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

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

Overview

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#account_id ⇒ String

The Amazon Web Services account ID for the account that owns the specified access points.

Returns:

  • (String) 


4843
4844
4845
4846
4847
4848
4849
4850
 
# File 'gems/aws-sdk-s3control/lib/aws-sdk-s3control/types.rb', line 4843

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

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


4843
4844
4845
4846
4847
4848
4849
4850
 
# File 'gems/aws-sdk-s3control/lib/aws-sdk-s3control/types.rb', line 4843

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

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


4843
4844
4845
4846
4847
4848
4849
4850
 
# File 'gems/aws-sdk-s3control/lib/aws-sdk-s3control/types.rb', line 4843

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

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


4843
4844
4845
4846
4847
4848
4849
4850
 
# File 'gems/aws-sdk-s3control/lib/aws-sdk-s3control/types.rb', line 4843

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