GetAccessGrantsInstanceForPrefix
Retrieve the S3 Access Grants instance that contains a particular prefix.
- Permissions
-
You must have the
s3:GetAccessGrantsInstanceForPrefixpermission for the caller account to use this operation. - Additional Permissions
-
The prefix owner account must grant you the following permissions to their S3 Access Grants instance:
s3:GetAccessGrantsInstanceForPrefix.
Request Syntax
GET /v20180820/accessgrantsinstance/prefix?s3prefix=S3Prefix HTTP/1.1
Host: s3-control.amazonaws.com
x-amz-account-id: AccountId
URI Request Parameters
The request uses the following URI parameters.
- s3prefix
-
The S3 prefix of the access grants that you would like to retrieve.
Length Constraints: Minimum length of 1. Maximum length of 2000.
Pattern:
^.+$Required: Yes
- x-amz-account-id
-
The ID of the AWS account that is making this request.
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"?>
<GetAccessGrantsInstanceForPrefixResult>
<AccessGrantsInstanceArn>string</AccessGrantsInstanceArn>
<AccessGrantsInstanceId>string</AccessGrantsInstanceId>
</GetAccessGrantsInstanceForPrefixResult>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.
- GetAccessGrantsInstanceForPrefixResult
-
Root level tag for the GetAccessGrantsInstanceForPrefixResult parameters.
Required: Yes
- AccessGrantsInstanceArn
-
The Amazon Resource Name (ARN) of the S3 Access Grants instance.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 2048.
Pattern:
arn:[a-z\-]+:s3:[a-z0-9\-]+:\d{12}:access\-grants\/[a-zA-Z0-9\-]+ - AccessGrantsInstanceId
-
The ID of the S3 Access Grants instance. The ID is
default. You can have one S3 Access Grants instance per Region per account.Type: String
Length Constraints: Minimum length of 1. Maximum length of 64.
Pattern:
[a-zA-Z0-9\-]+
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
