Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

ListAssetInstances

A list of Amazon EC2 instances, belonging to all accounts, running on the specified Outpost. Does not include Amazon EBS or Amazon S3 instances.

Request Syntax


GET /outposts/OutpostId/assetInstances?AccountIdFilter=AccountIdFilter&AssetIdFilter=AssetIdFilter&AwsServiceFilter=AwsServiceFilter&InstanceTypeFilter=InstanceTypeFilter&MaxResults=MaxResults&NextToken=NextToken HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

AccountIdFilter

Filters the results by account ID.

Length Constraints: Fixed length of 12.

Pattern: \d{12}

AssetIdFilter

Filters the results by asset ID.

Length Constraints: Minimum length of 1. Maximum length of 100.

Pattern: ^(\w+)$

AwsServiceFilter

Filters the results by AWS service.

Valid Values: AWS | EC2 | ELASTICACHE | ELB | RDS | ROUTE53

InstanceTypeFilter

Filters the results by instance ID.

Length Constraints: Minimum length of 3. Maximum length of 30.

Pattern: [a-z0-9\-\.]+

MaxResults

The maximum page size.

Valid Range: Minimum value of 1. Maximum value of 1000.

NextToken

The pagination token.

Length Constraints: Minimum length of 1. Maximum length of 2048.

Pattern: ^(\d+)##(\S+)$

OutpostId

The ID of the Outpost.

Length Constraints: Minimum length of 1. Maximum length of 180.

Pattern: ^(arn:aws([a-z-]+)?:outposts:[a-z\d-]+:\d{12}:outpost/)?op-[a-f0-9]{17}$

Required: Yes

Request Body

The request does not have a request body.

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "AssetInstances": [ 
      { 
         "AccountId": "string",
         "AssetId": "string",
         "AwsServiceName": "string",
         "InstanceId": "string",
         "InstanceType": "string"
      }
   ],
   "NextToken": "string"
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

AssetInstances

List of instances owned by all accounts on the Outpost. Does not include Amazon EBS or Amazon S3 instances.

Type: Array of AssetInstance objects

NextToken

The pagination token.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 2048.

Pattern: ^(\d+)##(\S+)$

Errors

For information about the errors that are common to all actions, see Common Errors.

AccessDeniedException

You do not have permission to perform this operation.

HTTP Status Code: 403

InternalServerException

An internal error has occurred.

HTTP Status Code: 500

NotFoundException

The specified request is not valid.

HTTP Status Code: 404

ValidationException

A parameter is not valid.

HTTP Status Code: 400