DescribeContactFlow
Describes the specified flow.
You can also create and update flows using the Amazon Connect Flow language.
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",
"Id": "string",
"Name": "string",
"State": "string",
"Tags": {
"string" : "string"
},
"Type": "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.
HTTP Status Code: 500
- InvalidParameterException
-
One or more of the specified parameters are not valid.
HTTP Status Code: 400
- InvalidRequestException
-
The request is not valid.
HTTP Status Code: 400
- ResourceNotFoundException
-
The specified resource was not found.
HTTP Status Code: 404
- ThrottlingException
-
The throttling limit has been exceeded.
HTTP Status Code: 429
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
