Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

CreateIdNamespace

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.

Request Syntax


POST /idnamespaces HTTP/1.1
Content-type: application/json

{
   "description": "string",
   "idMappingWorkflowProperties": [ 
      { 
         "idMappingType": "string",
         "providerProperties": { 
            "providerConfiguration": JSON value,
            "providerServiceArn": "string"
         }
      }
   ],
   "idNamespaceName": "string",
   "inputSourceConfig": [ 
      { 
         "inputSourceARN": "string",
         "schemaName": "string"
      }
   ],
   "roleArn": "string",
   "tags": { 
      "string" : "string" 
   },
   "type": "string"
}

URI Request Parameters

The request does not use any URI parameters.

Request Body

The request accepts the following data in JSON format.

description

The description of the ID namespace.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 255.

Required: No

idMappingWorkflowProperties

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

Type: Array of IdNamespaceIdMappingWorkflowProperties objects

Array Members: Fixed number of 1 item.

Required: No

idNamespaceName

The name of the ID namespace.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 255.

Pattern: ^[a-zA-Z_0-9-]*$

Required: Yes

inputSourceConfig

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

Type: Array of IdNamespaceInputSource objects

Array Members: Minimum number of 0 items. Maximum number of 20 items.

Required: No

roleArn

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

Type: String

Length Constraints: Minimum length of 32. Maximum length of 512.

Pattern: ^arn:aws:iam::\d{12}:role/?[a-zA-Z_0-9+=,.@\-_/]+$

Required: No

tags

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

Type: String to string map

Map Entries: Minimum number of 0 items. Maximum number of 200 items.

Key Length Constraints: Minimum length of 1. Maximum length of 128.

Value Length Constraints: Minimum length of 0. Maximum length of 256.

Required: No

type

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.

Type: String

Valid Values: SOURCE | TARGET

Required: Yes

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "createdAt": number,
   "description": "string",
   "idMappingWorkflowProperties": [ 
      { 
         "idMappingType": "string",
         "providerProperties": { 
            "providerConfiguration": JSON value,
            "providerServiceArn": "string"
         }
      }
   ],
   "idNamespaceArn": "string",
   "idNamespaceName": "string",
   "inputSourceConfig": [ 
      { 
         "inputSourceARN": "string",
         "schemaName": "string"
      }
   ],
   "roleArn": "string",
   "tags": { 
      "string" : "string" 
   },
   "type": "string",
   "updatedAt": number
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

createdAt

The timestamp of when the ID namespace was created.

Type: Timestamp

description

The description of the ID namespace.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 255.

idMappingWorkflowProperties

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

Type: Array of IdNamespaceIdMappingWorkflowProperties objects

Array Members: Fixed number of 1 item.

idNamespaceArn

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

Type: String

Pattern: ^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})$

idNamespaceName

The name of the ID namespace.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 255.

Pattern: ^[a-zA-Z_0-9-]*$

inputSourceConfig

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

Type: Array of IdNamespaceInputSource objects

Array Members: Minimum number of 0 items. Maximum number of 20 items.

roleArn

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

Type: String

Length Constraints: Minimum length of 32. Maximum length of 512.

Pattern: ^arn:aws:iam::\d{12}:role/?[a-zA-Z_0-9+=,.@\-_/]+$

tags

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

Type: String to string map

Map Entries: Minimum number of 0 items. Maximum number of 200 items.

Key Length Constraints: Minimum length of 1. Maximum length of 128.

Value Length Constraints: Minimum length of 0. Maximum length of 256.

type

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.

Type: String

Valid Values: SOURCE | TARGET

updatedAt

The timestamp of when the ID namespace was last updated.

Type: Timestamp

Errors

For information about the errors that are common to all actions, see Common Errors.

AccessDeniedException

You do not have sufficient access to perform this action. HTTP Status Code: 403

HTTP Status Code: 403

ConflictException

The request could not be processed because of conflict in the current state of the resource. Example: Workflow already exists, Schema already exists, Workflow is currently running, etc. HTTP Status Code: 400

HTTP Status Code: 400

ExceedsLimitException

The request was rejected because it attempted to create resources beyond the current AWS Entity Resolution account limits. The error message describes the limit exceeded. HTTP Status Code: 402

HTTP Status Code: 402

InternalServerException

This exception occurs when there is an internal failure in the AWS Entity Resolution service. HTTP Status Code: 500

HTTP Status Code: 500

ThrottlingException

The request was denied due to request throttling. HTTP Status Code: 429

HTTP Status Code: 429

ValidationException

The input fails to satisfy the constraints specified by AWS Entity Resolution. HTTP Status Code: 400

HTTP Status Code: 400