GetAccessPoint
Note
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 GetAccessPoint
:
Request Syntax
GET /v20180820/accesspoint/name
HTTP/1.1
Host: s3-control.amazonaws.com.cn
x-amz-account-id: AccountId
URI Request Parameters
The request uses the following URI parameters.
- name
-
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 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 pointreports-ap
through Outpostmy-outpost
owned by account123456789012
in Regionus-west-2
, use the URL encoding ofarn:aws:s3-outposts:us-west-2:123456789012:outpost/my-outpost/accesspoint/reports-ap
. The value must be URL encoded.Length Constraints: Minimum length of 3. Maximum length of 255.
Required: Yes
- x-amz-account-id
-
The Amazon Web Services account ID for the account that owns the specified access point.
Length Constraints: Maximum length of 64.
Pattern:
^\d{12}$
Required: Yes
Request Body
The request does not have a request body.
Response Syntax
HTTP/1.1 200
<?xml version="1.0" encoding="UTF-8"?>
<GetAccessPointResult>
<Name>string</Name>
<Bucket>string</Bucket>
<NetworkOrigin>string</NetworkOrigin>
<VpcConfiguration>
<VpcId>string</VpcId>
</VpcConfiguration>
<PublicAccessBlockConfiguration>
<BlockPublicAcls>boolean</BlockPublicAcls>
<BlockPublicPolicy>boolean</BlockPublicPolicy>
<IgnorePublicAcls>boolean</IgnorePublicAcls>
<RestrictPublicBuckets>boolean</RestrictPublicBuckets>
</PublicAccessBlockConfiguration>
<CreationDate>timestamp</CreationDate>
<Alias>string</Alias>
<AccessPointArn>string</AccessPointArn>
<Endpoints>
<entry>
<key>string</key>
<value>string</value>
</entry>
</Endpoints>
<BucketAccountId>string</BucketAccountId>
</GetAccessPointResult>
Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in XML format by the service.
- GetAccessPointResult
-
Root level tag for the GetAccessPointResult parameters.
Required: Yes
- AccessPointArn
-
The ARN of the access point.
Type: String
Length Constraints: Minimum length of 4. Maximum length of 128.
- Alias
-
The name or alias of the access point.
Type: String
Length Constraints: Maximum length of 63.
Pattern:
^[0-9a-z\\-]{63}
- Bucket
-
The name of the bucket associated with the specified access point.
Type: String
Length Constraints: Minimum length of 3. Maximum length of 255.
- BucketAccountId
-
The Amazon Web Services account ID associated with the S3 bucket associated with this access point.
Type: String
Length Constraints: Maximum length of 64.
Pattern:
^\d{12}$
- CreationDate
-
The date and time when the specified access point was created.
Type: Timestamp
- Endpoints
-
The VPC endpoint for the access point.
Type: String to string map
Key Length Constraints: Minimum length of 1. Maximum length of 64.
Value Length Constraints: Minimum length of 1. Maximum length of 1024.
- Name
-
The name of the specified access point.
Type: String
Length Constraints: Minimum length of 3. Maximum length of 255.
- NetworkOrigin
-
Indicates whether this access point allows access from the public internet. If
VpcConfiguration
is specified for this access point, thenNetworkOrigin
isVPC
, and the access point doesn't allow access from the public internet. Otherwise,NetworkOrigin
isInternet
, and the access point allows access from the public internet, subject to the access point and bucket access policies.This will always be true for an Amazon S3 on Outposts access point
Type: String
Valid Values:
Internet | VPC
- PublicAccessBlockConfiguration
-
The
PublicAccessBlock
configuration that you want to apply to this Amazon S3 account. You can enable the configuration options in any combination. For more information about when Amazon S3 considers a bucket or object public, see The Meaning of "Public" in the Amazon S3 User Guide.This data type is not supported for Amazon S3 on Outposts.
Type: PublicAccessBlockConfiguration data type
- VpcConfiguration
-
Contains the virtual private cloud (VPC) configuration for the specified access point.
Note
This element is empty if this access point is an Amazon S3 on Outposts access point that is used by other Amazon Web Services services.
Type: VpcConfiguration data type
Examples
Sample request syntax for getting an Amazon S3 on Outposts access point
The following request returns the access point of the specified S3 on Outposts access point.
GET /v20180820/accesspoint/example-access-point HTTP/1.1 Host: s3-outposts.<Region>.amazonaws.com Date: Wed, 28 Oct 2020 22:32:00 GMT Authorization: authorization string x-amz-account-id: example-account-id x-amz-outpost-id: op-01ac5d28a6a232904
See Also
For more information about using this API in one of the language-specific Amazon SDKs, see the following: