ChimeSDKIdentity
****************


Client
======

class ChimeSDKIdentity.Client

   A low-level client representing Amazon Chime SDK Identity

   The Amazon Chime SDK Identity APIs in this section allow software
   developers to create and manage unique instances of their messaging
   applications. These APIs provide the overarching framework for
   creating and sending messages. For more information about the
   identity APIs, refer to Amazon Chime SDK identity.

      import boto3

      client = boto3.client('chime-sdk-identity')

These are the available methods:

* can_paginate

* close

* create_app_instance

* create_app_instance_admin

* create_app_instance_bot

* create_app_instance_user

* delete_app_instance

* delete_app_instance_admin

* delete_app_instance_bot

* delete_app_instance_user

* deregister_app_instance_user_endpoint

* describe_app_instance

* describe_app_instance_admin

* describe_app_instance_bot

* describe_app_instance_user

* describe_app_instance_user_endpoint

* get_app_instance_retention_settings

* get_paginator

* get_waiter

* list_app_instance_admins

* list_app_instance_bots

* list_app_instance_user_endpoints

* list_app_instance_users

* list_app_instances

* list_tags_for_resource

* put_app_instance_retention_settings

* put_app_instance_user_expiration_settings

* register_app_instance_user_endpoint

* tag_resource

* untag_resource

* update_app_instance

* update_app_instance_bot

* update_app_instance_user

* update_app_instance_user_endpoint
ChimeSDKIdentity / Client / get_paginator


get_paginator
*************

ChimeSDKIdentity.Client.get_paginator(operation_name)

   Create a paginator for an operation.

   Parameters:
      **operation_name** (*string*) -- The operation name.  This is
      the same name as the method name on the client.  For example, if
      the method name is "create_foo", and you'd normally invoke the
      operation as "client.create_foo(**kwargs)", if the "create_foo"
      operation can be paginated, you can use the call
      "client.get_paginator("create_foo")".

   Raises:
      **OperationNotPageableError** -- Raised if the operation is not
      pageable.  You can use the "client.can_paginate" method to check
      if an operation is pageable.

   Return type:
      "botocore.paginate.Paginator"

   Returns:
      A paginator object.
ChimeSDKIdentity / Client / register_app_instance_user_endpoint


register_app_instance_user_endpoint
***********************************

ChimeSDKIdentity.Client.register_app_instance_user_endpoint(**kwargs)

   Registers an endpoint under an Amazon Chime "AppInstanceUser". The
   endpoint receives messages for a user. For push notifications, the
   endpoint is a mobile device used to receive mobile push
   notifications for a user.

   See also: AWS API Documentation

   **Request Syntax**

      response = client.register_app_instance_user_endpoint(
          AppInstanceUserArn='string',
          Name='string',
          Type='APNS'|'APNS_SANDBOX'|'GCM',
          ResourceArn='string',
          EndpointAttributes={
              'DeviceToken': 'string',
              'VoipDeviceToken': 'string'
          },
          ClientRequestToken='string',
          AllowMessages='ALL'|'NONE'
      )

   Parameters:
      * **AppInstanceUserArn** (*string*) --

        **[REQUIRED]**

        The ARN of the "AppInstanceUser".

      * **Name** (*string*) -- The name of the
        "AppInstanceUserEndpoint".

      * **Type** (*string*) --

        **[REQUIRED]**

        The type of the "AppInstanceUserEndpoint". Supported types:

        * "APNS": The mobile notification service for an Apple device.

        * "APNS_SANDBOX": The sandbox environment of the mobile
          notification service for an Apple device.

        * "GCM": The mobile notification service for an Android
          device.

        Populate the "ResourceArn" value of each type as
        "PinpointAppArn".

      * **ResourceArn** (*string*) --

        **[REQUIRED]**

        The ARN of the resource to which the endpoint belongs.

      * **EndpointAttributes** (*dict*) --

        **[REQUIRED]**

        The attributes of an "Endpoint".

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

          The device token for the GCM, APNS, and APNS_SANDBOX
          endpoint types.

        * **VoipDeviceToken** *(string) --*

          The VOIP device token for the APNS and APNS_SANDBOX endpoint
          types.

      * **ClientRequestToken** (*string*) --

        **[REQUIRED]**

        The unique ID assigned to the request. Use different tokens to
        register other endpoints.

        This field is autopopulated if not provided.

      * **AllowMessages** (*string*) -- Boolean that controls whether
        the AppInstanceUserEndpoint is opted in to receive messages.
        "ALL" indicates the endpoint receives all messages. "NONE"
        indicates the endpoint receives no messages.

   Return type:
      dict

   Returns:
      **Response Syntax**

         {
             'AppInstanceUserArn': 'string',
             'EndpointId': 'string'
         }

      **Response Structure**

      * *(dict) --*

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

          The ARN of the "AppInstanceUser".

        * **EndpointId** *(string) --*

          The unique identifier of the "AppInstanceUserEndpoint".

   **Exceptions**

   * "ChimeSDKIdentity.Client.exceptions.BadRequestException"

   * "ChimeSDKIdentity.Client.exceptions.ConflictException"

   * "ChimeSDKIdentity.Client.exceptions.ForbiddenException"

   * "ChimeSDKIdentity.Client.exceptions.ResourceLimitExceededExcepti
     on"

   * "ChimeSDKIdentity.Client.exceptions.ThrottledClientException"

   * "ChimeSDKIdentity.Client.exceptions.UnauthorizedClientException"

   * "ChimeSDKIdentity.Client.exceptions.ServiceUnavailableException"

   * "ChimeSDKIdentity.Client.exceptions.ServiceFailureException"
ChimeSDKIdentity / Client / delete_app_instance_user


delete_app_instance_user
************************

ChimeSDKIdentity.Client.delete_app_instance_user(**kwargs)

   Deletes an "AppInstanceUser".

   See also: AWS API Documentation

   **Request Syntax**

      response = client.delete_app_instance_user(
          AppInstanceUserArn='string'
      )

   Parameters:
      **AppInstanceUserArn** (*string*) --

      **[REQUIRED]**

      The ARN of the user request being deleted.

   Returns:
      None

   **Exceptions**

   * "ChimeSDKIdentity.Client.exceptions.BadRequestException"

   * "ChimeSDKIdentity.Client.exceptions.ConflictException"

   * "ChimeSDKIdentity.Client.exceptions.ForbiddenException"

   * "ChimeSDKIdentity.Client.exceptions.ResourceLimitExceededExcepti
     on"

   * "ChimeSDKIdentity.Client.exceptions.ThrottledClientException"

   * "ChimeSDKIdentity.Client.exceptions.UnauthorizedClientException"

   * "ChimeSDKIdentity.Client.exceptions.ServiceUnavailableException"

   * "ChimeSDKIdentity.Client.exceptions.ServiceFailureException"
ChimeSDKIdentity / Client / update_app_instance_user_endpoint


update_app_instance_user_endpoint
*********************************

ChimeSDKIdentity.Client.update_app_instance_user_endpoint(**kwargs)

   Updates the details of an "AppInstanceUserEndpoint". You can update
   the name and "AllowMessage" values.

   See also: AWS API Documentation

   **Request Syntax**

      response = client.update_app_instance_user_endpoint(
          AppInstanceUserArn='string',
          EndpointId='string',
          Name='string',
          AllowMessages='ALL'|'NONE'
      )

   Parameters:
      * **AppInstanceUserArn** (*string*) --

        **[REQUIRED]**

        The ARN of the "AppInstanceUser".

      * **EndpointId** (*string*) --

        **[REQUIRED]**

        The unique identifier of the "AppInstanceUserEndpoint".

      * **Name** (*string*) -- The name of the
        "AppInstanceUserEndpoint".

      * **AllowMessages** (*string*) -- Boolean that controls whether
        the "AppInstanceUserEndpoint" is opted in to receive messages.
        "ALL" indicates the endpoint will receive all messages. "NONE"
        indicates the endpoint will receive no messages.

   Return type:
      dict

   Returns:
      **Response Syntax**

         {
             'AppInstanceUserArn': 'string',
             'EndpointId': 'string'
         }

      **Response Structure**

      * *(dict) --*

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

          The ARN of the "AppInstanceUser".

        * **EndpointId** *(string) --*

          The unique identifier of the "AppInstanceUserEndpoint".

   **Exceptions**

   * "ChimeSDKIdentity.Client.exceptions.BadRequestException"

   * "ChimeSDKIdentity.Client.exceptions.ConflictException"

   * "ChimeSDKIdentity.Client.exceptions.ForbiddenException"

   * "ChimeSDKIdentity.Client.exceptions.ThrottledClientException"

   * "ChimeSDKIdentity.Client.exceptions.UnauthorizedClientException"

   * "ChimeSDKIdentity.Client.exceptions.ServiceUnavailableException"

   * "ChimeSDKIdentity.Client.exceptions.ServiceFailureException"
