GetDeclarativePoliciesReportSummary
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 AWS Organizations User Guide.
Request Parameters
The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see Common Query Parameters.
- DryRun
-
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 isUnauthorizedOperation.Type: Boolean
Required: No
- ReportId
-
The ID of the report.
Type: String
Required: Yes
Response Elements
The following elements are returned by the service.
- attributeSummarySet
-
The attributes described in the report.
Type: Array of AttributeSummary objects
- endTime
-
The time when the report generation ended.
Type: Timestamp
- numberOfAccounts
-
The total number of accounts associated with the specified
targetId.Type: Integer
- numberOfFailedAccounts
-
The number of accounts where attributes could not be retrieved in any Region.
Type: Integer
- reportId
-
The ID of the report.
Type: String
- requestId
-
The ID of the request.
Type: String
- s3Bucket
-
The name of the Amazon S3 bucket where the report is located.
Type: String
- s3Prefix
-
The prefix for your S3 object.
Type: String
- startTime
-
The time when the report generation started.
Type: Timestamp
- targetId
-
The root ID, organizational unit ID, or account ID.
Format:
-
For root:
r-ab12 -
For OU:
ou-ab12-cdef1234 -
For account:
123456789012
Type: String
-
Errors
For information about the errors that are common to all actions, see Common client error codes.
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
