DevOpsAgentService / Client / list_chats

list_chats

DevOpsAgentService.Client.list_chats(**kwargs)

Retrieves a paginated list of the user’s recent chat executions

See also: AWS API Documentation

Request Syntax

response = client.list_chats(
    agentSpaceId='string',
    userId='string',
    maxResults=123,
    nextToken='string'
)

Parameters:

• agentSpaceId (string) –

  [REQUIRED]

  Unique identifier for an agent space (allows alphanumeric characters and hyphens; 1-64 characters)

• userId (string) –

  [REQUIRED]

  The user identifier to list chats for

• maxResults (integer) – Maximum number of results to return

• nextToken (string) – Token for pagination

Return type:

dict

Returns:

Response Syntax

{
    'executions': [
        {
            'executionId': 'string',
            'createdAt': datetime(2015, 1, 1),
            'updatedAt': datetime(2015, 1, 1),
            'summary': 'string'
        },
    ],
    'nextToken': 'string'
}

Response Structure

• (dict) –

  Response structure for listing chats

  • executions (list) –

    List of recent chat executions

    • (dict) –

      A single chat execution summary

      • executionId (string) –

        The unique identifier for the execution

      • createdAt (datetime) –

        Timestamp when the chat was created

      • updatedAt (datetime) –

        Timestamp when the chat was last updated

      • summary (string) –

        Summary or title of the chat

  • nextToken (string) –

    Token for retrieving the next page 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.ResourceNotFoundException

• DevOpsAgentService.Client.exceptions.ThrottlingException

• DevOpsAgentService.Client.exceptions.InvalidParameterException