ChimeSDKIdentity / Client / get_app_instance_retention_settings


get_app_instance_retention_settings
***********************************

ChimeSDKIdentity.Client.get_app_instance_retention_settings(**kwargs)

   Gets the retention settings for an "AppInstance".

   See also: AWS API Documentation

   **Request Syntax**

      response = client.get_app_instance_retention_settings(
          AppInstanceArn='string'
      )

   Parameters:
      **AppInstanceArn** (*string*) --

      **[REQUIRED]**

      The ARN of the "AppInstance".

   Return type:
      dict

   Returns:
      **Response Syntax**

         {
             'AppInstanceRetentionSettings': {
                 'ChannelRetentionSettings': {
                     'RetentionDays': 123
                 }
             },
             'InitiateDeletionTimestamp': datetime(2015, 1, 1)
         }

      **Response Structure**

      * *(dict) --*

        * **AppInstanceRetentionSettings** *(dict) --*

          The retention settings for the "AppInstance".

          * **ChannelRetentionSettings** *(dict) --*

            The length of time in days to retain the messages in a
            channel.

            * **RetentionDays** *(integer) --*

              The time in days to retain the messages in a channel.

        * **InitiateDeletionTimestamp** *(datetime) --*

          The timestamp representing the time at which the specified
          items are retained, in Epoch Seconds.

   **Exceptions**

   * "ChimeSDKIdentity.Client.exceptions.BadRequestException"

   * "ChimeSDKIdentity.Client.exceptions.ForbiddenException"

   * "ChimeSDKIdentity.Client.exceptions.ThrottledClientException"

   * "ChimeSDKIdentity.Client.exceptions.UnauthorizedClientException"

   * "ChimeSDKIdentity.Client.exceptions.ServiceUnavailableException"

   * "ChimeSDKIdentity.Client.exceptions.ServiceFailureException"
ChimeSDKIdentity / Client / can_paginate


can_paginate
************

ChimeSDKIdentity.Client.can_paginate(operation_name)

   Check if an operation can be paginated.

   Parameters:
      **operation_name** (*string*) -- The operation name.  This is
      the same name as the method name on the client.  For example, if
      the method name is "create_foo", and you'd normally invoke the
      operation as "client.create_foo(**kwargs)", if the "create_foo"
      operation can be paginated, you can use the call
      "client.get_paginator("create_foo")".

   Returns:
      "True" if the operation can be paginated, "False" otherwise.
ChimeSDKIdentity / Client / list_app_instance_users


list_app_instance_users
***********************

ChimeSDKIdentity.Client.list_app_instance_users(**kwargs)

   List all "AppInstanceUsers" created under a single "AppInstance".

   See also: AWS API Documentation

   **Request Syntax**

      response = client.list_app_instance_users(
          AppInstanceArn='string',
          MaxResults=123,
          NextToken='string'
      )

   Parameters:
      * **AppInstanceArn** (*string*) --

        **[REQUIRED]**

        The ARN of the "AppInstance".

      * **MaxResults** (*integer*) -- The maximum number of requests
        that you want returned.

      * **NextToken** (*string*) -- The token passed by previous API
        calls until all requested users are returned.

   Return type:
      dict

   Returns:
      **Response Syntax**

         {
             'AppInstanceArn': 'string',
             'AppInstanceUsers': [
                 {
                     'AppInstanceUserArn': 'string',
                     'Name': 'string',
                     'Metadata': 'string'
                 },
             ],
             'NextToken': 'string'
         }

      **Response Structure**

      * *(dict) --*

        * **AppInstanceArn** *(string) --*

          The ARN of the "AppInstance".

        * **AppInstanceUsers** *(list) --*

          The information for each requested "AppInstanceUser".

          * *(dict) --*

            Summary of the details of an "AppInstanceUser".

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

              The ARN of the "AppInstanceUser".

            * **Name** *(string) --*

              The name of an "AppInstanceUser".

            * **Metadata** *(string) --*

              The metadata of the "AppInstanceUser".

        * **NextToken** *(string) --*

          The token passed by previous API calls until all requested
          users are returned.

   **Exceptions**

   * "ChimeSDKIdentity.Client.exceptions.BadRequestException"

   * "ChimeSDKIdentity.Client.exceptions.ForbiddenException"

   * "ChimeSDKIdentity.Client.exceptions.ThrottledClientException"

   * "ChimeSDKIdentity.Client.exceptions.UnauthorizedClientException"

   * "ChimeSDKIdentity.Client.exceptions.ServiceUnavailableException"

   * "ChimeSDKIdentity.Client.exceptions.ServiceFailureException"
ChimeSDKIdentity / Client / list_app_instance_admins


list_app_instance_admins
************************

ChimeSDKIdentity.Client.list_app_instance_admins(**kwargs)

   Returns a list of the administrators in the "AppInstance".

   See also: AWS API Documentation

   **Request Syntax**

      response = client.list_app_instance_admins(
          AppInstanceArn='string',
          MaxResults=123,
          NextToken='string'
      )

   Parameters:
      * **AppInstanceArn** (*string*) --

        **[REQUIRED]**

        The ARN of the "AppInstance".

      * **MaxResults** (*integer*) -- The maximum number of
        administrators that you want to return.

      * **NextToken** (*string*) -- The token returned from previous
        API requests until the number of administrators is reached.

   Return type:
      dict

   Returns:
      **Response Syntax**

         {
             'AppInstanceArn': 'string',
             'AppInstanceAdmins': [
                 {
                     'Admin': {
                         'Arn': 'string',
                         'Name': 'string'
                     }
                 },
             ],
             'NextToken': 'string'
         }

      **Response Structure**

      * *(dict) --*

        * **AppInstanceArn** *(string) --*

          The ARN of the "AppInstance".

        * **AppInstanceAdmins** *(list) --*

          The information for each administrator.

          * *(dict) --*

            Summary of the details of an "AppInstanceAdmin".

            * **Admin** *(dict) --*

              The details of the "AppInstanceAdmin".

              * **Arn** *(string) --*

                The ARN in an Identity.

              * **Name** *(string) --*

                The name in an Identity.

        * **NextToken** *(string) --*

          The token returned from previous API requests until the
          number of administrators is reached.

   **Exceptions**

   * "ChimeSDKIdentity.Client.exceptions.BadRequestException"

   * "ChimeSDKIdentity.Client.exceptions.ForbiddenException"

   * "ChimeSDKIdentity.Client.exceptions.ResourceLimitExceededExcepti
     on"

   * "ChimeSDKIdentity.Client.exceptions.ThrottledClientException"

   * "ChimeSDKIdentity.Client.exceptions.UnauthorizedClientException"

   * "ChimeSDKIdentity.Client.exceptions.ServiceUnavailableException"

   * "ChimeSDKIdentity.Client.exceptions.ServiceFailureException"
ChimeSDKIdentity / Client / deregister_app_instance_user_endpoint


deregister_app_instance_user_endpoint
*************************************

ChimeSDKIdentity.Client.deregister_app_instance_user_endpoint(**kwargs)

   Deregisters an "AppInstanceUserEndpoint".

   See also: AWS API Documentation

   **Request Syntax**

      response = client.deregister_app_instance_user_endpoint(
          AppInstanceUserArn='string',
          EndpointId='string'
      )

   Parameters:
      * **AppInstanceUserArn** (*string*) --

        **[REQUIRED]**

        The ARN of the "AppInstanceUser".

      * **EndpointId** (*string*) --

        **[REQUIRED]**

        The unique identifier of the "AppInstanceUserEndpoint".

   Returns:
      None

   **Exceptions**

   * "ChimeSDKIdentity.Client.exceptions.BadRequestException"

   * "ChimeSDKIdentity.Client.exceptions.ForbiddenException"

   * "ChimeSDKIdentity.Client.exceptions.ThrottledClientException"

   * "ChimeSDKIdentity.Client.exceptions.UnauthorizedClientException"

   * "ChimeSDKIdentity.Client.exceptions.ServiceUnavailableException"

   * "ChimeSDKIdentity.Client.exceptions.ServiceFailureException"
ChimeSDKIdentity / Client / delete_app_instance_admin


delete_app_instance_admin
*************************

