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

PopulateIdMappingTable

Defines the information that's necessary to populate an ID mapping table.

Request Syntax


POST /memberships/membershipIdentifier/idmappingtables/idMappingTableIdentifier/populate HTTP/1.1
Content-type: application/json

{
   "jobType": "string"
}

URI Request Parameters

The request uses the following URI parameters.

idMappingTableIdentifier

The unique identifier of the ID mapping table that you want to populate.

Length Constraints: Fixed length of 36.

Pattern: [0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}

Required: Yes

membershipIdentifier

The unique identifier of the membership that contains the ID mapping table that you want to populate.

Length Constraints: Fixed length of 36.

Pattern: [0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}

Required: Yes

Request Body

The request accepts the following data in JSON format.

jobType

The job type of the rule-based ID mapping job. Valid values include:

INCREMENTAL: Processes only new or changed data since the last job run. This is the default job type if the ID mapping workflow was created in AWS Entity Resolution with incrementalRunConfig specified.

BATCH: Processes all data from the input source, regardless of previous job runs. This is the default job type if the ID mapping workflow was created in AWS Entity Resolution but incrementalRunConfig wasn't specified.

DELETE_ONLY: Processes only deletion requests from BatchDeleteUniqueId, which is set in AWS Entity Resolution.

For more information about incrementalRunConfig and BatchDeleteUniqueId, see the AWS Entity Resolution API Reference.

Type: String

Valid Values: BATCH | INCREMENTAL | DELETE_ONLY

Required: No

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "idMappingJobId": "string"
}

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.

idMappingJobId

The unique identifier of the mapping job that will populate the ID mapping table.

Type: String

Length Constraints: Fixed length of 36.

Pattern: [0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}

Errors

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

AccessDeniedException

Caller does not have sufficient access to perform this action.

reason: A reason code for the exception.

HTTP Status Code: 403

ConflictException

Updating or deleting a resource can cause an inconsistent state.

reason: A reason code for the exception.
resourceId: The ID of the conflicting resource.
resourceType: The type of the conflicting resource.

HTTP Status Code: 409

InternalServerException

Unexpected error during processing of request.

HTTP Status Code: 500

ResourceNotFoundException

Request references a resource which does not exist.

resourceId: The Id of the missing resource.
resourceType: The type of the missing resource.

HTTP Status Code: 404

ServiceQuotaExceededException

Request denied because service quota has been exceeded.

quotaName: The name of the quota.
quotaValue: The value of the quota.

HTTP Status Code: 402

ThrottlingException

Request was denied due to request throttling.

HTTP Status Code: 429

ValidationException

The input fails to satisfy the specified constraints.

fieldList: Validation errors for specific input parameters.
reason: A reason code for the exception.

HTTP Status Code: 400