S3Control / Client / get_access_grants_location

get_access_grants_location#

S3Control.Client.get_access_grants_location(**kwargs)#

Retrieves the details of a particular location registered in your S3 Access Grants instance.

Permissions

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

See also: AWS API Documentation

Request Syntax

response = client.get_access_grants_location(
    AccountId='string',
    AccessGrantsLocationId='string'
)
Parameters:

  • AccountId (string) –

    [REQUIRED]

    The Amazon Web Services account ID of the S3 Access Grants instance.

  • AccessGrantsLocationId (string) –

    [REQUIRED]

    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 default to the default location s3:// and assigns an auto-generated ID to other locations that you register.

Return type:

dict

Returns:

Response Syntax

{
    'CreatedAt': datetime(2015, 1, 1),
    'AccessGrantsLocationId': 'string',
    'AccessGrantsLocationArn': 'string',
    'LocationScope': 'string',
    'IAMRoleArn': 'string'
}

Response Structure

  • (dict) –

    • CreatedAt (datetime) –

      The date and time when you registered the location.

    • AccessGrantsLocationId (string) –

      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 default to the default location s3:// and assigns an auto-generated ID to other locations that you register.

    • AccessGrantsLocationArn (string) –

      The Amazon Resource Name (ARN) of the registered location.

    • LocationScope (string) –

      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 the engineering/ prefix or object key names that start with the marketing/campaigns/ prefix.

    • IAMRoleArn (string) –

      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.