Table Of Contents

Feedback

User Guide

First time using the AWS CLI? See the User Guide for help getting started.

Note: You are viewing the documentation for an older major version of the AWS CLI (version 1).

AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ aws . connect ]

update-quick-connect-config

Description

This API is in preview release for Amazon Connect and is subject to change.

Updates the configuration settings for the specified quick connect.

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.

Synopsis

  update-quick-connect-config
--instance-id <value>
--quick-connect-id <value>
--quick-connect-config <value>
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]

Options

--instance-id (string)

The identifier of the Amazon Connect instance.

--quick-connect-id (string)

The identifier for the quick connect.

--quick-connect-config (structure)

Information about the 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"
  }
}

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI 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.

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

None