S3Control / Paginator / ListCallerAccessGrants

ListCallerAccessGrants

class S3Control.Paginator.ListCallerAccessGrants

paginator = client.get_paginator('list_caller_access_grants')

paginate(**kwargs)

Creates an iterator that will paginate through responses from S3Control.Client.list_caller_access_grants().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    AccountId='string',
    GrantScope='string',
    AllowedByApplication=True|False,
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

• AccountId (string) –

  [REQUIRED]

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

• GrantScope (string) – The S3 path of the data that you would like to access. Must start with s3://. You can optionally pass only the beginning characters of a path, and S3 Access Grants will search for all applicable grants for the path fragment.

• AllowedByApplication (boolean) – If this optional parameter is passed in the request, a filter is applied to the results. The results will include only the access grants for the caller’s Identity Center application or for any other applications ( ALL).

• PaginationConfig (dict) –

  A dictionary that provides parameters to control pagination.

  • MaxItems (integer) –

    The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

  • PageSize (integer) –

    The size of each page.

  • StartingToken (string) –

    A token to specify where to start paginating. This is the NextToken from a previous response.

Return type:

dict

Returns:

Response Syntax

{
    'CallerAccessGrantsList': [
        {
            'Permission': 'READ'|'WRITE'|'READWRITE',
            'GrantScope': 'string',
            'ApplicationArn': 'string'
        },
    ]
}

Response Structure

• (dict) –

  • CallerAccessGrantsList (list) –

    A list of the caller’s access grants that were created using S3 Access Grants and that grant the caller access to the S3 data of the Amazon Web Services account ID that was specified in the request.

    • (dict) –

      Part of ListCallerAccessGrantsResult. Each entry includes the permission level (READ, WRITE, or READWRITE) and the grant scope of the access grant. If the grant also includes an application ARN, the grantee can only access the S3 data through this application.

      • Permission (string) –

        The type of permission granted, which can be one of the following values:

        • READ - Grants read-only access to the S3 data.

        • WRITE - Grants write-only access to the S3 data.

        • READWRITE - Grants both read and write access to the S3 data.

      • GrantScope (string) –

        The S3 path of the data to which you have been granted access.

      • ApplicationArn (string) –

        The Amazon Resource Name (ARN) of an Amazon Web Services IAM Identity Center application associated with your Identity Center instance. If the grant includes an application ARN, the grantee can only access the S3 data through this application.