Amazon Archiver Appliance

The /EC2Resources resource collection represents Amazon archiver appliance resources.

Get Instance Types

Returns a list of instance types that the Amazon archiver appliance will use.

SecurityBearer
Request
query Parameters
accountId
required
string <uuid>

Specifies the identification number of the cloud account. For more information on how to get this parameter, see Get Accounts.

regionId
required
string

Specifies the region ID for Amazon S3 object storage repository. For more information, see this Amazon article.

Responses
200

OK

default

Operation failure response.

get/v8/EC2Resources/InstanceType
Request samples
Response samples
application/json
[
  • {
    }
]

Get Instance Type by Name

Returns information about an instance type with the specified name that the Amazon archiver appliance will use.

SecurityBearer
Request
path Parameters
instanceTypeName
required
string

Specifies the instance type. For more information on how to get this parameter, see Get Instance Types. For more information on instance types, see this Amazon article.

query Parameters
accountId
required
string <uuid>

Specifies the identification number of the cloud account. For more information on how to get this parameter, see Get Accounts.

regionId
required
string

Specifies the region ID for Amazon S3 object storage repository. For more information, see this Amazon article.

Responses
200

OK

default

Operation failure response.

get/v8/EC2Resources/InstanceType/{instanceTypeName}
Request samples
Response samples
application/json
[
  • {
    }
]

Get Virtual Private Clouds

Returns a list of available Amazon Virtual Private Clouds (Amazon VPC) dedicated to the specified cloud account.

SecurityBearer
Request
query Parameters
accountId
required
string <uuid>

Specifies the identification number of the cloud account. For more information on how to get this parameter, see Get Accounts.

regionId
required
string

Specifies the region ID for Amazon S3 object storage repository. For more information, see this Amazon article.

Responses
200

OK

default

Operation failure response.

get/v8/EC2Resources/VirtualPrivateCloud
Request samples
Response samples
application/json
[
  • {
    }
]

Get Virtual Private Cloud by Name

Returns information about Amazon Virtual Private Cloud (Amazon VPC) with the specified name.

SecurityBearer
Request
path Parameters
name
required
string

Specifies the Amazon Virtual Private Cloud (Amazon VPC) ID. For more information on how to get this parameter, see Get Virtual Private Clouds.

query Parameters
accountId
required
string <uuid>

Specifies the identification number of the cloud account. For more information on how to get this parameter, see Get Accounts.

regionId
required
string

Specifies the region ID for Amazon S3 object storage repository. For more information, see this Amazon article.

Responses
200

OK

default

Operation failure response.

get/v8/EC2Resources/VirtualPrivateCloud/{name}
Request samples
Response samples
application/json
[
  • {
    }
]

Get Subnets

Returns a list of subnets within Amazon Virtual Private Cloud (Amazon VPC) with the specified ID.

SecurityBearer
Request
path Parameters
id
required
string

Specifies the Amazon Virtual Private Cloud (Amazon VPC) ID. For more information on how to get this parameter, see Get Virtual Private Clouds.

query Parameters
accountId
required
string <uuid>

Specifies the identification number of the cloud account. For more information on how to get this parameter, see Get Accounts.

regionId
required
string

Specifies the region ID for Amazon S3 object storage repository. For more information, see this Amazon article.

Responses
200

OK

default

Operation failure response.

get/v8/EC2Resources/VirtualPrivateCloud/{id}/Subnets
Request samples
Response samples
application/json
[
  • {
    }
]

Get Subnet by Name

Returns information about a subnet with the specified name within Amazon Virtual Private Cloud (Amazon VPC) with the specified ID.

SecurityBearer
Request
path Parameters
id
required
string

Specifies the Amazon Virtual Private Cloud (Amazon VPC) ID. For more information on how to get this parameter, see Get Virtual Private Clouds.

subnetName
required
string

Specifies the subnet name. For more information on how to get this parameter, see Get Subnets.

query Parameters
accountId
required
string <uuid>

Specifies the identification number of the cloud account. For more information on how to get this parameter, see Get Accounts.

regionId
required
string

Specifies the region ID for Amazon S3 object storage repository. For more information, see this Amazon article.

Responses
200

OK

default

Operation failure response.

get/v8/EC2Resources/VirtualPrivateCloud/{id}/Subnets/{subnetName}
Request samples
Response samples
application/json
[
  • {
    }
]

Get Security Groups

Returns a list of security groups that will be associated with the Amazon archiver appliance.

SecurityBearer
Request
path Parameters
id
required
string

Specifies the Amazon Virtual Private Cloud (Amazon VPC) ID. For more information on how to get this parameter, see Get Virtual Private Clouds.

query Parameters
accountId
required
string <uuid>

Specifies the identification number of the cloud account. For more information on how to get this parameter, see Get Accounts.

regionId
required
string

Specifies the region ID for Amazon S3 object storage repository. For more information, see this Amazon article.

Responses
200

OK

default

Operation failure response.

get/v8/EC2Resources/VirtualPrivateCloud/{id}/SecurityGroup
Request samples
Response samples
application/json
[
  • {
    }
]

Get Security Group by Name

Returns information about a security group with the specified name.

SecurityBearer
Request
path Parameters
id
required
string

Specifies the Amazon Virtual Private Cloud (Amazon VPC) ID. For more information on how to get this parameter, see Get Virtual Private Clouds.

securityGroupName
required
string

Specifies the security group name. For more information on how to get this parameter, see Get Security Groups. For more information on security groups for Amazon VPC, see this Amazon article.

query Parameters
accountId
required
string <uuid>

Specifies the identification number of the cloud account. For more information on how to get this parameter, see Get Accounts.

regionId
required
string

Specifies the region ID for Amazon S3 object storage repository. For more information, see this Amazon article.

Responses
200

OK

default

Operation failure response.

get/v8/EC2Resources/VirtualPrivateCloud/{id}/SecurityGroup/{securityGroupName}
Request samples
Response samples
application/json
{
  • "id": "string",
  • "name": "string"
}

Document updated 12/18/2025

Page content applies to build 8.3.0.2201