Struct aws_sdk_s3::Client

source ·

pub struct Client { /* private fields */ }

Expand description

Client for Amazon Simple Storage Service

Client for invoking operations on Amazon Simple Storage Service. Each operation on Amazon Simple Storage Service 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_s3::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_s3::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 AbortMultipartUpload operation has a Client::abort_multipart_upload, 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.abort_multipart_upload()
    .bucket("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 aws_sdk_s3::ClientCopy item path

§Constructing a Client

§Using the Client

Implementations§

impl Client

pub fn abort_multipart_upload(&self) -> AbortMultipartUploadFluentBuilder

impl Client

pub fn complete_multipart_upload(&self) -> CompleteMultipartUploadFluentBuilder

impl Client

pub fn copy_object(&self) -> CopyObjectFluentBuilder

impl Client

pub fn create_bucket(&self) -> CreateBucketFluentBuilder

impl Client

pub fn create_multipart_upload(&self) -> CreateMultipartUploadFluentBuilder

impl Client

pub fn create_session(&self) -> CreateSessionFluentBuilder

impl Client

pub fn delete_bucket(&self) -> DeleteBucketFluentBuilder

impl Client

pub fn delete_bucket_analytics_configuration( &self, ) -> DeleteBucketAnalyticsConfigurationFluentBuilder

impl Client

pub fn delete_bucket_cors(&self) -> DeleteBucketCorsFluentBuilder

impl Client

pub fn delete_bucket_encryption(&self) -> DeleteBucketEncryptionFluentBuilder

impl Client

pub fn delete_bucket_intelligent_tiering_configuration( &self, ) -> DeleteBucketIntelligentTieringConfigurationFluentBuilder

impl Client

pub fn delete_bucket_inventory_configuration( &self, ) -> DeleteBucketInventoryConfigurationFluentBuilder

impl Client

pub fn delete_bucket_lifecycle(&self) -> DeleteBucketLifecycleFluentBuilder

impl Client

pub fn delete_bucket_metrics_configuration( &self, ) -> DeleteBucketMetricsConfigurationFluentBuilder

impl Client

pub fn delete_bucket_ownership_controls( &self, ) -> DeleteBucketOwnershipControlsFluentBuilder

impl Client

pub fn delete_bucket_policy(&self) -> DeleteBucketPolicyFluentBuilder

impl Client

pub fn delete_bucket_replication(&self) -> DeleteBucketReplicationFluentBuilder

impl Client

pub fn delete_bucket_tagging(&self) -> DeleteBucketTaggingFluentBuilder

impl Client

pub fn delete_bucket_website(&self) -> DeleteBucketWebsiteFluentBuilder

impl Client

pub fn delete_object(&self) -> DeleteObjectFluentBuilder

impl Client

pub fn delete_object_tagging(&self) -> DeleteObjectTaggingFluentBuilder

impl Client

pub fn delete_objects(&self) -> DeleteObjectsFluentBuilder

impl Client

pub fn delete_public_access_block(&self) -> DeletePublicAccessBlockFluentBuilder

impl Client

pub fn get_bucket_accelerate_configuration( &self, ) -> GetBucketAccelerateConfigurationFluentBuilder

impl Client

pub fn get_bucket_acl(&self) -> GetBucketAclFluentBuilder

impl Client

pub fn get_bucket_analytics_configuration( &self, ) -> GetBucketAnalyticsConfigurationFluentBuilder

impl Client

pub fn get_bucket_cors(&self) -> GetBucketCorsFluentBuilder

impl Client

pub fn get_bucket_encryption(&self) -> GetBucketEncryptionFluentBuilder

impl Client

pub fn get_bucket_intelligent_tiering_configuration( &self, ) -> GetBucketIntelligentTieringConfigurationFluentBuilder

impl Client

pub fn get_bucket_inventory_configuration( &self, ) -> GetBucketInventoryConfigurationFluentBuilder

impl Client

pub fn get_bucket_lifecycle_configuration( &self, ) -> GetBucketLifecycleConfigurationFluentBuilder

impl Client

pub fn get_bucket_location(&self) -> GetBucketLocationFluentBuilder

impl Client

pub fn get_bucket_logging(&self) -> GetBucketLoggingFluentBuilder

impl Client

pub fn get_bucket_metrics_configuration( &self, ) -> GetBucketMetricsConfigurationFluentBuilder

impl Client

pub fn get_bucket_notification_configuration( &self, ) -> GetBucketNotificationConfigurationFluentBuilder

impl Client

pub fn get_bucket_ownership_controls( &self, ) -> GetBucketOwnershipControlsFluentBuilder

impl Client

pub fn get_bucket_policy(&self) -> GetBucketPolicyFluentBuilder

impl Client

pub fn get_bucket_policy_status(&self) -> GetBucketPolicyStatusFluentBuilder

Struct aws_sdk_s3::Client

§Constructing a `Client`

§Using the `Client`