Struct bonsaidb::keystorage::s3::aws_sdk_s3::client::Client

pub struct Client { /* private fields */ }

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 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.

Implementations

impl Client

pub fn from_conf(conf: Config) -> Client

Creates a new client from the service Config.

Panics

This method will panic if the conf has retry or timeouts enabled without a sleep_impl. If you experience this panic, it can be fixed by setting the sleep_impl, or by disabling retries and timeouts.

pub fn config(&self) -> &Config

Returns the client’s configuration.

impl Client

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

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.

impl Client

pub fn abort_multipart_upload(&self) -> AbortMultipartUploadFluentBuilder

Constructs a fluent builder for the AbortMultipartUpload operation.

• The fluent builder is configurable:
  • bucket(impl Into<String>) / set_bucket(Option<String>):

    The bucket name to which the upload was taking place.

    When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using access points in the Amazon S3 User Guide.

    When you use this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When you use this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts access point ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see What is S3 on Outposts? in the Amazon S3 User Guide.

  • key(impl Into<String>) / set_key(Option<String>):

    Key of the object for which the multipart upload was initiated.

  • upload_id(impl Into<String>) / set_upload_id(Option<String>):

    Upload ID that identifies the multipart upload.

  • request_payer(RequestPayer) / set_request_payer(Option<RequestPayer>):

    Confirms that the requester knows that they will be charged for the request. Bucket owners need not specify this parameter in their requests. If either the source or destination Amazon S3 bucket has Requester Pays enabled, the requester will pay for corresponding charges to copy the object. For information about downloading objects from Requester Pays buckets, see Downloading Objects in Requester Pays Buckets in the Amazon S3 User Guide.

  • expected_bucket_owner(impl Into<String>) / set_expected_bucket_owner(Option<String>):

    The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code 403 Forbidden (access denied).

• On success, responds with AbortMultipartUploadOutput with field(s):
  • request_charged(Option<RequestCharged>):

    If present, indicates that the requester was successfully charged for the request.

• On failure, responds with SdkError<AbortMultipartUploadError>

impl Client

pub fn complete_multipart_upload(&self) -> CompleteMultipartUploadFluentBuilder

Constructs a fluent builder for the CompleteMultipartUpload operation.

• The fluent builder is configurable:
  • bucket(impl Into<String>) / set_bucket(Option<String>):

    Name of the bucket to which the multipart upload was initiated.

    When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using access points in the Amazon S3 User Guide.

    When you use this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When you use this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts access point ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see What is S3 on Outposts? in the Amazon S3 User Guide.

  • key(impl Into<String>) / set_key(Option<String>):

    Object key for which the multipart upload was initiated.

  • multipart_upload(CompletedMultipartUpload) / set_multipart_upload(Option<CompletedMultipartUpload>):

    The container for the multipart upload request information.

  • upload_id(impl Into<String>) / set_upload_id(Option<String>):

    ID for the initiated multipart upload.

  • checksum_crc32(impl Into<String>) / set_checksum_crc32(Option<String>):

    This header can be used as a data integrity check to verify that the data received is the same data that was originally sent. This header specifies the base64-encoded, 32-bit CRC32 checksum of the object. For more information, see Checking object integrity in the Amazon S3 User Guide.

  • checksum_crc32_c(impl Into<String>) / set_checksum_crc32_c(Option<String>):

    This header can be used as a data integrity check to verify that the data received is the same data that was originally sent. This header specifies the base64-encoded, 32-bit CRC32C checksum of the object. For more information, see Checking object integrity in the Amazon S3 User Guide.

  • checksum_sha1(impl Into<String>) / set_checksum_sha1(Option<String>):

    This header can be used as a data integrity check to verify that the data received is the same data that was originally sent. This header specifies the base64-encoded, 160-bit SHA-1 digest of the object. For more information, see Checking object integrity in the Amazon S3 User Guide.

  • checksum_sha256(impl Into<String>) / set_checksum_sha256(Option<String>):

    This header can be used as a data integrity check to verify that the data received is the same data that was originally sent. This header specifies the base64-encoded, 256-bit SHA-256 digest of the object. For more information, see Checking object integrity in the Amazon S3 User Guide.

  • request_payer(RequestPayer) / set_request_payer(Option<RequestPayer>):

    Confirms that the requester knows that they will be charged for the request. Bucket owners need not specify this parameter in their requests. If either the source or destination Amazon S3 bucket has Requester Pays enabled, the requester will pay for corresponding charges to copy the object. For information about downloading objects from Requester Pays buckets, see Downloading Objects in Requester Pays Buckets in the Amazon S3 User Guide.

  • expected_bucket_owner(impl Into<String>) / set_expected_bucket_owner(Option<String>):

    The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code 403 Forbidden (access denied).

  • sse_customer_algorithm(impl Into<String>) / set_sse_customer_algorithm(Option<String>):

    The server-side encryption (SSE) algorithm used to encrypt the object. This parameter is needed only when the object was created using a checksum algorithm. For more information, see Protecting data using SSE-C keys in the Amazon S3 User Guide.

  • sse_customer_key(impl Into<String>) / set_sse_customer_key(Option<String>):

    The server-side encryption (SSE) customer managed key. This parameter is needed only when the object was created using a checksum algorithm. For more information, see Protecting data using SSE-C keys in the Amazon S3 User Guide.

  • sse_customer_key_md5(impl Into<String>) / set_sse_customer_key_md5(Option<String>):

    The MD5 server-side encryption (SSE) customer managed key. This parameter is needed only when the object was created using a checksum algorithm. For more information, see Protecting data using SSE-C keys in the Amazon S3 User Guide.

• On success, responds with CompleteMultipartUploadOutput with field(s):
  • location(Option<String>):

    The URI that identifies the newly created object.

  • bucket(Option<String>):

    The name of the bucket that contains the newly created object. Does not return the access point ARN or access point alias if used.

    When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using access points in the Amazon S3 User Guide.

    When you use this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When you use this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts access point ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see What is S3 on Outposts? in the Amazon S3 User Guide.

  • key(Option<String>):

    The object key of the newly created object.

  • expiration(Option<String>):

    If the object expiration is configured, this will contain the expiration date (expiry-date) and rule ID (rule-id). The value of rule-id is URL-encoded.

  • e_tag(Option<String>):

    Entity tag that identifies the newly created object’s data. Objects with different object data will have different entity tags. The entity tag is an opaque string. The entity tag may or may not be an MD5 digest of the object data. If the entity tag is not an MD5 digest of the object data, it will contain one or more nonhexadecimal characters and/or will consist of less than 32 or more than 32 hexadecimal digits. For more information about how the entity tag is calculated, see Checking object integrity in the Amazon S3 User Guide.

  • checksum_crc32(Option<String>):

    The base64-encoded, 32-bit CRC32 checksum of the object. This will only be present if it was uploaded with the object. With multipart uploads, this may not be a checksum value of the object. For more information about how checksums are calculated with multipart uploads, see Checking object integrity in the Amazon S3 User Guide.

  • checksum_crc32_c(Option<String>):

    The base64-encoded, 32-bit CRC32C checksum of the object. This will only be present if it was uploaded with the object. With multipart uploads, this may not be a checksum value of the object. For more information about how checksums are calculated with multipart uploads, see Checking object integrity in the Amazon S3 User Guide.

  • checksum_sha1(Option<String>):

    The base64-encoded, 160-bit SHA-1 digest of the object. This will only be present if it was uploaded with the object. With multipart uploads, this may not be a checksum value of the object. For more information about how checksums are calculated with multipart uploads, see Checking object integrity in the Amazon S3 User Guide.

  • checksum_sha256(Option<String>):

    The base64-encoded, 256-bit SHA-256 digest of the object. This will only be present if it was uploaded with the object. With multipart uploads, this may not be a checksum value of the object. For more information about how checksums are calculated with multipart uploads, see Checking object integrity in the Amazon S3 User Guide.

  • server_side_encryption(Option<ServerSideEncryption>):

    The server-side encryption algorithm used when storing this object in Amazon S3 (for example, AES256, aws:kms).

  • version_id(Option<String>):

    Version ID of the newly created object, in case the bucket has versioning turned on.

  • ssekms_key_id(Option<String>):

    If present, specifies the ID of the Key Management Service (KMS) symmetric encryption customer managed key that was used for the object.

  • bucket_key_enabled(bool):

    Indicates whether the multipart upload uses an S3 Bucket Key for server-side encryption with Key Management Service (KMS) keys (SSE-KMS).

  • request_charged(Option<RequestCharged>):

    If present, indicates that the requester was successfully charged for the request.

• On failure, responds with SdkError<CompleteMultipartUploadError>

impl Client

pub fn copy_object(&self) -> CopyObjectFluentBuilder

Constructs a fluent builder for the CopyObject operation.

• The fluent builder is configurable:
  • acl(ObjectCannedAcl) / set_acl(Option<ObjectCannedAcl>):

    The canned ACL to apply to the object.

    This action is not supported by Amazon S3 on Outposts.

  • bucket(impl Into<String>) / set_bucket(Option<String>):

    The name of the destination bucket.

    When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using access points in the Amazon S3 User Guide.

    When you use this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When you use this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts access point ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see What is S3 on Outposts? in the Amazon S3 User Guide.

  • cache_control(impl Into<String>) / set_cache_control(Option<String>):

    Specifies caching behavior along the request/reply chain.

  • checksum_algorithm(ChecksumAlgorithm) / set_checksum_algorithm(Option<ChecksumAlgorithm>):

    Indicates the algorithm you want Amazon S3 to use to create the checksum for the object. For more information, see Checking object integrity in the Amazon S3 User Guide.

  • content_disposition(impl Into<String>) / set_content_disposition(Option<String>):

    Specifies presentational information for the object.

  • content_encoding(impl Into<String>) / set_content_encoding(Option<String>):

    Specifies what content encodings have been applied to the object and thus what decoding mechanisms must be applied to obtain the media-type referenced by the Content-Type header field.

  • content_language(impl Into<String>) / set_content_language(Option<String>):

    The language the content is in.

  • content_type(impl Into<String>) / set_content_type(Option<String>):

    A standard MIME type describing the format of the object data.

  • copy_source(impl Into<String>) / set_copy_source(Option<String>):

    Specifies the source object for the copy operation. You specify the value in one of two formats, depending on whether you want to access the source object through an access point:

    • For objects not accessed through an access point, specify the name of the source bucket and the key of the source object, separated by a slash (/). For example, to copy the object reports/january.pdf from the bucket awsexamplebucket, use awsexamplebucket/reports/january.pdf. The value must be URL-encoded.

    • For objects accessed through access points, specify the Amazon Resource Name (ARN) of the object as accessed through the access point, in the format arn:aws:s3: : :accesspoint/ /object/ . For example, to copy the object reports/january.pdf through access point my-access-point owned by account 123456789012 in Region us-west-2, use the URL encoding of arn:aws:s3:us-west-2:123456789012:accesspoint/my-access-point/object/reports/january.pdf. The value must be URL encoded.

      Amazon S3 supports copy operations using access points only when the source and destination buckets are in the same Amazon Web Services Region.

      Alternatively, for objects accessed through Amazon S3 on Outposts, specify the ARN of the object as accessed in the format arn:aws:s3-outposts: : :outpost/ /object/ . For example, to copy the object reports/january.pdf through outpost my-outpost owned by account 123456789012 in Region us-west-2, use the URL encoding of arn:aws:s3-outposts:us-west-2:123456789012:outpost/my-outpost/object/reports/january.pdf. The value must be URL-encoded.

    To copy a specific version of an object, append ?versionId= to the value (for example, awsexamplebucket/reports/january.pdf?versionId=QUpfdndhfd8438MNFDN93jdnJFkdmqnh893). If you don’t specify a version ID, Amazon S3 copies the latest version of the source object.

  • copy_source_if_match(impl Into<String>) / set_copy_source_if_match(Option<String>):

    Copies the object if its entity tag (ETag) matches the specified tag.

  • copy_source_if_modified_since(DateTime) / set_copy_source_if_modified_since(Option<DateTime>):

    Copies the object if it has been modified since the specified time.

  • copy_source_if_none_match(impl Into<String>) / set_copy_source_if_none_match(Option<String>):

    Copies the object if its entity tag (ETag) is different than the specified ETag.

  • copy_source_if_unmodified_since(DateTime) / set_copy_source_if_unmodified_since(Option<DateTime>):

    Copies the object if it hasn’t been modified since the specified time.

  • expires(DateTime) / set_expires(Option<DateTime>):

    The date and time at which the object is no longer cacheable.

  • grant_full_control(impl Into<String>) / set_grant_full_control(Option<String>):

    Gives the grantee READ, READ_ACP, and WRITE_ACP permissions on the object.

    This action is not supported by Amazon S3 on Outposts.

  • grant_read(impl Into<String>) / set_grant_read(Option<String>):

    Allows grantee to read the object data and its metadata.

    This action is not supported by Amazon S3 on Outposts.

  • grant_read_acp(impl Into<String>) / set_grant_read_acp(Option<String>):

    Allows grantee to read the object ACL.

    This action is not supported by Amazon S3 on Outposts.

  • grant_write_acp(impl Into<String>) / set_grant_write_acp(Option<String>):

    Allows grantee to write the ACL for the applicable object.

    This action is not supported by Amazon S3 on Outposts.

  • key(impl Into<String>) / set_key(Option<String>):

    The key of the destination object.

  • metadata(impl Into<String>, impl Into<String>) / set_metadata(Option<HashMap<String, String>>):

    A map of metadata to store with the object in S3.

  • metadata_directive(MetadataDirective) / set_metadata_directive(Option<MetadataDirective>):

    Specifies whether the metadata is copied from the source object or replaced with metadata provided in the request.

  • tagging_directive(TaggingDirective) / set_tagging_directive(Option<TaggingDirective>):

    Specifies whether the object tag-set are copied from the source object or replaced with tag-set provided in the request.

  • server_side_encryption(ServerSideEncryption) / set_server_side_encryption(Option<ServerSideEncryption>):

    The server-side encryption algorithm used when storing this object in Amazon S3 (for example, AES256, aws:kms, aws:kms:dsse).

  • storage_class(StorageClass) / set_storage_class(Option<StorageClass>):

    If the x-amz-storage-class header is not used, the copied object will be stored in the STANDARD Storage Class by default. The STANDARD storage class provides high durability and high availability. Depending on performance needs, you can specify a different Storage Class. Amazon S3 on Outposts only uses the OUTPOSTS Storage Class. For more information, see Storage Classes in the Amazon S3 User Guide.

  • website_redirect_location(impl Into<String>) / set_website_redirect_location(Option<String>):

    If the bucket is configured as a website, redirects requests for this object to another object in the same bucket or to an external URL. Amazon S3 stores the value of this header in the object metadata. This value is unique to each object and is not copied when using the x-amz-metadata-directive header. Instead, you may opt to provide this header in combination with the directive.

  • sse_customer_algorithm(impl Into<String>) / set_sse_customer_algorithm(Option<String>):

    Specifies the algorithm to use to when encrypting the object (for example, AES256).

  • sse_customer_key(impl Into<String>) / set_sse_customer_key(Option<String>):

    Specifies the customer-provided encryption key for Amazon S3 to use in encrypting data. This value is used to store the object and then it is discarded; Amazon S3 does not store the encryption key. The key must be appropriate for use with the algorithm specified in the x-amz-server-side-encryption-customer-algorithm header.

  • sse_customer_key_md5(impl Into<String>) / set_sse_customer_key_md5(Option<String>):

    Specifies the 128-bit MD5 digest of the encryption key according to RFC 1321. Amazon S3 uses this header for a message integrity check to ensure that the encryption key was transmitted without error.

  • ssekms_key_id(impl Into<String>) / set_ssekms_key_id(Option<String>):

    Specifies the KMS ID (Key ID, Key ARN, or Key Alias) to use for object encryption. All GET and PUT requests for an object protected by KMS will fail if they’re not made via SSL or using SigV4. For information about configuring any of the officially supported Amazon Web Services SDKs and Amazon Web Services CLI, see Specifying the Signature Version in Request Authentication in the Amazon S3 User Guide.

  • ssekms_encryption_context(impl Into<String>) / set_ssekms_encryption_context(Option<String>):

    Specifies the Amazon Web Services KMS Encryption Context to use for object encryption. The value of this header is a base64-encoded UTF-8 string holding JSON with the encryption context key-value pairs.

  • bucket_key_enabled(bool) / set_bucket_key_enabled(Option<bool>):

    Specifies whether Amazon S3 should use an S3 Bucket Key for object encryption with server-side encryption using Key Management Service (KMS) keys (SSE-KMS). Setting this header to true causes Amazon S3 to use an S3 Bucket Key for object encryption with SSE-KMS.

    Specifying this header with a COPY action doesn’t affect bucket-level settings for S3 Bucket Key.

  • copy_source_sse_customer_algorithm(impl Into<String>) / set_copy_source_sse_customer_algorithm(Option<String>):

    Specifies the algorithm to use when decrypting the source object (for example, AES256).

  • copy_source_sse_customer_key(impl Into<String>) / set_copy_source_sse_customer_key(Option<String>):

    Specifies the customer-provided encryption key for Amazon S3 to use to decrypt the source object. The encryption key provided in this header must be one that was used when the source object was created.

  • copy_source_sse_customer_key_md5(impl Into<String>) / set_copy_source_sse_customer_key_md5(Option<String>):

    Specifies the 128-bit MD5 digest of the encryption key according to RFC 1321. Amazon S3 uses this header for a message integrity check to ensure that the encryption key was transmitted without error.

  • request_payer(RequestPayer) / set_request_payer(Option<RequestPayer>):

    Confirms that the requester knows that they will be charged for the request. Bucket owners need not specify this parameter in their requests. If either the source or destination Amazon S3 bucket has Requester Pays enabled, the requester will pay for corresponding charges to copy the object. For information about downloading objects from Requester Pays buckets, see Downloading Objects in Requester Pays Buckets in the Amazon S3 User Guide.

  • tagging(impl Into<String>) / set_tagging(Option<String>):

    The tag-set for the object destination object this value must be used in conjunction with the TaggingDirective. The tag-set must be encoded as URL Query parameters.

  • object_lock_mode(ObjectLockMode) / set_object_lock_mode(Option<ObjectLockMode>):

    The Object Lock mode that you want to apply to the copied object.

  • object_lock_retain_until_date(DateTime) / set_object_lock_retain_until_date(Option<DateTime>):

    The date and time when you want the copied object’s Object Lock to expire.

  • object_lock_legal_hold_status(ObjectLockLegalHoldStatus) / set_object_lock_legal_hold_status(Option<ObjectLockLegalHoldStatus>):

    Specifies whether you want to apply a legal hold to the copied object.

  • expected_bucket_owner(impl Into<String>) / set_expected_bucket_owner(Option<String>):

    The account ID of the expected destination bucket owner. If the destination bucket is owned by a different account, the request fails with the HTTP status code 403 Forbidden (access denied).

  • expected_source_bucket_owner(impl Into<String>) / set_expected_source_bucket_owner(Option<String>):

    The account ID of the expected source bucket owner. If the source bucket is owned by a different account, the request fails with the HTTP status code 403 Forbidden (access denied).

• On success, responds with CopyObjectOutput with field(s):
  • copy_object_result(Option<CopyObjectResult>):

    Container for all response elements.

  • expiration(Option<String>):

    If the object expiration is configured, the response includes this header.

  • copy_source_version_id(Option<String>):

    Version of the copied object in the destination bucket.

  • version_id(Option<String>):

    Version ID of the newly created copy.

  • server_side_encryption(Option<ServerSideEncryption>):

    The server-side encryption algorithm used when storing this object in Amazon S3 (for example, AES256, aws:kms, aws:kms:dsse).

  • sse_customer_algorithm(Option<String>):

    If server-side encryption with a customer-provided encryption key was requested, the response will include this header confirming the encryption algorithm used.

  • sse_customer_key_md5(Option<String>):

    If server-side encryption with a customer-provided encryption key was requested, the response will include this header to provide round-trip message integrity verification of the customer-provided encryption key.

  • ssekms_key_id(Option<String>):

    If present, specifies the ID of the Key Management Service (KMS) symmetric encryption customer managed key that was used for the object.

  • ssekms_encryption_context(Option<String>):

    If present, specifies the Amazon Web Services KMS Encryption Context to use for object encryption. The value of this header is a base64-encoded UTF-8 string holding JSON with the encryption context key-value pairs.

  • bucket_key_enabled(bool):

    Indicates whether the copied object uses an S3 Bucket Key for server-side encryption with Key Management Service (KMS) keys (SSE-KMS).

  • request_charged(Option<RequestCharged>):

    If present, indicates that the requester was successfully charged for the request.

• On failure, responds with SdkError<CopyObjectError>

impl Client

pub fn create_bucket(&self) -> CreateBucketFluentBuilder

Constructs a fluent builder for the CreateBucket operation.

• The fluent builder is configurable:
  • acl(BucketCannedAcl) / set_acl(Option<BucketCannedAcl>):

    The canned ACL to apply to the bucket.

  • bucket(impl Into<String>) / set_bucket(Option<String>):

    The name of the bucket to create.

  • create_bucket_configuration(CreateBucketConfiguration) / set_create_bucket_configuration(Option<CreateBucketConfiguration>):

    The configuration information for the bucket.

  • grant_full_control(impl Into<String>) / set_grant_full_control(Option<String>):

    Allows grantee the read, write, read ACP, and write ACP permissions on the bucket.

  • grant_read(impl Into<String>) / set_grant_read(Option<String>):

    Allows grantee to list the objects in the bucket.

  • grant_read_acp(impl Into<String>) / set_grant_read_acp(Option<String>):

    Allows grantee to read the bucket ACL.

  • grant_write(impl Into<String>) / set_grant_write(Option<String>):

    Allows grantee to create new objects in the bucket.

    For the bucket and object owners of existing objects, also allows deletions and overwrites of those objects.

  • grant_write_acp(impl Into<String>) / set_grant_write_acp(Option<String>):

    Allows grantee to write the ACL for the applicable bucket.

  • object_lock_enabled_for_bucket(bool) / set_object_lock_enabled_for_bucket(Option<bool>):

    Specifies whether you want S3 Object Lock to be enabled for the new bucket.

  • object_ownership(ObjectOwnership) / set_object_ownership(Option<ObjectOwnership>):

    The container element for object ownership for a bucket’s ownership controls.

    BucketOwnerPreferred - Objects uploaded to the bucket change ownership to the bucket owner if the objects are uploaded with the bucket-owner-full-control canned ACL.

    ObjectWriter - The uploading account will own the object if the object is uploaded with the bucket-owner-full-control canned ACL.

    BucketOwnerEnforced - Access control lists (ACLs) are disabled and no longer affect permissions. The bucket owner automatically owns and has full control over every object in the bucket. The bucket only accepts PUT requests that don’t specify an ACL or bucket owner full control ACLs, such as the bucket-owner-full-control canned ACL or an equivalent form of this ACL expressed in the XML format.

• On success, responds with CreateBucketOutput with field(s):
  • location(Option<String>):

    A forward slash followed by the name of the bucket.

• On failure, responds with SdkError<CreateBucketError>

impl Client

pub fn create_multipart_upload(&self) -> CreateMultipartUploadFluentBuilder

Constructs a fluent builder for the CreateMultipartUpload operation.

