ListAccessPoints
Note
This operation is not supported by directory buckets.
Returns a list of the access points
that are
owned by the current account
that's
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.
All Amazon S3 on Outposts REST API requests for this action require an additional parameter of x-amz-outpost-id to be passed with the request. In addition, you must use an S3 on Outposts endpoint hostname prefix instead of s3-control. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and the x-amz-outpost-id derived by using the access point ARN, see the Examples section.
The following actions are related to ListAccessPoints:
Request Syntax
GET /v20180820/accesspoint?bucket=Bucket&maxResults=MaxResults&nextToken=NextToken HTTP/1.1
Host: s3-control.amazonaws.com
x-amz-account-id: AccountId
URI Request Parameters
The request uses the following URI parameters.
- bucket
-
The name of the bucket whose associated access points you want to list.
For using this parameter with Amazon S3 on Outposts with the REST API, you must specify the name and the x-amz-outpost-id as well.
For using this parameter with S3 on Outposts with the AWS SDK and CLI, you must specify the ARN of the bucket accessed in the format
arn:aws:s3-outposts:<Region>:<account-id>:outpost/<outpost-id>/bucket/<my-bucket-name>. For example, to access the bucketreportsthrough Outpostmy-outpostowned by account123456789012in Regionus-west-2, use the URL encoding ofarn:aws:s3-outposts:us-west-2:123456789012:outpost/my-outpost/bucket/reports. The value must be URL encoded.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
NextTokenfield that you can use to retrieve the next page of access points.Valid Range: Minimum value of 0. Maximum value of 1000.
- nextToken
-
A continuation token. If a previous call to
ListAccessPointsreturned a continuation token in theNextTokenfield, 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 the account that owns the specified access points.
Length Constraints: Maximum length of 64.
Pattern:
^\d{12}$Required: Yes
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>
<AccessPointArn>string</AccessPointArn>
<Alias>string</Alias>
<Bucket>string</Bucket>
<BucketAccountId>string</BucketAccountId>
<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, 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.
Examples
Sample request syntax for ListAccessPoints for Amazon S3 on Outposts
The following request returns a list access points of the specified Amazon S3 on Outposts
bucket example-outpost-bucket.
GET /v20180820/accesspoint?Bucket=example-outpost-bucket&MaxResults=MaxResults&NextToken=NextToken HTTP/1.1 Host: s3-outposts.<Region>.amazonaws.com Date: Wed, 28 Oct 2020 22:32:00 GMT Authorization: authorization string x-amz-account-id: example-account-id x-amz-outpost-id: op-01ac5d28a6a232904
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
