DevOpsAgentService / Paginator / ListExecutions

ListExecutions¶

class DevOpsAgentService.Paginator.ListExecutions¶

paginator = client.get_paginator('list_executions')

paginate(**kwargs)¶

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

Request Syntax

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

Parameters:

agentSpaceId (string) –
[REQUIRED]

The unique identifier for the agent space
taskId (string) –
[REQUIRED]

The unique identifier of the task whose executions to retrieve
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

{
    'executions': [
        {
            'agentSpaceId': 'string',
            'executionId': 'string',
            'parentExecutionId': 'string',
            'agentSubTask': 'string',
            'createdAt': datetime(2015, 1, 1),
            'updatedAt': datetime(2015, 1, 1),
            'executionStatus': 'FAILED'|'RUNNING'|'STOPPED'|'CANCELED'|'TIMED_OUT',
            'agentType': 'string',
            'uid': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

(dict) –

Response structure containing executions
- executions (list) –
  
  List of executions
  - (dict) –
    
    Represents an execution instance with its lifecycle information
    - agentSpaceId (string) –
      
      The unique identifier for the agent space containing this execution
    - executionId (string) –
      
      The unique identifier for this execution
    - parentExecutionId (string) –
      
      The identifier of the parent execution, if this is a child execution
    - agentSubTask (string) –
      
      The specific subtask being executed by the agent
    - createdAt (datetime) –
      
      Timestamp when this execution was created
    - updatedAt (datetime) –
      
      Timestamp when this execution was last updated
    - executionStatus (string) –
      
      The current status of this execution
    - agentType (string) –
      
      The type of agent that performed this execution.
    - uid (string) –
      
      The unique identifier for the user session associated with this execution
- NextToken (string) –
  
  A token to resume pagination.