WellArchitected / Client / list_agent_recommendations

list_agent_recommendations

WellArchitected.Client.list_agent_recommendations(**kwargs)

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

See also: AWS API Documentation

Request Syntax

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

Parameters:

• profileArn (string) –

  [REQUIRED]

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

• maxResults (integer) – The maximum number of recommendations to return in a single response.

• nextToken (string) – A pagination token returned from a previous call to continue retrieving results.

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

• pillar (string) – Optional filter to return only recommendations for the specified pillar.

Return type:

dict

Returns:

Response Syntax

{
    'items': [
        {
            'recommendationArn': 'string',
            'profileArn': '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.

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

Exceptions

• WellArchitected.Client.exceptions.AccessDeniedException

• WellArchitected.Client.exceptions.ValidationException

• WellArchitected.Client.exceptions.InternalServerException

• WellArchitected.Client.exceptions.ResourceNotFoundException

• WellArchitected.Client.exceptions.ThrottlingException