CancelDeclarativePoliciesReportCommand

Suggest an Edit

Cancels the generation of an account status report.

You can only cancel a report while it has the running status. Reports with other statuses (complete, cancelled, or error) can't be canceled.

For more information, see Generating the account status report for declarative policies  in the Amazon Web Services Organizations User Guide.

Example Syntax

Use a bare-bones client and the command you need to make an API call.

import { EC2Client, CancelDeclarativePoliciesReportCommand } from "@aws-sdk/client-ec2"; // ES Modules import
// const { EC2Client, CancelDeclarativePoliciesReportCommand } = require("@aws-sdk/client-ec2"); // CommonJS import
const client = new EC2Client(config);
const input = { // CancelDeclarativePoliciesReportRequest
  DryRun: true || false,
  ReportId: "STRING_VALUE", // required
};
const command = new CancelDeclarativePoliciesReportCommand(input);
const response = await client.send(command);
// { // CancelDeclarativePoliciesReportResult
//   Return: true || false,
// };

CancelDeclarativePoliciesReportCommand Input

See CancelDeclarativePoliciesReportCommandInput for more details

Parameter
Type
Description
ReportId
Required
string | undefined

The ID of the report.

DryRun
boolean | undefined

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

CancelDeclarativePoliciesReportCommand Output

See CancelDeclarativePoliciesReportCommandOutput for details

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.
Return
boolean | undefined

Is true if the request succeeds, and an error otherwise.

Throws

Name
Fault
Details
EC2ServiceException
Base exception class for all service exceptions from EC2 service.