GetWorkflow - Amazon Connect
Request SyntaxURI Request ParametersRequest BodyResponse SyntaxResponse ElementsErrorsSee Also

GetWorkflow

Get details of specified workflow.

Request Syntax

GET /domains/DomainName/workflows/WorkflowId HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

DomainName

The unique name of the domain.

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

Pattern: ^[a-zA-Z0-9_-]+$

Required: Yes

WorkflowId

Unique identifier for the workflow.

Pattern: [a-f0-9]{32}

Required: Yes

Request Body

The request does not have a request body.

Response Syntax

HTTP/1.1 200
Content-type: application/json

{
   "Attributes": { 
      "AppflowIntegration": { 
         "ConnectorProfileName": "string",
         "RoleArn": "string",
         "SourceConnectorType": "string"
      }
   },
   "ErrorDescription": "string",
   "LastUpdatedAt": number,
   "Metrics": { 
      "AppflowIntegration": { 
         "RecordsProcessed": number,
         "StepsCompleted": number,
         "TotalSteps": number
      }
   },
   "StartDate": number,
   "Status": "string",
   "WorkflowId": "string",
   "WorkflowType": "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.

Attributes

Attributes provided for workflow execution.

Type: WorkflowAttributes object

ErrorDescription

Workflow error messages during execution (if any).

Type: String

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

LastUpdatedAt

The timestamp that represents when workflow execution last updated.

Type: Timestamp

Metrics

Workflow specific execution metrics.

Type: WorkflowMetrics object

StartDate

The timestamp that represents when workflow execution started.

Type: Timestamp

Status

Status of workflow execution.

Type: String

Valid Values: NOT_STARTED | IN_PROGRESS | COMPLETE | FAILED | SPLIT | RETRY | CANCELLED

WorkflowId

Unique identifier for the workflow.

Type: String

Pattern: [a-f0-9]{32}

WorkflowType

The type of workflow. The only supported value is APPFLOW_INTEGRATION.

Type: String

Valid Values: APPFLOW_INTEGRATION

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

BadRequestException

The input you provided is invalid.

HTTP Status Code: 400

InternalServerException

An internal service error occurred.

HTTP Status Code: 500

ResourceNotFoundException

The requested resource does not exist, or access was denied.

HTTP Status Code: 404

ThrottlingException

You exceeded the maximum number of requests.

HTTP Status Code: 429

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: