get_declarative_policies_report_summary¶
Operation¶
get_declarative_policies_report_summary
¶
get_declarative_policies_report_summary(request: GetDeclarativePoliciesReportSummaryInput | GetDeclarativePoliciesReportSummaryInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[GetDeclarativePoliciesReportSummaryInputDict]) -> GetDeclarativePoliciesReportSummaryOutput
Retrieves a summary of the account status 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
|
GetDeclarativePoliciesReportSummaryInput | GetDeclarativePoliciesReportSummaryInputDict | 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[GetDeclarativePoliciesReportSummaryInputDict]
|
The input fields as keyword arguments. |
{}
|
Returns:
| Type | Description |
|---|---|
GetDeclarativePoliciesReportSummaryOutput
|
An instance of |
get_declarative_policies_report_summary
async
¶
get_declarative_policies_report_summary(request: GetDeclarativePoliciesReportSummaryInput | GetDeclarativePoliciesReportSummaryInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[GetDeclarativePoliciesReportSummaryInputDict]) -> GetDeclarativePoliciesReportSummaryOutput
Retrieves a summary of the account status 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
|
GetDeclarativePoliciesReportSummaryInput | GetDeclarativePoliciesReportSummaryInputDict | 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[GetDeclarativePoliciesReportSummaryInputDict]
|
The input fields as keyword arguments. |
{}
|
Returns:
| Type | Description |
|---|---|
GetDeclarativePoliciesReportSummaryOutput
|
An instance of |
Input¶
Pass the input as keyword arguments, a positional dictionary, or a positional model object. Pass plugins separately as a keyword argument.
GetDeclarativePoliciesReportSummaryInputDict
¶
Bases: TypedDict
Dictionary form of GetDeclarativePoliciesReportSummaryInput.
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.
GetDeclarativePoliciesReportSummaryInput
dataclass
¶
Bases: _SerdeShape
Dataclass for GetDeclarativePoliciesReportSummaryInput 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.
Output¶
GetDeclarativePoliciesReportSummaryOutput
dataclass
¶
Bases: _SerdeShape
Dataclass for GetDeclarativePoliciesReportSummaryOutput structure.
Attributes¶
attribute_summaries
class-attribute
instance-attribute
¶
attribute_summaries: list[AttributeSummary] | None = ...
The attributes described in the report.
end_time
class-attribute
instance-attribute
¶
end_time: datetime | None = ...
The time when the report generation ended.
number_of_accounts
class-attribute
instance-attribute
¶
number_of_accounts: int | None = ...
The total number of accounts associated with the specified targetId.
number_of_failed_accounts
class-attribute
instance-attribute
¶
number_of_failed_accounts: int | None = ...
The number of accounts where attributes could not be retrieved in any Region.
response_metadata
class-attribute
instance-attribute
¶
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.
s3_bucket
class-attribute
instance-attribute
¶
s3_bucket: str | None = ...
The name of the Amazon S3 bucket where the report is located.
s3_prefix
class-attribute
instance-attribute
¶
s3_prefix: str | None = ...
The prefix for your S3 object.