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-contact-routing-data¶

Description¶

Updates routing priority and age on the contact (QueuePriority and QueueTimeAdjustmentInSeconds ). These properties can be used to change a customer's position in the queue. For example, you can move a contact to the back of the queue by setting a lower routing priority relative to other contacts in queue; or you can move a contact to the front of the queue by increasing the routing age which will make the contact look artificially older and therefore higher up in the first-in-first-out routing order. Note that adjusting the routing age of a contact affects only its position in queue, and not its actual queue wait time as reported through metrics. These properties can also be updated by using the Set routing priority / age flow block .

Note

Either QueuePriority or QueueTimeAdjustmentInSeconds should be provided within the request body, but not both.

Synopsis¶

  update-contact-routing-data
--instance-id <value>
--contact-id <value>
[--queue-time-adjustment-seconds <value>]
[--queue-priority <value>]
[--routing-criteria <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.

--queue-time-adjustment-seconds (integer)

The number of seconds to add or subtract from the contact's routing age. Contacts are routed to agents on a first-come, first-serve basis. This means that changing their amount of time in queue compared to others also changes their position in queue.

--queue-priority (long)

Priority of the contact in the queue. The default priority for new contacts is 5. You can raise the priority of a contact compared to other contacts in the queue by assigning them a higher priority, such as 1 or 2.

--routing-criteria (structure)

Updates the routing criteria on the contact. These properties can be used to change how a contact is routed within the queue.

Steps -> (list)

When Amazon Connect does not find an available agent meeting the requirements in a step for a given step duration, the routing criteria will move on to the next step sequentially until a join is completed with an agent. When all steps are exhausted, the contact will be offered to any agent in the queue.

(structure)

Step defines the list of agents to be routed or route based on the agent requirements such as ProficiencyLevel, Name, or Value.

Expiry -> (structure)

An object to specify the expiration of a routing step.

DurationInSeconds -> (integer)

The number of seconds that the contact will be routed only to agents matching this routing step, if expiry was configured for this routing step.

Expression -> (structure)

A tagged union to specify expression for a routing step.

AttributeCondition -> (structure)

An object to specify the predefined attribute condition.

Name -> (string)

The name of predefined attribute.

Value -> (string)

The value of predefined attribute.

ProficiencyLevel -> (float)

The proficiency level of the condition.

MatchCriteria -> (structure)

An object to define AgentsCriteria .

AgentsCriteria -> (structure)

An object to define agentIds.

AgentIds -> (list)

An object to specify a list of agents, by user ID.

(string)

ComparisonOperator -> (string)

The operator of the condition.

AndExpression -> (list)

List of routing expressions which will be AND-ed together.

(structure)

A tagged union to specify expression for a routing step.

AttributeCondition -> (structure)

An object to specify the predefined attribute condition.

Name -> (string)

The name of predefined attribute.

Value -> (string)

The value of predefined attribute.

ProficiencyLevel -> (float)

The proficiency level of the condition.

MatchCriteria -> (structure)

An object to define AgentsCriteria .

AgentsCriteria -> (structure)

An object to define agentIds.

AgentIds -> (list)

An object to specify a list of agents, by user ID.

(string)

ComparisonOperator -> (string)

The operator of the condition.

AndExpression -> (list)

List of routing expressions which will be AND-ed together.

( ... recursive ... )

OrExpression -> (list)

List of routing expressions which will be OR-ed together.

( ... recursive ... )

OrExpression -> (list)

List of routing expressions which will be OR-ed together.

(structure)

A tagged union to specify expression for a routing step.

AttributeCondition -> (structure)

An object to specify the predefined attribute condition.

Name -> (string)

The name of predefined attribute.

Value -> (string)

The value of predefined attribute.

ProficiencyLevel -> (float)

The proficiency level of the condition.

MatchCriteria -> (structure)

An object to define AgentsCriteria .

AgentsCriteria -> (structure)

An object to define agentIds.

AgentIds -> (list)

An object to specify a list of agents, by user ID.

(string)

ComparisonOperator -> (string)

The operator of the condition.

AndExpression -> (list)

List of routing expressions which will be AND-ed together.

( ... recursive ... )

OrExpression -> (list)

List of routing expressions which will be OR-ed together.

( ... recursive ... )

JSON Syntax:

{
  "Steps": [
    {
      "Expiry": {
        "DurationInSeconds": integer
      },
      "Expression": {
        "AttributeCondition": {
          "Name": "string",
          "Value": "string",
          "ProficiencyLevel": float,
          "MatchCriteria": {
            "AgentsCriteria": {
              "AgentIds": ["string", ...]
            }
          },
          "ComparisonOperator": "string"
        },
        "AndExpression": [
          {
            "AttributeCondition": {
              "Name": "string",
              "Value": "string",
              "ProficiencyLevel": float,
              "MatchCriteria": {
                "AgentsCriteria": {
                  "AgentIds": ["string", ...]
                }
              },
              "ComparisonOperator": "string"
            },
            "AndExpression": [
              { ... recursive ... }
              ...
            ],
            "OrExpression": [
              { ... recursive ... }
              ...
            ]
          }
          ...
        ],
        "OrExpression": [
          {
            "AttributeCondition": {
              "Name": "string",
              "Value": "string",
              "ProficiencyLevel": float,
              "MatchCriteria": {
                "AgentsCriteria": {
                  "AgentIds": ["string", ...]
                }
              },
              "ComparisonOperator": "string"
            },
            "AndExpression": [
              { ... recursive ... }
              ...
            ],
            "OrExpression": [
              { ... recursive ... }
              ...
            ]
          }
          ...
        ]
      }
    }
    ...
  ]
}

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

Output¶

None

Table Of Contents

Feedback

User Guide