DataExchange / Paginator / ListReceivedDataGrants

ListReceivedDataGrants#

class DataExchange.Paginator.ListReceivedDataGrants#
paginator = client.get_paginator('list_received_data_grants')
paginate(**kwargs)#

Creates an iterator that will paginate through responses from DataExchange.Client.list_received_data_grants().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    AcceptanceState=[
        'PENDING_RECEIVER_ACCEPTANCE'|'ACCEPTED',
    ],
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)
Parameters:
  • AcceptanceState (list) –

    The acceptance state of the data grants to list.

    • (string) –

  • 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

{
    'DataGrantSummaries': [
        {
            'Name': 'string',
            'SenderPrincipal': 'string',
            'ReceiverPrincipal': 'string',
            'AcceptanceState': 'PENDING_RECEIVER_ACCEPTANCE'|'ACCEPTED',
            'AcceptedAt': datetime(2015, 1, 1),
            'EndsAt': datetime(2015, 1, 1),
            'DataSetId': 'string',
            'Id': 'string',
            'Arn': 'string',
            'CreatedAt': datetime(2015, 1, 1),
            'UpdatedAt': datetime(2015, 1, 1)
        },
    ],

}

Response Structure

  • (dict) –

    • DataGrantSummaries (list) –

      An object that contains a list of received data grant information.

      • (dict) –

        Information about a received data grant.

        • Name (string) –

          The name of the data grant.

        • SenderPrincipal (string) –

          The Amazon Web Services account ID of the data grant sender.

        • ReceiverPrincipal (string) –

          The Amazon Web Services account ID of the data grant receiver.

        • AcceptanceState (string) –

          The acceptance state of the data grant.

        • AcceptedAt (datetime) –

          The timestamp of when the data grant was accepted.

        • EndsAt (datetime) –

          The timestamp of when access to the associated data set ends.

        • DataSetId (string) –

          The ID of the data set associated to the data grant.

        • Id (string) –

          The ID of the data grant.

        • Arn (string) –

          The Amazon Resource Name (ARN) of the data grant.

        • CreatedAt (datetime) –

          The timestamp of when the data grant was created.

        • UpdatedAt (datetime) –

          The timestamp of when the data grant was last updated.