AWS Well-Architected Tool

2026/09/25 - AWS Well-Architected Tool - 2 updated api methods

Changes  This change releases the Well-Architected Agent, a generative AI service that analyzes a customer's AWS environment and delivers personalized, prioritized recommendations across cost, security, performance, and resilience.

GetAgentRecommendation (updated) Link ¶
Changes (response)
{'generationId': 'string'}

Retrieves detailed information about a specific optimization recommendation, including its impact analysis, content, and implementation guidance.

See also: AWS API Documentation

Request Syntax

client.get_agent_recommendation(
    recommendationArn='string',
    remediationType='AUTO_REMEDIATION'|'CONSOLE'|'CLI'|'SDK'|'IAC'|'MCP'
)
type recommendationArn:

string

param recommendationArn:

[REQUIRED]

The Amazon Resource Name (ARN) of the recommendation to retrieve.

type remediationType:

string

param remediationType:

Optional filter on remediation type.

rtype:

dict

returns:

Response Syntax

{
    'recommendationArn': 'string',
    'profileArn': 'string',
    'generationId': 'string',
    'title': 'string',
    'description': 'string',
    'type': 'RESOURCE'|'ARCHITECTURE'|'APPLICATION',
    'pillar': 'COST_OPTIMIZATION'|'SECURITY'|'RESILIENCE'|'PERFORMANCE'|'OPERATIONAL_EXCELLENCE',
    'priority': 'HIGH'|'MEDIUM'|'LOW',
    'effort': 'LARGE'|'MEDIUM'|'SMALL',
    'status': 'ACTIVE'|'SUPPRESSED'|'COMPLETED',
    'state': 'OPEN'|'CLOSED',
    'updateReason': 'string',
    'impact': 'HIGH'|'MEDIUM'|'LOW',
    'roi': {
        'estimate': 'string',
        'detail': 'string'
    },
    'numberOfResources': 123,
    'awsServices': [
        'string',
    ],
    'businessUnits': [
        'string',
    ],
    'applications': [
        'string',
    ],
    'impactDetails': [
        'string',
    ],
    'insights': [
        {
            'usagePattern': 'string',
            'signalsDetected': 'string'
        },
    ],
    'highlights': [
        'string',
    ],
    'remediationSummary': {
        'recommendation': 'string',
        'steps': [
            'string',
        ]
    },
    'crossPillarBenefits': [
        {
            'pillar': 'COST_OPTIMIZATION'|'SECURITY'|'RESILIENCE'|'PERFORMANCE'|'OPERATIONAL_EXCELLENCE',
            'title': 'string',
            'description': 'string',
            'impact': 'HIGH'|'MEDIUM'|'LOW'
        },
    ],
    'tradeOffs': [
        {
            'pillar': 'COST_OPTIMIZATION'|'SECURITY'|'RESILIENCE'|'PERFORMANCE'|'OPERATIONAL_EXCELLENCE',
            'title': 'string',
            'description': 'string',
            'risk': 'LOW'|'MEDIUM'|'HIGH',
            'mitigation': 'string',
            'riskExplanation': 'string'
        },
    ],
    'sources': [
        'TRUSTED_ADVISOR'|'COST_EXPLORER'|'CLOUDWATCH'|'WELL_ARCHITECTED_TOOL'|'WELL_ARCHITECTED_AGENT'|'CUSTOMER_IAC',
    ],
    'goals': [
        {
            'title': 'string'
        },
    ],
    'tags': [
        {
            'key': 'string',
            'value': 'string'
        },
    ],
    'createdBy': 'string',
    'createdAt': datetime(2015, 1, 1),
    'lastModifiedBy': 'string',
    'lastModifiedAt': datetime(2015, 1, 1),
    'remediations': [
        {
            'recommendationArn': 'string',
            'type': 'AUTO_REMEDIATION'|'CONSOLE'|'CLI'|'SDK'|'IAC'|'MCP',
            'steps': [
                {
                    'title': 'string',
                    'content': 'string'
                },
            ],
            'resourceLinks': [
                {
                    'url': 'string',
                    'title': 'string'
                },
            ],
            'createdBy': 'string',
            'createdAt': datetime(2015, 1, 1),
            'lastModifiedBy': 'string',
            'lastModifiedAt': datetime(2015, 1, 1)
        },
    ]
}

