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

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



.. py:method:: 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 <https://docs.aws.amazon.com/goto/WebAPI/chime-sdk-identity-2021-04-20/PutAppInstanceRetentionSettings>`_  


  **Request Syntax**
  ::

    response = client.put_app_instance_retention_settings(
        AppInstanceArn='string',
        AppInstanceRetentionSettings={
            'ChannelRetentionSettings': {
                'RetentionDays': 123
            }
        }
    )
    
  :type AppInstanceArn: string
  :param AppInstanceArn: **[REQUIRED]** 

    The ARN of the ``AppInstance``.

    

  
  :type AppInstanceRetentionSettings: dict
  :param AppInstanceRetentionSettings: **[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.

        

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

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

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

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

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

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

  