• The fluent builder is configurable:
  • acl(ObjectCannedAcl) / set_acl(Option<ObjectCannedAcl>):

    The canned ACL to apply to the object.

    This action is not supported by Amazon S3 on Outposts.

  • bucket(impl Into<String>) / set_bucket(Option<String>):

    The name of the bucket to which to initiate the upload

    When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using access points in the Amazon S3 User Guide.

    When you use this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When you use this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts access point ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see What is S3 on Outposts? in the Amazon S3 User Guide.

  • cache_control(impl Into<String>) / set_cache_control(Option<String>):

    Specifies caching behavior along the request/reply chain.

  • content_disposition(impl Into<String>) / set_content_disposition(Option<String>):

    Specifies presentational information for the object.

  • content_encoding(impl Into<String>) / set_content_encoding(Option<String>):

    Specifies what content encodings have been applied to the object and thus what decoding mechanisms must be applied to obtain the media-type referenced by the Content-Type header field.

  • content_language(impl Into<String>) / set_content_language(Option<String>):

    The language the content is in.

  • content_type(impl Into<String>) / set_content_type(Option<String>):

    A standard MIME type describing the format of the object data.

  • expires(DateTime) / set_expires(Option<DateTime>):

    The date and time at which the object is no longer cacheable.

  • grant_full_control(impl Into<String>) / set_grant_full_control(Option<String>):

    Gives the grantee READ, READ_ACP, and WRITE_ACP permissions on the object.

    This action is not supported by Amazon S3 on Outposts.

  • grant_read(impl Into<String>) / set_grant_read(Option<String>):

    Allows grantee to read the object data and its metadata.

    This action is not supported by Amazon S3 on Outposts.

  • grant_read_acp(impl Into<String>) / set_grant_read_acp(Option<String>):

    Allows grantee to read the object ACL.

    This action is not supported by Amazon S3 on Outposts.

  • grant_write_acp(impl Into<String>) / set_grant_write_acp(Option<String>):

    Allows grantee to write the ACL for the applicable object.

    This action is not supported by Amazon S3 on Outposts.

  • key(impl Into<String>) / set_key(Option<String>):

    Object key for which the multipart upload is to be initiated.

  • metadata(impl Into<String>, impl Into<String>) / set_metadata(Option<HashMap<String, String>>):

    A map of metadata to store with the object in S3.

  • server_side_encryption(ServerSideEncryption) / set_server_side_encryption(Option<ServerSideEncryption>):

    The server-side encryption algorithm used when storing this object in Amazon S3 (for example, AES256, aws:kms).

  • storage_class(StorageClass) / set_storage_class(Option<StorageClass>):

    By default, Amazon S3 uses the STANDARD Storage Class to store newly created objects. The STANDARD storage class provides high durability and high availability. Depending on performance needs, you can specify a different Storage Class. Amazon S3 on Outposts only uses the OUTPOSTS Storage Class. For more information, see Storage Classes in the Amazon S3 User Guide.

  • website_redirect_location(impl Into<String>) / set_website_redirect_location(Option<String>):

    If the bucket is configured as a website, redirects requests for this object to another object in the same bucket or to an external URL. Amazon S3 stores the value of this header in the object metadata.

  • sse_customer_algorithm(impl Into<String>) / set_sse_customer_algorithm(Option<String>):

    Specifies the algorithm to use to when encrypting the object (for example, AES256).

  • sse_customer_key(impl Into<String>) / set_sse_customer_key(Option<String>):

    Specifies the customer-provided encryption key for Amazon S3 to use in encrypting data. This value is used to store the object and then it is discarded; Amazon S3 does not store the encryption key. The key must be appropriate for use with the algorithm specified in the x-amz-server-side-encryption-customer-algorithm header.

  • sse_customer_key_md5(impl Into<String>) / set_sse_customer_key_md5(Option<String>):

    Specifies the 128-bit MD5 digest of the encryption key according to RFC 1321. Amazon S3 uses this header for a message integrity check to ensure that the encryption key was transmitted without error.

  • ssekms_key_id(impl Into<String>) / set_ssekms_key_id(Option<String>):

    Specifies the ID (Key ID, Key ARN, or Key Alias) of the symmetric encryption customer managed key to use for object encryption. All GET and PUT requests for an object protected by KMS will fail if they’re not made via SSL or using SigV4. For information about configuring any of the officially supported Amazon Web Services SDKs and Amazon Web Services CLI, see Specifying the Signature Version in Request Authentication in the Amazon S3 User Guide.

  • ssekms_encryption_context(impl Into<String>) / set_ssekms_encryption_context(Option<String>):

    Specifies the Amazon Web Services KMS Encryption Context to use for object encryption. The value of this header is a base64-encoded UTF-8 string holding JSON with the encryption context key-value pairs.

  • bucket_key_enabled(bool) / set_bucket_key_enabled(Option<bool>):

    Specifies whether Amazon S3 should use an S3 Bucket Key for object encryption with server-side encryption using Key Management Service (KMS) keys (SSE-KMS). Setting this header to true causes Amazon S3 to use an S3 Bucket Key for object encryption with SSE-KMS.

    Specifying this header with an object action doesn’t affect bucket-level settings for S3 Bucket Key.

  • request_payer(RequestPayer) / set_request_payer(Option<RequestPayer>):

    Confirms that the requester knows that they will be charged for the request. Bucket owners need not specify this parameter in their requests. If either the source or destination Amazon S3 bucket has Requester Pays enabled, the requester will pay for corresponding charges to copy the object. For information about downloading objects from Requester Pays buckets, see Downloading Objects in Requester Pays Buckets in the Amazon S3 User Guide.

  • tagging(impl Into<String>) / set_tagging(Option<String>):

    The tag-set for the object. The tag-set must be encoded as URL Query parameters.

  • object_lock_mode(ObjectLockMode) / set_object_lock_mode(Option<ObjectLockMode>):

    Specifies the Object Lock mode that you want to apply to the uploaded object.

  • object_lock_retain_until_date(DateTime) / set_object_lock_retain_until_date(Option<DateTime>):

    Specifies the date and time when you want the Object Lock to expire.

  • object_lock_legal_hold_status(ObjectLockLegalHoldStatus) / set_object_lock_legal_hold_status(Option<ObjectLockLegalHoldStatus>):

    Specifies whether you want to apply a legal hold to the uploaded object.

  • expected_bucket_owner(impl Into<String>) / set_expected_bucket_owner(Option<String>):

    The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code 403 Forbidden (access denied).

  • checksum_algorithm(ChecksumAlgorithm) / set_checksum_algorithm(Option<ChecksumAlgorithm>):

    Indicates the algorithm you want Amazon S3 to use to create the checksum for the object. For more information, see Checking object integrity in the Amazon S3 User Guide.

• On success, responds with CreateMultipartUploadOutput with field(s):
  • abort_date(Option<DateTime>):

    If the bucket has a lifecycle rule configured with an action to abort incomplete multipart uploads and the prefix in the lifecycle rule matches the object name in the request, the response includes this header. The header indicates when the initiated multipart upload becomes eligible for an abort operation. For more information, see Aborting Incomplete Multipart Uploads Using a Bucket Lifecycle Configuration.

    The response also includes the x-amz-abort-rule-id header that provides the ID of the lifecycle configuration rule that defines this action.

  • abort_rule_id(Option<String>):

    This header is returned along with the x-amz-abort-date header. It identifies the applicable lifecycle configuration rule that defines the action to abort incomplete multipart uploads.

  • bucket(Option<String>):

    The name of the bucket to which the multipart upload was initiated. Does not return the access point ARN or access point alias if used.

    When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using access points in the Amazon S3 User Guide.

    When you use this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When you use this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts access point ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see What is S3 on Outposts? in the Amazon S3 User Guide.

  • key(Option<String>):

    Object key for which the multipart upload was initiated.

  • upload_id(Option<String>):

    ID for the initiated multipart upload.

  • server_side_encryption(Option<ServerSideEncryption>):

    The server-side encryption algorithm used when storing this object in Amazon S3 (for example, AES256, aws:kms).

  • sse_customer_algorithm(Option<String>):

    If server-side encryption with a customer-provided encryption key was requested, the response will include this header confirming the encryption algorithm used.

  • sse_customer_key_md5(Option<String>):

    If server-side encryption with a customer-provided encryption key was requested, the response will include this header to provide round-trip message integrity verification of the customer-provided encryption key.

  • ssekms_key_id(Option<String>):

    If present, specifies the ID of the Key Management Service (KMS) symmetric encryption customer managed key that was used for the object.

  • ssekms_encryption_context(Option<String>):

    If present, specifies the Amazon Web Services KMS Encryption Context to use for object encryption. The value of this header is a base64-encoded UTF-8 string holding JSON with the encryption context key-value pairs.

  • bucket_key_enabled(bool):

    Indicates whether the multipart upload uses an S3 Bucket Key for server-side encryption with Key Management Service (KMS) keys (SSE-KMS).

  • request_charged(Option<RequestCharged>):

    If present, indicates that the requester was successfully charged for the request.

  • checksum_algorithm(Option<ChecksumAlgorithm>):

    The algorithm that was used to create a checksum of the object.

• On failure, responds with SdkError<CreateMultipartUploadError>

impl Client

pub fn delete_bucket(&self) -> DeleteBucketFluentBuilder

Constructs a fluent builder for the DeleteBucket operation.

• The fluent builder is configurable:
  • bucket(impl Into<String>) / set_bucket(Option<String>):

    Specifies the bucket being deleted.

  • expected_bucket_owner(impl Into<String>) / set_expected_bucket_owner(Option<String>):

    The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code 403 Forbidden (access denied).

• On success, responds with DeleteBucketOutput
• On failure, responds with SdkError<DeleteBucketError>

impl Client

pub fn delete_bucket_analytics_configuration( &self ) -> DeleteBucketAnalyticsConfigurationFluentBuilder

Constructs a fluent builder for the DeleteBucketAnalyticsConfiguration operation.

• The fluent builder is configurable:
  • bucket(impl Into<String>) / set_bucket(Option<String>):

    The name of the bucket from which an analytics configuration is deleted.

  • id(impl Into<String>) / set_id(Option<String>):

    The ID that identifies the analytics configuration.

  • expected_bucket_owner(impl Into<String>) / set_expected_bucket_owner(Option<String>):

    The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code 403 Forbidden (access denied).

• On success, responds with DeleteBucketAnalyticsConfigurationOutput
• On failure, responds with SdkError<DeleteBucketAnalyticsConfigurationError>

impl Client

pub fn delete_bucket_cors(&self) -> DeleteBucketCorsFluentBuilder

Constructs a fluent builder for the DeleteBucketCors operation.

• The fluent builder is configurable:
  • bucket(impl Into<String>) / set_bucket(Option<String>):

    Specifies the bucket whose cors configuration is being deleted.

  • expected_bucket_owner(impl Into<String>) / set_expected_bucket_owner(Option<String>):

    The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code 403 Forbidden (access denied).

• On success, responds with DeleteBucketCorsOutput
• On failure, responds with SdkError<DeleteBucketCorsError>

impl Client

pub fn delete_bucket_encryption(&self) -> DeleteBucketEncryptionFluentBuilder

Constructs a fluent builder for the DeleteBucketEncryption operation.

• The fluent builder is configurable:
  • bucket(impl Into<String>) / set_bucket(Option<String>):

    The name of the bucket containing the server-side encryption configuration to delete.

  • expected_bucket_owner(impl Into<String>) / set_expected_bucket_owner(Option<String>):

    The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code 403 Forbidden (access denied).

• On success, responds with DeleteBucketEncryptionOutput
• On failure, responds with SdkError<DeleteBucketEncryptionError>

impl Client

pub fn delete_bucket_intelligent_tiering_configuration( &self ) -> DeleteBucketIntelligentTieringConfigurationFluentBuilder

Constructs a fluent builder for the DeleteBucketIntelligentTieringConfiguration operation.

• The fluent builder is configurable:
  • bucket(impl Into<String>) / set_bucket(Option<String>):

    The name of the Amazon S3 bucket whose configuration you want to modify or retrieve.

  • id(impl Into<String>) / set_id(Option<String>):

    The ID used to identify the S3 Intelligent-Tiering configuration.

• On success, responds with DeleteBucketIntelligentTieringConfigurationOutput
• On failure, responds with SdkError<DeleteBucketIntelligentTieringConfigurationError>

impl Client

pub fn delete_bucket_inventory_configuration( &self ) -> DeleteBucketInventoryConfigurationFluentBuilder

Constructs a fluent builder for the DeleteBucketInventoryConfiguration operation.

• The fluent builder is configurable:
  • bucket(impl Into<String>) / set_bucket(Option<String>):

    The name of the bucket containing the inventory configuration to delete.

  • id(impl Into<String>) / set_id(Option<String>):

    The ID used to identify the inventory configuration.

  • expected_bucket_owner(impl Into<String>) / set_expected_bucket_owner(Option<String>):

    The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code 403 Forbidden (access denied).

• On success, responds with DeleteBucketInventoryConfigurationOutput
• On failure, responds with SdkError<DeleteBucketInventoryConfigurationError>

impl Client

pub fn delete_bucket_lifecycle(&self) -> DeleteBucketLifecycleFluentBuilder

Constructs a fluent builder for the DeleteBucketLifecycle operation.

• The fluent builder is configurable:
  • bucket(impl Into<String>) / set_bucket(Option<String>):

    The bucket name of the lifecycle to delete.

  • expected_bucket_owner(impl Into<String>) / set_expected_bucket_owner(Option<String>):

    The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code 403 Forbidden (access denied).

• On success, responds with DeleteBucketLifecycleOutput
• On failure, responds with SdkError<DeleteBucketLifecycleError>

impl Client

pub fn delete_bucket_metrics_configuration( &self ) -> DeleteBucketMetricsConfigurationFluentBuilder

Constructs a fluent builder for the DeleteBucketMetricsConfiguration operation.

• The fluent builder is configurable:
  • bucket(impl Into<String>) / set_bucket(Option<String>):

    The name of the bucket containing the metrics configuration to delete.

  • id(impl Into<String>) / set_id(Option<String>):

    The ID used to identify the metrics configuration. The ID has a 64 character limit and can only contain letters, numbers, periods, dashes, and underscores.

  • expected_bucket_owner(impl Into<String>) / set_expected_bucket_owner(Option<String>):

    The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code 403 Forbidden (access denied).

• On success, responds with DeleteBucketMetricsConfigurationOutput
• On failure, responds with SdkError<DeleteBucketMetricsConfigurationError>

impl Client

pub fn delete_bucket_ownership_controls( &self ) -> DeleteBucketOwnershipControlsFluentBuilder

Constructs a fluent builder for the DeleteBucketOwnershipControls operation.

• The fluent builder is configurable:
  • bucket(impl Into<String>) / set_bucket(Option<String>):

    The Amazon S3 bucket whose OwnershipControls you want to delete.

  • expected_bucket_owner(impl Into<String>) / set_expected_bucket_owner(Option<String>):

    The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code 403 Forbidden (access denied).

• On success, responds with DeleteBucketOwnershipControlsOutput
• On failure, responds with SdkError<DeleteBucketOwnershipControlsError>

impl Client

pub fn delete_bucket_policy(&self) -> DeleteBucketPolicyFluentBuilder

Constructs a fluent builder for the DeleteBucketPolicy operation.

• The fluent builder is configurable:
  • bucket(impl Into<String>) / set_bucket(Option<String>):

    The bucket name.

  • expected_bucket_owner(impl Into<String>) / set_expected_bucket_owner(Option<String>):

    The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code 403 Forbidden (access denied).

• On success, responds with DeleteBucketPolicyOutput
• On failure, responds with SdkError<DeleteBucketPolicyError>

impl Client

pub fn delete_bucket_replication(&self) -> DeleteBucketReplicationFluentBuilder

Constructs a fluent builder for the DeleteBucketReplication operation.

• The fluent builder is configurable:
  • bucket(impl Into<String>) / set_bucket(Option<String>):

    The bucket name.

  • expected_bucket_owner(impl Into<String>) / set_expected_bucket_owner(Option<String>):

    The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code 403 Forbidden (access denied).

• On success, responds with DeleteBucketReplicationOutput
• On failure, responds with SdkError<DeleteBucketReplicationError>

impl Client

pub fn delete_bucket_tagging(&self) -> DeleteBucketTaggingFluentBuilder

Constructs a fluent builder for the DeleteBucketTagging operation.

• The fluent builder is configurable:
  • bucket(impl Into<String>) / set_bucket(Option<String>):

    The bucket that has the tag set to be removed.

  • expected_bucket_owner(impl Into<String>) / set_expected_bucket_owner(Option<String>):

    The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code 403 Forbidden (access denied).

• On success, responds with DeleteBucketTaggingOutput
• On failure, responds with SdkError<DeleteBucketTaggingError>

impl Client

pub fn delete_bucket_website(&self) -> DeleteBucketWebsiteFluentBuilder

Constructs a fluent builder for the DeleteBucketWebsite operation.

• The fluent builder is configurable:
  • bucket(impl Into<String>) / set_bucket(Option<String>):

    The bucket name for which you want to remove the website configuration.

  • expected_bucket_owner(impl Into<String>) / set_expected_bucket_owner(Option<String>):

    The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code 403 Forbidden (access denied).

• On success, responds with DeleteBucketWebsiteOutput
• On failure, responds with SdkError<DeleteBucketWebsiteError>

impl Client

pub fn delete_object(&self) -> DeleteObjectFluentBuilder

Constructs a fluent builder for the DeleteObject operation.

• The fluent builder is configurable:
  • bucket(impl Into<String>) / set_bucket(Option<String>):

    The bucket name of the bucket containing the object.

    When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using access points in the Amazon S3 User Guide.

    When you use this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When you use this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts access point ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see What is S3 on Outposts? in the Amazon S3 User Guide.

  • key(impl Into<String>) / set_key(Option<String>):

    Key name of the object to delete.

  • mfa(impl Into<String>) / set_mfa(Option<String>):

    The concatenation of the authentication device’s serial number, a space, and the value that is displayed on your authentication device. Required to permanently delete a versioned object if versioning is configured with MFA delete enabled.

  • version_id(impl Into<String>) / set_version_id(Option<String>):

    VersionId used to reference a specific version of the object.

  • request_payer(RequestPayer) / set_request_payer(Option<RequestPayer>):

    Confirms that the requester knows that they will be charged for the request. Bucket owners need not specify this parameter in their requests. If either the source or destination Amazon S3 bucket has Requester Pays enabled, the requester will pay for corresponding charges to copy the object. For information about downloading objects from Requester Pays buckets, see Downloading Objects in Requester Pays Buckets in the Amazon S3 User Guide.

  • bypass_governance_retention(bool) / set_bypass_governance_retention(Option<bool>):

    Indicates whether S3 Object Lock should bypass Governance-mode restrictions to process this operation. To use this header, you must have the s3:BypassGovernanceRetention permission.

  • expected_bucket_owner(impl Into<String>) / set_expected_bucket_owner(Option<String>):

    The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code 403 Forbidden (access denied).

• On success, responds with DeleteObjectOutput with field(s):
  • delete_marker(bool):

    Indicates whether the specified object version that was permanently deleted was (true) or was not (false) a delete marker before deletion. In a simple DELETE, this header indicates whether (true) or not (false) the current version of the object is a delete marker.

  • version_id(Option<String>):

    Returns the version ID of the delete marker created as a result of the DELETE operation.

  • request_charged(Option<RequestCharged>):

    If present, indicates that the requester was successfully charged for the request.

• On failure, responds with SdkError<DeleteObjectError>

impl Client

pub fn delete_object_tagging(&self) -> DeleteObjectTaggingFluentBuilder

Constructs a fluent builder for the DeleteObjectTagging operation.

• The fluent builder is configurable:
  • bucket(impl Into<String>) / set_bucket(Option<String>):

    The bucket name containing the objects from which to remove the tags.

    When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using access points in the Amazon S3 User Guide.

    When you use this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When you use this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts access point ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see What is S3 on Outposts? in the Amazon S3 User Guide.

  • key(impl Into<String>) / set_key(Option<String>):

    The key that identifies the object in the bucket from which to remove all tags.

  • version_id(impl Into<String>) / set_version_id(Option<String>):

    The versionId of the object that the tag-set will be removed from.

  • expected_bucket_owner(impl Into<String>) / set_expected_bucket_owner(Option<String>):

    The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code 403 Forbidden (access denied).

• On success, responds with DeleteObjectTaggingOutput with field(s):
  • version_id(Option<String>):

    The versionId of the object the tag-set was removed from.

• On failure, responds with SdkError<DeleteObjectTaggingError>

impl Client

pub fn delete_objects(&self) -> DeleteObjectsFluentBuilder

Constructs a fluent builder for the DeleteObjects operation.

• The fluent builder is configurable:
  • bucket(impl Into<String>) / set_bucket(Option<String>):

    The bucket name containing the objects to delete.

    When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using access points in the Amazon S3 User Guide.

    When you use this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When you use this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts access point ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see What is S3 on Outposts? in the Amazon S3 User Guide.

  • delete(Delete) / set_delete(Option<Delete>):

    Container for the request.

  • mfa(impl Into<String>) / set_mfa(Option<String>):

    The concatenation of the authentication device’s serial number, a space, and the value that is displayed on your authentication device. Required to permanently delete a versioned object if versioning is configured with MFA delete enabled.

  • request_payer(RequestPayer) / set_request_payer(Option<RequestPayer>):

    Confirms that the requester knows that they will be charged for the request. Bucket owners need not specify this parameter in their requests. If either the source or destination Amazon S3 bucket has Requester Pays enabled, the requester will pay for corresponding charges to copy the object. For information about downloading objects from Requester Pays buckets, see Downloading Objects in Requester Pays Buckets in the Amazon S3 User Guide.

  • bypass_governance_retention(bool) / set_bypass_governance_retention(Option<bool>):

    Specifies whether you want to delete this object even if it has a Governance-type Object Lock in place. To use this header, you must have the s3:BypassGovernanceRetention permission.

  • expected_bucket_owner(impl Into<String>) / set_expected_bucket_owner(Option<String>):

    The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code 403 Forbidden (access denied).

  • checksum_algorithm(ChecksumAlgorithm) / set_checksum_algorithm(Option<ChecksumAlgorithm>):

    Indicates the algorithm used to create the checksum for the object when using the SDK. This header will not provide any additional functionality if not using the SDK. When sending this header, there must be a corresponding x-amz-checksum or x-amz-trailer header sent. Otherwise, Amazon S3 fails the request with the HTTP status code 400 Bad Request. For more information, see Checking object integrity in the Amazon S3 User Guide.

    If you provide an individual checksum, Amazon S3 ignores any provided ChecksumAlgorithm parameter.

    This checksum algorithm must be the same for all parts and it match the checksum value supplied in the CreateMultipartUpload request.

• On success, responds with DeleteObjectsOutput with field(s):
  • deleted(Option<Vec<DeletedObject>>):

    Container element for a successful delete. It identifies the object that was successfully deleted.

  • request_charged(Option<RequestCharged>):

    If present, indicates that the requester was successfully charged for the request.

  • errors(Option<Vec<Error>>):

    Container for a failed delete action that describes the object that Amazon S3 attempted to delete and the error it encountered.

• On failure, responds with SdkError<DeleteObjectsError>

impl Client

pub fn delete_public_access_block(&self) -> DeletePublicAccessBlockFluentBuilder

Constructs a fluent builder for the DeletePublicAccessBlock operation.

• The fluent builder is configurable:
  • bucket(impl Into<String>) / set_bucket(Option<String>):

    The Amazon S3 bucket whose PublicAccessBlock configuration you want to delete.

  • expected_bucket_owner(impl Into<String>) / set_expected_bucket_owner(Option<String>):

    The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code 403 Forbidden (access denied).

• On success, responds with DeletePublicAccessBlockOutput
• On failure, responds with SdkError<DeletePublicAccessBlockError>

impl Client

pub fn get_bucket_accelerate_configuration( &self ) -> GetBucketAccelerateConfigurationFluentBuilder

Constructs a fluent builder for the GetBucketAccelerateConfiguration operation.

• The fluent builder is configurable:
  • bucket(impl Into<String>) / set_bucket(Option<String>):

    The name of the bucket for which the accelerate configuration is retrieved.

  • expected_bucket_owner(impl Into<String>) / set_expected_bucket_owner(Option<String>):

    The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code 403 Forbidden (access denied).

  • request_payer(RequestPayer) / set_request_payer(Option<RequestPayer>):

    Confirms that the requester knows that they will be charged for the request. Bucket owners need not specify this parameter in their requests. If either the source or destination Amazon S3 bucket has Requester Pays enabled, the requester will pay for corresponding charges to copy the object. For information about downloading objects from Requester Pays buckets, see Downloading Objects in Requester Pays Buckets in the Amazon S3 User Guide.

• On success, responds with GetBucketAccelerateConfigurationOutput with field(s):
  • status(Option<BucketAccelerateStatus>):

    The accelerate configuration of the bucket.

  • request_charged(Option<RequestCharged>):

    If present, indicates that the requester was successfully charged for the request.

• On failure, responds with SdkError<GetBucketAccelerateConfigurationError>

impl Client

pub fn get_bucket_acl(&self) -> GetBucketAclFluentBuilder

Constructs a fluent builder for the GetBucketAcl operation.

• The fluent builder is configurable:
  • bucket(impl Into<String>) / set_bucket(Option<String>):

    Specifies the S3 bucket whose ACL is being requested.

    To use this API operation against an access point, provide the alias of the access point in place of the bucket name.

    To use this API operation against an Object Lambda access point, provide the alias of the Object Lambda access point in place of the bucket name. If the Object Lambda access point alias in a request is not valid, the error code InvalidAccessPointAliasError is returned. For more information about InvalidAccessPointAliasError, see List of Error Codes.

  • expected_bucket_owner(impl Into<String>) / set_expected_bucket_owner(Option<String>):

    The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code 403 Forbidden (access denied).

• On success, responds with GetBucketAclOutput with field(s):
  • owner(Option<Owner>):

    Container for the bucket owner’s display name and ID.

  • grants(Option<Vec<Grant>>):

    A list of grants.

• On failure, responds with SdkError<GetBucketAclError>

impl Client

pub fn get_bucket_analytics_configuration( &self ) -> GetBucketAnalyticsConfigurationFluentBuilder

Constructs a fluent builder for the GetBucketAnalyticsConfiguration operation.

• The fluent builder is configurable:
  • bucket(impl Into<String>) / set_bucket(Option<String>):

    The name of the bucket from which an analytics configuration is retrieved.

  • id(impl Into<String>) / set_id(Option<String>):

    The ID that identifies the analytics configuration.

  • expected_bucket_owner(impl Into<String>) / set_expected_bucket_owner(Option<String>):

    The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code 403 Forbidden (access denied).

• On success, responds with GetBucketAnalyticsConfigurationOutput with field(s):
  • analytics_configuration(Option<AnalyticsConfiguration>):

    The configuration and any analyses for the analytics filter.

• On failure, responds with SdkError<GetBucketAnalyticsConfigurationError>

impl Client

pub fn get_bucket_cors(&self) -> GetBucketCorsFluentBuilder

Constructs a fluent builder for the GetBucketCors operation.

• The fluent builder is configurable:
  • bucket(impl Into<String>) / set_bucket(Option<String>):

    The bucket name for which to get the cors configuration.

    To use this API operation against an access point, provide the alias of the access point in place of the bucket name.

    To use this API operation against an Object Lambda access point, provide the alias of the Object Lambda access point in place of the bucket name. If the Object Lambda access point alias in a request is not valid, the error code InvalidAccessPointAliasError is returned. For more information about InvalidAccessPointAliasError, see List of Error Codes.

  • expected_bucket_owner(impl Into<String>) / set_expected_bucket_owner(Option<String>):

    The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code 403 Forbidden (access denied).

• On success, responds with GetBucketCorsOutput with field(s):
  • cors_rules(Option<Vec<CorsRule>>):

    A set of origins and methods (cross-origin access that you want to allow). You can add up to 100 rules to the configuration.

• On failure, responds with SdkError<GetBucketCorsError>

impl Client

pub fn get_bucket_encryption(&self) -> GetBucketEncryptionFluentBuilder

Constructs a fluent builder for the GetBucketEncryption operation.

• The fluent builder is configurable:
  • bucket(impl Into<String>) / set_bucket(Option<String>):

    The name of the bucket from which the server-side encryption configuration is retrieved.

  • expected_bucket_owner(impl Into<String>) / set_expected_bucket_owner(Option<String>):

    The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code 403 Forbidden (access denied).

• On success, responds with GetBucketEncryptionOutput with field(s):
  • server_side_encryption_configuration(Option<ServerSideEncryptionConfiguration>):

    Specifies the default server-side-encryption configuration.

• On failure, responds with SdkError<GetBucketEncryptionError>

impl Client

pub fn get_bucket_intelligent_tiering_configuration( &self ) -> GetBucketIntelligentTieringConfigurationFluentBuilder

Constructs a fluent builder for the GetBucketIntelligentTieringConfiguration operation.

• The fluent builder is configurable:
  • bucket(impl Into<String>) / set_bucket(Option<String>):

    The name of the Amazon S3 bucket whose configuration you want to modify or retrieve.

  • id(impl Into<String>) / set_id(Option<String>):

    The ID used to identify the S3 Intelligent-Tiering configuration.

