Class: Aws::S3Control::Types::GetAccessPointRequest

Inherits:

Struct

Object
Struct
Aws::S3Control::Types::GetAccessPointRequest

show all

Defined in:: gems/aws-sdk-s3control/lib/aws-sdk-s3control/types.rb

Overview

Note:

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

{
  account_id: "AccountId", # required
  name: "AccessPointName", # required
}

Constant Summary collapse

SENSITIVE =

[]

Instance Attribute Summary collapse

#account_id ⇒ String
The account ID for the account that owns the specified access point.
#name ⇒ String
The name of the access point whose configuration information you want to retrieve.

Instance Attribute Details

#account_id ⇒ `String`

The account ID for the account that owns the specified access point.

Returns:

(String)

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

class GetAccessPointRequest < Struct.new(
  :account_id,
  :name)
  SENSITIVE = []
  include Aws::Structure
end

#name ⇒ `String`

The name of the access point whose configuration information you want to retrieve.

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 access point accessed in the format arn:aws:s3-outposts:<Region>:<account-id>:outpost/<outpost-id>/accesspoint/<my-accesspoint-name>. For example, to access the access point reports-ap 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/accesspoint/reports-ap. The value must be URL encoded.