CleanRoomsService / Client / list_id_mapping_tables

list_id_mapping_tables#

CleanRoomsService.Client.list_id_mapping_tables(**kwargs)#

Returns a list of ID mapping tables.

See also: AWS API Documentation

Request Syntax

response = client.list_id_mapping_tables(
    membershipIdentifier='string',
    nextToken='string',
    maxResults=123
)
Parameters:

  • membershipIdentifier (string) –

    [REQUIRED]

    The unique identifier of the membership that contains the ID mapping tables that you want to view.

  • nextToken (string) – The pagination token that’s used to fetch the next set of results.

  • maxResults (integer) – The maximum size of the results that is returned per call. Service chooses a default if it has not been set. Service may return a nextToken even if the maximum results has not been met.

Return type:

dict

Returns:

Response Syntax

{
    'idMappingTableSummaries': [
        {
            'collaborationArn': 'string',
            'collaborationId': 'string',
            'membershipId': 'string',
            'membershipArn': 'string',
            'createTime': datetime(2015, 1, 1),
            'updateTime': datetime(2015, 1, 1),
            'id': 'string',
            'arn': 'string',
            'description': 'string',
            'inputReferenceConfig': {
                'inputReferenceArn': 'string',
                'manageResourcePolicies': True|False
            },
            'name': 'string'
        },
    ],
    'nextToken': 'string'
}

Response Structure

  • (dict) –

    • idMappingTableSummaries (list) –

      The summary information of the ID mapping tables that you requested.

      • (dict) –

        Detailed information about the ID mapping table.

        • collaborationArn (string) –

          The Amazon Resource Name (ARN) of the collaboration that contains this ID mapping table.

        • collaborationId (string) –

          The unique identifier of the collaboration that contains this ID mapping table.

        • membershipId (string) –

          The unique identifier of the membership resource for this ID mapping table.

        • membershipArn (string) –

          The Amazon Resource Name (ARN) of the membership resource for this ID mapping table.

        • createTime (datetime) –

          The time at which this ID mapping table was created.

        • updateTime (datetime) –

          The most recent time at which this ID mapping table was updated.

        • id (string) –

          The unique identifier of this ID mapping table.

        • arn (string) –

          The Amazon Resource Name (ARN) of this ID mapping table.

        • description (string) –

          The description of this ID mapping table.

        • inputReferenceConfig (dict) –

          The input reference configuration for the ID mapping table.

          • inputReferenceArn (string) –

            The Amazon Resource Name (ARN) of the referenced resource in Entity Resolution. Valid values are ID mapping workflow ARNs.

          • manageResourcePolicies (boolean) –

            When TRUE, Clean Rooms manages permissions for the ID mapping table resource.

            When FALSE, the resource owner manages permissions for the ID mapping table resource.

        • name (string) –

          The name of this ID mapping table.

    • nextToken (string) –

      The token value provided to access the next page of results.

Exceptions