• On success, responds with GetBucketIntelligentTieringConfigurationOutput with field(s):
  • intelligent_tiering_configuration(Option<IntelligentTieringConfiguration>):

    Container for S3 Intelligent-Tiering configuration.

• On failure, responds with SdkError<GetBucketIntelligentTieringConfigurationError>

impl Client

pub fn get_bucket_inventory_configuration( &self ) -> GetBucketInventoryConfigurationFluentBuilder

Constructs a fluent builder for the GetBucketInventoryConfiguration operation.

• The fluent builder is configurable:
  • bucket(impl Into<String>) / set_bucket(Option<String>):

    The name of the bucket containing the inventory configuration to retrieve.

  • id(impl Into<String>) / set_id(Option<String>):

    The ID used to identify the inventory configuration.

  • expected_bucket_owner(impl Into<String>) / set_expected_bucket_owner(Option<String>):

    The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code 403 Forbidden (access denied).

• On success, responds with GetBucketInventoryConfigurationOutput with field(s):
  • inventory_configuration(Option<InventoryConfiguration>):

    Specifies the inventory configuration.

• On failure, responds with SdkError<GetBucketInventoryConfigurationError>

impl Client

pub fn get_bucket_lifecycle_configuration( &self ) -> GetBucketLifecycleConfigurationFluentBuilder

Constructs a fluent builder for the GetBucketLifecycleConfiguration operation.

• The fluent builder is configurable:
  • bucket(impl Into<String>) / set_bucket(Option<String>):

    The name of the bucket for which to get the lifecycle information.

  • expected_bucket_owner(impl Into<String>) / set_expected_bucket_owner(Option<String>):

    The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code 403 Forbidden (access denied).

• On success, responds with GetBucketLifecycleConfigurationOutput with field(s):
  • rules(Option<Vec<LifecycleRule>>):

    Container for a lifecycle rule.

• On failure, responds with SdkError<GetBucketLifecycleConfigurationError>

impl Client

pub fn get_bucket_location(&self) -> GetBucketLocationFluentBuilder

Constructs a fluent builder for the GetBucketLocation operation.

• The fluent builder is configurable:
  • bucket(impl Into<String>) / set_bucket(Option<String>):

    The name of the bucket for which to get the location.

    To use this API operation against an access point, provide the alias of the access point in place of the bucket name.

    To use this API operation against an Object Lambda access point, provide the alias of the Object Lambda access point in place of the bucket name. If the Object Lambda access point alias in a request is not valid, the error code InvalidAccessPointAliasError is returned. For more information about InvalidAccessPointAliasError, see List of Error Codes.

  • expected_bucket_owner(impl Into<String>) / set_expected_bucket_owner(Option<String>):

    The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code 403 Forbidden (access denied).

• On success, responds with GetBucketLocationOutput with field(s):
  • location_constraint(Option<BucketLocationConstraint>):

    Specifies the Region where the bucket resides. For a list of all the Amazon S3 supported location constraints by Region, see Regions and Endpoints. Buckets in Region us-east-1 have a LocationConstraint of null.

• On failure, responds with SdkError<GetBucketLocationError>

impl Client

pub fn get_bucket_logging(&self) -> GetBucketLoggingFluentBuilder

Constructs a fluent builder for the GetBucketLogging operation.

• The fluent builder is configurable:
  • bucket(impl Into<String>) / set_bucket(Option<String>):

    The bucket name for which to get the logging information.

  • expected_bucket_owner(impl Into<String>) / set_expected_bucket_owner(Option<String>):

    The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code 403 Forbidden (access denied).

• On success, responds with GetBucketLoggingOutput with field(s):
  • logging_enabled(Option<LoggingEnabled>):

    Describes where logs are stored and the prefix that Amazon S3 assigns to all log object keys for a bucket. For more information, see PUT Bucket logging in the Amazon S3 API Reference.

• On failure, responds with SdkError<GetBucketLoggingError>

impl Client

pub fn get_bucket_metrics_configuration( &self ) -> GetBucketMetricsConfigurationFluentBuilder

Constructs a fluent builder for the GetBucketMetricsConfiguration operation.

• The fluent builder is configurable:
  • bucket(impl Into<String>) / set_bucket(Option<String>):

    The name of the bucket containing the metrics configuration to retrieve.

  • id(impl Into<String>) / set_id(Option<String>):

    The ID used to identify the metrics configuration. The ID has a 64 character limit and can only contain letters, numbers, periods, dashes, and underscores.

  • expected_bucket_owner(impl Into<String>) / set_expected_bucket_owner(Option<String>):

    The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code 403 Forbidden (access denied).

• On success, responds with GetBucketMetricsConfigurationOutput with field(s):
  • metrics_configuration(Option<MetricsConfiguration>):

    Specifies the metrics configuration.

• On failure, responds with SdkError<GetBucketMetricsConfigurationError>

impl Client

pub fn get_bucket_notification_configuration( &self ) -> GetBucketNotificationConfigurationFluentBuilder

Constructs a fluent builder for the GetBucketNotificationConfiguration operation.

• The fluent builder is configurable:
  • bucket(impl Into<String>) / set_bucket(Option<String>):

    The name of the bucket for which to get the notification configuration.

    To use this API operation against an access point, provide the alias of the access point in place of the bucket name.

    To use this API operation against an Object Lambda access point, provide the alias of the Object Lambda access point in place of the bucket name. If the Object Lambda access point alias in a request is not valid, the error code InvalidAccessPointAliasError is returned. For more information about InvalidAccessPointAliasError, see List of Error Codes.

  • expected_bucket_owner(impl Into<String>) / set_expected_bucket_owner(Option<String>):

    The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code 403 Forbidden (access denied).

• On success, responds with GetBucketNotificationConfigurationOutput with field(s):
  • topic_configurations(Option<Vec<TopicConfiguration>>):

    The topic to which notifications are sent and the events for which notifications are generated.

  • queue_configurations(Option<Vec<QueueConfiguration>>):

    The Amazon Simple Queue Service queues to publish messages to and the events for which to publish messages.

  • lambda_function_configurations(Option<Vec<LambdaFunctionConfiguration>>):

    Describes the Lambda functions to invoke and the events for which to invoke them.

  • event_bridge_configuration(Option<EventBridgeConfiguration>):

    Enables delivery of events to Amazon EventBridge.

• On failure, responds with SdkError<GetBucketNotificationConfigurationError>

impl Client

pub fn get_bucket_ownership_controls( &self ) -> GetBucketOwnershipControlsFluentBuilder

Constructs a fluent builder for the GetBucketOwnershipControls operation.

• The fluent builder is configurable:
  • bucket(impl Into<String>) / set_bucket(Option<String>):

    The name of the Amazon S3 bucket whose OwnershipControls you want to retrieve.

  • expected_bucket_owner(impl Into<String>) / set_expected_bucket_owner(Option<String>):

    The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code 403 Forbidden (access denied).

• On success, responds with GetBucketOwnershipControlsOutput with field(s):
  • ownership_controls(Option<OwnershipControls>):

    The OwnershipControls (BucketOwnerEnforced, BucketOwnerPreferred, or ObjectWriter) currently in effect for this Amazon S3 bucket.

• On failure, responds with SdkError<GetBucketOwnershipControlsError>

impl Client

pub fn get_bucket_policy(&self) -> GetBucketPolicyFluentBuilder

Constructs a fluent builder for the GetBucketPolicy operation.

• The fluent builder is configurable:
  • bucket(impl Into<String>) / set_bucket(Option<String>):

    The bucket name for which to get the bucket policy.

    To use this API operation against an access point, provide the alias of the access point in place of the bucket name.

    To use this API operation against an Object Lambda access point, provide the alias of the Object Lambda access point in place of the bucket name. If the Object Lambda access point alias in a request is not valid, the error code InvalidAccessPointAliasError is returned. For more information about InvalidAccessPointAliasError, see List of Error Codes.

  • expected_bucket_owner(impl Into<String>) / set_expected_bucket_owner(Option<String>):

    The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code 403 Forbidden (access denied).

• On success, responds with GetBucketPolicyOutput with field(s):
  • policy(Option<String>):

    The bucket policy as a JSON document.

• On failure, responds with SdkError<GetBucketPolicyError>

impl Client

pub fn get_bucket_policy_status(&self) -> GetBucketPolicyStatusFluentBuilder

Constructs a fluent builder for the GetBucketPolicyStatus operation.

• The fluent builder is configurable:
  • bucket(impl Into<String>) / set_bucket(Option<String>):

    The name of the Amazon S3 bucket whose policy status you want to retrieve.

  • expected_bucket_owner(impl Into<String>) / set_expected_bucket_owner(Option<String>):

    The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code 403 Forbidden (access denied).

• On success, responds with GetBucketPolicyStatusOutput with field(s):
  • policy_status(Option<PolicyStatus>):

    The policy status for the specified bucket.

• On failure, responds with SdkError<GetBucketPolicyStatusError>

impl Client

pub fn get_bucket_replication(&self) -> GetBucketReplicationFluentBuilder

Constructs a fluent builder for the GetBucketReplication operation.

• The fluent builder is configurable:
  • bucket(impl Into<String>) / set_bucket(Option<String>):

    The bucket name for which to get the replication information.

  • expected_bucket_owner(impl Into<String>) / set_expected_bucket_owner(Option<String>):

    The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code 403 Forbidden (access denied).

• On success, responds with GetBucketReplicationOutput with field(s):
  • replication_configuration(Option<ReplicationConfiguration>):

    A container for replication rules. You can add up to 1,000 rules. The maximum size of a replication configuration is 2 MB.

• On failure, responds with SdkError<GetBucketReplicationError>

impl Client

pub fn get_bucket_request_payment(&self) -> GetBucketRequestPaymentFluentBuilder

Constructs a fluent builder for the GetBucketRequestPayment operation.

• The fluent builder is configurable:
  • bucket(impl Into<String>) / set_bucket(Option<String>):

    The name of the bucket for which to get the payment request configuration

  • expected_bucket_owner(impl Into<String>) / set_expected_bucket_owner(Option<String>):

    The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code 403 Forbidden (access denied).

• On success, responds with GetBucketRequestPaymentOutput with field(s):
  • payer(Option<Payer>):

    Specifies who pays for the download and request fees.

• On failure, responds with SdkError<GetBucketRequestPaymentError>

impl Client

pub fn get_bucket_tagging(&self) -> GetBucketTaggingFluentBuilder

Constructs a fluent builder for the GetBucketTagging operation.

• The fluent builder is configurable:
  • bucket(impl Into<String>) / set_bucket(Option<String>):

    The name of the bucket for which to get the tagging information.

  • expected_bucket_owner(impl Into<String>) / set_expected_bucket_owner(Option<String>):

    The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code 403 Forbidden (access denied).

• On success, responds with GetBucketTaggingOutput with field(s):
  • tag_set(Option<Vec<Tag>>):

    Contains the tag set.

• On failure, responds with SdkError<GetBucketTaggingError>

impl Client

pub fn get_bucket_versioning(&self) -> GetBucketVersioningFluentBuilder

Constructs a fluent builder for the GetBucketVersioning operation.

• The fluent builder is configurable:
  • bucket(impl Into<String>) / set_bucket(Option<String>):

    The name of the bucket for which to get the versioning information.

  • expected_bucket_owner(impl Into<String>) / set_expected_bucket_owner(Option<String>):

    The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code 403 Forbidden (access denied).

• On success, responds with GetBucketVersioningOutput with field(s):
  • status(Option<BucketVersioningStatus>):

    The versioning state of the bucket.

  • mfa_delete(Option<MfaDeleteStatus>):

    Specifies whether MFA delete is enabled in the bucket versioning configuration. This element is only returned if the bucket has been configured with MFA delete. If the bucket has never been so configured, this element is not returned.

• On failure, responds with SdkError<GetBucketVersioningError>

impl Client

pub fn get_bucket_website(&self) -> GetBucketWebsiteFluentBuilder

Constructs a fluent builder for the GetBucketWebsite operation.

• The fluent builder is configurable:
  • bucket(impl Into<String>) / set_bucket(Option<String>):

    The bucket name for which to get the website configuration.

  • expected_bucket_owner(impl Into<String>) / set_expected_bucket_owner(Option<String>):

    The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code 403 Forbidden (access denied).

• On success, responds with GetBucketWebsiteOutput with field(s):
  • redirect_all_requests_to(Option<RedirectAllRequestsTo>):

    Specifies the redirect behavior of all requests to a website endpoint of an Amazon S3 bucket.

  • index_document(Option<IndexDocument>):

    The name of the index document for the website (for example index.html).

  • error_document(Option<ErrorDocument>):

    The object key name of the website error document to use for 4XX class errors.

  • routing_rules(Option<Vec<RoutingRule>>):

    Rules that define when a redirect is applied and the redirect behavior.

• On failure, responds with SdkError<GetBucketWebsiteError>

impl Client

pub fn get_object(&self) -> GetObjectFluentBuilder

Constructs a fluent builder for the GetObject operation.

• The fluent builder is configurable:
  • bucket(impl Into<String>) / set_bucket(Option<String>):

    The bucket name containing the object.

    When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using access points in the Amazon S3 User Guide.

    When using an Object Lambda access point the hostname takes the form AccessPointName-AccountId.s3-object-lambda.Region.amazonaws.com.

    When you use this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When you use this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts access point ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see What is S3 on Outposts? in the Amazon S3 User Guide.

  • if_match(impl Into<String>) / set_if_match(Option<String>):

    Return the object only if its entity tag (ETag) is the same as the one specified; otherwise, return a 412 (precondition failed) error.

  • if_modified_since(DateTime) / set_if_modified_since(Option<DateTime>):

    Return the object only if it has been modified since the specified time; otherwise, return a 304 (not modified) error.

  • if_none_match(impl Into<String>) / set_if_none_match(Option<String>):

    Return the object only if its entity tag (ETag) is different from the one specified; otherwise, return a 304 (not modified) error.

  • if_unmodified_since(DateTime) / set_if_unmodified_since(Option<DateTime>):

    Return the object only if it has not been modified since the specified time; otherwise, return a 412 (precondition failed) error.

  • key(impl Into<String>) / set_key(Option<String>):

    Key of the object to get.

  • range(impl Into<String>) / set_range(Option<String>):

    Downloads the specified range bytes of an object. For more information about the HTTP Range header, see https://www.rfc-editor.org/rfc/rfc9110.html#name-range.

    Amazon S3 doesn’t support retrieving multiple ranges of data per GET request.

  • response_cache_control(impl Into<String>) / set_response_cache_control(Option<String>):

    Sets the Cache-Control header of the response.

  • response_content_disposition(impl Into<String>) / set_response_content_disposition(Option<String>):

    Sets the Content-Disposition header of the response

  • response_content_encoding(impl Into<String>) / set_response_content_encoding(Option<String>):

    Sets the Content-Encoding header of the response.

  • response_content_language(impl Into<String>) / set_response_content_language(Option<String>):

    Sets the Content-Language header of the response.

  • response_content_type(impl Into<String>) / set_response_content_type(Option<String>):

    Sets the Content-Type header of the response.

  • response_expires(DateTime) / set_response_expires(Option<DateTime>):

    Sets the Expires header of the response.

  • version_id(impl Into<String>) / set_version_id(Option<String>):

    VersionId used to reference a specific version of the object.

  • sse_customer_algorithm(impl Into<String>) / set_sse_customer_algorithm(Option<String>):

    Specifies the algorithm to use to when decrypting the object (for example, AES256).

  • sse_customer_key(impl Into<String>) / set_sse_customer_key(Option<String>):

    Specifies the customer-provided encryption key for Amazon S3 used to encrypt the data. This value is used to decrypt the object when recovering it and must match the one used when storing the data. The key must be appropriate for use with the algorithm specified in the x-amz-server-side-encryption-customer-algorithm header.

  • sse_customer_key_md5(impl Into<String>) / set_sse_customer_key_md5(Option<String>):

    Specifies the 128-bit MD5 digest of the encryption key according to RFC 1321. Amazon S3 uses this header for a message integrity check to ensure that the encryption key was transmitted without error.

  • request_payer(RequestPayer) / set_request_payer(Option<RequestPayer>):

    Confirms that the requester knows that they will be charged for the request. Bucket owners need not specify this parameter in their requests. If either the source or destination Amazon S3 bucket has Requester Pays enabled, the requester will pay for corresponding charges to copy the object. For information about downloading objects from Requester Pays buckets, see Downloading Objects in Requester Pays Buckets in the Amazon S3 User Guide.

  • part_number(i32) / set_part_number(Option<i32>):

    Part number of the object being read. This is a positive integer between 1 and 10,000. Effectively performs a ‘ranged’ GET request for the part specified. Useful for downloading just a part of an object.

  • expected_bucket_owner(impl Into<String>) / set_expected_bucket_owner(Option<String>):

    The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code 403 Forbidden (access denied).

  • checksum_mode(ChecksumMode) / set_checksum_mode(Option<ChecksumMode>):

    To retrieve the checksum, this mode must be enabled.

• On success, responds with GetObjectOutput with field(s):
  • body(ByteStream):

    Object data.

  • delete_marker(bool):

    Specifies whether the object retrieved was (true) or was not (false) a Delete Marker. If false, this response header does not appear in the response.

  • accept_ranges(Option<String>):

    Indicates that a range of bytes was specified.

  • expiration(Option<String>):

    If the object expiration is configured (see PUT Bucket lifecycle), the response includes this header. It includes the expiry-date and rule-id key-value pairs providing object expiration information. The value of the rule-id is URL-encoded.

  • restore(Option<String>):

    Provides information about object restoration action and expiration time of the restored object copy.

  • last_modified(Option<DateTime>):

    Creation date of the object.

  • content_length(i64):

    Size of the body in bytes.

  • e_tag(Option<String>):

    An entity tag (ETag) is an opaque identifier assigned by a web server to a specific version of a resource found at a URL.

  • checksum_crc32(Option<String>):

    The base64-encoded, 32-bit CRC32 checksum of the object. This will only be present if it was uploaded with the object. With multipart uploads, this may not be a checksum value of the object. For more information about how checksums are calculated with multipart uploads, see Checking object integrity in the Amazon S3 User Guide.

  • checksum_crc32_c(Option<String>):

    The base64-encoded, 32-bit CRC32C checksum of the object. This will only be present if it was uploaded with the object. With multipart uploads, this may not be a checksum value of the object. For more information about how checksums are calculated with multipart uploads, see Checking object integrity in the Amazon S3 User Guide.

  • checksum_sha1(Option<String>):

    The base64-encoded, 160-bit SHA-1 digest of the object. This will only be present if it was uploaded with the object. With multipart uploads, this may not be a checksum value of the object. For more information about how checksums are calculated with multipart uploads, see Checking object integrity in the Amazon S3 User Guide.

  • checksum_sha256(Option<String>):

    The base64-encoded, 256-bit SHA-256 digest of the object. This will only be present if it was uploaded with the object. With multipart uploads, this may not be a checksum value of the object. For more information about how checksums are calculated with multipart uploads, see Checking object integrity in the Amazon S3 User Guide.

  • missing_meta(i32):

    This is set to the number of metadata entries not returned in x-amz-meta headers. This can happen if you create metadata using an API like SOAP that supports more flexible metadata than the REST API. For example, using SOAP, you can create metadata whose values are not legal HTTP headers.

  • version_id(Option<String>):

    Version of the object.

  • cache_control(Option<String>):

    Specifies caching behavior along the request/reply chain.

  • content_disposition(Option<String>):

    Specifies presentational information for the object.

  • content_encoding(Option<String>):

    Specifies what content encodings have been applied to the object and thus what decoding mechanisms must be applied to obtain the media-type referenced by the Content-Type header field.

  • content_language(Option<String>):

    The language the content is in.

  • content_range(Option<String>):

    The portion of the object returned in the response.

  • content_type(Option<String>):

    A standard MIME type describing the format of the object data.

  • expires(Option<DateTime>):

    The date and time at which the object is no longer cacheable.

  • website_redirect_location(Option<String>):

    If the bucket is configured as a website, redirects requests for this object to another object in the same bucket or to an external URL. Amazon S3 stores the value of this header in the object metadata.

  • server_side_encryption(Option<ServerSideEncryption>):

    The server-side encryption algorithm used when storing this object in Amazon S3 (for example, AES256, aws:kms, aws:kms:dsse).

  • metadata(Option<HashMap<String, String>>):

    A map of metadata to store with the object in S3.

  • sse_customer_algorithm(Option<String>):

    If server-side encryption with a customer-provided encryption key was requested, the response will include this header confirming the encryption algorithm used.

  • sse_customer_key_md5(Option<String>):

    If server-side encryption with a customer-provided encryption key was requested, the response will include this header to provide round-trip message integrity verification of the customer-provided encryption key.

  • ssekms_key_id(Option<String>):

    If present, specifies the ID of the Key Management Service (KMS) symmetric encryption customer managed key that was used for the object.

  • bucket_key_enabled(bool):

    Indicates whether the object uses an S3 Bucket Key for server-side encryption with Key Management Service (KMS) keys (SSE-KMS).

  • storage_class(Option<StorageClass>):

    Provides storage class information of the object. Amazon S3 returns this header for all objects except for S3 Standard storage class objects.

  • request_charged(Option<RequestCharged>):

    If present, indicates that the requester was successfully charged for the request.

  • replication_status(Option<ReplicationStatus>):

    Amazon S3 can return this if your request involves a bucket that is either a source or destination in a replication rule.

  • parts_count(i32):

    The count of parts this object has. This value is only returned if you specify partNumber in your request and the object was uploaded as a multipart upload.

  • tag_count(i32):

    The number of tags, if any, on the object.

  • object_lock_mode(Option<ObjectLockMode>):

    The Object Lock mode currently in place for this object.

  • object_lock_retain_until_date(Option<DateTime>):

    The date and time when this object’s Object Lock will expire.

  • object_lock_legal_hold_status(Option<ObjectLockLegalHoldStatus>):

    Indicates whether this object has an active legal hold. This field is only returned if you have permission to view an object’s legal hold status.

• On failure, responds with SdkError<GetObjectError>

impl Client

pub fn get_object_acl(&self) -> GetObjectAclFluentBuilder

Constructs a fluent builder for the GetObjectAcl operation.

• The fluent builder is configurable:
  • bucket(impl Into<String>) / set_bucket(Option<String>):

    The bucket name that contains the object for which to get the ACL information.

    When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using access points in the Amazon S3 User Guide.

  • key(impl Into<String>) / set_key(Option<String>):

    The key of the object for which to get the ACL information.

  • version_id(impl Into<String>) / set_version_id(Option<String>):

    VersionId used to reference a specific version of the object.

  • request_payer(RequestPayer) / set_request_payer(Option<RequestPayer>):

    Confirms that the requester knows that they will be charged for the request. Bucket owners need not specify this parameter in their requests. If either the source or destination Amazon S3 bucket has Requester Pays enabled, the requester will pay for corresponding charges to copy the object. For information about downloading objects from Requester Pays buckets, see Downloading Objects in Requester Pays Buckets in the Amazon S3 User Guide.

  • expected_bucket_owner(impl Into<String>) / set_expected_bucket_owner(Option<String>):

    The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code 403 Forbidden (access denied).

• On success, responds with GetObjectAclOutput with field(s):
  • owner(Option<Owner>):

    Container for the bucket owner’s display name and ID.

  • grants(Option<Vec<Grant>>):

    A list of grants.

  • request_charged(Option<RequestCharged>):

    If present, indicates that the requester was successfully charged for the request.

• On failure, responds with SdkError<GetObjectAclError>

impl Client

pub fn get_object_attributes(&self) -> GetObjectAttributesFluentBuilder

Constructs a fluent builder for the GetObjectAttributes operation.

• The fluent builder is configurable:
  • bucket(impl Into<String>) / set_bucket(Option<String>):

    The name of the bucket that contains the object.

    When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using access points in the Amazon S3 User Guide.

    When you use this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When you use this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts access point ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see What is S3 on Outposts? in the Amazon S3 User Guide.

  • key(impl Into<String>) / set_key(Option<String>):

    The object key.

  • version_id(impl Into<String>) / set_version_id(Option<String>):

    The version ID used to reference a specific version of the object.

  • max_parts(i32) / set_max_parts(Option<i32>):

    Sets the maximum number of parts to return.

  • part_number_marker(impl Into<String>) / set_part_number_marker(Option<String>):

    Specifies the part after which listing should begin. Only parts with higher part numbers will be listed.

  • sse_customer_algorithm(impl Into<String>) / set_sse_customer_algorithm(Option<String>):

    Specifies the algorithm to use when encrypting the object (for example, AES256).

  • sse_customer_key(impl Into<String>) / set_sse_customer_key(Option<String>):

    Specifies the customer-provided encryption key for Amazon S3 to use in encrypting data. This value is used to store the object and then it is discarded; Amazon S3 does not store the encryption key. The key must be appropriate for use with the algorithm specified in the x-amz-server-side-encryption-customer-algorithm header.

  • sse_customer_key_md5(impl Into<String>) / set_sse_customer_key_md5(Option<String>):

    Specifies the 128-bit MD5 digest of the encryption key according to RFC 1321. Amazon S3 uses this header for a message integrity check to ensure that the encryption key was transmitted without error.

  • request_payer(RequestPayer) / set_request_payer(Option<RequestPayer>):

    Confirms that the requester knows that they will be charged for the request. Bucket owners need not specify this parameter in their requests. If either the source or destination Amazon S3 bucket has Requester Pays enabled, the requester will pay for corresponding charges to copy the object. For information about downloading objects from Requester Pays buckets, see Downloading Objects in Requester Pays Buckets in the Amazon S3 User Guide.

  • expected_bucket_owner(impl Into<String>) / set_expected_bucket_owner(Option<String>):

    The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code 403 Forbidden (access denied).

  • object_attributes(ObjectAttributes) / set_object_attributes(Option<Vec<ObjectAttributes>>):

    Specifies the fields at the root level that you want returned in the response. Fields that you do not specify are not returned.

• On success, responds with GetObjectAttributesOutput with field(s):
  • delete_marker(bool):

    Specifies whether the object retrieved was (true) or was not (false) a delete marker. If false, this response header does not appear in the response.

  • last_modified(Option<DateTime>):

    The creation date of the object.

  • version_id(Option<String>):

    The version ID of the object.

  • request_charged(Option<RequestCharged>):

    If present, indicates that the requester was successfully charged for the request.

  • e_tag(Option<String>):

    An ETag is an opaque identifier assigned by a web server to a specific version of a resource found at a URL.

  • checksum(Option<Checksum>):

    The checksum or digest of the object.

  • object_parts(Option<GetObjectAttributesParts>):

    A collection of parts associated with a multipart upload.

  • storage_class(Option<StorageClass>):

    Provides the storage class information of the object. Amazon S3 returns this header for all objects except for S3 Standard storage class objects.

    For more information, see Storage Classes.

  • object_size(i64):

    The size of the object in bytes.

