[ aws . chime ]



Sends email to a maximum of 50 users, inviting them to the specified Amazon Chime Team account. Only Team account types are currently supported for this action.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.


--account-id <value>
--user-email-list <value>
[--user-type <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--cli-auto-prompt <value>]


--account-id (string)

The Amazon Chime account ID.

--user-email-list (list)

The user email addresses to which to send the email invitation.



"string" "string" ...

--user-type (string)

The user type.

Possible values:

  • PrivateUser

  • SharedDevice

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


To invite users to join Amazon Chime

The following invite-users example sends an email to invite a user to the specified Amazon Chime account.

aws chime invite-users \
    --account-id a1b2c3d4-5678-90ab-cdef-11111EXAMPLE \
    --user-email-list "alejandror@example.com" "janed@example.com"


    "Invites": [
            "InviteId": "a1b2c3d4-5678-90ab-cdef-22222EXAMPLE",
            "Status": "Pending",
            "EmailAddress": "alejandror@example.com",
            "EmailStatus": "Sent"
            "InviteId": "a1b2c3d4-5678-90ab-cdef-33333EXAMPLE",
            "Status": "Pending",
            "EmailAddress": "janed@example.com",
            "EmailStatus": "Sent"

For more information, see Inviting and Suspending Users in the Amazon Chime Administration Guide.


Invites -> (list)

The email invitation details.


Invitation object returned after emailing users to invite them to join the Amazon Chime Team account.

InviteId -> (string)

The invite ID.

Status -> (string)

The status of the invite.

EmailAddress -> (string)

The email address to which the invite is sent.

EmailStatus -> (string)

The status of the invite email.