ListOutposts
Lists the Outposts for your AWS account.
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?AvailabilityZoneFilter=AvailabilityZoneFilter
&AvailabilityZoneIdFilter=AvailabilityZoneIdFilter
&LifeCycleStatusFilter=LifeCycleStatusFilter
&MaxResults=MaxResults
&NextToken=NextToken
HTTP/1.1
URI Request Parameters
The request uses the following URI parameters.
- AvailabilityZoneFilter
-
Filters the results by Availability Zone (for example,
us-east-1a
).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
-
Filters the results by AZ ID (for example,
use1-az1
).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
-
Filters the results by the lifecycle status.
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 2048.
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",
"SupportedHardwareType": "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.
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: