DevOpsAgentService / Client / list_goals

list_goals¶

DevOpsAgentService.Client.list_goals(**kwargs)¶

Lists goals in the specified agent space with optional filtering

Request Syntax

response = client.list_goals(
    agentSpaceId='string',
    status='ACTIVE'|'PAUSED'|'COMPLETE',
    goalType='CUSTOMER_DEFINED'|'ONCALL_REPORT',
    limit=123,
    nextToken='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
limit (integer) – Maximum number of goals to return
nextToken (string) – Pagination token for the next set of results

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) –
  
  Pagination token for the next set of results

Exceptions

DevOpsAgentService.Client.exceptions.ValidationException
DevOpsAgentService.Client.exceptions.ContentSizeExceededException
DevOpsAgentService.Client.exceptions.ServiceQuotaExceededException
DevOpsAgentService.Client.exceptions.ConflictException
DevOpsAgentService.Client.exceptions.InternalServerException
DevOpsAgentService.Client.exceptions.AccessDeniedException
DevOpsAgentService.Client.exceptions.ThrottlingException
DevOpsAgentService.Client.exceptions.ResourceNotFoundException
DevOpsAgentService.Client.exceptions.InvalidParameterException