AWS CLI Command Reference

Note:

You are viewing the documentation for an older major version of the AWS CLI (version 1). To view this page for the AWS CLI version 2, click here.

We announced the upcoming end-of-support for the AWS CLI v1. For dates, additional details, and information on how to migrate, please refer to the linked announcement. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ aws . connect ]

update-user-config

Description

Updates the configuration settings for the specified user, including per-channel auto-accept and after contact work (ACW) timeout settings.

Note

This operation replaces the UpdateUserPhoneConfig API. While UpdateUserPhoneConfig applies the same ACW timeout to all channels, UpdateUserConfig allows you to set different auto-accept and ACW timeout values for each channel type.

See also: AWS API Documentation

Synopsis

  update-user-config
[--auto-accept-configs <value>]
[--after-contact-work-configs <value>]
[--phone-number-configs <value>]
[--persistent-connection-configs <value>]
[--voice-enhancement-configs <value>]
--user-id <value>
--instance-id <value>
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]
[--v2-debug]

Options

--auto-accept-configs (list)

The list of auto-accept configuration settings for each channel. When auto-accept is enabled for a channel, available agents are automatically connected to contacts from that channel without needing to manually accept. Auto-accept connects agents to contacts in less than one second.

(structure)

Configuration settings for auto-accept for a specific channel.

Channel -> (string)

The channel for this auto-accept configuration. Valid values: VOICE, CHAT, TASK, EMAIL.

AutoAccept -> (boolean)

Indicates whether auto-accept is enabled for this channel. When enabled, available agents are automatically connected to contacts from this channel.

AgentFirstCallbackAutoAccept -> (boolean)

Indicates whether auto-accept is enabled for agent-first callbacks. This setting only applies to the VOICE channel.

Shorthand Syntax:

Channel=string,AutoAccept=boolean,AgentFirstCallbackAutoAccept=boolean ...

JSON Syntax:

[
  {
    "Channel": "VOICE"|"CHAT"|"TASK"|"EMAIL",
    "AutoAccept": true|false,
    "AgentFirstCallbackAutoAccept": true|false
  }
  ...
]

--after-contact-work-configs (list)

The list of after contact work (ACW) timeout configuration settings for each channel. ACW timeout specifies how many seconds agents have for after contact work, such as entering notes about the contact. The minimum setting is 1 second, and the maximum is 2,000,000 seconds (24 days). Enter 0 for an indefinite amount of time, meaning agents must manually choose to end ACW.

(structure)

Configuration settings for after contact work (ACW) timeout for a specific channel.

Channel -> (string)

The channel for this ACW timeout configuration. Valid values: VOICE, CHAT, TASK, EMAIL.

AfterContactWorkConfig -> (structure)

The ACW timeout settings for this channel.

AfterContactWorkTimeLimit -> (integer)

The ACW timeout duration in seconds. Minimum: 1 second. Maximum: 2,000,000 seconds (24 days). Enter 0 for indefinite ACW time.

AgentFirstCallbackAfterContactWorkConfig -> (structure)

The ACW timeout settings for agent-first callbacks. This setting only applies to the VOICE channel.

AfterContactWorkTimeLimit -> (integer)

The ACW timeout duration in seconds. Minimum: 1 second. Maximum: 2,000,000 seconds (24 days). Enter 0 for indefinite ACW time.

Shorthand Syntax:

Channel=string,AfterContactWorkConfig={AfterContactWorkTimeLimit=integer},AgentFirstCallbackAfterContactWorkConfig={AfterContactWorkTimeLimit=integer} ...

JSON Syntax:

[
  {
    "Channel": "VOICE"|"CHAT"|"TASK"|"EMAIL",
    "AfterContactWorkConfig": {
      "AfterContactWorkTimeLimit": integer
    },
    "AgentFirstCallbackAfterContactWorkConfig": {
      "AfterContactWorkTimeLimit": integer
    }
  }
  ...
]

--phone-number-configs (list)

The list of phone number configuration settings for each channel.

(structure)

Configuration settings for phone type and phone number.

Channel -> (string)

The channel for this phone number configuration. Only ``VOICE`` is supported for this data type.

PhoneType -> (string)

The phone type. Valid values: SOFT_PHONE, DESK_PHONE.

PhoneNumber -> (string)

The phone number for the user’s desk phone.

Shorthand Syntax:

Channel=string,PhoneType=string,PhoneNumber=string ...

JSON Syntax:

[
  {
    "Channel": "VOICE"|"CHAT"|"TASK"|"EMAIL",
    "PhoneType": "SOFT_PHONE"|"DESK_PHONE",
    "PhoneNumber": "string"
  }
  ...
]

--persistent-connection-configs (list)

The list of persistent connection configuration settings for each channel.

(structure)

Configuration settings for persistent connection for a specific channel.

Channel -> (string)

Configuration settings for persistent connection. Only ``VOICE`` is supported for this data type.

PersistentConnection -> (boolean)

Indicates whether persistent connection is enabled. When enabled, the agent’s connection is maintained after a call ends, enabling subsequent calls to connect faster.

Shorthand Syntax:

Channel=string,PersistentConnection=boolean ...

JSON Syntax:

[
  {
    "Channel": "VOICE"|"CHAT"|"TASK"|"EMAIL",
    "PersistentConnection": true|false
  }
  ...
]

--voice-enhancement-configs (list)

The list of voice enhancement configuration settings for each channel.

(structure)

Configuration settings for voice enhancement.

Channel -> (string)

The channel for this voice enhancement configuration. Only ``VOICE`` is supported for this data type.

VoiceEnhancementMode -> (string)

The voice enhancement mode.

Shorthand Syntax:

Channel=string,VoiceEnhancementMode=string ...

JSON Syntax:

[
  {
    "Channel": "VOICE"|"CHAT"|"TASK"|"EMAIL",
    "VoiceEnhancementMode": "VOICE_ISOLATION"|"NOISE_SUPPRESSION"|"NONE"
  }
  ...
]

--user-id (string)

The identifier of the user account.

--instance-id (string)

The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

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

Global Options

--debug (boolean)

Turn on debug logging.

--endpoint-url (string)

Override command’s default URL with the given URL.

--no-verify-ssl (boolean)

By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.

--no-paginate (boolean)

Disable automatic pagination. If automatic pagination is disabled, the AWS CLI will only make one call, for the first page of results.

--output (string)

The formatting style for command output.

  • json
  • text
  • table

--query (string)

A JMESPath query to use in filtering the response data.

--profile (string)

Use a specific profile from your credential file.

--region (string)

The region to use. Overrides config/env settings.

--version (string)

Display the version of this tool.

--color (string)

Turn on/off color output.

  • on
  • off
  • auto

--no-sign-request (boolean)

Do not sign requests. Credentials will not be loaded if this argument is provided.

--ca-bundle (string)

The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.

--cli-read-timeout (int)

The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.

--cli-connect-timeout (int)

The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.

--v2-debug (boolean)

Enable AWS CLI v2 migration assistance. Prints warnings if the command would face a breaking change after swapping AWS CLI v1 for AWS CLI v2 in the current environment. Prints one warning for each breaking change detected.

Output

None