update_agent ¶

def update_agent(
    self,
    agent_arn: "capo_datasync.types.agent_arn.AgentArn",
    *,
    config_overrides: Optional[DataSyncClientConfig] = None,
    name: Optional["capo_datasync.types.tag_value.TagValue"] = None,
) -> "capo_datasync.types.update_agent_response.UpdateAgentResponse":
    """<p>Updates the name of an DataSync agent.</p>

    Args:
        agent_arn: <p>The Amazon Resource Name (ARN) of the agent to update.</p>
        name: <p>The name that you want to use to configure the agent.</p>

    Raises:
        capo_datasync.errors.internal_exception.InternalException: <p>This exception is thrown when an error occurs in the DataSync service.</p>
        capo_datasync.errors.invalid_request_exception.InvalidRequestException: <p>This exception is thrown when the client submits a malformed request.</p>
        capo_datasync.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_datasync.types.update_agent_request.UpdateAgentRequest]",
    ) -> OperationResponse[
        "capo_datasync.types.update_agent_response.UpdateAgentResponse"
    ]:
        import capo_datasync._operations.fmrs_service.update_agent

        output, http_response = (
            capo_datasync._operations.fmrs_service.update_agent.update_agent(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("UpdateAgent")
    )
    input_: capo_datasync.types.update_agent_request.UpdateAgentRequest = {
        "agent_arn": agent_arn
    }
    if name is not None:
        input_["name"] = name

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