DryRunResult - Amazon CloudWatch Logs
Services or capabilities described in AWS documentation might vary by Region. To see the differences applicable to the AWS European Sovereign Cloud Region, see the AWS European Sovereign Cloud User Guide.

DryRunResult

Contains the estimated impact of creating, updating, or deleting an account-level retention policy. The analysis compares the effective retention period of each log group, which accounts for all account-level retention policies that apply to it, before and after the change. Log groups in the Delivery class are not included.

Contents

decreasedRetentionLogGroupCount

The number of log groups whose effective retention period would become shorter.

Type: Integer

Valid Range: Minimum value of 0.

Required: No

failedAnalysisCount

The number of log groups in the scope of the policy that could not be analyzed. These log groups are not included in totalMatchedLogGroups.

Type: Integer

Valid Range: Minimum value of 0.

Required: No

increasedRetentionLogGroupCount

The number of log groups whose effective retention period would become longer.

Type: Integer

Valid Range: Minimum value of 0.

Required: No

topLogGroupsImpacted

Up to 20 log groups in the scope of the policy, sorted by stored bytes in descending order. This list can include log groups whose effective retention period would not change.

Type: Array of LogGroupImpact objects

Required: No

totalMatchedLogGroups

The number of log groups in the scope of the policy that were analyzed. This value is the sum of increasedRetentionLogGroupCount, decreasedRetentionLogGroupCount, and unchangedRetentionLogGroupCount, and does not include log groups that could not be analyzed.

Type: Integer

Valid Range: Minimum value of 0.

Required: No

unchangedRetentionLogGroupCount

The number of log groups whose effective retention period would not change.

Type: Integer

Valid Range: Minimum value of 0.

Required: No

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: