DevOpsAgentService / Paginator / ListGoals

ListGoals

class DevOpsAgentService.Paginator.ListGoals

paginator = client.get_paginator('list_goals')

paginate(**kwargs)

Creates an iterator that will paginate through responses from DevOpsAgentService.Client.list_goals().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    agentSpaceId='string',
    status='ACTIVE'|'PAUSED'|'COMPLETE',
    goalType='CUSTOMER_DEFINED'|'ONCALL_REPORT',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

• agentSpaceId (string) –

  [REQUIRED]

  The unique identifier for the agent space

• status (string) – Filter goals by goal status

• goalType (string) – Filter goals by goal type

• 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

{
    'goals': [
        {
            'agentSpaceArn': 'string',
            'goalId': 'string',
            'title': 'string',
            'content': {
                'description': 'string',
                'objectives': 'string'
            },
            'status': 'ACTIVE'|'PAUSED'|'COMPLETE',
            'goalType': 'CUSTOMER_DEFINED'|'ONCALL_REPORT',
            'createdAt': datetime(2015, 1, 1),
            'updatedAt': datetime(2015, 1, 1),
            'lastEvaluatedAt': datetime(2015, 1, 1),
            'lastTaskId': 'string',
            'lastSuccessfulTaskId': 'string',
            'version': 123,
            'evaluationSchedule': {
                'state': 'ENABLED'|'DISABLED',
                'expression': 'string'
            }
        },
    ],
    'NextToken': 'string'
}

Response Structure

• (dict) –

  Response structure containing the list of goals

  • goals (list) –

    List of goals matching the criteria

    • (dict) –

      Represents a goal with all its properties and metadata

      • agentSpaceArn (string) –

        The unique identifier for the agent space containing this goal

      • goalId (string) –

        The unique identifier for this goal

      • title (string) –

        The title of the goal

      • content (dict) –

        Content of the goal

        • description (string) –

          A detailed description of the goal.

        • objectives (string) –

          The objectives to be achieved for this goal.

      • status (string) –

        Current status of the goal itself

      • goalType (string) –

        Type of goal based on its origin

      • createdAt (datetime) –

        Timestamp when this goal was created

      • updatedAt (datetime) –

        Timestamp when this goal was last updated

      • lastEvaluatedAt (datetime) –

        Timestamp when the goal was last evaluated

      • lastTaskId (string) –

        ID of the most recent task associated with this goal

      • lastSuccessfulTaskId (string) –

        ID of the most recent successful task associated with this goal

      • version (integer) –

        Version number for optimistic locking

      • evaluationSchedule (dict) –

        Goal Schedule. Allows to schedule the goal to run periodically, as well as disable a goal temporarily

        • state (string) –

          Whether the schedule is enabled or disabled

        • expression (string) –

          Schedule expression (e.g., ‘rate(7 days)’)

  • NextToken (string) –

    A token to resume pagination.