List Access Points
s3control_list_access_points | R Documentation |
This operation is not supported by directory buckets¶
Description¶
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 list_access_points
:
-
create_access_point
-
delete_access_point
-
get_access_point
Usage¶
Arguments¶
AccountId
[required] The Amazon Web Services account ID for the account that owns the specified access points.
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 Amazon Web Services 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 bucketreports
through Outpostmy-outpost
owned by account123456789012
in 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.NextToken
A continuation token. If a previous call to
list_access_points
returned a continuation token in theNextToken
field, then providing that value here causes Amazon S3 to retrieve the next page of results.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.
Value¶
A list with the following syntax:
list(
AccessPointList = list(
list(
Name = "string",
NetworkOrigin = "Internet"|"VPC",
VpcConfiguration = list(
VpcId = "string"
),
Bucket = "string",
AccessPointArn = "string",
Alias = "string",
BucketAccountId = "string"
)
),
NextToken = "string"
)