get_app_instance_retention_settings

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