CoverageSummary
Important
This is not available during the preview release.
Counts describing the coverage of a completed Organizational Report. Includes the number of accounts in scope, how many had a profile, how many failed, and aggregated recommendation counts by pillar and priority. Returned only by GetAgentOrganizationalReport after the report reaches COMPLETED status. Not returned on the list response.
Contents
- accountsWithoutProfile
-
Number of in-scope accounts that had no Agent Profile at the time of the snapshot.
Type: Long
Required: Yes
- accountsWithProfile
-
Number of in-scope accounts that had an Agent Profile and were successfully processed.
Type: Long
Required: Yes
- failedAccountCount
-
Number of in-scope accounts that errored during processing. Equal to the length of failedAccounts.
Type: Long
Required: Yes
- totalAccountsInScope
-
Total number of accounts that were in scope for the report after applying all filters and AWS Organizations membership validation.
Type: Long
Required: Yes
- totalProfiles
-
Total number of Agent Profiles contributing to the report.
Type: Long
Required: Yes
- totalRecommendations
-
Total number of recommendations included in the report across all profiles and all pillars.
Type: Long
Required: Yes
- failedAccounts
-
Accounts that errored during processing and the reason they failed.
Type: Array of FailedAccount objects
Array Members: Minimum number of 0 items. Maximum number of 1000 items.
Required: No
- failedOrganizationalUnits
-
Organizational units named in the report's filters that could not be expanded into their member accounts, along with the reason each failed. A failed OU means the report is missing whatever accounts it contained. Absent or empty when every requested OU expanded successfully.
Type: Array of FailedOrganizationalUnit objects
Array Members: Minimum number of 0 items. Maximum number of 1000 items.
Required: No
- recommendationCountByPillar
-
Recommendation count grouped by Well-Architected pillar. Each entry pairs a Pillar enum value with a non-negative long. The counts sum to totalRecommendations.
Type: Array of PillarCount objects
Array Members: Minimum number of 0 items. Maximum number of 10 items.
Required: No
- recommendationCountByPriority
-
Recommendation count grouped by Priority. Each entry pairs a Priority enum value with a non-negative long. The counts sum to totalRecommendations.
Type: Array of PriorityCount objects
Array Members: Minimum number of 0 items. Maximum number of 10 items.
Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
