Struct aws_sdk_s3::operation::put_object::builders::PutObjectFluentBuilder
source · pub struct PutObjectFluentBuilder { /* private fields */ }
Expand description
Fluent builder constructing a request to PutObject
.
Adds an object to a bucket.
-
Amazon S3 never adds partial objects; if you receive a success response, Amazon S3 added the entire object to the bucket. You cannot use
PutObject
to only update a single piece of metadata for an existing object. You must put the entire object with updated metadata if you want to update some values. -
If your bucket uses the bucket owner enforced setting for Object Ownership, ACLs are disabled and no longer affect permissions. All objects written to the bucket by any account will be owned by the bucket owner.
-
Directory buckets - For directory buckets, you must make requests for this API operation to the Zonal endpoint. These endpoints support virtual-hosted-style requests in the format
https://bucket_name.s3express-az_id.region.amazonaws.com/key-name
. Path-style requests are not supported. For more information, see Regional and Zonal endpoints in the Amazon S3 User Guide.
Amazon S3 is a distributed system. If it receives multiple write requests for the same object simultaneously, it overwrites all but the last object written. However, Amazon S3 provides features that can modify this behavior:
-
S3 Object Lock - To prevent objects from being deleted or overwritten, you can use Amazon S3 Object Lock in the Amazon S3 User Guide.
This functionality is not supported for directory buckets.
-
S3 Versioning - When you enable versioning for a bucket, if Amazon S3 receives multiple write requests for the same object simultaneously, it stores all versions of the objects. For each write request that is made to the same object, Amazon S3 automatically generates a unique version ID of that object being stored in Amazon S3. You can retrieve, replace, or delete any version of the object. For more information about versioning, see Adding Objects to Versioning-Enabled Buckets in the Amazon S3 User Guide. For information about returning the versioning state of a bucket, see GetBucketVersioning.
This functionality is not supported for directory buckets.
- Permissions
-
-
General purpose bucket permissions - The following permissions are required in your policies when your
PutObject
request includes specific headers.-
s3:PutObject
- To successfully complete thePutObject
request, you must always have thes3:PutObject
permission on a bucket to add an object to it. -
s3:PutObjectAcl
- To successfully change the objects ACL of yourPutObject
request, you must have thes3:PutObjectAcl
. -
s3:PutObjectTagging
- To successfully set the tag-set with yourPutObject
request, you must have thes3:PutObjectTagging
.
-
-
Directory bucket permissions - To grant access to this API operation on a directory bucket, we recommend that you use the
CreateSession
API operation for session-based authorization. Specifically, you grant thes3express:CreateSession
permission to the directory bucket in a bucket policy or an IAM identity-based policy. Then, you make theCreateSession
API call on the bucket to obtain a session token. With the session token in your request header, you can make API requests to this operation. After the session token expires, you make anotherCreateSession
API call to generate a new session token for use. Amazon Web Services CLI or SDKs create session and refresh the session token automatically to avoid service interruptions when a session expires. For more information about authorization, seeCreateSession
.
-
- Data integrity with Content-MD5
-
-
General purpose bucket - To ensure that data is not corrupted traversing the network, use the
Content-MD5
header. When you use this header, Amazon S3 checks the object against the provided MD5 value and, if they do not match, Amazon S3 returns an error. Alternatively, when the object's ETag is its MD5 digest, you can calculate the MD5 while putting the object to Amazon S3 and compare the returned ETag to the calculated MD5 value. -
Directory bucket - This functionality is not supported for directory buckets.
-
- HTTP Host header syntax
-
Directory buckets - The HTTP Host header syntax is
Bucket_name.s3express-az_id.region.amazonaws.com
.
For more information about related Amazon S3 APIs, see the following:
Implementations§
source§impl PutObjectFluentBuilder
impl PutObjectFluentBuilder
sourcepub fn as_input(&self) -> &PutObjectInputBuilder
pub fn as_input(&self) -> &PutObjectInputBuilder
Access the PutObject as a reference.
sourcepub async fn send(
self,
) -> Result<PutObjectOutput, SdkError<PutObjectError, HttpResponse>>
pub async fn send( self, ) -> Result<PutObjectOutput, SdkError<PutObjectError, HttpResponse>>
Sends the request and returns the response.
If an error occurs, an SdkError
will be returned with additional details that
can be matched against.
By default, any retryable failures will be retried twice. Retry behavior is configurable with the RetryConfig, which can be set when configuring the client.
sourcepub fn customize(
self,
) -> CustomizableOperation<PutObjectOutput, PutObjectError, Self>
pub fn customize( self, ) -> CustomizableOperation<PutObjectOutput, PutObjectError, Self>
Consumes this builder, creating a customizable operation that can be modified before being sent.
sourcepub async fn presigned(
self,
presigning_config: PresigningConfig,
) -> Result<PresignedRequest, SdkError<PutObjectError, HttpResponse>>
pub async fn presigned( self, presigning_config: PresigningConfig, ) -> Result<PresignedRequest, SdkError<PutObjectError, HttpResponse>>
Creates a presigned request for this operation.
The presigning_config
provides additional presigning-specific config values, such as the
amount of time the request should be valid for after creation.
Presigned requests can be given to other users or applications to access a resource or perform an operation without having access to the AWS security credentials.
Important: If you’re using credentials that can expire, such as those from STS AssumeRole or SSO, then the presigned request can only be valid for as long as the credentials used to create it are.
sourcepub fn acl(self, input: ObjectCannedAcl) -> Self
pub fn acl(self, input: ObjectCannedAcl) -> Self
The canned ACL to apply to the object. For more information, see Canned ACL in the Amazon S3 User Guide.
When adding a new object, you can use headers to grant ACL-based permissions to individual Amazon Web Services accounts or to predefined groups defined by Amazon S3. These permissions are then added to the ACL on the object. By default, all objects are private. Only the owner has full access control. For more information, see Access Control List (ACL) Overview and Managing ACLs Using the REST API in the Amazon S3 User Guide.
If the bucket that you're uploading objects to uses the bucket owner enforced setting for S3 Object Ownership, ACLs are disabled and no longer affect permissions. Buckets that use this setting only accept PUT requests that don't specify an ACL or PUT requests that specify 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. PUT requests that contain other ACLs (for example, custom grants to certain Amazon Web Services accounts) fail and return a 400
error with the error code AccessControlListNotSupported
. For more information, see Controlling ownership of objects and disabling ACLs in the Amazon S3 User Guide.
-
This functionality is not supported for directory buckets.
-
This functionality is not supported for Amazon S3 on Outposts.
sourcepub fn set_acl(self, input: Option<ObjectCannedAcl>) -> Self
pub fn set_acl(self, input: Option<ObjectCannedAcl>) -> Self
The canned ACL to apply to the object. For more information, see Canned ACL in the Amazon S3 User Guide.
When adding a new object, you can use headers to grant ACL-based permissions to individual Amazon Web Services accounts or to predefined groups defined by Amazon S3. These permissions are then added to the ACL on the object. By default, all objects are private. Only the owner has full access control. For more information, see Access Control List (ACL) Overview and Managing ACLs Using the REST API in the Amazon S3 User Guide.
If the bucket that you're uploading objects to uses the bucket owner enforced setting for S3 Object Ownership, ACLs are disabled and no longer affect permissions. Buckets that use this setting only accept PUT requests that don't specify an ACL or PUT requests that specify 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. PUT requests that contain other ACLs (for example, custom grants to certain Amazon Web Services accounts) fail and return a 400
error with the error code AccessControlListNotSupported
. For more information, see Controlling ownership of objects and disabling ACLs in the Amazon S3 User Guide.
-
This functionality is not supported for directory buckets.
-
This functionality is not supported for Amazon S3 on Outposts.
sourcepub fn get_acl(&self) -> &Option<ObjectCannedAcl>
pub fn get_acl(&self) -> &Option<ObjectCannedAcl>
The canned ACL to apply to the object. For more information, see Canned ACL in the Amazon S3 User Guide.
When adding a new object, you can use headers to grant ACL-based permissions to individual Amazon Web Services accounts or to predefined groups defined by Amazon S3. These permissions are then added to the ACL on the object. By default, all objects are private. Only the owner has full access control. For more information, see Access Control List (ACL) Overview and Managing ACLs Using the REST API in the Amazon S3 User Guide.
If the bucket that you're uploading objects to uses the bucket owner enforced setting for S3 Object Ownership, ACLs are disabled and no longer affect permissions. Buckets that use this setting only accept PUT requests that don't specify an ACL or PUT requests that specify 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. PUT requests that contain other ACLs (for example, custom grants to certain Amazon Web Services accounts) fail and return a 400
error with the error code AccessControlListNotSupported
. For more information, see Controlling ownership of objects and disabling ACLs in the Amazon S3 User Guide.
-
This functionality is not supported for directory buckets.
-
This functionality is not supported for Amazon S3 on Outposts.
sourcepub fn body(self, input: ByteStream) -> Self
pub fn body(self, input: ByteStream) -> Self
Object data.
sourcepub fn set_body(self, input: Option<ByteStream>) -> Self
pub fn set_body(self, input: Option<ByteStream>) -> Self
Object data.
sourcepub fn get_body(&self) -> &Option<ByteStream>
pub fn get_body(&self) -> &Option<ByteStream>
Object data.
sourcepub fn bucket(self, input: impl Into<String>) -> Self
pub fn bucket(self, input: impl Into<String>) -> Self
The bucket name to which the PUT action was initiated.
Directory buckets - When you use this operation with a directory bucket, you must use virtual-hosted-style requests in the format Bucket_name.s3express-az_id.region.amazonaws.com
. Path-style requests are not supported. Directory bucket names must be unique in the chosen Availability Zone. Bucket names must follow the format bucket_base_name--az-id--x-s3
(for example, DOC-EXAMPLE-BUCKET--usw2-az1--x-s3
). For information about bucket naming restrictions, see Directory bucket naming rules in the Amazon S3 User Guide.
Access points - When you use this action with an access point, you must provide the alias of the access point in place of the bucket name or specify the access point ARN. When using the access point ARN, 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.
Access points and Object Lambda access points are not supported by directory buckets.
S3 on Outposts - 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.
sourcepub fn set_bucket(self, input: Option<String>) -> Self
pub fn set_bucket(self, input: Option<String>) -> Self
The bucket name to which the PUT action was initiated.
Directory buckets - When you use this operation with a directory bucket, you must use virtual-hosted-style requests in the format Bucket_name.s3express-az_id.region.amazonaws.com
. Path-style requests are not supported. Directory bucket names must be unique in the chosen Availability Zone. Bucket names must follow the format bucket_base_name--az-id--x-s3
(for example, DOC-EXAMPLE-BUCKET--usw2-az1--x-s3
). For information about bucket naming restrictions, see Directory bucket naming rules in the Amazon S3 User Guide.
Access points - When you use this action with an access point, you must provide the alias of the access point in place of the bucket name or specify the access point ARN. When using the access point ARN, 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.
Access points and Object Lambda access points are not supported by directory buckets.
S3 on Outposts - 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.
sourcepub fn get_bucket(&self) -> &Option<String>
pub fn get_bucket(&self) -> &Option<String>
The bucket name to which the PUT action was initiated.
Directory buckets - When you use this operation with a directory bucket, you must use virtual-hosted-style requests in the format Bucket_name.s3express-az_id.region.amazonaws.com
. Path-style requests are not supported. Directory bucket names must be unique in the chosen Availability Zone. Bucket names must follow the format bucket_base_name--az-id--x-s3
(for example, DOC-EXAMPLE-BUCKET--usw2-az1--x-s3
). For information about bucket naming restrictions, see Directory bucket naming rules in the Amazon S3 User Guide.
Access points - When you use this action with an access point, you must provide the alias of the access point in place of the bucket name or specify the access point ARN. When using the access point ARN, 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.
Access points and Object Lambda access points are not supported by directory buckets.
S3 on Outposts - 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.
sourcepub fn cache_control(self, input: impl Into<String>) -> Self
pub fn cache_control(self, input: impl Into<String>) -> Self
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.
sourcepub fn set_cache_control(self, input: Option<String>) -> Self
pub fn set_cache_control(self, input: Option<String>) -> Self
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.
sourcepub fn get_cache_control(&self) -> &Option<String>
pub fn get_cache_control(&self) -> &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.
sourcepub fn content_disposition(self, input: impl Into<String>) -> Self
pub fn content_disposition(self, input: impl Into<String>) -> Self
Specifies presentational information for the object. For more information, see https://www.rfc-editor.org/rfc/rfc6266#section-4.
sourcepub fn set_content_disposition(self, input: Option<String>) -> Self
pub fn set_content_disposition(self, input: Option<String>) -> Self
Specifies presentational information for the object. For more information, see https://www.rfc-editor.org/rfc/rfc6266#section-4.
sourcepub fn get_content_disposition(&self) -> &Option<String>
pub fn get_content_disposition(&self) -> &Option<String>
Specifies presentational information for the object. For more information, see https://www.rfc-editor.org/rfc/rfc6266#section-4.
sourcepub fn content_encoding(self, input: impl Into<String>) -> Self
pub fn content_encoding(self, input: impl Into<String>) -> Self
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.
sourcepub fn set_content_encoding(self, input: Option<String>) -> Self
pub fn set_content_encoding(self, input: Option<String>) -> Self
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.
sourcepub fn get_content_encoding(&self) -> &Option<String>
pub fn get_content_encoding(&self) -> &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.
sourcepub fn content_language(self, input: impl Into<String>) -> Self
pub fn content_language(self, input: impl Into<String>) -> Self
The language the content is in.
sourcepub fn set_content_language(self, input: Option<String>) -> Self
pub fn set_content_language(self, input: Option<String>) -> Self
The language the content is in.
sourcepub fn get_content_language(&self) -> &Option<String>
pub fn get_content_language(&self) -> &Option<String>
The language the content is in.
sourcepub fn content_length(self, input: i64) -> Self
pub fn content_length(self, input: i64) -> Self
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.
sourcepub fn set_content_length(self, input: Option<i64>) -> Self
pub fn set_content_length(self, input: Option<i64>) -> Self
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.
sourcepub fn get_content_length(&self) -> &Option<i64>
pub fn get_content_length(&self) -> &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.
sourcepub fn content_md5(self, input: impl Into<String>) -> Self
pub fn content_md5(self, input: impl Into<String>) -> Self
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.
The Content-MD5
header is required for any request to upload an object with a retention period configured using Amazon S3 Object Lock. For more information about Amazon S3 Object Lock, see Amazon S3 Object Lock Overview in the Amazon S3 User Guide.
This functionality is not supported for directory buckets.
sourcepub fn set_content_md5(self, input: Option<String>) -> Self
pub fn set_content_md5(self, input: Option<String>) -> Self
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.
The Content-MD5
header is required for any request to upload an object with a retention period configured using Amazon S3 Object Lock. For more information about Amazon S3 Object Lock, see Amazon S3 Object Lock Overview in the Amazon S3 User Guide.
This functionality is not supported for directory buckets.
sourcepub fn get_content_md5(&self) -> &Option<String>
pub fn get_content_md5(&self) -> &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.
The Content-MD5
header is required for any request to upload an object with a retention period configured using Amazon S3 Object Lock. For more information about Amazon S3 Object Lock, see Amazon S3 Object Lock Overview in the Amazon S3 User Guide.
This functionality is not supported for directory buckets.
sourcepub fn content_type(self, input: impl Into<String>) -> Self
pub fn content_type(self, input: impl Into<String>) -> Self
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.
sourcepub fn set_content_type(self, input: Option<String>) -> Self
pub fn set_content_type(self, input: Option<String>) -> Self
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.
sourcepub fn get_content_type(&self) -> &Option<String>
pub fn get_content_type(&self) -> &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.
sourcepub fn checksum_algorithm(self, input: ChecksumAlgorithm) -> Self
pub fn checksum_algorithm(self, input: ChecksumAlgorithm) -> Self
Indicates the algorithm used to create the checksum for the object when you use the SDK. This header will not provide any additional functionality if you don't use the SDK. When you send this header, there must be a corresponding x-amz-checksum-algorithm
or x-amz-trailer
header sent. Otherwise, Amazon S3 fails the request with the HTTP status code 400 Bad Request
.
For the x-amz-checksum-algorithm
header, replace algorithm
with the supported algorithm from the following list:
-
CRC32
-
CRC32C
-
SHA1
-
SHA256
For more information, see Checking object integrity in the Amazon S3 User Guide.
If the individual checksum value you provide through x-amz-checksum-algorithm
doesn't match the checksum algorithm you set through x-amz-sdk-checksum-algorithm
, Amazon S3 ignores any provided ChecksumAlgorithm
parameter and uses the checksum algorithm that matches the provided value in x-amz-checksum-algorithm
.
For directory buckets, when you use Amazon Web Services SDKs, CRC32
is the default checksum algorithm that's used for performance.
sourcepub fn set_checksum_algorithm(self, input: Option<ChecksumAlgorithm>) -> Self
pub fn set_checksum_algorithm(self, input: Option<ChecksumAlgorithm>) -> Self
Indicates the algorithm used to create the checksum for the object when you use the SDK. This header will not provide any additional functionality if you don't use the SDK. When you send this header, there must be a corresponding x-amz-checksum-algorithm
or x-amz-trailer
header sent. Otherwise, Amazon S3 fails the request with the HTTP status code 400 Bad Request
.
For the x-amz-checksum-algorithm
header, replace algorithm
with the supported algorithm from the following list:
-
CRC32
-
CRC32C
-
SHA1
-
SHA256
For more information, see Checking object integrity in the Amazon S3 User Guide.
If the individual checksum value you provide through x-amz-checksum-algorithm
doesn't match the checksum algorithm you set through x-amz-sdk-checksum-algorithm
, Amazon S3 ignores any provided ChecksumAlgorithm
parameter and uses the checksum algorithm that matches the provided value in x-amz-checksum-algorithm
.
For directory buckets, when you use Amazon Web Services SDKs, CRC32
is the default checksum algorithm that's used for performance.
sourcepub fn get_checksum_algorithm(&self) -> &Option<ChecksumAlgorithm>
pub fn get_checksum_algorithm(&self) -> &Option<ChecksumAlgorithm>
Indicates the algorithm used to create the checksum for the object when you use the SDK. This header will not provide any additional functionality if you don't use the SDK. When you send this header, there must be a corresponding x-amz-checksum-algorithm
or x-amz-trailer
header sent. Otherwise, Amazon S3 fails the request with the HTTP status code 400 Bad Request
.
For the x-amz-checksum-algorithm
header, replace algorithm
with the supported algorithm from the following list:
-
CRC32
-
CRC32C
-
SHA1
-
SHA256
For more information, see Checking object integrity in the Amazon S3 User Guide.
If the individual checksum value you provide through x-amz-checksum-algorithm
doesn't match the checksum algorithm you set through x-amz-sdk-checksum-algorithm
, Amazon S3 ignores any provided ChecksumAlgorithm
parameter and uses the checksum algorithm that matches the provided value in x-amz-checksum-algorithm
.
For directory buckets, when you use Amazon Web Services SDKs, CRC32
is the default checksum algorithm that's used for performance.
sourcepub fn checksum_crc32(self, input: impl Into<String>) -> Self
pub fn checksum_crc32(self, input: impl Into<String>) -> Self
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.
sourcepub fn set_checksum_crc32(self, input: Option<String>) -> Self
pub fn set_checksum_crc32(self, input: Option<String>) -> Self
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.
sourcepub fn get_checksum_crc32(&self) -> &Option<String>
pub fn get_checksum_crc32(&self) -> &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.
sourcepub fn checksum_crc32_c(self, input: impl Into<String>) -> Self
pub fn checksum_crc32_c(self, input: impl Into<String>) -> Self
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.
sourcepub fn set_checksum_crc32_c(self, input: Option<String>) -> Self
pub fn set_checksum_crc32_c(self, input: Option<String>) -> Self
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.
sourcepub fn get_checksum_crc32_c(&self) -> &Option<String>
pub fn get_checksum_crc32_c(&self) -> &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.
sourcepub fn checksum_sha1(self, input: impl Into<String>) -> Self
pub fn checksum_sha1(self, input: impl Into<String>) -> Self
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.
sourcepub fn set_checksum_sha1(self, input: Option<String>) -> Self
pub fn set_checksum_sha1(self, input: Option<String>) -> Self
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.
sourcepub fn get_checksum_sha1(&self) -> &Option<String>
pub fn get_checksum_sha1(&self) -> &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.
sourcepub fn checksum_sha256(self, input: impl Into<String>) -> Self
pub fn checksum_sha256(self, input: impl Into<String>) -> Self
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.
sourcepub fn set_checksum_sha256(self, input: Option<String>) -> Self
pub fn set_checksum_sha256(self, input: Option<String>) -> Self
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.
sourcepub fn get_checksum_sha256(&self) -> &Option<String>
pub fn get_checksum_sha256(&self) -> &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.
sourcepub fn expires(self, input: DateTime) -> Self
pub fn expires(self, input: DateTime) -> Self
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.
sourcepub fn set_expires(self, input: Option<DateTime>) -> Self
pub fn set_expires(self, input: Option<DateTime>) -> Self
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.
sourcepub fn get_expires(&self) -> &Option<DateTime>
pub fn get_expires(&self) -> &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.
sourcepub fn grant_full_control(self, input: impl Into<String>) -> Self
pub fn grant_full_control(self, input: impl Into<String>) -> Self
Gives the grantee READ, READ_ACP, and WRITE_ACP permissions on the object.
-
This functionality is not supported for directory buckets.
-
This functionality is not supported for Amazon S3 on Outposts.
sourcepub fn set_grant_full_control(self, input: Option<String>) -> Self
pub fn set_grant_full_control(self, input: Option<String>) -> Self
Gives the grantee READ, READ_ACP, and WRITE_ACP permissions on the object.
-
This functionality is not supported for directory buckets.
-
This functionality is not supported for Amazon S3 on Outposts.
sourcepub fn get_grant_full_control(&self) -> &Option<String>
pub fn get_grant_full_control(&self) -> &Option<String>
Gives the grantee READ, READ_ACP, and WRITE_ACP permissions on the object.
-
This functionality is not supported for directory buckets.
-
This functionality is not supported for Amazon S3 on Outposts.
sourcepub fn grant_read(self, input: impl Into<String>) -> Self
pub fn grant_read(self, input: impl Into<String>) -> Self
Allows grantee to read the object data and its metadata.
-
This functionality is not supported for directory buckets.
-
This functionality is not supported for Amazon S3 on Outposts.
sourcepub fn set_grant_read(self, input: Option<String>) -> Self
pub fn set_grant_read(self, input: Option<String>) -> Self
Allows grantee to read the object data and its metadata.
-
This functionality is not supported for directory buckets.
-
This functionality is not supported for Amazon S3 on Outposts.
sourcepub fn get_grant_read(&self) -> &Option<String>
pub fn get_grant_read(&self) -> &Option<String>
Allows grantee to read the object data and its metadata.
-
This functionality is not supported for directory buckets.
-
This functionality is not supported for Amazon S3 on Outposts.
sourcepub fn grant_read_acp(self, input: impl Into<String>) -> Self
pub fn grant_read_acp(self, input: impl Into<String>) -> Self
Allows grantee to read the object ACL.
-
This functionality is not supported for directory buckets.
-
This functionality is not supported for Amazon S3 on Outposts.
sourcepub fn set_grant_read_acp(self, input: Option<String>) -> Self
pub fn set_grant_read_acp(self, input: Option<String>) -> Self
Allows grantee to read the object ACL.
-
This functionality is not supported for directory buckets.
-
This functionality is not supported for Amazon S3 on Outposts.
sourcepub fn get_grant_read_acp(&self) -> &Option<String>
pub fn get_grant_read_acp(&self) -> &Option<String>
Allows grantee to read the object ACL.
-
This functionality is not supported for directory buckets.
-
This functionality is not supported for Amazon S3 on Outposts.
sourcepub fn grant_write_acp(self, input: impl Into<String>) -> Self
pub fn grant_write_acp(self, input: impl Into<String>) -> Self
Allows grantee to write the ACL for the applicable object.
-
This functionality is not supported for directory buckets.
-
This functionality is not supported for Amazon S3 on Outposts.
sourcepub fn set_grant_write_acp(self, input: Option<String>) -> Self
pub fn set_grant_write_acp(self, input: Option<String>) -> Self
Allows grantee to write the ACL for the applicable object.
-
This functionality is not supported for directory buckets.
-
This functionality is not supported for Amazon S3 on Outposts.
sourcepub fn get_grant_write_acp(&self) -> &Option<String>
pub fn get_grant_write_acp(&self) -> &Option<String>
Allows grantee to write the ACL for the applicable object.
-
This functionality is not supported for directory buckets.
-
This functionality is not supported for Amazon S3 on Outposts.
sourcepub fn key(self, input: impl Into<String>) -> Self
pub fn key(self, input: impl Into<String>) -> Self
Object key for which the PUT action was initiated.
sourcepub fn set_key(self, input: Option<String>) -> Self
pub fn set_key(self, input: Option<String>) -> Self
Object key for which the PUT action was initiated.
sourcepub fn metadata(self, k: impl Into<String>, v: impl Into<String>) -> Self
pub fn metadata(self, k: impl Into<String>, v: impl Into<String>) -> Self
Adds a key-value pair to Metadata
.
To override the contents of this collection use set_metadata
.
A map of metadata to store with the object in S3.
sourcepub fn set_metadata(self, input: Option<HashMap<String, String>>) -> Self
pub fn set_metadata(self, input: Option<HashMap<String, String>>) -> Self
A map of metadata to store with the object in S3.
sourcepub fn get_metadata(&self) -> &Option<HashMap<String, String>>
pub fn get_metadata(&self) -> &Option<HashMap<String, String>>
A map of metadata to store with the object in S3.
sourcepub fn server_side_encryption(self, input: ServerSideEncryption) -> Self
pub fn server_side_encryption(self, input: ServerSideEncryption) -> Self
The server-side encryption algorithm that was used when you store this object in Amazon S3 (for example, AES256
, aws:kms
, aws:kms:dsse
).
General purpose buckets - You have four mutually exclusive options to protect data using server-side encryption in Amazon S3, depending on how you choose to manage the encryption keys. Specifically, the encryption key options are Amazon S3 managed keys (SSE-S3), Amazon Web Services KMS keys (SSE-KMS or DSSE-KMS), and customer-provided keys (SSE-C). Amazon S3 encrypts data with server-side encryption by using Amazon S3 managed keys (SSE-S3) by default. You can optionally tell Amazon S3 to encrypt data at rest by using server-side encryption with other key options. For more information, see Using Server-Side Encryption in the Amazon S3 User Guide.
Directory buckets - For directory buckets, only the server-side encryption with Amazon S3 managed keys (SSE-S3) (AES256
) value is supported.
sourcepub fn set_server_side_encryption(
self,
input: Option<ServerSideEncryption>,
) -> Self
pub fn set_server_side_encryption( self, input: Option<ServerSideEncryption>, ) -> Self
The server-side encryption algorithm that was used when you store this object in Amazon S3 (for example, AES256
, aws:kms
, aws:kms:dsse
).
General purpose buckets - You have four mutually exclusive options to protect data using server-side encryption in Amazon S3, depending on how you choose to manage the encryption keys. Specifically, the encryption key options are Amazon S3 managed keys (SSE-S3), Amazon Web Services KMS keys (SSE-KMS or DSSE-KMS), and customer-provided keys (SSE-C). Amazon S3 encrypts data with server-side encryption by using Amazon S3 managed keys (SSE-S3) by default. You can optionally tell Amazon S3 to encrypt data at rest by using server-side encryption with other key options. For more information, see Using Server-Side Encryption in the Amazon S3 User Guide.
Directory buckets - For directory buckets, only the server-side encryption with Amazon S3 managed keys (SSE-S3) (AES256
) value is supported.
sourcepub fn get_server_side_encryption(&self) -> &Option<ServerSideEncryption>
pub fn get_server_side_encryption(&self) -> &Option<ServerSideEncryption>
The server-side encryption algorithm that was used when you store this object in Amazon S3 (for example, AES256
, aws:kms
, aws:kms:dsse
).
General purpose buckets - You have four mutually exclusive options to protect data using server-side encryption in Amazon S3, depending on how you choose to manage the encryption keys. Specifically, the encryption key options are Amazon S3 managed keys (SSE-S3), Amazon Web Services KMS keys (SSE-KMS or DSSE-KMS), and customer-provided keys (SSE-C). Amazon S3 encrypts data with server-side encryption by using Amazon S3 managed keys (SSE-S3) by default. You can optionally tell Amazon S3 to encrypt data at rest by using server-side encryption with other key options. For more information, see Using Server-Side Encryption in the Amazon S3 User Guide.
Directory buckets - For directory buckets, only the server-side encryption with Amazon S3 managed keys (SSE-S3) (AES256
) value is supported.
sourcepub fn storage_class(self, input: StorageClass) -> Self
pub fn storage_class(self, input: StorageClass) -> Self
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. For more information, see Storage Classes in the Amazon S3 User Guide.
-
For directory buckets, only the S3 Express One Zone storage class is supported to store newly created objects.
-
Amazon S3 on Outposts only uses the OUTPOSTS Storage Class.
sourcepub fn set_storage_class(self, input: Option<StorageClass>) -> Self
pub fn set_storage_class(self, input: Option<StorageClass>) -> Self
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. For more information, see Storage Classes in the Amazon S3 User Guide.
-
For directory buckets, only the S3 Express One Zone storage class is supported to store newly created objects.
-
Amazon S3 on Outposts only uses the OUTPOSTS Storage Class.
sourcepub fn get_storage_class(&self) -> &Option<StorageClass>
pub fn get_storage_class(&self) -> &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. For more information, see Storage Classes in the Amazon S3 User Guide.
-
For directory buckets, only the S3 Express One Zone storage class is supported to store newly created objects.
-
Amazon S3 on Outposts only uses the OUTPOSTS Storage Class.
sourcepub fn website_redirect_location(self, input: impl Into<String>) -> Self
pub fn website_redirect_location(self, input: impl Into<String>) -> Self
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 Amazon S3 User Guide.
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 in the Amazon S3 User Guide.
This functionality is not supported for directory buckets.
sourcepub fn set_website_redirect_location(self, input: Option<String>) -> Self
pub fn set_website_redirect_location(self, input: Option<String>) -> Self
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 Amazon S3 User Guide.
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 in the Amazon S3 User Guide.
This functionality is not supported for directory buckets.
sourcepub fn get_website_redirect_location(&self) -> &Option<String>
pub fn get_website_redirect_location(&self) -> &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 Amazon S3 User Guide.
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 in the Amazon S3 User Guide.
This functionality is not supported for directory buckets.
sourcepub fn sse_customer_algorithm(self, input: impl Into<String>) -> Self
pub fn sse_customer_algorithm(self, input: impl Into<String>) -> Self
Specifies the algorithm to use when encrypting the object (for example, AES256
).
This functionality is not supported for directory buckets.
sourcepub fn set_sse_customer_algorithm(self, input: Option<String>) -> Self
pub fn set_sse_customer_algorithm(self, input: Option<String>) -> Self
Specifies the algorithm to use when encrypting the object (for example, AES256
).
This functionality is not supported for directory buckets.
sourcepub fn get_sse_customer_algorithm(&self) -> &Option<String>
pub fn get_sse_customer_algorithm(&self) -> &Option<String>
Specifies the algorithm to use when encrypting the object (for example, AES256
).
This functionality is not supported for directory buckets.
sourcepub fn sse_customer_key(self, input: impl Into<String>) -> Self
pub fn sse_customer_key(self, input: impl Into<String>) -> Self
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 functionality is not supported for directory buckets.
sourcepub fn set_sse_customer_key(self, input: Option<String>) -> Self
pub fn set_sse_customer_key(self, input: Option<String>) -> Self
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 functionality is not supported for directory buckets.
sourcepub fn get_sse_customer_key(&self) -> &Option<String>
pub fn get_sse_customer_key(&self) -> &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 functionality is not supported for directory buckets.
sourcepub fn sse_customer_key_md5(self, input: impl Into<String>) -> Self
pub fn sse_customer_key_md5(self, input: impl Into<String>) -> Self
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.
This functionality is not supported for directory buckets.
sourcepub fn set_sse_customer_key_md5(self, input: Option<String>) -> Self
pub fn set_sse_customer_key_md5(self, input: Option<String>) -> Self
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.
This functionality is not supported for directory buckets.
sourcepub fn get_sse_customer_key_md5(&self) -> &Option<String>
pub fn get_sse_customer_key_md5(&self) -> &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.
This functionality is not supported for directory buckets.
sourcepub fn ssekms_key_id(self, input: impl Into<String>) -> Self
pub fn ssekms_key_id(self, input: impl Into<String>) -> Self
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.
This functionality is not supported for directory buckets.
sourcepub fn set_ssekms_key_id(self, input: Option<String>) -> Self
pub fn set_ssekms_key_id(self, input: Option<String>) -> Self
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.
This functionality is not supported for directory buckets.
sourcepub fn get_ssekms_key_id(&self) -> &Option<String>
pub fn get_ssekms_key_id(&self) -> &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.
This functionality is not supported for directory buckets.
sourcepub fn ssekms_encryption_context(self, input: impl Into<String>) -> Self
pub fn ssekms_encryption_context(self, input: impl Into<String>) -> Self
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. This value must be explicitly added during CopyObject
operations.
This functionality is not supported for directory buckets.
sourcepub fn set_ssekms_encryption_context(self, input: Option<String>) -> Self
pub fn set_ssekms_encryption_context(self, input: Option<String>) -> Self
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. This value must be explicitly added during CopyObject
operations.
This functionality is not supported for directory buckets.
sourcepub fn get_ssekms_encryption_context(&self) -> &Option<String>
pub fn get_ssekms_encryption_context(&self) -> &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. This value must be explicitly added during CopyObject
operations.
This functionality is not supported for directory buckets.
sourcepub fn bucket_key_enabled(self, input: bool) -> Self
pub fn bucket_key_enabled(self, input: bool) -> Self
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.
This functionality is not supported for directory buckets.
sourcepub fn set_bucket_key_enabled(self, input: Option<bool>) -> Self
pub fn set_bucket_key_enabled(self, input: Option<bool>) -> Self
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.
This functionality is not supported for directory buckets.
sourcepub fn get_bucket_key_enabled(&self) -> &Option<bool>
pub fn get_bucket_key_enabled(&self) -> &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.
This functionality is not supported for directory buckets.
sourcepub fn request_payer(self, input: RequestPayer) -> Self
pub fn request_payer(self, input: RequestPayer) -> Self
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 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.
This functionality is not supported for directory buckets.
sourcepub fn set_request_payer(self, input: Option<RequestPayer>) -> Self
pub fn set_request_payer(self, input: Option<RequestPayer>) -> Self
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 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.
This functionality is not supported for directory buckets.
sourcepub fn get_request_payer(&self) -> &Option<RequestPayer>
pub fn get_request_payer(&self) -> &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 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.
This functionality is not supported for directory buckets.
sourcepub fn tagging(self, input: impl Into<String>) -> Self
pub fn tagging(self, input: impl Into<String>) -> Self
The tag-set for the object. The tag-set must be encoded as URL Query parameters. (For example, "Key1=Value1")
This functionality is not supported for directory buckets.
sourcepub fn set_tagging(self, input: Option<String>) -> Self
pub fn set_tagging(self, input: Option<String>) -> Self
The tag-set for the object. The tag-set must be encoded as URL Query parameters. (For example, "Key1=Value1")
This functionality is not supported for directory buckets.
sourcepub fn get_tagging(&self) -> &Option<String>
pub fn get_tagging(&self) -> &Option<String>
The tag-set for the object. The tag-set must be encoded as URL Query parameters. (For example, "Key1=Value1")
This functionality is not supported for directory buckets.
sourcepub fn object_lock_mode(self, input: ObjectLockMode) -> Self
pub fn object_lock_mode(self, input: ObjectLockMode) -> Self
The Object Lock mode that you want to apply to this object.
This functionality is not supported for directory buckets.
sourcepub fn set_object_lock_mode(self, input: Option<ObjectLockMode>) -> Self
pub fn set_object_lock_mode(self, input: Option<ObjectLockMode>) -> Self
The Object Lock mode that you want to apply to this object.
This functionality is not supported for directory buckets.
sourcepub fn get_object_lock_mode(&self) -> &Option<ObjectLockMode>
pub fn get_object_lock_mode(&self) -> &Option<ObjectLockMode>
The Object Lock mode that you want to apply to this object.
This functionality is not supported for directory buckets.
sourcepub fn object_lock_retain_until_date(self, input: DateTime) -> Self
pub fn object_lock_retain_until_date(self, input: DateTime) -> Self
The date and time when you want this object's Object Lock to expire. Must be formatted as a timestamp parameter.
This functionality is not supported for directory buckets.
sourcepub fn set_object_lock_retain_until_date(self, input: Option<DateTime>) -> Self
pub fn set_object_lock_retain_until_date(self, input: Option<DateTime>) -> Self
The date and time when you want this object's Object Lock to expire. Must be formatted as a timestamp parameter.
This functionality is not supported for directory buckets.
sourcepub fn get_object_lock_retain_until_date(&self) -> &Option<DateTime>
pub fn get_object_lock_retain_until_date(&self) -> &Option<DateTime>
The date and time when you want this object's Object Lock to expire. Must be formatted as a timestamp parameter.
This functionality is not supported for directory buckets.
sourcepub fn object_lock_legal_hold_status(
self,
input: ObjectLockLegalHoldStatus,
) -> Self
pub fn object_lock_legal_hold_status( self, input: ObjectLockLegalHoldStatus, ) -> Self
Specifies whether a legal hold will be applied to this object. For more information about S3 Object Lock, see Object Lock in the Amazon S3 User Guide.
This functionality is not supported for directory buckets.
sourcepub fn set_object_lock_legal_hold_status(
self,
input: Option<ObjectLockLegalHoldStatus>,
) -> Self
pub fn set_object_lock_legal_hold_status( self, input: Option<ObjectLockLegalHoldStatus>, ) -> Self
Specifies whether a legal hold will be applied to this object. For more information about S3 Object Lock, see Object Lock in the Amazon S3 User Guide.
This functionality is not supported for directory buckets.
sourcepub fn get_object_lock_legal_hold_status(
&self,
) -> &Option<ObjectLockLegalHoldStatus>
pub fn get_object_lock_legal_hold_status( &self, ) -> &Option<ObjectLockLegalHoldStatus>
Specifies whether a legal hold will be applied to this object. For more information about S3 Object Lock, see Object Lock in the Amazon S3 User Guide.
This functionality is not supported for directory buckets.
sourcepub fn expected_bucket_owner(self, input: impl Into<String>) -> Self
pub fn expected_bucket_owner(self, input: impl Into<String>) -> Self
The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden
(access denied).
sourcepub fn set_expected_bucket_owner(self, input: Option<String>) -> Self
pub fn set_expected_bucket_owner(self, input: Option<String>) -> Self
The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden
(access denied).
sourcepub fn get_expected_bucket_owner(&self) -> &Option<String>
pub fn get_expected_bucket_owner(&self) -> &Option<String>
The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden
(access denied).