Skip to content

describe_declarative_policies_reports

Operation

describe_declarative_policies_reports

Describes the metadata of an account status report, including the status of the report.

To view the full report, download it from the Amazon S3 bucket where it was saved. Reports are accessible only when they have the complete status. Reports with other statuses (running, cancelled, or error) are not available in the S3 bucket. For more information about downloading objects from an S3 bucket, see Downloading objects in the Amazon Simple Storage Service User Guide.

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 DescribeDeclarativePoliciesReportsInput | DescribeDeclarativePoliciesReportsInputDict | 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[DescribeDeclarativePoliciesReportsInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
DescribeDeclarativePoliciesReportsOutput

An instance of DescribeDeclarativePoliciesReportsOutput.

describe_declarative_policies_reports async

Describes the metadata of an account status report, including the status of the report.

To view the full report, download it from the Amazon S3 bucket where it was saved. Reports are accessible only when they have the complete status. Reports with other statuses (running, cancelled, or error) are not available in the S3 bucket. For more information about downloading objects from an S3 bucket, see Downloading objects in the Amazon Simple Storage Service User Guide.

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 DescribeDeclarativePoliciesReportsInput | DescribeDeclarativePoliciesReportsInputDict | 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[DescribeDeclarativePoliciesReportsInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
DescribeDeclarativePoliciesReportsOutput

An instance of DescribeDeclarativePoliciesReportsOutput.

Input

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

DescribeDeclarativePoliciesReportsInputDict

Bases: TypedDict

Dictionary form of DescribeDeclarativePoliciesReportsInput.

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.

max_results instance-attribute
max_results: int | None

The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output. For more information, see Pagination.

next_token instance-attribute
next_token: str | None

The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.

report_ids instance-attribute
report_ids: Sequence[str] | None

One or more report IDs.

DescribeDeclarativePoliciesReportsInput dataclass

Bases: _SerdeShape

Dataclass for DescribeDeclarativePoliciesReportsInput 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.

max_results class-attribute instance-attribute
max_results: int | None = ...

The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output. For more information, see Pagination.

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

The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.

report_ids class-attribute instance-attribute
report_ids: list[str] | None = ...

One or more report IDs.

Output

DescribeDeclarativePoliciesReportsOutput dataclass

Bases: _SerdeShape

Dataclass for DescribeDeclarativePoliciesReportsOutput structure.

Attributes

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

The token to include in another request to get the next page of items. This value is null when there are no more items to return.

reports class-attribute instance-attribute
reports: list[DeclarativePoliciesReport] | None = ...

The report metadata.

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.