Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

DeleteAccountPolicy

Deletes a CloudWatch Logs account policy. This stops the account-wide policy from applying to log groups or data sources in the account. If you delete a data protection policy or subscription filter policy, any log-group level policies of those types remain in effect. This operation supports deletion of data source-based field index policies, including facet configurations, in addition to log group-based policies.

To use this operation, you must be signed on with the correct permissions depending on the type of policy that you are deleting.

To delete a data protection policy, you must have the logs:DeleteDataProtectionPolicy and logs:DeleteAccountPolicy permissions.
To delete a subscription filter policy, you must have the logs:DeleteSubscriptionFilter and logs:DeleteAccountPolicy permissions.
To delete a transformer policy, you must have the logs:DeleteTransformer and logs:DeleteAccountPolicy permissions.
To delete a field index policy, you must have the logs:DeleteIndexPolicy and logs:DeleteAccountPolicy permissions.

If you delete a field index policy that included facet configurations, those facets will no longer be available for interactive exploration in the CloudWatch Logs Insights console. However, facet data is retained for up to 30 days.
To delete a retention policy, you must have the logs:DeleteRetentionPolicy and logs:DeleteAccountPolicy permissions. To preview the impact of deleting a retention policy, specify true for dryRun.

If you delete a field index policy, the indexing of the log events that happened before you deleted the policy will still be used for up to 30 days to improve CloudWatch Logs Insights queries.

Request Syntax


{
   "dryRun": boolean,
   "policyName": "string",
   "policyType": "string"
}

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

dryRun

Specifies whether to preview the impact of deleting the policy without deleting it. If you specify true, CloudWatch Logs does not delete the policy and returns the estimated impact in dryRunResult. The default is false.

Specifying dryRun is valid only when you specify RETENTION_POLICY for policyType. Only one dry run can be in progress for an account at a time.

Type: Boolean

Required: No

policyName

The name of the policy to delete.

Type: String

Required: Yes

policyType

The type of policy to delete.

Type: String

Required: Yes

Response Syntax


{
   "dryRunResult": { 
      "decreasedRetentionLogGroupCount": number,
      "failedAnalysisCount": number,
      "increasedRetentionLogGroupCount": number,
      "topLogGroupsImpacted": [ 
         { 
            "currentRetention": "string",
            "logGroupName": "string",
            "proposedRetention": "string",
            "storedBytes": number
         }
      ],
      "totalMatchedLogGroups": number,
      "unchangedRetentionLogGroupCount": number
   }
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

dryRunResult

The estimated impact of deleting the policy. This field is returned only when the request specifies dryRun as true.

Type: DryRunResult object

Errors

For information about the errors that are common to all actions, see Common Error Types.

InvalidParameterException

A parameter is specified incorrectly.

HTTP Status Code: 400

OperationAbortedException

Multiple concurrent requests to update the same resource were in conflict.

HTTP Status Code: 400

ResourceNotFoundException

The specified resource does not exist.

HTTP Status Code: 400

ServiceUnavailableException

The service cannot complete the request.

HTTP Status Code: 500