ChimeSDKIdentity.Client.delete_app_instance_admin(**kwargs)

   Demotes an "AppInstanceAdmin" to an "AppInstanceUser" or
   "AppInstanceBot". This action does not delete the user.

   See also: AWS API Documentation

   **Request Syntax**

      response = client.delete_app_instance_admin(
          AppInstanceAdminArn='string',
          AppInstanceArn='string'
      )

   Parameters:
      * **AppInstanceAdminArn** (*string*) --

        **[REQUIRED]**

        The ARN of the "AppInstance"'s administrator.

      * **AppInstanceArn** (*string*) --

        **[REQUIRED]**

        The ARN of the "AppInstance".

   Returns:
      None

   **Exceptions**

   * "ChimeSDKIdentity.Client.exceptions.BadRequestException"

   * "ChimeSDKIdentity.Client.exceptions.ConflictException"

   * "ChimeSDKIdentity.Client.exceptions.ForbiddenException"

   * "ChimeSDKIdentity.Client.exceptions.ResourceLimitExceededExcepti
     on"

   * "ChimeSDKIdentity.Client.exceptions.ThrottledClientException"

   * "ChimeSDKIdentity.Client.exceptions.UnauthorizedClientException"

   * "ChimeSDKIdentity.Client.exceptions.ServiceUnavailableException"

   * "ChimeSDKIdentity.Client.exceptions.ServiceFailureException"
ChimeSDKIdentity / Client / put_app_instance_user_expiration_settings


put_app_instance_user_expiration_settings
*****************************************

ChimeSDKIdentity.Client.put_app_instance_user_expiration_settings(**kwargs)

   Sets the number of days before the "AppInstanceUser" is
   automatically deleted.

   Note:

     A background process deletes expired "AppInstanceUsers" within 6
     hours of expiration. Actual deletion times may vary.Expired
     "AppInstanceUsers" that have not yet been deleted appear as
     active, and you can update their expiration settings. The system
     honors the new settings.

   See also: AWS API Documentation

   **Request Syntax**

      response = client.put_app_instance_user_expiration_settings(
          AppInstanceUserArn='string',
          ExpirationSettings={
              'ExpirationDays': 123,
              'ExpirationCriterion': 'CREATED_TIMESTAMP'
          }
      )

   Parameters:
      * **AppInstanceUserArn** (*string*) --

        **[REQUIRED]**

        The ARN of the "AppInstanceUser".

      * **ExpirationSettings** (*dict*) --

        Settings that control the interval after which an
        "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.

   Return type:
      dict

   Returns:
      **Response Syntax**

         {
             'AppInstanceUserArn': 'string',
             'ExpirationSettings': {
                 'ExpirationDays': 123,
                 'ExpirationCriterion': 'CREATED_TIMESTAMP'
             }
         }

      **Response Structure**

      * *(dict) --*

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

          The ARN of the "AppInstanceUser".

        * **ExpirationSettings** *(dict) --*

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

          * **ExpirationDays** *(integer) --*

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

          * **ExpirationCriterion** *(string) --*

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

   **Exceptions**

   * "ChimeSDKIdentity.Client.exceptions.BadRequestException"

   * "ChimeSDKIdentity.Client.exceptions.ConflictException"

   * "ChimeSDKIdentity.Client.exceptions.ForbiddenException"

   * "ChimeSDKIdentity.Client.exceptions.ThrottledClientException"

   * "ChimeSDKIdentity.Client.exceptions.UnauthorizedClientException"

   * "ChimeSDKIdentity.Client.exceptions.ServiceUnavailableException"

   * "ChimeSDKIdentity.Client.exceptions.ServiceFailureException"
ChimeSDKIdentity / Client / describe_app_instance_admin


describe_app_instance_admin
***************************

ChimeSDKIdentity.Client.describe_app_instance_admin(**kwargs)

   Returns the full details of an "AppInstanceAdmin".

   See also: AWS API Documentation

   **Request Syntax**

      response = client.describe_app_instance_admin(
          AppInstanceAdminArn='string',
          AppInstanceArn='string'
      )

   Parameters:
      * **AppInstanceAdminArn** (*string*) --

        **[REQUIRED]**

        The ARN of the "AppInstanceAdmin".

      * **AppInstanceArn** (*string*) --

        **[REQUIRED]**

        The ARN of the "AppInstance".

   Return type:
      dict

   Returns:
      **Response Syntax**

         {
             'AppInstanceAdmin': {
                 'Admin': {
                     'Arn': 'string',
                     'Name': 'string'
                 },
                 'AppInstanceArn': 'string',
                 'CreatedTimestamp': datetime(2015, 1, 1)
             }
         }

      **Response Structure**

      * *(dict) --*

        * **AppInstanceAdmin** *(dict) --*

          The ARN and name of the "AppInstanceUser", the ARN of the
          "AppInstance", and the created and last-updated timestamps.
          All timestamps use epoch milliseconds.

          * **Admin** *(dict) --*

            The "AppInstanceAdmin" data.

            * **Arn** *(string) --*

              The ARN in an Identity.

            * **Name** *(string) --*

              The name in an Identity.

          * **AppInstanceArn** *(string) --*

            The ARN of the "AppInstance" for which the user is an
            administrator.

          * **CreatedTimestamp** *(datetime) --*

            The time at which an administrator was created.

   **Exceptions**

   * "ChimeSDKIdentity.Client.exceptions.BadRequestException"

   * "ChimeSDKIdentity.Client.exceptions.ForbiddenException"

   * "ChimeSDKIdentity.Client.exceptions.ThrottledClientException"

   * "ChimeSDKIdentity.Client.exceptions.UnauthorizedClientException"

   * "ChimeSDKIdentity.Client.exceptions.ServiceUnavailableException"

   * "ChimeSDKIdentity.Client.exceptions.ServiceFailureException"
ChimeSDKIdentity / Client / list_tags_for_resource


list_tags_for_resource
**********************

ChimeSDKIdentity.Client.list_tags_for_resource(**kwargs)

   Lists the tags applied to an Amazon Chime SDK identity resource.

   See also: AWS API Documentation

   **Request Syntax**

      response = client.list_tags_for_resource(
          ResourceARN='string'
      )

   Parameters:
      **ResourceARN** (*string*) --

      **[REQUIRED]**

      The ARN of the resource.

   Return type:
      dict

   Returns:
      **Response Syntax**

         {
             'Tags': [
                 {
                     'Key': 'string',
                     'Value': 'string'
                 },
             ]
         }

      **Response Structure**

      * *(dict) --*

        * **Tags** *(list) --*

          The tag key-value pairs.

          * *(dict) --*

            A tag object containing a key-value pair.

            * **Key** *(string) --*

              The key in a tag.

            * **Value** *(string) --*

              The value in a tag.

   **Exceptions**

   * "ChimeSDKIdentity.Client.exceptions.BadRequestException"

   * "ChimeSDKIdentity.Client.exceptions.ForbiddenException"

   * "ChimeSDKIdentity.Client.exceptions.UnauthorizedClientException"

   * "ChimeSDKIdentity.Client.exceptions.ThrottledClientException"

   * "ChimeSDKIdentity.Client.exceptions.ServiceUnavailableException"

   * "ChimeSDKIdentity.Client.exceptions.ServiceFailureException"
ChimeSDKIdentity / Client / untag_resource


untag_resource
**************

ChimeSDKIdentity.Client.untag_resource(**kwargs)

   Removes the specified tags from the specified Amazon Chime SDK
   identity resource.

   See also: AWS API Documentation

   **Request Syntax**

      response = client.untag_resource(
          ResourceARN='string',
          TagKeys=[
              'string',
          ]
      )

   Parameters:
      * **ResourceARN** (*string*) --

        **[REQUIRED]**

        The resource ARN.

      * **TagKeys** (*list*) --

        **[REQUIRED]**

        The tag keys.

        * *(string) --*

   Returns:
      None

   **Exceptions**

   * "ChimeSDKIdentity.Client.exceptions.BadRequestException"

   * "ChimeSDKIdentity.Client.exceptions.ForbiddenException"

   * "ChimeSDKIdentity.Client.exceptions.UnauthorizedClientException"

   * "ChimeSDKIdentity.Client.exceptions.ThrottledClientException"

   * "ChimeSDKIdentity.Client.exceptions.ServiceUnavailableException"

   * "ChimeSDKIdentity.Client.exceptions.ServiceFailureException"
ChimeSDKIdentity / Client / create_app_instance_admin


create_app_instance_admin
*************************

ChimeSDKIdentity.Client.create_app_instance_admin(**kwargs)

   Promotes an "AppInstanceUser" or "AppInstanceBot" to an
   "AppInstanceAdmin". The promoted entity can perform the following
   actions.

   * "ChannelModerator" actions across all channels in the
     "AppInstance".

   * "DeleteChannelMessage" actions.

   Only an "AppInstanceUser" and "AppInstanceBot" can be promoted to
   an "AppInstanceAdmin" role.

   See also: AWS API Documentation

   **Request Syntax**

      response = client.create_app_instance_admin(
          AppInstanceAdminArn='string',
          AppInstanceArn='string'
      )

   Parameters:
      * **AppInstanceAdminArn** (*string*) --

        **[REQUIRED]**

        The ARN of the administrator of the current "AppInstance".

      * **AppInstanceArn** (*string*) --

        **[REQUIRED]**

        The ARN of the "AppInstance".

   Return type:
      dict

   Returns:
      **Response Syntax**

         {
             'AppInstanceAdmin': {
                 'Arn': 'string',
                 'Name': 'string'
             },
             'AppInstanceArn': 'string'
         }

      **Response Structure**

      * *(dict) --*

        * **AppInstanceAdmin** *(dict) --*

          The ARN and name of the administrator, the ARN of the
          "AppInstance", and the created and last-updated timestamps.
          All timestamps use epoch milliseconds.

          * **Arn** *(string) --*

            The ARN in an Identity.

          * **Name** *(string) --*

            The name in an Identity.

        * **AppInstanceArn** *(string) --*

          The ARN of the of the admin for the "AppInstance".

   **Exceptions**

   * "ChimeSDKIdentity.Client.exceptions.BadRequestException"

   * "ChimeSDKIdentity.Client.exceptions.ConflictException"

   * "ChimeSDKIdentity.Client.exceptions.ForbiddenException"

   * "ChimeSDKIdentity.Client.exceptions.ResourceLimitExceededExcepti
     on"

   * "ChimeSDKIdentity.Client.exceptions.ThrottledClientException"

   * "ChimeSDKIdentity.Client.exceptions.UnauthorizedClientException"

   * "ChimeSDKIdentity.Client.exceptions.ServiceUnavailableException"

   * "ChimeSDKIdentity.Client.exceptions.ServiceFailureException"
ChimeSDKIdentity / Client / get_waiter


get_waiter
**********

ChimeSDKIdentity.Client.get_waiter(waiter_name)

   Returns an object that can wait for some condition.

   Parameters:
      **waiter_name** (*str*) -- The name of the waiter to get. See
      the waiters section of the service docs for a list of available
      waiters.

   Returns:
      The specified waiter object.

   Return type:
      "botocore.waiter.Waiter"
ChimeSDKIdentity / Client / delete_app_instance


delete_app_instance
*******************

ChimeSDKIdentity.Client.delete_app_instance(**kwargs)

   Deletes an "AppInstance" and all associated data asynchronously.

   See also: AWS API Documentation

   **Request Syntax**

      response = client.delete_app_instance(
          AppInstanceArn='string'
      )

   Parameters:
      **AppInstanceArn** (*string*) --

      **[REQUIRED]**

      The ARN of the "AppInstance".

   Returns:
      None

   **Exceptions**

   * "ChimeSDKIdentity.Client.exceptions.BadRequestException"

   * "ChimeSDKIdentity.Client.exceptions.ForbiddenException"

   * "ChimeSDKIdentity.Client.exceptions.ResourceLimitExceededExcepti
     on"

   * "ChimeSDKIdentity.Client.exceptions.ThrottledClientException"

   * "ChimeSDKIdentity.Client.exceptions.UnauthorizedClientException"

   * "ChimeSDKIdentity.Client.exceptions.ServiceUnavailableException"

   * "ChimeSDKIdentity.Client.exceptions.ServiceFailureException"
ChimeSDKIdentity / Client / describe_app_instance_user


describe_app_instance_user
**************************

ChimeSDKIdentity.Client.describe_app_instance_user(**kwargs)

   Returns the full details of an "AppInstanceUser".

   See also: AWS API Documentation

   **Request Syntax**

      response = client.describe_app_instance_user(
          AppInstanceUserArn='string'
      )

   Parameters:
      **AppInstanceUserArn** (*string*) --

      **[REQUIRED]**

      The ARN of the "AppInstanceUser".

   Return type:
      dict

   Returns:
      **Response Syntax**

         {
             'AppInstanceUser': {
                 'AppInstanceUserArn': 'string',
                 'Name': 'string',
                 'Metadata': 'string',
                 'CreatedTimestamp': datetime(2015, 1, 1),
                 'LastUpdatedTimestamp': datetime(2015, 1, 1),
                 'ExpirationSettings': {
                     'ExpirationDays': 123,
                     'ExpirationCriterion': 'CREATED_TIMESTAMP'
                 }
             }
         }

      **Response Structure**

      * *(dict) --*

        * **AppInstanceUser** *(dict) --*

          The name of the "AppInstanceUser".

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

            The ARN of the "AppInstanceUser".

          * **Name** *(string) --*

            The name of the "AppInstanceUser".

          * **Metadata** *(string) --*

            The metadata of the "AppInstanceUser".

          * **CreatedTimestamp** *(datetime) --*

            The time at which the "AppInstanceUser" was created.

          * **LastUpdatedTimestamp** *(datetime) --*

            The time at which the "AppInstanceUser" was last updated.

          * **ExpirationSettings** *(dict) --*

            The interval after which an "AppInstanceUser" is
            automatically deleted.

            * **ExpirationDays** *(integer) --*

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

            * **ExpirationCriterion** *(string) --*

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

   **Exceptions**

   * "ChimeSDKIdentity.Client.exceptions.BadRequestException"

   * "ChimeSDKIdentity.Client.exceptions.ForbiddenException"

   * "ChimeSDKIdentity.Client.exceptions.ThrottledClientException"

   * "ChimeSDKIdentity.Client.exceptions.UnauthorizedClientException"

   * "ChimeSDKIdentity.Client.exceptions.ServiceUnavailableException"

   * "ChimeSDKIdentity.Client.exceptions.ServiceFailureException"
ChimeSDKIdentity / Client / list_app_instance_user_endpoints


list_app_instance_user_endpoints
********************************

ChimeSDKIdentity.Client.list_app_instance_user_endpoints(**kwargs)

   Lists all the "AppInstanceUserEndpoints" created under a single
   "AppInstanceUser".

   See also: AWS API Documentation

   **Request Syntax**

      response = client.list_app_instance_user_endpoints(
          AppInstanceUserArn='string',
          MaxResults=123,
          NextToken='string'
      )

   Parameters:
      * **AppInstanceUserArn** (*string*) --

        **[REQUIRED]**

        The ARN of the "AppInstanceUser".

      * **MaxResults** (*integer*) -- The maximum number of endpoints
        that you want to return.

      * **NextToken** (*string*) -- The token passed by previous API
        calls until all requested endpoints are returned.

   Return type:
      dict

   Returns:
      **Response Syntax**

         {
             'AppInstanceUserEndpoints': [
                 {
                     'AppInstanceUserArn': 'string',
                     'EndpointId': 'string',
                     'Name': 'string',
                     'Type': 'APNS'|'APNS_SANDBOX'|'GCM',
                     'AllowMessages': 'ALL'|'NONE',
                     'EndpointState': {
                         'Status': 'ACTIVE'|'INACTIVE',
                         'StatusReason': 'INVALID_DEVICE_TOKEN'|'INVALID_PINPOINT_ARN'
                     }
                 },
             ],
             'NextToken': 'string'
         }

      **Response Structure**

      * *(dict) --*

        * **AppInstanceUserEndpoints** *(list) --*

          The information for each requested
          "AppInstanceUserEndpoint".

          * *(dict) --*

            Summary of the details of an "AppInstanceUserEndpoint".

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

              The ARN of the "AppInstanceUser".

            * **EndpointId** *(string) --*

              The unique identifier of the "AppInstanceUserEndpoint".

            * **Name** *(string) --*

              The name of the "AppInstanceUserEndpoint".

            * **Type** *(string) --*

              The type of the "AppInstanceUserEndpoint".

            * **AllowMessages** *(string) --*

              BBoolean that controls whether the
              "AppInstanceUserEndpoint" is opted in to receive
              messages. "ALL" indicates the endpoint will receive all
              messages. "NONE" indicates the endpoint will receive no
              messages.

            * **EndpointState** *(dict) --*

              A read-only field that represent the state of an
              "AppInstanceUserEndpoint".

              * **Status** *(string) --*

                Enum that indicates the Status of an
                "AppInstanceUserEndpoint".

              * **StatusReason** *(string) --*

                The reason for the "EndpointStatus".

        * **NextToken** *(string) --*

          The token passed by previous API calls until all requested
          endpoints are returned.

   **Exceptions**

   * "ChimeSDKIdentity.Client.exceptions.BadRequestException"

   * "ChimeSDKIdentity.Client.exceptions.ForbiddenException"

   * "ChimeSDKIdentity.Client.exceptions.ThrottledClientException"

   * "ChimeSDKIdentity.Client.exceptions.UnauthorizedClientException"

   * "ChimeSDKIdentity.Client.exceptions.ServiceUnavailableException"

   * "ChimeSDKIdentity.Client.exceptions.ServiceFailureException"
ChimeSDKIdentity / Client / list_app_instances


list_app_instances
******************

