types

package
v1.25.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Sep 23, 2025 License: Apache-2.0 Imports: 5 Imported by: 0

Documentation

Index

Examples

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type AccessDeniedException

type AccessDeniedException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

You do not have sufficient access to perform this action.

func (*AccessDeniedException) Error

func (e *AccessDeniedException) Error() string

func (*AccessDeniedException) ErrorCode

func (e *AccessDeniedException) ErrorCode() string

func (*AccessDeniedException) ErrorFault

func (e *AccessDeniedException) ErrorFault() smithy.ErrorFault

func (*AccessDeniedException) ErrorMessage

func (e *AccessDeniedException) ErrorMessage() string

type AttributeMatchingModel

type AttributeMatchingModel string
const (
	AttributeMatchingModelOneToOne   AttributeMatchingModel = "ONE_TO_ONE"
	AttributeMatchingModelManyToMany AttributeMatchingModel = "MANY_TO_MANY"
)

Enum values for AttributeMatchingModel

func (AttributeMatchingModel) Values

Values returns all known values for AttributeMatchingModel. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type ConflictException

type ConflictException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

The request couldn't be processed because of conflict in the current state of the resource. Example: Workflow already exists, Schema already exists, Workflow is currently running, etc.

func (*ConflictException) Error

func (e *ConflictException) Error() string

func (*ConflictException) ErrorCode

func (e *ConflictException) ErrorCode() string

func (*ConflictException) ErrorFault

func (e *ConflictException) ErrorFault() smithy.ErrorFault

func (*ConflictException) ErrorMessage

func (e *ConflictException) ErrorMessage() string

type DeleteUniqueIdError added in v1.10.0

type DeleteUniqueIdError struct {

	//  The error type for the delete unique ID operation.
	//
	// The SERVICE_ERROR value indicates that an internal service-side problem
	// occurred during the deletion operation.
	//
	// The VALIDATION_ERROR value indicates that the deletion operation couldn't
	// complete because of invalid input parameters or data.
	//
	// This member is required.
	ErrorType DeleteUniqueIdErrorType

	// The unique ID that couldn't be deleted.
	//
	// This member is required.
	UniqueId *string
	// contains filtered or unexported fields
}

The error information provided when the delete unique ID operation doesn't complete.

type DeleteUniqueIdErrorType added in v1.10.0

type DeleteUniqueIdErrorType string
const (
	DeleteUniqueIdErrorTypeServiceError    DeleteUniqueIdErrorType = "SERVICE_ERROR"
	DeleteUniqueIdErrorTypeValidationError DeleteUniqueIdErrorType = "VALIDATION_ERROR"
)

Enum values for DeleteUniqueIdErrorType

func (DeleteUniqueIdErrorType) Values added in v1.10.0

Values returns all known values for DeleteUniqueIdErrorType. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type DeleteUniqueIdStatus added in v1.10.0

type DeleteUniqueIdStatus string
const (
	DeleteUniqueIdStatusCompleted DeleteUniqueIdStatus = "COMPLETED"
	DeleteUniqueIdStatusAccepted  DeleteUniqueIdStatus = "ACCEPTED"
)

Enum values for DeleteUniqueIdStatus

func (DeleteUniqueIdStatus) Values added in v1.10.0

Values returns all known values for DeleteUniqueIdStatus. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type DeletedUniqueId added in v1.10.0

type DeletedUniqueId struct {

	//  The unique ID of the deleted item.
	//
	// This member is required.
	UniqueId *string
	// contains filtered or unexported fields
}

The deleted unique ID.

type ErrorDetails

type ErrorDetails struct {

	// The error message from the job, if there is one.
	ErrorMessage *string
	// contains filtered or unexported fields
}

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

type ExceedsLimitException

type ExceedsLimitException struct {
	Message *string

	ErrorCodeOverride *string

	QuotaName  *string
	QuotaValue *int32
	// contains filtered or unexported fields
}

The request was rejected because it attempted to create resources beyond the current Entity Resolution account limits. The error message describes the limit exceeded.

func (*ExceedsLimitException) Error

func (e *ExceedsLimitException) Error() string

func (*ExceedsLimitException) ErrorCode

func (e *ExceedsLimitException) ErrorCode() string

func (*ExceedsLimitException) ErrorFault

func (e *ExceedsLimitException) ErrorFault() smithy.ErrorFault

func (*ExceedsLimitException) ErrorMessage

func (e *ExceedsLimitException) ErrorMessage() string

type FailedRecord added in v1.19.0

type FailedRecord struct {

	//  The error message for the record that didn't generate a Match ID.
	//
	// This member is required.
	ErrorMessage *string

	//  The input source ARN of the record that didn't generate a Match ID.
	//
	// This member is required.
	InputSourceARN *string

	//  The unique ID of the record that didn't generate a Match ID.
	//
	// This member is required.
	UniqueId *string
	// contains filtered or unexported fields
}

The record that didn't generate a Match ID.

type IdMappingIncrementalRunConfig added in v1.25.0

type IdMappingIncrementalRunConfig struct {

	//  The incremental run type for an ID mapping workflow.
	//
	// It takes only one value: ON_DEMAND . This setting runs the ID mapping workflow
	// when it's manually triggered through the StartIdMappingJob API.
	IncrementalRunType IdMappingIncrementalRunType
	// contains filtered or unexported fields
}

Incremental run configuration for an ID mapping workflow.

