ListOutposts - AWS Outposts

ListOutposts

Create a list of the Outposts for your AWS account. Add filters to your request to return a more specific list of results. Use filters to match an Outpost lifecycle status, Availibility Zone (us-east-1a), and AZ ID (use1-az1).

If you specify multiple filters, the filters are joined with an AND, and the request returns only results that match all of the specified filters.

Request Syntax

GET /outposts?AvailabilityZoneFilter=AvailabilityZoneFilter&AvailabilityZoneIdFilter=AvailabilityZoneIdFilter&LifeCycleStatusFilter=LifeCycleStatusFilter&MaxResults=MaxResults&NextToken=NextToken HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

AvailabilityZoneFilter

A filter for the Availibility Zone (us-east-1a) of 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.

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

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

Pattern: ^([a-zA-Z]+-){1,3}([a-zA-Z]+)?(\d+[a-zA-Z]?)?$

AvailabilityZoneIdFilter

A filter for the AZ IDs (use1-az1) of 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.

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

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

Pattern: ^[a-zA-Z]+\d-[a-zA-Z]+\d$

LifeCycleStatusFilter

A filter for the lifecycle status of 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.

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

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

Pattern: ^[ A-Za-z]+$

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+)$

Request Body

The request does not have a request body.

Response Syntax

HTTP/1.1 200 Content-type: application/json { "NextToken": "string", "Outposts": [ { "AvailabilityZone": "string", "AvailabilityZoneId": "string", "Description": "string", "LifeCycleStatus": "string", "Name": "string", "OutpostArn": "string", "OutpostId": "string", "OwnerId": "string", "SiteArn": "string", "SiteId": "string", "Tags": { "string" : "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.

NextToken

The pagination token.

Type: String

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

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

Outposts

Information about the Outposts.

Type: Array of Outpost objects

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

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: