Chime / Client / put_retention_settings

put_retention_settings#

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 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 in the Amazon Chime Administration Guide.

Request Syntax

response = client.put_retention_settings(
    AccountId='string',
    RetentionSettings={
        'RoomRetentionSettings': {
            'RetentionDays': 123
        },
        'ConversationRetentionSettings': {
            'RetentionDays': 123
        }
    }
)

Parameters:

AccountId (string) –
[REQUIRED]

The Amazon Chime account ID.
RetentionSettings (dict) –
[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.

Return type:

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

Chime.Client.exceptions.UnauthorizedClientException
Chime.Client.exceptions.NotFoundException
Chime.Client.exceptions.BadRequestException
Chime.Client.exceptions.ForbiddenException
Chime.Client.exceptions.ConflictException
Chime.Client.exceptions.ThrottledClientException
Chime.Client.exceptions.ServiceUnavailableException
Chime.Client.exceptions.ServiceFailureException