EntityResolution / Paginator / ListIdNamespaces

ListIdNamespaces

class EntityResolution.Paginator.ListIdNamespaces

paginator = client.get_paginator('list_id_namespaces')

paginate(**kwargs)

Creates an iterator that will paginate through responses from EntityResolution.Client.list_id_namespaces().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

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

{
    'idNamespaceSummaries': [
        {
            'createdAt': datetime(2015, 1, 1),
            'description': 'string',
            'idMappingWorkflowProperties': [
                {
                    'idMappingType': 'PROVIDER'|'RULE_BASED'
                },
            ],
            'idNamespaceArn': 'string',
            'idNamespaceName': 'string',
            'type': 'SOURCE'|'TARGET',
            'updatedAt': datetime(2015, 1, 1)
        },
    ],
    'NextToken': 'string'
}

Response Structure

• (dict) –

  • idNamespaceSummaries (list) –

    A list of IdNamespaceSummaries objects.

    • (dict) –

      A summary of ID namespaces.

      • createdAt (datetime) –

        The timestamp of when the ID namespace was created.

      • description (string) –

        The description of the ID namespace.

      • idMappingWorkflowProperties (list) –

        An object which defines any additional configurations required by the ID mapping workflow.

        • (dict) –

          The settings for the ID namespace for the ID mapping workflow job.

          • idMappingType (string) –

            The type of ID mapping.

      • idNamespaceArn (string) –

        The Amazon Resource Name (ARN) of the ID namespace.

      • idNamespaceName (string) –

        The name of the ID namespace.

      • type (string) –

        The type of ID namespace. There are two types: SOURCE and TARGET.

        The SOURCE contains configurations for sourceId data that will be processed in an ID mapping workflow.

        The TARGET contains a configuration of targetId which all sourceIds will resolve to.

      • updatedAt (datetime) –

        The timestamp of when the ID namespace was last updated.

  • NextToken (string) –

    A token to resume pagination.