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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-s3control/lib/aws-sdk-s3control/types.rb

Overview

Note:

When making an API call, you may pass ListAccessPointsRequest data as a hash:

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

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#account_idString

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

Returns:

  • (String)


3813
3814
3815
3816
3817
3818
3819
3820
# File 'gems/aws-sdk-s3control/lib/aws-sdk-s3control/types.rb', line 3813

class ListAccessPointsRequest < Struct.new(
  :account_id,
  :bucket,
  :next_token,
  :max_results)
  SENSITIVE = []
  include Aws::Structure
end

#bucketString

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 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)


3813
3814
3815
3816
3817
3818
3819
3820
# File 'gems/aws-sdk-s3control/lib/aws-sdk-s3control/types.rb', line 3813

class ListAccessPointsRequest < Struct.new(
  :account_id,
  :bucket,
  :next_token,
  :max_results)
  SENSITIVE = []
  include Aws::Structure
end

#max_resultsInteger

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)


3813
3814
3815
3816
3817
3818
3819
3820
# File 'gems/aws-sdk-s3control/lib/aws-sdk-s3control/types.rb', line 3813

class ListAccessPointsRequest < Struct.new(
  :account_id,
  :bucket,
  :next_token,
  :max_results)
  SENSITIVE = []
  include Aws::Structure
end

#next_tokenString

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)


3813
3814
3815
3816
3817
3818
3819
3820
# File 'gems/aws-sdk-s3control/lib/aws-sdk-s3control/types.rb', line 3813

class ListAccessPointsRequest < Struct.new(
  :account_id,
  :bucket,
  :next_token,
  :max_results)
  SENSITIVE = []
  include Aws::Structure
end