ListEndpoints
Lists endpoints associated with the specified Outpost.
Related actions include:
Request Syntax
GET /S3Outposts/ListEndpoints?maxResults=MaxResults&nextToken=NextToken HTTP/1.1
URI Request Parameters
The request uses the following URI parameters.
- MaxResults
-
The maximum number of endpoints that will be returned in the response.
Valid Range: Minimum value of 0. Maximum value of 100.
- NextToken
-
If a previous response from this operation included a
NextTokenvalue, provide that value here to retrieve the next page of results.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
{
"Endpoints": [
{
"AccessType": "string",
"CidrBlock": "string",
"CreationTime": number,
"CustomerOwnedIpv4Pool": "string",
"EndpointArn": "string",
"FailedReason": {
"ErrorCode": "string",
"Message": "string"
},
"NetworkInterfaces": [
{
"NetworkInterfaceId": "string"
}
],
"OutpostsId": "string",
"SecurityGroupId": "string",
"Status": "string",
"SubnetId": "string",
"VpcId": "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.
- Endpoints
-
The list of endpoints associated with the specified Outpost.
Type: Array of Endpoint objects
- NextToken
-
If the number of endpoints associated with the specified Outpost exceeds
MaxResults, you can include this value in subsequent calls to this operation to retrieve more results.Type: String
Length Constraints: Minimum length of 1. Maximum length of 1024.
Pattern:
^[A-Za-z0-9\+\:\/\=\?\#-_]+$
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
- ResourceNotFoundException
-
The requested resource was not found.
HTTP Status Code: 404
- 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:
