Skip to content

List Contact Flows

connect_list_contact_flows R Documentation

Provides information about the flows for the specified Amazon Connect instance

Description

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.

Usage

connect_list_contact_flows(InstanceId, ContactFlowTypes, NextToken,
  MaxResults)

Arguments

InstanceId

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

ContactFlowTypes

The type of flow.

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.

MaxResults

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

Value

A list with the following syntax:

list(
  ContactFlowSummaryList = list(
    list(
      Id = "string",
      Arn = "string",
      Name = "string",
      ContactFlowType = "CONTACT_FLOW"|"CUSTOMER_QUEUE"|"CUSTOMER_HOLD"|"CUSTOMER_WHISPER"|"AGENT_HOLD"|"AGENT_WHISPER"|"OUTBOUND_WHISPER"|"AGENT_TRANSFER"|"QUEUE_TRANSFER",
      ContactFlowState = "ACTIVE"|"ARCHIVED",
      ContactFlowStatus = "PUBLISHED"|"SAVED"
    )
  ),
  NextToken = "string"
)

Request syntax

svc$list_contact_flows(
  InstanceId = "string",
  ContactFlowTypes = list(
    "CONTACT_FLOW"|"CUSTOMER_QUEUE"|"CUSTOMER_HOLD"|"CUSTOMER_WHISPER"|"AGENT_HOLD"|"AGENT_WHISPER"|"OUTBOUND_WHISPER"|"AGENT_TRANSFER"|"QUEUE_TRANSFER"
  ),
  NextToken = "string",
  MaxResults = 123
)