Struct rusoto_s3::S3Client

pub struct S3Client { /* fields omitted */ }

A client for the Amazon S3 API.

Methods

impl S3Client

pub fn new(region: Region) -> S3Client

Creates a client backed by the default tokio event loop.

The client will use the default credentials provider and tls client.

pub fn new_with<P, D>(
    request_dispatcher: D,
    credentials_provider: P,
    region: Region
) -> S3Client where
    P: ProvideAwsCredentials + Send + Sync + 'static,
    P::Future: Send,
    D: DispatchSignedRequest + Send + Sync + 'static,
    D::Future: Send, 

Trait Implementations

impl S3 for S3Client

fn abort_multipart_upload(
    &self,
    input: AbortMultipartUploadRequest
) -> RusotoFuture<AbortMultipartUploadOutput, AbortMultipartUploadError>

Aborts a multipart upload.

To verify that all parts have been removed, so you don't get charged for the part storage, you should call the List Parts operation and ensure the parts list is empty.

fn complete_multipart_upload(
    &self,
    input: CompleteMultipartUploadRequest
) -> RusotoFuture<CompleteMultipartUploadOutput, CompleteMultipartUploadError>

Completes a multipart upload by assembling previously uploaded parts.

fn copy_object(
    &self,
    input: CopyObjectRequest
) -> RusotoFuture<CopyObjectOutput, CopyObjectError>

Creates a copy of an object that is already stored in Amazon S3.

fn create_bucket(
    &self,
    input: CreateBucketRequest
) -> RusotoFuture<CreateBucketOutput, CreateBucketError>

Creates a new bucket.

fn create_multipart_upload(
    &self,
    input: CreateMultipartUploadRequest
) -> RusotoFuture<CreateMultipartUploadOutput, CreateMultipartUploadError>

Initiates a multipart upload and returns an upload ID.

Note: After you initiate multipart upload and upload one or more parts, you must either complete or abort multipart upload in order to stop getting charged for storage of the uploaded parts. Only after you either complete or abort multipart upload, Amazon S3 frees up the parts storage and stops charging you for the parts storage.

fn delete_bucket(
    &self,
    input: DeleteBucketRequest
) -> RusotoFuture<(), DeleteBucketError>

Deletes the bucket. All objects (including all object versions and Delete Markers) in the bucket must be deleted before the bucket itself can be deleted.

fn delete_bucket_analytics_configuration(
    &self,
    input: DeleteBucketAnalyticsConfigurationRequest
) -> RusotoFuture<(), DeleteBucketAnalyticsConfigurationError>

Deletes an analytics configuration for the bucket (specified by the analytics configuration ID).

To use this operation, you must have permissions to perform the s3:PutAnalyticsConfiguration action. The bucket owner has this permission by default. The bucket owner can grant this permission to others.

fn delete_bucket_cors(
    &self,
    input: DeleteBucketCorsRequest
) -> RusotoFuture<(), DeleteBucketCorsError>

Deletes the CORS configuration information set for the bucket.

fn delete_bucket_encryption(
    &self,
    input: DeleteBucketEncryptionRequest
) -> RusotoFuture<(), DeleteBucketEncryptionError>

Deletes the server-side encryption configuration from the bucket.

fn delete_bucket_inventory_configuration(
    &self,
    input: DeleteBucketInventoryConfigurationRequest
) -> RusotoFuture<(), DeleteBucketInventoryConfigurationError>

Deletes an inventory configuration (identified by the inventory ID) from the bucket.

fn delete_bucket_lifecycle(
    &self,
    input: DeleteBucketLifecycleRequest
) -> RusotoFuture<(), DeleteBucketLifecycleError>

Deletes the lifecycle configuration from the bucket.

fn delete_bucket_metrics_configuration(
    &self,
    input: DeleteBucketMetricsConfigurationRequest
) -> RusotoFuture<(), DeleteBucketMetricsConfigurationError>

Deletes a metrics configuration (specified by the metrics configuration ID) from the bucket.

fn delete_bucket_policy(
    &self,
    input: DeleteBucketPolicyRequest
) -> RusotoFuture<(), DeleteBucketPolicyError>

Deletes the policy from the bucket.

fn delete_bucket_replication(
    &self,
    input: DeleteBucketReplicationRequest
) -> RusotoFuture<(), DeleteBucketReplicationError>

Deletes the replication configuration from the bucket. For information about replication configuration, see Cross-Region Replication (CRR) in the Amazon S3 Developer Guide.

fn delete_bucket_tagging(
    &self,
    input: DeleteBucketTaggingRequest
) -> RusotoFuture<(), DeleteBucketTaggingError>

