CloudWatchLogs / Client / put_retention_policy

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.

Account-level retention policies created with PutAccountPolicy override the retention that you set with PutRetentionPolicy. If an account-level retention policy applies to the log group, this operation succeeds and CloudWatch Logs saves the retention period that you specify, but the retention period from the account-level policy continues to determine when log events in the log group expire. DescribeLogGroups returns the retention period from the policy in retentionInDays and the name of the policy in retentionPolicyName. The retention period that you set with this operation takes effect if the account-level policy no longer applies to the 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.

When log events reach their retention setting they are marked for deletion. After they are marked for deletion, they do not add to your archival storage costs anymore, even if they are not actually deleted until later. These log events marked for deletion are also not included when you use an API to retrieve the storedBytes value to see how many bytes a log group is storing.

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, 1096, 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