[ aws . connect ]

create-user

Description

Creates a user account for the specified Amazon Connect instance.

For information about how to create user accounts using the Amazon Connect console, see Add Users in the Amazon Connect Administrator Guide .

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

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>
[--tags <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

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_-.@]+.

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

LastName -> (string)

The last name. This is required if you are using Amazon Connect or SAML for identity management.

Email -> (string)

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

Shorthand Syntax:

FirstName=string,LastName=string,Email=string

JSON Syntax:

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

--phone-config (structure)

The phone settings for the user.

PhoneType -> (string)

The phone type.

AutoAccept -> (boolean)

The Auto accept setting.

AfterContactWorkTimeLimit -> (integer)

The After Call Work (ACW) timeout setting, in seconds.

DeskPhoneNumber -> (string)

The phone number for the user’s desk phone.

Shorthand Syntax:

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

JSON Syntax:

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

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

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

Examples

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.