S3Control / Client / get_access_grants_instance

get_access_grants_instance#

S3Control.Client.get_access_grants_instance(**kwargs)#

Retrieves the S3 Access Grants instance for a Region in your account.

Permissions

You must have the s3:GetAccessGrantsInstance permission to use this operation.

Request Syntax

response = client.get_access_grants_instance(
    AccountId='string'
)

Parameters:

AccountId (string) –

[REQUIRED]

The ID of the Amazon Web Services account that is making this request.

Return type:

dict

Returns:

Response Syntax

{
    'AccessGrantsInstanceArn': 'string',
    'AccessGrantsInstanceId': 'string',
    'IdentityCenterArn': 'string',
    'CreatedAt': datetime(2015, 1, 1)
}

Response Structure

(dict) –
- AccessGrantsInstanceArn (string) –
  
  The Amazon Resource Name (ARN) of the S3 Access Grants instance.
- AccessGrantsInstanceId (string) –
  
  The ID of the S3 Access Grants instance. The ID is default. You can have one S3 Access Grants instance per Region per account.
- IdentityCenterArn (string) –
  
  If you associated your S3 Access Grants instance with an Amazon Web Services IAM Identity Center instance, this field returns the Amazon Resource Name (ARN) of the Amazon Web Services 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.
- CreatedAt (datetime) –
  
  The date and time when you created the S3 Access Grants instance.