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.

Examples

Constructing a client and invoking an operation

    // create a shared configuration. This can be used & shared between multiple service clients.
    let shared_config = aws_config::load_from_env().await;
    let client = aws_sdk_backupstorage::Client::new(&shared_config);
    // invoke an operation
    /* let rsp = client
        .<operation_name>().
        .<param>("some value")
        .send().await; */

Constructing a client with custom configuration

use aws_config::retry::RetryConfig;
let shared_config = aws_config::load_from_env().await;
let config = aws_sdk_backupstorage::config::Builder::from(&shared_config)
  .retry_config(RetryConfig::disabled())
  .build();
let client = aws_sdk_backupstorage::Client::from_conf(config);

Implementations

impl Client

pub fn with_config(
    client: Client<DynConnector, DynMiddleware<DynConnector>>,
    conf: Config
) -> Self

Creates a client with the given service configuration.

pub fn conf(&self) -> &Config

Returns the client’s configuration.

impl Client

pub fn delete_object(&self) -> DeleteObject

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>): Backup job Id for the in-progress backup.
  • object_name(impl Into<String>) / set_object_name(Option<String>): The name of the Object.
• On success, responds with DeleteObjectOutput
• On failure, responds with SdkError<DeleteObjectError>

pub fn get_chunk(&self) -> GetChunk

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>): Storage job id
  • chunk_token(impl Into<String>) / set_chunk_token(Option<String>): Chunk token
• On success, responds with GetChunkOutput with field(s):
  • data(ByteStream): Chunk data
  • length(i64): Data length
  • checksum(Option<String>): Data checksum
  • checksum_algorithm(Option<DataChecksumAlgorithm>): Checksum algorithm
• On failure, responds with SdkError<GetChunkError>

pub fn get_object_metadata(&self) -> GetObjectMetadata

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>): Backup job id for the in-progress backup.
  • object_token(impl Into<String>) / set_object_token(Option<String>): 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>

pub fn list_chunks(&self) -> ListChunks

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>): Storage job id
  • object_token(impl Into<String>) / set_object_token(Option<String>): Object token
  • max_results(i32) / set_max_results(i32): Maximum number of chunks
  • next_token(impl Into<String>) / set_next_token(Option<String>): Pagination token
• On success, responds with ListChunksOutput with field(s):
  • chunk_list(Option<Vec<Chunk>>): List of chunks
  • next_token(Option<String>): Pagination token
• On failure, responds with SdkError<ListChunksError>

pub fn list_objects(&self) -> ListObjects

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>): Storage job id
  • starting_object_name(impl Into<String>) / set_starting_object_name(Option<String>): 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>): Optional, specifies the starting Object prefix to list from. Ignored if NextToken is not NULL
  • max_results(i32) / set_max_results(i32): Maximum objects count
  • next_token(impl Into<String>) / set_next_token(Option<String>): Pagination token
  • created_before(DateTime) / set_created_before(Option<DateTime>): (Optional) Created before filter
  • created_after(DateTime) / set_created_after(Option<DateTime>): (Optional) Created after filter
• On success, responds with ListObjectsOutput with field(s):
  • object_list(Option<Vec<BackupObject>>): Object list
  • next_token(Option<String>): Pagination token
• On failure, responds with SdkError<ListObjectsError>

pub fn notify_object_complete(&self) -> NotifyObjectComplete

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

pub fn put_chunk(&self) -> PutChunk

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

pub fn put_object(&self) -> PutObject

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

pub fn start_object(&self) -> StartObject

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>): Backup job Id for the in-progress backup
  • object_name(impl Into<String>) / set_object_name(Option<String>): Name for the object.
  • throw_on_duplicate(bool) / set_throw_on_duplicate(bool): Throw an exception if Object name is already exist.
• On success, responds with StartObjectOutput with field(s):
  • upload_id(Option<String>): Upload Id for a given upload.
• On failure, responds with SdkError<StartObjectError>

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.

pub fn from_conf(conf: Config) -> Self

Creates a new client from the service Config.

Panics

• This method will panic if the conf 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 conf is missing an HTTP connector. If you experience this panic, set the http_connector on the Config passed into this function to fix it.

Trait Implementations

impl Clone for Client

fn clone(&self) -> Self

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.

impl From<Client<DynConnector, DynMiddleware<DynConnector>, Standard>> for Client

fn from(client: Client<DynConnector, DynMiddleware<DynConnector>>) -> Self

Converts to this type from the input type.