update_gateway_information ¶

def update_gateway_information(
    self,
    gateway_arn: "capo_backup_gateway.types.gateway_arn.GatewayArn",
    *,
    config_overrides: Optional[BackupGatewayClientConfig] = None,
    gateway_display_name: Optional["capo_backup_gateway.types.name.Name"] = None,
) -> "capo_backup_gateway.types.update_gateway_information_output.UpdateGatewayInformationOutput":
    """<p>Updates a gateway's name. Specify which gateway to update using the Amazon Resource Name (ARN) of the gateway in your request.</p>

    Args:
        gateway_arn: <p>The Amazon Resource Name (ARN) of the gateway to update.</p>
        gateway_display_name: <p>The updated display name of the gateway.</p>

    Raises:
        capo_backup_gateway.errors.internal_server_exception.InternalServerException: <p>The operation did not succeed because an internal error occurred. Try again later.</p>
        capo_backup_gateway.errors.throttling_exception.ThrottlingException: <p>TPS has been limited to protect against intentional or unintentional high request volumes.</p>
        capo_backup_gateway.errors.validation_exception.ValidationException: <p>The operation did not succeed because a validation error occurred.</p>
        capo_backup_gateway.errors.conflict_exception.ConflictException: <p>The operation cannot proceed because it is not supported.</p>
        capo_backup_gateway.errors.resource_not_found_exception.ResourceNotFoundException: <p>A resource that is required for the action wasn't found.</p>
        capo_backup_gateway.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_backup_gateway.types.update_gateway_information_input.UpdateGatewayInformationInput]",
    ) -> OperationResponse[
        "capo_backup_gateway.types.update_gateway_information_output.UpdateGatewayInformationOutput"
    ]:
        import capo_backup_gateway._operations.backup_on_premises_v20210101.update_gateway_information

        output, http_response = (
            capo_backup_gateway._operations.backup_on_premises_v20210101.update_gateway_information.update_gateway_information(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("UpdateGatewayInformation")
    )
    input_: capo_backup_gateway.types.update_gateway_information_input.UpdateGatewayInformationInput = {
        "gateway_arn": gateway_arn
    }
    if gateway_display_name is not None:
        input_["gateway_display_name"] = gateway_display_name

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