ChimeSDKIdentity.Client.list_app_instances(**kwargs)

   Lists all Amazon Chime >>``<<AppInstance``s created under a single
   AWS account.

   See also: AWS API Documentation

   **Request Syntax**

      response = client.list_app_instances(
          MaxResults=123,
          NextToken='string'
      )

   Parameters:
      * **MaxResults** (*integer*) -- The maximum number of
        >>``<<AppInstance``s that you want to return.

      * **NextToken** (*string*) -- The token passed by previous API
        requests until you reach the maximum number of "AppInstances".

   Return type:
      dict

   Returns:
      **Response Syntax**

         {
             'AppInstances': [
                 {
                     'AppInstanceArn': 'string',
                     'Name': 'string',
                     'Metadata': 'string'
                 },
             ],
             'NextToken': 'string'
         }

      **Response Structure**

      * *(dict) --*

        * **AppInstances** *(list) --*

          The information for each "AppInstance".

          * *(dict) --*

            Summary of the data for an "AppInstance".

            * **AppInstanceArn** *(string) --*

              The "AppInstance" ARN.

            * **Name** *(string) --*

              The name of the "AppInstance".

            * **Metadata** *(string) --*

              The metadata of the "AppInstance".

        * **NextToken** *(string) --*

          The token passed by previous API requests until the maximum
          number of >>``<<AppInstance``s is reached.

   **Exceptions**

   * "ChimeSDKIdentity.Client.exceptions.BadRequestException"

   * "ChimeSDKIdentity.Client.exceptions.ForbiddenException"

   * "ChimeSDKIdentity.Client.exceptions.ThrottledClientException"

   * "ChimeSDKIdentity.Client.exceptions.UnauthorizedClientException"

   * "ChimeSDKIdentity.Client.exceptions.ServiceUnavailableException"

   * "ChimeSDKIdentity.Client.exceptions.ServiceFailureException"
ChimeSDKIdentity / Client / describe_app_instance


describe_app_instance
*********************

ChimeSDKIdentity.Client.describe_app_instance(**kwargs)

   Returns the full details of an "AppInstance".

   See also: AWS API Documentation

   **Request Syntax**

      response = client.describe_app_instance(
          AppInstanceArn='string'
      )

   Parameters:
      **AppInstanceArn** (*string*) --

      **[REQUIRED]**

      The ARN of the "AppInstance".

   Return type:
      dict

   Returns:
      **Response Syntax**

         {
             'AppInstance': {
                 'AppInstanceArn': 'string',
                 'Name': 'string',
                 'CreatedTimestamp': datetime(2015, 1, 1),
                 'LastUpdatedTimestamp': datetime(2015, 1, 1),
                 'Metadata': 'string'
             }
         }

      **Response Structure**

      * *(dict) --*

        * **AppInstance** *(dict) --*

          The ARN, metadata, created and last-updated timestamps, and
          the name of the "AppInstance". All timestamps use epoch
          milliseconds.

          * **AppInstanceArn** *(string) --*

            The ARN of the messaging instance.

          * **Name** *(string) --*

            The name of an "AppInstance".

          * **CreatedTimestamp** *(datetime) --*

            The time at which an "AppInstance" was created. In epoch
            milliseconds.

          * **LastUpdatedTimestamp** *(datetime) --*

            The time an "AppInstance" was last updated. In epoch
            milliseconds.

          * **Metadata** *(string) --*

            The metadata of an "AppInstance".

   **Exceptions**

   * "ChimeSDKIdentity.Client.exceptions.BadRequestException"

   * "ChimeSDKIdentity.Client.exceptions.ForbiddenException"

   * "ChimeSDKIdentity.Client.exceptions.ThrottledClientException"

   * "ChimeSDKIdentity.Client.exceptions.UnauthorizedClientException"

   * "ChimeSDKIdentity.Client.exceptions.ServiceUnavailableException"

   * "ChimeSDKIdentity.Client.exceptions.ServiceFailureException"
ChimeSDKIdentity / Client / create_app_instance_bot


create_app_instance_bot
***********************

ChimeSDKIdentity.Client.create_app_instance_bot(**kwargs)

   Creates a bot under an Amazon Chime "AppInstance". The request
   consists of a unique "Configuration" and "Name" for that bot.

   See also: AWS API Documentation

   **Request Syntax**

      response = client.create_app_instance_bot(
          AppInstanceArn='string',
          Name='string',
          Metadata='string',
          ClientRequestToken='string',
          Tags=[
              {
                  'Key': 'string',
                  'Value': 'string'
              },
          ],
          Configuration={
              'Lex': {
                  'RespondsTo': 'STANDARD_MESSAGES',
                  'InvokedBy': {
                      'StandardMessages': 'AUTO'|'ALL'|'MENTIONS'|'NONE',
                      'TargetedMessages': 'ALL'|'NONE'
                  },
                  'LexBotAliasArn': 'string',
                  'LocaleId': 'string',
                  'WelcomeIntent': 'string'
              }
          }
      )

   Parameters:
      * **AppInstanceArn** (*string*) --

        **[REQUIRED]**

        The ARN of the "AppInstance" request.

      * **Name** (*string*) -- The user's name.

      * **Metadata** (*string*) -- The request metadata. Limited to a
        1KB string in UTF-8.

      * **ClientRequestToken** (*string*) --

        **[REQUIRED]**

        The unique ID for the client making the request. Use different
        tokens for different "AppInstanceBots".

        This field is autopopulated if not provided.

      * **Tags** (*list*) --

        The tags assigned to the "AppInstanceBot".

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

      * **Configuration** (*dict*) --

        **[REQUIRED]**

        Configuration information about the Amazon Lex V2 V2 bot.

        * **Lex** *(dict) --* **[REQUIRED]**

          The configuration for an Amazon Lex V2 bot.

          * **RespondsTo** *(string) --*

            Warning:

              **Deprecated**. Use "InvokedBy" instead.

            Determines whether the Amazon Lex V2 bot responds to all
            standard messages. Control messages are not supported.

          * **InvokedBy** *(dict) --*

            Specifies the type of message that triggers a bot.

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

              Sets standard messages as the bot trigger. For standard
              messages:

              * "ALL": The bot processes all standard messages.

              * "AUTO": The bot responds to ALL messages when the
                channel has one other non-hidden member, and responds
                to MENTIONS when the channel has more than one other
                non-hidden member.

              * "MENTIONS": The bot processes all standard messages
                that have a message attribute with "CHIME.mentions"
                and a value of the bot ARN.

              * "NONE": The bot processes no standard messages.

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

              Sets targeted messages as the bot trigger. For targeted
              messages:

              * "ALL": The bot processes all "TargetedMessages" sent
                to it. The bot then responds with a targeted message
                back to the sender.

              * "NONE": The bot processes no targeted messages.

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

            The ARN of the Amazon Lex V2 bot's alias. The ARN uses
            this format: "arn:aws:lex:REGION:ACCOUNT:bot-
            alias/MYBOTID/MYBOTALIAS"

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

            Identifies the Amazon Lex V2 bot's language and locale.
            The string must match one of the supported locales in
            Amazon Lex V2. All of the intents, slot types, and slots
            used in the bot must have the same locale. For more
            information, see Supported languages in the *Amazon Lex V2
            Developer Guide*.

          * **WelcomeIntent** *(string) --*

            The name of the welcome intent configured in the Amazon
            Lex V2 bot.

   Return type:
      dict

   Returns:
      **Response Syntax**

         {
             'AppInstanceBotArn': 'string'
         }

      **Response Structure**

      * *(dict) --*

        * **AppInstanceBotArn** *(string) --*

          The ARN of the "AppinstanceBot".

   **Exceptions**

   * "ChimeSDKIdentity.Client.exceptions.BadRequestException"

   * "ChimeSDKIdentity.Client.exceptions.ConflictException"

   * "ChimeSDKIdentity.Client.exceptions.ForbiddenException"

   * "ChimeSDKIdentity.Client.exceptions.ResourceLimitExceededExcepti
     on"

   * "ChimeSDKIdentity.Client.exceptions.ThrottledClientException"

   * "ChimeSDKIdentity.Client.exceptions.UnauthorizedClientException"

   * "ChimeSDKIdentity.Client.exceptions.ServiceUnavailableException"

   * "ChimeSDKIdentity.Client.exceptions.ServiceFailureException"
ChimeSDKIdentity / Client / update_app_instance_bot


update_app_instance_bot
***********************

