ListAssets - AWS Outposts

ListAssets

Lists the hardware assets for the specified Outpost.

Use filters to return specific results. If you specify multiple filters, the results include only the resources that match all of the specified filters. For a filter where you can specify multiple values, the results include items that match any of the values that you specify for the filter.

Request Syntax

GET /outposts/OutpostId/assets?HostIdFilter=HostIdFilter&MaxResults=MaxResults&NextToken=NextToken&StatusFilter=StatusFilter HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

HostIdFilter

Filters the results by the host ID of a Dedicated Host.

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

Pattern: ^[A-Za-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 or the Amazon Resource Name (ARN) of the Outpost.

Note

ListAssets uses the OutpostIdentifier parameter to identify an Outpost. The parameter name is OutpostId in this documentation for backward compatibility. In practice, there is no semantic difference between OutpostIdentifier and OutpostId.

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

StatusFilter

Filters the results by state.

Array Members: Minimum number of 1 item. Maximum number of 3 items.

Valid Values: ACTIVE | RETIRING | ISOLATED

Request Body

The request does not have a request body.

Response Syntax

HTTP/1.1 200 Content-type: application/json { "Assets": [ { "AssetId": "string", "AssetLocation": { "RackElevation": number }, "AssetType": "string", "ComputeAttributes": { "HostId": "string", "InstanceFamilies": [ "string" ], "State": "string" }, "RackId": "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.

Assets

Information about the hardware assets.

Type: Array of AssetInfo 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

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: