GetAccessGrantsInstance
Retrieves the S3 Access Grants instance for a Region in your account.
- Permissions
-
You must have the
s3:GetAccessGrantsInstancepermission to use this operation.
Note
GetAccessGrantsInstance is not supported for cross-account access. You can only call the API from the account that owns the S3 Access Grants instance.
Request Syntax
GET /v20180820/accessgrantsinstance HTTP/1.1
Host: s3-control.amazonaws.com
x-amz-account-id: AccountId
URI Request Parameters
The request uses the following URI parameters.
- 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"?>
<GetAccessGrantsInstanceResult>
<AccessGrantsInstanceArn>string</AccessGrantsInstanceArn>
<AccessGrantsInstanceId>string</AccessGrantsInstanceId>
<IdentityCenterArn>string</IdentityCenterArn>
<IdentityCenterInstanceArn>string</IdentityCenterInstanceArn>
<IdentityCenterApplicationArn>string</IdentityCenterApplicationArn>
<CreatedAt>timestamp</CreatedAt>
</GetAccessGrantsInstanceResult>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.
- GetAccessGrantsInstanceResult
-
Root level tag for the GetAccessGrantsInstanceResult 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\-]+ - CreatedAt
-
The date and time when you created the S3 Access Grants instance.
Type: Timestamp
- IdentityCenterApplicationArn
-
If you associated your S3 Access Grants instance with an AWS IAM Identity Center instance, this field returns the Amazon Resource Name (ARN) of the IAM Identity Center instance application; a subresource of the original Identity Center instance. S3 Access Grants creates this Identity Center application for the specific S3 Access Grants instance.
Type: String
Length Constraints: Minimum length of 10. Maximum length of 1224.
Pattern:
arn:[^:]+:sso::\d{12}:application/.*$ - IdentityCenterArn
-
This parameter has been deprecated.
If you associated your S3 Access Grants instance with an AWS IAM Identity Center instance, this field returns the Amazon Resource Name (ARN) of the IAM Identity Center instance application; a subresource of the original Identity Center instance. S3 Access Grants creates this Identity Center application for the specific S3 Access Grants instance.
Type: String
Length Constraints: Minimum length of 10. Maximum length of 1224.
Pattern:
arn:[^:]+:sso::(\d{12}){0,1}:instance/.*$ - IdentityCenterInstanceArn
-
The Amazon Resource Name (ARN) of the AWS IAM Identity Center instance that you are associating with your S3 Access Grants instance. An IAM Identity Center instance is your corporate identity directory that you added to the IAM Identity Center. You can use the ListInstances API operation to retrieve a list of your Identity Center instances and their ARNs.
Type: String
Length Constraints: Minimum length of 10. Maximum length of 1224.
Pattern:
arn:[^:]+:sso::(\d{12}){0,1}:instance/.*$
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