ChimeSDKIdentity.Client.update_app_instance_bot(**kwargs)

   Updates the name and metadata of an "AppInstanceBot".

   See also: AWS API Documentation

   **Request Syntax**

      response = client.update_app_instance_bot(
          AppInstanceBotArn='string',
          Name='string',
          Metadata='string',
          Configuration={
              'Lex': {
                  'RespondsTo': 'STANDARD_MESSAGES',
                  'InvokedBy': {
                      'StandardMessages': 'AUTO'|'ALL'|'MENTIONS'|'NONE',
                      'TargetedMessages': 'ALL'|'NONE'
                  },
                  'LexBotAliasArn': 'string',
                  'LocaleId': 'string',
                  'WelcomeIntent': 'string'
              }
          }
      )

   Parameters:
      * **AppInstanceBotArn** (*string*) --

        **[REQUIRED]**

        The ARN of the "AppInstanceBot".

      * **Name** (*string*) --

        **[REQUIRED]**

        The name of the "AppInstanceBot".

      * **Metadata** (*string*) --

        **[REQUIRED]**

        The metadata of the "AppInstanceBot".

      * **Configuration** (*dict*) --

        The configuration for the bot update.

        * **Lex** *(dict) --* **[REQUIRED]**

          The configuration for an Amazon Lex V2 bot.

          * **RespondsTo** *(string) --*

            Warning:

              **Deprecated**. Use "InvokedBy" instead.

            Determines whether the Amazon Lex V2 bot responds to all
            standard messages. Control messages are not supported.

          * **InvokedBy** *(dict) --*

            Specifies the type of message that triggers a bot.

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

              Sets standard messages as the bot trigger. For standard
              messages:

              * "ALL": The bot processes all standard messages.

              * "AUTO": The bot responds to ALL messages when the
                channel has one other non-hidden member, and responds
                to MENTIONS when the channel has more than one other
                non-hidden member.

              * "MENTIONS": The bot processes all standard messages
                that have a message attribute with "CHIME.mentions"
                and a value of the bot ARN.

              * "NONE": The bot processes no standard messages.

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

              Sets targeted messages as the bot trigger. For targeted
              messages:

              * "ALL": The bot processes all "TargetedMessages" sent
                to it. The bot then responds with a targeted message
                back to the sender.

              * "NONE": The bot processes no targeted messages.

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

            The ARN of the Amazon Lex V2 bot's alias. The ARN uses
            this format: "arn:aws:lex:REGION:ACCOUNT:bot-
            alias/MYBOTID/MYBOTALIAS"

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

            Identifies the Amazon Lex V2 bot's language and locale.
            The string must match one of the supported locales in
            Amazon Lex V2. All of the intents, slot types, and slots
            used in the bot must have the same locale. For more
            information, see Supported languages in the *Amazon Lex V2
            Developer Guide*.

          * **WelcomeIntent** *(string) --*

            The name of the welcome intent configured in the Amazon
            Lex V2 bot.

   Return type:
      dict

   Returns:
      **Response Syntax**

         {
             'AppInstanceBotArn': 'string'
         }

      **Response Structure**

      * *(dict) --*

        * **AppInstanceBotArn** *(string) --*

          The ARN of the "AppInstanceBot".

   **Exceptions**

   * "ChimeSDKIdentity.Client.exceptions.BadRequestException"

   * "ChimeSDKIdentity.Client.exceptions.ConflictException"

   * "ChimeSDKIdentity.Client.exceptions.ForbiddenException"

   * "ChimeSDKIdentity.Client.exceptions.ResourceLimitExceededExcepti
     on"

   * "ChimeSDKIdentity.Client.exceptions.ThrottledClientException"

   * "ChimeSDKIdentity.Client.exceptions.UnauthorizedClientException"

   * "ChimeSDKIdentity.Client.exceptions.ServiceUnavailableException"

   * "ChimeSDKIdentity.Client.exceptions.ServiceFailureException"
ChimeSDKIdentity / Client / put_app_instance_retention_settings


put_app_instance_retention_settings
***********************************

ChimeSDKIdentity.Client.put_app_instance_retention_settings(**kwargs)

   Sets the amount of time in days that a given "AppInstance" retains
   data.

   See also: AWS API Documentation

   **Request Syntax**

      response = client.put_app_instance_retention_settings(
          AppInstanceArn='string',
          AppInstanceRetentionSettings={
              'ChannelRetentionSettings': {
                  'RetentionDays': 123
              }
          }
      )

   Parameters:
      * **AppInstanceArn** (*string*) --

        **[REQUIRED]**

        The ARN of the "AppInstance".

      * **AppInstanceRetentionSettings** (*dict*) --

        **[REQUIRED]**

        The time in days to retain data. Data type: number.

        * **ChannelRetentionSettings** *(dict) --*

          The length of time in days to retain the messages in a
          channel.

          * **RetentionDays** *(integer) --*

            The time in days to retain the messages in a channel.

   Return type:
      dict

   Returns:
      **Response Syntax**

         {
             'AppInstanceRetentionSettings': {
                 'ChannelRetentionSettings': {
                     'RetentionDays': 123
                 }
             },
             'InitiateDeletionTimestamp': datetime(2015, 1, 1)
         }

      **Response Structure**

      * *(dict) --*

        * **AppInstanceRetentionSettings** *(dict) --*

          The time in days to retain data. Data type: number.

          * **ChannelRetentionSettings** *(dict) --*

            The length of time in days to retain the messages in a
            channel.

            * **RetentionDays** *(integer) --*

              The time in days to retain the messages in a channel.

        * **InitiateDeletionTimestamp** *(datetime) --*

          The time at which the API deletes data.

   **Exceptions**

   * "ChimeSDKIdentity.Client.exceptions.BadRequestException"

   * "ChimeSDKIdentity.Client.exceptions.ForbiddenException"

   * "ChimeSDKIdentity.Client.exceptions.ThrottledClientException"

   * "ChimeSDKIdentity.Client.exceptions.UnauthorizedClientException"

   * "ChimeSDKIdentity.Client.exceptions.ServiceUnavailableException"

   * "ChimeSDKIdentity.Client.exceptions.ServiceFailureException"
ChimeSDKIdentity / Client / create_app_instance


create_app_instance
*******************

ChimeSDKIdentity.Client.create_app_instance(**kwargs)

   Creates an Amazon Chime SDK messaging "AppInstance" under an AWS
   account. Only SDK messaging customers use this API.
   "CreateAppInstance" supports idempotency behavior as described in
   the AWS API Standard.

   identity

   See also: AWS API Documentation

   **Request Syntax**

      response = client.create_app_instance(
          Name='string',
          Metadata='string',
          ClientRequestToken='string',
          Tags=[
              {
                  'Key': 'string',
                  'Value': 'string'
              },
          ]
      )

   Parameters:
      * **Name** (*string*) --

        **[REQUIRED]**

        The name of the "AppInstance".

      * **Metadata** (*string*) -- The metadata of the "AppInstance".
        Limited to a 1KB string in UTF-8.

      * **ClientRequestToken** (*string*) --

        **[REQUIRED]**

        The unique ID of the request. Use different tokens to create
        different "AppInstances".

        This field is autopopulated if not provided.

      * **Tags** (*list*) --

        Tags assigned to the "AppInstance".

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

   Return type:
      dict

   Returns:
      **Response Syntax**

         {
             'AppInstanceArn': 'string'
         }

      **Response Structure**

      * *(dict) --*

        * **AppInstanceArn** *(string) --*

          The Amazon Resource Number (ARN) of the "AppInstance".

   **Exceptions**

   * "ChimeSDKIdentity.Client.exceptions.BadRequestException"

   * "ChimeSDKIdentity.Client.exceptions.ConflictException"

   * "ChimeSDKIdentity.Client.exceptions.ForbiddenException"

   * "ChimeSDKIdentity.Client.exceptions.ResourceLimitExceededExcepti
     on"

   * "ChimeSDKIdentity.Client.exceptions.ThrottledClientException"

   * "ChimeSDKIdentity.Client.exceptions.UnauthorizedClientException"

   * "ChimeSDKIdentity.Client.exceptions.ServiceUnavailableException"

   * "ChimeSDKIdentity.Client.exceptions.ServiceFailureException"
ChimeSDKIdentity / Client / update_app_instance_user


update_app_instance_user
************************

ChimeSDKIdentity.Client.update_app_instance_user(**kwargs)

   Updates the details of an "AppInstanceUser". You can update names
   and metadata.

   See also: AWS API Documentation

   **Request Syntax**

      response = client.update_app_instance_user(
          AppInstanceUserArn='string',
          Name='string',
          Metadata='string'
      )

   Parameters:
      * **AppInstanceUserArn** (*string*) --

        **[REQUIRED]**

        The ARN of the "AppInstanceUser".

      * **Name** (*string*) --

        **[REQUIRED]**

        The name of the "AppInstanceUser".

      * **Metadata** (*string*) --

        **[REQUIRED]**

        The metadata of the "AppInstanceUser".

   Return type:
      dict

   Returns:
      **Response Syntax**

         {
             'AppInstanceUserArn': 'string'
         }

      **Response Structure**

      * *(dict) --*

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

          The ARN of the "AppInstanceUser".

   **Exceptions**

   * "ChimeSDKIdentity.Client.exceptions.BadRequestException"

   * "ChimeSDKIdentity.Client.exceptions.ConflictException"

   * "ChimeSDKIdentity.Client.exceptions.ForbiddenException"

   * "ChimeSDKIdentity.Client.exceptions.ResourceLimitExceededExcepti
     on"

   * "ChimeSDKIdentity.Client.exceptions.ThrottledClientException"

   * "ChimeSDKIdentity.Client.exceptions.UnauthorizedClientException"

   * "ChimeSDKIdentity.Client.exceptions.ServiceUnavailableException"

   * "ChimeSDKIdentity.Client.exceptions.ServiceFailureException"
