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

**********************
put_retention_settings
**********************



.. py:method:: Chime.Client.put_retention_settings(**kwargs)

  

  Puts retention settings for the specified Amazon Chime Enterprise account. We recommend using AWS CloudTrail to monitor usage of this API for your account. For more information, see `Logging Amazon Chime API Calls with AWS CloudTrail <https://docs.aws.amazon.com/chime/latest/ag/cloudtrail.html>`__ in the *Amazon Chime Administration Guide*.

   

  To turn off existing retention settings, remove the number of days from the corresponding **RetentionDays** field in the **RetentionSettings** object. For more information about retention settings, see `Managing Chat Retention Policies <https://docs.aws.amazon.com/chime/latest/ag/chat-retention.html>`__ in the *Amazon Chime Administration Guide*.

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/PutRetentionSettings>`_  


  **Request Syntax**
  ::

    response = client.put_retention_settings(
        AccountId='string',
        RetentionSettings={
            'RoomRetentionSettings': {
                'RetentionDays': 123
            },
            'ConversationRetentionSettings': {
                'RetentionDays': 123
            }
        }
    )
    
  :type AccountId: string
  :param AccountId: **[REQUIRED]** 

    The Amazon Chime account ID.

    

  
  :type RetentionSettings: dict
  :param RetentionSettings: **[REQUIRED]** 

    The retention settings.

    

  
    - **RoomRetentionSettings** *(dict) --* 

      The chat room retention settings.

      

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

        The number of days for which to retain chat-room messages.

        

      
    
    - **ConversationRetentionSettings** *(dict) --* 

      The chat conversation retention settings.

      

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

        The number of days for which to retain conversation messages.

        

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

    
    ::

      {
          'RetentionSettings': {
              'RoomRetentionSettings': {
                  'RetentionDays': 123
              },
              'ConversationRetentionSettings': {
                  'RetentionDays': 123
              }
          },
          'InitiateDeletionTimestamp': datetime(2015, 1, 1)
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

      - **RetentionSettings** *(dict) --* 

        The retention settings.

        
        

        - **RoomRetentionSettings** *(dict) --* 

          The chat room retention settings.

          
          

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

            The number of days for which to retain chat-room messages.

            
      
        

        - **ConversationRetentionSettings** *(dict) --* 

          The chat conversation retention settings.

          
          

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

            The number of days for which to retain conversation messages.

            
      
    
      

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

        The timestamp representing the time at which the specified items are permanently deleted, in ISO 8601 format.

        
  
  **Exceptions**
  
  *   :py:class:`Chime.Client.exceptions.UnauthorizedClientException`

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

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

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

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

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

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

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

  