:doc:`ChimeSDKIdentity <../../chime-sdk-identity>` / Client / create_app_instance_user

************************
create_app_instance_user
************************



.. py:method:: ChimeSDKIdentity.Client.create_app_instance_user(**kwargs)

  

  Creates a user under an Amazon Chime ``AppInstance``. The request consists of a unique ``appInstanceUserId`` and ``Name`` for that user.

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/chime-sdk-identity-2021-04-20/CreateAppInstanceUser>`_  


  **Request Syntax**
  ::

    response = client.create_app_instance_user(
        AppInstanceArn='string',
        AppInstanceUserId='string',
        Name='string',
        Metadata='string',
        ClientRequestToken='string',
        Tags=[
            {
                'Key': 'string',
                'Value': 'string'
            },
        ],
        ExpirationSettings={
            'ExpirationDays': 123,
            'ExpirationCriterion': 'CREATED_TIMESTAMP'
        }
    )
    
  :type AppInstanceArn: string
  :param AppInstanceArn: **[REQUIRED]** 

    The ARN of the ``AppInstance`` request.

    

  
  :type AppInstanceUserId: string
  :param AppInstanceUserId: **[REQUIRED]** 

    The user ID of the ``AppInstance``.

    

  
  :type Name: string
  :param Name: **[REQUIRED]** 

    The user's name.

    

  
  :type Metadata: string
  :param Metadata: 

    The request's metadata. Limited to a 1KB string in UTF-8.

    

  
  :type ClientRequestToken: string
  :param ClientRequestToken: **[REQUIRED]** 

    The unique ID of the request. Use different tokens to request additional ``AppInstances``.

    This field is autopopulated if not provided.

  
  :type Tags: list
  :param Tags: 

    Tags assigned to the ``AppInstanceUser``.

    

  
    - *(dict) --* 

      A tag object containing a key-value pair.

      

    
      - **Key** *(string) --* **[REQUIRED]** 

        The key in a tag.

        

      
      - **Value** *(string) --* **[REQUIRED]** 

        The value in a tag.

        

      
    

  :type ExpirationSettings: dict
  :param ExpirationSettings: 

    Settings that control the interval after which the ``AppInstanceUser`` is automatically deleted.

    

  
    - **ExpirationDays** *(integer) --* **[REQUIRED]** 

      The period in days after which an ``AppInstanceUser`` will be automatically deleted.

      

    
    - **ExpirationCriterion** *(string) --* **[REQUIRED]** 

      Specifies the conditions under which an ``AppInstanceUser`` will expire.

      

    
  
  
  :rtype: dict
  :returns: 
    
    **Response Syntax**

    
    ::

      {
          'AppInstanceUserArn': 'string'
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

      - **AppInstanceUserArn** *(string) --* 

        The user's ARN.

        
  
  **Exceptions**
  
  *   :py:class:`ChimeSDKIdentity.Client.exceptions.BadRequestException`

  
  *   :py:class:`ChimeSDKIdentity.Client.exceptions.ConflictException`

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

  
  *   :py:class:`ChimeSDKIdentity.Client.exceptions.ResourceLimitExceededException`

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

  
  *   :py:class:`ChimeSDKIdentity.Client.exceptions.UnauthorizedClientException`

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

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

  