id_namespaces

Creates, updates, deletes, gets or lists an id_namespaces resource.

Overview

Name	id_namespaces
Type	Resource
Id	aws.entityresolution.id_namespaces

Fields

The following fields are returned by SELECT queries:

get_id_namespace

Name	Datatype	Description
created_at	string (date-time)	The timestamp of when the ID namespace was created.
description	string	The description of the ID namespace.
id_mapping_workflow_properties	array	Determines the properties of IdMappingWorkflow where this IdNamespace can be used as a Source or a Target.
id_namespace_arn	string	The Amazon Resource Name (ARN) of the ID namespace. (pattern: <code>arn:(aws|aws-us-gov|aws-cn):entityresolution:[a-z]{2}-[a-z]{1,10}-[0-9]:[0-9]{12}:(idnamespace/[a-zA-Z_0-9-]{1,255})</code>)
id_namespace_name	string	The name of the ID namespace. (pattern: <code>[a-zA-Z_0-9-]*</code>)
input_source_config	array	A list of InputSource objects, which have the fields InputSourceARN and SchemaName.
role_arn	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 a workflow run. (pattern: <code>arn:aws:iam::\d{12}:role/?[a-zA-Z_0-9+=,.@-_/]+</code>)
tags	object	The tags used to organize, track, or control access for this resource.
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. (SOURCE, TARGET)
updated_at	string (date-time)	The timestamp of when the ID namespace was last updated.

list_id_namespaces

Name	Datatype	Description
created_at	string (date-time)	The timestamp of when the ID namespace was created.
description	string	The description of the ID namespace.
id_mapping_workflow_properties	array	An object which defines any additional configurations required by the ID mapping workflow.
id_namespace_arn	string	The Amazon Resource Name (ARN) of the ID namespace. (pattern: <code>arn:(aws|aws-us-gov|aws-cn):entityresolution:[a-z]{2}-[a-z]{1,10}-[0-9]:[0-9]{12}:(idnamespace/[a-zA-Z_0-9-]{1,255})</code>)
id_namespace_name	string	The name of the ID namespace. (pattern: <code>[a-zA-Z_0-9-]*</code>)
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. (SOURCE, TARGET)
updated_at	string (date-time)	The timestamp of when the ID namespace was last updated.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_id_namespace	select	id_namespace_name, region		Returns the IdNamespace with a given name, if it exists.
list_id_namespaces	select	region	nextToken, maxResults	Returns a list of all ID namespaces.
create_id_namespace	insert	region, idNamespaceName, type		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.
update_id_namespace	update	id_namespace_name, region		Updates an existing ID namespace.
delete_id_namespace	delete	id_namespace_name, region		Deletes the IdNamespace with a given name. This operation returns a ResourceNotFoundException if an ID namespace with the given name does not exist.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
id_namespace_name	string	The name of the ID namespace.
region	string	AWS region (default: us-east-1)
maxResults	integer	The maximum number of IdNamespace objects returned per page.
nextToken	string	The pagination token from the previous API call.

SELECT examples

get_id_namespace

Returns the IdNamespace with a given name, if it exists.

SELECT
created_at,
description,
id_mapping_workflow_properties,
id_namespace_arn,
id_namespace_name,
input_source_config,
role_arn,
tags,
type_,
updated_at
FROM aws.entityresolution.id_namespaces
WHERE id_namespace_name = '{{ id_namespace_name }}' -- required
AND region = '{{ region }}' -- required
;

list_id_namespaces

Returns a list of all ID namespaces.

SELECT
created_at,
description,
id_mapping_workflow_properties,
id_namespace_arn,
id_namespace_name,
type_,
updated_at
FROM aws.entityresolution.id_namespaces
WHERE region = '{{ region }}' -- required
AND nextToken = '{{ nextToken }}'
AND maxResults = '{{ maxResults }}'
;

INSERT examples

create_id_namespace

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.

INSERT INTO aws.entityresolution.id_namespaces (
idNamespaceName,
description,
inputSourceConfig,
idMappingWorkflowProperties,
type,
roleArn,
tags,
region
)
SELECT 
'{{ idNamespaceName }}' /* required */,
'{{ description }}',
'{{ inputSourceConfig }}',
'{{ idMappingWorkflowProperties }}',
'{{ type }}' /* required */,
'{{ roleArn }}',
'{{ tags }}',
'{{ region }}'
RETURNING
created_at,
description,
id_mapping_workflow_properties,
id_namespace_arn,
id_namespace_name,
input_source_config,
role_arn,
tags,
type_,
updated_at
;

Manifest

# Description fields are for documentation purposes
- name: id_namespaces
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the id_namespaces resource.
  - name: idNamespaceName
    value: "{{ idNamespaceName }}"
  - name: description
    value: "{{ description }}"
  - name: inputSourceConfig
    value:
      - inputSourceARN: "{{ inputSourceARN }}"
        schemaName: "{{ schemaName }}"
  - name: idMappingWorkflowProperties
    value:
      - idMappingType: "{{ idMappingType }}"
        ruleBasedProperties:
          rules:
            - ruleName: "{{ ruleName }}"
              matchingKeys: "{{ matchingKeys }}"
          ruleDefinitionTypes:
            - "{{ ruleDefinitionTypes }}"
          attributeMatchingModel: "{{ attributeMatchingModel }}"
          recordMatchingModels:
            - "{{ recordMatchingModels }}"
        providerProperties:
          providerServiceArn: "{{ providerServiceArn }}"
          providerConfiguration: "{{ providerConfiguration }}"
  - name: type
    value: "{{ type }}"
    valid_values: ['SOURCE', 'TARGET']
  - name: roleArn
    value: "{{ roleArn }}"
  - name: tags
    value: "{{ tags }}"

UPDATE examples

update_id_namespace

Updates an existing ID namespace.

UPDATE aws.entityresolution.id_namespaces
SET 
description = '{{ description }}',
inputSourceConfig = '{{ inputSourceConfig }}',
idMappingWorkflowProperties = '{{ idMappingWorkflowProperties }}',
roleArn = '{{ roleArn }}'
WHERE 
id_namespace_name = '{{ id_namespace_name }}' --required
AND region = '{{ region }}' --required
RETURNING
created_at,
description,
id_mapping_workflow_properties,
id_namespace_arn,
id_namespace_name,
input_source_config,
role_arn,
type_,
updated_at;

DELETE examples

delete_id_namespace

Deletes the IdNamespace with a given name. This operation returns a ResourceNotFoundException if an ID namespace with the given name does not exist.

DELETE FROM aws.entityresolution.id_namespaces
WHERE id_namespace_name = '{{ id_namespace_name }}' --required
AND region = '{{ region }}' --required
;