2024/04/16 - AWS EntityResolution - 9 new8 updated api methods
Changes Cross Account Resource Support .
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.
See also: AWS API Documentation
Request Syntax
client.create_id_namespace(
description='string',
idMappingWorkflowProperties=[
{
'idMappingType': 'PROVIDER',
'providerProperties': {
'providerConfiguration': {...}|[...]|123|123.4|'string'|True|None,
'providerServiceArn': 'string'
}
},
],
idNamespaceName='string',
inputSourceConfig=[
{
'inputSourceARN': 'string',
'schemaName': 'string'
},
],
roleArn='string',
tags={
'string': 'string'
},
type='SOURCE'|'TARGET'
)
string
The description of the ID namespace.
list
Determines the properties of IdMappingWorflow where this IdNamespace can be used as a Source or a Target.
(dict) --
An object containing IdMappingType and ProviderProperties.
idMappingType (string) -- [REQUIRED]
The type of ID mapping.
providerProperties (dict) --
An object which defines any additional configurations required by the provider service.
providerConfiguration (:ref:`document<document>`) --
An object which defines any additional configurations required by the provider service.
providerServiceArn (string) -- [REQUIRED]
The Amazon Resource Name (ARN) of the provider service.
string
[REQUIRED]
The name of the ID namespace.
list
A list of InputSource objects, which have the fields InputSourceARN and SchemaName.
(dict) --
An object containing InputSourceARN and SchemaName.
inputSourceARN (string) -- [REQUIRED]
An Glue table ARN for the input source table.
schemaName (string) --
The name of the schema.
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 the workflow run.
dict
The tags used to organize, track, or control access for this resource.
(string) --
(string) --
string
[REQUIRED]
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.
dict
Response Syntax
{
'createdAt': datetime(2015, 1, 1),
'description': 'string',
'idMappingWorkflowProperties': [
{
'idMappingType': 'PROVIDER',
'providerProperties': {
'providerConfiguration': {...}|[...]|123|123.4|'string'|True|None,
'providerServiceArn': 'string'
}
},
],
'idNamespaceArn': 'string',
'idNamespaceName': 'string',
'inputSourceConfig': [
{
'inputSourceARN': 'string',
'schemaName': 'string'
},
],
'roleArn': 'string',
'tags': {
'string': 'string'
},
'type': 'SOURCE'|'TARGET',
'updatedAt': datetime(2015, 1, 1)
}
Response Structure
(dict) --
createdAt (datetime) --
The timestamp of when the ID namespace was created.
description (string) --
The description of the ID namespace.
idMappingWorkflowProperties (list) --
Determines the properties of IdMappingWorkflow where this IdNamespace can be used as a Source or a Target.
(dict) --
An object containing IdMappingType and ProviderProperties.
idMappingType (string) --
The type of ID mapping.
providerProperties (dict) --
An object which defines any additional configurations required by the provider service.
providerConfiguration (:ref:`document<document>`) --
An object which defines any additional configurations required by the provider service.
providerServiceArn (string) --
The Amazon Resource Name (ARN) of the provider service.
idNamespaceArn (string) --
The Amazon Resource Name (ARN) of the ID namespace.
idNamespaceName (string) --
The name of the ID namespace.
inputSourceConfig (list) --
A list of InputSource objects, which have the fields InputSourceARN and SchemaName.
(dict) --
An object containing InputSourceARN and SchemaName.
inputSourceARN (string) --
An Glue table ARN for the input source table.
schemaName (string) --
The name of the schema.
roleArn (string) --
The Amazon Resource Name (ARN) of the IAM role. Entity Resolution assumes this role to access the resources defined in inputSourceConfig on your behalf as part of the workflow run.
tags (dict) --
The tags used to organize, track, or control access for this resource.
(string) --
(string) --
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.
updatedAt (datetime) --
The timestamp of when the ID namespace was last updated.
Deletes the IdNamespace with a given name.
See also: AWS API Documentation
Request Syntax
client.delete_id_namespace(
idNamespaceName='string'
)
string
[REQUIRED]
The name of the ID namespace.
dict
Response Syntax
{
'message': 'string'
}
Response Structure
(dict) --
message (string) --
A successful operation message.
Deletes the policy statement.
See also: AWS API Documentation
Request Syntax
client.delete_policy_statement(
arn='string',
statementId='string'
)
string
[REQUIRED]
The ARN of the resource for which the policy need to be deleted.
string
[REQUIRED]
A statement identifier that differentiates the statement from others in the same policy.
dict
Response Syntax
{
'arn': 'string',
'policy': 'string',
'token': 'string'
}
Response Structure
(dict) --
arn (string) --
The ARN of the resource for which the policy need to be deleted.
policy (string) --
The resource-based policy.
token (string) --
A unique identifier for the deleted policy.
Returns the resource-based policy.
See also: AWS API Documentation
Request Syntax
client.get_policy(
arn='string'
)
string
[REQUIRED]
The Amazon Resource Name (ARN) of the resource for which the policy need to be returned.
dict
Response Syntax
{
'arn': 'string',
'policy': 'string',
'token': 'string'
}
Response Structure
(dict) --
arn (string) --
The Entity Resolution resource ARN.
policy (string) --
The resource-based policy.
token (string) --
A unique identifier for the current revision of the policy.
Returns a list of all ID namespaces.
See also: AWS API Documentation
Request Syntax
client.list_id_namespaces(
maxResults=123,
nextToken='string'
)
integer
The maximum number of IdNamespace objects returned per page.
string
The pagination token from the previous API call.
dict
Response Syntax
{
'idNamespaceSummaries': [
{
'createdAt': datetime(2015, 1, 1),
'description': 'string',
'idNamespaceArn': 'string',
'idNamespaceName': 'string',
'type': 'SOURCE'|'TARGET',
'updatedAt': datetime(2015, 1, 1)
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
idNamespaceSummaries (list) --
A list of IdNamespaceSummaries objects.
(dict) --
A summary of ID namespaces.
createdAt (datetime) --
The timestamp of when the ID namespace was created.
description (string) --
The description of the ID namespace.
idNamespaceArn (string) --
The Amazon Resource Name (ARN) of the ID namespace.
idNamespaceName (string) --
The name of the ID namespace.
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.
updatedAt (datetime) --
The timestamp of when the ID namespace was last updated.
nextToken (string) --
The pagination token from the previous API call.
Returns the IdNamespace with a given name, if it exists.
See also: AWS API Documentation
Request Syntax
client.get_id_namespace(
idNamespaceName='string'
)
string
[REQUIRED]
The name of the ID namespace.
dict
Response Syntax
{
'createdAt': datetime(2015, 1, 1),
'description': 'string',
'idMappingWorkflowProperties': [
{
'idMappingType': 'PROVIDER',
'providerProperties': {
'providerConfiguration': {...}|[...]|123|123.4|'string'|True|None,
'providerServiceArn': 'string'
}
},
],
'idNamespaceArn': 'string',
'idNamespaceName': 'string',
'inputSourceConfig': [
{
'inputSourceARN': 'string',
'schemaName': 'string'
},
],
'roleArn': 'string',
'tags': {
'string': 'string'
},
'type': 'SOURCE'|'TARGET',
'updatedAt': datetime(2015, 1, 1)
}
Response Structure
(dict) --
createdAt (datetime) --
The timestamp of when the ID namespace was created.
description (string) --
The description of the ID namespace.
idMappingWorkflowProperties (list) --
Determines the properties of IdMappingWorkflow where this IdNamespace can be used as a Source or a Target.
(dict) --
An object containing IdMappingType and ProviderProperties.
idMappingType (string) --
The type of ID mapping.
providerProperties (dict) --
An object which defines any additional configurations required by the provider service.
providerConfiguration (:ref:`document<document>`) --
An object which defines any additional configurations required by the provider service.
providerServiceArn (string) --
The Amazon Resource Name (ARN) of the provider service.
idNamespaceArn (string) --
The Amazon Resource Name (ARN) of the ID namespace.
idNamespaceName (string) --
The name of the ID namespace.
inputSourceConfig (list) --
A list of InputSource objects, which have the fields InputSourceARN and SchemaName.
(dict) --
An object containing InputSourceARN and SchemaName.
inputSourceARN (string) --
An Glue table ARN for the input source table.
schemaName (string) --
The name of the schema.
roleArn (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.
tags (dict) --
The tags used to organize, track, or control access for this resource.
(string) --
(string) --
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.
updatedAt (datetime) --
The timestamp of when the ID namespace was last updated.
Adds a policy statement object. To retrieve a list of existing policy statements, use the GetPolicy API.
See also: AWS API Documentation
Request Syntax
client.add_policy_statement(
action=[
'string',
],
arn='string',
condition='string',
effect='Allow'|'Deny',
principal=[
'string',
],
statementId='string'
)
list
[REQUIRED]
The action that the principal can use on the resource.
For example, entityresolution:GetIdMappingJob, entityresolution:GetMatchingJob.
(string) --
string
[REQUIRED]
The Amazon Resource Name (ARN) of the resource that will be accessed by the principal.
string
A set of condition keys that you can use in key policies.
string
[REQUIRED]
Determines whether the permissions specified in the policy are to be allowed ( Allow) or denied ( Deny).
list
[REQUIRED]
The Amazon Web Services service or Amazon Web Services account that can access the resource defined as ARN.
(string) --
string
[REQUIRED]
A statement identifier that differentiates the statement from others in the same policy.
dict
Response Syntax
{
'arn': 'string',
'policy': 'string',
'token': 'string'
}
Response Structure
(dict) --
arn (string) --
The Amazon Resource Name (ARN) of the resource that will be accessed by the principal.
policy (string) --
The resource-based policy.
token (string) --
A unique identifier for the current revision of the policy.
Updates an existing ID namespace.
See also: AWS API Documentation
Request Syntax
client.update_id_namespace(
description='string',
idMappingWorkflowProperties=[
{
'idMappingType': 'PROVIDER',
'providerProperties': {
'providerConfiguration': {...}|[...]|123|123.4|'string'|True|None,
'providerServiceArn': 'string'
}
},
],
idNamespaceName='string',
inputSourceConfig=[
{
'inputSourceARN': 'string',
'schemaName': 'string'
},
],
roleArn='string'
)
string
The description of the ID namespace.
list
Determines the properties of IdMappingWorkflow where this IdNamespace can be used as a Source or a Target.
(dict) --
An object containing IdMappingType and ProviderProperties.
idMappingType (string) -- [REQUIRED]
The type of ID mapping.
providerProperties (dict) --
An object which defines any additional configurations required by the provider service.
providerConfiguration (:ref:`document<document>`) --
An object which defines any additional configurations required by the provider service.
providerServiceArn (string) -- [REQUIRED]
The Amazon Resource Name (ARN) of the provider service.
string
[REQUIRED]
The name of the ID namespace.
list
A list of InputSource objects, which have the fields InputSourceARN and SchemaName.
(dict) --
An object containing InputSourceARN and SchemaName.
inputSourceARN (string) -- [REQUIRED]
An Glue table ARN for the input source table.
schemaName (string) --
The name of the schema.
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.
dict
Response Syntax
{
'createdAt': datetime(2015, 1, 1),
'description': 'string',
'idMappingWorkflowProperties': [
{
'idMappingType': 'PROVIDER',
'providerProperties': {
'providerConfiguration': {...}|[...]|123|123.4|'string'|True|None,
'providerServiceArn': 'string'
}
},
],
'idNamespaceArn': 'string',
'idNamespaceName': 'string',
'inputSourceConfig': [
{
'inputSourceARN': 'string',
'schemaName': 'string'
},
],
'roleArn': 'string',
'type': 'SOURCE'|'TARGET',
'updatedAt': datetime(2015, 1, 1)
}
Response Structure
(dict) --
createdAt (datetime) --
The timestamp of when the ID namespace was created.
description (string) --
The description of the ID namespace.
idMappingWorkflowProperties (list) --
Determines the properties of IdMappingWorkflow where this IdNamespace can be used as a Source or a Target.
(dict) --
An object containing IdMappingType and ProviderProperties.
idMappingType (string) --
The type of ID mapping.
providerProperties (dict) --
An object which defines any additional configurations required by the provider service.
providerConfiguration (:ref:`document<document>`) --
An object which defines any additional configurations required by the provider service.
providerServiceArn (string) --
The Amazon Resource Name (ARN) of the provider service.
idNamespaceArn (string) --
The Amazon Resource Name (ARN) of the ID namespace.
idNamespaceName (string) --
The name of the ID namespace.
inputSourceConfig (list) --
A list of InputSource objects, which have the fields InputSourceARN and SchemaName.
(dict) --
An object containing InputSourceARN and SchemaName.
inputSourceARN (string) --
An Glue table ARN for the input source table.
schemaName (string) --
The name of the schema.
roleArn (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.
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.
updatedAt (datetime) --
The timestamp of when the ID namespace was last updated.
Updates the resource-based policy.
See also: AWS API Documentation
Request Syntax
client.put_policy(
arn='string',
policy='string',
token='string'
)
string
[REQUIRED]
The Amazon Resource Name (ARN) of the resource for which the policy needs to be updated.
string
[REQUIRED]
The resource-based policy.
string
A unique identifier for the current revision of the policy.
dict
Response Syntax
{
'arn': 'string',
'policy': 'string',
'token': 'string'
}
Response Structure
(dict) --
arn (string) --
The Entity Resolution resource ARN.
policy (string) --
The resource-based policy.
token (string) --
A unique identifier for the current revision of the policy.
{'inputSourceConfig': {'type': 'SOURCE | TARGET'}}
Creates an IdMappingWorkflow object which stores the configuration of the data processing job to be run. Each IdMappingWorkflow must have a unique workflow name. To modify an existing workflow, use the UpdateIdMappingWorkflow API.
See also: AWS API Documentation
Request Syntax
client.create_id_mapping_workflow(
description='string',
idMappingTechniques={
'idMappingType': 'PROVIDER',
'providerProperties': {
'intermediateSourceConfiguration': {
'intermediateS3Path': 'string'
},
'providerConfiguration': {...}|[...]|123|123.4|'string'|True|None,
'providerServiceArn': 'string'
}
},
inputSourceConfig=[
{
'inputSourceARN': 'string',
'schemaName': 'string',
'type': 'SOURCE'|'TARGET'
},
],
outputSourceConfig=[
{
'KMSArn': 'string',
'outputS3Path': 'string'
},
],
roleArn='string',
tags={
'string': 'string'
},
workflowName='string'
)
string
A description of the workflow.
dict
[REQUIRED]
An object which defines the idMappingType and the providerProperties.
idMappingType (string) -- [REQUIRED]
The type of ID mapping.
providerProperties (dict) --
An object which defines any additional configurations required by the provider service.
intermediateSourceConfiguration (dict) --
The Amazon S3 location that temporarily stores your data while it processes. Your information won't be saved permanently.
intermediateS3Path (string) -- [REQUIRED]
The Amazon S3 location (bucket and prefix). For example: s3://provider_bucket/DOC-EXAMPLE-BUCKET
providerConfiguration (:ref:`document<document>`) --
The required configuration fields to use with the provider service.
providerServiceArn (string) -- [REQUIRED]
The ARN of the provider service.
list
[REQUIRED]
A list of InputSource objects, which have the fields InputSourceARN and SchemaName.
(dict) --
An object containing InputSourceARN, SchemaName, and Type.
inputSourceARN (string) -- [REQUIRED]
An Glue table ARN for the input source table.
schemaName (string) --
The name of the schema to be retrieved.
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.
list
A list of IdMappingWorkflowOutputSource objects, each of which contains fields OutputS3Path and Output.
(dict) --
The output source for the ID mapping workflow.
KMSArn (string) --
Customer KMS ARN for encryption at rest. If not provided, system will use an Entity Resolution managed KMS key.
outputS3Path (string) -- [REQUIRED]
The S3 path to which Entity Resolution will write the output table.
string
[REQUIRED]
The Amazon Resource Name (ARN) of the IAM role. Entity Resolution assumes this role to create resources on your behalf as part of workflow execution.
dict
The tags used to organize, track, or control access for this resource.
(string) --
(string) --
string
[REQUIRED]
The name of the workflow. There can't be multiple IdMappingWorkflows with the same name.
dict
Response Syntax
{
'description': 'string',
'idMappingTechniques': {
'idMappingType': 'PROVIDER',
'providerProperties': {
'intermediateSourceConfiguration': {
'intermediateS3Path': 'string'
},
'providerConfiguration': {...}|[...]|123|123.4|'string'|True|None,
'providerServiceArn': 'string'
}
},
'inputSourceConfig': [
{
'inputSourceARN': 'string',
'schemaName': 'string',
'type': 'SOURCE'|'TARGET'
},
],
'outputSourceConfig': [
{
'KMSArn': 'string',
'outputS3Path': 'string'
},
],
'roleArn': 'string',
'workflowArn': 'string',
'workflowName': 'string'
}
Response Structure
(dict) --
description (string) --
A description of the workflow.
idMappingTechniques (dict) --
An object which defines the idMappingType and the providerProperties.
idMappingType (string) --
The type of ID mapping.
providerProperties (dict) --
An object which defines any additional configurations required by the provider service.
intermediateSourceConfiguration (dict) --
The Amazon S3 location that temporarily stores your data while it processes. Your information won't be saved permanently.
intermediateS3Path (string) --
The Amazon S3 location (bucket and prefix). For example: s3://provider_bucket/DOC-EXAMPLE-BUCKET
providerConfiguration (:ref:`document<document>`) --
The required configuration fields to use with the provider service.
providerServiceArn (string) --
The ARN of the provider service.
inputSourceConfig (list) --
A list of InputSource objects, which have the fields InputSourceARN and SchemaName.
(dict) --
An object containing InputSourceARN, SchemaName, and Type.
inputSourceARN (string) --
An Glue table ARN for the input source table.
schemaName (string) --
The name of the schema to be retrieved.
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.
outputSourceConfig (list) --
A list of IdMappingWorkflowOutputSource objects, each of which contains fields OutputS3Path and Output.
(dict) --
The output source for the ID mapping workflow.
KMSArn (string) --
Customer KMS ARN for encryption at rest. If not provided, system will use an Entity Resolution managed KMS key.
outputS3Path (string) --
The S3 path to which Entity Resolution will write the output table.
roleArn (string) --
The Amazon Resource Name (ARN) of the IAM role. Entity Resolution assumes this role to create resources on your behalf as part of workflow execution.
workflowArn (string) --
The ARN (Amazon Resource Name) that Entity Resolution generated for the IDMappingWorkflow.
workflowName (string) --
The name of the workflow.
{'outputSourceConfig': [{'KMSArn': 'string',
'outputS3Path': 'string',
'roleArn': 'string'}]}
Gets the status, metrics, and errors (if there are any) that are associated with a job.
See also: AWS API Documentation
Request Syntax
client.get_id_mapping_job(
jobId='string',
workflowName='string'
)
string
[REQUIRED]
The ID of the job.
string
[REQUIRED]
The name of the workflow.
dict
Response Syntax
{
'endTime': datetime(2015, 1, 1),
'errorDetails': {
'errorMessage': 'string'
},
'jobId': 'string',
'metrics': {
'inputRecords': 123,
'recordsNotProcessed': 123,
'totalRecordsProcessed': 123
},
'outputSourceConfig': [
{
'KMSArn': 'string',
'outputS3Path': 'string',
'roleArn': 'string'
},
],
'startTime': datetime(2015, 1, 1),
'status': 'RUNNING'|'SUCCEEDED'|'FAILED'|'QUEUED'
}
Response Structure
(dict) --
endTime (datetime) --
The time at which the job has finished.
errorDetails (dict) --
An object containing an error message, if there was an error.
errorMessage (string) --
The error message from the job, if there is one.
jobId (string) --
The ID of the job.
metrics (dict) --
Metrics associated with the execution, specifically total records processed, unique IDs generated, and records the execution skipped.
inputRecords (integer) --
The total number of input records.
recordsNotProcessed (integer) --
The total number of records that did not get processed.
totalRecordsProcessed (integer) --
The total number of records processed.
outputSourceConfig (list) --
A list of OutputSource objects.
(dict) --
An object containing KMSArn, OutputS3Path, and RoleARN.
KMSArn (string) --
Customer KMS ARN for encryption at rest. If not provided, system will use an Entity Resolution managed KMS key.
outputS3Path (string) --
The S3 path to which Entity Resolution will write the output table.
roleArn (string) --
The Amazon Resource Name (ARN) of the IAM role. Entity Resolution assumes this role to access Amazon Web Services resources on your behalf as part of workflow execution.
startTime (datetime) --
The time at which the job was started.
status (string) --
The current status of the job.
{'inputSourceConfig': {'type': 'SOURCE | TARGET'}}
Returns the IdMappingWorkflow with a given name, if it exists.
See also: AWS API Documentation
Request Syntax
client.get_id_mapping_workflow(
workflowName='string'
)
string
[REQUIRED]
The name of the workflow.
dict
Response Syntax
{
'createdAt': datetime(2015, 1, 1),
'description': 'string',
'idMappingTechniques': {
'idMappingType': 'PROVIDER',
'providerProperties': {
'intermediateSourceConfiguration': {
'intermediateS3Path': 'string'
},
'providerConfiguration': {...}|[...]|123|123.4|'string'|True|None,
'providerServiceArn': 'string'
}
},
'inputSourceConfig': [
{
'inputSourceARN': 'string',
'schemaName': 'string',
'type': 'SOURCE'|'TARGET'
},
],
'outputSourceConfig': [
{
'KMSArn': 'string',
'outputS3Path': 'string'
},
],
'roleArn': 'string',
'tags': {
'string': 'string'
},
'updatedAt': datetime(2015, 1, 1),
'workflowArn': 'string',
'workflowName': 'string'
}
Response Structure
(dict) --
createdAt (datetime) --
The timestamp of when the workflow was created.
description (string) --
A description of the workflow.
idMappingTechniques (dict) --
An object which defines the idMappingType and the providerProperties.
idMappingType (string) --
The type of ID mapping.
providerProperties (dict) --
An object which defines any additional configurations required by the provider service.
intermediateSourceConfiguration (dict) --
The Amazon S3 location that temporarily stores your data while it processes. Your information won't be saved permanently.
intermediateS3Path (string) --
The Amazon S3 location (bucket and prefix). For example: s3://provider_bucket/DOC-EXAMPLE-BUCKET
providerConfiguration (:ref:`document<document>`) --
The required configuration fields to use with the provider service.
providerServiceArn (string) --
The ARN of the provider service.
inputSourceConfig (list) --
A list of InputSource objects, which have the fields InputSourceARN and SchemaName.
(dict) --
An object containing InputSourceARN, SchemaName, and Type.
inputSourceARN (string) --
An Glue table ARN for the input source table.
schemaName (string) --
The name of the schema to be retrieved.
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.
outputSourceConfig (list) --
A list of OutputSource objects, each of which contains fields OutputS3Path and KMSArn.
(dict) --
The output source for the ID mapping workflow.
KMSArn (string) --
Customer KMS ARN for encryption at rest. If not provided, system will use an Entity Resolution managed KMS key.
outputS3Path (string) --
The S3 path to which Entity Resolution will write the output table.
roleArn (string) --
The Amazon Resource Name (ARN) of the IAM role. Entity Resolution assumes this role to access Amazon Web Services resources on your behalf.
tags (dict) --
The tags used to organize, track, or control access for this resource.
(string) --
(string) --
updatedAt (datetime) --
The timestamp of when the workflow was last updated.
workflowArn (string) --
The ARN (Amazon Resource Name) that Entity Resolution generated for the IdMappingWorkflow .
workflowName (string) --
The name of the workflow.
{'applyNormalization': 'boolean'}
Response {'matchRule': 'string'}
Returns the corresponding Match ID of a customer record if the record has been processed.
See also: AWS API Documentation
Request Syntax
client.get_match_id(
applyNormalization=True|False,
record={
'string': 'string'
},
workflowName='string'
)
boolean
Normalizes the attributes defined in the schema in the input data. For example, if an attribute has an AttributeType of PHONE_NUMBER, and the data in the input table is in a format of 1234567890, Entity Resolution will normalize this field in the output to (123)-456-7890.
dict
[REQUIRED]
The record to fetch the Match ID for.
(string) --
(string) --
string
[REQUIRED]
The name of the workflow.
dict
Response Syntax
{
'matchId': 'string',
'matchRule': 'string'
}
Response Structure
(dict) --
matchId (string) --
The unique identifiers for this group of match records.
matchRule (string) --
The rule the record matched on.
{'outputSourceConfig': [{'KMSArn': 'string',
'outputS3Path': 'string',
'roleArn': 'string'}]}
Gets the status, metrics, and errors (if there are any) that are associated with a job.
See also: AWS API Documentation
Request Syntax
client.get_matching_job(
jobId='string',
workflowName='string'
)
string
[REQUIRED]
The ID of the job.
string
[REQUIRED]
The name of the workflow.
dict
Response Syntax
{
'endTime': datetime(2015, 1, 1),
'errorDetails': {
'errorMessage': 'string'
},
'jobId': 'string',
'metrics': {
'inputRecords': 123,
'matchIDs': 123,
'recordsNotProcessed': 123,
'totalRecordsProcessed': 123
},
'outputSourceConfig': [
{
'KMSArn': 'string',
'outputS3Path': 'string',
'roleArn': 'string'
},
],
'startTime': datetime(2015, 1, 1),
'status': 'RUNNING'|'SUCCEEDED'|'FAILED'|'QUEUED'
}
Response Structure
(dict) --
endTime (datetime) --
The time at which the job has finished.
errorDetails (dict) --
An object containing an error message, if there was an error.
errorMessage (string) --
The error message from the job, if there is one.
jobId (string) --
The ID of the job.
metrics (dict) --
Metrics associated with the execution, specifically total records processed, unique IDs generated, and records the execution skipped.
inputRecords (integer) --
The total number of input records.
matchIDs (integer) --
The total number of ``matchID``s generated.
recordsNotProcessed (integer) --
The total number of records that did not get processed.
totalRecordsProcessed (integer) --
The total number of records processed.
outputSourceConfig (list) --
A list of OutputSource objects.
(dict) --
An object containing KMSArn, OutputS3Path, and RoleArn.
KMSArn (string) --
Customer KMS ARN for encryption at rest. If not provided, system will use an Entity Resolution managed KMS key.
outputS3Path (string) --
The S3 path to which Entity Resolution will write the output table.
roleArn (string) --
The Amazon Resource Name (ARN) of the IAM role. Entity Resolution assumes this role to access Amazon Web Services resources on your behalf as part of workflow execution.
startTime (datetime) --
The time at which the job was started.
status (string) --
The current status of the job.
{'providerComponentSchema': {'providerSchemaAttributes': [{'fieldName': 'string',
'hashing': 'boolean',
'subType': 'string',
'type': 'NAME | '
'NAME_FIRST '
'| '
'NAME_MIDDLE '
'| '
'NAME_LAST '
'| ADDRESS '
'| '
'ADDRESS_STREET1 '
'| '
'ADDRESS_STREET2 '
'| '
'ADDRESS_STREET3 '
'| '
'ADDRESS_CITY '
'| '
'ADDRESS_STATE '
'| '
'ADDRESS_COUNTRY '
'| '
'ADDRESS_POSTALCODE '
'| PHONE | '
'PHONE_NUMBER '
'| '
'PHONE_COUNTRYCODE '
'| '
'EMAIL_ADDRESS '
'| '
'UNIQUE_ID '
'| DATE | '
'STRING | '
'PROVIDER_ID'}],
'schemas': [['string']]},
'providerIdNameSpaceConfiguration': {'description': 'string',
'providerSourceConfigurationDefinition': {},
'providerTargetConfigurationDefinition': {}},
'providerJobConfiguration': {}}
Returns the ProviderService of a given name.
See also: AWS API Documentation
Request Syntax
client.get_provider_service(
providerName='string',
providerServiceName='string'
)
string
[REQUIRED]
The name of the provider. This name is typically the company name.
string
[REQUIRED]
The ARN (Amazon Resource Name) of the product that the provider service provides.
dict
Response Syntax
{
'anonymizedOutput': True|False,
'providerComponentSchema': {
'providerSchemaAttributes': [
{
'fieldName': 'string',
'hashing': True|False,
'subType': 'string',
'type': 'NAME'|'NAME_FIRST'|'NAME_MIDDLE'|'NAME_LAST'|'ADDRESS'|'ADDRESS_STREET1'|'ADDRESS_STREET2'|'ADDRESS_STREET3'|'ADDRESS_CITY'|'ADDRESS_STATE'|'ADDRESS_COUNTRY'|'ADDRESS_POSTALCODE'|'PHONE'|'PHONE_NUMBER'|'PHONE_COUNTRYCODE'|'EMAIL_ADDRESS'|'UNIQUE_ID'|'DATE'|'STRING'|'PROVIDER_ID'
},
],
'schemas': [
[
'string',
],
]
},
'providerConfigurationDefinition': {...}|[...]|123|123.4|'string'|True|None,
'providerEndpointConfiguration': {
'marketplaceConfiguration': {
'assetId': 'string',
'dataSetId': 'string',
'listingId': 'string',
'revisionId': 'string'
}
},
'providerEntityOutputDefinition': {...}|[...]|123|123.4|'string'|True|None,
'providerIdNameSpaceConfiguration': {
'description': 'string',
'providerSourceConfigurationDefinition': {...}|[...]|123|123.4|'string'|True|None,
'providerTargetConfigurationDefinition': {...}|[...]|123|123.4|'string'|True|None
},
'providerIntermediateDataAccessConfiguration': {
'awsAccountIds': [
'string',
],
'requiredBucketActions': [
'string',
]
},
'providerJobConfiguration': {...}|[...]|123|123.4|'string'|True|None,
'providerName': 'string',
'providerServiceArn': 'string',
'providerServiceDisplayName': 'string',
'providerServiceName': 'string',
'providerServiceType': 'ASSIGNMENT'|'ID_MAPPING'
}
Response Structure
(dict) --
anonymizedOutput (boolean) --
Specifies whether output data from the provider is anonymized. A value of TRUE means the output will be anonymized and you can't relate the data that comes back from the provider to the identifying input. A value of FALSE means the output won't be anonymized and you can relate the data that comes back from the provider to your source data.
providerComponentSchema (dict) --
Input schema for the provider service.
providerSchemaAttributes (list) --
The provider schema attributes.
(dict) --
The provider schema attribute.
fieldName (string) --
The field name.
hashing (boolean) --
The hashing attribute of the provider schema.
subType (string) --
The sub type of the provider schema attribute.
type (string) --
The type of the provider schema attribute.
schemas (list) --
Input schema for the provider service.
(list) --
(string) --
providerConfigurationDefinition (:ref:`document<document>`) --
The definition of the provider configuration.
providerEndpointConfiguration (dict) --
The required configuration fields to use with the provider service.
marketplaceConfiguration (dict) --
The identifiers of the provider service, from Data Exchange.
assetId (string) --
The asset ID on Data Exchange.
dataSetId (string) --
The dataset ID on Data Exchange.
listingId (string) --
The listing ID on Data Exchange.
revisionId (string) --
The revision ID on Data Exchange.
providerEntityOutputDefinition (:ref:`document<document>`) --
The definition of the provider entity output.
providerIdNameSpaceConfiguration (dict) --
The provider configuration required for different ID namespace types.
description (string) --
The description of the ID namespace.
providerSourceConfigurationDefinition (:ref:`document<document>`) --
Configurations required for the source ID namespace.
providerTargetConfigurationDefinition (:ref:`document<document>`) --
Configurations required for the target ID namespace.
providerIntermediateDataAccessConfiguration (dict) --
The Amazon Web Services accounts and the S3 permissions that are required by some providers to create an S3 bucket for intermediate data storage.
awsAccountIds (list) --
The Amazon Web Services account that provider can use to read or write data into the customer's intermediate S3 bucket.
(string) --
requiredBucketActions (list) --
The S3 bucket actions that the provider requires permission for.
(string) --
providerJobConfiguration (:ref:`document<document>`) --
Provider service job configurations.
providerName (string) --
The name of the provider. This name is typically the company name.
providerServiceArn (string) --
The ARN (Amazon Resource Name) that Entity Resolution generated for the provider service.
providerServiceDisplayName (string) --
The display name of the provider service.
providerServiceName (string) --
The name of the product that the provider service provides.
providerServiceType (string) --
The type of provider service.
{'outputSourceConfig': [{'KMSArn': 'string',
'outputS3Path': 'string',
'roleArn': 'string'}]}
Starts the IdMappingJob of a workflow. The workflow must have previously been created using the CreateIdMappingWorkflow endpoint.
See also: AWS API Documentation
Request Syntax
client.start_id_mapping_job(
outputSourceConfig=[
{
'KMSArn': 'string',
'outputS3Path': 'string',
'roleArn': 'string'
},
],
workflowName='string'
)
list
A list of OutputSource objects.
(dict) --
An object containing KMSArn, OutputS3Path, and RoleARN.
KMSArn (string) --
Customer KMS ARN for encryption at rest. If not provided, system will use an Entity Resolution managed KMS key.
outputS3Path (string) -- [REQUIRED]
The S3 path to which Entity Resolution will write the output table.
roleArn (string) -- [REQUIRED]
The Amazon Resource Name (ARN) of the IAM role. Entity Resolution assumes this role to access Amazon Web Services resources on your behalf as part of workflow execution.
string
[REQUIRED]
The name of the ID mapping job to be retrieved.
dict
Response Syntax
{
'jobId': 'string',
'outputSourceConfig': [
{
'KMSArn': 'string',
'outputS3Path': 'string',
'roleArn': 'string'
},
]
}
Response Structure
(dict) --
jobId (string) --
The ID of the job.
outputSourceConfig (list) --
A list of OutputSource objects.
(dict) --
An object containing KMSArn, OutputS3Path, and RoleARN.
KMSArn (string) --
Customer KMS ARN for encryption at rest. If not provided, system will use an Entity Resolution managed KMS key.
outputS3Path (string) --
The S3 path to which Entity Resolution will write the output table.
roleArn (string) --
The Amazon Resource Name (ARN) of the IAM role. Entity Resolution assumes this role to access Amazon Web Services resources on your behalf as part of workflow execution.
{'inputSourceConfig': {'type': 'SOURCE | TARGET'}}
Updates an existing IdMappingWorkflow. This method is identical to CreateIdMappingWorkflow, except it uses an HTTP PUT request instead of a POST request, and the IdMappingWorkflow must already exist for the method to succeed.
See also: AWS API Documentation
Request Syntax
client.update_id_mapping_workflow(
description='string',
idMappingTechniques={
'idMappingType': 'PROVIDER',
'providerProperties': {
'intermediateSourceConfiguration': {
'intermediateS3Path': 'string'
},
'providerConfiguration': {...}|[...]|123|123.4|'string'|True|None,
'providerServiceArn': 'string'
}
},
inputSourceConfig=[
{
'inputSourceARN': 'string',
'schemaName': 'string',
'type': 'SOURCE'|'TARGET'
},
],
outputSourceConfig=[
{
'KMSArn': 'string',
'outputS3Path': 'string'
},
],
roleArn='string',
workflowName='string'
)
string
A description of the workflow.
dict
[REQUIRED]
An object which defines the idMappingType and the providerProperties.
idMappingType (string) -- [REQUIRED]
The type of ID mapping.
providerProperties (dict) --
An object which defines any additional configurations required by the provider service.
intermediateSourceConfiguration (dict) --
The Amazon S3 location that temporarily stores your data while it processes. Your information won't be saved permanently.
intermediateS3Path (string) -- [REQUIRED]
The Amazon S3 location (bucket and prefix). For example: s3://provider_bucket/DOC-EXAMPLE-BUCKET
providerConfiguration (:ref:`document<document>`) --
The required configuration fields to use with the provider service.
providerServiceArn (string) -- [REQUIRED]
The ARN of the provider service.
list
[REQUIRED]
A list of InputSource objects, which have the fields InputSourceARN and SchemaName.
(dict) --
An object containing InputSourceARN, SchemaName, and Type.
inputSourceARN (string) -- [REQUIRED]
An Glue table ARN for the input source table.
schemaName (string) --
The name of the schema to be retrieved.
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.
list
A list of OutputSource objects, each of which contains fields OutputS3Path and KMSArn.
(dict) --
The output source for the ID mapping workflow.
KMSArn (string) --
Customer KMS ARN for encryption at rest. If not provided, system will use an Entity Resolution managed KMS key.
outputS3Path (string) -- [REQUIRED]
The S3 path to which Entity Resolution will write the output table.
string
[REQUIRED]
The Amazon Resource Name (ARN) of the IAM role. Entity Resolution assumes this role to access Amazon Web Services resources on your behalf.
string
[REQUIRED]
The name of the workflow.
dict
Response Syntax
{
'description': 'string',
'idMappingTechniques': {
'idMappingType': 'PROVIDER',
'providerProperties': {
'intermediateSourceConfiguration': {
'intermediateS3Path': 'string'
},
'providerConfiguration': {...}|[...]|123|123.4|'string'|True|None,
'providerServiceArn': 'string'
}
},
'inputSourceConfig': [
{
'inputSourceARN': 'string',
'schemaName': 'string',
'type': 'SOURCE'|'TARGET'
},
],
'outputSourceConfig': [
{
'KMSArn': 'string',
'outputS3Path': 'string'
},
],
'roleArn': 'string',
'workflowArn': 'string',
'workflowName': 'string'
}
Response Structure
(dict) --
description (string) --
A description of the workflow.
idMappingTechniques (dict) --
An object which defines the idMappingType and the providerProperties.
idMappingType (string) --
The type of ID mapping.
providerProperties (dict) --
An object which defines any additional configurations required by the provider service.
intermediateSourceConfiguration (dict) --
The Amazon S3 location that temporarily stores your data while it processes. Your information won't be saved permanently.
intermediateS3Path (string) --
The Amazon S3 location (bucket and prefix). For example: s3://provider_bucket/DOC-EXAMPLE-BUCKET
providerConfiguration (:ref:`document<document>`) --
The required configuration fields to use with the provider service.
providerServiceArn (string) --
The ARN of the provider service.
inputSourceConfig (list) --
A list of InputSource objects, which have the fields InputSourceARN and SchemaName.
(dict) --
An object containing InputSourceARN, SchemaName, and Type.
inputSourceARN (string) --
An Glue table ARN for the input source table.
schemaName (string) --
The name of the schema to be retrieved.
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.
outputSourceConfig (list) --
A list of OutputSource objects, each of which contains fields OutputS3Path and KMSArn.
(dict) --
The output source for the ID mapping workflow.
KMSArn (string) --
Customer KMS ARN for encryption at rest. If not provided, system will use an Entity Resolution managed KMS key.
outputS3Path (string) --
The S3 path to which Entity Resolution will write the output table.
roleArn (string) --
The Amazon Resource Name (ARN) of the IAM role. Entity Resolution assumes this role to access Amazon Web Services resources on your behalf.
workflowArn (string) --
The Amazon Resource Name (ARN) of the workflow role. Entity Resolution assumes this role to access Amazon Web Services resources on your behalf.
workflowName (string) --
The name of the workflow.