put_retention_policy

CloudWatchLogs.Client.put_retention_policy(**kwargs)

Sets the retention of the specified log group. With a retention policy, you can configure the number of days for which to retain log events in the specified log group.

Note

CloudWatch Logs doesn’t immediately delete log events when they reach their retention setting. It typically takes up to 72 hours after that before log events are deleted, but in rare situations might take longer.

To illustrate, imagine that you change a log group to have a longer retention setting when it contains log events that are past the expiration date, but haven’t been deleted. Those log events will take up to 72 hours to be deleted after the new retention date is reached. To make sure that log data is deleted permanently, keep a log group at its lower retention setting until 72 hours after the previous retention period ends. Alternatively, wait to change the retention setting until you confirm that the earlier log events are deleted.

See also: AWS API Documentation

Request Syntax

response = client.put_retention_policy(
    logGroupName='string',
    retentionInDays=123
)

Parameters

• logGroupName (string) --

  [REQUIRED]

  The name of the log group.

• retentionInDays (integer) --

  [REQUIRED]

  The number of days to retain the log events in the specified log group. Possible values are: 1, 3, 5, 7, 14, 30, 60, 90, 120, 150, 180, 365, 400, 545, 731, 1827, 2192, 2557, 2922, 3288, and 3653.

  To set a log group so that its log events do not expire, use DeleteRetentionPolicy.

Returns

None

Exceptions

• CloudWatchLogs.Client.exceptions.InvalidParameterException
• CloudWatchLogs.Client.exceptions.ResourceNotFoundException
• CloudWatchLogs.Client.exceptions.OperationAbortedException
• CloudWatchLogs.Client.exceptions.ServiceUnavailableException