id_namespaces

Creates, updates, deletes or gets an id_namespace resource or lists id_namespaces in a region

Overview

Name	id_namespaces
Type	Resource
Description	IdNamespace defined in AWS Entity Resolution service
Id	aws.entityresolution.id_namespaces

Fields

Name	Datatype	Description
id_namespace_name	string
description	string
input_source_config	array
id_mapping_workflow_properties	array
type	string
role_arn	string
id_namespace_arn	string	The arn associated with the IdNamespace
created_at	string	The date and time when the IdNamespace was created
updated_at	string	The date and time when the IdNamespace was updated
tags	array
region	string	AWS region.

Methods

Name	Accessible by	Required Params
create_resource	INSERT	IdNamespaceName, Type, region
delete_resource	DELETE	data__Identifier, region
update_resource	UPDATE	data__Identifier, data__PatchDocument, region
list_resources	SELECT	region
get_resource	SELECT	data__Identifier, region

SELECT examples

Gets all id_namespaces in a region.

SELECT
region,
id_namespace_name,
description,
input_source_config,
id_mapping_workflow_properties,
type,
role_arn,
id_namespace_arn,
created_at,
updated_at,
tags
FROM aws.entityresolution.id_namespaces
WHERE region = 'us-east-1';

Gets all properties from an individual id_namespace.

SELECT
region,
id_namespace_name,
description,
input_source_config,
id_mapping_workflow_properties,
type,
role_arn,
id_namespace_arn,
created_at,
updated_at,
tags
FROM aws.entityresolution.id_namespaces
WHERE region = 'us-east-1' AND data__Identifier = '<IdNamespaceName>';

INSERT example

Use the following StackQL query and manifest file to create a new id_namespace resource, using stack-deploy.

Required Properties

/*+ create */
INSERT INTO aws.entityresolution.id_namespaces (
 IdNamespaceName,
 Type,
 region
)
SELECT 
'{{ IdNamespaceName }}',
 '{{ Type }}',
'{{ region }}';

All Properties

/*+ create */
INSERT INTO aws.entityresolution.id_namespaces (
 IdNamespaceName,
 Description,
 InputSourceConfig,
 IdMappingWorkflowProperties,
 Type,
 RoleArn,
 Tags,
 region
)
SELECT 
 '{{ IdNamespaceName }}',
 '{{ Description }}',
 '{{ InputSourceConfig }}',
 '{{ IdMappingWorkflowProperties }}',
 '{{ Type }}',
 '{{ RoleArn }}',
 '{{ Tags }}',
 '{{ region }}';

Manifest

version: 1
name: stack name
description: stack description
providers:
  - aws
globals:
  - name: region
    value: '{{ vars.AWS_REGION }}'
resources:
  - name: id_namespace
    props:
      - name: IdNamespaceName
        value: '{{ IdNamespaceName }}'
      - name: Description
        value: '{{ Description }}'
      - name: InputSourceConfig
        value:
          - InputSourceARN: '{{ InputSourceARN }}'
            SchemaName: null
      - name: IdMappingWorkflowProperties
        value:
          - IdMappingType: '{{ IdMappingType }}'
            ProviderProperties:
              ProviderServiceArn: '{{ ProviderServiceArn }}'
              ProviderConfiguration: {}
      - name: Type
        value: '{{ Type }}'
      - name: RoleArn
        value: '{{ RoleArn }}'
      - name: Tags
        value:
          - Key: '{{ Key }}'
            Value: '{{ Value }}'

DELETE example

/*+ delete */
DELETE FROM aws.entityresolution.id_namespaces
WHERE data__Identifier = '<IdNamespaceName>'
AND region = 'us-east-1';

Permissions

To operate on the id_namespaces resource, the following permissions are required:

Create

entityresolution:CreateIdNamespace,
entityresolution:TagResource,
iam:PassRole

Read

entityresolution:GetIdNamespace,
entityresolution:ListTagsForResource

Update

entityresolution:UpdateIdNamespace,
entityresolution:ListTagsForResource,
entityresolution:TagResource,
entityresolution:UntagResource,
iam:PassRole

Delete

entityresolution:DeleteIdNamespace,
entityresolution:GetIdNamespace,
entityresolution:UntagResource

List

entityresolution:ListIdNamespaces