Chime / Client / put_app_instance_retention_settings

put_app_instance_retention_settings

Chime.Client.put_app_instance_retention_settings(**kwargs)

Sets the amount of time in days that a given AppInstance retains data.

Warning

This API is is no longer supported and will not be updated. We recommend using the latest version, PutAppInstanceRetentionSettings, in the Amazon Chime SDK.

Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.

Danger

This operation is deprecated and may not function as expected. This operation should not be used going forward and is only kept for the purpose of backwards compatiblity.

See also: AWS API Documentation

Request Syntax

response = client.put_app_instance_retention_settings(
    AppInstanceArn='string',
    AppInstanceRetentionSettings={
        'ChannelRetentionSettings': {
            'RetentionDays': 123
        }
    }
)

Parameters:

• AppInstanceArn (string) –

  [REQUIRED]

  The ARN of the AppInstance.

• AppInstanceRetentionSettings (dict) –

  [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.

Return type:

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

• 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