2026/11/16 - AWS Well-Architected Tool - 17 new9 updated api methods
Changes This release adds AWS Organizations integration, on-demand reports, recommendation and profile sharing, and automated basic profiles to the Well-Architected Agent.
Retrieves metadata and current state for a single Organizational Report. The coverageSummary is populated once the report reaches COMPLETED and is absent for reports still in progress or in a failed state.
See also: AWS API Documentation
Request Syntax
client.get_agent_organizational_report(
reportId='string'
)
string
[REQUIRED]
Identifier of the report to retrieve.
dict
Response Syntax
{
'reportId': 'string',
'ownerAccountId': 'string',
'organizationId': 'string',
'label': 'string',
'state': 'DISCOVERING'|'SNAPSHOTTING'|'AGGREGATING'|'COMPRESSING'|'COMPLETED'|'FAILED'|'DELETING',
'createdAt': datetime(2015, 1, 1),
'filters': {
'accountIds': [
'string',
],
'organizationalUnitIds': [
'string',
],
'pillars': [
'COST_OPTIMIZATION'|'SECURITY'|'RESILIENCE'|'PERFORMANCE'|'OPERATIONAL_EXCELLENCE',
],
'recommendationTypes': [
'RESOURCE'|'ARCHITECTURE'|'APPLICATION',
],
'statuses': [
'ACTIVE'|'SUPPRESSED'|'COMPLETED',
],
'priorities': [
'HIGH'|'MEDIUM'|'LOW',
],
'createdAtRange': {
'from': datetime(2015, 1, 1),
'to': datetime(2015, 1, 1)
},
'updatedAtRange': {
'from': datetime(2015, 1, 1),
'to': datetime(2015, 1, 1)
}
},
'coverageSummary': {
'totalAccountsInScope': 123,
'accountsWithProfile': 123,
'accountsWithoutProfile': 123,
'failedAccountCount': 123,
'totalProfiles': 123,
'totalRecommendations': 123,
'recommendationCountByPillar': [
{
'pillar': 'COST_OPTIMIZATION'|'SECURITY'|'RESILIENCE'|'PERFORMANCE'|'OPERATIONAL_EXCELLENCE',
'count': 123
},
],
'recommendationCountByPriority': [
{
'priority': 'HIGH'|'MEDIUM'|'LOW',
'count': 123
},
],
'failedAccounts': [
{
'accountId': 'string',
'reason': 'string'
},
],
'failedOrganizationalUnits': [
{
'organizationalUnitId': 'string',
'reason': 'string'
},
]
}
}
Response Structure
(dict) --
reportId (string) --
Unique identifier of the Organizational Report assigned by the service at creation time.
ownerAccountId (string) --
AWS account ID of the caller that created the report. Only this account or a delegated administrator of the same organization may retrieve or delete the report.
organizationId (string) --
Identifier of the AWS Organization the report belongs to. Derived from the caller's authorization context at creation time and not accepted as a client-supplied input.
label (string) --
Optional human-readable label supplied by the caller at creation time.
state (string) --
Current lifecycle state of the report.
createdAt (datetime) --
Timestamp at which the report was created.
filters (dict) --
Filters captured when the report was created. Absent when no filters were supplied (meaning the report covered the whole organization).
accountIds (list) --
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.
(string) --
organizationalUnitIds (list) --
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.
(string) --
pillars (list) --
Well-Architected pillars to include. Absent or empty means all pillars.
(string) --
A pillar of the Amazon Web Services Well-Architected Framework, used to scope recommendation generation.
recommendationTypes (list) --
Recommendation types (RESOURCE, ARCHITECTURE, APPLICATION) to include. Absent or empty means all types.
(string) --
The type of a recommendation.
statuses (list) --
Recommendation statuses (ACTIVE, SUPPRESSED, COMPLETED) to include. Absent or empty means all statuses.
(string) --
The status of a recommendation.
priorities (list) --
Recommendation priorities (HIGH, MEDIUM, LOW) to include. Absent or empty means all priorities.
(string) --
The priority of a recommendation.
createdAtRange (dict) --
Inclusive window on recommendation creation time. Absent means no lower or upper bound on createdAt.
from (datetime) --
Lower bound of the window (inclusive). Absent means no lower bound.
to (datetime) --
Upper bound of the window (inclusive). Absent means no upper bound.
updatedAtRange (dict) --
Inclusive window on recommendation last-updated time. Absent means no lower or upper bound on updatedAt.
from (datetime) --
Lower bound of the window (inclusive). Absent means no lower bound.
to (datetime) --
Upper bound of the window (inclusive). Absent means no upper bound.
coverageSummary (dict) --
Coverage and aggregate counts for the report. Present only after the report reaches COMPLETED.
totalAccountsInScope (integer) --
Total number of accounts that were in scope for the report after applying all filters and AWS Organizations membership validation.
accountsWithProfile (integer) --
Number of in-scope accounts that had an Agent Profile and were successfully processed.
accountsWithoutProfile (integer) --
Number of in-scope accounts that had no Agent Profile at the time of the snapshot.
failedAccountCount (integer) --
Number of in-scope accounts that errored during processing. Equal to the length of failedAccounts.
totalProfiles (integer) --
Total number of Agent Profiles contributing to the report.
totalRecommendations (integer) --
Total number of recommendations included in the report across all profiles and all pillars.
recommendationCountByPillar (list) --
Recommendation count grouped by Well-Architected pillar. Each entry pairs a Pillar enum value with a non-negative long. The counts sum to totalRecommendations.
(dict) --
Pair of a Well-Architected pillar and the number of recommendations attributed to it in a CoverageSummary.
pillar (string) --
Well-Architected pillar this count is attributed to.
count (integer) --
Non-negative count of recommendations in the report that are attributed to this pillar.
recommendationCountByPriority (list) --
Recommendation count grouped by Priority. Each entry pairs a Priority enum value with a non-negative long. The counts sum to totalRecommendations.
(dict) --
Pair of a recommendation Priority and the number of recommendations attributed to it in a CoverageSummary.
priority (string) --
Priority this count is attributed to.
count (integer) --
Non-negative count of recommendations in the report that are attributed to this priority.
failedAccounts (list) --
Accounts that errored during processing and the reason they failed.
(dict) --
An account that was in scope for an Organizational Report but could not be processed, along with the reason for the failure.
accountId (string) --
The AWS account ID that failed.
reason (string) --
A human-readable explanation of why the account could not be processed.
failedOrganizationalUnits (list) --
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.
(dict) --
An organizational unit that was requested in an Organizational Report's filters but could not be expanded into its member accounts. A failed OU means the report is missing the accounts it contained.
organizationalUnitId (string) --
The AWS Organizations OU ID that could not be expanded.
reason (string) --
A human-readable explanation of why the organizational unit could not be expanded.
Removes the resource-based policy from an Agent Profile. This revokes all cross-account access previously granted by the policy. Only the profile owner can call this operation.
See also: AWS API Documentation
Request Syntax
client.delete_agent_profile_policy(
profileArn='string'
)
string
[REQUIRED]
The ARN of the Agent Profile whose policy to delete.
dict
Response Syntax
{}
Response Structure
(dict) --
Retrieves the resource-based policy attached to an individual Agent Recommendation. The recommendation owner or any principal with profile write access on the parent profile can call this operation.
See also: AWS API Documentation
Request Syntax
client.get_agent_recommendation_policy(
recommendationArn='string'
)
string
[REQUIRED]
The ARN of the Agent Recommendation whose policy to retrieve.
dict
Response Syntax
{
'recommendationArn': 'string',
'policy': 'string'
}
Response Structure
(dict) --
recommendationArn (string) --
The ARN of the Agent Recommendation.
policy (string) --
The IAM resource-based policy document in JSON format.
Creates a Basic profile for the calling account. No configuration input is required because the account and region are inferred from the caller. The profile uses the reserved name basic. This operation is idempotent. Calling it twice returns the same ARN. Each account can have at most one Basic profile.
See also: AWS API Documentation
Request Syntax
client.create_agent_basic_profile(
tags=[
{
'key': 'string',
'value': 'string'
},
]
)
list
Tags to apply to the Basic profile at creation time.
(dict) --
A key-value pair associated with a resource for cost allocation and access control.
key (string) -- [REQUIRED]
The key of the tag.
value (string) -- [REQUIRED]
The value of the tag.
dict
Response Syntax
{
'createdBy': 'string',
'createdAt': datetime(2015, 1, 1),
'lastModifiedBy': 'string',
'lastModifiedAt': datetime(2015, 1, 1),
'arn': 'string'
}
Response Structure
(dict) --
createdBy (string) --
The identifier of the user or system that created this resource.
createdAt (datetime) --
The timestamp when the resource was created.
lastModifiedBy (string) --
The identifier of the user or system that last modified this resource.
lastModifiedAt (datetime) --
The timestamp when the resource was last modified.
arn (string) --
The Amazon Resource Name (ARN) of the created Basic profile.
Creates or replaces the caller's Well-Architected Agent preferences. Each supplied update sets the desired state of one preference. Preferences not named in the request are left unchanged. Enabling or disabling is performed synchronously, so a failure to reach the requested state is returned as a modeled exception rather than a FAILED status. On success the operation returns an empty response. Call GetAgentPreferences to read the resulting state. The account the preferences belong to is inferred from the caller's authorization context.
See also: AWS API Documentation
Request Syntax
client.put_agent_preferences(
preferences=[
{
'key': 'ORG_INTEGRATION',
'state': 'ENABLED'|'DISABLED'
},
]
)
list
[REQUIRED]
Preference updates to apply. A given preference key may appear at most once.
(dict) --
A caller's requested change to one preference, supplied to PutAgentPreferences.
key (string) -- [REQUIRED]
Which preference to update.
state (string) -- [REQUIRED]
State to set the preference to. FAILED is an observed state only and cannot be requested.
dict
Response Syntax
{}
Response Structure
(dict) --
Deletes an Organizational Report and its associated artifacts. The operation is idempotent, so repeated calls for a report that has already been deleted return success.
See also: AWS API Documentation
Request Syntax
client.delete_agent_organizational_report(
reportId='string'
)
string
[REQUIRED]
Identifier of the report to delete.
dict
Response Syntax
{}
Response Structure
(dict) --
Creates an Organizational Profile for use with AWS Organizations integration. Organizational Profiles are scoped to an AWS Organization and do not require an execution role or aggregation configuration. The organization is inferred from the caller's identity.
See also: AWS API Documentation
Request Syntax
client.create_agent_organizational_profile(
name='string',
displayName='string',
description='string',
businessOverview='string',
pillars=[
'COST_OPTIMIZATION'|'SECURITY'|'RESILIENCE'|'PERFORMANCE'|'OPERATIONAL_EXCELLENCE',
],
deletionProtection=True|False,
clientToken='string',
organizationalAggregationConfiguration={
'organizationalUnits': [
{
'organizationalUnitId': 'string',
'regions': [
'string',
]
},
],
'accounts': [
{
'accountId': 'string',
'regions': [
'string',
]
},
]
},
tags=[
{
'key': 'string',
'value': 'string'
},
]
)
string
[REQUIRED]
The system name of the organizational profile.
string
The display name of the organizational profile shown to users.
string
A description of the organizational profile.
string
The business overview for this organizational profile.
list
[REQUIRED]
The Amazon Web Services Well-Architected Framework pillars to associate with this organizational profile.
(string) --
A pillar of the Amazon Web Services Well-Architected Framework, used to scope recommendation generation.
boolean
Indicates whether deletion protection is enabled for the organizational profile.
string
A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
This field is autopopulated if not provided.
dict
The organizational monitoring boundary. Contains organizational unit or root entries and individual account entries that define the scope for the profile.
organizationalUnits (list) --
A list of organizational unit or root entries that define the organizational scope. Each entry specifies an OU or root ID and the regions to monitor within it.
(dict) --
An organizational unit or root entry in the organizational monitoring boundary, with its associated regions.
organizationalUnitId (string) -- [REQUIRED]
The AWS Organizations organizational unit ID or root ID. Must match the pattern r-[a-z0-9]{4,32} for roots or ou-[a-z0-9]{4,32}-[a-z0-9]{8,32} for OUs.
regions (list) -- [REQUIRED]
The list of regions to monitor for this organizational unit or root.
(string) --
accounts (list) --
A list of individual account entries that define additional accounts to include. Each entry specifies an account ID and the regions to monitor within it.
(dict) --
An individual account entry in the organizational monitoring boundary, with its associated regions.
accountId (string) -- [REQUIRED]
The Amazon Web Services account ID to include in the monitoring boundary.
regions (list) -- [REQUIRED]
The list of regions to monitor for this account.
(string) --
list
The tags to associate with the organizational profile.
(dict) --
A key-value pair associated with a resource for cost allocation and access control.
key (string) -- [REQUIRED]
The key of the tag.
value (string) -- [REQUIRED]
The value of the tag.
dict
Response Syntax
{
'name': 'string',
'displayName': 'string',
'description': 'string',
'businessOverview': 'string',
'pillars': [
'COST_OPTIMIZATION'|'SECURITY'|'RESILIENCE'|'PERFORMANCE'|'OPERATIONAL_EXCELLENCE',
],
'deletionProtection': True|False,
'organizationId': 'string',
'organizationalAggregationConfiguration': {
'organizationalUnits': [
{
'organizationalUnitId': 'string',
'regions': [
'string',
]
},
],
'accounts': [
{
'accountId': 'string',
'regions': [
'string',
]
},
]
},
'arn': 'string',
'eligibleForScheduledGeneration': True|False,
'eligibleForArchitectureGeneration': True|False,
'fieldErrors': {
'string': 'string'
},
'tags': [
{
'key': 'string',
'value': 'string'
},
],
'createdBy': 'string',
'createdAt': datetime(2015, 1, 1),
'lastModifiedBy': 'string',
'lastModifiedAt': datetime(2015, 1, 1)
}
Response Structure
(dict) --
name (string) --
The system name of the created organizational profile.
displayName (string) --
The display name of the created organizational profile.
description (string) --
A description of the created organizational profile.
businessOverview (string) --
The business overview of the created organizational profile.
pillars (list) --
The Amazon Web Services Well-Architected Framework pillars associated with the created organizational profile.
(string) --
A pillar of the Amazon Web Services Well-Architected Framework, used to scope recommendation generation.
deletionProtection (boolean) --
Indicates whether deletion protection is enabled.
organizationId (string) --
The identifier of the Amazon Web Services Organization this profile belongs to.
organizationalAggregationConfiguration (dict) --
The organizational monitoring boundary for the created profile. Present only for organizational profiles.
organizationalUnits (list) --
A list of organizational unit or root entries that define the organizational scope. Each entry specifies an OU or root ID and the regions to monitor within it.
(dict) --
An organizational unit or root entry in the organizational monitoring boundary, with its associated regions.
organizationalUnitId (string) --
The AWS Organizations organizational unit ID or root ID. Must match the pattern r-[a-z0-9]{4,32} for roots or ou-[a-z0-9]{4,32}-[a-z0-9]{8,32} for OUs.
regions (list) --
The list of regions to monitor for this organizational unit or root.
(string) --
accounts (list) --
A list of individual account entries that define additional accounts to include. Each entry specifies an account ID and the regions to monitor within it.
(dict) --
An individual account entry in the organizational monitoring boundary, with its associated regions.
accountId (string) --
The Amazon Web Services account ID to include in the monitoring boundary.
regions (list) --
The list of regions to monitor for this account.
(string) --
arn (string) --
The Amazon Resource Name (ARN) of the created organizational profile.
eligibleForScheduledGeneration (boolean) --
Indicates whether the profile is valid for scheduled recommendation generation.
eligibleForArchitectureGeneration (boolean) --
Indicates whether the profile is valid for manual architecture generation.
fieldErrors (dict) --
A map of field paths to error messages for invalid or missing input fields.
(string) --
(string) --
tags (list) --
The tags associated with the created organizational profile.
(dict) --
A key-value pair associated with a resource for cost allocation and access control.
key (string) --
The key of the tag.
value (string) --
The value of the tag.
createdBy (string) --
The identifier of the user or system that created this organizational profile.
createdAt (datetime) --
The timestamp when the organizational profile was created.
lastModifiedBy (string) --
The identifier of the user or system that last modified this organizational profile.
lastModifiedAt (datetime) --
The timestamp when the organizational profile was last modified.
Lists Organizational Reports owned by the caller's account within the caller's AWS Organization, ordered by most recently created first. Supports pagination and an optional state filter.
See also: AWS API Documentation
Request Syntax
client.list_agent_organizational_reports(
maxResults=123,
nextToken='string',
state='DISCOVERING'|'SNAPSHOTTING'|'AGGREGATING'|'COMPRESSING'|'COMPLETED'|'FAILED'|'DELETING'
)
integer
Maximum number of items to return in a single page. Defaults to 100.
string
Pagination token from a previous ListAgentOrganizationalReports response. Absent on the first page.
string
Optional filter restricting the response to reports in a single lifecycle state.
dict
Response Syntax
{
'items': [
{
'reportId': 'string',
'ownerAccountId': 'string',
'organizationId': 'string',
'label': 'string',
'state': 'DISCOVERING'|'SNAPSHOTTING'|'AGGREGATING'|'COMPRESSING'|'COMPLETED'|'FAILED'|'DELETING',
'createdAt': datetime(2015, 1, 1)
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
items (list) --
Page of report summaries, most-recently-created first.
(dict) --
Summary of an Organizational Report returned in a list response. Includes the core fields of the full report and the optional label, but omits the filters and coverage summary. The filters and coverage summary are available through GetAgentOrganizationalReport. The coverage summary is populated once the report reaches COMPLETED.
reportId (string) --
Unique identifier of the Organizational Report assigned by the service at creation time.
ownerAccountId (string) --
AWS account ID of the caller that created the report. Only this account or a delegated administrator of the same organization may retrieve or delete the report.
organizationId (string) --
Identifier of the AWS Organization the report belongs to. Derived from the caller's authorization context at creation time and not accepted as a client-supplied input.
label (string) --
Optional human-readable label supplied by the caller at creation time.
state (string) --
Current lifecycle state of the report.
createdAt (datetime) --
Timestamp at which the report was created.
nextToken (string) --
Pagination token to supply on the next request, or absent when there are no more pages.
Returns the caller's complete set of Well-Architected Agent preferences with their current states.
See also: AWS API Documentation
Request Syntax
client.get_agent_preferences()
dict
Response Syntax
{
'preferences': [
{
'key': 'ORG_INTEGRATION',
'status': 'ENABLED'|'DISABLED'|'FAILED',
'detail': 'string'
},
]
}
Response Structure
(dict) --
preferences (list) --
The caller's complete set of preferences.
(dict) --
A single Well-Architected Agent preference and its current state.
key (string) --
Which preference this entry describes.
status (string) --
Current state of the preference. ENABLED and DISABLED reflect the result of the most recent successful change. FAILED reflects a stored failure surfaced on a read and is accompanied by a detail message.
detail (string) --
A human-readable explanation present only when status is FAILED, describing what went wrong and how to recover.
Writes the data artifact for a completed Organizational Report directly into a caller-owned S3 bucket. The artifact is written in the requested format to the supplied bucketArn and objectKey, and the resulting S3 location is returned in deliveredTo. This operation creates an S3 object and should not be retried indiscriminately. To download the artifact through a short-lived presigned URL instead, use GetAgentOrganizationalReportData.
See also: AWS API Documentation
Request Syntax
client.send_agent_organizational_report_data_to_s3(
reportId='string',
format='CSV'|'JSON'|'PARQUET',
bucketArn='string',
objectKey='string'
)
string
[REQUIRED]
Identifier of the report whose data is being delivered.
string
[REQUIRED]
Format of the delivered artifact (CSV, JSON, or PARQUET).
string
[REQUIRED]
ARN of the caller-owned S3 bucket that will receive the artifact.
string
[REQUIRED]
S3 object key under bucketArn where the artifact will be written.
dict
Response Syntax
{
'deliveredTo': 'string'
}
Response Structure
(dict) --
deliveredTo (string) --
S3 URI (format s3://bucket/key) where the artifact was written.
Removes the resource-based policy from an individual Agent Recommendation. This revokes all cross-account access previously granted by the policy. The recommendation owner or any principal with profile write access on the parent profile can call this operation.
See also: AWS API Documentation
Request Syntax
client.delete_agent_recommendation_policy(
recommendationArn='string'
)
string
[REQUIRED]
The ARN of the Agent Recommendation whose policy to delete.
dict
Response Syntax
{}
Response Structure
(dict) --
Attaches or replaces a resource-based policy on an individual Agent Recommendation. The policy controls cross-account access to the recommendation and its child resources such as items and remediations. The recommendation owner or any principal with profile write access on the parent profile can call this operation. The policy must be valid IAM JSON with Allow-only statements and no negation condition operators.
See also: AWS API Documentation
Request Syntax
client.put_agent_recommendation_policy(
recommendationArn='string',
policy='string'
)
string
[REQUIRED]
The ARN of the Agent Recommendation to attach the policy to.
string
[REQUIRED]
The IAM resource-based policy document in JSON format. Maximum size 50KB.
dict
Response Syntax
{}
Response Structure
(dict) --
Attaches or replaces a resource-based policy on an Agent Profile. The policy controls cross-account access to the profile and its child resources such as recommendations, goals, and contexts. Only the profile owner can call this operation. The policy must be valid IAM JSON with Allow-only statements and no negation condition operators.
See also: AWS API Documentation
Request Syntax
client.put_agent_profile_policy(
profileArn='string',
policy='string'
)
string
[REQUIRED]
The ARN of the Agent Profile to attach the policy to.
string
[REQUIRED]
The IAM resource-based policy document in JSON format. Maximum size 50KB.
dict
Response Syntax
{}
Response Structure
(dict) --
Retrieves the resource-based policy attached to an Agent Profile. Only the profile owner can call this operation.
See also: AWS API Documentation
Request Syntax
client.get_agent_profile_policy(
profileArn='string'
)
string
[REQUIRED]
The ARN of the Agent Profile whose policy to retrieve.
dict
Response Syntax
{
'profileArn': 'string',
'policy': 'string'
}
Response Structure
(dict) --
profileArn (string) --
The ARN of the Agent Profile.
policy (string) --
The IAM resource-based policy document in JSON format.
Updates an Organizational Profile. Organizational Profiles are specific to Profiles created using AWS Organizations integration. Include only the fields you want to change; any field you omit from the request keeps its current value.
To clear an optional text field, supply an empty string for it; the field is then unset, and a subsequent read omits it rather than returning an empty string. Omitting the field from the request leaves the stored value in place. description and businessOverview can be cleared this way. displayName cannot be cleared because a display name is required, though you can change it. pillars cannot be cleared because a profile must target at least one pillar.
organizationalAggregationConfiguration behaves differently because it is a structure rather than a text field. Supplying it with both its organizationalUnits and accounts lists empty removes every monitored organizational unit and account, but the field itself remains set: a subsequent read returns the structure with two empty lists rather than omitting it. Omitting the field from the request keeps the stored boundary.
See also: AWS API Documentation
Request Syntax
client.update_agent_organizational_profile(
clientToken='string',
profileArn='string',
displayName='string',
description='string',
businessOverview='string',
pillars=[
'COST_OPTIMIZATION'|'SECURITY'|'RESILIENCE'|'PERFORMANCE'|'OPERATIONAL_EXCELLENCE',
],
deletionProtection=True|False,
organizationalAggregationConfiguration={
'organizationalUnits': [
{
'organizationalUnitId': 'string',
'regions': [
'string',
]
},
],
'accounts': [
{
'accountId': 'string',
'regions': [
'string',
]
},
]
}
)
string
A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
This field is autopopulated if not provided.
string
[REQUIRED]
The Amazon Resource Name (ARN) of the organizational profile to update.
string
The updated display name of the organizational profile. Omit this field to keep the current display name. A display name is required, so it cannot be cleared.
string
The updated description of the organizational profile. Omit this field to keep the current description, or supply an empty string to clear it; a cleared description is read back as absent rather than as an empty string.
string
The updated business overview for the organizational profile. Omit this field to keep the current business overview, or supply an empty string to clear it; a cleared business overview is read back as absent rather than as an empty string.
list
The updated Amazon Web Services Well-Architected Framework pillars for the organizational profile. Omit this field to keep the current pillars. A profile must target at least one pillar, so an empty list is rejected.
(string) --
A pillar of the Amazon Web Services Well-Architected Framework, used to scope recommendation generation.
boolean
Indicates whether deletion protection is enabled for the organizational profile.
dict
The organizational monitoring boundary. Contains organizational unit or root entries and individual account entries that define the scope for the profile. Omit this field to keep the current boundary, or supply this structure with both its organizationalUnits and accounts lists empty to remove every monitored organizational unit and account. The field remains set either way — an emptied boundary is read back as a structure with two empty lists, not as an absent field.
organizationalUnits (list) --
A list of organizational unit or root entries that define the organizational scope. Each entry specifies an OU or root ID and the regions to monitor within it.
(dict) --
An organizational unit or root entry in the organizational monitoring boundary, with its associated regions.
organizationalUnitId (string) -- [REQUIRED]
The AWS Organizations organizational unit ID or root ID. Must match the pattern r-[a-z0-9]{4,32} for roots or ou-[a-z0-9]{4,32}-[a-z0-9]{8,32} for OUs.
regions (list) -- [REQUIRED]
The list of regions to monitor for this organizational unit or root.
(string) --
accounts (list) --
A list of individual account entries that define additional accounts to include. Each entry specifies an account ID and the regions to monitor within it.
(dict) --
An individual account entry in the organizational monitoring boundary, with its associated regions.
accountId (string) -- [REQUIRED]
The Amazon Web Services account ID to include in the monitoring boundary.
regions (list) -- [REQUIRED]
The list of regions to monitor for this account.
(string) --
dict
Response Syntax
{
'name': 'string',
'displayName': 'string',
'description': 'string',
'businessOverview': 'string',
'pillars': [
'COST_OPTIMIZATION'|'SECURITY'|'RESILIENCE'|'PERFORMANCE'|'OPERATIONAL_EXCELLENCE',
],
'deletionProtection': True|False,
'organizationId': 'string',
'organizationalAggregationConfiguration': {
'organizationalUnits': [
{
'organizationalUnitId': 'string',
'regions': [
'string',
]
},
],
'accounts': [
{
'accountId': 'string',
'regions': [
'string',
]
},
]
},
'arn': 'string',
'eligibleForScheduledGeneration': True|False,
'eligibleForArchitectureGeneration': True|False,
'fieldErrors': {
'string': 'string'
},
'createdBy': 'string',
'createdAt': datetime(2015, 1, 1),
'lastModifiedBy': 'string',
'lastModifiedAt': datetime(2015, 1, 1)
}
Response Structure
(dict) --
name (string) --
The system name of the updated organizational profile.
displayName (string) --
The display name of the updated organizational profile.
description (string) --
A description of the updated organizational profile.
businessOverview (string) --
The business overview of the updated organizational profile.
pillars (list) --
The Amazon Web Services Well-Architected Framework pillars associated with the updated organizational profile.
(string) --
A pillar of the Amazon Web Services Well-Architected Framework, used to scope recommendation generation.
deletionProtection (boolean) --
Indicates whether deletion protection is enabled.
organizationId (string) --
The identifier of the Amazon Web Services Organization this profile belongs to.
organizationalAggregationConfiguration (dict) --
The organizational monitoring boundary for the updated profile.
organizationalUnits (list) --
A list of organizational unit or root entries that define the organizational scope. Each entry specifies an OU or root ID and the regions to monitor within it.
(dict) --
An organizational unit or root entry in the organizational monitoring boundary, with its associated regions.
organizationalUnitId (string) --
The AWS Organizations organizational unit ID or root ID. Must match the pattern r-[a-z0-9]{4,32} for roots or ou-[a-z0-9]{4,32}-[a-z0-9]{8,32} for OUs.
regions (list) --
The list of regions to monitor for this organizational unit or root.
(string) --
accounts (list) --
A list of individual account entries that define additional accounts to include. Each entry specifies an account ID and the regions to monitor within it.
(dict) --
An individual account entry in the organizational monitoring boundary, with its associated regions.
accountId (string) --
The Amazon Web Services account ID to include in the monitoring boundary.
regions (list) --
The list of regions to monitor for this account.
(string) --
arn (string) --
The Amazon Resource Name (ARN) of the updated organizational profile.
eligibleForScheduledGeneration (boolean) --
Indicates whether the profile is valid for scheduled recommendation generation.
eligibleForArchitectureGeneration (boolean) --
Indicates whether the profile is valid for manual architecture generation.
fieldErrors (dict) --
A map of field paths to error messages for invalid or missing input fields.
(string) --
(string) --
createdBy (string) --
The identifier of the user or system that created this organizational profile.
createdAt (datetime) --
The timestamp when the organizational profile was created.
lastModifiedBy (string) --
The identifier of the user or system that last modified this organizational profile.
lastModifiedAt (datetime) --
The timestamp when the organizational profile was last modified.
Creates an Organizational Report, which is an asynchronously-materialized, point-in-time snapshot of recommendations across all Agent Profiles within the caller's AWS Organization. You can optionally narrow the scope with filters. The operation is idempotent on the caller-supplied clientToken. The AWS Organization the report belongs to is inferred from the caller's authorization context. Reports are retained for 90 days from creation, after which they are automatically deleted. Use DeleteAgentOrganizationalReport to delete a report earlier.
See also: AWS API Documentation
Request Syntax
client.create_agent_organizational_report(
clientToken='string',
label='string',
filters={
'accountIds': [
'string',
],
'organizationalUnitIds': [
'string',
],
'pillars': [
'COST_OPTIMIZATION'|'SECURITY'|'RESILIENCE'|'PERFORMANCE'|'OPERATIONAL_EXCELLENCE',
],
'recommendationTypes': [
'RESOURCE'|'ARCHITECTURE'|'APPLICATION',
],
'statuses': [
'ACTIVE'|'SUPPRESSED'|'COMPLETED',
],
'priorities': [
'HIGH'|'MEDIUM'|'LOW',
],
'createdAtRange': {
'from': datetime(2015, 1, 1),
'to': datetime(2015, 1, 1)
},
'updatedAtRange': {
'from': datetime(2015, 1, 1),
'to': datetime(2015, 1, 1)
}
}
)
string
A caller-supplied idempotency token. Two create calls sharing the same token within the service's idempotency window return the same reportId.
This field is autopopulated if not provided.
string
Optional human-readable label (1-500 characters) that helps callers distinguish reports created with the same filters. Carried through list and get responses.
dict
Optional filters narrowing the report's scope. Absent means the report covers the whole organization.
accountIds (list) --
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.
(string) --
organizationalUnitIds (list) --
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.
(string) --
pillars (list) --
Well-Architected pillars to include. Absent or empty means all pillars.
(string) --
A pillar of the Amazon Web Services Well-Architected Framework, used to scope recommendation generation.
recommendationTypes (list) --
Recommendation types (RESOURCE, ARCHITECTURE, APPLICATION) to include. Absent or empty means all types.
(string) --
The type of a recommendation.
statuses (list) --
Recommendation statuses (ACTIVE, SUPPRESSED, COMPLETED) to include. Absent or empty means all statuses.
(string) --
The status of a recommendation.
priorities (list) --
Recommendation priorities (HIGH, MEDIUM, LOW) to include. Absent or empty means all priorities.
(string) --
The priority of a recommendation.
createdAtRange (dict) --
Inclusive window on recommendation creation time. Absent means no lower or upper bound on createdAt.
from (datetime) --
Lower bound of the window (inclusive). Absent means no lower bound.
to (datetime) --
Upper bound of the window (inclusive). Absent means no upper bound.
updatedAtRange (dict) --
Inclusive window on recommendation last-updated time. Absent means no lower or upper bound on updatedAt.
from (datetime) --
Lower bound of the window (inclusive). Absent means no lower bound.
to (datetime) --
Upper bound of the window (inclusive). Absent means no upper bound.
dict
Response Syntax
{
'reportId': 'string',
'state': 'DISCOVERING'|'SNAPSHOTTING'|'AGGREGATING'|'COMPRESSING'|'COMPLETED'|'FAILED'|'DELETING'
}
Response Structure
(dict) --
reportId (string) --
Unique identifier assigned to the newly-created report.
state (string) --
Lifecycle state of the report at the moment the create call returned. For a freshly-created report this is typically DISCOVERING.
Retrieves the data artifact for a completed Organizational Report as a short-lived presigned S3 URL. The response contains the URL in downloadUrl and its expiration in expiresAt. To have the service write the artifact directly into a caller-owned bucket instead, use SendAgentOrganizationalReportDataToS3.
See also: AWS API Documentation
Request Syntax
client.get_agent_organizational_report_data(
reportId='string',
format='CSV'|'JSON'|'PARQUET'
)
string
[REQUIRED]
Identifier of the report whose data is being retrieved.
string
[REQUIRED]
Format of the returned artifact (CSV, JSON, or PARQUET).
dict
Response Syntax
{
'downloadUrl': 'string',
'expiresAt': datetime(2015, 1, 1)
}
Response Structure
(dict) --
downloadUrl (string) --
Presigned URL that can be used to download the artifact.
expiresAt (datetime) --
Expiration time of downloadUrl.
{'content': {'organizationalUnitIds': ['string']}}
Response {'context': {'content': {'organizationalUnitIds': ['string']}}}
Creates a context associated with an optimization profile. Contexts provide application and environment information used during recommendation generation.
See also: AWS API Documentation
Request Syntax
client.create_agent_context(
clientToken='string',
profileArn='string',
title='string',
contextType='APPLICATION',
content={
'accountIds': [
'string',
],
'regions': [
'string',
],
'awsServices': [
'string',
],
'resourceTypes': [
'string',
],
'resourceTags': [
{
'key': 'string',
'value': 'string'
},
],
'organizationalUnitIds': [
'string',
],
'applicationOverview': 'string',
'industry': 'string',
'applicationType': 'SAS'|'DESKTOP_APPLICATION'|'OTHER',
'criticality': 'MISSION_CRITICAL'|'BUSINESS_CRITICAL'|'NON_CRITICAL'|'TEST_DEVELOPMENT',
'architectureOverview': 'string',
'additionalContext': 'string'
}
)
string
A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
This field is autopopulated if not provided.
string
[REQUIRED]
The Amazon Resource Name (ARN) of the profile to associate the context with.
string
[REQUIRED]
The title of the context.
string
[REQUIRED]
The type of the context.
dict
[REQUIRED]
The typed content of the context. The structure contains application-specific fields such as account IDs, Regions, services, and resource types.
accountIds (list) --
The Amazon Web Services account IDs associated with this application context.
(string) --
regions (list) --
The Amazon Web Services Regions where this application operates.
(string) --
awsServices (list) --
The Amazon Web Services services used by this application.
(string) --
resourceTypes (list) --
The Amazon Web Services resource types relevant to this application.
(string) --
resourceTags (list) --
Resource tags used to scope this application context.
(dict) --
A key-value pair representing a resource tag used to scope context content.
key (string) -- [REQUIRED]
The tag key.
value (string) -- [REQUIRED]
The tag value.
organizationalUnitIds (list) --
The AWS Organizations organizational unit (OU) IDs associated with this application context. Valid only for organizational profiles; rejected for standard profiles.
(string) --
applicationOverview (string) --
A free-form overview of the application.
industry (string) --
The industry vertical for this application.
applicationType (string) --
The type of the application.
criticality (string) --
The business criticality of the application.
architectureOverview (string) --
A free-form description of the application architecture.
additionalContext (string) --
Additional context not captured by other fields.
dict
Response Syntax
{
'context': {
'id': 'string',
'profileArn': 'string',
'title': 'string',
'contextType': 'APPLICATION',
'content': {
'accountIds': [
'string',
],
'regions': [
'string',
],
'awsServices': [
'string',
],
'resourceTypes': [
'string',
],
'resourceTags': [
{
'key': 'string',
'value': 'string'
},
],
'organizationalUnitIds': [
'string',
],
'applicationOverview': 'string',
'industry': 'string',
'applicationType': 'SAS'|'DESKTOP_APPLICATION'|'OTHER',
'criticality': 'MISSION_CRITICAL'|'BUSINESS_CRITICAL'|'NON_CRITICAL'|'TEST_DEVELOPMENT',
'architectureOverview': 'string',
'additionalContext': 'string'
},
'applicationType': 'SAS'|'DESKTOP_APPLICATION'|'OTHER',
'criticality': 'MISSION_CRITICAL'|'BUSINESS_CRITICAL'|'NON_CRITICAL'|'TEST_DEVELOPMENT',
'createdBy': 'string',
'createdAt': datetime(2015, 1, 1),
'lastModifiedBy': 'string',
'lastModifiedAt': datetime(2015, 1, 1)
}
}
Response Structure
(dict) --
context (dict) --
The created context summary.
id (string) --
The unique identifier of the context.
profileArn (string) --
The Amazon Resource Name (ARN) of the associated profile.
title (string) --
The title of the context.
contextType (string) --
The type of the context.
content (dict) --
The typed content of the context, containing application-specific fields such as account IDs, Regions, services, and resource types.
accountIds (list) --
The Amazon Web Services account IDs associated with this application context.
(string) --
regions (list) --
The Amazon Web Services Regions where this application operates.
(string) --
awsServices (list) --
The Amazon Web Services services used by this application.
(string) --
resourceTypes (list) --
The Amazon Web Services resource types relevant to this application.
(string) --
resourceTags (list) --
Resource tags used to scope this application context.
(dict) --
A key-value pair representing a resource tag used to scope context content.
key (string) --
The tag key.
value (string) --
The tag value.
organizationalUnitIds (list) --
The AWS Organizations organizational unit (OU) IDs associated with this application context. Valid only for organizational profiles; rejected for standard profiles.
(string) --
applicationOverview (string) --
A free-form overview of the application.
industry (string) --
The industry vertical for this application.
applicationType (string) --
The type of the application.
criticality (string) --
The business criticality of the application.
architectureOverview (string) --
A free-form description of the application architecture.
additionalContext (string) --
Additional context not captured by other fields.
applicationType (string) --
The type of application described by this context.
criticality (string) --
The business criticality of the application described by this context.
createdBy (string) --
The identifier of the user or system that created this context.
createdAt (datetime) --
The timestamp when the context was created.
lastModifiedBy (string) --
The identifier of the user or system that last modified this context.
lastModifiedAt (datetime) --
The timestamp when the context was last modified.
{'context': {'content': {'organizationalUnitIds': ['string']}}}
Retrieves detailed information about a specific context associated with a profile.
See also: AWS API Documentation
Request Syntax
client.get_agent_context(
profileArn='string',
id='string'
)
string
[REQUIRED]
The Amazon Resource Name (ARN) of the profile containing the context.
string
[REQUIRED]
The unique identifier of the context to retrieve.
dict
Response Syntax
{
'context': {
'id': 'string',
'profileArn': 'string',
'title': 'string',
'contextType': 'APPLICATION',
'content': {
'accountIds': [
'string',
],
'regions': [
'string',
],
'awsServices': [
'string',
],
'resourceTypes': [
'string',
],
'resourceTags': [
{
'key': 'string',
'value': 'string'
},
],
'organizationalUnitIds': [
'string',
],
'applicationOverview': 'string',
'industry': 'string',
'applicationType': 'SAS'|'DESKTOP_APPLICATION'|'OTHER',
'criticality': 'MISSION_CRITICAL'|'BUSINESS_CRITICAL'|'NON_CRITICAL'|'TEST_DEVELOPMENT',
'architectureOverview': 'string',
'additionalContext': 'string'
},
'applicationType': 'SAS'|'DESKTOP_APPLICATION'|'OTHER',
'criticality': 'MISSION_CRITICAL'|'BUSINESS_CRITICAL'|'NON_CRITICAL'|'TEST_DEVELOPMENT',
'createdBy': 'string',
'createdAt': datetime(2015, 1, 1),
'lastModifiedBy': 'string',
'lastModifiedAt': datetime(2015, 1, 1)
}
}
Response Structure
(dict) --
context (dict) --
The retrieved context summary.
id (string) --
The unique identifier of the context.
profileArn (string) --
The Amazon Resource Name (ARN) of the associated profile.
title (string) --
The title of the context.
contextType (string) --
The type of the context.
content (dict) --
The typed content of the context, containing application-specific fields such as account IDs, Regions, services, and resource types.
accountIds (list) --
The Amazon Web Services account IDs associated with this application context.
(string) --
regions (list) --
The Amazon Web Services Regions where this application operates.
(string) --
awsServices (list) --
The Amazon Web Services services used by this application.
(string) --
resourceTypes (list) --
The Amazon Web Services resource types relevant to this application.
(string) --
resourceTags (list) --
Resource tags used to scope this application context.
(dict) --
A key-value pair representing a resource tag used to scope context content.
key (string) --
The tag key.
value (string) --
The tag value.
organizationalUnitIds (list) --
The AWS Organizations organizational unit (OU) IDs associated with this application context. Valid only for organizational profiles; rejected for standard profiles.
(string) --
applicationOverview (string) --
A free-form overview of the application.
industry (string) --
The industry vertical for this application.
applicationType (string) --
The type of the application.
criticality (string) --
The business criticality of the application.
architectureOverview (string) --
A free-form description of the application architecture.
additionalContext (string) --
Additional context not captured by other fields.
applicationType (string) --
The type of application described by this context.
criticality (string) --
The business criticality of the application described by this context.
createdBy (string) --
The identifier of the user or system that created this context.
createdAt (datetime) --
The timestamp when the context was created.
lastModifiedBy (string) --
The identifier of the user or system that last modified this context.
lastModifiedAt (datetime) --
The timestamp when the context was last modified.
{'organizationalAggregationConfiguration': {'accounts': [{'accountId': 'string',
'regions': ['string']}],
'organizationalUnits': [{'organizationalUnitId': 'string',
'regions': ['string']}]},
'profileType': 'STANDARD | BASIC | ORGANIZATIONAL'}
Retrieves detailed information about an optimization profile, including its configuration and metadata.
See also: AWS API Documentation
Request Syntax
client.get_agent_profile(
profileArn='string'
)
string
[REQUIRED]
The Amazon Resource Name (ARN) of the optimization profile to retrieve.
dict
Response Syntax
{
'name': 'string',
'displayName': 'string',
'description': 'string',
'businessOverview': 'string',
'pillars': [
'COST_OPTIMIZATION'|'SECURITY'|'RESILIENCE'|'PERFORMANCE'|'OPERATIONAL_EXCELLENCE',
],
'deletionProtection': True|False,
'profileType': 'STANDARD'|'BASIC'|'ORGANIZATIONAL',
'executionRoleArn': 'string',
'aggregationConfiguration': [
{
'accountId': 'string',
'regions': [
'string',
],
'accessRoleArn': 'string'
},
],
'arn': 'string',
'eligibleForScheduledGeneration': True|False,
'eligibleForArchitectureGeneration': True|False,
'fieldErrors': {
'string': 'string'
},
'tags': [
{
'key': 'string',
'value': 'string'
},
],
'createdBy': 'string',
'createdAt': datetime(2015, 1, 1),
'lastModifiedBy': 'string',
'lastModifiedAt': datetime(2015, 1, 1),
'organizationalAggregationConfiguration': {
'organizationalUnits': [
{
'organizationalUnitId': 'string',
'regions': [
'string',
]
},
],
'accounts': [
{
'accountId': 'string',
'regions': [
'string',
]
},
]
}
}
Response Structure
(dict) --
name (string) --
The system name of the profile.
displayName (string) --
The display name of the profile.
description (string) --
A description of the profile.
businessOverview (string) --
The business overview of the profile.
pillars (list) --
The Amazon Web Services Well-Architected Framework pillars associated with the profile. Not present for basic profiles.
(string) --
A pillar of the Amazon Web Services Well-Architected Framework, used to scope recommendation generation.
deletionProtection (boolean) --
Indicates whether deletion protection is enabled.
profileType (string) --
The type of the profile.
executionRoleArn (string) --
The ARN of the IAM execution role. Not present for basic profiles.
aggregationConfiguration (list) --
The aggregation configuration. Not present for basic profiles.
(dict) --
Configuration settings that define the scope of Amazon Web Services resources to analyze for optimization recommendations.
accountId (string) --
The Amazon Web Services account ID to analyze.
regions (list) --
A list of Amazon Web Services Regions to include in the analysis.
(string) --
accessRoleArn (string) --
The ARN of an IAM role to assume for resource analysis in this account.
arn (string) --
The Amazon Resource Name (ARN) of the profile.
eligibleForScheduledGeneration (boolean) --
Indicates whether the profile is valid for scheduled recommendation generation.
eligibleForArchitectureGeneration (boolean) --
Indicates whether the profile is valid for manual architecture generation.
fieldErrors (dict) --
A map of field paths to error messages for invalid or missing input fields.
(string) --
(string) --
tags (list) --
The tags associated with the profile.
(dict) --
A key-value pair associated with a resource for cost allocation and access control.
key (string) --
The key of the tag.
value (string) --
The value of the tag.
createdBy (string) --
The identifier of the user or system that created this profile.
createdAt (datetime) --
The timestamp when the profile was created.
lastModifiedBy (string) --
The identifier of the user or system that last modified this profile.
lastModifiedAt (datetime) --
The timestamp when the profile was last modified.
organizationalAggregationConfiguration (dict) --
The organizational monitoring boundary. Present only for organizational profiles.
organizationalUnits (list) --
A list of organizational unit or root entries that define the organizational scope. Each entry specifies an OU or root ID and the regions to monitor within it.
(dict) --
An organizational unit or root entry in the organizational monitoring boundary, with its associated regions.
organizationalUnitId (string) --
The AWS Organizations organizational unit ID or root ID. Must match the pattern r-[a-z0-9]{4,32} for roots or ou-[a-z0-9]{4,32}-[a-z0-9]{8,32} for OUs.
regions (list) --
The list of regions to monitor for this organizational unit or root.
(string) --
accounts (list) --
A list of individual account entries that define additional accounts to include. Each entry specifies an account ID and the regions to monitor within it.
(dict) --
An individual account entry in the organizational monitoring boundary, with its associated regions.
accountId (string) --
The Amazon Web Services account ID to include in the monitoring boundary.
regions (list) --
The list of regions to monitor for this account.
(string) --
{'generationRecommendationTypes': ['RESOURCE | ARCHITECTURE | APPLICATION'],
'generationType': 'ONDEMAND | SCHEDULED | BASIC'}
Retrieves information about a recommendation generation process, including its status, progress, and results. Recommendation generation is asynchronous: poll this operation until status reaches a terminal value of COMPLETED (results are ready) or ERROR (see errorDetails). Intermediate values are QUEUED and IN_PROGRESS.
See also: AWS API Documentation
Request Syntax
client.get_agent_recommendation_generation(
profileArn='string',
generationId='string'
)
string
[REQUIRED]
The ARN of the optimization profile associated with this generation.
string
[REQUIRED]
The unique identifier of the recommendation generation to retrieve.
dict
Response Syntax
{
'id': 'string',
'profileArn': 'string',
'name': 'string',
'status': 'QUEUED'|'IN_PROGRESS'|'COMPLETED'|'ERROR',
'estimatedCompletionTime': datetime(2015, 1, 1),
'createdBy': 'string',
'createdAt': datetime(2015, 1, 1),
'lastModifiedBy': 'string',
'lastModifiedAt': datetime(2015, 1, 1),
'generationType': 'ONDEMAND'|'SCHEDULED'|'BASIC',
'generationRecommendationTypes': [
'RESOURCE'|'ARCHITECTURE'|'APPLICATION',
],
'startedAt': datetime(2015, 1, 1),
'endedAt': datetime(2015, 1, 1),
'errorDetails': {
'code': 'string',
'message': 'string'
},
'additionalContext': {...}|[...]|123|123.4|'string'|True|None,
'scope': {
'pillars': [
'COST_OPTIMIZATION'|'SECURITY'|'RESILIENCE'|'PERFORMANCE'|'OPERATIONAL_EXCELLENCE',
],
'goalIds': [
'string',
],
'items': [
{
'pillar': 'COST_OPTIMIZATION'|'SECURITY'|'RESILIENCE'|'PERFORMANCE'|'OPERATIONAL_EXCELLENCE',
'ids': [
'string',
]
},
]
},
'progress': {
'stepsCompleted': 123,
'totalSteps': 123,
'completionPercentage': 123.0
}
}
Response Structure
(dict) --
id (string) --
The unique identifier of the recommendation generation.
profileArn (string) --
The Amazon Resource Name (ARN) of the profile used for this generation.
name (string) --
The name of the recommendation generation.
status (string) --
The current status of the recommendation generation.
estimatedCompletionTime (datetime) --
The estimated time for the generation to complete.
createdBy (string) --
The identifier of the user or system that started this generation.
createdAt (datetime) --
The timestamp when the generation was started.
lastModifiedBy (string) --
The identifier of the user or system that last modified this generation.
lastModifiedAt (datetime) --
The timestamp when the generation was last modified.
generationType (string) --
How the generation was started.
generationRecommendationTypes (list) --
The recommendation types the generation covers.
(string) --
The type of a recommendation.
startedAt (datetime) --
The timestamp when the recommendation generation process started.
endedAt (datetime) --
The timestamp when the recommendation generation process completed.
errorDetails (dict) --
Details about the error if the generation status is ERROR.
code (string) --
The status code identifying the type of error.
message (string) --
A human-readable description of the error.
additionalContext (:ref:`document<document>`) --
The additional context that was provided when the generation was started. For ARCHITECTURE generations, this includes the location of the reviewed IaC template and the lenses used.
scope (dict) --
The scope configuration that defines which pillars and goals to focus on during generation.
pillars (list) --
The Amazon Web Services Well-Architected Framework pillars to include in the generation scope.
(string) --
A pillar of the Amazon Web Services Well-Architected Framework, used to scope recommendation generation.
goalIds (list) --
Specific goal IDs to focus on during recommendation generation. Use ListAgentGoals to retrieve goal IDs.
(string) --
items (list) --
An optional per-pillar filter. When you specify items, only the listed items are processed for each pillar. When you omit items, all items are processed.
(dict) --
Item configuration for a specific Amazon Web Services Well-Architected Framework pillar.
pillar (string) --
The pillar this item configuration applies to.
ids (list) --
A list of item IDs to process for this pillar, such as best practice IDs, Amazon Web Services service names, or resource ARNs.
(string) --
progress (dict) --
Current progress information including steps completed and completion percentage.
stepsCompleted (integer) --
The number of generation steps that have been completed.
totalSteps (integer) --
The total number of steps in the generation process.
completionPercentage (float) --
The completion percentage of the generation process (0-100).
{'items': {'content': {'organizationalUnitIds': ['string']}}}
Lists contexts associated with a profile.
See also: AWS API Documentation
Request Syntax
client.list_agent_contexts(
profileArn='string',
maxResults=123,
nextToken='string'
)
string
[REQUIRED]
The Amazon Resource Name (ARN) of the profile to list contexts for.
integer
The maximum number of contexts to return in a single call. Default is 100.
string
A pagination token returned from a previous call to continue retrieving results.
dict
Response Syntax
{
'items': [
{
'id': 'string',
'profileArn': 'string',
'title': 'string',
'contextType': 'APPLICATION',
'content': {
'accountIds': [
'string',
],
'regions': [
'string',
],
'awsServices': [
'string',
],
'resourceTypes': [
'string',
],
'resourceTags': [
{
'key': 'string',
'value': 'string'
},
],
'organizationalUnitIds': [
'string',
],
'applicationOverview': 'string',
'industry': 'string',
'applicationType': 'SAS'|'DESKTOP_APPLICATION'|'OTHER',
'criticality': 'MISSION_CRITICAL'|'BUSINESS_CRITICAL'|'NON_CRITICAL'|'TEST_DEVELOPMENT',
'architectureOverview': 'string',
'additionalContext': 'string'
},
'applicationType': 'SAS'|'DESKTOP_APPLICATION'|'OTHER',
'criticality': 'MISSION_CRITICAL'|'BUSINESS_CRITICAL'|'NON_CRITICAL'|'TEST_DEVELOPMENT',
'createdBy': 'string',
'createdAt': datetime(2015, 1, 1),
'lastModifiedBy': 'string',
'lastModifiedAt': datetime(2015, 1, 1)
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
items (list) --
A list of context summaries associated with the profile.
(dict) --
Summary of a context associated with a profile, representing application or environment information used during recommendation generation.
id (string) --
The unique identifier of the context.
profileArn (string) --
The Amazon Resource Name (ARN) of the associated profile.
title (string) --
The title of the context.
contextType (string) --
The type of the context.
content (dict) --
The typed content of the context, containing application-specific fields such as account IDs, Regions, services, and resource types.
accountIds (list) --
The Amazon Web Services account IDs associated with this application context.
(string) --
regions (list) --
The Amazon Web Services Regions where this application operates.
(string) --
awsServices (list) --
The Amazon Web Services services used by this application.
(string) --
resourceTypes (list) --
The Amazon Web Services resource types relevant to this application.
(string) --
resourceTags (list) --
Resource tags used to scope this application context.
(dict) --
A key-value pair representing a resource tag used to scope context content.
key (string) --
The tag key.
value (string) --
The tag value.
organizationalUnitIds (list) --
The AWS Organizations organizational unit (OU) IDs associated with this application context. Valid only for organizational profiles; rejected for standard profiles.
(string) --
applicationOverview (string) --
A free-form overview of the application.
industry (string) --
The industry vertical for this application.
applicationType (string) --
The type of the application.
criticality (string) --
The business criticality of the application.
architectureOverview (string) --
A free-form description of the application architecture.
additionalContext (string) --
Additional context not captured by other fields.
applicationType (string) --
The type of application described by this context.
criticality (string) --
The business criticality of the application described by this context.
createdBy (string) --
The identifier of the user or system that created this context.
createdAt (datetime) --
The timestamp when the context was created.
lastModifiedBy (string) --
The identifier of the user or system that last modified this context.
lastModifiedAt (datetime) --
The timestamp when the context was last modified.
nextToken (string) --
A pagination token to retrieve the next set of results, if available.
{'items': {'organizationalAggregationConfiguration': {'accounts': [{'accountId': 'string',
'regions': ['string']}],
'organizationalUnits': [{'organizationalUnitId': 'string',
'regions': ['string']}]},
'profileType': 'STANDARD | BASIC | ORGANIZATIONAL'}}
Lists optimization profiles in your account. Profiles define the scope and configuration for generating optimization recommendations.
See also: AWS API Documentation
Request Syntax
client.list_agent_profiles(
maxResults=123,
nextToken='string'
)
integer
The maximum number of profiles to return in a single call. Default is 100.
string
A pagination token returned from a previous call to continue retrieving results.
dict
Response Syntax
{
'items': [
{
'name': 'string',
'displayName': 'string',
'description': 'string',
'businessOverview': 'string',
'pillars': [
'COST_OPTIMIZATION'|'SECURITY'|'RESILIENCE'|'PERFORMANCE'|'OPERATIONAL_EXCELLENCE',
],
'deletionProtection': True|False,
'profileType': 'STANDARD'|'BASIC'|'ORGANIZATIONAL',
'executionRoleArn': 'string',
'aggregationConfiguration': [
{
'accountId': 'string',
'regions': [
'string',
],
'accessRoleArn': 'string'
},
],
'arn': 'string',
'eligibleForScheduledGeneration': True|False,
'eligibleForArchitectureGeneration': True|False,
'fieldErrors': {
'string': 'string'
},
'createdBy': 'string',
'createdAt': datetime(2015, 1, 1),
'lastModifiedBy': 'string',
'lastModifiedAt': datetime(2015, 1, 1),
'organizationalAggregationConfiguration': {
'organizationalUnits': [
{
'organizationalUnitId': 'string',
'regions': [
'string',
]
},
],
'accounts': [
{
'accountId': 'string',
'regions': [
'string',
]
},
]
}
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
items (list) --
A list of profile summaries.
(dict) --
Summary of an optimization profile, including its configuration, metadata, and audit information.
name (string) --
The system name of the profile.
displayName (string) --
The display name of the profile shown to users.
description (string) --
A description of the profile.
businessOverview (string) --
The business overview for this profile.
pillars (list) --
The Amazon Web Services Well-Architected Framework pillars associated with this profile. Not present for basic profiles.
(string) --
A pillar of the Amazon Web Services Well-Architected Framework, used to scope recommendation generation.
deletionProtection (boolean) --
Indicates whether deletion protection is enabled for the profile.
profileType (string) --
The type of the profile.
executionRoleArn (string) --
The ARN of the IAM execution role used for recommendation actions. Not present for basic profiles.
aggregationConfiguration (list) --
The aggregation configuration that defines which Amazon Web Services accounts and Regions to analyze. Not present for basic profiles.
(dict) --
Configuration settings that define the scope of Amazon Web Services resources to analyze for optimization recommendations.
accountId (string) --
The Amazon Web Services account ID to analyze.
regions (list) --
A list of Amazon Web Services Regions to include in the analysis.
(string) --
accessRoleArn (string) --
The ARN of an IAM role to assume for resource analysis in this account.
arn (string) --
The Amazon Resource Name (ARN) of the optimization profile.
eligibleForScheduledGeneration (boolean) --
Indicates whether the profile is valid for scheduled recommendation generation.
eligibleForArchitectureGeneration (boolean) --
Indicates whether the profile is valid for manual architecture generation.
fieldErrors (dict) --
A map of field paths to error messages for invalid or missing input fields.
(string) --
(string) --
createdBy (string) --
The identifier of the user or system that created this profile.
createdAt (datetime) --
The timestamp when the profile was created.
lastModifiedBy (string) --
The identifier of the user or system that last modified this profile.
lastModifiedAt (datetime) --
The timestamp when the profile was last modified.
organizationalAggregationConfiguration (dict) --
The organizational monitoring boundary. Present only for organizational profiles.
organizationalUnits (list) --
A list of organizational unit or root entries that define the organizational scope. Each entry specifies an OU or root ID and the regions to monitor within it.
(dict) --
An organizational unit or root entry in the organizational monitoring boundary, with its associated regions.
organizationalUnitId (string) --
The AWS Organizations organizational unit ID or root ID. Must match the pattern r-[a-z0-9]{4,32} for roots or ou-[a-z0-9]{4,32}-[a-z0-9]{8,32} for OUs.
regions (list) --
The list of regions to monitor for this organizational unit or root.
(string) --
accounts (list) --
A list of individual account entries that define additional accounts to include. Each entry specifies an account ID and the regions to monitor within it.
(dict) --
An individual account entry in the organizational monitoring boundary, with its associated regions.
accountId (string) --
The Amazon Web Services account ID to include in the monitoring boundary.
regions (list) --
The list of regions to monitor for this account.
(string) --
nextToken (string) --
A pagination token to retrieve the next set of results, if available.
{'items': {'endedAt': 'timestamp',
'errorDetails': {'code': 'string', 'message': 'string'},
'generationRecommendationTypes': ['RESOURCE | ARCHITECTURE | '
'APPLICATION'],
'generationType': 'ONDEMAND | SCHEDULED | BASIC',
'startedAt': 'timestamp'}}
Lists recommendation generation processes for a specified profile.
See also: AWS API Documentation
Request Syntax
client.list_agent_recommendation_generations(
profileArn='string',
recommendationType='RESOURCE'|'ARCHITECTURE'|'APPLICATION',
maxResults=123,
nextToken='string'
)
string
[REQUIRED]
The Amazon Resource Name (ARN) of the optimization profile to list generation processes for.
string
Optional filter by recommendation type.
integer
The maximum number of generation processes to return in a single response.
string
A pagination token returned from a previous call to continue retrieving results.
dict
Response Syntax
{
'items': [
{
'id': 'string',
'profileArn': 'string',
'name': 'string',
'status': 'QUEUED'|'IN_PROGRESS'|'COMPLETED'|'ERROR',
'estimatedCompletionTime': datetime(2015, 1, 1),
'createdBy': 'string',
'createdAt': datetime(2015, 1, 1),
'lastModifiedBy': 'string',
'lastModifiedAt': datetime(2015, 1, 1),
'generationType': 'ONDEMAND'|'SCHEDULED'|'BASIC',
'generationRecommendationTypes': [
'RESOURCE'|'ARCHITECTURE'|'APPLICATION',
],
'startedAt': datetime(2015, 1, 1),
'endedAt': datetime(2015, 1, 1),
'errorDetails': {
'code': 'string',
'message': 'string'
}
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
items (list) --
A list of recommendation generation summaries.
(dict) --
Summary of a recommendation generation process initiated through the agent API.
id (string) --
The unique identifier of the recommendation generation.
profileArn (string) --
The Amazon Resource Name (ARN) of the profile used for this generation.
name (string) --
The name of the recommendation generation.
status (string) --
The current status of the recommendation generation.
estimatedCompletionTime (datetime) --
The estimated time for the generation to complete.
createdBy (string) --
The identifier of the user or system that started this generation.
createdAt (datetime) --
The timestamp when the generation was started.
lastModifiedBy (string) --
The identifier of the user or system that last modified this generation.
lastModifiedAt (datetime) --
The timestamp when the generation was last modified.
generationType (string) --
How the generation was started.
generationRecommendationTypes (list) --
The recommendation types the generation covers.
(string) --
The type of a recommendation.
startedAt (datetime) --
The timestamp when the recommendation generation process started.
endedAt (datetime) --
The timestamp when the recommendation generation process completed.
errorDetails (dict) --
Details about the error if the generation status is ERROR.
code (string) --
The status code identifying the type of error.
message (string) --
A human-readable description of the error.
nextToken (string) --
A pagination token to retrieve the next set of results, if available.
{'items': {'autoRemediation': {'cliCommand': 'string', 'deepLink': 'string'}}}
Lists recommendation items for a specific recommendation. Recommendation items provide detailed information about individual optimization opportunities.
See also: AWS API Documentation
Request Syntax
client.list_agent_recommendation_items(
recommendationArn='string',
type='AWS_RESOURCE'|'RECOMMENDATION',
maxResults=123,
nextToken='string'
)
string
[REQUIRED]
The Amazon Resource Name (ARN) of the recommendation to list items for.
string
Optional filter to return only recommendation items of the specified type.
integer
The maximum number of recommendation items to return in a single response.
string
A pagination token returned from a previous call to continue retrieving results.
dict
Response Syntax
{
'items': [
{
'id': 'string',
'recommendationArn': 'string',
'type': 'AWS_RESOURCE'|'RECOMMENDATION',
'metadata': {...}|[...]|123|123.4|'string'|True|None,
'createdBy': 'string',
'createdAt': datetime(2015, 1, 1),
'lastModifiedBy': 'string',
'lastModifiedAt': datetime(2015, 1, 1),
'autoRemediation': {
'deepLink': 'string',
'cliCommand': 'string'
}
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
items (list) --
A list of recommendation items with their detailed metadata and configuration information.
(dict) --
Summary of an agent recommendation item, representing an Amazon Web Services resource or recommendation affected by the optimization recommendation.
id (string) --
The unique identifier of the recommendation item.
recommendationArn (string) --
The Amazon Resource Name (ARN) of the associated recommendation.
type (string) --
The type of the recommendation item.
metadata (:ref:`document<document>`) --
Metadata containing a snapshot of the resource or recommendation at the time of generation.
createdBy (string) --
The identifier of the user or system that created this recommendation item.
createdAt (datetime) --
The timestamp when the recommendation item was created.
lastModifiedBy (string) --
The identifier of the user or system that last modified this recommendation item.
lastModifiedAt (datetime) --
The timestamp when the recommendation item was last modified.
autoRemediation (dict) --
The optional per-resource auto-remediation for this affected resource, representing an SSM runbook execution. Present only when the item's check is backed by an SSM automation runbook.
deepLink (string) --
A deep link to the SSM runbook execution page in the AWS Management Console for this resource, with the execution parameters prefilled.
cliCommand (string) --
The AWS CLI command that triggers the same SSM runbook execution for this resource. You can copy and run this command as-is.
nextToken (string) --
A pagination token to retrieve the next set of results, if available.
{'content': {'organizationalUnitIds': ['string']}}
Response {'context': {'content': {'organizationalUnitIds': ['string']}}}
Updates an existing context associated with a profile.
See also: AWS API Documentation
Request Syntax
client.update_agent_context(
clientToken='string',
profileArn='string',
id='string',
title='string',
content={
'accountIds': [
'string',
],
'regions': [
'string',
],
'awsServices': [
'string',
],
'resourceTypes': [
'string',
],
'resourceTags': [
{
'key': 'string',
'value': 'string'
},
],
'organizationalUnitIds': [
'string',
],
'applicationOverview': 'string',
'industry': 'string',
'applicationType': 'SAS'|'DESKTOP_APPLICATION'|'OTHER',
'criticality': 'MISSION_CRITICAL'|'BUSINESS_CRITICAL'|'NON_CRITICAL'|'TEST_DEVELOPMENT',
'architectureOverview': 'string',
'additionalContext': 'string'
}
)
string
A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
This field is autopopulated if not provided.
string
[REQUIRED]
The Amazon Resource Name (ARN) of the profile containing the context.
string
[REQUIRED]
The unique identifier of the context to update.
string
The updated title of the context.
dict
The updated typed content of the context. The structure contains application-specific fields such as account IDs, Regions, services, and resource types.
accountIds (list) --
The Amazon Web Services account IDs associated with this application context.
(string) --
regions (list) --
The Amazon Web Services Regions where this application operates.
(string) --
awsServices (list) --
The Amazon Web Services services used by this application.
(string) --
resourceTypes (list) --
The Amazon Web Services resource types relevant to this application.
(string) --
resourceTags (list) --
Resource tags used to scope this application context.
(dict) --
A key-value pair representing a resource tag used to scope context content.
key (string) -- [REQUIRED]
The tag key.
value (string) -- [REQUIRED]
The tag value.
organizationalUnitIds (list) --
The AWS Organizations organizational unit (OU) IDs associated with this application context. Valid only for organizational profiles; rejected for standard profiles.
(string) --
applicationOverview (string) --
A free-form overview of the application.
industry (string) --
The industry vertical for this application.
applicationType (string) --
The type of the application.
criticality (string) --
The business criticality of the application.
architectureOverview (string) --
A free-form description of the application architecture.
additionalContext (string) --
Additional context not captured by other fields.
dict
Response Syntax
{
'context': {
'id': 'string',
'profileArn': 'string',
'title': 'string',
'contextType': 'APPLICATION',
'content': {
'accountIds': [
'string',
],
'regions': [
'string',
],
'awsServices': [
'string',
],
'resourceTypes': [
'string',
],
'resourceTags': [
{
'key': 'string',
'value': 'string'
},
],
'organizationalUnitIds': [
'string',
],
'applicationOverview': 'string',
'industry': 'string',
'applicationType': 'SAS'|'DESKTOP_APPLICATION'|'OTHER',
'criticality': 'MISSION_CRITICAL'|'BUSINESS_CRITICAL'|'NON_CRITICAL'|'TEST_DEVELOPMENT',
'architectureOverview': 'string',
'additionalContext': 'string'
},
'applicationType': 'SAS'|'DESKTOP_APPLICATION'|'OTHER',
'criticality': 'MISSION_CRITICAL'|'BUSINESS_CRITICAL'|'NON_CRITICAL'|'TEST_DEVELOPMENT',
'createdBy': 'string',
'createdAt': datetime(2015, 1, 1),
'lastModifiedBy': 'string',
'lastModifiedAt': datetime(2015, 1, 1)
}
}
Response Structure
(dict) --
context (dict) --
The updated context summary.
id (string) --
The unique identifier of the context.
profileArn (string) --
The Amazon Resource Name (ARN) of the associated profile.
title (string) --
The title of the context.
contextType (string) --
The type of the context.
content (dict) --
The typed content of the context, containing application-specific fields such as account IDs, Regions, services, and resource types.
accountIds (list) --
The Amazon Web Services account IDs associated with this application context.
(string) --
regions (list) --
The Amazon Web Services Regions where this application operates.
(string) --
awsServices (list) --
The Amazon Web Services services used by this application.
(string) --
resourceTypes (list) --
The Amazon Web Services resource types relevant to this application.
(string) --
resourceTags (list) --
Resource tags used to scope this application context.
(dict) --
A key-value pair representing a resource tag used to scope context content.
key (string) --
The tag key.
value (string) --
The tag value.
organizationalUnitIds (list) --
The AWS Organizations organizational unit (OU) IDs associated with this application context. Valid only for organizational profiles; rejected for standard profiles.
(string) --
applicationOverview (string) --
A free-form overview of the application.
industry (string) --
The industry vertical for this application.
applicationType (string) --
The type of the application.
criticality (string) --
The business criticality of the application.
architectureOverview (string) --
A free-form description of the application architecture.
additionalContext (string) --
Additional context not captured by other fields.
applicationType (string) --
The type of application described by this context.
criticality (string) --
The business criticality of the application described by this context.
createdBy (string) --
The identifier of the user or system that created this context.
createdAt (datetime) --
The timestamp when the context was created.
lastModifiedBy (string) --
The identifier of the user or system that last modified this context.
lastModifiedAt (datetime) --
The timestamp when the context was last modified.