Struct rusoto_s3::PutObjectRequest

pub struct PutObjectRequest {
    pub acl: Option<String>,
    pub body: Option<StreamingBody>,
    pub bucket: 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 expires: Option<String>,
    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: String,
    pub metadata: Option<HashMap<String, String>>,
    pub object_lock_legal_hold_status: Option<String>,
    pub object_lock_mode: Option<String>,
    pub object_lock_retain_until_date: Option<String>,
    pub request_payer: Option<String>,
    pub sse_customer_algorithm: Option<String>,
    pub sse_customer_key: Option<String>,
    pub sse_customer_key_md5: Option<String>,
    pub ssekms_encryption_context: Option<String>,
    pub ssekms_key_id: Option<String>,
    pub server_side_encryption: Option<String>,
    pub storage_class: Option<String>,
    pub tagging: Option<String>,
    pub website_redirect_location: Option<String>,
}

Fields

acl: Option<String>

The canned ACL to apply to the object. For more information, see Canned ACL.

body: Option<StreamingBody>

Object data.

bucket: String

Bucket name to which the PUT operation was initiated.

When using this API 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 operation using an access point through the AWS 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 Simple Storage Service Developer 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 http://www.w3.org/Protocols/rfc2616/rfc2616-sec19.html#sec19.5.1.

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 http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.11.

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 http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.13.

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 http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.17.

expires: Option<String>

The date and time at which the object is no longer cacheable. For more information, see http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.21.

grant_full_control: Option<String>

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

grant_read: Option<String>

Allows grantee to read the object data and its metadata.

grant_read_acp: Option<String>

Allows grantee to read the object ACL.

grant_write_acp: Option<String>

Allows grantee to write the ACL for the applicable object.

key: String

Object key for which the PUT operation was initiated.

metadata: Option<HashMap<String, String>>

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

object_lock_legal_hold_status: Option<String>

Specifies whether a legal hold will be applied to this object. For more information about S3 Object Lock, see Object Lock.

object_lock_mode: Option<String>

The Object Lock mode that you want to apply to this object.

object_lock_retain_until_date: Option<String>

The date and time when you want this object's Object Lock to expire.

request_payer: Option<String>

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_encryption_context: Option<String>

Specifies the AWS 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.

ssekms_key_id: Option<String>

If x-amz-server-side-encryption is present and has the value of aws:kms, this header specifies the ID of the AWS Key Management Service (AWS KMS) symmetrical customer managed customer master key (CMK) that was used for the object.

If the value of x-amz-server-side-encryption is aws:kms, this header specifies the ID of the symmetric customer managed AWS KMS CMK that will be used for the object. If you specify x-amz-server-side-encryption:aws:kms, but do not provide x-amz-server-side-encryption-aws-kms-key-id, Amazon S3 uses the AWS managed CMK in AWS to protect the data.

server_side_encryption: Option<String>

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

storage_class: Option<String>

If you don't specify, S3 Standard is the default storage class. Amazon S3 supports other storage classes.

tagging: Option<String>

The tag-set for the object. The tag-set must be encoded as URL Query parameters. (For example, "Key1=Value1")

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.

Trait Implementations

impl Debug for PutObjectRequest

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for PutObjectRequest

fn default() -> PutObjectRequest

Returns the “default value” for a type.

impl PreSignedRequest for PutObjectRequest

fn get_presigned_url(
    &self,
    region: &Region,
    credentials: &AwsCredentials,
    option: &PreSignedRequestOption
) -> Result<String, InvalidDnsNameError>

https://docs.aws.amazon.com/AmazonS3/latest/API/RESTObjectPUT.html