update-user-identity-info¶

Description¶

Updates the identity information for the specified user.

Synopsis¶

  update-user-identity-info
--identity-info <value>
--user-id <value>
--instance-id <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--cli-auto-prompt <value>]

Options¶

--identity-info (structure)

The identity information for 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"
}

--user-id (string)

The identifier of the user account.

--instance-id (string)

The identifier of the Amazon Connect instance.

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

--cli-auto-prompt (boolean) Automatically prompt for CLI input parameters.

See ‘aws help’ for descriptions of global parameters.

Examples¶

To update a user’s identity information

The following update-user-identity-info example updates the identity information for the specified Amazon Connect user.

aws connect update-user-identity-info \
    --identity-info FirstName=Mary,LastName=Major,Email=marym@example.com \
    --user-id 87654321-2222-1234-1234-111234567891 \
    --instance-id a1b2c3d4-5678-90ab-cdef-EXAMPLE11111

This command produces no output.

For more information, see Configure Agent Settings in the Amazon Connect Administrator Guide.

Output¶

None

Table of Contents

Feedback

User Guide