GetAccessPoint - Amazon Simple Storage Service

GetAccessPoint

Returns configuration information about the specified access point.

Request Syntax

GET /v20180820/accesspoint/name HTTP/1.1 x-amz-account-id: AccountId

URI Request Parameters

The request requires the following URI parameters.

name

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

Length Constraints: Minimum length of 3. Maximum length of 50.

x-amz-account-id

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

Length Constraints: Maximum length of 64.

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> </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

Bucket

The name of the bucket associated with the specified access point.

Type: String

Length Constraints: Minimum length of 3. Maximum length of 255.

CreationDate

The date and time when the specified access point was created.

Type: Timestamp

Name

The name of the specified access point.

Type: String

Length Constraints: Minimum length of 3. Maximum length of 50.

NetworkOrigin

Indicates whether this access point allows access from the public internet. If VpcConfiguration is specified for this access point, then NetworkOrigin is VPC, and the access point doesn't allow access from the public internet. Otherwise, NetworkOrigin is Internet, and the access point allows access from the public internet, subject to the access point and bucket access policies.

Type: String

Valid Values: Internet | VPC

PublicAccessBlockConfiguration

The PublicAccessBlock configuration that you want to apply to this Amazon S3 bucket. 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 Simple Storage Service Developer Guide.

Type: PublicAccessBlockConfiguration data type

VpcConfiguration

Contains the virtual private cloud (VPC) configuration for the specified access point.

Type: VpcConfiguration data type

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: