get_retention_settings

get_retention_settings(**kwargs)

Gets the retention settings for the specified Amazon Chime Enterprise account. For more information about retention settings, see Managing Chat Retention Policies in the Amazon Chime Administration Guide .

See also: AWS API Documentation

Request Syntax

response = client.get_retention_settings(
    AccountId='string'
)

Parameters

AccountId (string) --

[REQUIRED]

The Amazon Chime account ID.

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.ThrottledClientException
• Chime.Client.exceptions.ServiceUnavailableException
• Chime.Client.exceptions.ServiceFailureException