start_declarative_policies_report¶
Operation¶
start_declarative_policies_report
async
¶
start_declarative_policies_report(request: StartDeclarativePoliciesReportInput | StartDeclarativePoliciesReportInputDict, /, *, plugins: list[Plugin] | None = None) -> StartDeclarativePoliciesReportOutput
start_declarative_policies_report(*, plugins: list[Plugin] | None = None, **kwargs: Unpack[StartDeclarativePoliciesReportInputDict]) -> StartDeclarativePoliciesReportOutput
Generates an account status report. The report is generated asynchronously, and can take several hours to complete.
The report provides the current status of all attributes supported by
declarative policies for the accounts within the specified scope. The
scope is determined by the specified TargetId, which can represent an
individual account, or all the accounts that fall under the specified
organizational unit (OU) or root (the entire Amazon Web Services
Organization).
The report is saved to your specified S3 bucket, using the following path structure (with the capitalized placeholders representing your specific values):
s3://AMZN-S3-DEMO-BUCKET/YOUR-OPTIONAL-S3-PREFIX/ec2_TARGETID_REPORTID_YYYYMMDDTHHMMZ.csv
Prerequisites for generating a report
-
The
StartDeclarativePoliciesReportAPI can only be called by the management account or delegated administrators for the organization. -
An S3 bucket must be available before generating the report (you can create a new one or use an existing one), it must be in the same Region where the report generation request is made, and it must have an appropriate bucket policy. For a sample S3 policy, see Sample Amazon S3 policy under Examples.
-
Trusted access must be enabled for the service for which the declarative policy will enforce a baseline configuration. If you use the Amazon Web Services Organizations console, this is done automatically when you enable declarative policies. The API uses the following service principal to identify the EC2 service:
ec2.amazonaws.com. For more information on how to enable trusted access with the Amazon Web Services CLI and Amazon Web Services SDKs, see Using Organizations with other Amazon Web Services services in the Amazon Web Services Organizations User Guide. -
Only one report per organization can be generated at a time. Attempting to generate a report while another is in progress will result in an error.
For more information, including the required IAM permissions to run this API, see Generating the account status report for declarative policies in the Amazon Web Services Organizations User Guide.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
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
|
Returns:
| Type | Description |
|---|---|
StartDeclarativePoliciesReportOutput
|
An instance of |
Input¶
Pass the input fields as keyword arguments, or pass a model or dictionary as the first positional argument. Pass plugins separately as a keyword argument.
Model¶
StartDeclarativePoliciesReportInput
dataclass
¶
Bases: _SerdeShape
Dataclass for StartDeclarativePoliciesReportInput 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.
s3_bucket
class-attribute
instance-attribute
¶
s3_bucket: str | None = ...
The name of the S3 bucket where the report will be saved. The bucket must be in the same Region where the report generation request is made.
s3_prefix
class-attribute
instance-attribute
¶
s3_prefix: str | None = ...
The prefix for your S3 object.
tag_specifications
class-attribute
instance-attribute
¶
tag_specifications: list[TagSpecification] | None = ...
The tags to apply.
Dictionaries¶
StartDeclarativePoliciesReportInputDict
¶
Bases: TypedDict
Dictionary form of StartDeclarativePoliciesReportInput.
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.
s3_bucket
instance-attribute
¶
The name of the S3 bucket where the report will be saved. The bucket must be in the same Region where the report generation request is made.
tag_specifications
instance-attribute
¶
tag_specifications: Sequence[TagSpecification | TagSpecificationDict] | None
The tags to apply.
Output¶
StartDeclarativePoliciesReportOutput
dataclass
¶
Bases: _SerdeShape
Dataclass for StartDeclarativePoliciesReportOutput structure.