ListAssets - AWS Outposts

ListAssets

Lists the hardware assets in an Outpost. If you are using Dedicated Hosts on AWS Outposts, you can filter your request by host ID to return a list of hardware assets that allocate resources for Dedicated Hosts.

Request Syntax

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

URI Request Parameters

The request uses the following URI parameters.

HostIdFilter

A filter for the host ID of Dedicated Hosts on the Outpost.

Filter values are case sensitive. If you specify multiple values for a filter, the values are joined with an OR, and the request returns all results that match any of the specified values.

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 1005.

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

OutpostId

The ID or the Amazon Resource Name (ARN) of the Outpost.

Note

The parameter name that ListAssets uses to identify an Outpost is OutpostIdentifier, which accepts an ID or an ARN. To address backwards compatibility, the AWS Outposts API Reference uses the parameter name OutpostID. In practice, there is no semantic difference between OutpostIdentifier and OutpostID. Replace the parameter with either the ID or the ARN to make your request.

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 { "Assets": [ { "AssetId": "string", "AssetLocation": { "RackElevation": number }, "AssetType": "string", "ComputeAttributes": { "HostId": "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 hardware assets.

Type: Array of AssetInfo objects

NextToken

The pagination token.

Type: String

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

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: