Module types

Data structures used by operation inputs/outputs.

Modules

builders

Builders

error

Error types that AWS EntityResolution can respond with.

Structs

DeleteUniqueIdError

The Delete Unique Id error.

DeletedUniqueId

The deleted unique ID.

ErrorDetails

An object containing an error message, if there was an error.

FailedRecord

The record that didn't generate a Match ID.

IdMappingJobMetrics

An object that contains metrics about an ID mapping job, including counts of input records, processed records, and mapped records between source and target identifiers.

IdMappingJobOutputSource

An object containing KMSArn, outputS3Path, and roleARN.

IdMappingRuleBasedProperties

An object that defines the list of matching rules to run in an ID mapping workflow.

IdMappingTechniques

An object which defines the ID mapping technique and any additional configurations.

IdMappingWorkflowInputSource

An object containing inputSourceARN, schemaName, and type.

IdMappingWorkflowOutputSource

The output source for the ID mapping workflow.

IdMappingWorkflowSummary

A list of IdMappingWorkflowSummary objects, each of which contain the fields WorkflowName, WorkflowArn, CreatedAt, and UpdatedAt.

IdNamespaceIdMappingWorkflowMetadata

The settings for the ID namespace for the ID mapping workflow job.

IdNamespaceIdMappingWorkflowProperties

An object containing idMappingType, providerProperties, and ruleBasedProperties.

IdNamespaceInputSource

An object containing inputSourceARN and schemaName.

IdNamespaceSummary

A summary of ID namespaces.

IncrementalRunConfig

Optional. An object that defines the incremental run type. This object contains only the incrementalRunType field, which appears as "Automatic" in the console.

For workflows where resolutionType is ML_MATCHING, incremental processing is not supported.

InputSource

An object containing inputSourceARN, schemaName, and applyNormalization.

IntermediateSourceConfiguration

The Amazon S3 location that temporarily stores your data while it processes. Your information won't be saved permanently.

JobMetrics

An object containing inputRecords, totalRecordsProcessed, matchIDs, and recordsNotProcessed.

JobOutputSource

An object containing KMSArn, outputS3Path, and roleArn.

JobSummary

An object containing the jobId, status, startTime, and endTime of a job.

MatchGroup

The match group.

MatchedRecord

The matched record.

MatchingWorkflowSummary

A list of MatchingWorkflowSummary objects, each of which contain the fields workflowName, workflowArn, resolutionType, createdAt, updatedAt.

NamespaceProviderProperties

An object containing providerConfiguration and providerServiceArn.

NamespaceRuleBasedProperties

The rule-based properties of an ID namespace. These properties define how the ID namespace can be used in an ID mapping workflow.

OutputAttribute

A list of OutputAttribute objects, each of which have the fields Name and Hashed. Each of these objects selects a column to be included in the output table, and whether the values of the column should be hashed.

OutputSource

A list of OutputAttribute objects, each of which have the fields Name and Hashed. Each of these objects selects a column to be included in the output table, and whether the values of the column should be hashed.

ProviderComponentSchema

The input schema supported by provider service.

ProviderIdNameSpaceConfiguration

The provider configuration required for different ID namespace types.

ProviderIntermediateDataAccessConfiguration

The required configuration fields to give intermediate access to a provider service.

ProviderMarketplaceConfiguration

The identifiers of the provider service, from Data Exchange.

ProviderProperties

An object containing the providerServiceARN, intermediateSourceConfiguration, and providerConfiguration.

ProviderSchemaAttribute

The provider schema attribute.

ProviderServiceSummary

A list of ProviderService objects, each of which contain the fields providerName, providerServiceArn, providerServiceName, and providerServiceType.

Record

The record.

ResolutionTechniques

An object which defines the resolutionType and the ruleBasedProperties.

Rule

An object containing the ruleName and matchingKeys.

RuleBasedProperties

An object which defines the list of matching rules to run in a matching workflow.

RuleCondition

An object that defines the ruleCondition and the ruleName to use in a matching workflow.

RuleConditionProperties

The properties of a rule condition that provides the ability to use more complex syntax.

SchemaInputAttribute

A configuration object for defining input data fields in Entity Resolution. The SchemaInputAttribute specifies how individual fields in your input data should be processed and matched.

SchemaMappingSummary

An object containing schemaName, schemaArn, createdAt, updatedAt, and hasWorkflows.

Enums

AttributeMatchingModel

When writing a match expression against AttributeMatchingModel, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

DeleteUniqueIdErrorType

When writing a match expression against DeleteUniqueIdErrorType, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

DeleteUniqueIdStatus

When writing a match expression against DeleteUniqueIdStatus, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

IdMappingType

When writing a match expression against IdMappingType, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

IdMappingWorkflowRuleDefinitionType

When writing a match expression against IdMappingWorkflowRuleDefinitionType, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

IdNamespaceType

When writing a match expression against IdNamespaceType, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

IncrementalRunType

When writing a match expression against IncrementalRunType, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

JobStatus

When writing a match expression against JobStatus, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

MatchPurpose

When writing a match expression against MatchPurpose, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

ProcessingType

When writing a match expression against ProcessingType, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

ProviderEndpointConfiguration

The required configuration fields to use with the provider service.

RecordMatchingModel

When writing a match expression against RecordMatchingModel, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

ResolutionType

When writing a match expression against ResolutionType, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

SchemaAttributeType

When writing a match expression against SchemaAttributeType, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

ServiceType

When writing a match expression against ServiceType, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

StatementEffect

When writing a match expression against StatementEffect, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.