Response Structure

  • (dict) --

    • recommendationArn (string) --

      The Amazon Resource Name (ARN) of the recommendation.

    • profileArn (string) --

      The Amazon Resource Name (ARN) of the associated profile.

    • generationId (string) --

      The identifier of the generation process that produced this recommendation.

    • title (string) --

      The title of the recommendation.

    • description (string) --

      A description of the recommendation.

    • type (string) --

      The type of the recommendation.

    • pillar (string) --

      The Well-Architected Tool Framework pillar that the recommendation addresses.

    • priority (string) --

      The priority of the recommendation.

    • effort (string) --

      The effort required to implement the recommendation.

    • status (string) --

      The current status of the recommendation.

    • state (string) --

      The current state of the recommendation.

    • updateReason (string) --

      The free-text reason associated with the recommendation's most recent status update.

    • impact (string) --

      The severity of the recommendation's impact.

    • roi (dict) --

      The return on investment estimate for the recommendation.

      • estimate (string) --

        A short statistic or key metric. Optional when there is no quantifiable figure.

      • detail (string) --

        A sentence providing context for the estimate.

    • numberOfResources (integer) --

      The number of Amazon Web Services resources this recommendation affects.

    • awsServices (list) --

      The Amazon Web Services services that the recommendation applies to.

      • (string) --

    • businessUnits (list) --

      The business units that own the affected resources.

      • (string) --

    • applications (list) --

      The applications that the recommendation targets.

      • (string) --

    • impactDetails (list) --

      Detailed impact information for the recommendation.

      • (string) --

    • insights (list) --

      A list of insights about the recommendation.

      • (dict) --

        An insight describing a usage pattern and the signals detected.

        • usagePattern (string) --

          A description of the usage pattern.

        • signalsDetected (string) --

          A description of the signals detected.

    • highlights (list) --

      Highlights describing what was detected.

      • (string) --

    • remediationSummary (dict) --

      A high-level summary of the recommended remediation.

      • recommendation (string) --

        A short imperative statement of the recommended action.

      • steps (list) --

        High-level steps to implement the fix.

        • (string) --

    • crossPillarBenefits (list) --

      Cross-pillar benefits of acting on the recommendation.

      • (dict) --

        A benefit on a different pillar from acting on the recommendation.

        • pillar (string) --

          The pillar that would be positively impacted.

        • title (string) --

          A short phrase describing the outcome.

        • description (string) --

          A description of what changes and why it matters.

        • impact (string) --

          The severity of the benefit.

    • tradeOffs (list) --

      Trade-offs of acting on the recommendation.

      • (dict) --

        A negative trade-off from acting on the recommendation.

        • pillar (string) --

          The pillar that could be negatively impacted.

        • title (string) --

          A short phrase describing what is lost or degraded.

        • description (string) --

          A description of the specific risk and the condition that triggers it.

        • risk (string) --

          The risk rating for the trade-off.

        • mitigation (string) --

          A specific action to mitigate the trade-off and when to take it.

        • riskExplanation (string) --

          An optional explanation providing additional context for the risk rating.

    • sources (list) --

      Sources that generated this recommendation.

      • (string) --

    • goals (list) --

      Goals that this recommendation targets.

      • (dict) --

        Contains information about a goal associated with a recommendation.

        • title (string) --

          The title of the goal associated with the recommendation.

    • tags (list) --

      A set of key-value pairs associated with the recommendation, used for cost allocation and access control.

      • (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 recommendation.

    • createdAt (datetime) --

      The timestamp when the recommendation was created.

    • lastModifiedBy (string) --

      The identifier of the user or system that last modified this recommendation.

    • lastModifiedAt (datetime) --

      The timestamp when the recommendation was last modified.

    • remediations (list) --

      A list of remediations for the recommendation.

      • (dict) --

        The core fields for a remediation.

        • recommendationArn (string) --

          The ARN of the recommendation that this remediation belongs to.

        • type (string) --

          The remediation method.

        • steps (list) --

          The procedural steps to perform the remediation.

          • (dict) --

            One step within a remediation procedure.

            • title (string) --

              An optional short label for the step.

            • content (string) --

              The content describing the step, which can include code examples and verification checklists.

        • resourceLinks (list) --

          External references associated with the steps.

          • (dict) --

            An external reference associated with remediation steps.

            • url (string) --

              The URL of the external reference.

            • title (string) --

              An optional human-readable title for the link.

        • createdBy (string) --

          The identifier of the user or system that created this remediation.

        • createdAt (datetime) --

          The timestamp when the remediation was created.

        • lastModifiedBy (string) --

          The identifier of the user or system that last modified this remediation.

        • lastModifiedAt (datetime) --

          The timestamp when the remediation was last modified.

ListAgentRecommendations (updated) Link ¶
Changes (response)
{'items': {'generationId': 'string'}}

Lists active optimization recommendations for a specified profile with optional filtering by state.

See also: AWS API Documentation

Request Syntax

client.list_agent_recommendations(
    profileArn='string',
    maxResults=123,
    nextToken='string',
    state='OPEN'|'CLOSED',
    pillar='COST_OPTIMIZATION'|'SECURITY'|'RESILIENCE'|'PERFORMANCE'|'OPERATIONAL_EXCELLENCE'
)
type profileArn:

string

param profileArn:

[REQUIRED]

The Amazon Resource Name (ARN) of the optimization profile to list recommendations for.

type maxResults:

integer

param maxResults:

The maximum number of recommendations to return in a single response.

type nextToken:

string

param nextToken:

A pagination token returned from a previous call to continue retrieving results.

type state:

string

param state:

Optional filter to return only recommendations with the specified state (OPEN or CLOSED).

type pillar:

string

param pillar:

Optional filter to return only recommendations for the specified pillar.

rtype:

dict

returns:

Response Syntax

{
    'items': [
        {
            'recommendationArn': 'string',
            'profileArn': 'string',
            'generationId': 'string',
            'title': 'string',
            'description': 'string',
            'type': 'RESOURCE'|'ARCHITECTURE'|'APPLICATION',
            'pillar': 'COST_OPTIMIZATION'|'SECURITY'|'RESILIENCE'|'PERFORMANCE'|'OPERATIONAL_EXCELLENCE',
            'priority': 'HIGH'|'MEDIUM'|'LOW',
            'effort': 'LARGE'|'MEDIUM'|'SMALL',
            'status': 'ACTIVE'|'SUPPRESSED'|'COMPLETED',
            'state': 'OPEN'|'CLOSED',
            'updateReason': 'string',
            'impact': 'HIGH'|'MEDIUM'|'LOW',
            'roi': {
                'estimate': 'string',
                'detail': 'string'
            },
            'numberOfResources': 123,
            'awsServices': [
                'string',
            ],
            'businessUnits': [
                'string',
            ],
            'applications': [
                'string',
            ],
            'createdBy': 'string',
            'createdAt': datetime(2015, 1, 1),
            'lastModifiedBy': 'string',
            'lastModifiedAt': datetime(2015, 1, 1)
        },
    ],
    'nextToken': 'string'
}

Response Structure

  • (dict) --

    • items (list) --

      A list of recommendation summaries.

      • (dict) --

        Summary of an agent optimization recommendation returned by list operations.

        • recommendationArn (string) --

          The Amazon Resource Name (ARN) of the recommendation.

        • profileArn (string) --

          The Amazon Resource Name (ARN) of the associated profile.

        • generationId (string) --

          The identifier of the generation process that produced this recommendation.

        • title (string) --

          The title of the recommendation.

        • description (string) --

          A description of the recommendation.

        • type (string) --

          The type of the recommendation.

        • pillar (string) --

          The Well-Architected Tool Framework pillar that the recommendation addresses.

        • priority (string) --

          The priority of the recommendation.

        • effort (string) --

          The effort required to implement the recommendation.

        • status (string) --

          The current status of the recommendation.

        • state (string) --

          The current state of the recommendation.

        • updateReason (string) --

          The free-text reason associated with the recommendation's most recent status update.

        • impact (string) --

          The severity of the recommendation's impact.

        • roi (dict) --

          The return on investment estimate for the recommendation.

          • estimate (string) --

            A short statistic or key metric. Optional when there is no quantifiable figure.

          • detail (string) --

            A sentence providing context for the estimate.

        • numberOfResources (integer) --

          The number of Amazon Web Services resources this recommendation affects.

        • awsServices (list) --

          The Amazon Web Services services that the recommendation applies to.

          • (string) --

        • businessUnits (list) --

          The business units that own the affected resources.

          • (string) --

        • applications (list) --

          The applications that the recommendation targets.

          • (string) --

        • createdBy (string) --

          The identifier of the user or system that created this recommendation.

        • createdAt (datetime) --

          The timestamp when the recommendation was created.

        • lastModifiedBy (string) --

          The identifier of the user or system that last modified this recommendation.

        • lastModifiedAt (datetime) --

          The timestamp when the recommendation was last modified.

    • nextToken (string) --

      A pagination token to retrieve the next set of results, if available.