Struct Client

Source

pub struct Client { /* private fields */ }

Expand description

Client for AWS Backup Gateway

Client for invoking operations on AWS Backup Gateway. Each operation on AWS Backup Gateway is a method on this this struct. .send() MUST be invoked on the generated operations to dispatch the request to the service.

§Constructing a `Client`

A Config is required to construct a client. For most use cases, the aws-config crate should be used to automatically resolve this config using aws_config::load_from_env(), since this will resolve an SdkConfig which can be shared across multiple different AWS SDK clients. This config resolution process can be customized by calling aws_config::from_env() instead, which returns a ConfigLoader that uses the builder pattern to customize the default config.

In the simplest case, creating a client looks as follows:

let config = aws_config::load_from_env().await;
let client = aws_sdk_backupgateway::Client::new(&config);

Occasionally, SDKs may have additional service-specific values that can be set on the Config that is absent from SdkConfig, or slightly different settings for a specific client may be desired. The Builder struct implements From<&SdkConfig>, so setting these specific settings can be done as follows:

let sdk_config = ::aws_config::load_from_env().await;
let config = aws_sdk_backupgateway::config::Builder::from(&sdk_config)
    .some_service_specific_setting("value")
    .build();

See the aws-config docs and Config for more information on customizing configuration.

Note: Client construction is expensive due to connection thread pool initialization, and should be done once at application start-up.

§Using the `Client`

A client has a function for every operation that can be performed by the service. For example, the AssociateGatewayToServer operation has a Client::associate_gateway_to_server, function which returns a builder for that operation. The fluent builder ultimately has a send() function that returns an async future that returns a result, as illustrated below:

let result = client.associate_gateway_to_server()
    .gateway_arn("example")
    .send()
    .await;

The underlying HTTP requests that get made by this can be modified with the customize_operation function on the fluent builder. See the customize module for more information.

Struct ClientCopy item path

§Constructing a Client

§Using the Client

Implementations§

impl Client

pub fn associate_gateway_to_server( &self, ) -> AssociateGatewayToServerFluentBuilder

impl Client

pub fn create_gateway(&self) -> CreateGatewayFluentBuilder

impl Client

pub fn delete_gateway(&self) -> DeleteGatewayFluentBuilder

impl Client

pub fn delete_hypervisor(&self) -> DeleteHypervisorFluentBuilder

impl Client

pub fn disassociate_gateway_from_server( &self, ) -> DisassociateGatewayFromServerFluentBuilder

impl Client

pub fn get_bandwidth_rate_limit_schedule( &self, ) -> GetBandwidthRateLimitScheduleFluentBuilder

impl Client

pub fn get_gateway(&self) -> GetGatewayFluentBuilder

impl Client

pub fn get_hypervisor(&self) -> GetHypervisorFluentBuilder

impl Client

pub fn get_hypervisor_property_mappings( &self, ) -> GetHypervisorPropertyMappingsFluentBuilder

impl Client

pub fn get_virtual_machine(&self) -> GetVirtualMachineFluentBuilder

impl Client

pub fn import_hypervisor_configuration( &self, ) -> ImportHypervisorConfigurationFluentBuilder

impl Client

pub fn list_gateways(&self) -> ListGatewaysFluentBuilder

impl Client

pub fn list_hypervisors(&self) -> ListHypervisorsFluentBuilder

impl Client

pub fn list_tags_for_resource(&self) -> ListTagsForResourceFluentBuilder

impl Client

pub fn list_virtual_machines(&self) -> ListVirtualMachinesFluentBuilder

impl Client

pub fn put_bandwidth_rate_limit_schedule( &self, ) -> PutBandwidthRateLimitScheduleFluentBuilder

impl Client

pub fn put_hypervisor_property_mappings( &self, ) -> PutHypervisorPropertyMappingsFluentBuilder

impl Client

pub fn put_maintenance_start_time(&self) -> PutMaintenanceStartTimeFluentBuilder

impl Client

pub fn start_virtual_machines_metadata_sync( &self, ) -> StartVirtualMachinesMetadataSyncFluentBuilder

impl Client

pub fn tag_resource(&self) -> TagResourceFluentBuilder

impl Client

pub fn test_hypervisor_configuration( &self, ) -> TestHypervisorConfigurationFluentBuilder

impl Client

pub fn untag_resource(&self) -> UntagResourceFluentBuilder

impl Client

pub fn update_gateway_information( &self, ) -> UpdateGatewayInformationFluentBuilder

impl Client

pub fn update_gateway_software_now( &self, ) -> UpdateGatewaySoftwareNowFluentBuilder

impl Client

pub fn update_hypervisor(&self) -> UpdateHypervisorFluentBuilder

impl Client

pub fn from_conf(conf: Config) -> Self

§Panics

pub fn config(&self) -> &Config

impl Client

pub fn new(sdk_config: &SdkConfig) -> Self

§Panics

Trait Implementations§

impl Clone for Client

fn clone(&self) -> Client

fn clone_from(&mut self, source: &Self)

impl Debug for Client

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Auto Trait Implementations§

impl Freeze for Client

impl !RefUnwindSafe for Client

impl Send for Client

impl Sync for Client

impl Unpin for Client

impl !UnwindSafe for Client

Blanket Implementations§

impl<T> Any for Twhere T: 'static + ?Sized,

fn type_id(&self) -> TypeId

impl<T> Borrow<T> for Twhere T: ?Sized,

fn borrow(&self) -> &T

impl<T> BorrowMut<T> for Twhere T: ?Sized,

Struct Client

§Constructing a `Client`

§Using the `Client`

impl<T> Any for T
where T: 'static + ?Sized,

impl<T> Borrow<T> for T
where T: ?Sized,

impl<T> BorrowMut<T> for T
where T: ?Sized,

impl<T> CloneToUninit for T
where T: Clone,

impl<T, U> Into<U> for T
where U: From<T>,

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

impl<Unshared, Shared> IntoShared<Shared> for Unshared
where Shared: FromUnshared<Unshared>,

impl<T> Paint for T
where T: ?Sized,