[ aws . connect ]

create-quick-connect

Description

Creates a quick connect for the specified Amazon Connect instance.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  create-quick-connect
--instance-id <value>
--name <value>
[--description <value>]
--quick-connect-config <value>
[--tags <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.

--name (string)

The name of the quick connect.

--description (string)

The description of the quick connect.

--quick-connect-config (structure)

Configuration settings for 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.

Shorthand Syntax:

QuickConnectType=string,UserConfig={UserId=string,ContactFlowId=string},QueueConfig={QueueId=string,ContactFlowId=string},PhoneConfig={PhoneNumber=string}

JSON Syntax:

{
  "QuickConnectType": "USER"|"QUEUE"|"PHONE_NUMBER",
  "UserConfig": {
    "UserId": "string",
    "ContactFlowId": "string"
  },
  "QueueConfig": {
    "QueueId": "string",
    "ContactFlowId": "string"
  },
  "PhoneConfig": {
    "PhoneNumber": "string"
  }
}

--tags (map)

One or more tags.

key -> (string)

value -> (string)

Shorthand Syntax:

KeyName1=string,KeyName2=string

JSON Syntax:

{"string": "string"
  ...}

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

QuickConnectARN -> (string)

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

QuickConnectId -> (string)

The identifier for the quick connect.