Provides information about the contact flows for the specified Amazon Connect instance.
You can also create and update contact flows using the Amazon Connect Flow language .
For more information about contact flows, see Contact Flows in the Amazon Connect Administrator Guide .
See also: AWS API Documentation
See ‘aws help’ for descriptions of global parameters.
list-contact-flows
is a paginated operation. Multiple API calls may be issued in order to retrieve the entire data set of results. You can disable pagination by providing the --no-paginate
argument.
When using --output text
and the --query
argument on a paginated response, the --query
argument must extract data from the results of the following query expressions: ContactFlowSummaryList
list-contact-flows
--instance-id <value>
[--contact-flow-types <value>]
[--cli-input-json | --cli-input-yaml]
[--starting-token <value>]
[--page-size <value>]
[--max-items <value>]
[--generate-cli-skeleton <value>]
--instance-id
(string)
The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
--contact-flow-types
(list)
The type of contact flow.
(string)
Syntax:
"string" "string" ...
Where valid values are:
CONTACT_FLOW
CUSTOMER_QUEUE
CUSTOMER_HOLD
CUSTOMER_WHISPER
AGENT_HOLD
AGENT_WHISPER
OUTBOUND_WHISPER
AGENT_TRANSFER
QUEUE_TRANSFER
--cli-input-json
| --cli-input-yaml
(string)
Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton
. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml
.
--starting-token
(string)
A token to specify where to start paginating. This is the
NextToken
from a previously truncated response.For usage examples, see Pagination in the AWS Command Line Interface User Guide .
--page-size
(integer)
The size of each page to get in the AWS service call. This does not affect the number of items returned in the command’s output. Setting a smaller page size results in more calls to the AWS service, retrieving fewer items in each call. This can help prevent the AWS service calls from timing out.
For usage examples, see Pagination in the AWS Command Line Interface User Guide .
--max-items
(integer)
The total number of items to return in the command’s output. If the total number of items available is more than the value specified, a
NextToken
is provided in the command’s output. To resume pagination, provide theNextToken
value in thestarting-token
argument of a subsequent command. Do not use theNextToken
response element directly outside of the AWS CLI.For usage examples, see Pagination in the AWS Command Line Interface User Guide .
--generate-cli-skeleton
(string)
Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input
, prints a sample input JSON that can be used as an argument for --cli-input-json
. Similarly, if provided yaml-input
it will print a sample input YAML that can be used with --cli-input-yaml
. If provided with the value output
, it validates the command inputs and returns a sample output JSON for that command.
See ‘aws help’ for descriptions of global parameters.
To list the contact flows in an instance
The following list-contact-flows
example lists the contact flows in the specified Amazon Connect instance.
aws connect list-contact-flows \
--instance-id a1b2c3d4-5678-90ab-cdef-EXAMPLE11111
Output:
{
"ContactFlowSummaryList": [
{
"Id": "12345678-1111-2222-800e-a2b3c4d5f6g7",
"Arn": "arn:aws:connect:us-west-2:123456789012:instance/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111/contact-flow/12345678-1111-2222-800e-a2b3c4d5f6g7",
"Name": "Default queue transfer",
"ContactFlowType": "QUEUE_TRANSFER"
},
{
"Id": "87654321-2222-3333-ac99-123456789102",
"Arn": "arn:aws:connect:us-west-2:123456789012:instance/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111/contact-flow/87654321-2222-3333-ac99-123456789102",
"Name": "Default agent hold",
"ContactFlowType": "AGENT_HOLD"
},
{
"Id": "abcdefgh-3333-4444-8af3-201123456789",
"Arn": "arn:aws:connect:us-west-2:123456789012:instance/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111/contact-flow/abcdefgh-3333-4444-8af3-201123456789",
"Name": "Default customer hold",
"ContactFlowType": "CUSTOMER_HOLD"
},
]
}
For more information, see Create Amazon Connect Contact Flows in the Amazon Connect Administrator Guide.
ContactFlowSummaryList -> (list)
Information about the contact flows.
(structure)
Contains summary information about a contact flow.
You can also create and update contact flows using the Amazon Connect Flow language .
Id -> (string)
The identifier of the contact flow.
Arn -> (string)
The Amazon Resource Name (ARN) of the contact flow.
Name -> (string)
The name of the contact flow.
ContactFlowType -> (string)
The type of contact flow.
NextToken -> (string)
If there are additional results, this is the token for the next set of results.