DevOpsAgentService / Client / list_backlog_tasks

list_backlog_tasks¶

DevOpsAgentService.Client.list_backlog_tasks(**kwargs)¶

Lists backlog tasks in the specified agent space with optional filtering and sorting

Request Syntax

response = client.list_backlog_tasks(
    agentSpaceId='string',
    filter={
        'createdAfter': datetime(2015, 1, 1),
        'createdBefore': datetime(2015, 1, 1),
        'priority': [
            'CRITICAL'|'HIGH'|'MEDIUM'|'LOW'|'MINIMAL',
        ],
        'status': [
            'PENDING_TRIAGE'|'LINKED'|'PENDING_START'|'IN_PROGRESS'|'PENDING_CUSTOMER_APPROVAL'|'COMPLETED'|'FAILED'|'TIMED_OUT'|'CANCELED',
        ],
        'taskType': [
            'INVESTIGATION'|'EVALUATION',
        ],
        'primaryTaskId': 'string'
    },
    limit=123,
    nextToken='string',
    sortField='CREATED_AT'|'PRIORITY',
    order='ASC'|'DESC'
)

Parameters:

agentSpaceId (string) –
[REQUIRED]

The unique identifier for the agent space containing the tasks
filter (dict) –
Filter criteria to apply when listing tasks Filtering restrictions: - Each filter field list is limited to a single value - Filtering by Priority and Status at the same time when not filtering by Type is not permitted - Timestamp filters (createdAfter, createdBefore) can be combined with other filters when not sorting by priority
- createdAfter (datetime) –
  
  Filter for tasks created after this timestamp inclusive
- createdBefore (datetime) –
  
  Filter for tasks created before this timestamp exclusive
- priority (list) –
  
  Filter by priority (single value only)
  - (string) –
    
    Priority levels for tasks, from highest to lowest urgency
- status (list) –
  
  Filter by status (single value only)
  - (string) –
    
    Possible states of a task throughout its lifecycle
- taskType (list) –
  
  Filter by task type (single value only)
  - (string) –
    
    Types of tasks that can be created in the backlog
- primaryTaskId (string) –
  
  Filter by primary task ID to get linked tasks
limit (integer) – Maximum number of tasks to return in a single response (1-1000, default: 100)
nextToken (string) – Token for retrieving the next page of results
sortField (string) – Field to sort by Sorting restrictions: - Only sorting on createdAt is supported when using priority or status filters alone. - Sorting by priority is not supported when using Timestamp filters (createdAfter, createdBefore)
order (string) – Sort order for the tasks based on sortField (default: DESC)

Return type:

dict

Returns:

Response Syntax

{
    'tasks': [
        {
            'agentSpaceId': 'string',
            'taskId': 'string',
            'executionId': 'string',
            'title': 'string',
            'description': 'string',
            'reference': {
                'system': 'string',
                'title': 'string',
                'referenceId': 'string',
                'referenceUrl': 'string',
                'associationId': 'string'
            },
            'taskType': 'INVESTIGATION'|'EVALUATION',
            'priority': 'CRITICAL'|'HIGH'|'MEDIUM'|'LOW'|'MINIMAL',
            'status': 'PENDING_TRIAGE'|'LINKED'|'PENDING_START'|'IN_PROGRESS'|'PENDING_CUSTOMER_APPROVAL'|'COMPLETED'|'FAILED'|'TIMED_OUT'|'CANCELED',
            'createdAt': datetime(2015, 1, 1),
            'updatedAt': datetime(2015, 1, 1),
            'version': 123,
            'supportMetadata': {...}|[...]|123|123.4|'string'|True|None,
            'metadata': {...}|[...]|123|123.4|'string'|True|None,
            'primaryTaskId': 'string',
            'statusReason': 'string',
            'hasLinkedTasks': True|False
        },
    ],
    'nextToken': 'string'
}

Response Structure

(dict) –

Response structure containing a list of backlog tasks
- tasks (list) –
  
  List of backlog tasks
  - (dict) –
    
    Represents a backlog task with all its properties and metadata
    - agentSpaceId (string) –
      
      The unique identifier for the agent space containing this task
    - taskId (string) –
      
      The unique identifier for this task
    - executionId (string) –
      
      The execution ID associated with this task, if any
    - title (string) –
      
      The title of the task
    - description (string) –
      
      Optional detailed description of the task
    - reference (dict) –
      
      Optional reference information linking this task to external systems
      - system (string) –
        
        The name of the external system
      - title (string) –
        
        Optional title for the reference
      - referenceId (string) –
        
        The unique identifier in the external system
      - referenceUrl (string) –
        
        URL to access the reference in the external system
      - associationId (string) –
        
        Association identifier of the external system
    - taskType (string) –
      
      The type of this task
    - priority (string) –
      
      The priority level of this task
    - status (string) –
      
      The current status of this task
    - createdAt (datetime) –
      
      Timestamp when this task was created
    - updatedAt (datetime) –
      
      Timestamp when this task was last updated
    - version (integer) –
      
      Version number for optimistic locking
    - supportMetadata (document) –
      
      Optional support metadata for the task
    - metadata (document) –
      
      Optional metadata for the task
    - primaryTaskId (string) –
      
      The task ID of the primary investigation this task is linked to
    - statusReason (string) –
      
      Explanation for why the task status was changed (e.g., linked reason)
    - hasLinkedTasks (boolean) –
      
      Indicates if this task has other tasks linked to it
- nextToken (string) –
  
  Token for retrieving the next page of results, if more results are available

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.InvalidParameterException
DevOpsAgentService.Client.exceptions.ResourceNotFoundException