Module Awso_entityresolution.ValuesSource

Sourceval service : Awso.Service.t
Sourceval apiVersion : string
Sourceval endpointPrefix : string
Sourceval serviceFullName : string
Sourceval signatureVersion : string
Sourceval protocol : string
Sourceval globalEndpoint : string
Sourceval serviceAbbreviation : string
Sourceval simple_to_json : ('a -> Awso__Botodata.value) -> 'a -> Yojson.Safe.t
Sourceval composed_to_json : ('a -> Awso__Botodata.value) -> 'a -> Yojson.Safe.t
Sourceval to_query : ('a -> Awso.Client.Query.value) -> 'a -> Awso.Client.Query.t
Sourceval structure_to_value_aux : ('a * 'b option) list -> f:(('a * 'b) list -> 'c) -> [> `Structure of 'c ]
Sourceval structure_to_value : ('a * 'b option) list -> [> `Structure of ('a * 'b) list ]
Sourceval structure_to_wrapped_value : wrapper:'a -> response:'a -> ('b * 'c option) list -> [> `Structure of ('a * [> `Structure of ('b * 'c) list ]) list ]
Sourcemodule AttributeName : sig ... end
Sourcemodule RuleMatchingKeysList : sig ... end
Sourcemodule RuleRuleNameString : sig ... end
Sourcemodule Boolean : sig ... end
Sourcemodule Rule : sig ... end

An object containing the ruleName and matchingKeys.

Sourcemodule RecordMatchingModel : sig ... end
Sourcemodule IdMappingType : sig ... end
Sourcemodule InputSourceARN : sig ... end
Sourcemodule String_ : sig ... end
Sourcemodule CustomerProfilesDomainArn : sig ... end
Sourcemodule OutputAttribute : sig ... end

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.

Sourcemodule S3Path : sig ... end
Sourcemodule RuleCondition : sig ... end

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

Sourcemodule Document : sig ... end
Sourcemodule ProviderServiceArn : sig ... end
Sourcemodule AttributeMatchingModel : sig ... end
Sourcemodule RecordMatchingModelList : sig ... end

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

Sourcemodule SchemaAttributeType : sig ... end
Sourcemodule MatchedRecord : sig ... end

The matched record.

Sourcemodule EntityName : sig ... end

Specifies the configuration for integrating with Customer Profiles. This configuration enables Entity Resolution to send matched output directly to Customer Profiles instead of Amazon S3, creating a unified customer view by automatically updating customer profiles based on match clusters.

Sourcemodule KMSArn : sig ... end
Sourcemodule OptionalS3Path : sig ... end
Sourcemodule OutputSourceOutputList : sig ... end

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

Sourcemodule MatchPurpose : sig ... end
Sourcemodule MatchingConfig : sig ... end

An object that contains configuration settings for the matching process in a rule-based matching workflow.

An object containing providerConfiguration and providerServiceArn.

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

Sourcemodule IdNamespaceType : sig ... end
Sourcemodule RoleArn : sig ... end
Sourcemodule SchemaMappingArn : sig ... end
Sourcemodule Timestamp : sig ... end
Sourcemodule ServiceType : sig ... end
Sourcemodule MatchingWorkflowArn : sig ... end
Sourcemodule ResolutionType : sig ... end
Sourcemodule JobId : sig ... end
Sourcemodule JobStatus : sig ... end
Sourcemodule Description : sig ... end
Sourcemodule IdNamespaceArn : sig ... end
Sourcemodule IdMappingWorkflowArn : sig ... end
Sourcemodule ProviderSchemaAttribute : sig ... end

The provider schema attribute.

Sourcemodule SchemaList : sig ... end
Sourcemodule AwsAccountId : sig ... end
Sourcemodule ErrorMessage : sig ... end
Sourcemodule MatchedRecordsList : sig ... end
Sourcemodule UniqueId : sig ... end
Sourcemodule DeleteUniqueIdErrorType : sig ... end
Sourcemodule HeaderSafeUniqueId : sig ... end
Sourcemodule SchemaInputAttribute : sig ... end

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.

Sourcemodule IncrementalRunType : sig ... end
Sourcemodule InputSource : sig ... end

An object containing inputSourceARN, schemaName, and applyNormalization.

Sourcemodule OutputSource : sig ... end

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.

Sourcemodule ProviderProperties : sig ... end

An object containing the providerServiceARN, intermediateSourceConfiguration, and providerConfiguration.

Sourcemodule RuleBasedProperties : sig ... end

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

Sourcemodule RuleConditionProperties : sig ... end

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

An object containing idMappingType, providerProperties, and ruleBasedProperties.

Sourcemodule IdNamespaceInputSource : sig ... end

An object containing inputSourceARN and schemaName.

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

An object containing inputSourceARN, schemaName, and type.

The output source for the ID mapping workflow.

Sourcemodule TagKey : sig ... end
Sourcemodule TagValue : sig ... end
Sourcemodule Integer : sig ... end
Sourcemodule IdMappingJobOutputSource : sig ... end

An object containing KMSArn, outputS3Path, and roleARN.

Sourcemodule SchemaMappingSummary : sig ... end

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

Sourcemodule ProviderServiceSummary : sig ... end

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

Sourcemodule MatchingWorkflowSummary : sig ... end

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

Sourcemodule JobSummary : sig ... end

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

Sourcemodule IdNamespaceSummary : sig ... end

A summary of ID namespaces.

Sourcemodule IdMappingWorkflowSummary : sig ... end

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

Sourcemodule ProviderSchemaAttributes : sig ... end
Sourcemodule Schemas : sig ... end

The identifiers of the provider service, from Data Exchange.

Sourcemodule AwsAccountIdList : sig ... end
Sourcemodule RequiredBucketActionsList : sig ... end
Sourcemodule JobOutputSource : sig ... end

An object containing KMSArn, outputS3Path, and roleArn.

Sourcemodule FailedRecord : sig ... end

The record that didn't generate a Match ID.

Sourcemodule MatchGroup : sig ... end

The match group.

Sourcemodule Record : sig ... end

The record.

Sourcemodule DeleteUniqueIdError : sig ... end

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

Sourcemodule DeletedUniqueId : sig ... end

The deleted unique ID.

Sourcemodule StatementAction : sig ... end
Sourcemodule StatementPrincipal : sig ... end
Sourcemodule AccessDeniedException : sig ... end

You do not have sufficient access to perform this action.

Sourcemodule ConflictException : sig ... end

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.

Sourcemodule InternalServerException : sig ... end

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

Sourcemodule ResourceNotFoundException : sig ... end

The resource couldn't be found.

Sourcemodule SchemaInputAttributes : sig ... end
Sourcemodule ThrottlingException : sig ... end

The request was denied due to request throttling.

Sourcemodule ValidationException : sig ... end

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

Sourcemodule IncrementalRunConfig : sig ... end

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.

Sourcemodule InputSourceConfig : sig ... end
Sourcemodule OutputSourceConfig : sig ... end
Sourcemodule ResolutionTechniques : sig ... end

An object which defines the resolutionType and the ruleBasedProperties.

Incremental run configuration for an ID mapping workflow.

Sourcemodule IdMappingRoleArn : sig ... end
Sourcemodule IdMappingTechniques : sig ... end

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

Sourcemodule TagKeyList : sig ... end
Sourcemodule VeniceGlobalArn : sig ... end
Sourcemodule TagMap : sig ... end
Sourcemodule ExceedsLimitException : sig ... end

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

Sourcemodule JobType : sig ... end
Sourcemodule PolicyDocument : sig ... end
Sourcemodule PolicyToken : sig ... end
Sourcemodule NextToken : sig ... end
Sourcemodule SchemaMappingList : sig ... end
Sourcemodule ProviderServiceList : sig ... end
Sourcemodule MatchingWorkflowList : sig ... end
Sourcemodule JobList : sig ... end
Sourcemodule IdNamespaceList : sig ... end
Sourcemodule IdMappingWorkflowList : sig ... end
Sourcemodule ProviderComponentSchema : sig ... end

The input schema supported by provider service.

The required configuration fields to use with the provider service.

The provider configuration required for different ID namespace types.

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

Sourcemodule ErrorDetails : sig ... end

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

Sourcemodule JobMetrics : sig ... end

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

Sourcemodule JobOutputSourceConfig : sig ... end
Sourcemodule RecordAttributeMap : sig ... end
Sourcemodule IdMappingJobMetrics : sig ... end

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.

Sourcemodule FailedRecordsList : sig ... end
Sourcemodule MatchGroupsList : sig ... end
Sourcemodule ProcessingType : sig ... end
Sourcemodule StatementId : sig ... end
Sourcemodule DeleteUniqueIdErrorsList : sig ... end
Sourcemodule DeleteUniqueIdStatus : sig ... end
Sourcemodule DeletedUniqueIdList : sig ... end
Sourcemodule DisconnectedUniqueIdsList : sig ... end
Sourcemodule UniqueIdList : sig ... end
Sourcemodule StatementActionList : sig ... end
Sourcemodule StatementCondition : sig ... end
Sourcemodule StatementEffect : sig ... end
Sourcemodule StatementPrincipalList : sig ... end
Sourcemodule UpdateSchemaMappingOutput : sig ... end

Updates a schema mapping. A schema is immutable if it is being used by a workflow. Therefore, you can't update a schema mapping if it's associated with a workflow.

Sourcemodule UpdateSchemaMappingInput : sig ... end

Updates a schema mapping. A schema is immutable if it is being used by a workflow. Therefore, you can't update a schema mapping if it's associated with a workflow.

Updates an existing matching workflow. The workflow must already exist for this operation to succeed. For workflows where resolutionType is ML_MATCHING or PROVIDER, incremental processing is not supported.

Updates an existing matching workflow. The workflow must already exist for this operation to succeed. For workflows where resolutionType is ML_MATCHING or PROVIDER, incremental processing is not supported.

Sourcemodule UpdateIdNamespaceOutput : sig ... end

Updates an existing ID namespace.

Sourcemodule UpdateIdNamespaceInput : sig ... end

Updates an existing ID namespace.

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. Incremental processing is not supported for ID mapping workflows.

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. Incremental processing is not supported for ID mapping workflows.

Sourcemodule UntagResourceOutput : sig ... end

Removes one or more tags from the specified Entity Resolution resource. In Entity Resolution, SchemaMapping, and MatchingWorkflow can be tagged.

Sourcemodule UntagResourceInput : sig ... end

Removes one or more tags from the specified Entity Resolution resource. In Entity Resolution, SchemaMapping, and MatchingWorkflow can be tagged.

Sourcemodule TagResourceOutput : sig ... end

Assigns one or more tags (key-value pairs) to the specified Entity Resolution resource. Tags can help you organize and categorize your resources. You can also use them to scope user permissions by granting a user permission to access or change only resources with certain tag values. In Entity Resolution, SchemaMapping and MatchingWorkflow can be tagged. Tags don't have any semantic meaning to Amazon Web Services and are interpreted strictly as strings of characters. You can use the TagResource action with a resource that already has tags. If you specify a new tag key, this tag is appended to the list of tags associated with the resource. If you specify a tag key that is already associated with the resource, the new tag value that you specify replaces the previous value for that tag.

Sourcemodule TagResourceInput : sig ... end

Assigns one or more tags (key-value pairs) to the specified Entity Resolution resource. Tags can help you organize and categorize your resources. You can also use them to scope user permissions by granting a user permission to access or change only resources with certain tag values. In Entity Resolution, SchemaMapping and MatchingWorkflow can be tagged. Tags don't have any semantic meaning to Amazon Web Services and are interpreted strictly as strings of characters. You can use the TagResource action with a resource that already has tags. If you specify a new tag key, this tag is appended to the list of tags associated with the resource. If you specify a tag key that is already associated with the resource, the new tag value that you specify replaces the previous value for that tag.

Sourcemodule StartMatchingJobOutput : sig ... end

Starts the MatchingJob of a workflow. The workflow must have previously been created using the CreateMatchingWorkflow endpoint.

Sourcemodule StartMatchingJobInput : sig ... end

Starts the MatchingJob of a workflow. The workflow must have previously been created using the CreateMatchingWorkflow endpoint.

Sourcemodule StartIdMappingJobOutput : sig ... end

Starts the IdMappingJob of a workflow. The workflow must have previously been created using the CreateIdMappingWorkflow endpoint.

Sourcemodule StartIdMappingJobInput : sig ... end

Starts the IdMappingJob of a workflow. The workflow must have previously been created using the CreateIdMappingWorkflow endpoint.

Sourcemodule PutPolicyOutput : sig ... end

Updates the resource-based policy.

Sourcemodule PutPolicyInput : sig ... end

Updates the resource-based policy.

Sourcemodule ListTagsForResourceOutput : sig ... end

Displays the tags associated with an Entity Resolution resource. In Entity Resolution, SchemaMapping, and MatchingWorkflow can be tagged.

Sourcemodule ListTagsForResourceInput : sig ... end

Displays the tags associated with an Entity Resolution resource. In Entity Resolution, SchemaMapping, and MatchingWorkflow can be tagged.

Sourcemodule ListSchemaMappingsOutput : sig ... end

Returns a list of all the SchemaMappings that have been created for an Amazon Web Services account.

Sourcemodule ListSchemaMappingsInput : sig ... end

Returns a list of all the SchemaMappings that have been created for an Amazon Web Services account.

Returns a list of all the ProviderServices that are available in this Amazon Web Services Region.

Sourcemodule ListProviderServicesInput : sig ... end

Returns a list of all the ProviderServices that are available in this Amazon Web Services Region.

Returns a list of all the MatchingWorkflows that have been created for an Amazon Web Services account.

Returns a list of all the MatchingWorkflows that have been created for an Amazon Web Services account.

Sourcemodule ListMatchingJobsOutput : sig ... end

Lists all jobs for a given workflow.

Sourcemodule ListMatchingJobsInput : sig ... end

Lists all jobs for a given workflow.

Sourcemodule ListIdNamespacesOutput : sig ... end

Returns a list of all ID namespaces.

Sourcemodule ListIdNamespacesInput : sig ... end

Returns a list of all ID namespaces.

Returns a list of all the IdMappingWorkflows that have been created for an Amazon Web Services account.

Returns a list of all the IdMappingWorkflows that have been created for an Amazon Web Services account.

Sourcemodule ListIdMappingJobsOutput : sig ... end

Lists all ID mapping jobs for a given workflow.

Sourcemodule ListIdMappingJobsInput : sig ... end

Lists all ID mapping jobs for a given workflow.

Sourcemodule GetSchemaMappingOutput : sig ... end

Returns the SchemaMapping of a given name.

Sourcemodule GetSchemaMappingInput : sig ... end

Returns the SchemaMapping of a given name.

Sourcemodule GetProviderServiceOutput : sig ... end

Returns the ProviderService of a given name.

Sourcemodule GetProviderServiceInput : sig ... end

Returns the ProviderService of a given name.

Sourcemodule GetPolicyOutput : sig ... end

Returns the resource-based policy.

Sourcemodule GetPolicyInput : sig ... end

Returns the resource-based policy.

Sourcemodule GetMatchingWorkflowOutput : sig ... end

Returns the MatchingWorkflow with a given name, if it exists.

Sourcemodule GetMatchingWorkflowInput : sig ... end

Returns the MatchingWorkflow with a given name, if it exists.

Sourcemodule GetMatchingJobOutput : sig ... end

Returns the status, metrics, and errors (if there are any) that are associated with a job.

Sourcemodule GetMatchingJobInput : sig ... end

Returns the status, metrics, and errors (if there are any) that are associated with a job.

Sourcemodule GetMatchIdOutput : sig ... end

Returns the corresponding Match ID of a customer record if the record has been processed in a rule-based matching workflow. You can call this API as a dry run of an incremental load on the rule-based matching workflow.

Sourcemodule GetMatchIdInput : sig ... end

Returns the corresponding Match ID of a customer record if the record has been processed in a rule-based matching workflow. You can call this API as a dry run of an incremental load on the rule-based matching workflow.

Sourcemodule GetIdNamespaceOutput : sig ... end

Returns the IdNamespace with a given name, if it exists.

Sourcemodule GetIdNamespaceInput : sig ... end

Returns the IdNamespace with a given name, if it exists.

Returns the IdMappingWorkflow with a given name, if it exists.

Sourcemodule GetIdMappingWorkflowInput : sig ... end

Returns the IdMappingWorkflow with a given name, if it exists.

Sourcemodule GetIdMappingJobOutput : sig ... end

Returns the status, metrics, and errors (if there are any) that are associated with a job.

Sourcemodule GetIdMappingJobInput : sig ... end

Returns the status, metrics, and errors (if there are any) that are associated with a job.

Sourcemodule GenerateMatchIdOutput : sig ... end

Generates or retrieves Match IDs for records using a rule-based matching workflow. When you call this operation, it processes your records against the workflow's matching rules to identify potential matches. For existing records, it retrieves their Match IDs and associated rules. For records without matches, it generates new Match IDs. The operation saves results to Amazon S3. The processing type (processingType) you choose affects both the accuracy and response time of the operation. Additional charges apply for each API call, whether made through the Entity Resolution console or directly via the API. The rule-based matching workflow must exist and be active before calling this operation.

Sourcemodule GenerateMatchIdInput : sig ... end

Generates or retrieves Match IDs for records using a rule-based matching workflow. When you call this operation, it processes your records against the workflow's matching rules to identify potential matches. For existing records, it retrieves their Match IDs and associated rules. For records without matches, it generates new Match IDs. The operation saves results to Amazon S3. The processing type (processingType) you choose affects both the accuracy and response time of the operation. Additional charges apply for each API call, whether made through the Entity Resolution console or directly via the API. The rule-based matching workflow must exist and be active before calling this operation.

Sourcemodule DeleteSchemaMappingOutput : sig ... end

Deletes the SchemaMapping with a given name. This operation will succeed even if a schema with the given name does not exist. This operation will fail if there is a MatchingWorkflow object that references the SchemaMapping in the workflow's InputSourceConfig.

Sourcemodule DeleteSchemaMappingInput : sig ... end

Deletes the SchemaMapping with a given name. This operation will succeed even if a schema with the given name does not exist. This operation will fail if there is a MatchingWorkflow object that references the SchemaMapping in the workflow's InputSourceConfig.

Deletes the policy statement.

Deletes the policy statement.

Deletes the MatchingWorkflow with a given name. This operation will succeed even if a workflow with the given name does not exist.

Deletes the MatchingWorkflow with a given name. This operation will succeed even if a workflow with the given name does not exist.

Sourcemodule DeleteIdNamespaceOutput : sig ... end

Deletes the IdNamespace with a given name.

Sourcemodule DeleteIdNamespaceInput : sig ... end

Deletes the IdNamespace with a given name.

Deletes the IdMappingWorkflow with a given name. This operation will succeed even if a workflow with the given name does not exist.

Deletes the IdMappingWorkflow with a given name. This operation will succeed even if a workflow with the given name does not exist.

Sourcemodule CreateSchemaMappingOutput : sig ... end

Creates a schema mapping, which defines the schema of the input customer records table. The SchemaMapping also provides Entity Resolution with some metadata about the table, such as the attribute types of the columns and which columns to match on.

Sourcemodule CreateSchemaMappingInput : sig ... end

Creates a schema mapping, which defines the schema of the input customer records table. The SchemaMapping also provides Entity Resolution with some metadata about the table, such as the attribute types of the columns and which columns to match on.

Creates a matching workflow that defines the configuration for a data processing job. The workflow name must be unique. To modify an existing workflow, use UpdateMatchingWorkflow. For workflows where resolutionType is ML_MATCHING or PROVIDER, incremental processing is not supported.

Creates a matching workflow that defines the configuration for a data processing job. The workflow name must be unique. To modify an existing workflow, use UpdateMatchingWorkflow. For workflows where resolutionType is ML_MATCHING or PROVIDER, incremental processing is not supported.

Sourcemodule CreateIdNamespaceOutput : sig ... end

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.

Sourcemodule CreateIdNamespaceInput : sig ... end

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.

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. Incremental processing is not supported for ID mapping workflows.

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. Incremental processing is not supported for ID mapping workflows.

Sourcemodule BatchDeleteUniqueIdOutput : sig ... end

Deletes multiple unique IDs in a matching workflow.

Sourcemodule BatchDeleteUniqueIdInput : sig ... end

Deletes multiple unique IDs in a matching workflow.

Sourcemodule AddPolicyStatementOutput : sig ... end

Adds a policy statement object. To retrieve a list of existing policy statements, use the GetPolicy API.

Sourcemodule AddPolicyStatementInput : sig ... end

Adds a policy statement object. To retrieve a list of existing policy statements, use the GetPolicy API.