[ aws . connect ]

describe-quick-connect

Description

Describes the quick connect.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

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

Options

--instance-id (string)

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

--quick-connect-id (string)

The identifier for the quick connect.

--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. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.

See ‘aws help’ for descriptions of global parameters.

Output

QuickConnect -> (structure)

Information about the quick connect.

QuickConnectARN -> (string)

The Amazon Resource Name (ARN) of the quick connect.

QuickConnectId -> (string)

The identifier for the quick connect.

Name -> (string)

The name of the quick connect.

Description -> (string)

The description.

QuickConnectConfig -> (structure)

Contains information about the quick connect.

QuickConnectType -> (string)

The type of quick connect. In the Amazon Connect console, when you create a quick connect, you are prompted to assign one of the following types: Agent (USER), External (PHONE_NUMBER), or Queue (QUEUE).

UserConfig -> (structure)

The user configuration. This is required only if QuickConnectType is USER.

UserId -> (string)

The identifier of the user.

ContactFlowId -> (string)

The identifier of the contact flow.

QueueConfig -> (structure)

The queue configuration. This is required only if QuickConnectType is QUEUE.

QueueId -> (string)

The identifier for the queue.

ContactFlowId -> (string)

The identifier of the contact flow.

PhoneConfig -> (structure)

The phone configuration. This is required only if QuickConnectType is PHONE_NUMBER.

PhoneNumber -> (string)

The phone number in E.164 format.

Tags -> (map)

The tags used to organize, track, or control access for this resource.

key -> (string)

value -> (string)