WellArchitected / Client / list_agent_goals

list_agent_goals¶

WellArchitected.Client.list_agent_goals(**kwargs)¶

Lists optimization goals associated with a specified profile. Goals define specific targets and objectives for the optimization process.

Request Syntax

response = client.list_agent_goals(
    profileArn='string',
    maxResults=123,
    nextToken='string'
)

Parameters:

profileArn (string) –
[REQUIRED]

The Amazon Resource Name (ARN) of the optimization profile to list goals for.
maxResults (integer) – The maximum number of goals 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',
            'pillars': [
                'COST_OPTIMIZATION'|'SECURITY'|'RESILIENCE'|'PERFORMANCE'|'OPERATIONAL_EXCELLENCE',
            ],
            'title': 'string',
            'description': '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 goal summaries associated with the profile.
  - (dict) –
    
    Summary of an optimization goal associated with a profile.
    - id (string) –
      
      The unique identifier of the goal.
    - profileArn (string) –
      
      The Amazon Resource Name (ARN) of the associated profile.
    - pillars (list) –
      
      The Well-Architected Tool Framework pillars associated with this goal.
      - (string) –
    - title (string) –
      
      The title of the goal.
    - description (string) –
      
      A description of the goal.
    - createdBy (string) –
      
      The identifier of the user or system that created this goal.
    - createdAt (datetime) –
      
      The timestamp when the goal was created.
    - lastModifiedBy (string) –
      
      The identifier of the user or system that last modified this goal.
    - lastModifiedAt (datetime) –
      
      The timestamp when the goal 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.ThrottlingException