:doc:`Chime <../../chime>` / Client / invite_users

************
invite_users
************



.. py:method:: 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 <https://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/InviteUsers>`_  


  **Request Syntax**
  ::

    response = client.invite_users(
        AccountId='string',
        UserEmailList=[
            'string',
        ],
        UserType='PrivateUser'|'SharedDevice'
    )
    
  :type AccountId: string
  :param AccountId: **[REQUIRED]** 

    The Amazon Chime account ID.

    

  
  :type UserEmailList: list
  :param UserEmailList: **[REQUIRED]** 

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

    

  
    - *(string) --* 

    

  :type UserType: string
  :param UserType: 

    The user type.

    

  
  
  :rtype: 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**
  
  *   :py:class:`Chime.Client.exceptions.UnauthorizedClientException`

  
  *   :py:class:`Chime.Client.exceptions.NotFoundException`

  
  *   :py:class:`Chime.Client.exceptions.ForbiddenException`

  
  *   :py:class:`Chime.Client.exceptions.BadRequestException`

  
  *   :py:class:`Chime.Client.exceptions.ThrottledClientException`

  
  *   :py:class:`Chime.Client.exceptions.ServiceUnavailableException`

  
  *   :py:class:`Chime.Client.exceptions.ServiceFailureException`

  