ListOutpostsWithS3
Lists the Outposts with S3 on Outposts capacity for your AWS account. Includes S3 on Outposts that you have access to as the Outposts owner, or as a shared user from Resource Access Manager (RAM).
Request Syntax
GET /S3Outposts/ListOutpostsWithS3?maxResults=MaxResults&nextToken=NextToken HTTP/1.1
URI Request Parameters
The request uses the following URI parameters.
- MaxResults
-
The maximum number of Outposts to return. The limit is 100.
Valid Range: Minimum value of 0. Maximum value of 100.
- NextToken
-
When you can get additional results from the
ListOutpostsWithS3call, aNextTokenparameter is returned in the output. You can then pass in a subsequent command to theNextTokenparameter to continue listing additional Outposts.Length Constraints: Minimum length of 1. Maximum length of 1024.
Pattern:
^[A-Za-z0-9\+\:\/\=\?\#-_]+$
Request Body
The request does not have a request body.
Response Syntax
HTTP/1.1 200
Content-type: application/json
{
"NextToken": "string",
"Outposts": [
{
"CapacityInBytes": number,
"OutpostArn": "string",
"OutpostId": "string",
"OwnerId": "string",
"S3OutpostArn": "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
-
Returns a token that you can use to call
ListOutpostsWithS3again and receive additional results, if there are any.Type: String
Length Constraints: Minimum length of 1. Maximum length of 1024.
Pattern:
^[A-Za-z0-9\+\:\/\=\?\#-_]+$ - Outposts
-
Returns the list of Outposts that have the following characteristics:
-
outposts that have S3 provisioned
-
outposts that are
Active(not pending any provisioning nor decommissioned) -
outposts to which the the calling AWS account has access
Type: Array of Outpost objects
-
Errors
- AccessDeniedException
-
Access was denied for this action.
HTTP Status Code: 403
- InternalServerException
-
There was an exception with the internal server.
HTTP Status Code: 500
- ThrottlingException
-
The request was denied due to request throttling.
HTTP Status Code: 429
- ValidationException
-
There was an exception validating this data.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
