OrganizationalReportFilters

Important

This is not available during the preview release.

Filters narrowing the scope of an Organizational Report. Every member is optional. An absent or empty member places no constraint on that dimension. When the entire structure is absent, the report covers every account and every recommendation in the organization.

accountIds

AWS account IDs to include in the report. Absent or empty means all accounts in the organization are in scope. Each supplied account is validated against AWS Organizations membership. Accounts that do not belong to the caller's organization are excluded and recorded on the report's coverage summary.

Type: Array of strings

Array Members: Minimum number of 0 items. Maximum number of 10000 items.

Pattern: \d{12}

Required: No

createdAtRange

Inclusive window on recommendation creation time. Absent means no lower or upper bound on createdAt.

Type: TimeWindow object

Required: No

organizationalUnitIds

AWS Organizational Unit IDs whose member accounts are included in the report. Absent or empty means no OU-based scoping is applied. Account and OU filters combine as a union.

Type: Array of strings

Array Members: Minimum number of 0 items. Maximum number of 10000 items.

Pattern: ou-[0-9a-z]{4,32}-[a-z0-9]{8,32}

Required: No

pillars

Well-Architected pillars to include. Absent or empty means all pillars.

Type: Array of strings

Array Members: Minimum number of 0 items. Maximum number of 10 items.

Valid Values: COST_OPTIMIZATION | SECURITY | RESILIENCE | PERFORMANCE | OPERATIONAL_EXCELLENCE

Required: No

priorities

Recommendation priorities (HIGH, MEDIUM, LOW) to include. Absent or empty means all priorities.

Type: Array of strings

Array Members: Minimum number of 0 items. Maximum number of 10 items.

Valid Values: HIGH | MEDIUM | LOW

Required: No

recommendationTypes

Recommendation types (RESOURCE, ARCHITECTURE, APPLICATION) to include. Absent or empty means all types.

Type: Array of strings

Array Members: Minimum number of 0 items. Maximum number of 10 items.

Valid Values: RESOURCE | ARCHITECTURE | APPLICATION

Required: No

statuses

Recommendation statuses (ACTIVE, SUPPRESSED, COMPLETED) to include. Absent or empty means all statuses.

Type: Array of strings

Array Members: Minimum number of 0 items. Maximum number of 10 items.

Valid Values: ACTIVE | SUPPRESSED | COMPLETED

Required: No

updatedAtRange

Inclusive window on recommendation last-updated time. Absent means no lower or upper bound on updatedAt.

Type: TimeWindow object

Required: No

OrganizationalReportFilters

Important

Contents

See Also