Skip to content

Get Access Point

s3control_get_access_point R Documentation

This operation is not supported by directory buckets

Description

This operation is not supported by directory buckets.

Returns configuration information about the specified access point.

All Amazon S3 on Outposts REST API requests for this action require an additional parameter of x-amz-outpost-id to be passed with the request. In addition, you must use an S3 on Outposts endpoint hostname prefix instead of s3-control. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and the x-amz-outpost-id derived by using the access point ARN, see the Examples section.

The following actions are related to get_access_point:

  • create_access_point

  • delete_access_point

  • list_access_points

Usage

s3control_get_access_point(AccountId, Name)

Arguments

AccountId

[required] The Amazon Web Services account ID for the account that owns the specified access point.

Name

[required] 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.

Value

A list with the following syntax: 

list(
  Name = "string",
  Bucket = "string",
  NetworkOrigin = "Internet"|"VPC",
  VpcConfiguration = list(
    VpcId = "string"
  ),
  PublicAccessBlockConfiguration = list(
    BlockPublicAcls = TRUE|FALSE,
    IgnorePublicAcls = TRUE|FALSE,
    BlockPublicPolicy = TRUE|FALSE,
    RestrictPublicBuckets = TRUE|FALSE
  ),
  CreationDate = as.POSIXct(
    "2015-01-01"
  ),
  Alias = "string",
  AccessPointArn = "string",
  Endpoints = list(
    "string"
  ),
  BucketAccountId = "string"
)

Request syntax

svc$get_access_point(
  AccountId = "string",
  Name = "string"
)