Skip to content

update_agent_collaborator

update_agent_collaborator(
    agent_id: Id,
    agent_version: DraftVersion,
    collaborator_id: Id,
    agent_descriptor: AgentDescriptor,
    collaborator_name: Name,
    collaboration_instruction: CollaborationInstruction,
    *,
    config_overrides: Optional[BedrockAgentClientConfig] = None,
    relay_conversation_history: Optional[RelayConversationHistory] = None,
) -> UpdateAgentCollaboratorResponse

Updates an agent's collaborator.

Parameters:

  • agent_id (Id) –

    The agent's ID.

  • agent_version (DraftVersion) –

    The agent's version.

  • collaborator_id (Id) –

    The collaborator's ID.

  • agent_descriptor (AgentDescriptor) –

    An agent descriptor for the agent collaborator.

  • collaborator_name (Name) –

    The collaborator's name.

  • collaboration_instruction (CollaborationInstruction) –

    Instruction for the collaborator.

  • relay_conversation_history (Optional[RelayConversationHistory], default: None ) –

    A relay conversation history for the collaborator.

Raises:

Source code in docs_src/capo_bedrock_agent/_services/bedrock_agent.py
def update_agent_collaborator(
    self,
    agent_id: "capo_bedrock_agent.types.id.Id",
    agent_version: "capo_bedrock_agent.types.draft_version.DraftVersion",
    collaborator_id: "capo_bedrock_agent.types.id.Id",
    agent_descriptor: "capo_bedrock_agent.types.agent_descriptor.AgentDescriptor",
    collaborator_name: "capo_bedrock_agent.types.name.Name",
    collaboration_instruction: "capo_bedrock_agent.types.collaboration_instruction.CollaborationInstruction",
    *,
    config_overrides: Optional[BedrockAgentClientConfig] = None,
    relay_conversation_history: Optional[
        "capo_bedrock_agent.types.relay_conversation_history.RelayConversationHistory"
    ] = None,
) -> "capo_bedrock_agent.types.update_agent_collaborator_response.UpdateAgentCollaboratorResponse":
    """<p>Updates an agent's collaborator.</p>

    Args:
        agent_id: <p>The agent's ID.</p>
        agent_version: <p>The agent's version.</p>
        collaborator_id: <p>The collaborator's ID.</p>
        agent_descriptor: <p>An agent descriptor for the agent collaborator.</p>
        collaborator_name: <p>The collaborator's name.</p>
        collaboration_instruction: <p>Instruction for the collaborator.</p>
        relay_conversation_history: <p>A relay conversation history for the collaborator.</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.conflict_exception.ConflictException: <p>There was a conflict performing an operation.</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.service_quota_exceeded_exception.ServiceQuotaExceededException: <p>The number of requests exceeds the service quota. Resubmit your request later.</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.
    """

    def _handler(
        req: "OperationRequest[capo_bedrock_agent.types.update_agent_collaborator_request.UpdateAgentCollaboratorRequest]",
    ) -> OperationResponse[
        "capo_bedrock_agent.types.update_agent_collaborator_response.UpdateAgentCollaboratorResponse"
    ]:
        import capo_bedrock_agent._operations.amazon_bedrock_agent_build_time_lambda.update_agent_collaborator

        output, http_response = (
            capo_bedrock_agent._operations.amazon_bedrock_agent_build_time_lambda.update_agent_collaborator.update_agent_collaborator(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    def _redact_input(
        input_: "capo_bedrock_agent.types.update_agent_collaborator_request.UpdateAgentCollaboratorRequest",
    ) -> dict[str, Any]:
        import capo_bedrock_agent.types.update_agent_collaborator_request

        return capo_bedrock_agent.types.update_agent_collaborator_request.redact_sensitive(
            input_
        )

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

        return capo_bedrock_agent.types.update_agent_collaborator_response.redact_sensitive(
            output
        )

    interceptors_, options_ = self.operation_options(
        config_overrides,
        OperationLogging(
            "UpdateAgentCollaborator",
            redact_input=_redact_input,
            redact_output=_redact_output,
        ),
    )
    input_: capo_bedrock_agent.types.update_agent_collaborator_request.UpdateAgentCollaboratorRequest = {
        "agent_id": agent_id,
        "agent_version": agent_version,
        "collaborator_id": collaborator_id,
        "agent_descriptor": agent_descriptor,
        "collaborator_name": collaborator_name,
        "collaboration_instruction": collaboration_instruction,
    }
    if relay_conversation_history is not None:
        input_["relay_conversation_history"] = relay_conversation_history

    response = execute_pipeline(
        OperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    response.response.close()
    return response.output