GetAccessGrantsLocation
Retrieves the details of a particular location registered in your S3 Access Grants instance.
- Permissions
-
You must have the
s3:GetAccessGrantsLocationpermission to use this operation.
Request Syntax
GET /v20180820/accessgrantsinstance/location/id HTTP/1.1
Host: s3-control.amazonaws.com
x-amz-account-id: AccountId
URI Request Parameters
The request uses the following URI parameters.
- id
-
The ID of the registered location that you are retrieving. S3 Access Grants assigns this ID when you register the location. S3 Access Grants assigns the ID
defaultto the default locations3://and assigns an auto-generated ID to other locations that you register.Length Constraints: Minimum length of 1. Maximum length of 64.
Pattern:
[a-zA-Z0-9\-]+Required: Yes
- x-amz-account-id
-
The AWS account ID of the S3 Access Grants instance.
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"?>
<GetAccessGrantsLocationResult>
<CreatedAt>timestamp</CreatedAt>
<AccessGrantsLocationId>string</AccessGrantsLocationId>
<AccessGrantsLocationArn>string</AccessGrantsLocationArn>
<LocationScope>string</LocationScope>
<IAMRoleArn>string</IAMRoleArn>
</GetAccessGrantsLocationResult>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.
- GetAccessGrantsLocationResult
-
Root level tag for the GetAccessGrantsLocationResult parameters.
Required: Yes
- AccessGrantsLocationArn
-
The Amazon Resource Name (ARN) of the registered location.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 2048.
Pattern:
arn:[a-z\-]+:s3:[a-z0-9\-]+:\d{12}:access\-grants\/location/[a-zA-Z0-9\-]+ - AccessGrantsLocationId
-
The ID of the registered location to which you are granting access. S3 Access Grants assigns this ID when you register the location. S3 Access Grants assigns the ID
defaultto the default locations3://and assigns an auto-generated ID to other locations that you register.Type: String
Length Constraints: Minimum length of 1. Maximum length of 64.
Pattern:
[a-zA-Z0-9\-]+ - CreatedAt
-
The date and time when you registered the location.
Type: Timestamp
- IAMRoleArn
-
The Amazon Resource Name (ARN) of the IAM role for the registered location. S3 Access Grants assumes this role to manage access to the registered location.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 2048.
Pattern:
arn:[^:]+:iam::\d{12}:role/.* - LocationScope
-
The S3 URI path to the registered location. The location scope can be the default S3 location
s3://, the S3 path to a bucket, or the S3 path to a bucket and prefix. A prefix in S3 is a string of characters at the beginning of an object key name used to organize the objects that you store in your S3 buckets. For example, object key names that start with theengineering/prefix or object key names that start with themarketing/campaigns/prefix.Type: String
Length Constraints: Minimum length of 1. Maximum length of 2000.
Pattern:
^.+$
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
