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

DescribeContactFlow

Describes the specified flow.

You can also create and update flows using the Amazon Connect Flow language.

Use the $SAVED alias in the request to describe the SAVED content of a Flow. For example, arn:aws:.../contact-flow/{id}:$SAVED. After a flow is published, $SAVED needs to be supplied to view saved content that has not been published.

Use arn:aws:.../contact-flow/{id}:{version} to retrieve the content of a specific flow version.

In the response, Status indicates the flow status as either SAVED or PUBLISHED. The PUBLISHED status will initiate validation on the content. SAVED does not initiate validation of the content. SAVED | PUBLISHED

Request Syntax


GET /contact-flows/InstanceId/ContactFlowId HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

ContactFlowId

The identifier of the flow.

Length Constraints: Maximum length of 500.

Required: Yes

InstanceId

The identifier of the Amazon Connect instance.

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

Required: Yes

Request Body

The request does not have a request body.

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "ContactFlow": { 
      "Arn": "string",
      "Content": "string",
      "Description": "string",
      "FlowContentSha256": "string",
      "Id": "string",
      "LastModifiedRegion": "string",
      "LastModifiedTime": number,
      "Name": "string",
      "State": "string",
      "Status": "string",
      "Tags": { 
         "string" : "string" 
      },
      "Type": "string",
      "Version": number,
      "VersionDescription": "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.

ContactFlow

Information about the flow.

Type: ContactFlow object

Errors

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

ContactFlowNotPublishedException

The flow has not been published.

HTTP Status Code: 404

InternalServiceException

Request processing failed because of an error or failure with the service.

Message: The message.

HTTP Status Code: 500

InvalidParameterException

One or more of the specified parameters are not valid.

Message: The message about the parameters.

HTTP Status Code: 400

InvalidRequestException

The request is not valid.

Message: The message about the request.
Reason: Reason why the request was invalid.

HTTP Status Code: 400

ResourceNotFoundException

The specified resource was not found.

Message: The message about the resource.

HTTP Status Code: 404

ThrottlingException

The throttling limit has been exceeded.

HTTP Status Code: 429