type IdMappingIncrementalRunType added in v1.25.0

type IdMappingIncrementalRunType string
const (
	IdMappingIncrementalRunTypeOnDemand IdMappingIncrementalRunType = "ON_DEMAND"
)

Enum values for IdMappingIncrementalRunType

func (IdMappingIncrementalRunType) Values added in v1.25.0

Values returns all known values for IdMappingIncrementalRunType. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type IdMappingJobMetrics added in v1.3.0

type IdMappingJobMetrics struct {

	// The number of records processed that were marked for deletion in the input file
	// using the DELETE schema mapping field. These are the records to be removed from
	// the ID mapping table.
	DeleteRecordsProcessed *int32

	// The total number of records that were input for processing.
	InputRecords *int32

	//  The number of mapped records removed.
	MappedRecordsRemoved *int32

	//  The number of source records removed due to ID mapping.
	MappedSourceRecordsRemoved *int32

	//  The number of mapped target records removed.
	MappedTargetRecordsRemoved *int32

	//  The number of new mapped records.
	NewMappedRecords *int32

	//  The number of new source records mapped.
	NewMappedSourceRecords *int32

	//  The number of new mapped target records.
	NewMappedTargetRecords *int32

	// The number of new unique records processed in the current job run, after
	// removing duplicates. This metric excludes deletion-related records. Duplicates
	// are determined by the field marked as UNIQUE_ID in your schema mapping. Records
	// sharing the same value in this field are considered duplicates. For example, if
	// your current run processes five new records with the same UNIQUE_ID value, they
	// would count as one new unique record in this metric.
	NewUniqueRecordsLoaded *int32

	// The total number of records that did not get processed.
	RecordsNotProcessed *int32

	//  The total number of records that were mapped.
	TotalMappedRecords *int32

	//  The total number of mapped source records.
	TotalMappedSourceRecords *int32

	//  The total number of distinct mapped target records.
	TotalMappedTargetRecords *int32

	// The total number of records that were processed.
	TotalRecordsProcessed *int32

	// The number of de-duplicated processed records across all runs, excluding
	// deletion-related records. Duplicates are determined by the field marked as
	// UNIQUE_ID in your schema mapping. Records sharing the same value in this field
	// are considered duplicates. For example, if you specified "customer_id" as a
	// UNIQUE_ID field and had three records with the same customer_id value, they
	// would count as one unique record in this metric.
	UniqueRecordsLoaded *int32
	// contains filtered or unexported fields
}

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.

type IdMappingJobOutputSource added in v1.9.0

type IdMappingJobOutputSource struct {

	// The S3 path to which Entity Resolution will write the output table.
	//
	// This member is required.
	OutputS3Path *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.
	//
	// This member is required.
	RoleArn *string

	// Customer KMS ARN for encryption at rest. If not provided, system will use an
	// Entity Resolution managed KMS key.
	KMSArn *string
	// contains filtered or unexported fields
}

An object containing KMSArn , outputS3Path , and roleARN .

type IdMappingRuleBasedProperties added in v1.13.0

type IdMappingRuleBasedProperties struct {

	// The comparison type. You can either choose ONE_TO_ONE or MANY_TO_MANY as the
	// attributeMatchingModel .
	//
	// If you choose ONE_TO_ONE , the system can only match attributes if the sub-types
	// are an exact match. For example, for the Email attribute type, the system will
	// only consider it a match if the value of the Email field of Profile A matches
	// the value of the Email field of Profile B.
	//
	// If you choose MANY_TO_MANY , the system can match attributes across the
	// sub-types of an attribute type. For example, if the value of the Email field of
	// Profile A matches the value of the BusinessEmail field of Profile B, the two
	// profiles are matched on the Email attribute type.
	//
	// This member is required.
	AttributeMatchingModel AttributeMatchingModel

	//  The type of matching record that is allowed to be used in an ID mapping
	// workflow.
	//
	// If the value is set to ONE_SOURCE_TO_ONE_TARGET , only one record in the source
	// can be matched to the same record in the target.
	//
	// If the value is set to MANY_SOURCE_TO_ONE_TARGET , multiple records in the
	// source can be matched to one record in the target.
	//
	// This member is required.
	RecordMatchingModel RecordMatchingModel

	//  The set of rules you can use in an ID mapping workflow. The limitations
	// specified for the source or target to define the match rules must be compatible.
	//
	// This member is required.
	RuleDefinitionType IdMappingWorkflowRuleDefinitionType

	//  The rules that can be used for ID mapping.
	Rules []Rule
	// contains filtered or unexported fields
}
An object that defines the list of matching rules to run in an ID mapping

workflow.

type IdMappingTechniques added in v1.3.0

type IdMappingTechniques struct {

	// The type of ID mapping.
	//
	// This member is required.
	IdMappingType IdMappingType

	// An object which defines any additional configurations required by the provider
	// service.
	ProviderProperties *ProviderProperties

	//  An object which defines any additional configurations required by rule-based
	// matching.
	RuleBasedProperties *IdMappingRuleBasedProperties
	// contains filtered or unexported fields
}

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

type IdMappingType added in v1.3.0

type IdMappingType string
const (
	IdMappingTypeProvider  IdMappingType = "PROVIDER"
	IdMappingTypeRuleBased IdMappingType = "RULE_BASED"
)

Enum values for IdMappingType

func (IdMappingType) Values added in v1.3.0

func (IdMappingType) Values() []IdMappingType

Values returns all known values for IdMappingType. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type IdMappingWorkflowInputSource added in v1.3.0

type IdMappingWorkflowInputSource struct {

	// An Glue table Amazon Resource Name (ARN) or a matching workflow ARN for the
	// input source table.
	//
	// This member is required.
	InputSourceARN *string

	// The name of the schema to be retrieved.
	SchemaName *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 which all sourceIds will
	// resolve to.
	Type IdNamespaceType
	// contains filtered or unexported fields
}

An object containing inputSourceARN , schemaName , and type .

type IdMappingWorkflowOutputSource added in v1.3.0

type IdMappingWorkflowOutputSource struct {

	// The S3 path to which Entity Resolution will write the output table.
	//
	// This member is required.
	OutputS3Path *string

	// Customer KMS ARN for encryption at rest. If not provided, system will use an
	// Entity Resolution managed KMS key.
	KMSArn *string
	// contains filtered or unexported fields
}

The output source for the ID mapping workflow.

type IdMappingWorkflowRuleDefinitionType added in v1.13.0

type IdMappingWorkflowRuleDefinitionType string
const (
	IdMappingWorkflowRuleDefinitionTypeSource IdMappingWorkflowRuleDefinitionType = "SOURCE"
	IdMappingWorkflowRuleDefinitionTypeTarget IdMappingWorkflowRuleDefinitionType = "TARGET"
)

Enum values for IdMappingWorkflowRuleDefinitionType

func (IdMappingWorkflowRuleDefinitionType) Values added in v1.13.0

Values returns all known values for IdMappingWorkflowRuleDefinitionType. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type IdMappingWorkflowSummary added in v1.3.0

type IdMappingWorkflowSummary struct {

	// The timestamp of when the workflow was created.
	//
	// This member is required.
	CreatedAt *time.Time

	// The timestamp of when the workflow was last updated.
	//
	// This member is required.
	UpdatedAt *time.Time

	// The ARN (Amazon Resource Name) that Entity Resolution generated for the
	// IdMappingWorkflow .
	//
	// This member is required.
	WorkflowArn *string

	// The name of the workflow.
	//
	// This member is required.
	WorkflowName *string
	// contains filtered or unexported fields
}

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

type IdNamespaceIdMappingWorkflowMetadata added in v1.13.0

type IdNamespaceIdMappingWorkflowMetadata struct {

	// The type of ID mapping.
	//
	// This member is required.
	IdMappingType IdMappingType
	// contains filtered or unexported fields
}

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

type IdNamespaceIdMappingWorkflowProperties added in v1.9.0

type IdNamespaceIdMappingWorkflowProperties struct {

	// The type of ID mapping.
	//
	// This member is required.
	IdMappingType IdMappingType

	// An object which defines any additional configurations required by the provider
	// service.
	ProviderProperties *NamespaceProviderProperties

	//  An object which defines any additional configurations required by rule-based
	// matching.
	RuleBasedProperties *NamespaceRuleBasedProperties
	// contains filtered or unexported fields
}

An object containing idMappingType , providerProperties , and ruleBasedProperties .

type IdNamespaceInputSource added in v1.9.0

type IdNamespaceInputSource struct {

	// An Glue table Amazon Resource Name (ARN) or a matching workflow ARN for the
	// input source table.
	//
	// This member is required.
	InputSourceARN *string

	// The name of the schema.
	SchemaName *string
	// contains filtered or unexported fields
}

An object containing inputSourceARN and schemaName .

type IdNamespaceSummary added in v1.9.0

type IdNamespaceSummary struct {

	// The timestamp of when the ID namespace was created.
	//
	// This member is required.
	CreatedAt *time.Time

	// The Amazon Resource Name (ARN) of the ID namespace.
	//
	// This member is required.
	IdNamespaceArn *string

	// The name of the ID namespace.
	//
	// This member is required.
	IdNamespaceName *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 which all sourceIds will
	// resolve to.
	//
	// This member is required.
	Type IdNamespaceType

	// The timestamp of when the ID namespace was last updated.
	//
	// This member is required.
	UpdatedAt *time.Time

	// The description of the ID namespace.
	Description *string

	// An object which defines any additional configurations required by the ID
	// mapping workflow.
	IdMappingWorkflowProperties []IdNamespaceIdMappingWorkflowMetadata
	// contains filtered or unexported fields
}

A summary of ID namespaces.

type IdNamespaceType added in v1.9.0

type IdNamespaceType string
const (
	IdNamespaceTypeSource IdNamespaceType = "SOURCE"
	IdNamespaceTypeTarget IdNamespaceType = "TARGET"
)

Enum values for IdNamespaceType

func (IdNamespaceType) Values added in v1.9.0

func (IdNamespaceType) Values() []IdNamespaceType

Values returns all known values for IdNamespaceType. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type IncrementalRunConfig

type IncrementalRunConfig struct {

	// The type of incremental run. The only valid value is IMMEDIATE . This appears as
	// "Automatic" in the console.
	//
	// For workflows where resolutionType is ML_MATCHING or PROVIDER , incremental
	// processing is not supported.
	IncrementalRunType IncrementalRunType
	// contains filtered or unexported fields
}

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 or PROVIDER , incremental processing is not supported.

type IncrementalRunType

type IncrementalRunType string
const (
	IncrementalRunTypeImmediate IncrementalRunType = "IMMEDIATE"
)

