Struct bonsaidb::keystorage::s3::aws_sdk_s3::operation::put_object::PutObjectInput
#[non_exhaustive]pub struct PutObjectInput {Show 37 fields
pub acl: Option<ObjectCannedAcl>,
pub body: ByteStream,
pub bucket: Option<String>,
pub cache_control: Option<String>,
pub content_disposition: Option<String>,
pub content_encoding: Option<String>,
pub content_language: Option<String>,
pub content_length: Option<i64>,
pub content_md5: Option<String>,
pub content_type: Option<String>,
pub checksum_algorithm: Option<ChecksumAlgorithm>,
pub checksum_crc32: Option<String>,
pub checksum_crc32_c: Option<String>,
pub checksum_sha1: Option<String>,
pub checksum_sha256: Option<String>,
pub expires: Option<DateTime>,
pub grant_full_control: Option<String>,
pub grant_read: Option<String>,
pub grant_read_acp: Option<String>,
pub grant_write_acp: Option<String>,
pub key: Option<String>,
pub metadata: Option<HashMap<String, String>>,
pub server_side_encryption: Option<ServerSideEncryption>,
pub storage_class: Option<StorageClass>,
pub website_redirect_location: Option<String>,
pub sse_customer_algorithm: Option<String>,
pub sse_customer_key: Option<String>,
pub sse_customer_key_md5: Option<String>,
pub ssekms_key_id: Option<String>,
pub ssekms_encryption_context: Option<String>,
pub bucket_key_enabled: Option<bool>,
pub request_payer: Option<RequestPayer>,
pub tagging: Option<String>,
pub object_lock_mode: Option<ObjectLockMode>,
pub object_lock_retain_until_date: Option<DateTime>,
pub object_lock_legal_hold_status: Option<ObjectLockLegalHoldStatus>,
pub expected_bucket_owner: Option<String>,
}Fields (Non-exhaustive)§
This struct is marked as non-exhaustive
Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.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: ByteStreamObject data.
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: 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: Option<String>Specifies presentational information for the object. For more information, see https://www.rfc-editor.org/rfc/rfc6266#section-4.
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: Option<String>The language the content is in.
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: 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: 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: 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: 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: 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: 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: 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: 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: 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: 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: Option<String>Allows grantee to read the object ACL.
This action is not supported by Amazon S3 on Outposts.
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: Option<String>Object key for which the PUT action was initiated.
metadata: Option<HashMap<String, String>>A map of metadata to store with the object in S3.
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: 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: 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: Option<String>Specifies the algorithm to use to when encrypting the object (for example, AES256).
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: 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: 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: 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: 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: 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: 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: Option<ObjectLockMode>The Object Lock mode that you want to apply to this object.
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: 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: 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).
Implementations§
§impl PutObjectInput
impl PutObjectInput
pub fn acl(&self) -> Option<&ObjectCannedAcl>
pub fn acl(&self) -> 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.
pub fn body(&self) -> &ByteStream
pub fn body(&self) -> &ByteStream
Object data.
pub fn bucket(&self) -> Option<&str>
pub fn bucket(&self) -> Option<&str>
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.
pub fn cache_control(&self) -> Option<&str>
pub fn cache_control(&self) -> Option<&str>
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.
pub fn content_disposition(&self) -> Option<&str>
pub fn content_disposition(&self) -> Option<&str>
Specifies presentational information for the object. For more information, see https://www.rfc-editor.org/rfc/rfc6266#section-4.
pub fn content_encoding(&self) -> Option<&str>
pub fn content_encoding(&self) -> Option<&str>
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.
pub fn content_language(&self) -> Option<&str>
pub fn content_language(&self) -> Option<&str>
The language the content is in.
pub fn content_length(&self) -> Option<i64>
pub fn 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.
pub fn content_md5(&self) -> Option<&str>
pub fn content_md5(&self) -> Option<&str>
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.
pub fn content_type(&self) -> Option<&str>
pub fn content_type(&self) -> Option<&str>
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.
pub fn checksum_algorithm(&self) -> Option<&ChecksumAlgorithm>
pub fn checksum_algorithm(&self) -> 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.
pub fn checksum_crc32(&self) -> Option<&str>
pub fn checksum_crc32(&self) -> Option<&str>
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.
pub fn checksum_crc32_c(&self) -> Option<&str>
pub fn checksum_crc32_c(&self) -> Option<&str>
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.
pub fn checksum_sha1(&self) -> Option<&str>
pub fn checksum_sha1(&self) -> Option<&str>
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.
pub fn checksum_sha256(&self) -> Option<&str>
pub fn checksum_sha256(&self) -> Option<&str>
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.
pub fn expires(&self) -> Option<&DateTime>
pub fn 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.
pub fn grant_full_control(&self) -> Option<&str>
pub fn grant_full_control(&self) -> Option<&str>
Gives the grantee READ, READ_ACP, and WRITE_ACP permissions on the object.
This action is not supported by Amazon S3 on Outposts.
pub fn grant_read(&self) -> Option<&str>
pub fn grant_read(&self) -> Option<&str>
Allows grantee to read the object data and its metadata.
This action is not supported by Amazon S3 on Outposts.
pub fn grant_read_acp(&self) -> Option<&str>
pub fn grant_read_acp(&self) -> Option<&str>
Allows grantee to read the object ACL.
This action is not supported by Amazon S3 on Outposts.
pub fn grant_write_acp(&self) -> Option<&str>
pub fn grant_write_acp(&self) -> Option<&str>
Allows grantee to write the ACL for the applicable object.
This action is not supported by Amazon S3 on Outposts.
pub fn metadata(&self) -> Option<&HashMap<String, String>>
pub fn metadata(&self) -> Option<&HashMap<String, String>>
A map of metadata to store with the object in S3.
pub fn server_side_encryption(&self) -> Option<&ServerSideEncryption>
pub fn server_side_encryption(&self) -> Option<&ServerSideEncryption>
The server-side encryption algorithm used when storing this object in Amazon S3 (for example, AES256, aws:kms, aws:kms:dsse).
pub fn storage_class(&self) -> Option<&StorageClass>
pub fn 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. Amazon S3 on Outposts only uses the OUTPOSTS Storage Class. For more information, see Storage Classes in the Amazon S3 User Guide.
pub fn website_redirect_location(&self) -> Option<&str>
pub fn website_redirect_location(&self) -> Option<&str>
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.
pub fn sse_customer_algorithm(&self) -> Option<&str>
pub fn sse_customer_algorithm(&self) -> Option<&str>
Specifies the algorithm to use to when encrypting the object (for example, AES256).
pub fn sse_customer_key(&self) -> Option<&str>
pub fn sse_customer_key(&self) -> Option<&str>
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.
pub fn sse_customer_key_md5(&self) -> Option<&str>
pub fn sse_customer_key_md5(&self) -> Option<&str>
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.
pub fn ssekms_key_id(&self) -> Option<&str>
pub fn ssekms_key_id(&self) -> Option<&str>
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.
pub fn ssekms_encryption_context(&self) -> Option<&str>
pub fn ssekms_encryption_context(&self) -> Option<&str>
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.
pub fn bucket_key_enabled(&self) -> Option<bool>
pub fn 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.
pub fn request_payer(&self) -> Option<&RequestPayer>
pub fn 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 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.
pub fn tagging(&self) -> Option<&str>
pub fn tagging(&self) -> Option<&str>
The tag-set for the object. The tag-set must be encoded as URL Query parameters. (For example, "Key1=Value1")
pub fn object_lock_mode(&self) -> Option<&ObjectLockMode>
pub fn object_lock_mode(&self) -> Option<&ObjectLockMode>
The Object Lock mode that you want to apply to this object.
pub fn object_lock_retain_until_date(&self) -> Option<&DateTime>
pub fn 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.
pub fn object_lock_legal_hold_status(
&self
) -> Option<&ObjectLockLegalHoldStatus>
pub fn 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.
pub fn expected_bucket_owner(&self) -> Option<&str>
pub fn expected_bucket_owner(&self) -> Option<&str>
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).
§impl PutObjectInput
impl PutObjectInput
pub fn builder() -> PutObjectInputBuilder
pub fn builder() -> PutObjectInputBuilder
Creates a new builder-style object to manufacture PutObjectInput.