ListAccessPoints - Amazon Simple Storage Service

ListAccessPoints

Returns a list of the access points currently associated with the specified bucket. You can retrieve up to 1000 access points per call. If the specified bucket has more than 1,000 access points (or the number specified in maxResults, whichever is less), the response will include a continuation token that you can use to list the additional access points.

Request Syntax

GET /v20180820/accesspoint?Bucket=Bucket&MaxResults=MaxResults&NextToken=NextToken HTTP/1.1 x-amz-account-id: AccountId

URI Request Parameters

The request requires the following URI parameters.

bucket

The name of the bucket whose associated access points you want to list.

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

maxResults

The maximum number of access points that you want to include in the list. If the specified bucket has more than this number of access points, then the response will include a continuation token in the NextToken field that you can use to retrieve the next page of access points.

Valid Range: Minimum value of 1. Maximum value of 1000.

nextToken

A continuation token. If a previous call to ListAccessPoints returned a continuation token in the NextToken field, then providing that value here causes Amazon S3 to retrieve the next page of results.

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

x-amz-account-id

The AWS account ID for owner of the bucket whose access points you want to list.

Length Constraints: Maximum length of 64.

Pattern: ^\d{12}$

Request Body

The request does not have a request body.

Response Syntax

HTTP/1.1 200 <?xml version="1.0" encoding="UTF-8"?> <ListAccessPointsResult> <AccessPointList> <AccessPoint> <Bucket>string</Bucket> <Name>string</Name> <NetworkOrigin>string</NetworkOrigin> <VpcConfiguration> <VpcId>string</VpcId> </VpcConfiguration> </AccessPoint> </AccessPointList> <NextToken>string</NextToken> </ListAccessPointsResult>

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in XML format by the service.

ListAccessPointsResult

Root level tag for the ListAccessPointsResult parameters.

Required: Yes

AccessPointList

Contains identification and configuration information for one or more access points associated with the specified bucket.

Type: Array of AccessPoint data types

NextToken

If the specified bucket has more access points than can be returned in one call to this API, then this field contains a continuation token that you can provide in subsequent calls to this API to retrieve additional access points.

Type: String

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

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: