Chime / Client / invite_users

invite_users#

Chime.Client.invite_users(**kwargs)#

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

Request Syntax

response = client.invite_users(
    AccountId='string',
    UserEmailList=[
        'string',
    ],
    UserType='PrivateUser'|'SharedDevice'
)
Parameters:

  • AccountId (string) –

    [REQUIRED]

    The Amazon Chime account ID.

  • UserEmailList (list) –

    [REQUIRED]

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

    • (string) –

  • UserType (string) – The user type.

Return type:

dict

Returns:

Response Syntax

{
    'Invites': [
        {
            'InviteId': 'string',
            'Status': 'Pending'|'Accepted'|'Failed',
            'EmailAddress': 'string',
            'EmailStatus': 'NotSent'|'Sent'|'Failed'
        },
    ]
}

Response Structure

  • (dict) –

    • Invites (list) –

      The email invitation details.

      • (dict) –

        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.

Exceptions

  • Chime.Client.exceptions.UnauthorizedClientException

  • Chime.Client.exceptions.NotFoundException

  • Chime.Client.exceptions.ForbiddenException

  • Chime.Client.exceptions.BadRequestException

  • Chime.Client.exceptions.ThrottledClientException

  • Chime.Client.exceptions.ServiceUnavailableException

  • Chime.Client.exceptions.ServiceFailureException