WellArchitected / Client / start_agent_recommendation_generation

start_agent_recommendation_generation¶

WellArchitected.Client.start_agent_recommendation_generation(**kwargs)¶

Initiates a new recommendation generation process for the specified optimization profile. This asynchronous operation analyzes your Amazon Web Services resources and generates optimization recommendations based on the configured pillars and scope. Use GetAgentRecommendationGeneration to check status.

Request Syntax

response = client.start_agent_recommendation_generation(
    profileArn='string',
    types=[
        'RESOURCE'|'ARCHITECTURE'|'APPLICATION',
    ],
    name='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',
                ]
            },
        ]
    }
)

Parameters:

profileArn (string) –
[REQUIRED]

The Amazon Resource Name (ARN) of the optimization profile to use for generating recommendations.
types (list) –
[REQUIRED]

The types of recommendations to generate.
- (string) –
name (string) – An optional name for this generation process to help identify it in lists and logs.
additionalContext (document) – Optional additional context to guide the recommendation generation, such as specific business requirements or constraints.
scope (dict) –
[REQUIRED]

Scope configuration to focus the generation on specific pillars or goals.
- pillars (list) – [REQUIRED]
  
  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) – [REQUIRED]
      
      The pillar this item configuration applies to.
    - ids (list) – [REQUIRED]
      
      A list of item IDs to process for this pillar, such as best practice IDs, Amazon Web Services service names, or resource ARNs.
      - (string) –

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)
}

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.

Exceptions

WellArchitected.Client.exceptions.AccessDeniedException
WellArchitected.Client.exceptions.ValidationException
WellArchitected.Client.exceptions.InternalServerException
WellArchitected.Client.exceptions.ConflictException
WellArchitected.Client.exceptions.ServiceQuotaExceededException
WellArchitected.Client.exceptions.ThrottlingException