Struct aws_sdk_backupstorage::client::Client

pub struct Client { /* private fields */ }

Client for AWS Backup Storage

Client for invoking operations on AWS Backup Storage. Each operation on AWS Backup Storage 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_backupstorage::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 Config 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_backupstorage::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 DeleteObject operation has a Client::delete_object, 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.delete_object()
    .backup_job_id("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.

Implementations

impl Client

pub fn delete_object(&self) -> DeleteObjectFluentBuilder

Constructs a fluent builder for the DeleteObject operation.

• The fluent builder is configurable:
  • backup_job_id(impl Into<String>) / set_backup_job_id(Option<String>):
    required: true
    Backup job Id for the in-progress backup.
    
  • object_name(impl Into<String>) / set_object_name(Option<String>):
    required: true
    The name of the Object.
    
• On success, responds with DeleteObjectOutput
• On failure, responds with SdkError<DeleteObjectError>

impl Client

pub fn get_chunk(&self) -> GetChunkFluentBuilder

Constructs a fluent builder for the GetChunk operation.

• The fluent builder is configurable:
  • storage_job_id(impl Into<String>) / set_storage_job_id(Option<String>):
    required: true
    Storage job id
    
  • chunk_token(impl Into<String>) / set_chunk_token(Option<String>):
    required: true
    Chunk token
    
• On success, responds with GetChunkOutput with field(s):
  • data(ByteStream): Chunk data
  • length(i64): Data length
  • checksum(String): Data checksum
  • checksum_algorithm(DataChecksumAlgorithm): Checksum algorithm
• On failure, responds with SdkError<GetChunkError>

impl Client

pub fn get_object_metadata(&self) -> GetObjectMetadataFluentBuilder

Constructs a fluent builder for the GetObjectMetadata operation.

• The fluent builder is configurable:
  • storage_job_id(impl Into<String>) / set_storage_job_id(Option<String>):
    required: true
    Backup job id for the in-progress backup.
    
  • object_token(impl Into<String>) / set_object_token(Option<String>):
    required: true
    Object token.
    
• On success, responds with GetObjectMetadataOutput with field(s):
  • metadata_string(Option<String>): Metadata string.
  • metadata_blob(ByteStream): Metadata blob.
  • metadata_blob_length(i64): The size of MetadataBlob.
  • metadata_blob_checksum(Option<String>): MetadataBlob checksum.
  • metadata_blob_checksum_algorithm(Option<DataChecksumAlgorithm>): Checksum algorithm.
• On failure, responds with SdkError<GetObjectMetadataError>

impl Client

pub fn list_chunks(&self) -> ListChunksFluentBuilder

Constructs a fluent builder for the ListChunks operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • storage_job_id(impl Into<String>) / set_storage_job_id(Option<String>):
    required: true
    Storage job id
    
  • object_token(impl Into<String>) / set_object_token(Option<String>):
    required: true
    Object token
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    Maximum number of chunks
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    Pagination token
    
• On success, responds with ListChunksOutput with field(s):
  • chunk_list(Vec::<Chunk>): List of chunks
  • next_token(Option<String>): Pagination token
• On failure, responds with SdkError<ListChunksError>

impl Client

pub fn list_objects(&self) -> ListObjectsFluentBuilder

Constructs a fluent builder for the ListObjects operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • storage_job_id(impl Into<String>) / set_storage_job_id(Option<String>):
    required: true
    Storage job id
    
  • starting_object_name(impl Into<String>) / set_starting_object_name(Option<String>):
    required: false
    Optional, specifies the starting Object name to list from. Ignored if NextToken is not NULL
    
  • starting_object_prefix(impl Into<String>) / set_starting_object_prefix(Option<String>):
    required: false
    Optional, specifies the starting Object prefix to list from. Ignored if NextToken is not NULL
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    Maximum objects count
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    Pagination token
    
  • created_before(DateTime) / set_created_before(Option<DateTime>):
    required: false
    (Optional) Created before filter
    
  • created_after(DateTime) / set_created_after(Option<DateTime>):
    required: false
    (Optional) Created after filter
    
• On success, responds with ListObjectsOutput with field(s):
  • object_list(Vec::<BackupObject>): Object list
  • next_token(Option<String>): Pagination token
• On failure, responds with SdkError<ListObjectsError>

impl Client

pub fn notify_object_complete(&self) -> NotifyObjectCompleteFluentBuilder

Constructs a fluent builder for the NotifyObjectComplete operation.

• The fluent builder is configurable:
  • backup_job_id(impl Into<String>) / set_backup_job_id(Option<String>):
    required: true
    Backup job Id for the in-progress backup
    
  • upload_id(impl Into<String>) / set_upload_id(Option<String>):
    required: true
    Upload Id for the in-progress upload
    
  • object_checksum(impl Into<String>) / set_object_checksum(Option<String>):
    required: true
    Object checksum
    
  • object_checksum_algorithm(SummaryChecksumAlgorithm) / set_object_checksum_algorithm(Option<SummaryChecksumAlgorithm>):
    required: true
    Checksum algorithm
    
  • metadata_string(impl Into<String>) / set_metadata_string(Option<String>):
    required: false
    Optional metadata associated with an Object. Maximum string length is 256 bytes.
    
  • metadata_blob(ByteStream) / set_metadata_blob(ByteStream):
    required: false
    Optional metadata associated with an Object. Maximum length is 4MB.
    
  • metadata_blob_length(i64) / set_metadata_blob_length(Option<i64>):
    required: false
    The size of MetadataBlob.
    
  • metadata_blob_checksum(impl Into<String>) / set_metadata_blob_checksum(Option<String>):
    required: false
    Checksum of MetadataBlob.
    
  • metadata_blob_checksum_algorithm(DataChecksumAlgorithm) / set_metadata_blob_checksum_algorithm(Option<DataChecksumAlgorithm>):
    required: false
    Checksum algorithm.
    
• On success, responds with NotifyObjectCompleteOutput with field(s):
  • object_checksum(String): Object checksum
  • object_checksum_algorithm(SummaryChecksumAlgorithm): Checksum algorithm
• On failure, responds with SdkError<NotifyObjectCompleteError>

impl Client

pub fn put_chunk(&self) -> PutChunkFluentBuilder

Constructs a fluent builder for the PutChunk operation.

• The fluent builder is configurable:
  • backup_job_id(impl Into<String>) / set_backup_job_id(Option<String>):
    required: true
    Backup job Id for the in-progress backup.
    
  • upload_id(impl Into<String>) / set_upload_id(Option<String>):
    required: true
    Upload Id for the in-progress upload.
    
  • chunk_index(i64) / set_chunk_index(Option<i64>):
    required: true
    Describes this chunk’s position relative to the other chunks
    
  • data(ByteStream) / set_data(ByteStream):
    required: true
    Data to be uploaded
    
  • length(i64) / set_length(Option<i64>):
    required: true
    Data length
    
  • checksum(impl Into<String>) / set_checksum(Option<String>):
    required: true
    Data checksum
    
  • checksum_algorithm(DataChecksumAlgorithm) / set_checksum_algorithm(Option<DataChecksumAlgorithm>):
    required: true
    Checksum algorithm
    
• On success, responds with PutChunkOutput with field(s):
  • chunk_checksum(String): Chunk checksum
  • chunk_checksum_algorithm(DataChecksumAlgorithm): Checksum algorithm
• On failure, responds with SdkError<PutChunkError>

impl Client

pub fn put_object(&self) -> PutObjectFluentBuilder

Constructs a fluent builder for the PutObject operation.

• The fluent builder is configurable:
  • backup_job_id(impl Into<String>) / set_backup_job_id(Option<String>):
    required: true
    Backup job Id for the in-progress backup.
    
  • object_name(impl Into<String>) / set_object_name(Option<String>):
    required: true
    The name of the Object to be uploaded.
    
  • metadata_string(impl Into<String>) / set_metadata_string(Option<String>):
    required: false
    Store user defined metadata like backup checksum, disk ids, restore metadata etc.
    
  • inline_chunk(ByteStream) / set_inline_chunk(ByteStream):
    required: false
    Inline chunk data to be uploaded.
    
  • inline_chunk_length(i64) / set_inline_chunk_length(Option<i64>):
    required: false
    Length of the inline chunk data.
    
  • inline_chunk_checksum(impl Into<String>) / set_inline_chunk_checksum(Option<String>):
    required: false
    Inline chunk checksum
    
  • inline_chunk_checksum_algorithm(impl Into<String>) / set_inline_chunk_checksum_algorithm(Option<String>):
    required: false
    Inline chunk checksum algorithm
    
  • object_checksum(impl Into<String>) / set_object_checksum(Option<String>):
    required: false
    object checksum
    
  • object_checksum_algorithm(SummaryChecksumAlgorithm) / set_object_checksum_algorithm(Option<SummaryChecksumAlgorithm>):
    required: false
    object checksum algorithm
    
  • throw_on_duplicate(bool) / set_throw_on_duplicate(Option<bool>):
    required: false
    Throw an exception if Object name is already exist.
    
• On success, responds with PutObjectOutput with field(s):
  • inline_chunk_checksum(String): Inline chunk checksum
  • inline_chunk_checksum_algorithm(DataChecksumAlgorithm): Inline chunk checksum algorithm
  • object_checksum(String): object checksum
  • object_checksum_algorithm(SummaryChecksumAlgorithm): object checksum algorithm
• On failure, responds with SdkError<PutObjectError>

impl Client

pub fn start_object(&self) -> StartObjectFluentBuilder

Constructs a fluent builder for the StartObject operation.

• The fluent builder is configurable:
  • backup_job_id(impl Into<String>) / set_backup_job_id(Option<String>):
    required: true
    Backup job Id for the in-progress backup
    
  • object_name(impl Into<String>) / set_object_name(Option<String>):
    required: true
    Name for the object.
    
  • throw_on_duplicate(bool) / set_throw_on_duplicate(Option<bool>):
    required: false
    Throw an exception if Object name is already exist.
    
• On success, responds with StartObjectOutput with field(s):
  • upload_id(String): Upload Id for a given upload.
• On failure, responds with SdkError<StartObjectError>

impl Client

pub fn from_conf(conf: Config) -> Self

Creates a new client from the service Config.

Panics

This method will panic in the following cases:

• Retries or timeouts are enabled without a sleep_impl configured.
• Identity caching is enabled without a sleep_impl and time_source configured.
• No behavior_version is provided.

The panic message for each of these will have instructions on how to resolve them.

pub fn config(&self) -> &Config

Returns the client’s configuration.

impl Client

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

Creates a new client from an SDK Config.

Panics

• This method will panic if the sdk_config is missing an async sleep implementation. If you experience this panic, set the sleep_impl on the Config passed into this function to fix it.
• This method will panic if the sdk_config is missing an HTTP connector. If you experience this panic, set the http_connector on the Config passed into this function to fix it.
• This method will panic if no BehaviorVersion is provided. If you experience this panic, set behavior_version on the Config or enable the behavior-version-latest Cargo feature.

Trait Implementations

impl Clone for Client

fn clone(&self) -> Client

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Client

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

Formats the value using the given formatter.