Enum values for IncrementalRunType

func (IncrementalRunType) Values

Values returns all known values for IncrementalRunType. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type InputSource

type InputSource struct {

	// An Glue table Amazon Resource Name (ARN) for the input source table.
	//
	// This member is required.
	InputSourceARN *string

	// The name of the schema to be retrieved.
	//
	// This member is required.
	SchemaName *string

	// 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.
	ApplyNormalization *bool
	// contains filtered or unexported fields
}

An object containing inputSourceARN , schemaName , and applyNormalization .

type IntermediateSourceConfiguration added in v1.3.0

type IntermediateSourceConfiguration struct {

	// The Amazon S3 location (bucket and prefix). For example:
	// s3://provider_bucket/DOC-EXAMPLE-BUCKET
	//
	// This member is required.
	IntermediateS3Path *string
	// contains filtered or unexported fields
}

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

type InternalServerException

type InternalServerException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

This exception occurs when there is an internal failure in the Entity Resolution service.

func (*InternalServerException) Error

func (e *InternalServerException) Error() string

func (*InternalServerException) ErrorCode

func (e *InternalServerException) ErrorCode() string

func (*InternalServerException) ErrorFault

func (e *InternalServerException) ErrorFault() smithy.ErrorFault

func (*InternalServerException) ErrorMessage

func (e *InternalServerException) ErrorMessage() string

type JobMetrics

type JobMetrics struct {

	// The number of records processed that were marked for deletion ( DELETE = True)
	// in the input file. This metric tracks records flagged for removal during the job
	// execution.
	DeleteRecordsProcessed *int32

	// The total number of input records.
	InputRecords *int32

	// The total number of matchID s generated.
	MatchIDs *int32

	// The total number of records that did not get processed.
	RecordsNotProcessed *int32

	// The total number of records processed.
	TotalRecordsProcessed *int32
	// contains filtered or unexported fields
}

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

type JobOutputSource added in v1.9.0

type JobOutputSource struct {

	// The S3 path to which Entity Resolution will write the output table.
	//
	// This member is required.
	OutputS3Path *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.
	//
	// This member is required.
	RoleArn *string

	// Customer KMS ARN for encryption at rest. If not provided, system will use an
	// Entity Resolution managed KMS key.
	KMSArn *string
	// contains filtered or unexported fields
}

An object containing KMSArn , outputS3Path , and roleArn .

type JobStatus

type JobStatus string
const (
	JobStatusRunning   JobStatus = "RUNNING"
	JobStatusSucceeded JobStatus = "SUCCEEDED"
	JobStatusFailed    JobStatus = "FAILED"
	JobStatusQueued    JobStatus = "QUEUED"
)

Enum values for JobStatus

func (JobStatus) Values

func (JobStatus) Values() []JobStatus

Values returns all known values for JobStatus. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type JobSummary

type JobSummary struct {

	// The ID of the job.
	//
	// This member is required.
	JobId *string

	// The time at which the job was started.
	//
	// This member is required.
	StartTime *time.Time

	// The current status of the job.
	//
	// This member is required.
	Status JobStatus

	// The time at which the job has finished.
	EndTime *time.Time
	// contains filtered or unexported fields
}

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

type JobType added in v1.25.0

type JobType string
const (
	JobTypeBatch       JobType = "BATCH"
	JobTypeIncremental JobType = "INCREMENTAL"
	JobTypeDeleteOnly  JobType = "DELETE_ONLY"
)

Enum values for JobType

func (JobType) Values added in v1.25.0

func (JobType) Values() []JobType

Values returns all known values for JobType. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type MatchGroup added in v1.19.0

type MatchGroup struct {

	//  The match ID.
	//
	// This member is required.
	MatchId *string

	//  The match rule of the match group.
	//
	// This member is required.
	MatchRule *string

	//  The matched records.
	//
	// This member is required.
	Records []MatchedRecord
	// contains filtered or unexported fields
}

The match group.

type MatchPurpose added in v1.13.0

type MatchPurpose string
const (
	MatchPurposeIdentifierGeneration MatchPurpose = "IDENTIFIER_GENERATION"
	MatchPurposeIndexing             MatchPurpose = "INDEXING"
)

Enum values for MatchPurpose

func (MatchPurpose) Values added in v1.13.0

func (MatchPurpose) Values() []MatchPurpose

Values returns all known values for MatchPurpose. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type MatchedRecord added in v1.19.0

type MatchedRecord struct {

	//  The input source ARN of the matched record.
	//
	// This member is required.
	InputSourceARN *string

	//  The record ID of the matched record.
	//
	// This member is required.
	RecordId *string
	// contains filtered or unexported fields
}

The matched record.

type MatchingWorkflowSummary

type MatchingWorkflowSummary struct {

	// The timestamp of when the workflow was created.
	//
	// This member is required.
	CreatedAt *time.Time

	// The method that has been specified for data matching, either using matching
	// provided by Entity Resolution or through a provider service.
	//
	// This member is required.
	ResolutionType ResolutionType

	// The timestamp of when the workflow was last updated.
	//
	// This member is required.
	UpdatedAt *time.Time

	// The ARN (Amazon Resource Name) that Entity Resolution generated for the
	// MatchingWorkflow .
	//
	// This member is required.
	WorkflowArn *string

	// The name of the workflow.
	//
	// This member is required.
	WorkflowName *string
	// contains filtered or unexported fields
}

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