ChimeSDKIdentity / Client / close


close
*****

ChimeSDKIdentity.Client.close()

   Closes underlying endpoint connections.
ChimeSDKIdentity / Client / describe_app_instance_user_endpoint


describe_app_instance_user_endpoint
***********************************

ChimeSDKIdentity.Client.describe_app_instance_user_endpoint(**kwargs)

   Returns the full details of an "AppInstanceUserEndpoint".

   See also: AWS API Documentation

   **Request Syntax**

      response = client.describe_app_instance_user_endpoint(
          AppInstanceUserArn='string',
          EndpointId='string'
      )

   Parameters:
      * **AppInstanceUserArn** (*string*) --

        **[REQUIRED]**

        The ARN of the "AppInstanceUser".

      * **EndpointId** (*string*) --

        **[REQUIRED]**

        The unique identifier of the "AppInstanceUserEndpoint".

   Return type:
      dict

   Returns:
      **Response Syntax**

         {
             'AppInstanceUserEndpoint': {
                 'AppInstanceUserArn': 'string',
                 'EndpointId': 'string',
                 'Name': 'string',
                 'Type': 'APNS'|'APNS_SANDBOX'|'GCM',
                 'ResourceArn': 'string',
                 'EndpointAttributes': {
                     'DeviceToken': 'string',
                     'VoipDeviceToken': 'string'
                 },
                 'CreatedTimestamp': datetime(2015, 1, 1),
                 'LastUpdatedTimestamp': datetime(2015, 1, 1),
                 'AllowMessages': 'ALL'|'NONE',
                 'EndpointState': {
                     'Status': 'ACTIVE'|'INACTIVE',
                     'StatusReason': 'INVALID_DEVICE_TOKEN'|'INVALID_PINPOINT_ARN'
                 }
             }
         }

      **Response Structure**

      * *(dict) --*

        * **AppInstanceUserEndpoint** *(dict) --*

          The full details of an "AppInstanceUserEndpoint": the
          "AppInstanceUserArn", ID, name, type, resource ARN,
          attributes, allow messages, state, and created and last
          updated timestamps. All timestamps use epoch milliseconds.

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

            The ARN of the "AppInstanceUser".

          * **EndpointId** *(string) --*

            The unique identifier of the "AppInstanceUserEndpoint".

          * **Name** *(string) --*

            The name of the "AppInstanceUserEndpoint".

          * **Type** *(string) --*

            The type of the "AppInstanceUserEndpoint".

          * **ResourceArn** *(string) --*

            The ARN of the resource to which the endpoint belongs.

          * **EndpointAttributes** *(dict) --*

            The attributes of an "Endpoint".

            * **DeviceToken** *(string) --*

              The device token for the GCM, APNS, and APNS_SANDBOX
              endpoint types.

            * **VoipDeviceToken** *(string) --*

              The VOIP device token for the APNS and APNS_SANDBOX
              endpoint types.

          * **CreatedTimestamp** *(datetime) --*

            The time at which an "AppInstanceUserEndpoint" was
            created.

          * **LastUpdatedTimestamp** *(datetime) --*

            The time at which an "AppInstanceUserEndpoint" was last
            updated.

          * **AllowMessages** *(string) --*

            Boolean that controls whether the
            "AppInstanceUserEndpoint" is opted in to receive messages.
            "ALL" indicates the endpoint will receive all messages.
            "NONE" indicates the endpoint will receive no messages.

          * **EndpointState** *(dict) --*

            A read-only field that represents the state of an
            "AppInstanceUserEndpoint". Supported values:

            * "ACTIVE": The "AppInstanceUserEndpoint" is active and
              able to receive messages. When "ACTIVE", the
              "EndpointStatusReason" remains empty.

            * "INACTIVE": The "AppInstanceUserEndpoint" is inactive
              and can't receive message. When "INACTIVE", the
              corresponding reason will be conveyed through
              "EndpointStatusReason".

            * "INVALID_DEVICE_TOKEN" indicates that an
              "AppInstanceUserEndpoint" is "INACTIVE" due to invalid
              device token

            * "INVALID_PINPOINT_ARN" indicates that an
              "AppInstanceUserEndpoint" is "INACTIVE" due to an
              invalid pinpoint ARN that was input through the
              "ResourceArn" field.

            * **Status** *(string) --*

              Enum that indicates the Status of an
              "AppInstanceUserEndpoint".

            * **StatusReason** *(string) --*

              The reason for the "EndpointStatus".

   **Exceptions**

   * "ChimeSDKIdentity.Client.exceptions.BadRequestException"

   * "ChimeSDKIdentity.Client.exceptions.ForbiddenException"

   * "ChimeSDKIdentity.Client.exceptions.ThrottledClientException"

   * "ChimeSDKIdentity.Client.exceptions.UnauthorizedClientException"

   * "ChimeSDKIdentity.Client.exceptions.ServiceUnavailableException"

   * "ChimeSDKIdentity.Client.exceptions.ServiceFailureException"
ChimeSDKIdentity / Client / describe_app_instance_bot


describe_app_instance_bot
*************************

ChimeSDKIdentity.Client.describe_app_instance_bot(**kwargs)

   The "AppInstanceBot's" information.

   See also: AWS API Documentation

   **Request Syntax**

      response = client.describe_app_instance_bot(
          AppInstanceBotArn='string'
      )

   Parameters:
      **AppInstanceBotArn** (*string*) --

      **[REQUIRED]**

      The ARN of the "AppInstanceBot".

   Return type:
      dict

   Returns:
      **Response Syntax**

         {
             'AppInstanceBot': {
                 'AppInstanceBotArn': 'string',
                 'Name': 'string',
                 'Configuration': {
                     'Lex': {
                         'RespondsTo': 'STANDARD_MESSAGES',
                         'InvokedBy': {
                             'StandardMessages': 'AUTO'|'ALL'|'MENTIONS'|'NONE',
                             'TargetedMessages': 'ALL'|'NONE'
                         },
                         'LexBotAliasArn': 'string',
                         'LocaleId': 'string',
                         'WelcomeIntent': 'string'
                     }
                 },
                 'CreatedTimestamp': datetime(2015, 1, 1),
                 'LastUpdatedTimestamp': datetime(2015, 1, 1),
                 'Metadata': 'string'
             }
         }

      **Response Structure**

      * *(dict) --*

        * **AppInstanceBot** *(dict) --*

          The detials of the "AppInstanceBot".

          * **AppInstanceBotArn** *(string) --*

            The ARN of the AppInstanceBot.

          * **Name** *(string) --*

            The name of the AppInstanceBot.

          * **Configuration** *(dict) --*

            The data processing instructions for an AppInstanceBot.

            * **Lex** *(dict) --*

              The configuration for an Amazon Lex V2 bot.

              * **RespondsTo** *(string) --*

                Warning:

                  **Deprecated**. Use "InvokedBy" instead.

                Determines whether the Amazon Lex V2 bot responds to
                all standard messages. Control messages are not
                supported.

              * **InvokedBy** *(dict) --*

                Specifies the type of message that triggers a bot.

                * **StandardMessages** *(string) --*

                  Sets standard messages as the bot trigger. For
                  standard messages:

                  * "ALL": The bot processes all standard messages.

                  * "AUTO": The bot responds to ALL messages when the
                    channel has one other non-hidden member, and
                    responds to MENTIONS when the channel has more
                    than one other non-hidden member.

                  * "MENTIONS": The bot processes all standard
                    messages that have a message attribute with
                    "CHIME.mentions" and a value of the bot ARN.

                  * "NONE": The bot processes no standard messages.

                * **TargetedMessages** *(string) --*

                  Sets targeted messages as the bot trigger. For
                  targeted messages:

                  * "ALL": The bot processes all "TargetedMessages"
                    sent to it. The bot then responds with a targeted
                    message back to the sender.

                  * "NONE": The bot processes no targeted messages.

              * **LexBotAliasArn** *(string) --*

                The ARN of the Amazon Lex V2 bot's alias. The ARN uses
                this format: "arn:aws:lex:REGION:ACCOUNT:bot-
                alias/MYBOTID/MYBOTALIAS"

              * **LocaleId** *(string) --*

                Identifies the Amazon Lex V2 bot's language and
                locale. The string must match one of the supported
                locales in Amazon Lex V2. All of the intents, slot
                types, and slots used in the bot must have the same
                locale. For more information, see Supported languages
                in the *Amazon Lex V2 Developer Guide*.

              * **WelcomeIntent** *(string) --*

                The name of the welcome intent configured in the
                Amazon Lex V2 bot.

          * **CreatedTimestamp** *(datetime) --*

            The time at which the "AppInstanceBot" was created.

          * **LastUpdatedTimestamp** *(datetime) --*

            The time at which the "AppInstanceBot" was last updated.

          * **Metadata** *(string) --*

            The metadata for an AppInstanceBot.

   **Exceptions**

   * "ChimeSDKIdentity.Client.exceptions.BadRequestException"

   * "ChimeSDKIdentity.Client.exceptions.ForbiddenException"

   * "ChimeSDKIdentity.Client.exceptions.ThrottledClientException"

   * "ChimeSDKIdentity.Client.exceptions.UnauthorizedClientException"

   * "ChimeSDKIdentity.Client.exceptions.NotFoundException"

   * "ChimeSDKIdentity.Client.exceptions.ServiceUnavailableException"

   * "ChimeSDKIdentity.Client.exceptions.ServiceFailureException"
