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 ]

create-user

Description

Creates a user account for the specified Amazon Connect instance.

Warning

Certain UserIdentityInfo parameters are required in some situations. For example, Email , FirstName and LastName are required if you are using Amazon Connect or SAML for identity management.

Note

Fields in PhoneConfig cannot be set simultaneously with their corresponding channel-specific configuration parameters. Specifically:

  • PhoneConfig.AutoAccept conflicts with AutoAcceptConfigs
  • PhoneConfig.AfterContactWorkTimeLimit conflicts with AfterContactWorkConfigs
  • PhoneConfig.PhoneType and PhoneConfig.PhoneNumber conflict with PhoneNumberConfigs
  • PhoneConfig.PersistentConnection conflicts with PersistentConnectionConfigs

We recommend using channel-specific parameters such as AutoAcceptConfigs , AfterContactWorkConfigs , PhoneNumberConfigs , PersistentConnectionConfigs , and VoiceEnhancementConfigs for per-channel configuration.

For information about how to create users using the Amazon Connect admin website, see Add Users in the Amazon Connect Administrator Guide .

See also: AWS API Documentation

Synopsis

  create-user
--username <value>
[--password <value>]
[--identity-info <value>]
[--phone-config <value>]
[--directory-user-id <value>]
--security-profile-ids <value>
--routing-profile-id <value>
[--hierarchy-group-id <value>]
--instance-id <value>
[--auto-accept-configs <value>]
[--after-contact-work-configs <value>]
[--phone-number-configs <value>]
[--persistent-connection-configs <value>]
[--voice-enhancement-configs <value>]
[--tags <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

--username (string)

The user name for the account. For instances not using SAML for identity management, the user name can include up to 20 characters. If you are using SAML for identity management, the user name can include up to 64 characters from [a-zA-Z0-9_-.@]+.

Username can include @ only if used in an email format. For example:

--password (string)

The password for the user account. A password is required if you are using Amazon Connect for identity management. Otherwise, it is an error to include a password.

--identity-info (structure)

The information about the identity of the user.

FirstName -> (string)

The first name. This is required if you are using Amazon Connect or SAML for identity management. Inputs must be in Unicode Normalization Form C (NFC). Text containing characters in a non-NFC form (for example, decomposed characters or combining marks) are not accepted.

LastName -> (string)

The last name. This is required if you are using Amazon Connect or SAML for identity management. Inputs must be in Unicode Normalization Form C (NFC). Text containing characters in a non-NFC form (for example, decomposed characters or combining marks) are not accepted.

Email -> (string)

The email address. If you are using SAML for identity management and include this parameter, an error is returned.

SecondaryEmail -> (string)

The user’s secondary email address. If you provide a secondary email, the user receives email notifications - other than password reset notifications - to this email address instead of to their primary email address.

Pattern: (?=^.{0,265}$)[a-zA-Z0-9._%+-]+@[a-zA-Z0-9.-]+\.[a-zA-Z]{2,63}

Mobile -> (string)

The user’s mobile number.

Shorthand Syntax:

FirstName=string,LastName=string,Email=string,SecondaryEmail=string,Mobile=string

JSON Syntax:

{
  "FirstName": "string",
  "LastName": "string",
  "Email": "string",
  "SecondaryEmail": "string",
  "Mobile": "string"
}

--phone-config (structure)

The phone settings for the user. This parameter is optional. If not provided, the user can be configured using channel-specific parameters such as AutoAcceptConfigs , AfterContactWorkConfigs , PhoneNumberConfigs , PersistentConnectionConfigs , and VoiceEnhancementConfigs .

PhoneType -> (string)

The phone type.

AutoAccept -> (boolean)

The Auto accept setting.

AfterContactWorkTimeLimit -> (integer)

The After Call Work (ACW) timeout setting, in seconds. This parameter has a minimum value of 0 and a maximum value of 2,000,000 seconds (24 days). Enter 0 if you don’t want to allocate a specific amount of ACW time. It essentially means an indefinite amount of time. When the conversation ends, ACW starts; the agent must choose Close contact to end ACW.

Note

When returned by a SearchUsers call, AfterContactWorkTimeLimit is returned in milliseconds.

DeskPhoneNumber -> (string)

The phone number for the user’s desk phone.

PersistentConnection -> (boolean)

The persistent connection setting for the user.

Shorthand Syntax:

PhoneType=string,AutoAccept=boolean,AfterContactWorkTimeLimit=integer,DeskPhoneNumber=string,PersistentConnection=boolean

JSON Syntax:

{
  "PhoneType": "SOFT_PHONE"|"DESK_PHONE",
  "AutoAccept": true|false,
  "AfterContactWorkTimeLimit": integer,
  "DeskPhoneNumber": "string",
  "PersistentConnection": true|false
}

--directory-user-id (string)

The identifier of the user account in the directory used for identity management. If Amazon Connect cannot access the directory, you can specify this identifier to authenticate users. If you include the identifier, we assume that Amazon Connect cannot access the directory. Otherwise, the identity information is used to authenticate users from your directory.

This parameter is required if you are using an existing directory for identity management in Amazon Connect when Amazon Connect cannot access your directory to authenticate users. If you are using SAML for identity management and include this parameter, an error is returned.

--security-profile-ids (list)

The identifier of the security profile for the user.

(string)

Syntax:

"string" "string" ...

--routing-profile-id (string)

The identifier of the routing profile for the user.

--hierarchy-group-id (string)

The identifier of the hierarchy group for the user.

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

--auto-accept-configs (list)

The list of auto-accept configuration settings for each channel.

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

(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"
  }
  ...
]

--tags (map)

The tags used to organize, track, or control access for this resource. For example, { “Tags”: {“key1”:”value1”, “key2”:”value2”} }.

key -> (string)

value -> (string)

Shorthand Syntax:

KeyName1=string,KeyName2=string

JSON Syntax:

{"string": "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.

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.

Examples

Note

To use the following examples, you must have the AWS CLI installed and configured. See the Getting started guide in the AWS CLI User Guide for more information.

Unless otherwise stated, all examples have unix-like quotation rules. These examples will need to be adapted to your terminal’s quoting rules. See Using quotation marks with strings in the AWS CLI User Guide .

To create a user

The following create-user example adds a user with the specified attributes to the specified Amazon Connect instance.

aws connect create-user \
    --username Mary \
    --password Pass@Word1 \
    --identity-info FirstName=Mary,LastName=Major \
    --phone-config PhoneType=DESK_PHONE,AutoAccept=true,AfterContactWorkTimeLimit=60,DeskPhoneNumber=+15555551212 \
    --security-profile-id 12345678-1111-2222-aaaa-a1b2c3d4f5g7 \
    --routing-profile-id 87654321-9999-3434-abcd-x1y2z3a1b2c3 \
    --instance-id a1b2c3d4-5678-90ab-cdef-EXAMPLE11111

Output:

{
    "UserId": "87654321-2222-1234-1234-111234567891",
    "UserArn": "arn:aws:connect:us-west-2:123456789012:instance/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111/agent/87654321-2222-1234-1234-111234567891"
}

For more information, see Add Users in the Amazon Connect Administrator Guide.

Output

UserId -> (string)

The identifier of the user account.

UserArn -> (string)

The Amazon Resource Name (ARN) of the user account.