ListContactFlowsCommand

Suggest an Edit

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.

Example Syntax

Use a bare-bones client and the command you need to make an API call.

import { ConnectClient, ListContactFlowsCommand } from "@aws-sdk/client-connect"; // ES Modules import
// const { ConnectClient, ListContactFlowsCommand } = require("@aws-sdk/client-connect"); // CommonJS import
const client = new ConnectClient(config);
const input = { // ListContactFlowsRequest
  InstanceId: "STRING_VALUE", // required
  ContactFlowTypes: [ // ContactFlowTypes
    "CONTACT_FLOW" || "CUSTOMER_QUEUE" || "CUSTOMER_HOLD" || "CUSTOMER_WHISPER" || "AGENT_HOLD" || "AGENT_WHISPER" || "OUTBOUND_WHISPER" || "AGENT_TRANSFER" || "QUEUE_TRANSFER" || "CAMPAIGN",
  ],
  NextToken: "STRING_VALUE",
  MaxResults: Number("int"),
};
const command = new ListContactFlowsCommand(input);
const response = await client.send(command);
// { // ListContactFlowsResponse
//   ContactFlowSummaryList: [ // ContactFlowSummaryList
//     { // ContactFlowSummary
//       Id: "STRING_VALUE",
//       Arn: "STRING_VALUE",
//       Name: "STRING_VALUE",
//       ContactFlowType: "CONTACT_FLOW" || "CUSTOMER_QUEUE" || "CUSTOMER_HOLD" || "CUSTOMER_WHISPER" || "AGENT_HOLD" || "AGENT_WHISPER" || "OUTBOUND_WHISPER" || "AGENT_TRANSFER" || "QUEUE_TRANSFER" || "CAMPAIGN",
//       ContactFlowState: "ACTIVE" || "ARCHIVED",
//       ContactFlowStatus: "PUBLISHED" || "SAVED",
//     },
//   ],
//   NextToken: "STRING_VALUE",
// };

ListContactFlowsCommand Input

See ListContactFlowsCommandInput for more details

Parameter
Type
Description
InstanceId
Required
string | undefined

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

ContactFlowTypes
ContactFlowType[] | undefined

The type of flow.

MaxResults
number | undefined

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

NextToken
string | undefined

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.

ListContactFlowsCommand Output

See ListContactFlowsCommandOutput for details

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.
ContactFlowSummaryList
ContactFlowSummary[] | undefined

Information about the flows.

NextToken
string | undefined

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

Throws

Name
Fault
Details
InternalServiceException
server

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

InvalidParameterException
client

One or more of the specified parameters are not valid.

InvalidRequestException
client

The request is not valid.

ResourceNotFoundException
client

The specified resource was not found.

ThrottlingException
client

The throttling limit has been exceeded.

ConnectServiceException
Base exception class for all service exceptions from Connect service.