type NamespaceProviderProperties added in v1.9.0

type NamespaceProviderProperties struct {

	// The Amazon Resource Name (ARN) of the provider service.
	//
	// This member is required.
	ProviderServiceArn *string

	// An object which defines any additional configurations required by the provider
	// service.
	ProviderConfiguration document.Interface
	// contains filtered or unexported fields
}

An object containing providerConfiguration and providerServiceArn .

type NamespaceRuleBasedProperties added in v1.13.0

type NamespaceRuleBasedProperties struct {

	// The comparison type. You can either choose ONE_TO_ONE or MANY_TO_MANY as the
	// attributeMatchingModel .
	//
	// If you choose ONE_TO_ONE , the system can only match attributes if the sub-types
	// are an exact match. For example, for the Email attribute type, the system will
	// only consider it a match if the value of the Email field of Profile A matches
	// the value of the Email field of Profile B.
	//
	// If you choose MANY_TO_MANY , the system can match attributes across the
	// sub-types of an attribute type. For example, if the value of the Email field of
	// Profile A matches the value of BusinessEmail field of Profile B, the two
	// profiles are matched on the Email attribute type.
	AttributeMatchingModel AttributeMatchingModel

	//  The type of matching record that is allowed to be used in an ID mapping
	// workflow.
	//
	// If the value is set to ONE_SOURCE_TO_ONE_TARGET , only one record in the source
	// is matched to one record in the target.
	//
	// If the value is set to MANY_SOURCE_TO_ONE_TARGET , all matching records in the
	// source are matched to one record in the target.
	RecordMatchingModels []RecordMatchingModel

	//  The sets of rules you can use in an ID mapping workflow. The limitations
	// specified for the source and target must be compatible.
	RuleDefinitionTypes []IdMappingWorkflowRuleDefinitionType

	//  The rules for the ID namespace.
	Rules []Rule
	// contains filtered or unexported fields
}
The rule-based properties of an ID namespace. These properties define how the

ID namespace can be used in an ID mapping workflow.

type OutputAttribute

type OutputAttribute struct {

	// A name of a column to be written to the output. This must be an InputField name
	// in the schema mapping.
	//
	// This member is required.
	Name *string

	// Enables the ability to hash the column values in the output.
	Hashed *bool
	// contains filtered or unexported fields
}

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.

type OutputSource

type OutputSource struct {

	// 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.
	//
	// This member is required.
	Output []OutputAttribute

	// The S3 path to which Entity Resolution will write the output table.
	//
	// This member is required.
	OutputS3Path *string

	// 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.
	ApplyNormalization *bool

	// Customer KMS ARN for encryption at rest. If not provided, system will use an
	// Entity Resolution managed KMS key.
	KMSArn *string
	// contains filtered or unexported fields
}

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.

type ProcessingType added in v1.19.0

type ProcessingType string
const (
	ProcessingTypeConsistent       ProcessingType = "CONSISTENT"
	ProcessingTypeEventual         ProcessingType = "EVENTUAL"
	ProcessingTypeEventualNoLookup ProcessingType = "EVENTUAL_NO_LOOKUP"
)

Enum values for ProcessingType

func (ProcessingType) Values added in v1.19.0

func (ProcessingType) Values() []ProcessingType

Values returns all known values for ProcessingType. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type ProviderComponentSchema added in v1.9.0

type ProviderComponentSchema struct {

	// The provider schema attributes.
	ProviderSchemaAttributes []ProviderSchemaAttribute

	// Input schema for the provider service.
	Schemas [][]string
	// contains filtered or unexported fields
}

The input schema supported by provider service.

type ProviderEndpointConfiguration added in v1.3.0

type ProviderEndpointConfiguration interface {
	// contains filtered or unexported methods
}

The required configuration fields to use with the provider service.

The following types satisfy this interface:

ProviderEndpointConfigurationMemberMarketplaceConfiguration
Example (OutputUsage)
// Code generated by smithy-go-codegen DO NOT EDIT.

package main

import (
	"fmt"
	"github.com/aws/aws-sdk-go-v2/service/entityresolution/types"
)

func main() {
	var union types.ProviderEndpointConfiguration
	// type switches can be used to check the union value
	switch v := union.(type) {
	case *types.ProviderEndpointConfigurationMemberMarketplaceConfiguration:
		_ = v.Value // Value is types.ProviderMarketplaceConfiguration

	case *types.UnknownUnionMember:
		fmt.Println("unknown tag:", v.Tag)

	default:
		fmt.Println("union is nil or unknown type")

	}
}

var _ *types.ProviderMarketplaceConfiguration

type ProviderEndpointConfigurationMemberMarketplaceConfiguration added in v1.3.0

type ProviderEndpointConfigurationMemberMarketplaceConfiguration struct {
	Value ProviderMarketplaceConfiguration
	// contains filtered or unexported fields
}

The identifiers of the provider service, from Data Exchange.

type ProviderIdNameSpaceConfiguration added in v1.9.0

type ProviderIdNameSpaceConfiguration struct {

	// The description of the ID namespace.
	Description *string

	// Configurations required for the source ID namespace.
	ProviderSourceConfigurationDefinition document.Interface

	// Configurations required for the target ID namespace.
	ProviderTargetConfigurationDefinition document.Interface
	// contains filtered or unexported fields
}

The provider configuration required for different ID namespace types.

