S3Control / Client / get_access_grants_instance_for_prefix

get_access_grants_instance_for_prefix#

S3Control.Client.get_access_grants_instance_for_prefix(**kwargs)#

Retrieve the S3 Access Grants instance that contains a particular prefix.

Permissions

You must have the s3:GetAccessGrantsInstanceForPrefix permission 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.

See also: AWS API Documentation

Request Syntax

response = client.get_access_grants_instance_for_prefix(
    AccountId='string',
    S3Prefix='string'
)
Parameters:

  • AccountId (string) –

    [REQUIRED]

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

  • S3Prefix (string) –

    [REQUIRED]

    The S3 prefix of the access grants that you would like to retrieve.

Return type:

dict

Returns:

Response Syntax

{
    'AccessGrantsInstanceArn': 'string',
    'AccessGrantsInstanceId': 'string'
}

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.