Deletes the tags from the bucket.

fn delete_bucket_website(
    &self,
    input: DeleteBucketWebsiteRequest
) -> RusotoFuture<(), DeleteBucketWebsiteError>

This operation removes the website configuration from the bucket.

fn delete_object(
    &self,
    input: DeleteObjectRequest
) -> RusotoFuture<DeleteObjectOutput, DeleteObjectError>

Removes the null version (if there is one) of an object and inserts a delete marker, which becomes the latest version of the object. If there isn't a null version, Amazon S3 does not remove any objects.

fn delete_object_tagging(
    &self,
    input: DeleteObjectTaggingRequest
) -> RusotoFuture<DeleteObjectTaggingOutput, DeleteObjectTaggingError>

Removes the tag-set from an existing object.

fn delete_objects(
    &self,
    input: DeleteObjectsRequest
) -> RusotoFuture<DeleteObjectsOutput, DeleteObjectsError>

This operation enables you to delete multiple objects from a bucket using a single HTTP request. You may specify up to 1000 keys.

fn delete_public_access_block(
    &self,
    input: DeletePublicAccessBlockRequest
) -> RusotoFuture<(), DeletePublicAccessBlockError>

Removes the PublicAccessBlock configuration from an Amazon S3 bucket.

fn get_bucket_accelerate_configuration(
    &self,
    input: GetBucketAccelerateConfigurationRequest
) -> RusotoFuture<GetBucketAccelerateConfigurationOutput, GetBucketAccelerateConfigurationError>

Returns the accelerate configuration of a bucket.

fn get_bucket_acl(
    &self,
    input: GetBucketAclRequest
) -> RusotoFuture<GetBucketAclOutput, GetBucketAclError>

Gets the access control policy for the bucket.

fn get_bucket_analytics_configuration(
    &self,
    input: GetBucketAnalyticsConfigurationRequest
) -> RusotoFuture<GetBucketAnalyticsConfigurationOutput, GetBucketAnalyticsConfigurationError>

Gets an analytics configuration for the bucket (specified by the analytics configuration ID).

fn get_bucket_cors(
    &self,
    input: GetBucketCorsRequest
) -> RusotoFuture<GetBucketCorsOutput, GetBucketCorsError>

Returns the CORS configuration for the bucket.

fn get_bucket_encryption(
    &self,
    input: GetBucketEncryptionRequest
) -> RusotoFuture<GetBucketEncryptionOutput, GetBucketEncryptionError>

Returns the server-side encryption configuration of a bucket.

fn get_bucket_inventory_configuration(
    &self,
    input: GetBucketInventoryConfigurationRequest
) -> RusotoFuture<GetBucketInventoryConfigurationOutput, GetBucketInventoryConfigurationError>

Returns an inventory configuration (identified by the inventory ID) from the bucket.

fn get_bucket_lifecycle(
    &self,
    input: GetBucketLifecycleRequest
) -> RusotoFuture<GetBucketLifecycleOutput, GetBucketLifecycleError>

No longer used, see the GetBucketLifecycleConfiguration operation.

fn get_bucket_lifecycle_configuration(
    &self,
    input: GetBucketLifecycleConfigurationRequest
) -> RusotoFuture<GetBucketLifecycleConfigurationOutput, GetBucketLifecycleConfigurationError>

Returns the lifecycle configuration information set on the bucket.

fn get_bucket_location(
    &self,
    input: GetBucketLocationRequest
) -> RusotoFuture<GetBucketLocationOutput, GetBucketLocationError>

Returns the region the bucket resides in.

fn get_bucket_logging(
    &self,
    input: GetBucketLoggingRequest
) -> RusotoFuture<GetBucketLoggingOutput, GetBucketLoggingError>

Returns the logging status of a bucket and the permissions users have to view and modify that status. To use GET, you must be the bucket owner.

fn get_bucket_metrics_configuration(
    &self,
    input: GetBucketMetricsConfigurationRequest
) -> RusotoFuture<GetBucketMetricsConfigurationOutput, GetBucketMetricsConfigurationError>

Gets a metrics configuration (specified by the metrics configuration ID) from the bucket.

fn get_bucket_notification(
    &self,
    input: GetBucketNotificationConfigurationRequest
) -> RusotoFuture<NotificationConfigurationDeprecated, GetBucketNotificationError>

No longer used, see the GetBucketNotificationConfiguration operation.

fn get_bucket_notification_configuration(
    &self,
    input: GetBucketNotificationConfigurationRequest
) -> RusotoFuture<NotificationConfiguration, GetBucketNotificationConfigurationError>

Returns the notification configuration of a bucket.

