WellArchitected / Paginator / ListAgentGoals

ListAgentGoals¶

class WellArchitected.Paginator.ListAgentGoals¶

paginator = client.get_paginator('list_agent_goals')

paginate(**kwargs)¶

Creates an iterator that will paginate through responses from WellArchitected.Client.list_agent_goals().

Request Syntax

response_iterator = paginator.paginate(
    profileArn='string',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

profileArn (string) –
[REQUIRED]

The Amazon Resource Name (ARN) of the optimization profile to list goals for.
PaginationConfig (dict) –
A dictionary that provides parameters to control pagination.
- MaxItems (integer) –
  
  The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
- PageSize (integer) –
  
  The size of each page.
- StartingToken (string) –
  
  A token to specify where to start paginating. This is the NextToken from a previous response.

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 token to resume pagination.