• On failure, responds with SdkError<GetObjectAttributesError>

impl Client

pub fn get_object_legal_hold(&self) -> GetObjectLegalHoldFluentBuilder

Constructs a fluent builder for the GetObjectLegalHold operation.

• The fluent builder is configurable:
  • bucket(impl Into<String>) / set_bucket(Option<String>):

    The bucket name containing the object whose legal hold status you want to retrieve.

    When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using access points in the Amazon S3 User Guide.

  • key(impl Into<String>) / set_key(Option<String>):

    The key name for the object whose legal hold status you want to retrieve.

  • version_id(impl Into<String>) / set_version_id(Option<String>):

    The version ID of the object whose legal hold status you want to retrieve.

  • request_payer(RequestPayer) / set_request_payer(Option<RequestPayer>):

    Confirms that the requester knows that they will be charged for the request. Bucket owners need not specify this parameter in their requests. If either the source or destination Amazon S3 bucket has Requester Pays enabled, the requester will pay for corresponding charges to copy the object. For information about downloading objects from Requester Pays buckets, see Downloading Objects in Requester Pays Buckets in the Amazon S3 User Guide.

  • expected_bucket_owner(impl Into<String>) / set_expected_bucket_owner(Option<String>):

    The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code 403 Forbidden (access denied).

• On success, responds with GetObjectLegalHoldOutput with field(s):
  • legal_hold(Option<ObjectLockLegalHold>):

    The current legal hold status for the specified object.

• On failure, responds with SdkError<GetObjectLegalHoldError>

impl Client

pub fn get_object_lock_configuration( &self ) -> GetObjectLockConfigurationFluentBuilder

Constructs a fluent builder for the GetObjectLockConfiguration operation.

• The fluent builder is configurable:
  • bucket(impl Into<String>) / set_bucket(Option<String>):

    The bucket whose Object Lock configuration you want to retrieve.

    When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using access points in the Amazon S3 User Guide.

  • expected_bucket_owner(impl Into<String>) / set_expected_bucket_owner(Option<String>):

    The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code 403 Forbidden (access denied).

• On success, responds with GetObjectLockConfigurationOutput with field(s):
  • object_lock_configuration(Option<ObjectLockConfiguration>):

    The specified bucket’s Object Lock configuration.

• On failure, responds with SdkError<GetObjectLockConfigurationError>

impl Client

pub fn get_object_retention(&self) -> GetObjectRetentionFluentBuilder

Constructs a fluent builder for the GetObjectRetention operation.

• The fluent builder is configurable:
  • bucket(impl Into<String>) / set_bucket(Option<String>):

    The bucket name containing the object whose retention settings you want to retrieve.

    When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using access points in the Amazon S3 User Guide.

  • key(impl Into<String>) / set_key(Option<String>):

    The key name for the object whose retention settings you want to retrieve.

  • version_id(impl Into<String>) / set_version_id(Option<String>):

    The version ID for the object whose retention settings you want to retrieve.

  • request_payer(RequestPayer) / set_request_payer(Option<RequestPayer>):

    Confirms that the requester knows that they will be charged for the request. Bucket owners need not specify this parameter in their requests. If either the source or destination Amazon S3 bucket has Requester Pays enabled, the requester will pay for corresponding charges to copy the object. For information about downloading objects from Requester Pays buckets, see Downloading Objects in Requester Pays Buckets in the Amazon S3 User Guide.

  • expected_bucket_owner(impl Into<String>) / set_expected_bucket_owner(Option<String>):

    The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code 403 Forbidden (access denied).

• On success, responds with GetObjectRetentionOutput with field(s):
  • retention(Option<ObjectLockRetention>):

    The container element for an object’s retention settings.

• On failure, responds with SdkError<GetObjectRetentionError>

impl Client

pub fn get_object_tagging(&self) -> GetObjectTaggingFluentBuilder

Constructs a fluent builder for the GetObjectTagging operation.

• The fluent builder is configurable:
  • bucket(impl Into<String>) / set_bucket(Option<String>):

    The bucket name containing the object for which to get the tagging information.

    When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using access points in the Amazon S3 User Guide.

    When you use this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When you use this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts access point ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see What is S3 on Outposts? in the Amazon S3 User Guide.

  • key(impl Into<String>) / set_key(Option<String>):

    Object key for which to get the tagging information.

  • version_id(impl Into<String>) / set_version_id(Option<String>):

    The versionId of the object for which to get the tagging information.

  • expected_bucket_owner(impl Into<String>) / set_expected_bucket_owner(Option<String>):

    The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code 403 Forbidden (access denied).

  • request_payer(RequestPayer) / set_request_payer(Option<RequestPayer>):

    Confirms that the requester knows that they will be charged for the request. Bucket owners need not specify this parameter in their requests. If either the source or destination Amazon S3 bucket has Requester Pays enabled, the requester will pay for corresponding charges to copy the object. For information about downloading objects from Requester Pays buckets, see Downloading Objects in Requester Pays Buckets in the Amazon S3 User Guide.

• On success, responds with GetObjectTaggingOutput with field(s):
  • version_id(Option<String>):

    The versionId of the object for which you got the tagging information.

  • tag_set(Option<Vec<Tag>>):

    Contains the tag set.

• On failure, responds with SdkError<GetObjectTaggingError>

impl Client

pub fn get_object_torrent(&self) -> GetObjectTorrentFluentBuilder

Constructs a fluent builder for the GetObjectTorrent operation.

• The fluent builder is configurable:
  • bucket(impl Into<String>) / set_bucket(Option<String>):

    The name of the bucket containing the object for which to get the torrent files.

  • key(impl Into<String>) / set_key(Option<String>):

    The object key for which to get the information.

  • request_payer(RequestPayer) / set_request_payer(Option<RequestPayer>):

    Confirms that the requester knows that they will be charged for the request. Bucket owners need not specify this parameter in their requests. If either the source or destination Amazon S3 bucket has Requester Pays enabled, the requester will pay for corresponding charges to copy the object. For information about downloading objects from Requester Pays buckets, see Downloading Objects in Requester Pays Buckets in the Amazon S3 User Guide.

  • expected_bucket_owner(impl Into<String>) / set_expected_bucket_owner(Option<String>):

    The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code 403 Forbidden (access denied).

• On success, responds with GetObjectTorrentOutput with field(s):
  • body(ByteStream):

    A Bencoded dictionary as defined by the BitTorrent specification

  • request_charged(Option<RequestCharged>):

    If present, indicates that the requester was successfully charged for the request.

• On failure, responds with SdkError<GetObjectTorrentError>

impl Client

pub fn get_public_access_block(&self) -> GetPublicAccessBlockFluentBuilder

Constructs a fluent builder for the GetPublicAccessBlock operation.

• The fluent builder is configurable:
  • bucket(impl Into<String>) / set_bucket(Option<String>):

    The name of the Amazon S3 bucket whose PublicAccessBlock configuration you want to retrieve.

  • expected_bucket_owner(impl Into<String>) / set_expected_bucket_owner(Option<String>):

    The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code 403 Forbidden (access denied).

• On success, responds with GetPublicAccessBlockOutput with field(s):
  • public_access_block_configuration(Option<PublicAccessBlockConfiguration>):

    The PublicAccessBlock configuration currently in effect for this Amazon S3 bucket.

• On failure, responds with SdkError<GetPublicAccessBlockError>

impl Client

pub fn head_bucket(&self) -> HeadBucketFluentBuilder

Constructs a fluent builder for the HeadBucket operation.

• The fluent builder is configurable:
  • bucket(impl Into<String>) / set_bucket(Option<String>):

    The bucket name.

    When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using access points in the Amazon S3 User Guide.

    When you use this action with an Object Lambda access point, provide the alias of the Object Lambda access point in place of the bucket name. If the Object Lambda access point alias in a request is not valid, the error code InvalidAccessPointAliasError is returned. For more information about InvalidAccessPointAliasError, see List of Error Codes.

    When you use this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When you use this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts access point ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see What is S3 on Outposts? in the Amazon S3 User Guide.

  • expected_bucket_owner(impl Into<String>) / set_expected_bucket_owner(Option<String>):

    The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code 403 Forbidden (access denied).

• On success, responds with HeadBucketOutput
• On failure, responds with SdkError<HeadBucketError>

impl Client

pub fn head_object(&self) -> HeadObjectFluentBuilder

Constructs a fluent builder for the HeadObject operation.

• The fluent builder is configurable:
  • bucket(impl Into<String>) / set_bucket(Option<String>):

    The name of the bucket containing the object.

    When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using access points in the Amazon S3 User Guide.

    When you use this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When you use this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts access point ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see What is S3 on Outposts? in the Amazon S3 User Guide.

  • if_match(impl Into<String>) / set_if_match(Option<String>):

    Return the object only if its entity tag (ETag) is the same as the one specified; otherwise, return a 412 (precondition failed) error.

  • if_modified_since(DateTime) / set_if_modified_since(Option<DateTime>):

    Return the object only if it has been modified since the specified time; otherwise, return a 304 (not modified) error.

  • if_none_match(impl Into<String>) / set_if_none_match(Option<String>):

    Return the object only if its entity tag (ETag) is different from the one specified; otherwise, return a 304 (not modified) error.

  • if_unmodified_since(DateTime) / set_if_unmodified_since(Option<DateTime>):

    Return the object only if it has not been modified since the specified time; otherwise, return a 412 (precondition failed) error.

  • key(impl Into<String>) / set_key(Option<String>):

    The object key.

  • range(impl Into<String>) / set_range(Option<String>):

    HeadObject returns only the metadata for an object. If the Range is satisfiable, only the ContentLength is affected in the response. If the Range is not satisfiable, S3 returns a 416 - Requested Range Not Satisfiable error.

  • version_id(impl Into<String>) / set_version_id(Option<String>):

    VersionId used to reference a specific version of the object.

  • sse_customer_algorithm(impl Into<String>) / set_sse_customer_algorithm(Option<String>):

    Specifies the algorithm to use to when encrypting the object (for example, AES256).

  • sse_customer_key(impl Into<String>) / set_sse_customer_key(Option<String>):

    Specifies the customer-provided encryption key for Amazon S3 to use in encrypting data. This value is used to store the object and then it is discarded; Amazon S3 does not store the encryption key. The key must be appropriate for use with the algorithm specified in the x-amz-server-side-encryption-customer-algorithm header.

  • sse_customer_key_md5(impl Into<String>) / set_sse_customer_key_md5(Option<String>):

    Specifies the 128-bit MD5 digest of the encryption key according to RFC 1321. Amazon S3 uses this header for a message integrity check to ensure that the encryption key was transmitted without error.

  • request_payer(RequestPayer) / set_request_payer(Option<RequestPayer>):

    Confirms that the requester knows that they will be charged for the request. Bucket owners need not specify this parameter in their requests. If either the source or destination Amazon S3 bucket has Requester Pays enabled, the requester will pay for corresponding charges to copy the object. For information about downloading objects from Requester Pays buckets, see Downloading Objects in Requester Pays Buckets in the Amazon S3 User Guide.

  • part_number(i32) / set_part_number(Option<i32>):

    Part number of the object being read. This is a positive integer between 1 and 10,000. Effectively performs a ‘ranged’ HEAD request for the part specified. Useful querying about the size of the part and the number of parts in this object.

  • expected_bucket_owner(impl Into<String>) / set_expected_bucket_owner(Option<String>):

    The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code 403 Forbidden (access denied).

  • checksum_mode(ChecksumMode) / set_checksum_mode(Option<ChecksumMode>):

    To retrieve the checksum, this parameter must be enabled.

    In addition, if you enable ChecksumMode and the object is encrypted with Amazon Web Services Key Management Service (Amazon Web Services KMS), you must have permission to use the kms:Decrypt action for the request to succeed.

