ListEndpoints - Amazon Simple Storage Service

ListEndpoints

Amazon S3 on Outposts access points simplify managing data access at scale for shared datasets in S3 on Outposts. S3 on Outposts uses endpoints to connect to Outposts buckets so that you can perform actions within your virtual private cloud (VPC). For more information, see Using Amazon S3 on Outposts in the Amazon Simple Storage Service Developer Guide.

This action lists endpoints associated with the Outposts.

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 max number of endpoints that can be returned on the request.

Valid Range: Minimum value of 0. Maximum value of 100.

NextToken

The next endpoint requested in the list.

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": [ { "CidrBlock": "string", "CreationTime": number, "EndpointArn": "string", "NetworkInterfaces": [ { "NetworkInterfaceId": "string" } ], "OutpostsId": "string", "Status": "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

Returns an array of endpoints associated with AWS Outposts.

Type: Array of Endpoint objects

NextToken

The next endpoint returned in the list.

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

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: