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

Inherits:

Struct

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

Defined in:

gems/aws-sdk-s3control/lib/aws-sdk-s3control/types.rb

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #account_id ⇒ String

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

• #bucket ⇒ String

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

• #data_source_id ⇒ String

  The unique identifier for the data source of the access point.

• #data_source_type ⇒ String

  The type of the data source that the access point is attached to.

• #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 Amazon Web Services account ID for the account that owns the specified access points.

Returns:

• (String)

# File 'gems/aws-sdk-s3control/lib/aws-sdk-s3control/types.rb', line 5224

class ListAccessPointsRequest < Struct.new(
  :account_id,
  :bucket,
  :next_token,
  :max_results,
  :data_source_id,
  :data_source_type)
  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)

# File 'gems/aws-sdk-s3control/lib/aws-sdk-s3control/types.rb', line 5224

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

#data_source_id ⇒ String

The unique identifier for the data source of the access point.

Returns:

• (String)

# File 'gems/aws-sdk-s3control/lib/aws-sdk-s3control/types.rb', line 5224

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

#data_source_type ⇒ String

The type of the data source that the access point is attached to. Returns only access points attached to S3 buckets by default. To return all access points specify DataSourceType as ALL.

Returns:

• (String)

# File 'gems/aws-sdk-s3control/lib/aws-sdk-s3control/types.rb', line 5224

class ListAccessPointsRequest < Struct.new(
  :account_id,
  :bucket,
  :next_token,
  :max_results,
  :data_source_id,
  :data_source_type)
  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)

# File 'gems/aws-sdk-s3control/lib/aws-sdk-s3control/types.rb', line 5224

class ListAccessPointsRequest < Struct.new(
  :account_id,
  :bucket,
  :next_token,
  :max_results,
  :data_source_id,
  :data_source_type)
  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)

# File 'gems/aws-sdk-s3control/lib/aws-sdk-s3control/types.rb', line 5224

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