Class: Aws::S3Control::Types::ListAccessPointsRequest

Inherits:

Struct

• Object
• Struct
• Aws::S3Control::Types::ListAccessPointsRequest

Defined in:

(unknown)

Overview

Note:

When passing ListAccessPointsRequest as input to an Aws::Client method, you can use a vanilla Hash:

{
  account_id: "AccountId", # required
  bucket: "BucketName",
  next_token: "NonEmptyMaxLength1024String",
  max_results: 1,
}

See Also:

• AWS API Documentation

Instance Attribute Summary

• #account_id ⇒ String

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

• #bucket ⇒ String

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

• #max_results ⇒ Integer

  The maximum number of access points that you want to include in the list.

• #next_token ⇒ String

  A continuation token.

Instance Attribute Details

#account_id ⇒ String

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

Returns:

• (String) —

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

#bucket ⇒ String

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 bucket reports through outpost my-outpost owned by account 123456789012 in Region us-west-2, use the URL encoding of arn:aws:s3-outposts:us-west-2:123456789012:outpost/my-outpost/bucket/reports. The value must be URL encoded.

Returns:

• (String) —

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

#max_results ⇒ Integer

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.

Returns:

• (Integer) —

  The maximum number of access points that you want to include in the list.

#next_token ⇒ String

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.

Returns:

• (String) —

  A continuation token.