[ aws . connect ]

describe-contact-flow

Description

Describes the specified contact flow.

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

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  describe-contact-flow
--instance-id <value>
--contact-flow-id <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options

--instance-id (string)

The identifier of the Amazon Connect instance.

--contact-flow-id (string)

The identifier of the contact flow.

--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.

--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.

Output

ContactFlow -> (structure)

Information about the contact flow.

Arn -> (string)

The Amazon Resource Name (ARN) of the contact flow.

Id -> (string)

The identifier of the contact flow.

Name -> (string)

The name of the contact flow.

Type -> (string)

The type of the contact flow. For descriptions of the available types, see Choose a Contact Flow Type in the Amazon Connect Administrator Guide .

State -> (string)

The type of contact flow.

Description -> (string)

The description of the contact flow.

Content -> (string)

The content of the contact flow.

Tags -> (map)

One or more tags.

key -> (string)

value -> (string)