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

ListContactFlows

Provides information about the flows for the specified Amazon Connect instance.

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

For more information about flows, see Flows in the Amazon Connect Administrator Guide.

Request Syntax


GET /contact-flows-summary/InstanceId?contactFlowTypes=ContactFlowTypes&maxResults=MaxResults&nextToken=NextToken HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

ContactFlowTypes

The type of flow.

Array Members: Maximum number of 10 items.

InstanceId

The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

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

Required: Yes

MaxResults

The maximum number of results to return per page. The default MaxResult size is 100.

Valid Range: Minimum value of 1. Maximum value of 1000.

NextToken

The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

Request Body

The request does not have a request body.

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "ContactFlowSummaryList": [ 
      { 
         "Arn": "string",
         "ContactFlowState": "string",
         "ContactFlowStatus": "string",
         "ContactFlowType": "string",
         "Id": "string",
         "Name": "string"
      }
   ],
   "NextToken": "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.

ContactFlowSummaryList

Information about the flows.

Type: Array of ContactFlowSummary objects

NextToken

If there are additional results, this is the token for the next set of results.

Type: String

Errors

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

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