fn get_bucket_policy(
    &self,
    input: GetBucketPolicyRequest
) -> RusotoFuture<GetBucketPolicyOutput, GetBucketPolicyError>

Returns the policy of a specified bucket.

fn get_bucket_policy_status(
    &self,
    input: GetBucketPolicyStatusRequest
) -> RusotoFuture<GetBucketPolicyStatusOutput, GetBucketPolicyStatusError>

Retrieves the policy status for an Amazon S3 bucket, indicating whether the bucket is public.

fn get_bucket_replication(
    &self,
    input: GetBucketReplicationRequest
) -> RusotoFuture<GetBucketReplicationOutput, GetBucketReplicationError>

Returns the replication configuration of a bucket.

It can take a while to propagate the put or delete a replication configuration to all Amazon S3 systems. Therefore, a get request soon after put or delete can return a wrong result.

fn get_bucket_request_payment(
    &self,
    input: GetBucketRequestPaymentRequest
) -> RusotoFuture<GetBucketRequestPaymentOutput, GetBucketRequestPaymentError>

Returns the request payment configuration of a bucket.

fn get_bucket_tagging(
    &self,
    input: GetBucketTaggingRequest
) -> RusotoFuture<GetBucketTaggingOutput, GetBucketTaggingError>

Returns the tag set associated with the bucket.

fn get_bucket_versioning(
    &self,
    input: GetBucketVersioningRequest
) -> RusotoFuture<GetBucketVersioningOutput, GetBucketVersioningError>

Returns the versioning state of a bucket.

fn get_bucket_website(
    &self,
    input: GetBucketWebsiteRequest
) -> RusotoFuture<GetBucketWebsiteOutput, GetBucketWebsiteError>

Returns the website configuration for a bucket.

fn get_object(
    &self,
    input: GetObjectRequest
) -> RusotoFuture<GetObjectOutput, GetObjectError>

Retrieves objects from Amazon S3.

fn get_object_acl(
    &self,
    input: GetObjectAclRequest
) -> RusotoFuture<GetObjectAclOutput, GetObjectAclError>

Returns the access control list (ACL) of an object.

fn get_object_legal_hold(
    &self,
    input: GetObjectLegalHoldRequest
) -> RusotoFuture<GetObjectLegalHoldOutput, GetObjectLegalHoldError>

Gets an object's current Legal Hold status.

fn get_object_lock_configuration(
    &self,
    input: GetObjectLockConfigurationRequest
) -> RusotoFuture<GetObjectLockConfigurationOutput, GetObjectLockConfigurationError>

Gets the object lock configuration for a bucket. The rule specified in the object lock configuration will be applied by default to every new object placed in the specified bucket.

fn get_object_retention(
    &self,
    input: GetObjectRetentionRequest
) -> RusotoFuture<GetObjectRetentionOutput, GetObjectRetentionError>

Retrieves an object's retention settings.

fn get_object_tagging(
    &self,
    input: GetObjectTaggingRequest
) -> RusotoFuture<GetObjectTaggingOutput, GetObjectTaggingError>

Returns the tag-set of an object.

fn get_object_torrent(
    &self,
    input: GetObjectTorrentRequest
) -> RusotoFuture<GetObjectTorrentOutput, GetObjectTorrentError>

Return torrent files from a bucket.

fn get_public_access_block(
    &self,
    input: GetPublicAccessBlockRequest
) -> RusotoFuture<GetPublicAccessBlockOutput, GetPublicAccessBlockError>

Retrieves the PublicAccessBlock configuration for an Amazon S3 bucket.

fn head_bucket(
    &self,
    input: HeadBucketRequest
) -> RusotoFuture<(), HeadBucketError>

This operation is useful to determine if a bucket exists and you have permission to access it.

fn head_object(
    &self,
    input: HeadObjectRequest
) -> RusotoFuture<HeadObjectOutput, HeadObjectError>

The HEAD operation retrieves metadata from an object without returning the object itself. This operation is useful if you're only interested in an object's metadata. To use HEAD, you must have READ access to the object.

fn list_bucket_analytics_configurations(
    &self,
    input: ListBucketAnalyticsConfigurationsRequest
) -> RusotoFuture<ListBucketAnalyticsConfigurationsOutput, ListBucketAnalyticsConfigurationsError>

Lists the analytics configurations for the bucket.

fn list_bucket_inventory_configurations(
    &self,
    input: ListBucketInventoryConfigurationsRequest
) -> RusotoFuture<ListBucketInventoryConfigurationsOutput, ListBucketInventoryConfigurationsError>

Returns a list of inventory configurations for the bucket.

