Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

GetMatchingWorkflow

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

Request Syntax


GET /matchingworkflows/workflowName HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

workflowName

The name of the workflow.

Length Constraints: Minimum length of 1. Maximum length of 255.

Pattern: ^[a-zA-Z_0-9-]*$

Required: Yes

Request Body

The request does not have a request body.

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "createdAt": number,
   "description": "string",
   "incrementalRunConfig": { 
      "incrementalRunType": "string"
   },
   "inputSourceConfig": [ 
      { 
         "applyNormalization": boolean,
         "inputSourceARN": "string",
         "schemaName": "string"
      }
   ],
   "outputSourceConfig": [ 
      { 
         "applyNormalization": boolean,
         "KMSArn": "string",
         "output": [ 
            { 
               "hashed": boolean,
               "name": "string"
            }
         ],
         "outputS3Path": "string"
      }
   ],
   "resolutionTechniques": { 
      "providerProperties": { 
         "intermediateSourceConfiguration": { 
            "intermediateS3Path": "string"
         },
         "providerConfiguration": JSON value,
         "providerServiceArn": "string"
      },
      "resolutionType": "string",
      "ruleBasedProperties": { 
         "attributeMatchingModel": "string",
         "matchPurpose": "string",
         "rules": [ 
            { 
               "matchingKeys": [ "string" ],
               "ruleName": "string"
            }
         ]
      }
   },
   "roleArn": "string",
   "tags": { 
      "string" : "string" 
   },
   "updatedAt": number,
   "workflowArn": "string",
   "workflowName": "string"
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

createdAt

The timestamp of when the workflow was created.

Type: Timestamp

description

A description of the workflow.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 255.

incrementalRunConfig

An object which defines an incremental run type and has only incrementalRunType as a field.

Type: IncrementalRunConfig object

inputSourceConfig

A list of InputSource objects, which have the fields InputSourceARN and SchemaName.

Type: Array of InputSource objects

Array Members: Minimum number of 1 item. Maximum number of 20 items.

outputSourceConfig

A list of OutputSource objects, each of which contains fields OutputS3Path, ApplyNormalization, and Output.

Type: Array of OutputSource objects

Array Members: Fixed number of 1 item.

resolutionTechniques

An object which defines the resolutionType and the ruleBasedProperties.

Type: ResolutionTechniques object

roleArn

The Amazon Resource Name (ARN) of the IAM role. AWS Entity Resolution assumes this role to access AWS resources on your behalf.

Type: String

tags

The tags used to organize, track, or control access for this resource.

Type: String to string map

Map Entries: Minimum number of 0 items. Maximum number of 200 items.

Key Length Constraints: Minimum length of 1. Maximum length of 128.

Value Length Constraints: Minimum length of 0. Maximum length of 256.

updatedAt

The timestamp of when the workflow was last updated.

Type: Timestamp

workflowArn

The ARN (Amazon Resource Name) that AWS Entity Resolution generated for the MatchingWorkflow.

Type: String

Pattern: ^arn:(aws|aws-us-gov|aws-cn):entityresolution:[a-z]{2}-[a-z]{1,10}-[0-9]:[0-9]{12}:(matchingworkflow/[a-zA-Z_0-9-]{1,255})$

workflowName

The name of the workflow.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 255.

Pattern: ^[a-zA-Z_0-9-]*$

Errors

For information about the errors that are common to all actions, see Common Errors.

AccessDeniedException

You do not have sufficient access to perform this action.

HTTP Status Code: 403

InternalServerException

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

HTTP Status Code: 500

ResourceNotFoundException

The resource could not be found.

HTTP Status Code: 404

ThrottlingException

The request was denied due to request throttling.

HTTP Status Code: 429

ValidationException

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

HTTP Status Code: 400