[ aws . connect ]

create-routing-profile

Description

Creates a new routing profile.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  create-routing-profile
--instance-id <value>
--name <value>
--description <value>
--default-outbound-queue-id <value>
[--queue-configs <value>]
--media-concurrencies <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 routing profile. Must not be more than 127 characters.

--description (string)

Description of the routing profile. Must not be more than 250 characters.

--default-outbound-queue-id (string)

The default outbound queue for the routing profile.

--queue-configs (list)

The inbound queues associated with the routing profile. If no queue is added, the agent can make only outbound calls.

(structure)

Contains information about the queue and channel for which priority and delay can be set.

QueueReference -> (structure)

Contains information about a queue resource.

QueueId -> (string)

The identifier for the queue.

Channel -> (string)

The channels agents can handle in the Contact Control Panel (CCP) for this routing profile.

Priority -> (integer)

The order in which contacts are to be handled for the queue. For more information, see Queues: priority and delay .

Delay -> (integer)

The delay, in seconds, a contact should be in the queue before they are routed to an available agent. For more information, see Queues: priority and delay in the Amazon Connect Administrator Guide .

Shorthand Syntax:

QueueReference={QueueId=string,Channel=string},Priority=integer,Delay=integer ...

JSON Syntax:

[
  {
    "QueueReference": {
      "QueueId": "string",
      "Channel": "VOICE"|"CHAT"|"TASK"
    },
    "Priority": integer,
    "Delay": integer
  }
  ...
]

--media-concurrencies (list)

The channels that agents can handle in the Contact Control Panel (CCP) for this routing profile.

(structure)

Contains information about which channels are supported, and how many contacts an agent can have on a channel simultaneously.

Channel -> (string)

The channels that agents can handle in the Contact Control Panel (CCP).

Concurrency -> (integer)

The number of contacts an agent can have on a channel simultaneously.

Valid Range for VOICE : Minimum value of 1. Maximum value of 1.

Valid Range for CHAT : Minimum value of 1. Maximum value of 10.

Valid Range for TASK : Minimum value of 1. Maximum value of 10.

Shorthand Syntax:

Channel=string,Concurrency=integer ...

JSON Syntax:

[
  {
    "Channel": "VOICE"|"CHAT"|"TASK",
    "Concurrency": integer
  }
  ...
]

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

RoutingProfileArn -> (string)

The Amazon Resource Name (ARN) of the routing profile.

RoutingProfileId -> (string)

The identifier of the routing profile.