Skip to content

list_agent_collaborators async

list_agent_collaborators(
    agent_id: Id,
    agent_version: Version,
    *,
    config_overrides: Optional[AsyncBedrockAgentClientConfig] = None,
    max_results: Optional[MaxResults] = None,
    next_token: Optional[NextToken] = None,
) -> ListAgentCollaboratorsResponse

Retrieve a list of an agent's collaborators.

Parameters:

  • agent_id (Id) –

    The agent's ID.

  • agent_version (Version) –

    The agent's version.

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

    The maximum number of agent collaborators to return in one page of results.

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

    Specify the pagination token from a previous request to retrieve the next page of results.

Raises:

Source code in docs_src/capo_bedrock_agent/_services/async_bedrock_agent.py
async def list_agent_collaborators(
    self,
    agent_id: "capo_bedrock_agent.types.id.Id",
    agent_version: "capo_bedrock_agent.types.version.Version",
    *,
    config_overrides: Optional[AsyncBedrockAgentClientConfig] = None,
    max_results: Optional["capo_bedrock_agent.types.max_results.MaxResults"] = None,
    next_token: Optional["capo_bedrock_agent.types.next_token.NextToken"] = None,
) -> "capo_bedrock_agent.types.list_agent_collaborators_response.ListAgentCollaboratorsResponse":
    """<p>Retrieve a list of an agent's collaborators.</p>

    Args:
        agent_id: <p>The agent's ID.</p>
        agent_version: <p>The agent's version.</p>
        max_results: <p>The maximum number of agent collaborators to return in one page of results.</p>
        next_token: <p>Specify the pagination token from a previous request to retrieve the next page of results.</p>

    Raises:
        capo_bedrock_agent.errors.access_denied_exception.AccessDeniedException: <p>The request is denied because of missing access permissions.</p>
        capo_bedrock_agent.errors.internal_server_exception.InternalServerException: <p>An internal server error occurred. Retry your request.</p>
        capo_bedrock_agent.errors.resource_not_found_exception.ResourceNotFoundException: <p>The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again.</p>
        capo_bedrock_agent.errors.throttling_exception.ThrottlingException: <p>The number of requests exceeds the limit. Resubmit your request later.</p>
        capo_bedrock_agent.errors.validation_exception.ValidationException: <p>Input validation failed. Check your request parameters and retry the request.</p>
        capo_bedrock_agent.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_bedrock_agent.types.list_agent_collaborators_request.ListAgentCollaboratorsRequest]",
    ) -> AsyncOperationResponse[
        "capo_bedrock_agent.types.list_agent_collaborators_response.ListAgentCollaboratorsResponse"
    ]:
        import capo_bedrock_agent._operations.amazon_bedrock_agent_build_time_lambda.list_agent_collaborators

        (
            output,
            http_response,
        ) = await capo_bedrock_agent._operations.amazon_bedrock_agent_build_time_lambda.list_agent_collaborators.async_list_agent_collaborators(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    def _redact_output(
        output: "capo_bedrock_agent.types.list_agent_collaborators_response.ListAgentCollaboratorsResponse",
    ) -> dict[str, Any]:
        import capo_bedrock_agent.types.list_agent_collaborators_response

        return capo_bedrock_agent.types.list_agent_collaborators_response.redact_sensitive(
            output
        )

    interceptors_, options_ = self.operation_options(
        config_overrides,
        OperationLogging("ListAgentCollaborators", redact_output=_redact_output),
    )
    input_: capo_bedrock_agent.types.list_agent_collaborators_request.ListAgentCollaboratorsRequest = {
        "agent_id": agent_id,
        "agent_version": agent_version,
    }
    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