Skip to content

list_chats async

list_chats(
    agent_space_id: AgentSpaceIdentifier,
    *,
    config_overrides: Optional[AsyncDevOpsAgentClientConfig] = None,
    user_id: Optional[ResourceId] = None,
    max_results: Optional[int] = None,
    next_token: Optional[str] = None,
) -> ListChatsResponse

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

Parameters:

  • agent_space_id (AgentSpaceIdentifier) –

    The unique identifier for the agent space to list chats from.

  • user_id (Optional[ResourceId], default: None ) –

    The user identifier to list chats for. This field is deprecated and will be ignored — the service resolves user identity from the authenticated session.

  • max_results (Optional[int], default: None ) –

    Maximum number of results to return

  • next_token (Optional[str], default: None ) –

    Token for pagination

Raises:

Source code in docs_src/capo_devops_agent/_services/async_dev_ops_agent.py
async def list_chats(
    self,
    agent_space_id: "capo_devops_agent.types.agent_space_identifier.AgentSpaceIdentifier",
    *,
    config_overrides: Optional[AsyncDevOpsAgentClientConfig] = None,
    user_id: Optional["capo_devops_agent.types.resource_id.ResourceId"] = None,
    max_results: Optional[int] = None,
    next_token: Optional[str] = None,
) -> "capo_devops_agent.types.list_chats_response.ListChatsResponse":
    """<p>Retrieves a paginated list of the user's recent chat executions</p>

    Args:
        agent_space_id: <p>The unique identifier for the agent space to list chats from.</p>
        user_id: <p>The user identifier to list chats for. This field is deprecated and will be ignored — the service resolves user identity from the authenticated session.</p>
        max_results: <p>Maximum number of results to return</p>
        next_token: <p>Token for pagination</p>

    Raises:
        capo_devops_agent.errors.access_denied_exception.AccessDeniedException: <p>Access to the requested resource is denied due to insufficient permissions.</p>
        capo_devops_agent.errors.conflict_exception.ConflictException: <p>The request conflicts with the current state of the resource.</p>
        capo_devops_agent.errors.content_size_exceeded_exception.ContentSizeExceededException: <p>This exception is thrown when the content size exceeds the allowed limit.</p>
        capo_devops_agent.errors.internal_server_exception.InternalServerException: <p>This exception is thrown when an unexpected error occurs in the processing of a request.</p>
        capo_devops_agent.errors.invalid_parameter_exception.InvalidParameterException: <p>One or more parameters provided in the request are invalid.</p>
        capo_devops_agent.errors.resource_not_found_exception.ResourceNotFoundException: <p>The requested resource could not be found.</p>
        capo_devops_agent.errors.service_quota_exceeded_exception.ServiceQuotaExceededException: <p>The request would exceed the service quota limit.</p>
        capo_devops_agent.errors.throttling_exception.ThrottlingException: <p>The request was throttled due to too many requests. Please slow down and try again.</p>
        capo_devops_agent.errors.validation_exception.ValidationException: <p>The input fails to satisfy the constraints specified by the service.</p>
        capo_devops_agent.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_devops_agent.types.list_chats_request.ListChatsRequest]",
    ) -> AsyncOperationResponse[
        "capo_devops_agent.types.list_chats_response.ListChatsResponse"
    ]:
        import capo_devops_agent._operations.dev_ops_agent.list_chats

        (
            output,
            http_response,
        ) = await capo_devops_agent._operations.dev_ops_agent.list_chats.async_list_chats(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("ListChats")
    )
    input_: capo_devops_agent.types.list_chats_request.ListChatsRequest = {
        "agent_space_id": agent_space_id
    }
    if user_id is not None:
        input_["user_id"] = user_id
    if max_results is not None:
        input_["max_results"] = max_results
    if next_token is not None:
        input_["next_token"] = next_token

    response = await aexecute_pipeline(
        AsyncOperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    await response.response.aclose()
    return response.output