openapi: 3.0.0 info: version: '2018-05-10' x-release: v4 title: AWS EntityResolution description: '

Welcome to the AWS Entity Resolution API Reference.

AWS Entity Resolution is an AWS service that provides pre-configured entity resolution capabilities that enable developers and analysts at advertising and marketing companies to build an accurate and complete view of their consumers.

With AWS Entity Resolution, you have the ability to match source records containing consumer identifiers, such as name, email address, and phone number. This holds true even when these records have incomplete or conflicting identifiers. For example, AWS Entity Resolution can effectively match a source record from a customer relationship management (CRM) system, which includes account information like first name, last name, postal address, phone number, and email address, with a source record from a marketing system containing campaign information, such as username and email address.

To learn more about AWS Entity Resolution concepts, procedures, and best practices, see the AWS Entity Resolution User Guide.

' x-logo: url: 'https://twitter.com/awscloud/profile_image?size=original' backgroundColor: '#FFFFFF' termsOfService: 'https://aws.amazon.com/service-terms/' contact: name: Mike Ralphson email: mike.ralphson@gmail.com url: 'https://github.com/mermade/aws2openapi' x-twitter: PermittedSoc license: name: Apache 2.0 License url: 'http://www.apache.org/licenses/' x-providerName: amazonaws.com x-serviceName: entityresolution x-aws-signingName: entityresolution x-origin: - contentType: application/json url: 'https://raw.githubusercontent.com/aws/aws-sdk-js/master/apis/entityresolution-2018-05-10.normal.json' converter: url: 'https://github.com/mermade/aws2openapi' version: 1.0.0 x-apisguru-driver: external x-apiClientRegistration: url: 'https://portal.aws.amazon.com/gp/aws/developer/registration/index.html?nc2=h_ct' x-apisguru-categories: - cloud x-preferred: true externalDocs: description: Amazon Web Services documentation url: 'https://docs.aws.amazon.com/entityresolution/' servers: - url: 'http://entityresolution.{region}.amazonaws.com' variables: region: description: The AWS region enum: - us-east-1 - us-east-2 - us-west-1 - us-west-2 - us-gov-west-1 - us-gov-east-1 - ca-central-1 - eu-north-1 - eu-west-1 - eu-west-2 - eu-west-3 - eu-central-1 - eu-south-1 - af-south-1 - ap-northeast-1 - ap-northeast-2 - ap-northeast-3 - ap-southeast-1 - ap-southeast-2 - ap-east-1 - ap-south-1 - sa-east-1 - me-south-1 default: us-east-1 description: The AWSEntityResolution multi-region endpoint - url: 'https://entityresolution.{region}.amazonaws.com' variables: region: description: The AWS region enum: - us-east-1 - us-east-2 - us-west-1 - us-west-2 - us-gov-west-1 - us-gov-east-1 - ca-central-1 - eu-north-1 - eu-west-1 - eu-west-2 - eu-west-3 - eu-central-1 - eu-south-1 - af-south-1 - ap-northeast-1 - ap-northeast-2 - ap-northeast-3 - ap-southeast-1 - ap-southeast-2 - ap-east-1 - ap-south-1 - sa-east-1 - me-south-1 default: us-east-1 description: The AWSEntityResolution multi-region endpoint - url: 'http://entityresolution.{region}.amazonaws.com.cn' variables: region: description: The AWS region enum: - cn-north-1 - cn-northwest-1 default: cn-north-1 description: The AWSEntityResolution endpoint for China (Beijing) and China (Ningxia) - url: 'https://entityresolution.{region}.amazonaws.com.cn' variables: region: description: The AWS region enum: - cn-north-1 - cn-northwest-1 default: cn-north-1 description: The AWSEntityResolution endpoint for China (Beijing) and China (Ningxia) x-hasEquivalentPaths: true paths: /matchingworkflows: post: operationId: CreateMatchingWorkflow description: 'Creates a MatchingWorkflow object which stores the configuration of the data processing job to be run. It is important to note that there should not be a pre-existing MatchingWorkflow with the same name. To modify an existing workflow, utilize the UpdateMatchingWorkflow API.' responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/CreateMatchingWorkflowOutput' examples: CreateMatchingWorkflow200Example: summary: Default CreateMatchingWorkflow 200 response x-microcks-default: true value: description: Example description incrementalRunConfig: example inputSourceConfig: example outputSourceConfig: example resolutionTechniques: example '480': description: ThrottlingException content: application/json: schema: $ref: '#/components/schemas/ThrottlingException' examples: CreateMatchingWorkflow480Example: summary: Default CreateMatchingWorkflow 480 response x-microcks-default: true value: {} '481': description: InternalServerException content: application/json: schema: $ref: '#/components/schemas/InternalServerException' examples: CreateMatchingWorkflow481Example: summary: Default CreateMatchingWorkflow 481 response x-microcks-default: true value: {} '482': description: AccessDeniedException content: application/json: schema: $ref: '#/components/schemas/AccessDeniedException' examples: CreateMatchingWorkflow482Example: summary: Default CreateMatchingWorkflow 482 response x-microcks-default: true value: {} '483': description: ExceedsLimitException content: application/json: schema: $ref: '#/components/schemas/ExceedsLimitException' examples: CreateMatchingWorkflow483Example: summary: Default CreateMatchingWorkflow 483 response x-microcks-default: true value: {} '484': description: ConflictException content: application/json: schema: $ref: '#/components/schemas/ConflictException' examples: CreateMatchingWorkflow484Example: summary: Default CreateMatchingWorkflow 484 response x-microcks-default: true value: {} '485': description: ValidationException content: application/json: schema: $ref: '#/components/schemas/ValidationException' examples: CreateMatchingWorkflow485Example: summary: Default CreateMatchingWorkflow 485 response x-microcks-default: true value: {} parameters: [] requestBody: required: true content: application/json: schema: type: object required: - inputSourceConfig - outputSourceConfig - resolutionTechniques - roleArn - workflowName properties: description: description: A description of the workflow. type: string minLength: 0 maxLength: 255 incrementalRunConfig: description: An object which defines an incremental run type and has only incrementalRunType as a field. type: object properties: incrementalRunType: allOf: - $ref: '#/components/schemas/IncrementalRunType' - description: 'The type of incremental run. It takes only one value: IMMEDIATE.' inputSourceConfig: description: 'A list of InputSource objects, which have the fields InputSourceARN and SchemaName.' type: array items: $ref: '#/components/schemas/InputSource' minItems: 1 maxItems: 20 outputSourceConfig: description: 'A list of OutputSource objects, each of which contains fields OutputS3Path, ApplyNormalization, and Output.' type: array items: $ref: '#/components/schemas/OutputSource' minItems: 1 maxItems: 1 resolutionTechniques: description: 'An object which defines the resolutionType and the ruleBasedProperties ' type: object properties: resolutionType: allOf: - $ref: '#/components/schemas/ResolutionType' - description: 'There are two types of matching, RULE_MATCHING and ML_MATCHING ' ruleBasedProperties: allOf: - $ref: '#/components/schemas/RuleBasedProperties' - description: 'An object which defines the list of matching rules to run and has a field Rules, which is a list of rule objects.' roleArn: description: The Amazon Resource Name (ARN) of the IAM role. AWS Entity Resolution assumes this role to create resources on your behalf as part of workflow execution. type: string tags: description: 'The tags used to organize, track, or control access for this resource.' type: object minProperties: 0 maxProperties: 200 additionalProperties: $ref: '#/components/schemas/TagValue' workflowName: description: The name of the workflow. There cannot be multiple DataIntegrationWorkflows with the same name. type: string pattern: '^[a-zA-Z_0-9-]*$' minLength: 0 maxLength: 255 examples: CreateMatchingWorkflowRequestExample: summary: Default CreateMatchingWorkflow request x-microcks-default: true value: description: Example description incrementalRunConfig: {} inputSourceConfig: [] outputSourceConfig: [] resolutionTechniques: {} summary: Amazon Entity Resolution CreateMatchingWorkflow x-microcks-operation: delay: 0 dispatcher: FALLBACK parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' get: operationId: ListMatchingWorkflows description: Returns a list of all the MatchingWorkflows that have been created for an AWS account. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/ListMatchingWorkflowsOutput' examples: ListMatchingWorkflows200Example: summary: Default ListMatchingWorkflows 200 response x-microcks-default: true value: nextToken: example workflowSummaries: example '480': description: ThrottlingException content: application/json: schema: $ref: '#/components/schemas/ThrottlingException' examples: ListMatchingWorkflows480Example: summary: Default ListMatchingWorkflows 480 response x-microcks-default: true value: {} '481': description: InternalServerException content: application/json: schema: $ref: '#/components/schemas/InternalServerException' examples: ListMatchingWorkflows481Example: summary: Default ListMatchingWorkflows 481 response x-microcks-default: true value: {} '482': description: AccessDeniedException content: application/json: schema: $ref: '#/components/schemas/AccessDeniedException' examples: ListMatchingWorkflows482Example: summary: Default ListMatchingWorkflows 482 response x-microcks-default: true value: {} '483': description: ValidationException content: application/json: schema: $ref: '#/components/schemas/ValidationException' examples: ListMatchingWorkflows483Example: summary: Default ListMatchingWorkflows 483 response x-microcks-default: true value: {} parameters: - name: maxResults in: query required: false description: The maximum number of objects returned per page. schema: type: integer maximum: 25 - name: nextToken in: query required: false description: The pagination token from the previous ListSchemaMappings API call. schema: type: string pattern: '^[a-zA-Z_0-9-=+/]*$' minLength: 1 maxLength: 1024 summary: Amazon Entity Resolution ListMatchingWorkflows x-microcks-operation: delay: 0 dispatcher: FALLBACK /schemas: post: operationId: CreateSchemaMapping description: '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.' responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/CreateSchemaMappingOutput' examples: CreateSchemaMapping200Example: summary: Default CreateSchemaMapping 200 response x-microcks-default: true value: description: Example description mappedInputFields: example schemaArn: arn:aws:service:us-east-1:123456789012:resource/example schemaName: example-name '480': description: ThrottlingException content: application/json: schema: $ref: '#/components/schemas/ThrottlingException' examples: CreateSchemaMapping480Example: summary: Default CreateSchemaMapping 480 response x-microcks-default: true value: {} '481': description: InternalServerException content: application/json: schema: $ref: '#/components/schemas/InternalServerException' examples: CreateSchemaMapping481Example: summary: Default CreateSchemaMapping 481 response x-microcks-default: true value: {} '482': description: AccessDeniedException content: application/json: schema: $ref: '#/components/schemas/AccessDeniedException' examples: CreateSchemaMapping482Example: summary: Default CreateSchemaMapping 482 response x-microcks-default: true value: {} '483': description: ExceedsLimitException content: application/json: schema: $ref: '#/components/schemas/ExceedsLimitException' examples: CreateSchemaMapping483Example: summary: Default CreateSchemaMapping 483 response x-microcks-default: true value: {} '484': description: ConflictException content: application/json: schema: $ref: '#/components/schemas/ConflictException' examples: CreateSchemaMapping484Example: summary: Default CreateSchemaMapping 484 response x-microcks-default: true value: {} '485': description: ValidationException content: application/json: schema: $ref: '#/components/schemas/ValidationException' examples: CreateSchemaMapping485Example: summary: Default CreateSchemaMapping 485 response x-microcks-default: true value: {} parameters: [] requestBody: required: true content: application/json: schema: type: object required: - schemaName properties: description: description: A description of the schema. type: string minLength: 0 maxLength: 255 mappedInputFields: description: 'A list of MappedInputFields. Each MappedInputField corresponds to a column the source data table, and contains column name plus additional information that Entity Resolution uses for matching.' type: array items: $ref: '#/components/schemas/SchemaInputAttribute' minItems: 2 maxItems: 25 schemaName: description: The name of the schema. There cannot be multiple SchemaMappings with the same name. type: string pattern: '^[a-zA-Z_0-9-]*$' minLength: 0 maxLength: 255 tags: description: 'The tags used to organize, track, or control access for this resource.' type: object minProperties: 0 maxProperties: 200 additionalProperties: $ref: '#/components/schemas/TagValue' examples: CreateSchemaMappingRequestExample: summary: Default CreateSchemaMapping request x-microcks-default: true value: description: Example description mappedInputFields: [] schemaName: example-name tags: {} summary: Amazon Entity Resolution CreateSchemaMapping x-microcks-operation: delay: 0 dispatcher: FALLBACK parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' get: operationId: ListSchemaMappings description: Returns a list of all the SchemaMappings that have been created for an AWS account. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/ListSchemaMappingsOutput' examples: ListSchemaMappings200Example: summary: Default ListSchemaMappings 200 response x-microcks-default: true value: nextToken: example schemaList: example '480': description: ThrottlingException content: application/json: schema: $ref: '#/components/schemas/ThrottlingException' examples: ListSchemaMappings480Example: summary: Default ListSchemaMappings 480 response x-microcks-default: true value: {} '481': description: InternalServerException content: application/json: schema: $ref: '#/components/schemas/InternalServerException' examples: ListSchemaMappings481Example: summary: Default ListSchemaMappings 481 response x-microcks-default: true value: {} '482': description: AccessDeniedException content: application/json: schema: $ref: '#/components/schemas/AccessDeniedException' examples: ListSchemaMappings482Example: summary: Default ListSchemaMappings 482 response x-microcks-default: true value: {} '483': description: ValidationException content: application/json: schema: $ref: '#/components/schemas/ValidationException' examples: ListSchemaMappings483Example: summary: Default ListSchemaMappings 483 response x-microcks-default: true value: {} parameters: - name: maxResults in: query required: false description: The maximum number of objects returned per page. schema: type: integer maximum: 25 - name: nextToken in: query required: false description: The pagination token from the previous ListSchemaMappings API call. schema: type: string pattern: '^[a-zA-Z_0-9-=+/]*$' minLength: 1 maxLength: 1024 summary: Amazon Entity Resolution ListSchemaMappings x-microcks-operation: delay: 0 dispatcher: FALLBACK '/matchingworkflows/{workflowName}': delete: operationId: DeleteMatchingWorkflow description: Deletes the MatchingWorkflow with a given name. This operation will succeed even if a workflow with the given name does not exist. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/DeleteMatchingWorkflowOutput' examples: DeleteMatchingWorkflow200Example: summary: Default DeleteMatchingWorkflow 200 response x-microcks-default: true value: message: example '480': description: ThrottlingException content: application/json: schema: $ref: '#/components/schemas/ThrottlingException' examples: DeleteMatchingWorkflow480Example: summary: Default DeleteMatchingWorkflow 480 response x-microcks-default: true value: {} '481': description: InternalServerException content: application/json: schema: $ref: '#/components/schemas/InternalServerException' examples: DeleteMatchingWorkflow481Example: summary: Default DeleteMatchingWorkflow 481 response x-microcks-default: true value: {} '482': description: AccessDeniedException content: application/json: schema: $ref: '#/components/schemas/AccessDeniedException' examples: DeleteMatchingWorkflow482Example: summary: Default DeleteMatchingWorkflow 482 response x-microcks-default: true value: {} '483': description: ValidationException content: application/json: schema: $ref: '#/components/schemas/ValidationException' examples: DeleteMatchingWorkflow483Example: summary: Default DeleteMatchingWorkflow 483 response x-microcks-default: true value: {} parameters: - name: workflowName in: path required: true description: The name of the workflow to be retrieved. schema: type: string pattern: '^[a-zA-Z_0-9-]*$' minLength: 0 maxLength: 255 summary: Amazon Entity Resolution DeleteMatchingWorkflow x-microcks-operation: delay: 0 dispatcher: FALLBACK parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' get: operationId: GetMatchingWorkflow description: 'Returns the MatchingWorkflow with a given name, if it exists.' responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/GetMatchingWorkflowOutput' examples: GetMatchingWorkflow200Example: summary: Default GetMatchingWorkflow 200 response x-microcks-default: true value: createdAt: example description: Example description incrementalRunConfig: example inputSourceConfig: example outputSourceConfig: example '480': description: ThrottlingException content: application/json: schema: $ref: '#/components/schemas/ThrottlingException' examples: GetMatchingWorkflow480Example: summary: Default GetMatchingWorkflow 480 response x-microcks-default: true value: {} '481': description: InternalServerException content: application/json: schema: $ref: '#/components/schemas/InternalServerException' examples: GetMatchingWorkflow481Example: summary: Default GetMatchingWorkflow 481 response x-microcks-default: true value: {} '482': description: ResourceNotFoundException content: application/json: schema: $ref: '#/components/schemas/ResourceNotFoundException' examples: GetMatchingWorkflow482Example: summary: Default GetMatchingWorkflow 482 response x-microcks-default: true value: {} '483': description: AccessDeniedException content: application/json: schema: $ref: '#/components/schemas/AccessDeniedException' examples: GetMatchingWorkflow483Example: summary: Default GetMatchingWorkflow 483 response x-microcks-default: true value: {} '484': description: ValidationException content: application/json: schema: $ref: '#/components/schemas/ValidationException' examples: GetMatchingWorkflow484Example: summary: Default GetMatchingWorkflow 484 response x-microcks-default: true value: {} parameters: - name: workflowName in: path required: true description: The name of the workflow. schema: type: string pattern: '^[a-zA-Z_0-9-]*$' minLength: 0 maxLength: 255 summary: Amazon Entity Resolution GetMatchingWorkflow x-microcks-operation: delay: 0 dispatcher: FALLBACK put: operationId: UpdateMatchingWorkflow description: 'Updates an existing MatchingWorkflow. This method is identical to CreateMatchingWorkflow, except it uses an HTTP PUT request instead of a POST request, and the MatchingWorkflow must already exist for the method to succeed.' responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/UpdateMatchingWorkflowOutput' examples: UpdateMatchingWorkflow200Example: summary: Default UpdateMatchingWorkflow 200 response x-microcks-default: true value: description: Example description incrementalRunConfig: example inputSourceConfig: example outputSourceConfig: example resolutionTechniques: example '480': description: ThrottlingException content: application/json: schema: $ref: '#/components/schemas/ThrottlingException' examples: UpdateMatchingWorkflow480Example: summary: Default UpdateMatchingWorkflow 480 response x-microcks-default: true value: {} '481': description: InternalServerException content: application/json: schema: $ref: '#/components/schemas/InternalServerException' examples: UpdateMatchingWorkflow481Example: summary: Default UpdateMatchingWorkflow 481 response x-microcks-default: true value: {} '482': description: ResourceNotFoundException content: application/json: schema: $ref: '#/components/schemas/ResourceNotFoundException' examples: UpdateMatchingWorkflow482Example: summary: Default UpdateMatchingWorkflow 482 response x-microcks-default: true value: {} '483': description: AccessDeniedException content: application/json: schema: $ref: '#/components/schemas/AccessDeniedException' examples: UpdateMatchingWorkflow483Example: summary: Default UpdateMatchingWorkflow 483 response x-microcks-default: true value: {} '484': description: ValidationException content: application/json: schema: $ref: '#/components/schemas/ValidationException' examples: UpdateMatchingWorkflow484Example: summary: Default UpdateMatchingWorkflow 484 response x-microcks-default: true value: {} parameters: - name: workflowName in: path required: true description: The name of the workflow to be retrieved. schema: type: string pattern: '^[a-zA-Z_0-9-]*$' minLength: 0 maxLength: 255 requestBody: required: true content: application/json: schema: type: object required: - inputSourceConfig - outputSourceConfig - resolutionTechniques - roleArn properties: description: description: A description of the workflow. type: string minLength: 0 maxLength: 255 incrementalRunConfig: description: An object which defines an incremental run type and has only incrementalRunType as a field. type: object properties: incrementalRunType: allOf: - $ref: '#/components/schemas/IncrementalRunType' - description: 'The type of incremental run. It takes only one value: IMMEDIATE.' inputSourceConfig: description: 'A list of InputSource objects, which have the fields InputSourceARN and SchemaName.' type: array items: $ref: '#/components/schemas/InputSource' minItems: 1 maxItems: 20 outputSourceConfig: description: 'A list of OutputSource objects, each of which contains fields OutputS3Path, ApplyNormalization, and Output.' type: array items: $ref: '#/components/schemas/OutputSource' minItems: 1 maxItems: 1 resolutionTechniques: description: 'An object which defines the resolutionType and the ruleBasedProperties ' type: object properties: resolutionType: allOf: - $ref: '#/components/schemas/ResolutionType' - description: 'There are two types of matching, RULE_MATCHING and ML_MATCHING ' ruleBasedProperties: allOf: - $ref: '#/components/schemas/RuleBasedProperties' - description: 'An object which defines the list of matching rules to run and has a field Rules, which is a list of rule objects.' roleArn: description: The Amazon Resource Name (ARN) of the IAM role. AWS Entity Resolution assumes this role to create resources on your behalf as part of workflow execution. type: string examples: UpdateMatchingWorkflowRequestExample: summary: Default UpdateMatchingWorkflow request x-microcks-default: true value: description: Example description incrementalRunConfig: {} inputSourceConfig: [] outputSourceConfig: [] resolutionTechniques: {} summary: Amazon Entity Resolution UpdateMatchingWorkflow x-microcks-operation: delay: 0 dispatcher: FALLBACK '/schemas/{schemaName}': delete: operationId: DeleteSchemaMapping description: 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 DataIntegrationWorkflow object that references the SchemaMapping in the workflow's InputSourceConfig. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/DeleteSchemaMappingOutput' examples: DeleteSchemaMapping200Example: summary: Default DeleteSchemaMapping 200 response x-microcks-default: true value: message: example '480': description: ThrottlingException content: application/json: schema: $ref: '#/components/schemas/ThrottlingException' examples: DeleteSchemaMapping480Example: summary: Default DeleteSchemaMapping 480 response x-microcks-default: true value: {} '481': description: InternalServerException content: application/json: schema: $ref: '#/components/schemas/InternalServerException' examples: DeleteSchemaMapping481Example: summary: Default DeleteSchemaMapping 481 response x-microcks-default: true value: {} '482': description: AccessDeniedException content: application/json: schema: $ref: '#/components/schemas/AccessDeniedException' examples: DeleteSchemaMapping482Example: summary: Default DeleteSchemaMapping 482 response x-microcks-default: true value: {} '483': description: ConflictException content: application/json: schema: $ref: '#/components/schemas/ConflictException' examples: DeleteSchemaMapping483Example: summary: Default DeleteSchemaMapping 483 response x-microcks-default: true value: {} '484': description: ValidationException content: application/json: schema: $ref: '#/components/schemas/ValidationException' examples: DeleteSchemaMapping484Example: summary: Default DeleteSchemaMapping 484 response x-microcks-default: true value: {} parameters: - name: schemaName in: path required: true description: The name of the schema to delete. schema: type: string pattern: '^[a-zA-Z_0-9-]*$' minLength: 0 maxLength: 255 summary: Amazon Entity Resolution DeleteSchemaMapping x-microcks-operation: delay: 0 dispatcher: FALLBACK parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' get: operationId: GetSchemaMapping description: Returns the SchemaMapping of a given name. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/GetSchemaMappingOutput' examples: GetSchemaMapping200Example: summary: Default GetSchemaMapping 200 response x-microcks-default: true value: createdAt: example description: Example description mappedInputFields: example schemaArn: arn:aws:service:us-east-1:123456789012:resource/example schemaName: example-name '480': description: ThrottlingException content: application/json: schema: $ref: '#/components/schemas/ThrottlingException' examples: GetSchemaMapping480Example: summary: Default GetSchemaMapping 480 response x-microcks-default: true value: {} '481': description: InternalServerException content: application/json: schema: $ref: '#/components/schemas/InternalServerException' examples: GetSchemaMapping481Example: summary: Default GetSchemaMapping 481 response x-microcks-default: true value: {} '482': description: ResourceNotFoundException content: application/json: schema: $ref: '#/components/schemas/ResourceNotFoundException' examples: GetSchemaMapping482Example: summary: Default GetSchemaMapping 482 response x-microcks-default: true value: {} '483': description: AccessDeniedException content: application/json: schema: $ref: '#/components/schemas/AccessDeniedException' examples: GetSchemaMapping483Example: summary: Default GetSchemaMapping 483 response x-microcks-default: true value: {} '484': description: ValidationException content: application/json: schema: $ref: '#/components/schemas/ValidationException' examples: GetSchemaMapping484Example: summary: Default GetSchemaMapping 484 response x-microcks-default: true value: {} parameters: - name: schemaName in: path required: true description: The name of the schema to be retrieved. schema: type: string pattern: '^[a-zA-Z_0-9-]*$' minLength: 0 maxLength: 255 summary: Amazon Entity Resolution GetSchemaMapping x-microcks-operation: delay: 0 dispatcher: FALLBACK '/matchingworkflows/{workflowName}/matches': post: operationId: GetMatchId description: Returns the corresponding Match ID of a customer record if the record has been processed. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/GetMatchIdOutput' examples: GetMatchId200Example: summary: Default GetMatchId 200 response x-microcks-default: true value: matchId: example-id-12345 '480': description: ThrottlingException content: application/json: schema: $ref: '#/components/schemas/ThrottlingException' examples: GetMatchId480Example: summary: Default GetMatchId 480 response x-microcks-default: true value: {} '481': description: InternalServerException content: application/json: schema: $ref: '#/components/schemas/InternalServerException' examples: GetMatchId481Example: summary: Default GetMatchId 481 response x-microcks-default: true value: {} '482': description: ResourceNotFoundException content: application/json: schema: $ref: '#/components/schemas/ResourceNotFoundException' examples: GetMatchId482Example: summary: Default GetMatchId 482 response x-microcks-default: true value: {} '483': description: AccessDeniedException content: application/json: schema: $ref: '#/components/schemas/AccessDeniedException' examples: GetMatchId483Example: summary: Default GetMatchId 483 response x-microcks-default: true value: {} '484': description: ValidationException content: application/json: schema: $ref: '#/components/schemas/ValidationException' examples: GetMatchId484Example: summary: Default GetMatchId 484 response x-microcks-default: true value: {} parameters: - name: workflowName in: path required: true description: The name of the workflow. schema: type: string pattern: '^[a-zA-Z_0-9-]*$' minLength: 0 maxLength: 255 requestBody: required: true content: application/json: schema: type: object required: - record properties: record: description: The record to fetch the Match ID for. type: object additionalProperties: $ref: '#/components/schemas/RecordAttributeMapValueString' examples: GetMatchIdRequestExample: summary: Default GetMatchId request x-microcks-default: true value: record: {} summary: Amazon Entity Resolution GetMatchId x-microcks-operation: delay: 0 dispatcher: FALLBACK parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' '/matchingworkflows/{workflowName}/jobs/{jobId}': get: operationId: GetMatchingJob description: 'Gets the status, metrics, and errors (if there are any) that are associated with a job.' responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/GetMatchingJobOutput' examples: GetMatchingJob200Example: summary: Default GetMatchingJob 200 response x-microcks-default: true value: endTime: '2025-01-15T00:00:00Z' errorDetails: example jobId: example-id-12345 metrics: example startTime: '2025-01-15T00:00:00Z' '480': description: ThrottlingException content: application/json: schema: $ref: '#/components/schemas/ThrottlingException' examples: GetMatchingJob480Example: summary: Default GetMatchingJob 480 response x-microcks-default: true value: {} '481': description: InternalServerException content: application/json: schema: $ref: '#/components/schemas/InternalServerException' examples: GetMatchingJob481Example: summary: Default GetMatchingJob 481 response x-microcks-default: true value: {} '482': description: ResourceNotFoundException content: application/json: schema: $ref: '#/components/schemas/ResourceNotFoundException' examples: GetMatchingJob482Example: summary: Default GetMatchingJob 482 response x-microcks-default: true value: {} '483': description: AccessDeniedException content: application/json: schema: $ref: '#/components/schemas/AccessDeniedException' examples: GetMatchingJob483Example: summary: Default GetMatchingJob 483 response x-microcks-default: true value: {} '484': description: ValidationException content: application/json: schema: $ref: '#/components/schemas/ValidationException' examples: GetMatchingJob484Example: summary: Default GetMatchingJob 484 response x-microcks-default: true value: {} parameters: - name: jobId in: path required: true description: The ID of the job. schema: type: string pattern: '^[a-f0-9]{32}$' - name: workflowName in: path required: true description: The name of the workflow. schema: type: string pattern: '^[a-zA-Z_0-9-]*$' minLength: 0 maxLength: 255 summary: Amazon Entity Resolution GetMatchingJob x-microcks-operation: delay: 0 dispatcher: FALLBACK parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' '/matchingworkflows/{workflowName}/jobs': get: operationId: ListMatchingJobs description: Lists all jobs for a given workflow. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/ListMatchingJobsOutput' examples: ListMatchingJobs200Example: summary: Default ListMatchingJobs 200 response x-microcks-default: true value: jobs: example nextToken: example '480': description: ThrottlingException content: application/json: schema: $ref: '#/components/schemas/ThrottlingException' examples: ListMatchingJobs480Example: summary: Default ListMatchingJobs 480 response x-microcks-default: true value: {} '481': description: InternalServerException content: application/json: schema: $ref: '#/components/schemas/InternalServerException' examples: ListMatchingJobs481Example: summary: Default ListMatchingJobs 481 response x-microcks-default: true value: {} '482': description: ResourceNotFoundException content: application/json: schema: $ref: '#/components/schemas/ResourceNotFoundException' examples: ListMatchingJobs482Example: summary: Default ListMatchingJobs 482 response x-microcks-default: true value: {} '483': description: AccessDeniedException content: application/json: schema: $ref: '#/components/schemas/AccessDeniedException' examples: ListMatchingJobs483Example: summary: Default ListMatchingJobs 483 response x-microcks-default: true value: {} '484': description: ValidationException content: application/json: schema: $ref: '#/components/schemas/ValidationException' examples: ListMatchingJobs484Example: summary: Default ListMatchingJobs 484 response x-microcks-default: true value: {} parameters: - name: maxResults in: query required: false description: The maximum number of objects returned per page. schema: type: integer minimum: 1 maximum: 25 - name: nextToken in: query required: false description: The pagination token from the previous ListSchemaMappings API call. schema: type: string pattern: '^[a-zA-Z_0-9-=+/]*$' minLength: 1 maxLength: 1024 - name: workflowName in: path required: true description: The name of the workflow to be retrieved. schema: type: string pattern: '^[a-zA-Z_0-9-]*$' minLength: 0 maxLength: 255 summary: Amazon Entity Resolution ListMatchingJobs x-microcks-operation: delay: 0 dispatcher: FALLBACK parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' post: operationId: StartMatchingJob description: Starts the MatchingJob of a workflow. The workflow must have previously been created using the CreateMatchingWorkflow endpoint. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/StartMatchingJobOutput' examples: StartMatchingJob200Example: summary: Default StartMatchingJob 200 response x-microcks-default: true value: jobId: example-id-12345 '480': description: ThrottlingException content: application/json: schema: $ref: '#/components/schemas/ThrottlingException' examples: StartMatchingJob480Example: summary: Default StartMatchingJob 480 response x-microcks-default: true value: {} '481': description: InternalServerException content: application/json: schema: $ref: '#/components/schemas/InternalServerException' examples: StartMatchingJob481Example: summary: Default StartMatchingJob 481 response x-microcks-default: true value: {} '482': description: ResourceNotFoundException content: application/json: schema: $ref: '#/components/schemas/ResourceNotFoundException' examples: StartMatchingJob482Example: summary: Default StartMatchingJob 482 response x-microcks-default: true value: {} '483': description: AccessDeniedException content: application/json: schema: $ref: '#/components/schemas/AccessDeniedException' examples: StartMatchingJob483Example: summary: Default StartMatchingJob 483 response x-microcks-default: true value: {} '484': description: ExceedsLimitException content: application/json: schema: $ref: '#/components/schemas/ExceedsLimitException' examples: StartMatchingJob484Example: summary: Default StartMatchingJob 484 response x-microcks-default: true value: {} '485': description: ConflictException content: application/json: schema: $ref: '#/components/schemas/ConflictException' examples: StartMatchingJob485Example: summary: Default StartMatchingJob 485 response x-microcks-default: true value: {} '486': description: ValidationException content: application/json: schema: $ref: '#/components/schemas/ValidationException' examples: StartMatchingJob486Example: summary: Default StartMatchingJob 486 response x-microcks-default: true value: {} parameters: - name: workflowName in: path required: true description: The name of the matching job to be retrieved. schema: type: string pattern: '^[a-zA-Z_0-9-]*$' minLength: 0 maxLength: 255 summary: Amazon Entity Resolution StartMatchingJob x-microcks-operation: delay: 0 dispatcher: FALLBACK '/tags/{resourceArn}': get: operationId: ListTagsForResource description: 'Displays the tags associated with an AWS Entity Resolution resource. In Entity Resolution, SchemaMapping, and MatchingWorkflow can be tagged.' responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/ListTagsForResourceOutput' examples: ListTagsForResource200Example: summary: Default ListTagsForResource 200 response x-microcks-default: true value: tags: example '480': description: InternalServerException content: application/json: schema: $ref: '#/components/schemas/InternalServerException' examples: ListTagsForResource480Example: summary: Default ListTagsForResource 480 response x-microcks-default: true value: {} '481': description: ResourceNotFoundException content: application/json: schema: $ref: '#/components/schemas/ResourceNotFoundException' examples: ListTagsForResource481Example: summary: Default ListTagsForResource 481 response x-microcks-default: true value: {} '482': description: ValidationException content: application/json: schema: $ref: '#/components/schemas/ValidationException' examples: ListTagsForResource482Example: summary: Default ListTagsForResource 482 response x-microcks-default: true value: {} parameters: - name: resourceArn in: path required: true description: The ARN of the resource for which you want to view tags. schema: type: string pattern: '^arn:(aws|aws-us-gov|aws-cn):(entityresolution):.*:[0-9]+:((schemamapping|matchingworkflow)/[a-zA-Z0-9_-]+)$' summary: Amazon Entity Resolution ListTagsForResource x-microcks-operation: delay: 0 dispatcher: FALLBACK parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' post: operationId: TagResource description: 'Assigns one or more tags (key-value pairs) to the specified AWS 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 AWS 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.' responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/TagResourceOutput' examples: TagResource200Example: summary: Default TagResource 200 response x-microcks-default: true value: {} '480': description: InternalServerException content: application/json: schema: $ref: '#/components/schemas/InternalServerException' examples: TagResource480Example: summary: Default TagResource 480 response x-microcks-default: true value: {} '481': description: ResourceNotFoundException content: application/json: schema: $ref: '#/components/schemas/ResourceNotFoundException' examples: TagResource481Example: summary: Default TagResource 481 response x-microcks-default: true value: {} '482': description: ValidationException content: application/json: schema: $ref: '#/components/schemas/ValidationException' examples: TagResource482Example: summary: Default TagResource 482 response x-microcks-default: true value: {} parameters: - name: resourceArn in: path required: true description: The ARN of the resource for which you want to view tags. schema: type: string pattern: '^arn:(aws|aws-us-gov|aws-cn):(entityresolution):.*:[0-9]+:((schemamapping|matchingworkflow)/[a-zA-Z0-9_-]+)$' requestBody: required: true content: application/json: schema: type: object required: - tags properties: tags: description: 'The tags used to organize, track, or control access for this resource.' type: object minProperties: 0 maxProperties: 200 additionalProperties: $ref: '#/components/schemas/TagValue' examples: TagResourceRequestExample: summary: Default TagResource request x-microcks-default: true value: tags: {} summary: Amazon Entity Resolution TagResource x-microcks-operation: delay: 0 dispatcher: FALLBACK '/tags/{resourceArn}#tagKeys': delete: operationId: UntagResource description: 'Removes one or more tags from the specified AWS Entity Resolution resource. In Entity Resolution, SchemaMapping, and MatchingWorkflow can be tagged.' responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/UntagResourceOutput' examples: UntagResource200Example: summary: Default UntagResource 200 response x-microcks-default: true value: {} '480': description: InternalServerException content: application/json: schema: $ref: '#/components/schemas/InternalServerException' examples: UntagResource480Example: summary: Default UntagResource 480 response x-microcks-default: true value: {} '481': description: ResourceNotFoundException content: application/json: schema: $ref: '#/components/schemas/ResourceNotFoundException' examples: UntagResource481Example: summary: Default UntagResource 481 response x-microcks-default: true value: {} parameters: - name: resourceArn in: path required: true description: The ARN of the resource for which you want to untag. schema: type: string pattern: '^arn:(aws|aws-us-gov|aws-cn):(entityresolution):.*:[0-9]+:((schemamapping|matchingworkflow)/[a-zA-Z0-9_-]+)$' - name: tagKeys in: query required: true description: The list of tag keys to remove from the resource. schema: type: array items: $ref: '#/components/schemas/TagKey' minItems: 0 maxItems: 200 summary: Amazon Entity Resolution UntagResource x-microcks-operation: delay: 0 dispatcher: FALLBACK parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' components: parameters: X-Amz-Content-Sha256: name: X-Amz-Content-Sha256 in: header schema: type: string required: false X-Amz-Date: name: X-Amz-Date in: header schema: type: string required: false X-Amz-Algorithm: name: X-Amz-Algorithm in: header schema: type: string required: false X-Amz-Credential: name: X-Amz-Credential in: header schema: type: string required: false X-Amz-Security-Token: name: X-Amz-Security-Token in: header schema: type: string required: false X-Amz-Signature: name: X-Amz-Signature in: header schema: type: string required: false X-Amz-SignedHeaders: name: X-Amz-SignedHeaders in: header schema: type: string required: false securitySchemes: hmac: type: apiKey name: Authorization in: header description: Amazon Signature authorization v4 x-amazon-apigateway-authtype: awsSigv4 schemas: CreateMatchingWorkflowOutput: type: object required: - inputSourceConfig - outputSourceConfig - resolutionTechniques - roleArn - workflowArn - workflowName properties: description: allOf: - $ref: '#/components/schemas/Description' - description: A description of the workflow. incrementalRunConfig: allOf: - $ref: '#/components/schemas/IncrementalRunConfig' - description: An object which defines an incremental run type and has only incrementalRunType as a field. inputSourceConfig: allOf: - $ref: '#/components/schemas/InputSourceConfig' - description: 'A list of InputSource objects, which have the fields InputSourceARN and SchemaName.' outputSourceConfig: allOf: - $ref: '#/components/schemas/OutputSourceConfig' - description: 'A list of OutputSource objects, each of which contains fields OutputS3Path, ApplyNormalization, and Output.' resolutionTechniques: allOf: - $ref: '#/components/schemas/ResolutionTechniques' - description: 'An object which defines the resolutionType and the ruleBasedProperties ' roleArn: allOf: - $ref: '#/components/schemas/String' - description: The Amazon Resource Name (ARN) of the IAM role. AWS Entity Resolution assumes this role to create resources on your behalf as part of workflow execution. workflowArn: allOf: - $ref: '#/components/schemas/MatchingWorkflowArn' - description: The ARN (Amazon Resource Name) that Entity Resolution generated for the MatchingWorkflow. workflowName: allOf: - $ref: '#/components/schemas/EntityName' - description: The name of the workflow. IncrementalRunType: type: string enum: - IMMEDIATE InputSource: type: object required: - inputSourceARN - schemaName properties: applyNormalization: allOf: - $ref: '#/components/schemas/Boolean' - description: '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.' inputSourceARN: allOf: - $ref: '#/components/schemas/InputSourceInputSourceARNString' - description: An Glue table ARN for the input source table. schemaName: allOf: - $ref: '#/components/schemas/EntityName' - description: The name of the schema to be retrieved. description: 'An object containing InputSourceARN, SchemaName, and ApplyNormalization.' OutputSource: type: object required: - output - outputS3Path properties: KMSArn: allOf: - $ref: '#/components/schemas/KMSArn' - description: 'Customer KMS ARN for encryption at rest. If not provided, system will use an Entity Resolution managed KMS key.' applyNormalization: allOf: - $ref: '#/components/schemas/Boolean' - description: '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.' output: allOf: - $ref: '#/components/schemas/OutputSourceOutputList' - description: '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.' outputS3Path: allOf: - $ref: '#/components/schemas/OutputSourceOutputS3PathString' - description: The S3 path to which Entity Resolution will write the output table. description: '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.' ResolutionType: type: string enum: - RULE_MATCHING - ML_MATCHING RuleBasedProperties: type: object required: - attributeMatchingModel - rules properties: attributeMatchingModel: allOf: - $ref: '#/components/schemas/AttributeMatchingModel' - description: 'You can either choose ONE_TO_ONE or MANY_TO_MANY as the AttributeMatchingModel. When choosing MANY_TO_MANY, the system can match attribute 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 type. When choosing ONE_TO_ONE the system can only match if the sub-types are exact matches. For example, only when the value of the Email field of Profile A and the value of the Email field of Profile B matches, the two profiles are matched on the Email type.' rules: allOf: - $ref: '#/components/schemas/RuleBasedPropertiesRulesList' - description: 'A list of Rule objects, each of which have fields RuleName and MatchingKeys.' description: 'An object which defines the list of matching rules to run and has a field Rules, which is a list of rule objects.' TagValue: type: string minLength: 0 maxLength: 256 ThrottlingException: {} InternalServerException: {} AccessDeniedException: {} ExceedsLimitException: {} ConflictException: {} ValidationException: {} CreateSchemaMappingOutput: type: object required: - description - mappedInputFields - schemaArn - schemaName properties: description: allOf: - $ref: '#/components/schemas/Description' - description: A description of the schema. mappedInputFields: allOf: - $ref: '#/components/schemas/SchemaInputAttributes' - description: 'A list of MappedInputFields. Each MappedInputField corresponds to a column the source data table, and contains column name plus additional information that Entity Resolution uses for matching.' schemaArn: allOf: - $ref: '#/components/schemas/SchemaMappingArn' - description: The ARN (Amazon Resource Name) that Entity Resolution generated for the SchemaMapping. schemaName: allOf: - $ref: '#/components/schemas/EntityName' - description: The name of the schema. SchemaInputAttribute: type: object required: - fieldName - type properties: fieldName: allOf: - $ref: '#/components/schemas/AttributeName' - description: A string containing the field name. groupName: allOf: - $ref: '#/components/schemas/AttributeName' - description: 'Instruct Entity Resolution to combine several columns into a unified column with the identical attribute type. For example, when working with columns such as first_name, middle_name, and last_name, assigning them a common GroupName will prompt Entity Resolution to concatenate them into a single value.' matchKey: allOf: - $ref: '#/components/schemas/AttributeName' - description: 'A key that allows grouping of multiple input attributes into a unified matching group. For example, let''s consider a scenario where the source table contains various addresses, such as business_address and shipping_address. By assigning the MatchKey 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.' type: allOf: - $ref: '#/components/schemas/SchemaAttributeType' - description: 'The type of the attribute, selected from a list of values.' description: 'An object containing FieldField, Type, GroupName, and MatchKey.' DeleteMatchingWorkflowOutput: type: object required: - message properties: message: allOf: - $ref: '#/components/schemas/String' - description: A successful operation message. DeleteSchemaMappingOutput: type: object required: - message properties: message: allOf: - $ref: '#/components/schemas/String' - description: A successful operation message. GetMatchIdOutput: type: object properties: matchId: allOf: - $ref: '#/components/schemas/String' - description: The unique identifiers for this group of match records. RecordAttributeMapValueString: type: string pattern: '^[a-zA-Z_0-9-.@ ()+\t]*$' minLength: 0 maxLength: 255 ResourceNotFoundException: {} GetMatchingJobOutput: type: object required: - jobId - startTime - status properties: endTime: allOf: - $ref: '#/components/schemas/Timestamp' - description: The time at which the job has finished. errorDetails: allOf: - $ref: '#/components/schemas/ErrorDetails' - description: 'An object containing an error message, if there was an error.' jobId: allOf: - $ref: '#/components/schemas/JobId' - description: The ID of the job. metrics: allOf: - $ref: '#/components/schemas/JobMetrics' - description: 'Metrics associated with the execution, specifically total records processed, unique IDs generated, and records the execution skipped.' startTime: allOf: - $ref: '#/components/schemas/Timestamp' - description: The time at which the job was started. status: allOf: - $ref: '#/components/schemas/JobStatus' - description: 'The current status of the job. Either running, succeeded, queued, or failed.' GetMatchingWorkflowOutput: type: object required: - createdAt - inputSourceConfig - outputSourceConfig - resolutionTechniques - roleArn - updatedAt - workflowArn - workflowName properties: createdAt: allOf: - $ref: '#/components/schemas/Timestamp' - description: The timestamp of when the workflow was created. description: allOf: - $ref: '#/components/schemas/Description' - description: A description of the workflow. incrementalRunConfig: allOf: - $ref: '#/components/schemas/IncrementalRunConfig' - description: An object which defines an incremental run type and has only incrementalRunType as a field. inputSourceConfig: allOf: - $ref: '#/components/schemas/InputSourceConfig' - description: 'A list of InputSource objects, which have the fields InputSourceARN and SchemaName.' outputSourceConfig: allOf: - $ref: '#/components/schemas/OutputSourceConfig' - description: 'A list of OutputSource objects, each of which contains fields OutputS3Path, ApplyNormalization, and Output.' resolutionTechniques: allOf: - $ref: '#/components/schemas/ResolutionTechniques' - description: 'An object which defines the resolutionType and the ruleBasedProperties ' roleArn: allOf: - $ref: '#/components/schemas/String' - description: The Amazon Resource Name (ARN) of the IAM role. AWS Entity Resolution assumes this role to access resources on your behalf. tags: allOf: - $ref: '#/components/schemas/TagMap' - description: 'The tags used to organize, track, or control access for this resource.' updatedAt: allOf: - $ref: '#/components/schemas/Timestamp' - description: The timestamp of when the workflow was last updated. workflowArn: allOf: - $ref: '#/components/schemas/MatchingWorkflowArn' - description: The ARN (Amazon Resource Name) that Entity Resolution generated for the MatchingWorkflow. workflowName: allOf: - $ref: '#/components/schemas/EntityName' - description: The name of the workflow. GetSchemaMappingOutput: type: object required: - createdAt - mappedInputFields - schemaArn - schemaName - updatedAt properties: createdAt: allOf: - $ref: '#/components/schemas/Timestamp' - description: The timestamp of when the SchemaMapping was created. description: allOf: - $ref: '#/components/schemas/Description' - description: A description of the schema. mappedInputFields: allOf: - $ref: '#/components/schemas/SchemaInputAttributes' - description: 'A list of MappedInputFields. Each MappedInputField corresponds to a column the source data table, and contains column name plus additional information Venice uses for matching.' schemaArn: allOf: - $ref: '#/components/schemas/SchemaMappingArn' - description: The ARN (Amazon Resource Name) that Entity Resolution generated for the SchemaMapping. schemaName: allOf: - $ref: '#/components/schemas/EntityName' - description: The name of the schema. tags: allOf: - $ref: '#/components/schemas/TagMap' - description: 'The tags used to organize, track, or control access for this resource.' updatedAt: allOf: - $ref: '#/components/schemas/Timestamp' - description: The timestamp of when the SchemaMapping was last updated. ListMatchingJobsOutput: type: object properties: jobs: allOf: - $ref: '#/components/schemas/JobList' - description: 'A list of JobSummary objects, each of which contain the ID, status, start time, and end time of a job.' nextToken: allOf: - $ref: '#/components/schemas/NextToken' - description: The pagination token from the previous ListSchemaMappings API call. ListMatchingWorkflowsOutput: type: object properties: nextToken: allOf: - $ref: '#/components/schemas/NextToken' - description: The pagination token from the previous ListSchemaMappings API call. workflowSummaries: allOf: - $ref: '#/components/schemas/MatchingWorkflowList' - description: 'A list of MatchingWorkflowSummary objects, each of which contain the fields WorkflowName, WorkflowArn, CreatedAt, and UpdatedAt.' ListSchemaMappingsOutput: type: object properties: nextToken: allOf: - $ref: '#/components/schemas/NextToken' - description: The pagination token from the previous ListDomains API call. schemaList: allOf: - $ref: '#/components/schemas/SchemaMappingList' - description: 'A list of SchemaMappingSummary objects, each of which contain the fields SchemaName, SchemaArn, CreatedAt, UpdatedAt.' ListTagsForResourceOutput: type: object required: - tags properties: tags: allOf: - $ref: '#/components/schemas/TagMap' - description: 'The tags used to organize, track, or control access for this resource.' StartMatchingJobOutput: type: object required: - jobId properties: jobId: allOf: - $ref: '#/components/schemas/JobId' - description: The ID of the job. TagResourceOutput: type: object properties: {} UntagResourceOutput: type: object properties: {} TagKey: type: string minLength: 1 maxLength: 128 UpdateMatchingWorkflowOutput: type: object required: - inputSourceConfig - outputSourceConfig - resolutionTechniques - roleArn - workflowName properties: description: allOf: - $ref: '#/components/schemas/Description' - description: A description of the workflow. incrementalRunConfig: allOf: - $ref: '#/components/schemas/IncrementalRunConfig' - description: An object which defines an incremental run type and has only incrementalRunType as a field. inputSourceConfig: allOf: - $ref: '#/components/schemas/InputSourceConfig' - description: 'A list of InputSource objects, which have the fields InputSourceARN and SchemaName.' outputSourceConfig: allOf: - $ref: '#/components/schemas/OutputSourceConfig' - description: 'A list of OutputSource objects, each of which contains fields OutputS3Path, ApplyNormalization, and Output.' resolutionTechniques: allOf: - $ref: '#/components/schemas/ResolutionTechniques' - description: 'An object which defines the resolutionType and the ruleBasedProperties ' roleArn: allOf: - $ref: '#/components/schemas/String' - description: The Amazon Resource Name (ARN) of the IAM role. AWS Entity Resolution assumes this role to create resources on your behalf as part of workflow execution. workflowName: allOf: - $ref: '#/components/schemas/EntityName' - description: The name of the workflow. AttributeMatchingModel: type: string enum: - ONE_TO_ONE - MANY_TO_MANY AttributeName: type: string pattern: '^[a-zA-Z_0-9- \t]*$' minLength: 0 maxLength: 255 Boolean: type: boolean Description: type: string minLength: 0 maxLength: 255 IncrementalRunConfig: type: object properties: incrementalRunType: allOf: - $ref: '#/components/schemas/IncrementalRunType' - description: 'The type of incremental run. It takes only one value: IMMEDIATE.' description: An object which defines an incremental run type and has only incrementalRunType as a field. InputSourceConfig: type: array items: $ref: '#/components/schemas/InputSource' minItems: 1 maxItems: 20 OutputSourceConfig: type: array items: $ref: '#/components/schemas/OutputSource' minItems: 1 maxItems: 1 ResolutionTechniques: type: object properties: resolutionType: allOf: - $ref: '#/components/schemas/ResolutionType' - description: 'There are two types of matching, RULE_MATCHING and ML_MATCHING ' ruleBasedProperties: allOf: - $ref: '#/components/schemas/RuleBasedProperties' - description: 'An object which defines the list of matching rules to run and has a field Rules, which is a list of rule objects.' description: 'An object which defines the resolutionType and the ruleBasedProperties ' String: type: string TagMap: type: object minProperties: 0 maxProperties: 200 additionalProperties: $ref: '#/components/schemas/TagValue' EntityName: type: string pattern: '^[a-zA-Z_0-9-]*$' minLength: 0 maxLength: 255 CreateMatchingWorkflowInput: type: object required: - inputSourceConfig - outputSourceConfig - resolutionTechniques - roleArn - workflowName title: CreateMatchingWorkflowInput properties: description: allOf: - $ref: '#/components/schemas/Description' - description: A description of the workflow. incrementalRunConfig: allOf: - $ref: '#/components/schemas/IncrementalRunConfig' - description: An object which defines an incremental run type and has only incrementalRunType as a field. inputSourceConfig: allOf: - $ref: '#/components/schemas/InputSourceConfig' - description: 'A list of InputSource objects, which have the fields InputSourceARN and SchemaName.' outputSourceConfig: allOf: - $ref: '#/components/schemas/OutputSourceConfig' - description: 'A list of OutputSource objects, each of which contains fields OutputS3Path, ApplyNormalization, and Output.' resolutionTechniques: allOf: - $ref: '#/components/schemas/ResolutionTechniques' - description: 'An object which defines the resolutionType and the ruleBasedProperties ' roleArn: allOf: - $ref: '#/components/schemas/String' - description: The Amazon Resource Name (ARN) of the IAM role. AWS Entity Resolution assumes this role to create resources on your behalf as part of workflow execution. tags: allOf: - $ref: '#/components/schemas/TagMap' - description: 'The tags used to organize, track, or control access for this resource.' workflowName: allOf: - $ref: '#/components/schemas/EntityName' - description: The name of the workflow. There cannot be multiple DataIntegrationWorkflows with the same name. MatchingWorkflowArn: type: string pattern: '^arn:(aws|aws-us-gov|aws-cn):entityresolution:.*:[0-9]+:(matchingworkflow/.*)$' SchemaInputAttributes: type: array items: $ref: '#/components/schemas/SchemaInputAttribute' minItems: 2 maxItems: 25 CreateSchemaMappingInput: type: object required: - schemaName title: CreateSchemaMappingInput properties: description: allOf: - $ref: '#/components/schemas/Description' - description: A description of the schema. mappedInputFields: allOf: - $ref: '#/components/schemas/SchemaInputAttributes' - description: 'A list of MappedInputFields. Each MappedInputField corresponds to a column the source data table, and contains column name plus additional information that Entity Resolution uses for matching.' schemaName: allOf: - $ref: '#/components/schemas/EntityName' - description: The name of the schema. There cannot be multiple SchemaMappings with the same name. tags: allOf: - $ref: '#/components/schemas/TagMap' - description: 'The tags used to organize, track, or control access for this resource.' SchemaMappingArn: type: string pattern: '^arn:(aws|aws-us-gov|aws-cn):entityresolution:.*:[0-9]+:(schemamapping/.*)$' DeleteMatchingWorkflowInput: type: object title: DeleteMatchingWorkflowInput properties: {} DeleteSchemaMappingInput: type: object title: DeleteSchemaMappingInput properties: {} ErrorMessage: type: string minLength: 1 maxLength: 2048 ErrorDetails: type: object properties: errorMessage: allOf: - $ref: '#/components/schemas/ErrorMessage' - description: 'The error message from the job, if there is one.' description: 'An object containing an error message, if there was an error.' RecordAttributeMap: type: object additionalProperties: $ref: '#/components/schemas/RecordAttributeMapValueString' GetMatchIdInput: type: object required: - record title: GetMatchIdInput properties: record: allOf: - $ref: '#/components/schemas/RecordAttributeMap' - description: The record to fetch the Match ID for. JobId: type: string pattern: '^[a-f0-9]{32}$' GetMatchingJobInput: type: object title: GetMatchingJobInput properties: {} Timestamp: type: string format: date-time JobMetrics: type: object properties: inputRecords: allOf: - $ref: '#/components/schemas/Integer' - description: The total number of input records. matchIDs: allOf: - $ref: '#/components/schemas/Integer' - description: The total number of matchIDs generated. recordsNotProcessed: allOf: - $ref: '#/components/schemas/Integer' - description: 'The total number of records that did not get processed,' totalRecordsProcessed: allOf: - $ref: '#/components/schemas/Integer' - description: The total number of records processed. description: 'An object containing InputRecords, TotalRecordsProcessed, MatchIDs, and RecordsNotProcessed.' JobStatus: type: string enum: - RUNNING - SUCCEEDED - FAILED - QUEUED GetMatchingWorkflowInput: type: object title: GetMatchingWorkflowInput properties: {} GetSchemaMappingInput: type: object title: GetSchemaMappingInput properties: {} InputSourceInputSourceARNString: type: string pattern: '^arn:aws:.*:.*:[0-9]+:.*$' Integer: type: integer JobSummary: type: object required: - jobId - startTime - status properties: endTime: allOf: - $ref: '#/components/schemas/Timestamp' - description: The time at which the job has finished. jobId: allOf: - $ref: '#/components/schemas/JobId' - description: The ID of the job. startTime: allOf: - $ref: '#/components/schemas/Timestamp' - description: The time at which the job was started. status: allOf: - $ref: '#/components/schemas/JobStatus' - description: 'The current status of the job. Either running, succeeded, queued, or failed.' description: 'An object containing the JobId, Status, StartTime, and EndTime of a job.' JobList: type: array items: $ref: '#/components/schemas/JobSummary' KMSArn: type: string pattern: '^arn:aws:kms:.*:[0-9]+:.*$' ListMatchingJobsInputMaxResultsInteger: type: integer minimum: 1 maximum: 25 NextToken: type: string pattern: '^[a-zA-Z_0-9-=+/]*$' minLength: 1 maxLength: 1024 ListMatchingJobsInput: type: object title: ListMatchingJobsInput properties: {} ListMatchingWorkflowsInputMaxResultsInteger: type: integer maximum: 25 ListMatchingWorkflowsInput: type: object title: ListMatchingWorkflowsInput properties: {} MatchingWorkflowList: type: array items: $ref: '#/components/schemas/MatchingWorkflowSummary' ListSchemaMappingsInputMaxResultsInteger: type: integer maximum: 25 ListSchemaMappingsInput: type: object title: ListSchemaMappingsInput properties: {} SchemaMappingList: type: array items: $ref: '#/components/schemas/SchemaMappingSummary' VeniceGlobalArn: type: string pattern: '^arn:(aws|aws-us-gov|aws-cn):(entityresolution):.*:[0-9]+:((schemamapping|matchingworkflow)/[a-zA-Z0-9_-]+)$' ListTagsForResourceInput: type: object title: ListTagsForResourceInput properties: {} MatchingWorkflowSummary: type: object required: - createdAt - updatedAt - workflowArn - workflowName properties: createdAt: allOf: - $ref: '#/components/schemas/Timestamp' - description: The timestamp of when the workflow was created. updatedAt: allOf: - $ref: '#/components/schemas/Timestamp' - description: The timestamp of when the workflow was last updated. workflowArn: allOf: - $ref: '#/components/schemas/MatchingWorkflowArn' - description: The ARN (Amazon Resource Name) that Entity Resolution generated for the MatchingWorkflow. workflowName: allOf: - $ref: '#/components/schemas/EntityName' - description: The name of the workflow. description: 'A list of MatchingWorkflowSummary objects, each of which contain the fields WorkflowName, WorkflowArn, CreatedAt, UpdatedAt.' OutputAttribute: type: object required: - name properties: hashed: allOf: - $ref: '#/components/schemas/Boolean' - description: Enables the ability to hash the column values in the output. name: allOf: - $ref: '#/components/schemas/AttributeName' - description: A name of a column to be written to the output. This must be an InputField name in the schema mapping. description: '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.' OutputSourceOutputList: type: array items: $ref: '#/components/schemas/OutputAttribute' minItems: 0 maxItems: 750 OutputSourceOutputS3PathString: type: string pattern: '^s3://([^/]+)/?(.*?([^/]+)/?)$' RecordAttributeMapKeyString: type: string pattern: '^[a-zA-Z_0-9- \t]*$' minLength: 0 maxLength: 255 RuleMatchingKeysList: type: array items: $ref: '#/components/schemas/AttributeName' minItems: 1 maxItems: 15 RuleRuleNameString: type: string pattern: '^[a-zA-Z_0-9- \t]*$' minLength: 0 maxLength: 255 Rule: type: object required: - matchingKeys - ruleName properties: matchingKeys: allOf: - $ref: '#/components/schemas/RuleMatchingKeysList' - description: 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. ruleName: allOf: - $ref: '#/components/schemas/RuleRuleNameString' - description: A name for the matching rule. description: 'An object containing RuleName, and MatchingKeys.' RuleBasedPropertiesRulesList: type: array items: $ref: '#/components/schemas/Rule' minItems: 1 maxItems: 15 SchemaAttributeType: type: string enum: - 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 SchemaMappingSummary: type: object required: - createdAt - schemaArn - schemaName - updatedAt properties: createdAt: allOf: - $ref: '#/components/schemas/Timestamp' - description: The timestamp of when the SchemaMapping was created. schemaArn: allOf: - $ref: '#/components/schemas/SchemaMappingArn' - description: The ARN (Amazon Resource Name) that Entity Resolution generated for the SchemaMapping. schemaName: allOf: - $ref: '#/components/schemas/EntityName' - description: The name of the schema. updatedAt: allOf: - $ref: '#/components/schemas/Timestamp' - description: The timestamp of when the SchemaMapping was last updated. description: 'An object containing SchemaName, SchemaArn, CreatedAt, andUpdatedAt.' StartMatchingJobInput: type: object title: StartMatchingJobInput properties: {} TagKeyList: type: array items: $ref: '#/components/schemas/TagKey' minItems: 0 maxItems: 200 TagResourceInput: type: object required: - tags title: TagResourceInput properties: tags: allOf: - $ref: '#/components/schemas/TagMap' - description: 'The tags used to organize, track, or control access for this resource.' UntagResourceInput: type: object title: UntagResourceInput properties: {} UpdateMatchingWorkflowInput: type: object required: - inputSourceConfig - outputSourceConfig - resolutionTechniques - roleArn title: UpdateMatchingWorkflowInput properties: description: allOf: - $ref: '#/components/schemas/Description' - description: A description of the workflow. incrementalRunConfig: allOf: - $ref: '#/components/schemas/IncrementalRunConfig' - description: An object which defines an incremental run type and has only incrementalRunType as a field. inputSourceConfig: allOf: - $ref: '#/components/schemas/InputSourceConfig' - description: 'A list of InputSource objects, which have the fields InputSourceARN and SchemaName.' outputSourceConfig: allOf: - $ref: '#/components/schemas/OutputSourceConfig' - description: 'A list of OutputSource objects, each of which contains fields OutputS3Path, ApplyNormalization, and Output.' resolutionTechniques: allOf: - $ref: '#/components/schemas/ResolutionTechniques' - description: 'An object which defines the resolutionType and the ruleBasedProperties ' roleArn: allOf: - $ref: '#/components/schemas/String' - description: The Amazon Resource Name (ARN) of the IAM role. AWS Entity Resolution assumes this role to create resources on your behalf as part of workflow execution. security: - hmac: []