type ProviderIntermediateDataAccessConfiguration added in v1.3.0

type ProviderIntermediateDataAccessConfiguration struct {

	// The Amazon Web Services account that provider can use to read or write data
	// into the customer's intermediate S3 bucket.
	AwsAccountIds []string

	// The S3 bucket actions that the provider requires permission for.
	RequiredBucketActions []string
	// contains filtered or unexported fields
}

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

type ProviderMarketplaceConfiguration added in v1.3.0

type ProviderMarketplaceConfiguration struct {

	// The asset ID on Data Exchange.
	//
	// This member is required.
	AssetId *string

	// The dataset ID on Data Exchange.
	//
	// This member is required.
	DataSetId *string

	// The listing ID on Data Exchange.
	//
	// This member is required.
	ListingId *string

	// The revision ID on Data Exchange.
	//
	// This member is required.
	RevisionId *string
	// contains filtered or unexported fields
}

The identifiers of the provider service, from Data Exchange.

type ProviderProperties added in v1.3.0

type ProviderProperties struct {

	// The ARN of the provider service.
	//
	// This member is required.
	ProviderServiceArn *string

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

	// The required configuration fields to use with the provider service.
	ProviderConfiguration document.Interface
	// contains filtered or unexported fields
}

An object containing the providerServiceARN , intermediateSourceConfiguration , and providerConfiguration .

type ProviderSchemaAttribute added in v1.9.0

type ProviderSchemaAttribute struct {

	// The field name.
	//
	// This member is required.
	FieldName *string

	// The type of the provider schema attribute.
	//
	// LiveRamp supports: 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 |
	// EMAIL_ADDRESS | UNIQUE_ID | PROVIDER_ID
	//
	// TransUnion supports: NAME | NAME_FIRST | NAME_LAST | ADDRESS | ADDRESS_CITY |
	// ADDRESS_STATE | ADDRESS_COUNTRY | ADDRESS_POSTALCODE | PHONE_NUMBER |
	// EMAIL_ADDRESS | UNIQUE_ID | DATE | IPV4 | IPV6 | MAID
	//
	// Unified ID 2.0 supports: PHONE_NUMBER | EMAIL_ADDRESS | UNIQUE_ID
	//
	// This member is required.
	Type SchemaAttributeType

	// The hashing attribute of the provider schema.
	Hashing *bool

	// The sub type of the provider schema attribute.
	SubType *string
	// contains filtered or unexported fields
}

The provider schema attribute.

type ProviderServiceSummary added in v1.3.0

type ProviderServiceSummary struct {

	// The name of the provider. This name is typically the company name.
	//
	// This member is required.
	ProviderName *string

	// The ARN (Amazon Resource Name) that Entity Resolution generated for the
	// providerService .
	//
	// This member is required.
	ProviderServiceArn *string

	// The display name of the provider service.
	//
	// This member is required.
	ProviderServiceDisplayName *string

	// The name of the product that the provider service provides.
	//
	// This member is required.
	ProviderServiceName *string

	// The type of provider service.
	//
	// This member is required.
	ProviderServiceType ServiceType
	// contains filtered or unexported fields
}

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

type Record added in v1.19.0

type Record struct {

	//  The input source ARN of the record.
	//
	// This member is required.
	InputSourceARN *string

	//  The record's attribute map.
	//
	// This member is required.
	RecordAttributeMap map[string]string

	//  The unique ID of the record.
	//
	// This member is required.
	UniqueId *string
	// contains filtered or unexported fields
}

The record.

type RecordMatchingModel added in v1.13.0

type RecordMatchingModel string
const (
	RecordMatchingModelOneSourceToOneTarget  RecordMatchingModel = "ONE_SOURCE_TO_ONE_TARGET"
	RecordMatchingModelManySourceToOneTarget RecordMatchingModel = "MANY_SOURCE_TO_ONE_TARGET"
)

Enum values for RecordMatchingModel

func (RecordMatchingModel) Values added in v1.13.0

Values returns all known values for RecordMatchingModel. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type ResolutionTechniques

type ResolutionTechniques struct {

	// The type of matching workflow to create. Specify one of the following types:
	//
	//   - RULE_MATCHING : Match records using configurable rule-based criteria
	//
	//   - ML_MATCHING : Match records using machine learning models
	//
	//   - PROVIDER : Match records using a third-party matching provider
	//
	// This member is required.
	ResolutionType ResolutionType

	// The properties of the provider service.
	ProviderProperties *ProviderProperties

	// An object which defines the list of matching rules to run and has a field rules
	// , which is a list of rule objects.
	RuleBasedProperties *RuleBasedProperties

	// An object containing the rules for a matching workflow.
	RuleConditionProperties *RuleConditionProperties
	// contains filtered or unexported fields
}

An object which defines the resolutionType and the ruleBasedProperties .

type ResolutionType

type ResolutionType string
const (
	ResolutionTypeRuleMatching ResolutionType = "RULE_MATCHING"
	ResolutionTypeMlMatching   ResolutionType = "ML_MATCHING"
	ResolutionTypeProvider     ResolutionType = "PROVIDER"
)

Enum values for ResolutionType

func (ResolutionType) Values

func (ResolutionType) Values() []ResolutionType

Values returns all known values for ResolutionType. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type ResourceNotFoundException

type ResourceNotFoundException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

The resource couldn't be found.

func (*ResourceNotFoundException) Error

func (e *ResourceNotFoundException) Error() string

func (*ResourceNotFoundException) ErrorCode

func (e *ResourceNotFoundException) ErrorCode() string

func (*ResourceNotFoundException) ErrorFault

func (*ResourceNotFoundException) ErrorMessage

func (e *ResourceNotFoundException) ErrorMessage() string

type Rule

type Rule struct {

	// A list of MatchingKeys . The MatchingKeys must have been defined in the
	// SchemaMapping . Two records are considered to match according to this rule if
	// all of the MatchingKeys match.
	//
	// This member is required.
	MatchingKeys []string

	// A name for the matching rule.
	//
	// This member is required.
	RuleName *string
	// contains filtered or unexported fields
}

An object containing the ruleName and matchingKeys .

type RuleBasedProperties

type RuleBasedProperties struct {

	// The comparison type. You can choose ONE_TO_ONE or MANY_TO_MANY as the
	// attributeMatchingModel .
	//
	// If you choose ONE_TO_ONE , the system can only match attributes if the sub-types
	// are an exact match. For example, for the Email attribute type, the system will
	// only consider it a match if the value of the Email field of Profile A matches
	// the value of the Email field of Profile B.
	//
	// If you choose MANY_TO_MANY , the system can match attributes across the
	// sub-types of an attribute type. For example, if the value of the Email field of
	// Profile A and the value of BusinessEmail field of Profile B matches, the two
	// profiles are matched on the Email attribute type.
	//
	// This member is required.
	AttributeMatchingModel AttributeMatchingModel

	// A list of Rule objects, each of which have fields RuleName and MatchingKeys .
	//
	// This member is required.
	Rules []Rule

	//  An indicator of whether to generate IDs and index the data or not.
	//
	// If you choose IDENTIFIER_GENERATION , the process generates IDs and indexes the
	// data.
	//
	// If you choose INDEXING , the process indexes the data without generating IDs.
	MatchPurpose MatchPurpose
	// contains filtered or unexported fields
}

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

type RuleCondition added in v1.21.0

type RuleCondition struct {

	// A statement that specifies the conditions for a matching rule.
	//
	// If your data is accurate, use an Exact matching function: Exact or
	// ExactManyToMany .
	//
	// If your data has variations in spelling or pronunciation, use a Fuzzy matching
	// function: Cosine , Levenshtein , or Soundex .
	//
	// Use operators if you want to combine ( AND ), separate ( OR ), or group matching
	// functions (...) .
	//
	// For example: (Cosine(a, 10) AND Exact(b, true)) OR ExactManyToMany(c, d)
	//
	// This member is required.
	Condition *string

	// A name for the matching rule.
	//
	// For example: Rule1
	//
	// This member is required.
	RuleName *string
	// contains filtered or unexported fields
}

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

type RuleConditionProperties added in v1.21.0

type RuleConditionProperties struct {

	//  A list of rule objects, each of which have fields ruleName and condition .
	//
	// This member is required.
	Rules []RuleCondition
	// contains filtered or unexported fields
}

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

type SchemaAttributeType

type SchemaAttributeType string
const (
	SchemaAttributeTypeName              SchemaAttributeType = "NAME"
	SchemaAttributeTypeNameFirst         SchemaAttributeType = "NAME_FIRST"
	SchemaAttributeTypeNameMiddle        SchemaAttributeType = "NAME_MIDDLE"
	SchemaAttributeTypeNameLast          SchemaAttributeType = "NAME_LAST"
	SchemaAttributeTypeAddress           SchemaAttributeType = "ADDRESS"
	SchemaAttributeTypeAddressStreet1    SchemaAttributeType = "ADDRESS_STREET1"
	SchemaAttributeTypeAddressStreet2    SchemaAttributeType = "ADDRESS_STREET2"
	SchemaAttributeTypeAddressStreet3    SchemaAttributeType = "ADDRESS_STREET3"
	SchemaAttributeTypeAddressCity       SchemaAttributeType = "ADDRESS_CITY"
	SchemaAttributeTypeAddressState      SchemaAttributeType = "ADDRESS_STATE"
	SchemaAttributeTypeAddressCountry    SchemaAttributeType = "ADDRESS_COUNTRY"
	SchemaAttributeTypeAddressPostalcode SchemaAttributeType = "ADDRESS_POSTALCODE"
	SchemaAttributeTypePhone             SchemaAttributeType = "PHONE"
	SchemaAttributeTypePhoneNumber       SchemaAttributeType = "PHONE_NUMBER"
	SchemaAttributeTypePhoneCountrycode  SchemaAttributeType = "PHONE_COUNTRYCODE"
	SchemaAttributeTypeEmailAddress      SchemaAttributeType = "EMAIL_ADDRESS"
	SchemaAttributeTypeUniqueId          SchemaAttributeType = "UNIQUE_ID"
	SchemaAttributeTypeDate              SchemaAttributeType = "DATE"
	SchemaAttributeTypeString            SchemaAttributeType = "STRING"
	SchemaAttributeTypeProviderId        SchemaAttributeType = "PROVIDER_ID"
	SchemaAttributeTypeIpv4              SchemaAttributeType = "IPV4"
	SchemaAttributeTypeIpv6              SchemaAttributeType = "IPV6"
	SchemaAttributeTypeMaid              SchemaAttributeType = "MAID"
)

Enum values for SchemaAttributeType

func (SchemaAttributeType) Values

Values returns all known values for SchemaAttributeType. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type SchemaInputAttribute

type SchemaInputAttribute struct {

	// A string containing the field name.
	//
	// This member is required.
	FieldName *string

	// The type of the attribute, selected from a list of values.
	//
	// LiveRamp supports: 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 |
	// EMAIL_ADDRESS | UNIQUE_ID | PROVIDER_ID
	//
	// TransUnion supports: NAME | NAME_FIRST | NAME_LAST | ADDRESS | ADDRESS_CITY |
	// ADDRESS_STATE | ADDRESS_COUNTRY | ADDRESS_POSTALCODE | PHONE_NUMBER |
	// EMAIL_ADDRESS | UNIQUE_ID | IPV4 | IPV6 | MAID
	//
	// Unified ID 2.0 supports: PHONE_NUMBER | EMAIL_ADDRESS | UNIQUE_ID
	//
	// Normalization is only supported for NAME , ADDRESS , PHONE , and EMAIL_ADDRESS .
	//
	// If you want to normalize NAME_FIRST , NAME_MIDDLE , and NAME_LAST , you must
	// group them by assigning them to the NAME groupName .
	//
	// If you want to normalize ADDRESS_STREET1 , ADDRESS_STREET2 , ADDRESS_STREET3 ,
	// ADDRESS_CITY , ADDRESS_STATE , ADDRESS_COUNTRY , and ADDRESS_POSTALCODE , you
	// must group them by assigning them to the ADDRESS groupName .
	//
	// If you want to normalize PHONE_NUMBER and PHONE_COUNTRYCODE , you must group
	// them by assigning them to the PHONE groupName .
	//
	// This member is required.
	Type SchemaAttributeType

	// A string that instructs Entity Resolution to combine several columns into a
	// unified column with the identical attribute type.
	//
	// For example, when working with columns such as NAME_FIRST , NAME_MIDDLE , and
	// NAME_LAST , assigning them a common groupName will prompt Entity Resolution to
	// concatenate them into a single value.
	GroupName *string

	//  Indicates if the column values are hashed in the schema input.
	//
	// If the value is set to TRUE , the column values are hashed.
	//
	// If the value is set to FALSE , the column values are cleartext.
	Hashed *bool

	// A key that allows grouping of multiple input attributes into a unified matching
	// group.
	//
	// For example, consider a scenario where the source table contains various
	// addresses, such as business_address and shipping_address . By assigning a
	// matchKey called address to both attributes, Entity Resolution will match
	// records across these fields to create a consolidated matching group.
	//
	// If no matchKey is specified for a column, it won't be utilized for matching
	// purposes but will still be included in the output table.
	MatchKey *string

	// The subtype of the attribute, selected from a list of values.
	SubType *string
	// contains filtered or unexported fields
}

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.

type SchemaMappingSummary

type SchemaMappingSummary struct {

	// The timestamp of when the SchemaMapping was created.
	//
	// This member is required.
	CreatedAt *time.Time

	// Specifies whether the schema mapping has been applied to a workflow.
	//
	// This member is required.
	HasWorkflows *bool

	// The ARN (Amazon Resource Name) that Entity Resolution generated for the
	// SchemaMapping .
	//
	// This member is required.
	SchemaArn *string

	// The name of the schema.
	//
	// This member is required.
	SchemaName *string

	// The timestamp of when the SchemaMapping was last updated.
	//
	// This member is required.
	UpdatedAt *time.Time
	// contains filtered or unexported fields
}

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

type ServiceType added in v1.3.0

type ServiceType string
const (
	ServiceTypeAssignment ServiceType = "ASSIGNMENT"
	ServiceTypeIdMapping  ServiceType = "ID_MAPPING"
)

Enum values for ServiceType

func (ServiceType) Values added in v1.3.0

func (ServiceType) Values() []ServiceType

Values returns all known values for ServiceType. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type StatementEffect added in v1.9.0

type StatementEffect string
const (
	StatementEffectAllow StatementEffect = "Allow"
	StatementEffectDeny  StatementEffect = "Deny"
)

Enum values for StatementEffect

func (StatementEffect) Values added in v1.9.0

func (StatementEffect) Values() []StatementEffect

Values returns all known values for StatementEffect. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type ThrottlingException

type ThrottlingException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

The request was denied due to request throttling.

func (*ThrottlingException) Error

func (e *ThrottlingException) Error() string

func (*ThrottlingException) ErrorCode

func (e *ThrottlingException) ErrorCode() string

func (*ThrottlingException) ErrorFault

func (e *ThrottlingException) ErrorFault() smithy.ErrorFault

func (*ThrottlingException) ErrorMessage

func (e *ThrottlingException) ErrorMessage() string

type UnknownUnionMember added in v1.3.0

type UnknownUnionMember struct {
	Tag   string
	Value []byte
	// contains filtered or unexported fields
}

UnknownUnionMember is returned when a union member is returned over the wire, but has an unknown tag.

type ValidationException

type ValidationException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

The input fails to satisfy the constraints specified by Entity Resolution.

func (*ValidationException) Error

func (e *ValidationException) Error() string

func (*ValidationException) ErrorCode

func (e *ValidationException) ErrorCode() string

func (*ValidationException) ErrorFault

func (e *ValidationException) ErrorFault() smithy.ErrorFault

func (*ValidationException) ErrorMessage

func (e *ValidationException) ErrorMessage() string

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL