UpdateIdNamespace
Updates an existing ID namespace.
Request Syntax
PUT /idnamespaces/idNamespaceName
HTTP/1.1
Content-type: application/json
{
"description": "string
",
"idMappingWorkflowProperties": [
{
"idMappingType": "string
",
"providerProperties": {
"providerConfiguration": JSON value
,
"providerServiceArn": "string
"
},
"ruleBasedProperties": {
"attributeMatchingModel": "string
",
"recordMatchingModels": [ "string
" ],
"ruleDefinitionTypes": [ "string
" ],
"rules": [
{
"matchingKeys": [ "string
" ],
"ruleName": "string
"
}
]
}
}
],
"inputSourceConfig": [
{
"inputSourceARN": "string
",
"schemaName": "string
"
}
],
"roleArn": "string
"
}
URI Request Parameters
The request uses the following URI parameters.
- idNamespaceName
-
The name of the ID namespace.
Length Constraints: Minimum length of 1. Maximum length of 255.
Pattern:
^[a-zA-Z_0-9-]*$
Required: Yes
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
IdMappingWorkflow
where thisIdNamespace
can be used as aSource
or aTarget
.Type: Array of IdNamespaceIdMappingWorkflowProperties objects
Array Members: Fixed number of 1 item.
Required: No
- inputSourceConfig
-
A list of
InputSource
objects, which have the fieldsInputSourceARN
andSchemaName
.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 a 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
Response Syntax
HTTP/1.1 200
Content-type: application/json
{
"createdAt": number,
"description": "string",
"idMappingWorkflowProperties": [
{
"idMappingType": "string",
"providerProperties": {
"providerConfiguration": JSON value,
"providerServiceArn": "string"
},
"ruleBasedProperties": {
"attributeMatchingModel": "string",
"recordMatchingModels": [ "string" ],
"ruleDefinitionTypes": [ "string" ],
"rules": [
{
"matchingKeys": [ "string" ],
"ruleName": "string"
}
]
}
}
],
"idNamespaceArn": "string",
"idNamespaceName": "string",
"inputSourceConfig": [
{
"inputSourceARN": "string",
"schemaName": "string"
}
],
"roleArn": "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 thisIdNamespace
can be used as aSource
or aTarget
.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 fieldsInputSourceARN
andSchemaName
.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 this
IdNamespace
on your behalf as part of a 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+=,.@\-_/]+$
- type
-
The type of ID namespace. There are two types:
SOURCE
andTARGET
.The
SOURCE
contains configurations forsourceId
data that will be processed in an ID mapping workflow.The
TARGET
contains a configuration oftargetId
to which allsourceIds
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
- InternalServerException
-
This exception occurs when there is an internal failure in the AWS Entity Resolution service.
HTTP Status Code: 500
- ResourceNotFoundException
-
The resource could not be found.
HTTP Status Code: 404
- ThrottlingException
-
The request was denied due to request throttling.
HTTP Status Code: 429
- ValidationException
-
The input fails to satisfy the constraints specified by AWS Entity Resolution.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: