S3Control / Client / list_access_grants_locations

list_access_grants_locations#

S3Control.Client.list_access_grants_locations(**kwargs)#

Returns a list of the locations registered in your S3 Access Grants instance.

Permissions

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

See also: AWS API Documentation

Request Syntax

response = client.list_access_grants_locations(
    AccountId='string',
    NextToken='string',
    MaxResults=123,
    LocationScope='string'
)
Parameters:

  • AccountId (string) –

    [REQUIRED]

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

  • NextToken (string) – A pagination token to request the next page of results. Pass this value into a subsequent List Access Grants Locations request in order to retrieve the next page of results.

  • MaxResults (integer) – The maximum number of access grants that you would like returned in the List Access Grants response. If the results include the pagination token NextToken, make another call using the NextToken to determine if there are more results.

  • LocationScope (string) – The S3 path to the location that you are registering. The location scope can be the default S3 location s3://, the S3 path to a bucket s3://<bucket>, or the S3 path to a bucket and prefix s3://<bucket>/<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.

Return type:

dict

Returns:

Response Syntax

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

Response Structure

  • (dict) –

    • NextToken (string) –

      A pagination token to request the next page of results. Pass this value into a subsequent List Access Grants Locations request in order to retrieve the next page of results.

    • AccessGrantsLocationsList (list) –

      A container for a list of registered locations in an S3 Access Grants instance.

      • (dict) –

        A container for information about the registered location.

        • 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 path to the location that you are registering. The location scope can be the default S3 location s3://, the S3 path to a bucket s3://<bucket>, or the S3 path to a bucket and prefix s3://<bucket>/<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.