WellArchitected / Client / list_agent_recommendation_generations

list_agent_recommendation_generations¶

WellArchitected.Client.list_agent_recommendation_generations(**kwargs)¶

Lists recommendation generation processes for a specified profile.

Request Syntax

response = client.list_agent_recommendation_generations(
    profileArn='string',
    recommendationType='RESOURCE'|'ARCHITECTURE'|'APPLICATION',
    maxResults=123,
    nextToken='string'
)

Parameters:

profileArn (string) –
[REQUIRED]

The Amazon Resource Name (ARN) of the optimization profile to list generation processes for.
recommendationType (string) – Optional filter by recommendation type.
maxResults (integer) – The maximum number of generation processes to return in a single response.
nextToken (string) – A pagination token returned from a previous call to continue retrieving results.

Return type:

dict

Returns:

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)
        },
    ],
    '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.
- 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