{ "opencollection": "1.0.0", "info": { "name": "AWS EntityResolution Matchingworkflows API", "version": "1.0.0" }, "request": { "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "items": [ { "info": { "name": "Matchingworkflows", "type": "folder" }, "items": [ { "info": { "name": "Amazon Entity Resolution ListMatchingWorkflows", "type": "http" }, "http": { "method": "GET", "url": "http://entityresolution.{region}.amazonaws.com/matchingworkflows", "headers": [ { "name": "X-Amz-Content-Sha256", "value": "" }, { "name": "X-Amz-Date", "value": "" }, { "name": "X-Amz-Algorithm", "value": "" }, { "name": "X-Amz-Credential", "value": "" }, { "name": "X-Amz-Security-Token", "value": "" }, { "name": "X-Amz-Signature", "value": "" }, { "name": "X-Amz-SignedHeaders", "value": "" } ], "params": [ { "name": "maxResults", "value": "", "type": "query", "description": "The maximum number of objects returned per page." }, { "name": "nextToken", "value": "", "type": "query", "description": "The pagination token from the previous ListSchemaMappings API call." } ] }, "docs": "Returns a list of all the MatchingWorkflows that have been created for an AWS account." }, { "info": { "name": "Amazon Entity Resolution CreateMatchingWorkflow", "type": "http" }, "http": { "method": "POST", "url": "http://entityresolution.{region}.amazonaws.com/matchingworkflows", "headers": [ { "name": "X-Amz-Content-Sha256", "value": "" }, { "name": "X-Amz-Date", "value": "" }, { "name": "X-Amz-Algorithm", "value": "" }, { "name": "X-Amz-Credential", "value": "" }, { "name": "X-Amz-Security-Token", "value": "" }, { "name": "X-Amz-Signature", "value": "" }, { "name": "X-Amz-SignedHeaders", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "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." }, { "info": { "name": "Amazon Entity Resolution GetMatchingWorkflow", "type": "http" }, "http": { "method": "GET", "url": "http://entityresolution.{region}.amazonaws.com/matchingworkflows/:workflowName", "headers": [ { "name": "X-Amz-Content-Sha256", "value": "" }, { "name": "X-Amz-Date", "value": "" }, { "name": "X-Amz-Algorithm", "value": "" }, { "name": "X-Amz-Credential", "value": "" }, { "name": "X-Amz-Security-Token", "value": "" }, { "name": "X-Amz-Signature", "value": "" }, { "name": "X-Amz-SignedHeaders", "value": "" } ], "params": [ { "name": "workflowName", "value": "", "type": "path", "description": "The name of the workflow." } ] }, "docs": "Returns the MatchingWorkflow with a given name, if it exists." }, { "info": { "name": "Amazon Entity Resolution UpdateMatchingWorkflow", "type": "http" }, "http": { "method": "PUT", "url": "http://entityresolution.{region}.amazonaws.com/matchingworkflows/:workflowName", "headers": [ { "name": "X-Amz-Content-Sha256", "value": "" }, { "name": "X-Amz-Date", "value": "" }, { "name": "X-Amz-Algorithm", "value": "" }, { "name": "X-Amz-Credential", "value": "" }, { "name": "X-Amz-Security-Token", "value": "" }, { "name": "X-Amz-Signature", "value": "" }, { "name": "X-Amz-SignedHeaders", "value": "" } ], "params": [ { "name": "workflowName", "value": "", "type": "path", "description": "The name of the workflow to be retrieved." } ], "body": { "type": "json", "data": "{}" } }, "docs": "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." }, { "info": { "name": "Amazon Entity Resolution DeleteMatchingWorkflow", "type": "http" }, "http": { "method": "DELETE", "url": "http://entityresolution.{region}.amazonaws.com/matchingworkflows/:workflowName", "headers": [ { "name": "X-Amz-Content-Sha256", "value": "" }, { "name": "X-Amz-Date", "value": "" }, { "name": "X-Amz-Algorithm", "value": "" }, { "name": "X-Amz-Credential", "value": "" }, { "name": "X-Amz-Security-Token", "value": "" }, { "name": "X-Amz-Signature", "value": "" }, { "name": "X-Amz-SignedHeaders", "value": "" } ], "params": [ { "name": "workflowName", "value": "", "type": "path", "description": "The name of the workflow to be retrieved." } ] }, "docs": "Deletes the MatchingWorkflow with a given name. This operation will succeed even if a workflow with the given name does not exist." }, { "info": { "name": "Amazon Entity Resolution GetMatchId", "type": "http" }, "http": { "method": "POST", "url": "http://entityresolution.{region}.amazonaws.com/matchingworkflows/:workflowName/matches", "headers": [ { "name": "X-Amz-Content-Sha256", "value": "" }, { "name": "X-Amz-Date", "value": "" }, { "name": "X-Amz-Algorithm", "value": "" }, { "name": "X-Amz-Credential", "value": "" }, { "name": "X-Amz-Security-Token", "value": "" }, { "name": "X-Amz-Signature", "value": "" }, { "name": "X-Amz-SignedHeaders", "value": "" } ], "params": [ { "name": "workflowName", "value": "", "type": "path", "description": "The name of the workflow." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Returns the corresponding Match ID of a customer record if the record has been processed." }, { "info": { "name": "Amazon Entity Resolution GetMatchingJob", "type": "http" }, "http": { "method": "GET", "url": "http://entityresolution.{region}.amazonaws.com/matchingworkflows/:workflowName/jobs/:jobId", "headers": [ { "name": "X-Amz-Content-Sha256", "value": "" }, { "name": "X-Amz-Date", "value": "" }, { "name": "X-Amz-Algorithm", "value": "" }, { "name": "X-Amz-Credential", "value": "" }, { "name": "X-Amz-Security-Token", "value": "" }, { "name": "X-Amz-Signature", "value": "" }, { "name": "X-Amz-SignedHeaders", "value": "" } ], "params": [ { "name": "jobId", "value": "", "type": "path", "description": "The ID of the job." }, { "name": "workflowName", "value": "", "type": "path", "description": "The name of the workflow." } ] }, "docs": "Gets the status, metrics, and errors (if there are any) that are associated with a job." }, { "info": { "name": "Amazon Entity Resolution ListMatchingJobs", "type": "http" }, "http": { "method": "GET", "url": "http://entityresolution.{region}.amazonaws.com/matchingworkflows/:workflowName/jobs", "headers": [ { "name": "X-Amz-Content-Sha256", "value": "" }, { "name": "X-Amz-Date", "value": "" }, { "name": "X-Amz-Algorithm", "value": "" }, { "name": "X-Amz-Credential", "value": "" }, { "name": "X-Amz-Security-Token", "value": "" }, { "name": "X-Amz-Signature", "value": "" }, { "name": "X-Amz-SignedHeaders", "value": "" } ], "params": [ { "name": "maxResults", "value": "", "type": "query", "description": "The maximum number of objects returned per page." }, { "name": "nextToken", "value": "", "type": "query", "description": "The pagination token from the previous ListSchemaMappings API call." }, { "name": "workflowName", "value": "", "type": "path", "description": "The name of the workflow to be retrieved." } ] }, "docs": "Lists all jobs for a given workflow." }, { "info": { "name": "Amazon Entity Resolution StartMatchingJob", "type": "http" }, "http": { "method": "POST", "url": "http://entityresolution.{region}.amazonaws.com/matchingworkflows/:workflowName/jobs", "headers": [ { "name": "X-Amz-Content-Sha256", "value": "" }, { "name": "X-Amz-Date", "value": "" }, { "name": "X-Amz-Algorithm", "value": "" }, { "name": "X-Amz-Credential", "value": "" }, { "name": "X-Amz-Security-Token", "value": "" }, { "name": "X-Amz-Signature", "value": "" }, { "name": "X-Amz-SignedHeaders", "value": "" } ], "params": [ { "name": "workflowName", "value": "", "type": "path", "description": "The name of the matching job to be retrieved." } ] }, "docs": "Starts the MatchingJob of a workflow. The workflow must have previously been created using the CreateMatchingWorkflow endpoint." } ] } ], "bundled": true }