EntityResolution / Client / create_id_namespace

create_id_namespace

EntityResolution.Client.create_id_namespace(**kwargs)

Creates an ID namespace object which will help customers provide metadata explaining their dataset and how to use it. Each ID namespace must have a unique name. To modify an existing ID namespace, use the UpdateIdNamespace API.

See also: AWS API Documentation

Request Syntax

response = client.create_id_namespace(
    description='string',
    idMappingWorkflowProperties=[
        {
            'idMappingType': 'PROVIDER',
            'providerProperties': {
                'providerConfiguration': {...}|[...]|123|123.4|'string'|True|None,
                'providerServiceArn': 'string'
            }
        },
    ],
    idNamespaceName='string',
    inputSourceConfig=[
        {
            'inputSourceARN': 'string',
            'schemaName': 'string'
        },
    ],
    roleArn='string',
    tags={
        'string': 'string'
    },
    type='SOURCE'|'TARGET'
)

Parameters:

• description (string) – The description of the ID namespace.

• idMappingWorkflowProperties (list) –

  Determines the properties of IdMappingWorflow where this IdNamespace can be used as a Source or a Target.

  • (dict) –

    An object containing IdMappingType and ProviderProperties.

    • idMappingType (string) – [REQUIRED]

      The type of ID mapping.

    • providerProperties (dict) –

      An object which defines any additional configurations required by the provider service.

      • providerConfiguration (document) –

        An object which defines any additional configurations required by the provider service.

      • providerServiceArn (string) – [REQUIRED]

        The Amazon Resource Name (ARN) of the provider service.

• idNamespaceName (string) –

  [REQUIRED]

  The name of the ID namespace.

• inputSourceConfig (list) –

  A list of InputSource objects, which have the fields InputSourceARN and SchemaName.

  • (dict) –

    An object containing InputSourceARN and SchemaName.

    • inputSourceARN (string) – [REQUIRED]

      An Glue table ARN for the input source table.

    • schemaName (string) –

      The name of the schema.

• roleArn (string) – The Amazon Resource Name (ARN) of the IAM role. Entity Resolution assumes this role to access the resources defined in this IdNamespace on your behalf as part of the workflow run.

• tags (dict) –

  The tags used to organize, track, or control access for this resource.

  • (string) –

    • (string) –

• type (string) –

  [REQUIRED]

  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 to which all sourceIds will resolve to.

Return type:

dict

Returns:

Response Syntax

{
    'createdAt': datetime(2015, 1, 1),
    'description': 'string',
    'idMappingWorkflowProperties': [
        {
            'idMappingType': 'PROVIDER',
            'providerProperties': {
                'providerConfiguration': {...}|[...]|123|123.4|'string'|True|None,
                'providerServiceArn': 'string'
            }
        },
    ],
    'idNamespaceArn': 'string',
    'idNamespaceName': 'string',
    'inputSourceConfig': [
        {
            'inputSourceARN': 'string',
            'schemaName': 'string'
        },
    ],
    'roleArn': 'string',
    'tags': {
        'string': 'string'
    },
    'type': 'SOURCE'|'TARGET',
    'updatedAt': datetime(2015, 1, 1)
}

Response Structure

• (dict) –

  • createdAt (datetime) –

    The timestamp of when the ID namespace was created.

  • description (string) –

    The description of the ID namespace.

  • idMappingWorkflowProperties (list) –

    Determines the properties of IdMappingWorkflow where this IdNamespace can be used as a Source or a Target.

    • (dict) –

      An object containing IdMappingType and ProviderProperties.

      • idMappingType (string) –

        The type of ID mapping.

      • providerProperties (dict) –

        An object which defines any additional configurations required by the provider service.

        • providerConfiguration (document) –

          An object which defines any additional configurations required by the provider service.

        • providerServiceArn (string) –

          The Amazon Resource Name (ARN) of the provider service.

  • idNamespaceArn (string) –

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

  • idNamespaceName (string) –

    The name of the ID namespace.

  • inputSourceConfig (list) –

    A list of InputSource objects, which have the fields InputSourceARN and SchemaName.

    • (dict) –

      An object containing InputSourceARN and SchemaName.

      • inputSourceARN (string) –

        An Glue table ARN for the input source table.

      • schemaName (string) –

        The name of the schema.

  • roleArn (string) –

    The Amazon Resource Name (ARN) of the IAM role. Entity Resolution assumes this role to access the resources defined in inputSourceConfig on your behalf as part of the workflow run.

  • tags (dict) –

    The tags used to organize, track, or control access for this resource.

    • (string) –

      • (string) –

  • 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 to which all sourceIds will resolve to.

  • updatedAt (datetime) –

    The timestamp of when the ID namespace was last updated.

Exceptions

• EntityResolution.Client.exceptions.ThrottlingException

• EntityResolution.Client.exceptions.InternalServerException

• EntityResolution.Client.exceptions.AccessDeniedException

• EntityResolution.Client.exceptions.ExceedsLimitException

• EntityResolution.Client.exceptions.ConflictException

• EntityResolution.Client.exceptions.ValidationException