AWS CLI Command Reference

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-participant-role-config

Description

Updates timeouts for when human chat participants are to be considered idle, and when agents are automatically disconnected from a chat due to idleness. You can set four timers:

  • Customer idle timeout
  • Customer auto-disconnect timeout
  • Agent idle timeout
  • Agent auto-disconnect timeout

For more information about how chat timeouts work, see Set up chat timeouts for human participants .

See also: AWS API Documentation

Synopsis

  update-participant-role-config
--instance-id <value>
--contact-id <value>
--channel-configuration <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>]

Options

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

--contact-id (string)

The identifier of the contact in this instance of Amazon Connect.

--channel-configuration (tagged union structure)

The Amazon Connect channel you want to configure.

Note

This is a Tagged Union structure. Only one of the following top level keys can be set: Chat.

Chat -> (structure)

Configuration information for the chat participant role.

ParticipantTimerConfigList -> (list)

A list of participant timers. You can specify any unique combination of role and timer type. Duplicate entries error out the request with a 400.

(structure)

Configuration information for the timer. After the timer configuration is set, it persists for the duration of the chat. It persists across new contacts in the chain, for example, transfer contacts.

For more information about how chat timeouts work, see Set up chat timeouts for human participants .

ParticipantRole -> (string)

The role of the participant in the chat conversation.

TimerType -> (string)

The type of timer. IDLE indicates the timer applies for considering a human chat participant as idle. DISCONNECT_NONCUSTOMER indicates the timer applies to automatically disconnecting a chat participant due to idleness.

TimerValue -> (tagged union structure)

The value of the timer. Either the timer action (Unset to delete the timer), or the duration of the timer in minutes. Only one value can be set.

Note

This is a Tagged Union structure. Only one of the following top level keys can be set: ParticipantTimerAction, ParticipantTimerDurationInMinutes.

ParticipantTimerAction -> (string)

The timer action. Currently only one value is allowed: Unset . It deletes a timer.

ParticipantTimerDurationInMinutes -> (integer)

The duration of a timer, in minutes.

JSON Syntax:

{
  "Chat": {
    "ParticipantTimerConfigList": [
      {
        "ParticipantRole": "CUSTOMER"|"AGENT",
        "TimerType": "IDLE"|"DISCONNECT_NONCUSTOMER",
        "TimerValue": {
          "ParticipantTimerAction": "Unset",
          "ParticipantTimerDurationInMinutes": integer
        }
      }
      ...
    ]
  }
}

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

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

Output

None