WellArchitected / Client / get_agent_recommendation_generation

get_agent_recommendation_generation

WellArchitected.Client.get_agent_recommendation_generation(**kwargs)

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

response = client.get_agent_recommendation_generation(
    profileArn='string',
    generationId='string'
)

Parameters:

• profileArn (string) –

  [REQUIRED]

  The ARN of the optimization profile associated with this generation.

• generationId (string) –

  [REQUIRED]

  The unique identifier of the recommendation generation to retrieve.

Return type:

dict

Returns:

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),
    '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',
                ]
            },
        ]
    },
    'startedAt': datetime(2015, 1, 1),
    'endedAt': datetime(2015, 1, 1),
    'progress': {
        'stepsCompleted': 123,
        'totalSteps': 123,
        'completionPercentage': 123.0
    },
    'errorDetails': {
        'code': 'string',
        'message': 'string'
    }
}

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.

  • additionalContext (document) –

    Additional context information provided to guide the recommendation generation process.

  • scope (dict) –

    The scope configuration that defines which pillars and goals to focus on during generation.

    • pillars (list) –

      The Well-Architected Tool Framework pillars to include in the generation scope.

      • (string) –

    • goalIds (list) –

      Specific goal IDs to focus on during recommendation generation.

      • (string) –

    • items (list) –

      Optional per-pillar item filtering configuration.

      • (dict) –

        Item configuration for a specific Well-Architected Tool 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) –

  • startedAt (datetime) –

    The timestamp when the recommendation generation process started.

  • endedAt (datetime) –

    The timestamp when the recommendation generation process completed.

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

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

Exceptions

• WellArchitected.Client.exceptions.AccessDeniedException

• WellArchitected.Client.exceptions.ValidationException

• WellArchitected.Client.exceptions.InternalServerException

• WellArchitected.Client.exceptions.ResourceNotFoundException

• WellArchitected.Client.exceptions.ThrottlingException