DataExchange / Client / list_data_grants

list_data_grants#

DataExchange.Client.list_data_grants(**kwargs)#

This operation returns information about all data grants.

See also: AWS API Documentation

Request Syntax

response = client.list_data_grants(
    MaxResults=123,
    NextToken='string'
)
Parameters:
  • MaxResults (integer) – The maximum number of results to be included in the next page.

  • NextToken (string) – The pagination token used to retrieve the next page of results for this operation.

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',
            'SourceDataSetId': 'string',
            'Id': 'string',
            'Arn': 'string',
            'CreatedAt': datetime(2015, 1, 1),
            'UpdatedAt': datetime(2015, 1, 1)
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) –

    • DataGrantSummaries (list) –

      An object that contains a list of data grant information.

      • (dict) –

        Information about a 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.

        • SourceDataSetId (string) –

          The ID of the data set used to create 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.

    • NextToken (string) –

      The pagination token used to retrieve the next page of results for this operation.

Exceptions