ChimeSDKIdentity / Client / update_app_instance


update_app_instance
*******************

ChimeSDKIdentity.Client.update_app_instance(**kwargs)

   Updates "AppInstance" metadata.

   See also: AWS API Documentation

   **Request Syntax**

      response = client.update_app_instance(
          AppInstanceArn='string',
          Name='string',
          Metadata='string'
      )

   Parameters:
      * **AppInstanceArn** (*string*) --

        **[REQUIRED]**

        The ARN of the "AppInstance".

      * **Name** (*string*) --

        **[REQUIRED]**

        The name that you want to change.

      * **Metadata** (*string*) --

        **[REQUIRED]**

        The metadata that you want to change.

   Return type:
      dict

   Returns:
      **Response Syntax**

         {
             'AppInstanceArn': 'string'
         }

      **Response Structure**

      * *(dict) --*

        * **AppInstanceArn** *(string) --*

          The ARN of the "AppInstance".

   **Exceptions**

   * "ChimeSDKIdentity.Client.exceptions.BadRequestException"

   * "ChimeSDKIdentity.Client.exceptions.ConflictException"

   * "ChimeSDKIdentity.Client.exceptions.ForbiddenException"

   * "ChimeSDKIdentity.Client.exceptions.ThrottledClientException"

   * "ChimeSDKIdentity.Client.exceptions.UnauthorizedClientException"

   * "ChimeSDKIdentity.Client.exceptions.ServiceUnavailableException"

   * "ChimeSDKIdentity.Client.exceptions.ServiceFailureException"
ChimeSDKIdentity / Client / tag_resource


tag_resource
************

ChimeSDKIdentity.Client.tag_resource(**kwargs)

   Applies the specified tags to the specified Amazon Chime SDK
   identity resource.

   See also: AWS API Documentation

   **Request Syntax**

      response = client.tag_resource(
          ResourceARN='string',
          Tags=[
              {
                  'Key': 'string',
                  'Value': 'string'
              },
          ]
      )

   Parameters:
      * **ResourceARN** (*string*) --

        **[REQUIRED]**

        The resource ARN.

      * **Tags** (*list*) --

        **[REQUIRED]**

        The tag key-value pairs.

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

   Returns:
      None

   **Exceptions**

   * "ChimeSDKIdentity.Client.exceptions.BadRequestException"

   * "ChimeSDKIdentity.Client.exceptions.ForbiddenException"

   * "ChimeSDKIdentity.Client.exceptions.UnauthorizedClientException"

   * "ChimeSDKIdentity.Client.exceptions.ResourceLimitExceededExcepti
     on"

   * "ChimeSDKIdentity.Client.exceptions.ThrottledClientException"

   * "ChimeSDKIdentity.Client.exceptions.ServiceUnavailableException"

   * "ChimeSDKIdentity.Client.exceptions.ServiceFailureException"
ChimeSDKIdentity / Client / list_app_instance_bots


list_app_instance_bots
**********************

ChimeSDKIdentity.Client.list_app_instance_bots(**kwargs)

   Lists all "AppInstanceBots" created under a single "AppInstance".

   See also: AWS API Documentation

   **Request Syntax**

      response = client.list_app_instance_bots(
          AppInstanceArn='string',
          MaxResults=123,
          NextToken='string'
      )

   Parameters:
      * **AppInstanceArn** (*string*) --

        **[REQUIRED]**

        The ARN of the "AppInstance".

      * **MaxResults** (*integer*) -- The maximum number of requests
        to return.

      * **NextToken** (*string*) -- The token passed by previous API
        calls until all requested bots are returned.

   Return type:
      dict

   Returns:
      **Response Syntax**

         {
             'AppInstanceArn': 'string',
             'AppInstanceBots': [
                 {
                     'AppInstanceBotArn': 'string',
                     'Name': 'string',
                     'Metadata': 'string'
                 },
             ],
             'NextToken': 'string'
         }

      **Response Structure**

      * *(dict) --*

        * **AppInstanceArn** *(string) --*

          The ARN of the AppInstance.

        * **AppInstanceBots** *(list) --*

          The information for each requested "AppInstanceBot".

          * *(dict) --*

            High-level information about an AppInstanceBot.

            * **AppInstanceBotArn** *(string) --*

              The ARN of the AppInstanceBot.

            * **Name** *(string) --*

              The name of the AppInstanceBox.

            * **Metadata** *(string) --*

              The metadata of the AppInstanceBot.

        * **NextToken** *(string) --*

          The token passed by previous API calls until all requested
          bots are returned.

   **Exceptions**

   * "ChimeSDKIdentity.Client.exceptions.BadRequestException"

   * "ChimeSDKIdentity.Client.exceptions.ForbiddenException"

   * "ChimeSDKIdentity.Client.exceptions.ResourceLimitExceededExcepti
     on"

   * "ChimeSDKIdentity.Client.exceptions.ThrottledClientException"

   * "ChimeSDKIdentity.Client.exceptions.UnauthorizedClientException"

   * "ChimeSDKIdentity.Client.exceptions.ServiceUnavailableException"

   * "ChimeSDKIdentity.Client.exceptions.ServiceFailureException"
ChimeSDKIdentity / Client / delete_app_instance_bot


delete_app_instance_bot
***********************

ChimeSDKIdentity.Client.delete_app_instance_bot(**kwargs)

   Deletes an "AppInstanceBot".

   See also: AWS API Documentation

   **Request Syntax**

      response = client.delete_app_instance_bot(
          AppInstanceBotArn='string'
      )

   Parameters:
      **AppInstanceBotArn** (*string*) --

      **[REQUIRED]**

      The ARN of the "AppInstanceBot" being deleted.

   Returns:
      None

   **Exceptions**

   * "ChimeSDKIdentity.Client.exceptions.BadRequestException"

   * "ChimeSDKIdentity.Client.exceptions.ConflictException"

   * "ChimeSDKIdentity.Client.exceptions.ForbiddenException"

   * "ChimeSDKIdentity.Client.exceptions.ResourceLimitExceededExcepti
     on"

   * "ChimeSDKIdentity.Client.exceptions.ThrottledClientException"

   * "ChimeSDKIdentity.Client.exceptions.UnauthorizedClientException"

   * "ChimeSDKIdentity.Client.exceptions.ServiceUnavailableException"

   * "ChimeSDKIdentity.Client.exceptions.ServiceFailureException"
ChimeSDKIdentity / Client / create_app_instance_user


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

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

   **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'
          }
      )

   Parameters:
      * **AppInstanceArn** (*string*) --

        **[REQUIRED]**

        The ARN of the "AppInstance" request.

      * **AppInstanceUserId** (*string*) --

        **[REQUIRED]**

        The user ID of the "AppInstance".

      * **Name** (*string*) --

        **[REQUIRED]**

        The user's name.

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

      * **ClientRequestToken** (*string*) --

        **[REQUIRED]**

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

        This field is autopopulated if not provided.

      * **Tags** (*list*) --

        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.

      * **ExpirationSettings** (*dict*) --

        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.

   Return type:
      dict

   Returns:
      **Response Syntax**

         {
             'AppInstanceUserArn': 'string'
         }

      **Response Structure**

      * *(dict) --*

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

          The user's ARN.

   **Exceptions**

   * "ChimeSDKIdentity.Client.exceptions.BadRequestException"

   * "ChimeSDKIdentity.Client.exceptions.ConflictException"

   * "ChimeSDKIdentity.Client.exceptions.ForbiddenException"

   * "ChimeSDKIdentity.Client.exceptions.ResourceLimitExceededExcepti
     on"

   * "ChimeSDKIdentity.Client.exceptions.ThrottledClientException"

   * "ChimeSDKIdentity.Client.exceptions.UnauthorizedClientException"

   * "ChimeSDKIdentity.Client.exceptions.ServiceUnavailableException"

   * "ChimeSDKIdentity.Client.exceptions.ServiceFailureException"