fn list_bucket_metrics_configurations(
    &self,
    input: ListBucketMetricsConfigurationsRequest
) -> RusotoFuture<ListBucketMetricsConfigurationsOutput, ListBucketMetricsConfigurationsError>

Lists the metrics configurations for the bucket.

fn list_buckets(&self) -> RusotoFuture<ListBucketsOutput, ListBucketsError>

Returns a list of all buckets owned by the authenticated sender of the request.

fn list_multipart_uploads(
    &self,
    input: ListMultipartUploadsRequest
) -> RusotoFuture<ListMultipartUploadsOutput, ListMultipartUploadsError>

This operation lists in-progress multipart uploads.

fn list_object_versions(
    &self,
    input: ListObjectVersionsRequest
) -> RusotoFuture<ListObjectVersionsOutput, ListObjectVersionsError>

Returns metadata about all of the versions of objects in a bucket.

fn list_objects(
    &self,
    input: ListObjectsRequest
) -> RusotoFuture<ListObjectsOutput, ListObjectsError>

Returns some or all (up to 1000) of the objects in a bucket. You can use the request parameters as selection criteria to return a subset of the objects in a bucket.

fn list_objects_v2(
    &self,
    input: ListObjectsV2Request
) -> RusotoFuture<ListObjectsV2Output, ListObjectsV2Error>

Returns some or all (up to 1000) of the objects in a bucket. You can use the request parameters as selection criteria to return a subset of the objects in a bucket. Note: ListObjectsV2 is the revised List Objects API and we recommend you use this revised API for new application development.

fn list_parts(
    &self,
    input: ListPartsRequest
) -> RusotoFuture<ListPartsOutput, ListPartsError>

Lists the parts that have been uploaded for a specific multipart upload.

fn put_bucket_accelerate_configuration(
    &self,
    input: PutBucketAccelerateConfigurationRequest
) -> RusotoFuture<(), PutBucketAccelerateConfigurationError>

Sets the accelerate configuration of an existing bucket.

fn put_bucket_acl(
    &self,
    input: PutBucketAclRequest
) -> RusotoFuture<(), PutBucketAclError>

Sets the permissions on a bucket using access control lists (ACL).

fn put_bucket_analytics_configuration(
    &self,
    input: PutBucketAnalyticsConfigurationRequest
) -> RusotoFuture<(), PutBucketAnalyticsConfigurationError>

Sets an analytics configuration for the bucket (specified by the analytics configuration ID).

fn put_bucket_cors(
    &self,
    input: PutBucketCorsRequest
) -> RusotoFuture<(), PutBucketCorsError>

Sets the CORS configuration for a bucket.

fn put_bucket_encryption(
    &self,
    input: PutBucketEncryptionRequest
) -> RusotoFuture<(), PutBucketEncryptionError>

Creates a new server-side encryption configuration (or replaces an existing one, if present).

fn put_bucket_inventory_configuration(
    &self,
    input: PutBucketInventoryConfigurationRequest
) -> RusotoFuture<(), PutBucketInventoryConfigurationError>

Adds an inventory configuration (identified by the inventory ID) from the bucket.

fn put_bucket_lifecycle(
    &self,
    input: PutBucketLifecycleRequest
) -> RusotoFuture<(), PutBucketLifecycleError>

No longer used, see the PutBucketLifecycleConfiguration operation.

fn put_bucket_lifecycle_configuration(
    &self,
    input: PutBucketLifecycleConfigurationRequest
) -> RusotoFuture<(), PutBucketLifecycleConfigurationError>

Sets lifecycle configuration for your bucket. If a lifecycle configuration exists, it replaces it.

fn put_bucket_logging(
    &self,
    input: PutBucketLoggingRequest
) -> RusotoFuture<(), PutBucketLoggingError>

Set the logging parameters for a bucket and to specify permissions for who can view and modify the logging parameters. To set the logging status of a bucket, you must be the bucket owner.

fn put_bucket_metrics_configuration(
    &self,
    input: PutBucketMetricsConfigurationRequest
) -> RusotoFuture<(), PutBucketMetricsConfigurationError>

Sets a metrics configuration (specified by the metrics configuration ID) for the bucket.

fn put_bucket_notification(
    &self,
    input: PutBucketNotificationRequest
) -> RusotoFuture<(), PutBucketNotificationError>

No longer used, see the PutBucketNotificationConfiguration operation.

fn put_bucket_notification_configuration(
    &self,
    input: PutBucketNotificationConfigurationRequest
) -> RusotoFuture<(), PutBucketNotificationConfigurationError>

Enables notifications of specified events for a bucket.

fn put_bucket_policy(
    &self,
    input: PutBucketPolicyRequest
) -> RusotoFuture<(), PutBucketPolicyError>

Applies an Amazon S3 bucket policy to an Amazon S3 bucket.

fn put_bucket_replication(
    &self,
    input: PutBucketReplicationRequest
) -> RusotoFuture<(), PutBucketReplicationError>

Creates a replication configuration or replaces an existing one. For more information, see Cross-Region Replication (CRR) in the Amazon S3 Developer Guide.

fn put_bucket_request_payment(
    &self,
    input: PutBucketRequestPaymentRequest
) -> RusotoFuture<(), PutBucketRequestPaymentError>

Sets the request payment configuration for a bucket. By default, the bucket owner pays for downloads from the bucket. This configuration parameter enables the bucket owner (only) to specify that the person requesting the download will be charged for the download. Documentation on requester pays buckets can be found at http://docs.aws.amazon.com/AmazonS3/latest/dev/RequesterPaysBuckets.html

fn put_bucket_tagging(
    &self,
    input: PutBucketTaggingRequest
) -> RusotoFuture<(), PutBucketTaggingError>

Sets the tags for a bucket.

fn put_bucket_versioning(
    &self,
    input: PutBucketVersioningRequest
) -> RusotoFuture<(), PutBucketVersioningError>

Sets the versioning state of an existing bucket. To set the versioning state, you must be the bucket owner.

fn put_bucket_website(
    &self,
    input: PutBucketWebsiteRequest
) -> RusotoFuture<(), PutBucketWebsiteError>

Set the website configuration for a bucket.

fn put_object(
    &self,
    input: PutObjectRequest
) -> RusotoFuture<PutObjectOutput, PutObjectError>

Adds an object to a bucket.

fn put_object_acl(
    &self,
    input: PutObjectAclRequest
) -> RusotoFuture<PutObjectAclOutput, PutObjectAclError>

uses the acl subresource to set the access control list (ACL) permissions for an object that already exists in a bucket

fn put_object_legal_hold(
    &self,
    input: PutObjectLegalHoldRequest
) -> RusotoFuture<PutObjectLegalHoldOutput, PutObjectLegalHoldError>

Applies a Legal Hold configuration to the specified object.

fn put_object_lock_configuration(
    &self,
    input: PutObjectLockConfigurationRequest
) -> RusotoFuture<PutObjectLockConfigurationOutput, PutObjectLockConfigurationError>

Places an object lock configuration on the specified bucket. The rule specified in the object lock configuration will be applied by default to every new object placed in the specified bucket.

fn put_object_retention(
    &self,
    input: PutObjectRetentionRequest
) -> RusotoFuture<PutObjectRetentionOutput, PutObjectRetentionError>

Places an Object Retention configuration on an object.

fn put_object_tagging(
    &self,
    input: PutObjectTaggingRequest
) -> RusotoFuture<PutObjectTaggingOutput, PutObjectTaggingError>

Sets the supplied tag-set to an object that already exists in a bucket

fn put_public_access_block(
    &self,
    input: PutPublicAccessBlockRequest
) -> RusotoFuture<(), PutPublicAccessBlockError>

Creates or modifies the PublicAccessBlock configuration for an Amazon S3 bucket.

fn restore_object(
    &self,
    input: RestoreObjectRequest
) -> RusotoFuture<RestoreObjectOutput, RestoreObjectError>

Restores an archived copy of an object back into Amazon S3

fn select_object_content(
    &self,
    input: SelectObjectContentRequest
) -> RusotoFuture<SelectObjectContentOutput, SelectObjectContentError>

This operation filters the contents of an Amazon S3 object based on a simple Structured Query Language (SQL) statement. In the request, along with the SQL expression, you must also specify a data serialization format (JSON or CSV) of the object. Amazon S3 uses this to parse object data into records, and returns only records that match the specified SQL expression. You must also specify the data serialization format for the response.

fn upload_part(
    &self,
    input: UploadPartRequest
) -> RusotoFuture<UploadPartOutput, UploadPartError>

Uploads a part in a multipart upload.

Note: After you initiate multipart upload and upload one or more parts, you must either complete or abort multipart upload in order to stop getting charged for storage of the uploaded parts. Only after you either complete or abort multipart upload, Amazon S3 frees up the parts storage and stops charging you for the parts storage.

fn upload_part_copy(
    &self,
    input: UploadPartCopyRequest
) -> RusotoFuture<UploadPartCopyOutput, UploadPartCopyError>

Uploads a part by copying data from an existing object as data source.

impl Clone for S3Client

fn clone(&self) -> S3Client

Returns a copy of the value.

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

Performs copy-assignment from source.