EntityResolution / Client / list_id_namespaces

list_id_namespaces#

EntityResolution.Client.list_id_namespaces(**kwargs)#

Returns a list of all ID namespaces.

See also: AWS API Documentation

Request Syntax

response = client.list_id_namespaces(
    maxResults=123,
    nextToken='string'
)
Parameters:
  • maxResults (integer) – The maximum number of IdNamespace objects returned per page.

  • nextToken (string) – The pagination token from the previous API call.

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) –

      The pagination token from the previous API call.

Exceptions