DevOpsAgentService / Client / list_pending_messages

list_pending_messages¶

DevOpsAgentService.Client.list_pending_messages(**kwargs)¶

List pending messages for a specific execution.

Request Syntax

response = client.list_pending_messages(
    agentSpaceId='string',
    executionId='string'
)

Parameters:

agentSpaceId (string) –
[REQUIRED]

Unique identifier for an agent space (allows alphanumeric characters and hyphens; 1-64 characters)
executionId (string) –
[REQUIRED]

The unique identifier of the execution whose journal records to retrieve

Return type:

dict

Returns:

Response Syntax

{
    'agentSpaceId': 'string',
    'executionId': 'string',
    'messages': [
        {
            'messageId': 'string',
            'message': {
                'userMessage': [
                    {
                        'text': 'string',
                        'toolResult': {...}|[...]|123|123.4|'string'|True|None
                    },
                ],
                'assistantMessage': [
                    {
                        'text': 'string',
                        'toolUse': {...}|[...]|123|123.4|'string'|True|None
                    },
                ]
            }
        },
    ],
    'createdAt': datetime(2015, 1, 1)
}

Response Structure

(dict) –

Response structure containing a list of pending messages
- agentSpaceId (string) –
  
  Unique identifier for an agent space (allows alphanumeric characters and hyphens; 1-64 characters)
- executionId (string) –
  
  The unique identifier for the execution.
- messages (list) –
  
  The list of pending messages for the execution.
  - (dict) –
    
    Represents a pending message in an agent execution.
    - messageId (string) –
      
      The unique identifier for this pending message.
    - message (dict) –
      
      The message content.
      Note
      This is a Tagged Union structure. Only one of the following top level keys will be set: userMessage, assistantMessage. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
      
      'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
      - userMessage (list) –
        
        A message from the user.
        
        (dict) –
        
        A block of content in a user message.
        
        Note
        This is a Tagged Union structure. Only one of the following top level keys will be set: text, toolResult. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
        
        'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
        
        text (string) –
        
        Text content from the user.
        
        toolResult (document) –
        
        Tool execution result provided by the user.
      - assistantMessage (list) –
        
        A message from the assistant.
        
        (dict) –
        
        A block of content in an assistant message.
        
        Note
        This is a Tagged Union structure. Only one of the following top level keys will be set: text, toolUse. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
        
        'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
        
        text (string) –
        
        Text content from the assistant.
        
        toolUse (document) –
        
        Tool use request from the assistant.
- createdAt (datetime) –
  
  Timestamp when the pending messages were created.

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