Skip to content

cancel_declarative_policies_report

Operation

cancel_declarative_policies_report

cancel_declarative_policies_report(request: CancelDeclarativePoliciesReportInput | CancelDeclarativePoliciesReportInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[CancelDeclarativePoliciesReportInputDict]) -> CancelDeclarativePoliciesReportOutput

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.

Parameters:

Name Type Description Default
request CancelDeclarativePoliciesReportInput | CancelDeclarativePoliciesReportInputDict | None

The input as a model or dictionary. Pass this or keyword arguments, not both.

None
plugins list[Plugin] | None

A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations.

None
**kwargs Unpack[CancelDeclarativePoliciesReportInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
CancelDeclarativePoliciesReportOutput

An instance of CancelDeclarativePoliciesReportOutput.

cancel_declarative_policies_report async

cancel_declarative_policies_report(request: CancelDeclarativePoliciesReportInput | CancelDeclarativePoliciesReportInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[CancelDeclarativePoliciesReportInputDict]) -> CancelDeclarativePoliciesReportOutput

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.

Parameters:

Name Type Description Default
request CancelDeclarativePoliciesReportInput | CancelDeclarativePoliciesReportInputDict | None

The input as a model or dictionary. Pass this or keyword arguments, not both.

None
plugins list[Plugin] | None

A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations.

None
**kwargs Unpack[CancelDeclarativePoliciesReportInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
CancelDeclarativePoliciesReportOutput

An instance of CancelDeclarativePoliciesReportOutput.

Input

Pass the input as keyword arguments, a positional dictionary, or a positional model object. Pass plugins separately as a keyword argument.

CancelDeclarativePoliciesReportInputDict

Bases: TypedDict

Dictionary form of CancelDeclarativePoliciesReportInput.

Attributes

dry_run instance-attribute
dry_run: bool | None

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.

report_id instance-attribute
report_id: Required[str]

The ID of the report.

CancelDeclarativePoliciesReportInput dataclass

Bases: _SerdeShape

Dataclass for CancelDeclarativePoliciesReportInput structure.

Attributes

dry_run class-attribute instance-attribute
dry_run: bool | None = ...

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.

report_id class-attribute instance-attribute
report_id: str | None = ...

The ID of the report.

Output

CancelDeclarativePoliciesReportOutput dataclass

Bases: _SerdeShape

Dataclass for CancelDeclarativePoliciesReportOutput structure.

Attributes

response_metadata class-attribute instance-attribute
response_metadata: ResponseMetadata = ...

Metadata about the response that produced this output. Use this to recover the request identifiers a service's support team needs in order to investigate a call. Members of the metadata are individually optional.

return_ class-attribute instance-attribute
return_: bool | None = ...

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