• On success, responds with HeadObjectOutput with field(s):
  • delete_marker(bool):

    Specifies whether the object retrieved was (true) or was not (false) a Delete Marker. If false, this response header does not appear in the response.

  • accept_ranges(Option<String>):

    Indicates that a range of bytes was specified.

  • expiration(Option<String>):

    If the object expiration is configured (see PUT Bucket lifecycle), the response includes this header. It includes the expiry-date and rule-id key-value pairs providing object expiration information. The value of the rule-id is URL-encoded.

  • restore(Option<String>):

    If the object is an archived object (an object whose storage class is GLACIER), the response includes this header if either the archive restoration is in progress (see RestoreObject or an archive copy is already restored.

    If an archive copy is already restored, the header value indicates when Amazon S3 is scheduled to delete the object copy. For example:

    x-amz-restore: ongoing-request=“false”, expiry-date=“Fri, 21 Dec 2012 00:00:00 GMT”

    If the object restoration is in progress, the header returns the value ongoing-request=“true”.

    For more information about archiving objects, see Transitioning Objects: General Considerations.

  • archive_status(Option<ArchiveStatus>):

    The archive state of the head object.

  • last_modified(Option<DateTime>):

    Creation date of the object.

  • content_length(i64):

    Size of the body in bytes.

  • checksum_crc32(Option<String>):

    The base64-encoded, 32-bit CRC32 checksum of the object. This will only be present if it was uploaded with the object. With multipart uploads, this may not be a checksum value of the object. For more information about how checksums are calculated with multipart uploads, see Checking object integrity in the Amazon S3 User Guide.

  • checksum_crc32_c(Option<String>):

    The base64-encoded, 32-bit CRC32C checksum of the object. This will only be present if it was uploaded with the object. With multipart uploads, this may not be a checksum value of the object. For more information about how checksums are calculated with multipart uploads, see Checking object integrity in the Amazon S3 User Guide.

  • checksum_sha1(Option<String>):

    The base64-encoded, 160-bit SHA-1 digest of the object. This will only be present if it was uploaded with the object. With multipart uploads, this may not be a checksum value of the object. For more information about how checksums are calculated with multipart uploads, see Checking object integrity in the Amazon S3 User Guide.

  • checksum_sha256(Option<String>):

    The base64-encoded, 256-bit SHA-256 digest of the object. This will only be present if it was uploaded with the object. With multipart uploads, this may not be a checksum value of the object. For more information about how checksums are calculated with multipart uploads, see Checking object integrity in the Amazon S3 User Guide.

  • e_tag(Option<String>):

    An entity tag (ETag) is an opaque identifier assigned by a web server to a specific version of a resource found at a URL.

  • missing_meta(i32):

    This is set to the number of metadata entries not returned in x-amz-meta headers. This can happen if you create metadata using an API like SOAP that supports more flexible metadata than the REST API. For example, using SOAP, you can create metadata whose values are not legal HTTP headers.

  • version_id(Option<String>):

    Version of the object.

  • cache_control(Option<String>):

    Specifies caching behavior along the request/reply chain.

  • content_disposition(Option<String>):

    Specifies presentational information for the object.

  • content_encoding(Option<String>):

    Specifies what content encodings have been applied to the object and thus what decoding mechanisms must be applied to obtain the media-type referenced by the Content-Type header field.

  • content_language(Option<String>):

    The language the content is in.

  • content_type(Option<String>):

    A standard MIME type describing the format of the object data.

  • expires(Option<DateTime>):

    The date and time at which the object is no longer cacheable.

  • website_redirect_location(Option<String>):

    If the bucket is configured as a website, redirects requests for this object to another object in the same bucket or to an external URL. Amazon S3 stores the value of this header in the object metadata.

  • server_side_encryption(Option<ServerSideEncryption>):

    The server-side encryption algorithm used when storing this object in Amazon S3 (for example, AES256, aws:kms, aws:kms:dsse).

  • metadata(Option<HashMap<String, String>>):

    A map of metadata to store with the object in S3.

  • sse_customer_algorithm(Option<String>):

    If server-side encryption with a customer-provided encryption key was requested, the response will include this header confirming the encryption algorithm used.

  • sse_customer_key_md5(Option<String>):

    If server-side encryption with a customer-provided encryption key was requested, the response will include this header to provide round-trip message integrity verification of the customer-provided encryption key.

  • ssekms_key_id(Option<String>):

    If present, specifies the ID of the Key Management Service (KMS) symmetric encryption customer managed key that was used for the object.

  • bucket_key_enabled(bool):

    Indicates whether the object uses an S3 Bucket Key for server-side encryption with Key Management Service (KMS) keys (SSE-KMS).

  • storage_class(Option<StorageClass>):

    Provides storage class information of the object. Amazon S3 returns this header for all objects except for S3 Standard storage class objects.

    For more information, see Storage Classes.

  • request_charged(Option<RequestCharged>):

    If present, indicates that the requester was successfully charged for the request.

  • replication_status(Option<ReplicationStatus>):

    Amazon S3 can return this header if your request involves a bucket that is either a source or a destination in a replication rule.

    In replication, you have a source bucket on which you configure replication and destination bucket or buckets where Amazon S3 stores object replicas. When you request an object (GetObject) or object metadata (HeadObject) from these buckets, Amazon S3 will return the x-amz-replication-status header in the response as follows:

    • If requesting an object from the source bucket, Amazon S3 will return the x-amz-replication-status header if the object in your request is eligible for replication.

      For example, suppose that in your replication configuration, you specify object prefix TaxDocs requesting Amazon S3 to replicate objects with key prefix TaxDocs. Any objects you upload with this key name prefix, for example TaxDocs/document1.pdf, are eligible for replication. For any object request with this key name prefix, Amazon S3 will return the x-amz-replication-status header with value PENDING, COMPLETED or FAILED indicating object replication status.

    • If requesting an object from a destination bucket, Amazon S3 will return the x-amz-replication-status header with value REPLICA if the object in your request is a replica that Amazon S3 created and there is no replica modification replication in progress.

    • When replicating objects to multiple destination buckets, the x-amz-replication-status header acts differently. The header of the source object will only return a value of COMPLETED when replication is successful to all destinations. The header will remain at value PENDING until replication has completed for all destinations. If one or more destinations fails replication the header will return FAILED.

    For more information, see Replication.

  • parts_count(i32):

    The count of parts this object has. This value is only returned if you specify partNumber in your request and the object was uploaded as a multipart upload.

  • object_lock_mode(Option<ObjectLockMode>):

    The Object Lock mode, if any, that’s in effect for this object. This header is only returned if the requester has the s3:GetObjectRetention permission. For more information about S3 Object Lock, see Object Lock.

  • object_lock_retain_until_date(Option<DateTime>):

    The date and time when the Object Lock retention period expires. This header is only returned if the requester has the s3:GetObjectRetention permission.

  • object_lock_legal_hold_status(Option<ObjectLockLegalHoldStatus>):

    Specifies whether a legal hold is in effect for this object. This header is only returned if the requester has the s3:GetObjectLegalHold permission. This header is not returned if the specified version of this object has never had a legal hold applied. For more information about S3 Object Lock, see Object Lock.

• On failure, responds with SdkError<HeadObjectError>

impl Client

pub fn list_bucket_analytics_configurations( &self ) -> ListBucketAnalyticsConfigurationsFluentBuilder

Constructs a fluent builder for the ListBucketAnalyticsConfigurations operation.

• The fluent builder is configurable:
  • bucket(impl Into<String>) / set_bucket(Option<String>):

    The name of the bucket from which analytics configurations are retrieved.

  • continuation_token(impl Into<String>) / set_continuation_token(Option<String>):

    The ContinuationToken that represents a placeholder from where this request should begin.

  • expected_bucket_owner(impl Into<String>) / set_expected_bucket_owner(Option<String>):

    The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code 403 Forbidden (access denied).

• On success, responds with ListBucketAnalyticsConfigurationsOutput with field(s):
  • is_truncated(bool):

    Indicates whether the returned list of analytics configurations is complete. A value of true indicates that the list is not complete and the NextContinuationToken will be provided for a subsequent request.

  • continuation_token(Option<String>):

    The marker that is used as a starting point for this analytics configuration list response. This value is present if it was sent in the request.

  • next_continuation_token(Option<String>):

    NextContinuationToken is sent when isTruncated is true, which indicates that there are more analytics configurations to list. The next request must include this NextContinuationToken. The token is obfuscated and is not a usable value.

  • analytics_configuration_list(Option<Vec<AnalyticsConfiguration>>):

    The list of analytics configurations for a bucket.

• On failure, responds with SdkError<ListBucketAnalyticsConfigurationsError>

impl Client

pub fn list_bucket_intelligent_tiering_configurations( &self ) -> ListBucketIntelligentTieringConfigurationsFluentBuilder

Constructs a fluent builder for the ListBucketIntelligentTieringConfigurations operation.

• The fluent builder is configurable:
  • bucket(impl Into<String>) / set_bucket(Option<String>):

    The name of the Amazon S3 bucket whose configuration you want to modify or retrieve.

  • continuation_token(impl Into<String>) / set_continuation_token(Option<String>):

    The ContinuationToken that represents a placeholder from where this request should begin.

• On success, responds with ListBucketIntelligentTieringConfigurationsOutput with field(s):
  • is_truncated(bool):

    Indicates whether the returned list of analytics configurations is complete. A value of true indicates that the list is not complete and the NextContinuationToken will be provided for a subsequent request.

  • continuation_token(Option<String>):

    The ContinuationToken that represents a placeholder from where this request should begin.

  • next_continuation_token(Option<String>):

    The marker used to continue this inventory configuration listing. Use the NextContinuationToken from this response to continue the listing in a subsequent request. The continuation token is an opaque value that Amazon S3 understands.

  • intelligent_tiering_configuration_list(Option<Vec<IntelligentTieringConfiguration>>):

    The list of S3 Intelligent-Tiering configurations for a bucket.

• On failure, responds with SdkError<ListBucketIntelligentTieringConfigurationsError>

impl Client

pub fn list_bucket_inventory_configurations( &self ) -> ListBucketInventoryConfigurationsFluentBuilder

Constructs a fluent builder for the ListBucketInventoryConfigurations operation.

• The fluent builder is configurable:
  • bucket(impl Into<String>) / set_bucket(Option<String>):

    The name of the bucket containing the inventory configurations to retrieve.

  • continuation_token(impl Into<String>) / set_continuation_token(Option<String>):

    The marker used to continue an inventory configuration listing that has been truncated. Use the NextContinuationToken from a previously truncated list response to continue the listing. The continuation token is an opaque value that Amazon S3 understands.

  • expected_bucket_owner(impl Into<String>) / set_expected_bucket_owner(Option<String>):

    The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code 403 Forbidden (access denied).

• On success, responds with ListBucketInventoryConfigurationsOutput with field(s):
  • continuation_token(Option<String>):

    If sent in the request, the marker that is used as a starting point for this inventory configuration list response.

  • inventory_configuration_list(Option<Vec<InventoryConfiguration>>):

    The list of inventory configurations for a bucket.

  • is_truncated(bool):

    Tells whether the returned list of inventory configurations is complete. A value of true indicates that the list is not complete and the NextContinuationToken is provided for a subsequent request.

  • next_continuation_token(Option<String>):

    The marker used to continue this inventory configuration listing. Use the NextContinuationToken from this response to continue the listing in a subsequent request. The continuation token is an opaque value that Amazon S3 understands.

• On failure, responds with SdkError<ListBucketInventoryConfigurationsError>

impl Client

pub fn list_bucket_metrics_configurations( &self ) -> ListBucketMetricsConfigurationsFluentBuilder

Constructs a fluent builder for the ListBucketMetricsConfigurations operation.

• The fluent builder is configurable:
  • bucket(impl Into<String>) / set_bucket(Option<String>):

    The name of the bucket containing the metrics configurations to retrieve.

  • continuation_token(impl Into<String>) / set_continuation_token(Option<String>):

    The marker that is used to continue a metrics configuration listing that has been truncated. Use the NextContinuationToken from a previously truncated list response to continue the listing. The continuation token is an opaque value that Amazon S3 understands.

  • expected_bucket_owner(impl Into<String>) / set_expected_bucket_owner(Option<String>):

    The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code 403 Forbidden (access denied).

• On success, responds with ListBucketMetricsConfigurationsOutput with field(s):
  • is_truncated(bool):

    Indicates whether the returned list of metrics configurations is complete. A value of true indicates that the list is not complete and the NextContinuationToken will be provided for a subsequent request.

  • continuation_token(Option<String>):

    The marker that is used as a starting point for this metrics configuration list response. This value is present if it was sent in the request.

  • next_continuation_token(Option<String>):

    The marker used to continue a metrics configuration listing that has been truncated. Use the NextContinuationToken from a previously truncated list response to continue the listing. The continuation token is an opaque value that Amazon S3 understands.

  • metrics_configuration_list(Option<Vec<MetricsConfiguration>>):

    The list of metrics configurations for a bucket.

• On failure, responds with SdkError<ListBucketMetricsConfigurationsError>

impl Client

pub fn list_buckets(&self) -> ListBucketsFluentBuilder

Constructs a fluent builder for the ListBuckets operation.

• The fluent builder takes no input, just send it.
• On success, responds with ListBucketsOutput with field(s):
  • buckets(Option<Vec<Bucket>>):

    The list of buckets owned by the requester.

  • owner(Option<Owner>):

    The owner of the buckets listed.

• On failure, responds with SdkError<ListBucketsError>

impl Client

pub fn list_multipart_uploads(&self) -> ListMultipartUploadsFluentBuilder

Constructs a fluent builder for the ListMultipartUploads operation.

• The fluent builder is configurable:
  • bucket(impl Into<String>) / set_bucket(Option<String>):

    The name of the bucket to which the multipart upload was initiated.

    When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using access points in the Amazon S3 User Guide.

    When you use this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When you use this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts access point ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see What is S3 on Outposts? in the Amazon S3 User Guide.

  • delimiter(impl Into<String>) / set_delimiter(Option<String>):

    Character you use to group keys.

    All keys that contain the same string between the prefix, if specified, and the first occurrence of the delimiter after the prefix are grouped under a single result element, CommonPrefixes. If you don’t specify the prefix parameter, then the substring starts at the beginning of the key. The keys that are grouped under CommonPrefixes result element are not returned elsewhere in the response.

  • encoding_type(EncodingType) / set_encoding_type(Option<EncodingType>):

    Requests Amazon S3 to encode the object keys in the response and specifies the encoding method to use. An object key can contain any Unicode character; however, the XML 1.0 parser cannot parse some characters, such as characters with an ASCII value from 0 to 10. For characters that are not supported in XML 1.0, you can add this parameter to request that Amazon S3 encode the keys in the response.

  • key_marker(impl Into<String>) / set_key_marker(Option<String>):

    Together with upload-id-marker, this parameter specifies the multipart upload after which listing should begin.

    If upload-id-marker is not specified, only the keys lexicographically greater than the specified key-marker will be included in the list.

    If upload-id-marker is specified, any multipart uploads for a key equal to the key-marker might also be included, provided those multipart uploads have upload IDs lexicographically greater than the specified upload-id-marker.

  • max_uploads(i32) / set_max_uploads(Option<i32>):

    Sets the maximum number of multipart uploads, from 1 to 1,000, to return in the response body. 1,000 is the maximum number of uploads that can be returned in a response.

  • prefix(impl Into<String>) / set_prefix(Option<String>):

    Lists in-progress uploads only for those keys that begin with the specified prefix. You can use prefixes to separate a bucket into different grouping of keys. (You can think of using prefix to make groups in the same way that you’d use a folder in a file system.)

  • upload_id_marker(impl Into<String>) / set_upload_id_marker(Option<String>):

    Together with key-marker, specifies the multipart upload after which listing should begin. If key-marker is not specified, the upload-id-marker parameter is ignored. Otherwise, any multipart uploads for a key equal to the key-marker might be included in the list only if they have an upload ID lexicographically greater than the specified upload-id-marker.

  • expected_bucket_owner(impl Into<String>) / set_expected_bucket_owner(Option<String>):

    The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code 403 Forbidden (access denied).

  • request_payer(RequestPayer) / set_request_payer(Option<RequestPayer>):

    Confirms that the requester knows that they will be charged for the request. Bucket owners need not specify this parameter in their requests. If either the source or destination Amazon S3 bucket has Requester Pays enabled, the requester will pay for corresponding charges to copy the object. For information about downloading objects from Requester Pays buckets, see Downloading Objects in Requester Pays Buckets in the Amazon S3 User Guide.

• On success, responds with ListMultipartUploadsOutput with field(s):
  • bucket(Option<String>):

    The name of the bucket to which the multipart upload was initiated. Does not return the access point ARN or access point alias if used.

  • key_marker(Option<String>):

    The key at or after which the listing began.

  • upload_id_marker(Option<String>):

    Upload ID after which listing began.

  • next_key_marker(Option<String>):

    When a list is truncated, this element specifies the value that should be used for the key-marker request parameter in a subsequent request.

  • prefix(Option<String>):

    When a prefix is provided in the request, this field contains the specified prefix. The result contains only keys starting with the specified prefix.

  • delimiter(Option<String>):

    Contains the delimiter you specified in the request. If you don’t specify a delimiter in your request, this element is absent from the response.

  • next_upload_id_marker(Option<String>):

    When a list is truncated, this element specifies the value that should be used for the upload-id-marker request parameter in a subsequent request.

  • max_uploads(i32):

    Maximum number of multipart uploads that could have been included in the response.

  • is_truncated(bool):

    Indicates whether the returned list of multipart uploads is truncated. A value of true indicates that the list was truncated. The list can be truncated if the number of multipart uploads exceeds the limit allowed or specified by max uploads.

  • uploads(Option<Vec<MultipartUpload>>):

    Container for elements related to a particular multipart upload. A response can contain zero or more Upload elements.

  • common_prefixes(Option<Vec<CommonPrefix>>):

    If you specify a delimiter in the request, then the result returns each distinct key prefix containing the delimiter in a CommonPrefixes element. The distinct key prefixes are returned in the Prefix child element.

  • encoding_type(Option<EncodingType>):

    Encoding type used by Amazon S3 to encode object keys in the response.

    If you specify the encoding-type request parameter, Amazon S3 includes this element in the response, and returns encoded key name values in the following response elements:

    Delimiter, KeyMarker, Prefix, NextKeyMarker, Key.

  • request_charged(Option<RequestCharged>):

    If present, indicates that the requester was successfully charged for the request.

• On failure, responds with SdkError<ListMultipartUploadsError>

impl Client

pub fn list_object_versions(&self) -> ListObjectVersionsFluentBuilder

Constructs a fluent builder for the ListObjectVersions operation.

• The fluent builder is configurable:
  • bucket(impl Into<String>) / set_bucket(Option<String>):

    The bucket name that contains the objects.

  • delimiter(impl Into<String>) / set_delimiter(Option<String>):

    A delimiter is a character that you specify to group keys. All keys that contain the same string between the prefix and the first occurrence of the delimiter are grouped under a single result element in CommonPrefixes. These groups are counted as one result against the max-keys limitation. These keys are not returned elsewhere in the response.

  • encoding_type(EncodingType) / set_encoding_type(Option<EncodingType>):

    Requests Amazon S3 to encode the object keys in the response and specifies the encoding method to use. An object key can contain any Unicode character; however, the XML 1.0 parser cannot parse some characters, such as characters with an ASCII value from 0 to 10. For characters that are not supported in XML 1.0, you can add this parameter to request that Amazon S3 encode the keys in the response.

  • key_marker(impl Into<String>) / set_key_marker(Option<String>):

    Specifies the key to start with when listing objects in a bucket.

  • max_keys(i32) / set_max_keys(Option<i32>):

    Sets the maximum number of keys returned in the response. By default, the action returns up to 1,000 key names. The response might contain fewer keys but will never contain more. If additional keys satisfy the search criteria, but were not returned because max-keys was exceeded, the response contains true . To return the additional keys, see key-marker and version-id-marker.

  • prefix(impl Into<String>) / set_prefix(Option<String>):

    Use this parameter to select only those keys that begin with the specified prefix. You can use prefixes to separate a bucket into different groupings of keys. (You can think of using prefix to make groups in the same way that you’d use a folder in a file system.) You can use prefix with delimiter to roll up numerous objects into a single result under CommonPrefixes.

  • version_id_marker(impl Into<String>) / set_version_id_marker(Option<String>):

    Specifies the object version you want to start listing from.

  • expected_bucket_owner(impl Into<String>) / set_expected_bucket_owner(Option<String>):

    The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code 403 Forbidden (access denied).

  • request_payer(RequestPayer) / set_request_payer(Option<RequestPayer>):

    Confirms that the requester knows that they will be charged for the request. Bucket owners need not specify this parameter in their requests. If either the source or destination Amazon S3 bucket has Requester Pays enabled, the requester will pay for corresponding charges to copy the object. For information about downloading objects from Requester Pays buckets, see Downloading Objects in Requester Pays Buckets in the Amazon S3 User Guide.

  • optional_object_attributes(OptionalObjectAttributes) / set_optional_object_attributes(Option<Vec<OptionalObjectAttributes>>):

    Specifies the optional fields that you want returned in the response. Fields that you do not specify are not returned.

• On success, responds with ListObjectVersionsOutput with field(s):
  • is_truncated(bool):

    A flag that indicates whether Amazon S3 returned all of the results that satisfied the search criteria. If your results were truncated, you can make a follow-up paginated request by using the NextKeyMarker and NextVersionIdMarker response parameters as a starting place in another request to return the rest of the results.

  • key_marker(Option<String>):

    Marks the last key returned in a truncated response.

  • version_id_marker(Option<String>):

    Marks the last version of the key returned in a truncated response.

  • next_key_marker(Option<String>):

    When the number of responses exceeds the value of MaxKeys, NextKeyMarker specifies the first key not returned that satisfies the search criteria. Use this value for the key-marker request parameter in a subsequent request.

  • next_version_id_marker(Option<String>):

    When the number of responses exceeds the value of MaxKeys, NextVersionIdMarker specifies the first object version not returned that satisfies the search criteria. Use this value for the version-id-marker request parameter in a subsequent request.

  • versions(Option<Vec<ObjectVersion>>):

    Container for version information.

  • delete_markers(Option<Vec<DeleteMarkerEntry>>):

    Container for an object that is a delete marker.

  • name(Option<String>):

    The bucket name.

  • prefix(Option<String>):

    Selects objects that start with the value supplied by this parameter.

  • delimiter(Option<String>):

    The delimiter grouping the included keys. A delimiter is a character that you specify to group keys. All keys that contain the same string between the prefix and the first occurrence of the delimiter are grouped under a single result element in CommonPrefixes. These groups are counted as one result against the max-keys limitation. These keys are not returned elsewhere in the response.

  • max_keys(i32):

    Specifies the maximum number of objects to return.

  • common_prefixes(Option<Vec<CommonPrefix>>):

    All of the keys rolled up into a common prefix count as a single return when calculating the number of returns.

  • encoding_type(Option<EncodingType>):

    Encoding type used by Amazon S3 to encode object key names in the XML response.

    If you specify the encoding-type request parameter, Amazon S3 includes this element in the response, and returns encoded key name values in the following response elements:

    KeyMarker, NextKeyMarker, Prefix, Key, and Delimiter.

  • request_charged(Option<RequestCharged>):

    If present, indicates that the requester was successfully charged for the request.

• On failure, responds with SdkError<ListObjectVersionsError>

impl Client

pub fn list_objects(&self) -> ListObjectsFluentBuilder

Constructs a fluent builder for the ListObjects operation.

• The fluent builder is configurable:
  • bucket(impl Into<String>) / set_bucket(Option<String>):

    The name of the bucket containing the objects.

    When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using access points in the Amazon S3 User Guide.

    When you use this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When you use this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts access point ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see What is S3 on Outposts? in the Amazon S3 User Guide.

  • delimiter(impl Into<String>) / set_delimiter(Option<String>):

    A delimiter is a character that you use to group keys.

  • encoding_type(EncodingType) / set_encoding_type(Option<EncodingType>):

    Requests Amazon S3 to encode the object keys in the response and specifies the encoding method to use. An object key can contain any Unicode character; however, the XML 1.0 parser cannot parse some characters, such as characters with an ASCII value from 0 to 10. For characters that are not supported in XML 1.0, you can add this parameter to request that Amazon S3 encode the keys in the response.

  • marker(impl Into<String>) / set_marker(Option<String>):

    Marker is where you want Amazon S3 to start listing from. Amazon S3 starts listing after this specified key. Marker can be any key in the bucket.

  • max_keys(i32) / set_max_keys(Option<i32>):

    Sets the maximum number of keys returned in the response. By default, the action returns up to 1,000 key names. The response might contain fewer keys but will never contain more.

  • prefix(impl Into<String>) / set_prefix(Option<String>):

    Limits the response to keys that begin with the specified prefix.

  • request_payer(RequestPayer) / set_request_payer(Option<RequestPayer>):

    Confirms that the requester knows that she or he will be charged for the list objects request. Bucket owners need not specify this parameter in their requests.

  • expected_bucket_owner(impl Into<String>) / set_expected_bucket_owner(Option<String>):

    The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code 403 Forbidden (access denied).

  • optional_object_attributes(OptionalObjectAttributes) / set_optional_object_attributes(Option<Vec<OptionalObjectAttributes>>):

    Specifies the optional fields that you want returned in the response. Fields that you do not specify are not returned.

• On success, responds with ListObjectsOutput with field(s):
  • is_truncated(bool):

    A flag that indicates whether Amazon S3 returned all of the results that satisfied the search criteria.

  • marker(Option<String>):

    Indicates where in the bucket listing begins. Marker is included in the response if it was sent with the request.

  • next_marker(Option<String>):

    When the response is truncated (the IsTruncated element value in the response is true), you can use the key name in this field as the marker parameter in the subsequent request to get the next set of objects. Amazon S3 lists objects in alphabetical order.

    This element is returned only if you have the delimiter request parameter specified. If the response does not include the NextMarker element and it is truncated, you can use the value of the last Key element in the response as the marker parameter in the subsequent request to get the next set of object keys.

  • contents(Option<Vec<Object>>):

    Metadata about each object returned.

  • name(Option<String>):

    The bucket name.

  • prefix(Option<String>):

    Keys that begin with the indicated prefix.

  • delimiter(Option<String>):

    Causes keys that contain the same string between the prefix and the first occurrence of the delimiter to be rolled up into a single result element in the CommonPrefixes collection. These rolled-up keys are not returned elsewhere in the response. Each rolled-up result counts as only one return against the MaxKeys value.

  • max_keys(i32):

    The maximum number of keys returned in the response body.

  • common_prefixes(Option<Vec<CommonPrefix>>):

    All of the keys (up to 1,000) rolled up in a common prefix count as a single return when calculating the number of returns.

    A response can contain CommonPrefixes only if you specify a delimiter.

    CommonPrefixes contains all (if there are any) keys between Prefix and the next occurrence of the string specified by the delimiter.

    CommonPrefixes lists keys that act like subdirectories in the directory specified by Prefix.

    For example, if the prefix is notes/ and the delimiter is a slash (/), as in notes/summer/july, the common prefix is notes/summer/. All of the keys that roll up into a common prefix count as a single return when calculating the number of returns.

  • encoding_type(Option<EncodingType>):

    Encoding type used by Amazon S3 to encode object keys in the response.

  • request_charged(Option<RequestCharged>):

    If present, indicates that the requester was successfully charged for the request.

• On failure, responds with SdkError<ListObjectsError>

impl Client

pub fn list_objects_v2(&self) -> ListObjectsV2FluentBuilder

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

• The fluent builder is configurable:
  • bucket(impl Into<String>) / set_bucket(Option<String>):

    Bucket name to list.

    When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using access points in the Amazon S3 User Guide.

    When you use this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When you use this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts access point ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see What is S3 on Outposts? in the Amazon S3 User Guide.

  • delimiter(impl Into<String>) / set_delimiter(Option<String>):

    A delimiter is a character that you use to group keys.

  • encoding_type(EncodingType) / set_encoding_type(Option<EncodingType>):

    Encoding type used by Amazon S3 to encode object keys in the response.

  • max_keys(i32) / set_max_keys(Option<i32>):

    Sets the maximum number of keys returned in the response. By default, the action returns up to 1,000 key names. The response might contain fewer keys but will never contain more.

  • prefix(impl Into<String>) / set_prefix(Option<String>):

    Limits the response to keys that begin with the specified prefix.

  • continuation_token(impl Into<String>) / set_continuation_token(Option<String>):

    ContinuationToken indicates to Amazon S3 that the list is being continued on this bucket with a token. ContinuationToken is obfuscated and is not a real key.

  • fetch_owner(bool) / set_fetch_owner(Option<bool>):

    The owner field is not present in ListObjectsV2 by default. If you want to return the owner field with each key in the result, then set the FetchOwner field to true.

  • start_after(impl Into<String>) / set_start_after(Option<String>):

    StartAfter is where you want Amazon S3 to start listing from. Amazon S3 starts listing after this specified key. StartAfter can be any key in the bucket.

  • request_payer(RequestPayer) / set_request_payer(Option<RequestPayer>):

    Confirms that the requester knows that she or he will be charged for the list objects request in V2 style. Bucket owners need not specify this parameter in their requests.

  • expected_bucket_owner(impl Into<String>) / set_expected_bucket_owner(Option<String>):

    The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code 403 Forbidden (access denied).

  • optional_object_attributes(OptionalObjectAttributes) / set_optional_object_attributes(Option<Vec<OptionalObjectAttributes>>):

    Specifies the optional fields that you want returned in the response. Fields that you do not specify are not returned.

• On success, responds with ListObjectsV2Output with field(s):
  • is_truncated(bool):

    Set to false if all of the results were returned. Set to true if more keys are available to return. If the number of results exceeds that specified by MaxKeys, all of the results might not be returned.

  • contents(Option<Vec<Object>>):

    Metadata about each object returned.

  • name(Option<String>):

    The bucket name.

    When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using access points in the Amazon S3 User Guide.

    When you use this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When you use this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts access point ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see What is S3 on Outposts? in the Amazon S3 User Guide.

  • prefix(Option<String>):

    Keys that begin with the indicated prefix.

  • delimiter(Option<String>):

    Causes keys that contain the same string between the prefix and the first occurrence of the delimiter to be rolled up into a single result element in the CommonPrefixes collection. These rolled-up keys are not returned elsewhere in the response. Each rolled-up result counts as only one return against the MaxKeys value.

  • max_keys(i32):

    Sets the maximum number of keys returned in the response. By default, the action returns up to 1,000 key names. The response might contain fewer keys but will never contain more.

  • common_prefixes(Option<Vec<CommonPrefix>>):

    All of the keys (up to 1,000) rolled up into a common prefix count as a single return when calculating the number of returns.

    A response can contain CommonPrefixes only if you specify a delimiter.

    CommonPrefixes contains all (if there are any) keys between Prefix and the next occurrence of the string specified by a delimiter.

    CommonPrefixes lists keys that act like subdirectories in the directory specified by Prefix.

    For example, if the prefix is notes/ and the delimiter is a slash (/) as in notes/summer/july, the common prefix is notes/summer/. All of the keys that roll up into a common prefix count as a single return when calculating the number of returns.

  • encoding_type(Option<EncodingType>):

    Encoding type used by Amazon S3 to encode object key names in the XML response.

    If you specify the encoding-type request parameter, Amazon S3 includes this element in the response, and returns encoded key name values in the following response elements:

    Delimiter, Prefix, Key, and StartAfter.

  • key_count(i32):

    KeyCount is the number of keys returned with this request. KeyCount will always be less than or equal to the MaxKeys field. For example, if you ask for 50 keys, your result will include 50 keys or fewer.

  • continuation_token(Option<String>):

    If ContinuationToken was sent with the request, it is included in the response.

  • next_continuation_token(Option<String>):

    NextContinuationToken is sent when isTruncated is true, which means there are more keys in the bucket that can be listed. The next list requests to Amazon S3 can be continued with this NextContinuationToken. NextContinuationToken is obfuscated and is not a real key

  • start_after(Option<String>):

    If StartAfter was sent with the request, it is included in the response.

  • request_charged(Option<RequestCharged>):

    If present, indicates that the requester was successfully charged for the request.

• On failure, responds with SdkError<ListObjectsV2Error>

impl Client

pub fn list_parts(&self) -> ListPartsFluentBuilder

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

• The fluent builder is configurable:
  • bucket(impl Into<String>) / set_bucket(Option<String>):

    The name of the bucket to which the parts are being uploaded.

    When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using access points in the Amazon S3 User Guide.

    When you use this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When you use this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts access point ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see What is S3 on Outposts? in the Amazon S3 User Guide.

  • key(impl Into<String>) / set_key(Option<String>):

    Object key for which the multipart upload was initiated.

  • max_parts(i32) / set_max_parts(Option<i32>):

    Sets the maximum number of parts to return.

  • part_number_marker(impl Into<String>) / set_part_number_marker(Option<String>):

    Specifies the part after which listing should begin. Only parts with higher part numbers will be listed.

  • upload_id(impl Into<String>) / set_upload_id(Option<String>):

    Upload ID identifying the multipart upload whose parts are being listed.

  • request_payer(RequestPayer) / set_request_payer(Option<RequestPayer>):

    Confirms that the requester knows that they will be charged for the request. Bucket owners need not specify this parameter in their requests. If either the source or destination Amazon S3 bucket has Requester Pays enabled, the requester will pay for corresponding charges to copy the object. For information about downloading objects from Requester Pays buckets, see Downloading Objects in Requester Pays Buckets in the Amazon S3 User Guide.

  • expected_bucket_owner(impl Into<String>) / set_expected_bucket_owner(Option<String>):

    The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code 403 Forbidden (access denied).

  • sse_customer_algorithm(impl Into<String>) / set_sse_customer_algorithm(Option<String>):

    The server-side encryption (SSE) algorithm used to encrypt the object. This parameter is needed only when the object was created using a checksum algorithm. For more information, see Protecting data using SSE-C keys in the Amazon S3 User Guide.

  • sse_customer_key(impl Into<String>) / set_sse_customer_key(Option<String>):

    The server-side encryption (SSE) customer managed key. This parameter is needed only when the object was created using a checksum algorithm. For more information, see Protecting data using SSE-C keys in the Amazon S3 User Guide.

  • sse_customer_key_md5(impl Into<String>) / set_sse_customer_key_md5(Option<String>):

    The MD5 server-side encryption (SSE) customer managed key. This parameter is needed only when the object was created using a checksum algorithm. For more information, see Protecting data using SSE-C keys in the Amazon S3 User Guide.

• On success, responds with ListPartsOutput with field(s):
  • abort_date(Option<DateTime>):

    If the bucket has a lifecycle rule configured with an action to abort incomplete multipart uploads and the prefix in the lifecycle rule matches the object name in the request, then the response includes this header indicating when the initiated multipart upload will become eligible for abort operation. For more information, see Aborting Incomplete Multipart Uploads Using a Bucket Lifecycle Configuration.

    The response will also include the x-amz-abort-rule-id header that will provide the ID of the lifecycle configuration rule that defines this action.

  • abort_rule_id(Option<String>):

    This header is returned along with the x-amz-abort-date header. It identifies applicable lifecycle configuration rule that defines the action to abort incomplete multipart uploads.

  • bucket(Option<String>):

    The name of the bucket to which the multipart upload was initiated. Does not return the access point ARN or access point alias if used.

  • key(Option<String>):

    Object key for which the multipart upload was initiated.

  • upload_id(Option<String>):

    Upload ID identifying the multipart upload whose parts are being listed.

  • part_number_marker(Option<String>):

    When a list is truncated, this element specifies the last part in the list, as well as the value to use for the part-number-marker request parameter in a subsequent request.

  • next_part_number_marker(Option<String>):

    When a list is truncated, this element specifies the last part in the list, as well as the value to use for the part-number-marker request parameter in a subsequent request.

  • max_parts(i32):

    Maximum number of parts that were allowed in the response.

  • is_truncated(bool):

    Indicates whether the returned list of parts is truncated. A true value indicates that the list was truncated. A list can be truncated if the number of parts exceeds the limit returned in the MaxParts element.

  • parts(Option<Vec<Part>>):

    Container for elements related to a particular part. A response can contain zero or more Part elements.

  • initiator(Option<Initiator>):

    Container element that identifies who initiated the multipart upload. If the initiator is an Amazon Web Services account, this element provides the same information as the Owner element. If the initiator is an IAM User, this element provides the user ARN and display name.

  • owner(Option<Owner>):

    Container element that identifies the object owner, after the object is created. If multipart upload is initiated by an IAM user, this element provides the parent account ID and display name.

  • storage_class(Option<StorageClass>):

    Class of storage (STANDARD or REDUCED_REDUNDANCY) used to store the uploaded object.

  • request_charged(Option<RequestCharged>):

    If present, indicates that the requester was successfully charged for the request.

  • checksum_algorithm(Option<ChecksumAlgorithm>):

    The algorithm that was used to create a checksum of the object.

• On failure, responds with SdkError<ListPartsError>

impl Client

pub fn put_bucket_accelerate_configuration( &self ) -> PutBucketAccelerateConfigurationFluentBuilder

Constructs a fluent builder for the PutBucketAccelerateConfiguration operation.

• The fluent builder is configurable:
  • bucket(impl Into<String>) / set_bucket(Option<String>):

    The name of the bucket for which the accelerate configuration is set.

  • accelerate_configuration(AccelerateConfiguration) / set_accelerate_configuration(Option<AccelerateConfiguration>):

    Container for setting the transfer acceleration state.

  • expected_bucket_owner(impl Into<String>) / set_expected_bucket_owner(Option<String>):

    The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code 403 Forbidden (access denied).

  • checksum_algorithm(ChecksumAlgorithm) / set_checksum_algorithm(Option<ChecksumAlgorithm>):

    Indicates the algorithm used to create the checksum for the object when using the SDK. This header will not provide any additional functionality if not using the SDK. When sending this header, there must be a corresponding x-amz-checksum or x-amz-trailer header sent. Otherwise, Amazon S3 fails the request with the HTTP status code 400 Bad Request. For more information, see Checking object integrity in the Amazon S3 User Guide.

    If you provide an individual checksum, Amazon S3 ignores any provided ChecksumAlgorithm parameter.

• On success, responds with PutBucketAccelerateConfigurationOutput
• On failure, responds with SdkError<PutBucketAccelerateConfigurationError>

impl Client

pub fn put_bucket_acl(&self) -> PutBucketAclFluentBuilder

Constructs a fluent builder for the PutBucketAcl operation.

• The fluent builder is configurable:
  • acl(BucketCannedAcl) / set_acl(Option<BucketCannedAcl>):

    The canned ACL to apply to the bucket.

  • access_control_policy(AccessControlPolicy) / set_access_control_policy(Option<AccessControlPolicy>):

    Contains the elements that set the ACL permissions for an object per grantee.

  • bucket(impl Into<String>) / set_bucket(Option<String>):

    The bucket to which to apply the ACL.

  • content_md5(impl Into<String>) / set_content_md5(Option<String>):

    The base64-encoded 128-bit MD5 digest of the data. This header must be used as a message integrity check to verify that the request body was not corrupted in transit. For more information, go to RFC 1864.

    For requests made using the Amazon Web Services Command Line Interface (CLI) or Amazon Web Services SDKs, this field is calculated automatically.

  • checksum_algorithm(ChecksumAlgorithm) / set_checksum_algorithm(Option<ChecksumAlgorithm>):

    Indicates the algorithm used to create the checksum for the object when using the SDK. This header will not provide any additional functionality if not using the SDK. When sending this header, there must be a corresponding x-amz-checksum or x-amz-trailer header sent. Otherwise, Amazon S3 fails the request with the HTTP status code 400 Bad Request. For more information, see Checking object integrity in the Amazon S3 User Guide.

    If you provide an individual checksum, Amazon S3 ignores any provided ChecksumAlgorithm parameter.

  • grant_full_control(impl Into<String>) / set_grant_full_control(Option<String>):

    Allows grantee the read, write, read ACP, and write ACP permissions on the bucket.

  • grant_read(impl Into<String>) / set_grant_read(Option<String>):

    Allows grantee to list the objects in the bucket.

  • grant_read_acp(impl Into<String>) / set_grant_read_acp(Option<String>):

    Allows grantee to read the bucket ACL.

  • grant_write(impl Into<String>) / set_grant_write(Option<String>):

    Allows grantee to create new objects in the bucket.

    For the bucket and object owners of existing objects, also allows deletions and overwrites of those objects.

  • grant_write_acp(impl Into<String>) / set_grant_write_acp(Option<String>):

    Allows grantee to write the ACL for the applicable bucket.

  • expected_bucket_owner(impl Into<String>) / set_expected_bucket_owner(Option<String>):

    The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code 403 Forbidden (access denied).

• On success, responds with PutBucketAclOutput
• On failure, responds with SdkError<PutBucketAclError>

impl Client

pub fn put_bucket_analytics_configuration( &self ) -> PutBucketAnalyticsConfigurationFluentBuilder

Constructs a fluent builder for the PutBucketAnalyticsConfiguration operation.

• The fluent builder is configurable:
  • bucket(impl Into<String>) / set_bucket(Option<String>):

    The name of the bucket to which an analytics configuration is stored.

  • id(impl Into<String>) / set_id(Option<String>):

    The ID that identifies the analytics configuration.

  • analytics_configuration(AnalyticsConfiguration) / set_analytics_configuration(Option<AnalyticsConfiguration>):

    The configuration and any analyses for the analytics filter.

  • expected_bucket_owner(impl Into<String>) / set_expected_bucket_owner(Option<String>):

    The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code 403 Forbidden (access denied).

• On success, responds with PutBucketAnalyticsConfigurationOutput
• On failure, responds with SdkError<PutBucketAnalyticsConfigurationError>

impl Client

pub fn put_bucket_cors(&self) -> PutBucketCorsFluentBuilder

Constructs a fluent builder for the PutBucketCors operation.

• The fluent builder is configurable:
  • bucket(impl Into<String>) / set_bucket(Option<String>):

    Specifies the bucket impacted by the corsconfiguration.

  • cors_configuration(CorsConfiguration) / set_cors_configuration(Option<CorsConfiguration>):

    Describes the cross-origin access configuration for objects in an Amazon S3 bucket. For more information, see Enabling Cross-Origin Resource Sharing in the Amazon S3 User Guide.

  • content_md5(impl Into<String>) / set_content_md5(Option<String>):

    The base64-encoded 128-bit MD5 digest of the data. This header must be used as a message integrity check to verify that the request body was not corrupted in transit. For more information, go to RFC 1864.

    For requests made using the Amazon Web Services Command Line Interface (CLI) or Amazon Web Services SDKs, this field is calculated automatically.

  • checksum_algorithm(ChecksumAlgorithm) / set_checksum_algorithm(Option<ChecksumAlgorithm>):

    Indicates the algorithm used to create the checksum for the object when using the SDK. This header will not provide any additional functionality if not using the SDK. When sending this header, there must be a corresponding x-amz-checksum or x-amz-trailer header sent. Otherwise, Amazon S3 fails the request with the HTTP status code 400 Bad Request. For more information, see Checking object integrity in the Amazon S3 User Guide.

    If you provide an individual checksum, Amazon S3 ignores any provided ChecksumAlgorithm parameter.

  • expected_bucket_owner(impl Into<String>) / set_expected_bucket_owner(Option<String>):

    The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code 403 Forbidden (access denied).

• On success, responds with PutBucketCorsOutput
• On failure, responds with SdkError<PutBucketCorsError>

impl Client

pub fn put_bucket_encryption(&self) -> PutBucketEncryptionFluentBuilder

Constructs a fluent builder for the PutBucketEncryption operation.

• The fluent builder is configurable:
  • bucket(impl Into<String>) / set_bucket(Option<String>):

    Specifies default encryption for a bucket using server-side encryption with different key options. By default, all buckets have a default encryption configuration that uses server-side encryption with Amazon S3 managed keys (SSE-S3). You can optionally configure default encryption for a bucket by using server-side encryption with an Amazon Web Services KMS key (SSE-KMS) or a customer-provided key (SSE-C). For information about the bucket default encryption feature, see Amazon S3 Bucket Default Encryption in the Amazon S3 User Guide.

  • content_md5(impl Into<String>) / set_content_md5(Option<String>):

    The base64-encoded 128-bit MD5 digest of the server-side encryption configuration.

    For requests made using the Amazon Web Services Command Line Interface (CLI) or Amazon Web Services SDKs, this field is calculated automatically.

  • checksum_algorithm(ChecksumAlgorithm) / set_checksum_algorithm(Option<ChecksumAlgorithm>):

    Indicates the algorithm used to create the checksum for the object when using the SDK. This header will not provide any additional functionality if not using the SDK. When sending this header, there must be a corresponding x-amz-checksum or x-amz-trailer header sent. Otherwise, Amazon S3 fails the request with the HTTP status code 400 Bad Request. For more information, see Checking object integrity in the Amazon S3 User Guide.

    If you provide an individual checksum, Amazon S3 ignores any provided ChecksumAlgorithm parameter.

  • server_side_encryption_configuration(ServerSideEncryptionConfiguration) / set_server_side_encryption_configuration(Option<ServerSideEncryptionConfiguration>):

    Specifies the default server-side-encryption configuration.

  • expected_bucket_owner(impl Into<String>) / set_expected_bucket_owner(Option<String>):

    The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code 403 Forbidden (access denied).

• On success, responds with PutBucketEncryptionOutput
• On failure, responds with SdkError<PutBucketEncryptionError>

impl Client

pub fn put_bucket_intelligent_tiering_configuration( &self ) -> PutBucketIntelligentTieringConfigurationFluentBuilder

Constructs a fluent builder for the PutBucketIntelligentTieringConfiguration operation.

• The fluent builder is configurable:
  • bucket(impl Into<String>) / set_bucket(Option<String>):

    The name of the Amazon S3 bucket whose configuration you want to modify or retrieve.

  • id(impl Into<String>) / set_id(Option<String>):

    The ID used to identify the S3 Intelligent-Tiering configuration.

  • intelligent_tiering_configuration(IntelligentTieringConfiguration) / set_intelligent_tiering_configuration(Option<IntelligentTieringConfiguration>):

    Container for S3 Intelligent-Tiering configuration.

• On success, responds with PutBucketIntelligentTieringConfigurationOutput
• On failure, responds with SdkError<PutBucketIntelligentTieringConfigurationError>

impl Client

pub fn put_bucket_inventory_configuration( &self ) -> PutBucketInventoryConfigurationFluentBuilder

Constructs a fluent builder for the PutBucketInventoryConfiguration operation.

• The fluent builder is configurable:
  • bucket(impl Into<String>) / set_bucket(Option<String>):

    The name of the bucket where the inventory configuration will be stored.

  • id(impl Into<String>) / set_id(Option<String>):

    The ID used to identify the inventory configuration.

  • inventory_configuration(InventoryConfiguration) / set_inventory_configuration(Option<InventoryConfiguration>):

    Specifies the inventory configuration.

  • expected_bucket_owner(impl Into<String>) / set_expected_bucket_owner(Option<String>):

    The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code 403 Forbidden (access denied).

• On success, responds with PutBucketInventoryConfigurationOutput
• On failure, responds with SdkError<PutBucketInventoryConfigurationError>

impl Client

pub fn put_bucket_lifecycle_configuration( &self ) -> PutBucketLifecycleConfigurationFluentBuilder

Constructs a fluent builder for the PutBucketLifecycleConfiguration operation.

• The fluent builder is configurable:
  • bucket(impl Into<String>) / set_bucket(Option<String>):

    The name of the bucket for which to set the configuration.

  • checksum_algorithm(ChecksumAlgorithm) / set_checksum_algorithm(Option<ChecksumAlgorithm>):

    Indicates the algorithm used to create the checksum for the object when using the SDK. This header will not provide any additional functionality if not using the SDK. When sending this header, there must be a corresponding x-amz-checksum or x-amz-trailer header sent. Otherwise, Amazon S3 fails the request with the HTTP status code 400 Bad Request. For more information, see Checking object integrity in the Amazon S3 User Guide.

    If you provide an individual checksum, Amazon S3 ignores any provided ChecksumAlgorithm parameter.

  • lifecycle_configuration(BucketLifecycleConfiguration) / set_lifecycle_configuration(Option<BucketLifecycleConfiguration>):

    Container for lifecycle rules. You can add as many as 1,000 rules.

  • expected_bucket_owner(impl Into<String>) / set_expected_bucket_owner(Option<String>):

    The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code 403 Forbidden (access denied).

• On success, responds with PutBucketLifecycleConfigurationOutput
• On failure, responds with SdkError<PutBucketLifecycleConfigurationError>

impl Client

pub fn put_bucket_logging(&self) -> PutBucketLoggingFluentBuilder

Constructs a fluent builder for the PutBucketLogging operation.

• The fluent builder is configurable:
  • bucket(impl Into<String>) / set_bucket(Option<String>):

    The name of the bucket for which to set the logging parameters.

  • bucket_logging_status(BucketLoggingStatus) / set_bucket_logging_status(Option<BucketLoggingStatus>):

    Container for logging status information.

  • content_md5(impl Into<String>) / set_content_md5(Option<String>):

    The MD5 hash of the PutBucketLogging request body.

    For requests made using the Amazon Web Services Command Line Interface (CLI) or Amazon Web Services SDKs, this field is calculated automatically.

  • checksum_algorithm(ChecksumAlgorithm) / set_checksum_algorithm(Option<ChecksumAlgorithm>):

    Indicates the algorithm used to create the checksum for the object when using the SDK. This header will not provide any additional functionality if not using the SDK. When sending this header, there must be a corresponding x-amz-checksum or x-amz-trailer header sent. Otherwise, Amazon S3 fails the request with the HTTP status code 400 Bad Request. For more information, see Checking object integrity in the Amazon S3 User Guide.

    If you provide an individual checksum, Amazon S3 ignores any provided ChecksumAlgorithm parameter.

  • expected_bucket_owner(impl Into<String>) / set_expected_bucket_owner(Option<String>):

    The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code 403 Forbidden (access denied).

• On success, responds with PutBucketLoggingOutput
• On failure, responds with SdkError<PutBucketLoggingError>

impl Client

pub fn put_bucket_metrics_configuration( &self ) -> PutBucketMetricsConfigurationFluentBuilder

Constructs a fluent builder for the PutBucketMetricsConfiguration operation.

• The fluent builder is configurable:
  • bucket(impl Into<String>) / set_bucket(Option<String>):

    The name of the bucket for which the metrics configuration is set.

  • id(impl Into<String>) / set_id(Option<String>):

    The ID used to identify the metrics configuration. The ID has a 64 character limit and can only contain letters, numbers, periods, dashes, and underscores.

  • metrics_configuration(MetricsConfiguration) / set_metrics_configuration(Option<MetricsConfiguration>):

    Specifies the metrics configuration.

  • expected_bucket_owner(impl Into<String>) / set_expected_bucket_owner(Option<String>):

    The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code 403 Forbidden (access denied).

• On success, responds with PutBucketMetricsConfigurationOutput
• On failure, responds with SdkError<PutBucketMetricsConfigurationError>

impl Client

pub fn put_bucket_notification_configuration( &self ) -> PutBucketNotificationConfigurationFluentBuilder

Constructs a fluent builder for the PutBucketNotificationConfiguration operation.

• The fluent builder is configurable:
  • bucket(impl Into<String>) / set_bucket(Option<String>):

    The name of the bucket.

  • notification_configuration(NotificationConfiguration) / set_notification_configuration(Option<NotificationConfiguration>):

    A container for specifying the notification configuration of the bucket. If this element is empty, notifications are turned off for the bucket.

  • expected_bucket_owner(impl Into<String>) / set_expected_bucket_owner(Option<String>):

    The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code 403 Forbidden (access denied).

  • skip_destination_validation(bool) / set_skip_destination_validation(Option<bool>):

    Skips validation of Amazon SQS, Amazon SNS, and Lambda destinations. True or false value.

• On success, responds with PutBucketNotificationConfigurationOutput
• On failure, responds with SdkError<PutBucketNotificationConfigurationError>

impl Client

pub fn put_bucket_ownership_controls( &self ) -> PutBucketOwnershipControlsFluentBuilder

Constructs a fluent builder for the PutBucketOwnershipControls operation.

• The fluent builder is configurable:
  • bucket(impl Into<String>) / set_bucket(Option<String>):

    The name of the Amazon S3 bucket whose OwnershipControls you want to set.

  • content_md5(impl Into<String>) / set_content_md5(Option<String>):

    The MD5 hash of the OwnershipControls request body.

    For requests made using the Amazon Web Services Command Line Interface (CLI) or Amazon Web Services SDKs, this field is calculated automatically.

  • expected_bucket_owner(impl Into<String>) / set_expected_bucket_owner(Option<String>):

    The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code 403 Forbidden (access denied).

  • ownership_controls(OwnershipControls) / set_ownership_controls(Option<OwnershipControls>):

    The OwnershipControls (BucketOwnerEnforced, BucketOwnerPreferred, or ObjectWriter) that you want to apply to this Amazon S3 bucket.

• On success, responds with PutBucketOwnershipControlsOutput
• On failure, responds with SdkError<PutBucketOwnershipControlsError>

impl Client

pub fn put_bucket_policy(&self) -> PutBucketPolicyFluentBuilder

Constructs a fluent builder for the PutBucketPolicy operation.

• The fluent builder is configurable:
  • bucket(impl Into<String>) / set_bucket(Option<String>):

    The name of the bucket.

  • content_md5(impl Into<String>) / set_content_md5(Option<String>):

    The MD5 hash of the request body.

    For requests made using the Amazon Web Services Command Line Interface (CLI) or Amazon Web Services SDKs, this field is calculated automatically.

  • checksum_algorithm(ChecksumAlgorithm) / set_checksum_algorithm(Option<ChecksumAlgorithm>):

    Indicates the algorithm used to create the checksum for the object when using the SDK. This header will not provide any additional functionality if not using the SDK. When sending this header, there must be a corresponding x-amz-checksum or x-amz-trailer header sent. Otherwise, Amazon S3 fails the request with the HTTP status code 400 Bad Request. For more information, see Checking object integrity in the Amazon S3 User Guide.

    If you provide an individual checksum, Amazon S3 ignores any provided ChecksumAlgorithm parameter.

  • confirm_remove_self_bucket_access(bool) / set_confirm_remove_self_bucket_access(Option<bool>):

    Set this parameter to true to confirm that you want to remove your permissions to change this bucket policy in the future.

  • policy(impl Into<String>) / set_policy(Option<String>):

    The bucket policy as a JSON document.

  • expected_bucket_owner(impl Into<String>) / set_expected_bucket_owner(Option<String>):

    The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code 403 Forbidden (access denied).

• On success, responds with PutBucketPolicyOutput
• On failure, responds with SdkError<PutBucketPolicyError>

impl Client

pub fn put_bucket_replication(&self) -> PutBucketReplicationFluentBuilder

Constructs a fluent builder for the PutBucketReplication operation.

• The fluent builder is configurable:
  • bucket(impl Into<String>) / set_bucket(Option<String>):

    The name of the bucket

  • content_md5(impl Into<String>) / set_content_md5(Option<String>):

    The base64-encoded 128-bit MD5 digest of the data. You must use this header as a message integrity check to verify that the request body was not corrupted in transit. For more information, see RFC 1864.

    For requests made using the Amazon Web Services Command Line Interface (CLI) or Amazon Web Services SDKs, this field is calculated automatically.

  • checksum_algorithm(ChecksumAlgorithm) / set_checksum_algorithm(Option<ChecksumAlgorithm>):

    Indicates the algorithm used to create the checksum for the object when using the SDK. This header will not provide any additional functionality if not using the SDK. When sending this header, there must be a corresponding x-amz-checksum or x-amz-trailer header sent. Otherwise, Amazon S3 fails the request with the HTTP status code 400 Bad Request. For more information, see Checking object integrity in the Amazon S3 User Guide.

    If you provide an individual checksum, Amazon S3 ignores any provided ChecksumAlgorithm parameter.

  • replication_configuration(ReplicationConfiguration) / set_replication_configuration(Option<ReplicationConfiguration>):

    A container for replication rules. You can add up to 1,000 rules. The maximum size of a replication configuration is 2 MB.

  • token(impl Into<String>) / set_token(Option<String>):

    A token to allow Object Lock to be enabled for an existing bucket.

  • expected_bucket_owner(impl Into<String>) / set_expected_bucket_owner(Option<String>):

    The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code 403 Forbidden (access denied).

• On success, responds with PutBucketReplicationOutput
• On failure, responds with SdkError<PutBucketReplicationError>

impl Client

pub fn put_bucket_request_payment(&self) -> PutBucketRequestPaymentFluentBuilder

Constructs a fluent builder for the PutBucketRequestPayment operation.

• The fluent builder is configurable:
  • bucket(impl Into<String>) / set_bucket(Option<String>):

    The bucket name.

  • content_md5(impl Into<String>) / set_content_md5(Option<String>):

    The base64-encoded 128-bit MD5 digest of the data. You must use this header as a message integrity check to verify that the request body was not corrupted in transit. For more information, see RFC 1864.

    For requests made using the Amazon Web Services Command Line Interface (CLI) or Amazon Web Services SDKs, this field is calculated automatically.

  • checksum_algorithm(ChecksumAlgorithm) / set_checksum_algorithm(Option<ChecksumAlgorithm>):

    Indicates the algorithm used to create the checksum for the object when using the SDK. This header will not provide any additional functionality if not using the SDK. When sending this header, there must be a corresponding x-amz-checksum or x-amz-trailer header sent. Otherwise, Amazon S3 fails the request with the HTTP status code 400 Bad Request. For more information, see Checking object integrity in the Amazon S3 User Guide.

    If you provide an individual checksum, Amazon S3 ignores any provided ChecksumAlgorithm parameter.

  • request_payment_configuration(RequestPaymentConfiguration) / set_request_payment_configuration(Option<RequestPaymentConfiguration>):

    Container for Payer.

  • expected_bucket_owner(impl Into<String>) / set_expected_bucket_owner(Option<String>):

    The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code 403 Forbidden (access denied).

• On success, responds with PutBucketRequestPaymentOutput
• On failure, responds with SdkError<PutBucketRequestPaymentError>

impl Client

pub fn put_bucket_tagging(&self) -> PutBucketTaggingFluentBuilder

Constructs a fluent builder for the PutBucketTagging operation.

• The fluent builder is configurable:
  • bucket(impl Into<String>) / set_bucket(Option<String>):

    The bucket name.

  • content_md5(impl Into<String>) / set_content_md5(Option<String>):

    The base64-encoded 128-bit MD5 digest of the data. You must use this header as a message integrity check to verify that the request body was not corrupted in transit. For more information, see RFC 1864.

    For requests made using the Amazon Web Services Command Line Interface (CLI) or Amazon Web Services SDKs, this field is calculated automatically.

  • checksum_algorithm(ChecksumAlgorithm) / set_checksum_algorithm(Option<ChecksumAlgorithm>):

    Indicates the algorithm used to create the checksum for the object when using the SDK. This header will not provide any additional functionality if not using the SDK. When sending this header, there must be a corresponding x-amz-checksum or x-amz-trailer header sent. Otherwise, Amazon S3 fails the request with the HTTP status code 400 Bad Request. For more information, see Checking object integrity in the Amazon S3 User Guide.

    If you provide an individual checksum, Amazon S3 ignores any provided ChecksumAlgorithm parameter.

  • tagging(Tagging) / set_tagging(Option<Tagging>):

    Container for the TagSet and Tag elements.

  • expected_bucket_owner(impl Into<String>) / set_expected_bucket_owner(Option<String>):

    The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code 403 Forbidden (access denied).

• On success, responds with PutBucketTaggingOutput
• On failure, responds with SdkError<PutBucketTaggingError>

impl Client

pub fn put_bucket_versioning(&self) -> PutBucketVersioningFluentBuilder

Constructs a fluent builder for the PutBucketVersioning operation.

• The fluent builder is configurable:
  • bucket(impl Into<String>) / set_bucket(Option<String>):

    The bucket name.

  • content_md5(impl Into<String>) / set_content_md5(Option<String>):

    >The base64-encoded 128-bit MD5 digest of the data. You must use this header as a message integrity check to verify that the request body was not corrupted in transit. For more information, see RFC 1864.

    For requests made using the Amazon Web Services Command Line Interface (CLI) or Amazon Web Services SDKs, this field is calculated automatically.

  • checksum_algorithm(ChecksumAlgorithm) / set_checksum_algorithm(Option<ChecksumAlgorithm>):

    Indicates the algorithm used to create the checksum for the object when using the SDK. This header will not provide any additional functionality if not using the SDK. When sending this header, there must be a corresponding x-amz-checksum or x-amz-trailer header sent. Otherwise, Amazon S3 fails the request with the HTTP status code 400 Bad Request. For more information, see Checking object integrity in the Amazon S3 User Guide.

    If you provide an individual checksum, Amazon S3 ignores any provided ChecksumAlgorithm parameter.

  • mfa(impl Into<String>) / set_mfa(Option<String>):

    The concatenation of the authentication device’s serial number, a space, and the value that is displayed on your authentication device.

  • versioning_configuration(VersioningConfiguration) / set_versioning_configuration(Option<VersioningConfiguration>):

    Container for setting the versioning state.

  • expected_bucket_owner(impl Into<String>) / set_expected_bucket_owner(Option<String>):

    The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code 403 Forbidden (access denied).

• On success, responds with PutBucketVersioningOutput
• On failure, responds with SdkError<PutBucketVersioningError>

impl Client

pub fn put_bucket_website(&self) -> PutBucketWebsiteFluentBuilder

Constructs a fluent builder for the PutBucketWebsite operation.

• The fluent builder is configurable:
  • bucket(impl Into<String>) / set_bucket(Option<String>):

    The bucket name.

  • content_md5(impl Into<String>) / set_content_md5(Option<String>):

    The base64-encoded 128-bit MD5 digest of the data. You must use this header as a message integrity check to verify that the request body was not corrupted in transit. For more information, see RFC 1864.

    For requests made using the Amazon Web Services Command Line Interface (CLI) or Amazon Web Services SDKs, this field is calculated automatically.

  • checksum_algorithm(ChecksumAlgorithm) / set_checksum_algorithm(Option<ChecksumAlgorithm>):

    Indicates the algorithm used to create the checksum for the object when using the SDK. This header will not provide any additional functionality if not using the SDK. When sending this header, there must be a corresponding x-amz-checksum or x-amz-trailer header sent. Otherwise, Amazon S3 fails the request with the HTTP status code 400 Bad Request. For more information, see Checking object integrity in the Amazon S3 User Guide.

    If you provide an individual checksum, Amazon S3 ignores any provided ChecksumAlgorithm parameter.

  • website_configuration(WebsiteConfiguration) / set_website_configuration(Option<WebsiteConfiguration>):

    Container for the request.

  • expected_bucket_owner(impl Into<String>) / set_expected_bucket_owner(Option<String>):

    The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code 403 Forbidden (access denied).

• On success, responds with PutBucketWebsiteOutput
• On failure, responds with SdkError<PutBucketWebsiteError>

impl Client

pub fn put_object(&self) -> PutObjectFluentBuilder

Constructs a fluent builder for the PutObject operation.

• The fluent builder is configurable:
  • acl(ObjectCannedAcl) / set_acl(Option<ObjectCannedAcl>):

    The canned ACL to apply to the object. For more information, see Canned ACL.

    This action is not supported by Amazon S3 on Outposts.

  • body(ByteStream) / set_body(ByteStream):

    Object data.

  • bucket(impl Into<String>) / set_bucket(Option<String>):

    The bucket name to which the PUT action was initiated.

    When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using access points in the Amazon S3 User Guide.

    When you use this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When you use this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts access point ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see What is S3 on Outposts? in the Amazon S3 User Guide.

  • cache_control(impl Into<String>) / set_cache_control(Option<String>):

    Can be used to specify caching behavior along the request/reply chain. For more information, see http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.9.

  • content_disposition(impl Into<String>) / set_content_disposition(Option<String>):

    Specifies presentational information for the object. For more information, see https://www.rfc-editor.org/rfc/rfc6266#section-4.

  • content_encoding(impl Into<String>) / set_content_encoding(Option<String>):

    Specifies what content encodings have been applied to the object and thus what decoding mechanisms must be applied to obtain the media-type referenced by the Content-Type header field. For more information, see https://www.rfc-editor.org/rfc/rfc9110.html#field.content-encoding.

  • content_language(impl Into<String>) / set_content_language(Option<String>):

    The language the content is in.

  • content_length(i64) / set_content_length(Option<i64>):

    Size of the body in bytes. This parameter is useful when the size of the body cannot be determined automatically. For more information, see https://www.rfc-editor.org/rfc/rfc9110.html#name-content-length.

  • content_md5(impl Into<String>) / set_content_md5(Option<String>):

    The base64-encoded 128-bit MD5 digest of the message (without the headers) according to RFC 1864. This header can be used as a message integrity check to verify that the data is the same data that was originally sent. Although it is optional, we recommend using the Content-MD5 mechanism as an end-to-end integrity check. For more information about REST request authentication, see REST Authentication.

  • content_type(impl Into<String>) / set_content_type(Option<String>):

    A standard MIME type describing the format of the contents. For more information, see https://www.rfc-editor.org/rfc/rfc9110.html#name-content-type.

  • checksum_algorithm(ChecksumAlgorithm) / set_checksum_algorithm(Option<ChecksumAlgorithm>):

    Indicates the algorithm used to create the checksum for the object when using the SDK. This header will not provide any additional functionality if not using the SDK. When sending this header, there must be a corresponding x-amz-checksum or x-amz-trailer header sent. Otherwise, Amazon S3 fails the request with the HTTP status code 400 Bad Request. For more information, see Checking object integrity in the Amazon S3 User Guide.

    If you provide an individual checksum, Amazon S3 ignores any provided ChecksumAlgorithm parameter.

  • checksum_crc32(impl Into<String>) / set_checksum_crc32(Option<String>):

    This header can be used as a data integrity check to verify that the data received is the same data that was originally sent. This header specifies the base64-encoded, 32-bit CRC32 checksum of the object. For more information, see Checking object integrity in the Amazon S3 User Guide.

  • checksum_crc32_c(impl Into<String>) / set_checksum_crc32_c(Option<String>):

    This header can be used as a data integrity check to verify that the data received is the same data that was originally sent. This header specifies the base64-encoded, 32-bit CRC32C checksum of the object. For more information, see Checking object integrity in the Amazon S3 User Guide.

  • checksum_sha1(impl Into<String>) / set_checksum_sha1(Option<String>):

    This header can be used as a data integrity check to verify that the data received is the same data that was originally sent. This header specifies the base64-encoded, 160-bit SHA-1 digest of the object. For more information, see Checking object integrity in the Amazon S3 User Guide.

  • checksum_sha256(impl Into<String>) / set_checksum_sha256(Option<String>):

    This header can be used as a data integrity check to verify that the data received is the same data that was originally sent. This header specifies the base64-encoded, 256-bit SHA-256 digest of the object. For more information, see Checking object integrity in the Amazon S3 User Guide.

  • expires(DateTime) / set_expires(Option<DateTime>):

    The date and time at which the object is no longer cacheable. For more information, see https://www.rfc-editor.org/rfc/rfc7234#section-5.3.

  • grant_full_control(impl Into<String>) / set_grant_full_control(Option<String>):

    Gives the grantee READ, READ_ACP, and WRITE_ACP permissions on the object.

    This action is not supported by Amazon S3 on Outposts.

  • grant_read(impl Into<String>) / set_grant_read(Option<String>):

    Allows grantee to read the object data and its metadata.

    This action is not supported by Amazon S3 on Outposts.

  • grant_read_acp(impl Into<String>) / set_grant_read_acp(Option<String>):

    Allows grantee to read the object ACL.

    This action is not supported by Amazon S3 on Outposts.

  • grant_write_acp(impl Into<String>) / set_grant_write_acp(Option<String>):

    Allows grantee to write the ACL for the applicable object.

    This action is not supported by Amazon S3 on Outposts.

  • key(impl Into<String>) / set_key(Option<String>):

    Object key for which the PUT action was initiated.

  • metadata(impl Into<String>, impl Into<String>) / set_metadata(Option<HashMap<String, String>>):

    A map of metadata to store with the object in S3.

  • server_side_encryption(ServerSideEncryption) / set_server_side_encryption(Option<ServerSideEncryption>):

    The server-side encryption algorithm used when storing this object in Amazon S3 (for example, AES256, aws:kms, aws:kms:dsse).

  • storage_class(StorageClass) / set_storage_class(Option<StorageClass>):

    By default, Amazon S3 uses the STANDARD Storage Class to store newly created objects. The STANDARD storage class provides high durability and high availability. Depending on performance needs, you can specify a different Storage Class. Amazon S3 on Outposts only uses the OUTPOSTS Storage Class. For more information, see Storage Classes in the Amazon S3 User Guide.

  • website_redirect_location(impl Into<String>) / set_website_redirect_location(Option<String>):

    If the bucket is configured as a website, redirects requests for this object to another object in the same bucket or to an external URL. Amazon S3 stores the value of this header in the object metadata. For information about object metadata, see Object Key and Metadata.

    In the following example, the request header sets the redirect to an object (anotherPage.html) in the same bucket:

    x-amz-website-redirect-location: /anotherPage.html

    In the following example, the request header sets the object redirect to another website:

    x-amz-website-redirect-location: http://www.example.com/

    For more information about website hosting in Amazon S3, see Hosting Websites on Amazon S3 and How to Configure Website Page Redirects.

  • sse_customer_algorithm(impl Into<String>) / set_sse_customer_algorithm(Option<String>):

    Specifies the algorithm to use to when encrypting the object (for example, AES256).

  • sse_customer_key(impl Into<String>) / set_sse_customer_key(Option<String>):

    Specifies the customer-provided encryption key for Amazon S3 to use in encrypting data. This value is used to store the object and then it is discarded; Amazon S3 does not store the encryption key. The key must be appropriate for use with the algorithm specified in the x-amz-server-side-encryption-customer-algorithm header.

  • sse_customer_key_md5(impl Into<String>) / set_sse_customer_key_md5(Option<String>):

    Specifies the 128-bit MD5 digest of the encryption key according to RFC 1321. Amazon S3 uses this header for a message integrity check to ensure that the encryption key was transmitted without error.

  • ssekms_key_id(impl Into<String>) / set_ssekms_key_id(Option<String>):

    If x-amz-server-side-encryption has a valid value of aws:kms or aws:kms:dsse, this header specifies the ID (Key ID, Key ARN, or Key Alias) of the Key Management Service (KMS) symmetric encryption customer managed key that was used for the object. If you specify x-amz-server-side-encryption:aws:kms or x-amz-server-side-encryption:aws:kms:dsse, but do not provide x-amz-server-side-encryption-aws-kms-key-id, Amazon S3 uses the Amazon Web Services managed key (aws/s3) to protect the data. If the KMS key does not exist in the same account that’s issuing the command, you must use the full ARN and not just the ID.

  • ssekms_encryption_context(impl Into<String>) / set_ssekms_encryption_context(Option<String>):

    Specifies the Amazon Web Services KMS Encryption Context to use for object encryption. The value of this header is a base64-encoded UTF-8 string holding JSON with the encryption context key-value pairs. This value is stored as object metadata and automatically gets passed on to Amazon Web Services KMS for future GetObject or CopyObject operations on this object.

  • bucket_key_enabled(bool) / set_bucket_key_enabled(Option<bool>):

    Specifies whether Amazon S3 should use an S3 Bucket Key for object encryption with server-side encryption using Key Management Service (KMS) keys (SSE-KMS). Setting this header to true causes Amazon S3 to use an S3 Bucket Key for object encryption with SSE-KMS.

    Specifying this header with a PUT action doesn’t affect bucket-level settings for S3 Bucket Key.

  • request_payer(RequestPayer) / set_request_payer(Option<RequestPayer>):

    Confirms that the requester knows that they will be charged for the request. Bucket owners need not specify this parameter in their requests. If either the source or destination Amazon S3 bucket has Requester Pays enabled, the requester will pay for corresponding charges to copy the object. For information about downloading objects from Requester Pays buckets, see Downloading Objects in Requester Pays Buckets in the Amazon S3 User Guide.

  • tagging(impl Into<String>) / set_tagging(Option<String>):

    The tag-set for the object. The tag-set must be encoded as URL Query parameters. (For example, “Key1=Value1”)

  • object_lock_mode(ObjectLockMode) / set_object_lock_mode(Option<ObjectLockMode>):

    The Object Lock mode that you want to apply to this object.

  • object_lock_retain_until_date(DateTime) / set_object_lock_retain_until_date(Option<DateTime>):

    The date and time when you want this object’s Object Lock to expire. Must be formatted as a timestamp parameter.

  • object_lock_legal_hold_status(ObjectLockLegalHoldStatus) / set_object_lock_legal_hold_status(Option<ObjectLockLegalHoldStatus>):

    Specifies whether a legal hold will be applied to this object. For more information about S3 Object Lock, see Object Lock.

  • expected_bucket_owner(impl Into<String>) / set_expected_bucket_owner(Option<String>):

    The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code 403 Forbidden (access denied).

• On success, responds with PutObjectOutput with field(s):
  • expiration(Option<String>):

    If the expiration is configured for the object (see PutBucketLifecycleConfiguration), the response includes this header. It includes the expiry-date and rule-id key-value pairs that provide information about object expiration. The value of the rule-id is URL-encoded.

  • e_tag(Option<String>):

    Entity tag for the uploaded object.

  • checksum_crc32(Option<String>):

    The base64-encoded, 32-bit CRC32 checksum of the object. This will only be present if it was uploaded with the object. With multipart uploads, this may not be a checksum value of the object. For more information about how checksums are calculated with multipart uploads, see Checking object integrity in the Amazon S3 User Guide.

  • checksum_crc32_c(Option<String>):

    The base64-encoded, 32-bit CRC32C checksum of the object. This will only be present if it was uploaded with the object. With multipart uploads, this may not be a checksum value of the object. For more information about how checksums are calculated with multipart uploads, see Checking object integrity in the Amazon S3 User Guide.

  • checksum_sha1(Option<String>):

    The base64-encoded, 160-bit SHA-1 digest of the object. This will only be present if it was uploaded with the object. With multipart uploads, this may not be a checksum value of the object. For more information about how checksums are calculated with multipart uploads, see Checking object integrity in the Amazon S3 User Guide.

  • checksum_sha256(Option<String>):

    The base64-encoded, 256-bit SHA-256 digest of the object. This will only be present if it was uploaded with the object. With multipart uploads, this may not be a checksum value of the object. For more information about how checksums are calculated with multipart uploads, see Checking object integrity in the Amazon S3 User Guide.

  • server_side_encryption(Option<ServerSideEncryption>):

    The server-side encryption algorithm used when storing this object in Amazon S3 (for example, AES256, aws:kms, aws:kms:dsse).

  • version_id(Option<String>):

    Version of the object.

  • sse_customer_algorithm(Option<String>):

    If server-side encryption with a customer-provided encryption key was requested, the response will include this header confirming the encryption algorithm used.

  • sse_customer_key_md5(Option<String>):

    If server-side encryption with a customer-provided encryption key was requested, the response will include this header to provide round-trip message integrity verification of the customer-provided encryption key.

  • ssekms_key_id(Option<String>):

    If x-amz-server-side-encryption has a valid value of aws:kms or aws:kms:dsse, this header specifies the ID of the Key Management Service (KMS) symmetric encryption customer managed key that was used for the object.

  • ssekms_encryption_context(Option<String>):

    If present, specifies the Amazon Web Services KMS Encryption Context to use for object encryption. The value of this header is a base64-encoded UTF-8 string holding JSON with the encryption context key-value pairs. This value is stored as object metadata and automatically gets passed on to Amazon Web Services KMS for future GetObject or CopyObject operations on this object.

  • bucket_key_enabled(bool):

    Indicates whether the uploaded object uses an S3 Bucket Key for server-side encryption with Key Management Service (KMS) keys (SSE-KMS).

  • request_charged(Option<RequestCharged>):

    If present, indicates that the requester was successfully charged for the request.

• On failure, responds with SdkError<PutObjectError>

impl Client

pub fn put_object_acl(&self) -> PutObjectAclFluentBuilder

Constructs a fluent builder for the PutObjectAcl operation.

• The fluent builder is configurable:
  • acl(ObjectCannedAcl) / set_acl(Option<ObjectCannedAcl>):

    The canned ACL to apply to the object. For more information, see Canned ACL.

  • access_control_policy(AccessControlPolicy) / set_access_control_policy(Option<AccessControlPolicy>):

    Contains the elements that set the ACL permissions for an object per grantee.

  • bucket(impl Into<String>) / set_bucket(Option<String>):

    The bucket name that contains the object to which you want to attach the ACL.

    When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using access points in the Amazon S3 User Guide.

  • content_md5(impl Into<String>) / set_content_md5(Option<String>):

    The base64-encoded 128-bit MD5 digest of the data. This header must be used as a message integrity check to verify that the request body was not corrupted in transit. For more information, go to RFC 1864.>

    For requests made using the Amazon Web Services Command Line Interface (CLI) or Amazon Web Services SDKs, this field is calculated automatically.

  • checksum_algorithm(ChecksumAlgorithm) / set_checksum_algorithm(Option<ChecksumAlgorithm>):

    Indicates the algorithm used to create the checksum for the object when using the SDK. This header will not provide any additional functionality if not using the SDK. When sending this header, there must be a corresponding x-amz-checksum or x-amz-trailer header sent. Otherwise, Amazon S3 fails the request with the HTTP status code 400 Bad Request. For more information, see Checking object integrity in the Amazon S3 User Guide.

    If you provide an individual checksum, Amazon S3 ignores any provided ChecksumAlgorithm parameter.

  • grant_full_control(impl Into<String>) / set_grant_full_control(Option<String>):

    Allows grantee the read, write, read ACP, and write ACP permissions on the bucket.

    This action is not supported by Amazon S3 on Outposts.

  • grant_read(impl Into<String>) / set_grant_read(Option<String>):

    Allows grantee to list the objects in the bucket.

    This action is not supported by Amazon S3 on Outposts.

  • grant_read_acp(impl Into<String>) / set_grant_read_acp(Option<String>):

    Allows grantee to read the bucket ACL.

    This action is not supported by Amazon S3 on Outposts.

  • grant_write(impl Into<String>) / set_grant_write(Option<String>):

    Allows grantee to create new objects in the bucket.

    For the bucket and object owners of existing objects, also allows deletions and overwrites of those objects.

  • grant_write_acp(impl Into<String>) / set_grant_write_acp(Option<String>):

    Allows grantee to write the ACL for the applicable bucket.

    This action is not supported by Amazon S3 on Outposts.

  • key(impl Into<String>) / set_key(Option<String>):

    Key for which the PUT action was initiated.

    When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using access points in the Amazon S3 User Guide.

    When you use this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When you use this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts access point ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see What is S3 on Outposts? in the Amazon S3 User Guide.

  • request_payer(RequestPayer) / set_request_payer(Option<RequestPayer>):

    Confirms that the requester knows that they will be charged for the request. Bucket owners need not specify this parameter in their requests. If either the source or destination Amazon S3 bucket has Requester Pays enabled, the requester will pay for corresponding charges to copy the object. For information about downloading objects from Requester Pays buckets, see Downloading Objects in Requester Pays Buckets in the Amazon S3 User Guide.

  • version_id(impl Into<String>) / set_version_id(Option<String>):

    VersionId used to reference a specific version of the object.

  • expected_bucket_owner(impl Into<String>) / set_expected_bucket_owner(Option<String>):

    The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code 403 Forbidden (access denied).

• On success, responds with PutObjectAclOutput with field(s):
  • request_charged(Option<RequestCharged>):

    If present, indicates that the requester was successfully charged for the request.

• On failure, responds with SdkError<PutObjectAclError>

impl Client

pub fn put_object_legal_hold(&self) -> PutObjectLegalHoldFluentBuilder

Constructs a fluent builder for the PutObjectLegalHold operation.

• The fluent builder is configurable:
  • bucket(impl Into<String>) / set_bucket(Option<String>):

    The bucket name containing the object that you want to place a legal hold on.

    When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using access points in the Amazon S3 User Guide.

  • key(impl Into<String>) / set_key(Option<String>):

    The key name for the object that you want to place a legal hold on.

  • legal_hold(ObjectLockLegalHold) / set_legal_hold(Option<ObjectLockLegalHold>):

    Container element for the legal hold configuration you want to apply to the specified object.

  • request_payer(RequestPayer) / set_request_payer(Option<RequestPayer>):

    Confirms that the requester knows that they will be charged for the request. Bucket owners need not specify this parameter in their requests. If either the source or destination Amazon S3 bucket has Requester Pays enabled, the requester will pay for corresponding charges to copy the object. For information about downloading objects from Requester Pays buckets, see Downloading Objects in Requester Pays Buckets in the Amazon S3 User Guide.

  • version_id(impl Into<String>) / set_version_id(Option<String>):

    The version ID of the object that you want to place a legal hold on.

  • content_md5(impl Into<String>) / set_content_md5(Option<String>):

    The MD5 hash for the request body.

    For requests made using the Amazon Web Services Command Line Interface (CLI) or Amazon Web Services SDKs, this field is calculated automatically.

  • checksum_algorithm(ChecksumAlgorithm) / set_checksum_algorithm(Option<ChecksumAlgorithm>):

    Indicates the algorithm used to create the checksum for the object when using the SDK. This header will not provide any additional functionality if not using the SDK. When sending this header, there must be a corresponding x-amz-checksum or x-amz-trailer header sent. Otherwise, Amazon S3 fails the request with the HTTP status code 400 Bad Request. For more information, see Checking object integrity in the Amazon S3 User Guide.

    If you provide an individual checksum, Amazon S3 ignores any provided ChecksumAlgorithm parameter.

  • expected_bucket_owner(impl Into<String>) / set_expected_bucket_owner(Option<String>):

    The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code 403 Forbidden (access denied).

• On success, responds with PutObjectLegalHoldOutput with field(s):
  • request_charged(Option<RequestCharged>):

    If present, indicates that the requester was successfully charged for the request.

• On failure, responds with SdkError<PutObjectLegalHoldError>

impl Client

pub fn put_object_lock_configuration( &self ) -> PutObjectLockConfigurationFluentBuilder

Constructs a fluent builder for the PutObjectLockConfiguration operation.

• The fluent builder is configurable:
  • bucket(impl Into<String>) / set_bucket(Option<String>):

    The bucket whose Object Lock configuration you want to create or replace.

  • object_lock_configuration(ObjectLockConfiguration) / set_object_lock_configuration(Option<ObjectLockConfiguration>):

    The Object Lock configuration that you want to apply to the specified bucket.

  • request_payer(RequestPayer) / set_request_payer(Option<RequestPayer>):

    Confirms that the requester knows that they will be charged for the request. Bucket owners need not specify this parameter in their requests. If either the source or destination Amazon S3 bucket has Requester Pays enabled, the requester will pay for corresponding charges to copy the object. For information about downloading objects from Requester Pays buckets, see Downloading Objects in Requester Pays Buckets in the Amazon S3 User Guide.

  • token(impl Into<String>) / set_token(Option<String>):

    A token to allow Object Lock to be enabled for an existing bucket.

  • content_md5(impl Into<String>) / set_content_md5(Option<String>):

    The MD5 hash for the request body.

    For requests made using the Amazon Web Services Command Line Interface (CLI) or Amazon Web Services SDKs, this field is calculated automatically.

  • checksum_algorithm(ChecksumAlgorithm) / set_checksum_algorithm(Option<ChecksumAlgorithm>):

    Indicates the algorithm used to create the checksum for the object when using the SDK. This header will not provide any additional functionality if not using the SDK. When sending this header, there must be a corresponding x-amz-checksum or x-amz-trailer header sent. Otherwise, Amazon S3 fails the request with the HTTP status code 400 Bad Request. For more information, see Checking object integrity in the Amazon S3 User Guide.

    If you provide an individual checksum, Amazon S3 ignores any provided ChecksumAlgorithm parameter.

  • expected_bucket_owner(impl Into<String>) / set_expected_bucket_owner(Option<String>):

    The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code 403 Forbidden (access denied).

• On success, responds with PutObjectLockConfigurationOutput with field(s):
  • request_charged(Option<RequestCharged>):

    If present, indicates that the requester was successfully charged for the request.

• On failure, responds with SdkError<PutObjectLockConfigurationError>

impl Client

pub fn put_object_retention(&self) -> PutObjectRetentionFluentBuilder

Constructs a fluent builder for the PutObjectRetention operation.

• The fluent builder is configurable:
  • bucket(impl Into<String>) / set_bucket(Option<String>):

    The bucket name that contains the object you want to apply this Object Retention configuration to.

    When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using access points in the Amazon S3 User Guide.

  • key(impl Into<String>) / set_key(Option<String>):

    The key name for the object that you want to apply this Object Retention configuration to.

  • retention(ObjectLockRetention) / set_retention(Option<ObjectLockRetention>):

    The container element for the Object Retention configuration.

  • request_payer(RequestPayer) / set_request_payer(Option<RequestPayer>):

    Confirms that the requester knows that they will be charged for the request. Bucket owners need not specify this parameter in their requests. If either the source or destination Amazon S3 bucket has Requester Pays enabled, the requester will pay for corresponding charges to copy the object. For information about downloading objects from Requester Pays buckets, see Downloading Objects in Requester Pays Buckets in the Amazon S3 User Guide.

  • version_id(impl Into<String>) / set_version_id(Option<String>):

    The version ID for the object that you want to apply this Object Retention configuration to.

  • bypass_governance_retention(bool) / set_bypass_governance_retention(Option<bool>):

    Indicates whether this action should bypass Governance-mode restrictions.

  • content_md5(impl Into<String>) / set_content_md5(Option<String>):

    The MD5 hash for the request body.

    For requests made using the Amazon Web Services Command Line Interface (CLI) or Amazon Web Services SDKs, this field is calculated automatically.

  • checksum_algorithm(ChecksumAlgorithm) / set_checksum_algorithm(Option<ChecksumAlgorithm>):

    Indicates the algorithm used to create the checksum for the object when using the SDK. This header will not provide any additional functionality if not using the SDK. When sending this header, there must be a corresponding x-amz-checksum or x-amz-trailer header sent. Otherwise, Amazon S3 fails the request with the HTTP status code 400 Bad Request. For more information, see Checking object integrity in the Amazon S3 User Guide.

    If you provide an individual checksum, Amazon S3 ignores any provided ChecksumAlgorithm parameter.

  • expected_bucket_owner(impl Into<String>) / set_expected_bucket_owner(Option<String>):

    The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code 403 Forbidden (access denied).

• On success, responds with PutObjectRetentionOutput with field(s):
  • request_charged(Option<RequestCharged>):

    If present, indicates that the requester was successfully charged for the request.

• On failure, responds with SdkError<PutObjectRetentionError>

impl Client

pub fn put_object_tagging(&self) -> PutObjectTaggingFluentBuilder

Constructs a fluent builder for the PutObjectTagging operation.

• The fluent builder is configurable:
  • bucket(impl Into<String>) / set_bucket(Option<String>):

    The bucket name containing the object.

    When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using access points in the Amazon S3 User Guide.

    When you use this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When you use this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts access point ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see What is S3 on Outposts? in the Amazon S3 User Guide.

  • key(impl Into<String>) / set_key(Option<String>):

    Name of the object key.

  • version_id(impl Into<String>) / set_version_id(Option<String>):

    The versionId of the object that the tag-set will be added to.

  • content_md5(impl Into<String>) / set_content_md5(Option<String>):

    The MD5 hash for the request body.

    For requests made using the Amazon Web Services Command Line Interface (CLI) or Amazon Web Services SDKs, this field is calculated automatically.

  • checksum_algorithm(ChecksumAlgorithm) / set_checksum_algorithm(Option<ChecksumAlgorithm>):

    Indicates the algorithm used to create the checksum for the object when using the SDK. This header will not provide any additional functionality if not using the SDK. When sending this header, there must be a corresponding x-amz-checksum or x-amz-trailer header sent. Otherwise, Amazon S3 fails the request with the HTTP status code 400 Bad Request. For more information, see Checking object integrity in the Amazon S3 User Guide.

    If you provide an individual checksum, Amazon S3 ignores any provided ChecksumAlgorithm parameter.

  • tagging(Tagging) / set_tagging(Option<Tagging>):

    Container for the TagSet and Tag elements

  • expected_bucket_owner(impl Into<String>) / set_expected_bucket_owner(Option<String>):

    The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code 403 Forbidden (access denied).

  • request_payer(RequestPayer) / set_request_payer(Option<RequestPayer>):

    Confirms that the requester knows that they will be charged for the request. Bucket owners need not specify this parameter in their requests. If either the source or destination Amazon S3 bucket has Requester Pays enabled, the requester will pay for corresponding charges to copy the object. For information about downloading objects from Requester Pays buckets, see Downloading Objects in Requester Pays Buckets in the Amazon S3 User Guide.

• On success, responds with PutObjectTaggingOutput with field(s):
  • version_id(Option<String>):

    The versionId of the object the tag-set was added to.

• On failure, responds with SdkError<PutObjectTaggingError>

impl Client

pub fn put_public_access_block(&self) -> PutPublicAccessBlockFluentBuilder

Constructs a fluent builder for the PutPublicAccessBlock operation.

• The fluent builder is configurable:
  • bucket(impl Into<String>) / set_bucket(Option<String>):

    The name of the Amazon S3 bucket whose PublicAccessBlock configuration you want to set.

  • content_md5(impl Into<String>) / set_content_md5(Option<String>):

    The MD5 hash of the PutPublicAccessBlock request body.

    For requests made using the Amazon Web Services Command Line Interface (CLI) or Amazon Web Services SDKs, this field is calculated automatically.

  • checksum_algorithm(ChecksumAlgorithm) / set_checksum_algorithm(Option<ChecksumAlgorithm>):

    Indicates the algorithm used to create the checksum for the object when using the SDK. This header will not provide any additional functionality if not using the SDK. When sending this header, there must be a corresponding x-amz-checksum or x-amz-trailer header sent. Otherwise, Amazon S3 fails the request with the HTTP status code 400 Bad Request. For more information, see Checking object integrity in the Amazon S3 User Guide.

    If you provide an individual checksum, Amazon S3 ignores any provided ChecksumAlgorithm parameter.

  • public_access_block_configuration(PublicAccessBlockConfiguration) / set_public_access_block_configuration(Option<PublicAccessBlockConfiguration>):

    The PublicAccessBlock configuration that you want to apply to this Amazon S3 bucket. You can enable the configuration options in any combination. For more information about when Amazon S3 considers a bucket or object public, see The Meaning of “Public” in the Amazon S3 User Guide.

  • expected_bucket_owner(impl Into<String>) / set_expected_bucket_owner(Option<String>):

    The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code 403 Forbidden (access denied).

• On success, responds with PutPublicAccessBlockOutput
• On failure, responds with SdkError<PutPublicAccessBlockError>

impl Client

pub fn restore_object(&self) -> RestoreObjectFluentBuilder

Constructs a fluent builder for the RestoreObject operation.

• The fluent builder is configurable:
  • bucket(impl Into<String>) / set_bucket(Option<String>):

    The bucket name containing the object to restore.

    When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using access points in the Amazon S3 User Guide.

    When you use this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When you use this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts access point ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see What is S3 on Outposts? in the Amazon S3 User Guide.

  • key(impl Into<String>) / set_key(Option<String>):

    Object key for which the action was initiated.

  • version_id(impl Into<String>) / set_version_id(Option<String>):

    VersionId used to reference a specific version of the object.

  • restore_request(RestoreRequest) / set_restore_request(Option<RestoreRequest>):

    Container for restore job parameters.

  • request_payer(RequestPayer) / set_request_payer(Option<RequestPayer>):

    Confirms that the requester knows that they will be charged for the request. Bucket owners need not specify this parameter in their requests. If either the source or destination Amazon S3 bucket has Requester Pays enabled, the requester will pay for corresponding charges to copy the object. For information about downloading objects from Requester Pays buckets, see Downloading Objects in Requester Pays Buckets in the Amazon S3 User Guide.

  • checksum_algorithm(ChecksumAlgorithm) / set_checksum_algorithm(Option<ChecksumAlgorithm>):

    Indicates the algorithm used to create the checksum for the object when using the SDK. This header will not provide any additional functionality if not using the SDK. When sending this header, there must be a corresponding x-amz-checksum or x-amz-trailer header sent. Otherwise, Amazon S3 fails the request with the HTTP status code 400 Bad Request. For more information, see Checking object integrity in the Amazon S3 User Guide.

    If you provide an individual checksum, Amazon S3 ignores any provided ChecksumAlgorithm parameter.

  • expected_bucket_owner(impl Into<String>) / set_expected_bucket_owner(Option<String>):

    The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code 403 Forbidden (access denied).

• On success, responds with RestoreObjectOutput with field(s):
  • request_charged(Option<RequestCharged>):

    If present, indicates that the requester was successfully charged for the request.

  • restore_output_path(Option<String>):

    Indicates the path in the provided S3 output location where Select results will be restored to.

• On failure, responds with SdkError<RestoreObjectError>

impl Client

pub fn select_object_content(&self) -> SelectObjectContentFluentBuilder

Constructs a fluent builder for the SelectObjectContent operation.

• The fluent builder is configurable:
  • bucket(impl Into<String>) / set_bucket(Option<String>):

    The S3 bucket.

  • key(impl Into<String>) / set_key(Option<String>):

    The object key.

  • sse_customer_algorithm(impl Into<String>) / set_sse_customer_algorithm(Option<String>):

    The server-side encryption (SSE) algorithm used to encrypt the object. This parameter is needed only when the object was created using a checksum algorithm. For more information, see Protecting data using SSE-C keys in the Amazon S3 User Guide.

  • sse_customer_key(impl Into<String>) / set_sse_customer_key(Option<String>):

    The server-side encryption (SSE) customer managed key. This parameter is needed only when the object was created using a checksum algorithm. For more information, see Protecting data using SSE-C keys in the Amazon S3 User Guide.

  • sse_customer_key_md5(impl Into<String>) / set_sse_customer_key_md5(Option<String>):

    The MD5 server-side encryption (SSE) customer managed key. This parameter is needed only when the object was created using a checksum algorithm. For more information, see Protecting data using SSE-C keys in the Amazon S3 User Guide.

  • expression(impl Into<String>) / set_expression(Option<String>):

    The expression that is used to query the object.

  • expression_type(ExpressionType) / set_expression_type(Option<ExpressionType>):

    The type of the provided expression (for example, SQL).

  • request_progress(RequestProgress) / set_request_progress(Option<RequestProgress>):

    Specifies if periodic request progress information should be enabled.

  • input_serialization(InputSerialization) / set_input_serialization(Option<InputSerialization>):

    Describes the format of the data in the object that is being queried.

  • output_serialization(OutputSerialization) / set_output_serialization(Option<OutputSerialization>):

    Describes the format of the data that you want Amazon S3 to return in response.

  • scan_range(ScanRange) / set_scan_range(Option<ScanRange>):

    Specifies the byte range of the object to get the records from. A record is processed when its first byte is contained by the range. This parameter is optional, but when specified, it must not be empty. See RFC 2616, Section 14.35.1 about how to specify the start and end of the range.

    ScanRangemay be used in the following ways:

    • 50 100 - process only the records starting between the bytes 50 and 100 (inclusive, counting from zero)

    • 50 - process only the records starting after the byte 50

    • 50 - process only the records within the last 50 bytes of the file.

  • expected_bucket_owner(impl Into<String>) / set_expected_bucket_owner(Option<String>):

    The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code 403 Forbidden (access denied).

• On success, responds with SelectObjectContentOutput with field(s):
  • payload(Receiver<SelectObjectContentEventStream, SelectObjectContentEventStreamError>):

    The array of results.

• On failure, responds with SdkError<SelectObjectContentError>

impl Client

pub fn upload_part(&self) -> UploadPartFluentBuilder

Constructs a fluent builder for the UploadPart operation.

• The fluent builder is configurable:
  • body(ByteStream) / set_body(ByteStream):

    Object data.

  • bucket(impl Into<String>) / set_bucket(Option<String>):

    The name of the bucket to which the multipart upload was initiated.

    When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using access points in the Amazon S3 User Guide.

    When you use this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When you use this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts access point ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see What is S3 on Outposts? in the Amazon S3 User Guide.

  • content_length(i64) / set_content_length(Option<i64>):

    Size of the body in bytes. This parameter is useful when the size of the body cannot be determined automatically.

  • content_md5(impl Into<String>) / set_content_md5(Option<String>):

    The base64-encoded 128-bit MD5 digest of the part data. This parameter is auto-populated when using the command from the CLI. This parameter is required if object lock parameters are specified.

  • checksum_algorithm(ChecksumAlgorithm) / set_checksum_algorithm(Option<ChecksumAlgorithm>):

    Indicates the algorithm used to create the checksum for the object when using the SDK. This header will not provide any additional functionality if not using the SDK. When sending this header, there must be a corresponding x-amz-checksum or x-amz-trailer header sent. Otherwise, Amazon S3 fails the request with the HTTP status code 400 Bad Request. For more information, see Checking object integrity in the Amazon S3 User Guide.

    If you provide an individual checksum, Amazon S3 ignores any provided ChecksumAlgorithm parameter.

    This checksum algorithm must be the same for all parts and it match the checksum value supplied in the CreateMultipartUpload request.

  • checksum_crc32(impl Into<String>) / set_checksum_crc32(Option<String>):

    This header can be used as a data integrity check to verify that the data received is the same data that was originally sent. This header specifies the base64-encoded, 32-bit CRC32 checksum of the object. For more information, see Checking object integrity in the Amazon S3 User Guide.

  • checksum_crc32_c(impl Into<String>) / set_checksum_crc32_c(Option<String>):

    This header can be used as a data integrity check to verify that the data received is the same data that was originally sent. This header specifies the base64-encoded, 32-bit CRC32C checksum of the object. For more information, see Checking object integrity in the Amazon S3 User Guide.

  • checksum_sha1(impl Into<String>) / set_checksum_sha1(Option<String>):

    This header can be used as a data integrity check to verify that the data received is the same data that was originally sent. This header specifies the base64-encoded, 160-bit SHA-1 digest of the object. For more information, see Checking object integrity in the Amazon S3 User Guide.

  • checksum_sha256(impl Into<String>) / set_checksum_sha256(Option<String>):

    This header can be used as a data integrity check to verify that the data received is the same data that was originally sent. This header specifies the base64-encoded, 256-bit SHA-256 digest of the object. For more information, see Checking object integrity in the Amazon S3 User Guide.

  • key(impl Into<String>) / set_key(Option<String>):

    Object key for which the multipart upload was initiated.

  • part_number(i32) / set_part_number(Option<i32>):

    Part number of part being uploaded. This is a positive integer between 1 and 10,000.

  • upload_id(impl Into<String>) / set_upload_id(Option<String>):

    Upload ID identifying the multipart upload whose part is being uploaded.

  • sse_customer_algorithm(impl Into<String>) / set_sse_customer_algorithm(Option<String>):

    Specifies the algorithm to use to when encrypting the object (for example, AES256).

  • sse_customer_key(impl Into<String>) / set_sse_customer_key(Option<String>):

    Specifies the customer-provided encryption key for Amazon S3 to use in encrypting data. This value is used to store the object and then it is discarded; Amazon S3 does not store the encryption key. The key must be appropriate for use with the algorithm specified in the x-amz-server-side-encryption-customer-algorithm header. This must be the same encryption key specified in the initiate multipart upload request.

  • sse_customer_key_md5(impl Into<String>) / set_sse_customer_key_md5(Option<String>):

    Specifies the 128-bit MD5 digest of the encryption key according to RFC 1321. Amazon S3 uses this header for a message integrity check to ensure that the encryption key was transmitted without error.

  • request_payer(RequestPayer) / set_request_payer(Option<RequestPayer>):

    Confirms that the requester knows that they will be charged for the request. Bucket owners need not specify this parameter in their requests. If either the source or destination Amazon S3 bucket has Requester Pays enabled, the requester will pay for corresponding charges to copy the object. For information about downloading objects from Requester Pays buckets, see Downloading Objects in Requester Pays Buckets in the Amazon S3 User Guide.

  • expected_bucket_owner(impl Into<String>) / set_expected_bucket_owner(Option<String>):

    The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code 403 Forbidden (access denied).

• On success, responds with UploadPartOutput with field(s):
  • server_side_encryption(Option<ServerSideEncryption>):

    The server-side encryption algorithm used when storing this object in Amazon S3 (for example, AES256, aws:kms).

  • e_tag(Option<String>):

    Entity tag for the uploaded object.

  • checksum_crc32(Option<String>):

    The base64-encoded, 32-bit CRC32 checksum of the object. This will only be present if it was uploaded with the object. With multipart uploads, this may not be a checksum value of the object. For more information about how checksums are calculated with multipart uploads, see Checking object integrity in the Amazon S3 User Guide.

  • checksum_crc32_c(Option<String>):

    The base64-encoded, 32-bit CRC32C checksum of the object. This will only be present if it was uploaded with the object. With multipart uploads, this may not be a checksum value of the object. For more information about how checksums are calculated with multipart uploads, see Checking object integrity in the Amazon S3 User Guide.

  • checksum_sha1(Option<String>):

    The base64-encoded, 160-bit SHA-1 digest of the object. This will only be present if it was uploaded with the object. With multipart uploads, this may not be a checksum value of the object. For more information about how checksums are calculated with multipart uploads, see Checking object integrity in the Amazon S3 User Guide.

  • checksum_sha256(Option<String>):

    The base64-encoded, 256-bit SHA-256 digest of the object. This will only be present if it was uploaded with the object. With multipart uploads, this may not be a checksum value of the object. For more information about how checksums are calculated with multipart uploads, see Checking object integrity in the Amazon S3 User Guide.

  • sse_customer_algorithm(Option<String>):

    If server-side encryption with a customer-provided encryption key was requested, the response will include this header confirming the encryption algorithm used.

  • sse_customer_key_md5(Option<String>):

    If server-side encryption with a customer-provided encryption key was requested, the response will include this header to provide round-trip message integrity verification of the customer-provided encryption key.

  • ssekms_key_id(Option<String>):

    If present, specifies the ID of the Key Management Service (KMS) symmetric encryption customer managed key was used for the object.

  • bucket_key_enabled(bool):

    Indicates whether the multipart upload uses an S3 Bucket Key for server-side encryption with Key Management Service (KMS) keys (SSE-KMS).

  • request_charged(Option<RequestCharged>):

    If present, indicates that the requester was successfully charged for the request.

• On failure, responds with SdkError<UploadPartError>

impl Client

pub fn upload_part_copy(&self) -> UploadPartCopyFluentBuilder

Constructs a fluent builder for the UploadPartCopy operation.

• The fluent builder is configurable:
  • bucket(impl Into<String>) / set_bucket(Option<String>):

    The bucket name.

    When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using access points in the Amazon S3 User Guide.

    When you use this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When you use this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts access point ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see What is S3 on Outposts? in the Amazon S3 User Guide.

  • copy_source(impl Into<String>) / set_copy_source(Option<String>):

    Specifies the source object for the copy operation. You specify the value in one of two formats, depending on whether you want to access the source object through an access point:

    • For objects not accessed through an access point, specify the name of the source bucket and key of the source object, separated by a slash (/). For example, to copy the object reports/january.pdf from the bucket awsexamplebucket, use awsexamplebucket/reports/january.pdf. The value must be URL-encoded.

    • For objects accessed through access points, specify the Amazon Resource Name (ARN) of the object as accessed through the access point, in the format arn:aws:s3: : :accesspoint/ /object/ . For example, to copy the object reports/january.pdf through access point my-access-point owned by account 123456789012 in Region us-west-2, use the URL encoding of arn:aws:s3:us-west-2:123456789012:accesspoint/my-access-point/object/reports/january.pdf. The value must be URL encoded.

      Amazon S3 supports copy operations using access points only when the source and destination buckets are in the same Amazon Web Services Region.

      Alternatively, for objects accessed through Amazon S3 on Outposts, specify the ARN of the object as accessed in the format arn:aws:s3-outposts: : :outpost/ /object/ . For example, to copy the object reports/january.pdf through outpost my-outpost owned by account 123456789012 in Region us-west-2, use the URL encoding of arn:aws:s3-outposts:us-west-2:123456789012:outpost/my-outpost/object/reports/january.pdf. The value must be URL-encoded.

    To copy a specific version of an object, append ?versionId= to the value (for example, awsexamplebucket/reports/january.pdf?versionId=QUpfdndhfd8438MNFDN93jdnJFkdmqnh893). If you don’t specify a version ID, Amazon S3 copies the latest version of the source object.

  • copy_source_if_match(impl Into<String>) / set_copy_source_if_match(Option<String>):

    Copies the object if its entity tag (ETag) matches the specified tag.

  • copy_source_if_modified_since(DateTime) / set_copy_source_if_modified_since(Option<DateTime>):

    Copies the object if it has been modified since the specified time.

  • copy_source_if_none_match(impl Into<String>) / set_copy_source_if_none_match(Option<String>):

    Copies the object if its entity tag (ETag) is different than the specified ETag.

  • copy_source_if_unmodified_since(DateTime) / set_copy_source_if_unmodified_since(Option<DateTime>):

    Copies the object if it hasn’t been modified since the specified time.

  • copy_source_range(impl Into<String>) / set_copy_source_range(Option<String>):

    The range of bytes to copy from the source object. The range value must use the form bytes=first-last, where the first and last are the zero-based byte offsets to copy. For example, bytes=0-9 indicates that you want to copy the first 10 bytes of the source. You can copy a range only if the source object is greater than 5 MB.

  • key(impl Into<String>) / set_key(Option<String>):

    Object key for which the multipart upload was initiated.

  • part_number(i32) / set_part_number(Option<i32>):

    Part number of part being copied. This is a positive integer between 1 and 10,000.

  • upload_id(impl Into<String>) / set_upload_id(Option<String>):

    Upload ID identifying the multipart upload whose part is being copied.

  • sse_customer_algorithm(impl Into<String>) / set_sse_customer_algorithm(Option<String>):

    Specifies the algorithm to use to when encrypting the object (for example, AES256).

  • sse_customer_key(impl Into<String>) / set_sse_customer_key(Option<String>):

    Specifies the customer-provided encryption key for Amazon S3 to use in encrypting data. This value is used to store the object and then it is discarded; Amazon S3 does not store the encryption key. The key must be appropriate for use with the algorithm specified in the x-amz-server-side-encryption-customer-algorithm header. This must be the same encryption key specified in the initiate multipart upload request.

  • sse_customer_key_md5(impl Into<String>) / set_sse_customer_key_md5(Option<String>):

    Specifies the 128-bit MD5 digest of the encryption key according to RFC 1321. Amazon S3 uses this header for a message integrity check to ensure that the encryption key was transmitted without error.

  • copy_source_sse_customer_algorithm(impl Into<String>) / set_copy_source_sse_customer_algorithm(Option<String>):

    Specifies the algorithm to use when decrypting the source object (for example, AES256).

  • copy_source_sse_customer_key(impl Into<String>) / set_copy_source_sse_customer_key(Option<String>):

    Specifies the customer-provided encryption key for Amazon S3 to use to decrypt the source object. The encryption key provided in this header must be one that was used when the source object was created.

  • copy_source_sse_customer_key_md5(impl Into<String>) / set_copy_source_sse_customer_key_md5(Option<String>):

    Specifies the 128-bit MD5 digest of the encryption key according to RFC 1321. Amazon S3 uses this header for a message integrity check to ensure that the encryption key was transmitted without error.

  • request_payer(RequestPayer) / set_request_payer(Option<RequestPayer>):

    Confirms that the requester knows that they will be charged for the request. Bucket owners need not specify this parameter in their requests. If either the source or destination Amazon S3 bucket has Requester Pays enabled, the requester will pay for corresponding charges to copy the object. For information about downloading objects from Requester Pays buckets, see Downloading Objects in Requester Pays Buckets in the Amazon S3 User Guide.

  • expected_bucket_owner(impl Into<String>) / set_expected_bucket_owner(Option<String>):

    The account ID of the expected destination bucket owner. If the destination bucket is owned by a different account, the request fails with the HTTP status code 403 Forbidden (access denied).

  • expected_source_bucket_owner(impl Into<String>) / set_expected_source_bucket_owner(Option<String>):

    The account ID of the expected source bucket owner. If the source bucket is owned by a different account, the request fails with the HTTP status code 403 Forbidden (access denied).

• On success, responds with UploadPartCopyOutput with field(s):
  • copy_source_version_id(Option<String>):

    The version of the source object that was copied, if you have enabled versioning on the source bucket.

  • copy_part_result(Option<CopyPartResult>):

    Container for all response elements.

  • server_side_encryption(Option<ServerSideEncryption>):

    The server-side encryption algorithm used when storing this object in Amazon S3 (for example, AES256, aws:kms).

  • sse_customer_algorithm(Option<String>):

    If server-side encryption with a customer-provided encryption key was requested, the response will include this header confirming the encryption algorithm used.

  • sse_customer_key_md5(Option<String>):

    If server-side encryption with a customer-provided encryption key was requested, the response will include this header to provide round-trip message integrity verification of the customer-provided encryption key.

  • ssekms_key_id(Option<String>):

    If present, specifies the ID of the Key Management Service (KMS) symmetric encryption customer managed key that was used for the object.

  • bucket_key_enabled(bool):

    Indicates whether the multipart upload uses an S3 Bucket Key for server-side encryption with Key Management Service (KMS) keys (SSE-KMS).

  • request_charged(Option<RequestCharged>):

    If present, indicates that the requester was successfully charged for the request.

• On failure, responds with SdkError<UploadPartCopyError>

impl Client

pub fn write_get_object_response(&self) -> WriteGetObjectResponseFluentBuilder

Constructs a fluent builder for the WriteGetObjectResponse operation.

• The fluent builder is configurable:
  • request_route(impl Into<String>) / set_request_route(Option<String>):

    Route prefix to the HTTP URL generated.

  • request_token(impl Into<String>) / set_request_token(Option<String>):

    A single use encrypted token that maps WriteGetObjectResponse to the end user GetObject request.

  • body(ByteStream) / set_body(ByteStream):

    The object data.

  • status_code(i32) / set_status_code(Option<i32>):

    The integer status code for an HTTP response of a corresponding GetObject request. The following is a list of status codes.

    • 200 - OK

    • 206 - Partial Content

    • 304 - Not Modified

    • 400 - Bad Request

    • 401 - Unauthorized

    • 403 - Forbidden

    • 404 - Not Found

    • 405 - Method Not Allowed

    • 409 - Conflict

    • 411 - Length Required

    • 412 - Precondition Failed

    • 416 - Range Not Satisfiable

    • 500 - Internal Server Error

    • 503 - Service Unavailable

  • error_code(impl Into<String>) / set_error_code(Option<String>):

    A string that uniquely identifies an error condition. Returned in the tag of the error XML response for a corresponding GetObject call. Cannot be used with a successful StatusCode header or when the transformed object is provided in the body. All error codes from S3 are sentence-cased. The regular expression (regex) value is “^[A-Z][a-zA-Z]+$”.

  • error_message(impl Into<String>) / set_error_message(Option<String>):

    Contains a generic description of the error condition. Returned in the tag of the error XML response for a corresponding GetObject call. Cannot be used with a successful StatusCode header or when the transformed object is provided in body.

  • accept_ranges(impl Into<String>) / set_accept_ranges(Option<String>):

    Indicates that a range of bytes was specified.

  • cache_control(impl Into<String>) / set_cache_control(Option<String>):

    Specifies caching behavior along the request/reply chain.

  • content_disposition(impl Into<String>) / set_content_disposition(Option<String>):

    Specifies presentational information for the object.

  • content_encoding(impl Into<String>) / set_content_encoding(Option<String>):

    Specifies what content encodings have been applied to the object and thus what decoding mechanisms must be applied to obtain the media-type referenced by the Content-Type header field.

  • content_language(impl Into<String>) / set_content_language(Option<String>):

    The language the content is in.

  • content_length(i64) / set_content_length(Option<i64>):

    The size of the content body in bytes.

  • content_range(impl Into<String>) / set_content_range(Option<String>):

    The portion of the object returned in the response.

  • content_type(impl Into<String>) / set_content_type(Option<String>):

    A standard MIME type describing the format of the object data.

  • checksum_crc32(impl Into<String>) / set_checksum_crc32(Option<String>):

    This header can be used as a data integrity check to verify that the data received is the same data that was originally sent. This specifies the base64-encoded, 32-bit CRC32 checksum of the object returned by the Object Lambda function. This may not match the checksum for the object stored in Amazon S3. Amazon S3 will perform validation of the checksum values only when the original GetObject request required checksum validation. For more information about checksums, see Checking object integrity in the Amazon S3 User Guide.

    Only one checksum header can be specified at a time. If you supply multiple checksum headers, this request will fail.

  • checksum_crc32_c(impl Into<String>) / set_checksum_crc32_c(Option<String>):

    This header can be used as a data integrity check to verify that the data received is the same data that was originally sent. This specifies the base64-encoded, 32-bit CRC32C checksum of the object returned by the Object Lambda function. This may not match the checksum for the object stored in Amazon S3. Amazon S3 will perform validation of the checksum values only when the original GetObject request required checksum validation. For more information about checksums, see Checking object integrity in the Amazon S3 User Guide.

    Only one checksum header can be specified at a time. If you supply multiple checksum headers, this request will fail.

  • checksum_sha1(impl Into<String>) / set_checksum_sha1(Option<String>):

    This header can be used as a data integrity check to verify that the data received is the same data that was originally sent. This specifies the base64-encoded, 160-bit SHA-1 digest of the object returned by the Object Lambda function. This may not match the checksum for the object stored in Amazon S3. Amazon S3 will perform validation of the checksum values only when the original GetObject request required checksum validation. For more information about checksums, see Checking object integrity in the Amazon S3 User Guide.

    Only one checksum header can be specified at a time. If you supply multiple checksum headers, this request will fail.

  • checksum_sha256(impl Into<String>) / set_checksum_sha256(Option<String>):

    This header can be used as a data integrity check to verify that the data received is the same data that was originally sent. This specifies the base64-encoded, 256-bit SHA-256 digest of the object returned by the Object Lambda function. This may not match the checksum for the object stored in Amazon S3. Amazon S3 will perform validation of the checksum values only when the original GetObject request required checksum validation. For more information about checksums, see Checking object integrity in the Amazon S3 User Guide.

    Only one checksum header can be specified at a time. If you supply multiple checksum headers, this request will fail.

  • delete_marker(bool) / set_delete_marker(Option<bool>):

    Specifies whether an object stored in Amazon S3 is (true) or is not (false) a delete marker.

  • e_tag(impl Into<String>) / set_e_tag(Option<String>):

    An opaque identifier assigned by a web server to a specific version of a resource found at a URL.

  • expires(DateTime) / set_expires(Option<DateTime>):

    The date and time at which the object is no longer cacheable.

  • expiration(impl Into<String>) / set_expiration(Option<String>):

    If the object expiration is configured (see PUT Bucket lifecycle), the response includes this header. It includes the expiry-date and rule-id key-value pairs that provide the object expiration information. The value of the rule-id is URL-encoded.

  • last_modified(DateTime) / set_last_modified(Option<DateTime>):

    The date and time that the object was last modified.

  • missing_meta(i32) / set_missing_meta(Option<i32>):

    Set to the number of metadata entries not returned in x-amz-meta headers. This can happen if you create metadata using an API like SOAP that supports more flexible metadata than the REST API. For example, using SOAP, you can create metadata whose values are not legal HTTP headers.

  • metadata(impl Into<String>, impl Into<String>) / set_metadata(Option<HashMap<String, String>>):

    A map of metadata to store with the object in S3.

  • object_lock_mode(ObjectLockMode) / set_object_lock_mode(Option<ObjectLockMode>):

    Indicates whether an object stored in Amazon S3 has Object Lock enabled. For more information about S3 Object Lock, see Object Lock.

  • object_lock_legal_hold_status(ObjectLockLegalHoldStatus) / set_object_lock_legal_hold_status(Option<ObjectLockLegalHoldStatus>):

    Indicates whether an object stored in Amazon S3 has an active legal hold.

  • object_lock_retain_until_date(DateTime) / set_object_lock_retain_until_date(Option<DateTime>):

    The date and time when Object Lock is configured to expire.

  • parts_count(i32) / set_parts_count(Option<i32>):

    The count of parts this object has.

  • replication_status(ReplicationStatus) / set_replication_status(Option<ReplicationStatus>):

    Indicates if request involves bucket that is either a source or destination in a Replication rule. For more information about S3 Replication, see Replication.

  • request_charged(RequestCharged) / set_request_charged(Option<RequestCharged>):

    If present, indicates that the requester was successfully charged for the request.

  • restore(impl Into<String>) / set_restore(Option<String>):

    Provides information about object restoration operation and expiration time of the restored object copy.

  • server_side_encryption(ServerSideEncryption) / set_server_side_encryption(Option<ServerSideEncryption>):

    The server-side encryption algorithm used when storing requested object in Amazon S3 (for example, AES256, aws:kms).

  • sse_customer_algorithm(impl Into<String>) / set_sse_customer_algorithm(Option<String>):

    Encryption algorithm used if server-side encryption with a customer-provided encryption key was specified for object stored in Amazon S3.

  • ssekms_key_id(impl Into<String>) / set_ssekms_key_id(Option<String>):

    If present, specifies the ID (Key ID, Key ARN, or Key Alias) of the Amazon Web Services Key Management Service (Amazon Web Services KMS) symmetric encryption customer managed key that was used for stored in Amazon S3 object.

  • sse_customer_key_md5(impl Into<String>) / set_sse_customer_key_md5(Option<String>):

    128-bit MD5 digest of customer-provided encryption key used in Amazon S3 to encrypt data stored in S3. For more information, see Protecting data using server-side encryption with customer-provided encryption keys (SSE-C).

  • storage_class(StorageClass) / set_storage_class(Option<StorageClass>):

    Provides storage class information of the object. Amazon S3 returns this header for all objects except for S3 Standard storage class objects.

    For more information, see Storage Classes.

  • tag_count(i32) / set_tag_count(Option<i32>):

    The number of tags, if any, on the object.

  • version_id(impl Into<String>) / set_version_id(Option<String>):

    An ID used to reference a specific version of the object.

  • bucket_key_enabled(bool) / set_bucket_key_enabled(Option<bool>):

    Indicates whether the object stored in Amazon S3 uses an S3 bucket key for server-side encryption with Amazon Web Services KMS (SSE-KMS).

• On success, responds with WriteGetObjectResponseOutput
• On failure, responds with SdkError<WriteGetObjectResponseError>

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<(), Error>

Formats the value using the given formatter.