/AWS1/CL_S3C=>LISTACCESSPOINTS()
¶
About ListAccessPoints¶
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
:
Method Signature¶
IMPORTING¶
Required arguments:¶
IV_ACCOUNTID
TYPE /AWS1/S3CACCOUNTID
/AWS1/S3CACCOUNTID
¶
The Amazon Web Services account ID for the account that owns the specified access points.
Optional arguments:¶
IV_BUCKET
TYPE /AWS1/S3CBUCKETNAME
/AWS1/S3CBUCKETNAME
¶
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:
. For example, to access the bucket: :outpost/ /bucket/ reports
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.
IV_NEXTTOKEN
TYPE /AWS1/S3CNONEMPTYMAXLENGTH1000
/AWS1/S3CNONEMPTYMAXLENGTH1000
¶
A continuation token. If a previous call to
ListAccessPoints
returned a continuation token in theNextToken
field, then providing that value here causes Amazon S3 to retrieve the next page of results.
IV_MAXRESULTS
TYPE /AWS1/S3CMAXRESULTS
/AWS1/S3CMAXRESULTS
¶
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.