Struct RenameObjectInput 

#[non_exhaustive]
pub struct RenameObjectInput {
    pub bucket: Option<String>,
    pub key: Option<String>,
    pub rename_source: Option<String>,
    pub destination_if_match: Option<String>,
    pub destination_if_none_match: Option<String>,
    pub destination_if_modified_since: Option<DateTime>,
    pub destination_if_unmodified_since: Option<DateTime>,
    pub source_if_match: Option<String>,
    pub source_if_none_match: Option<String>,
    pub source_if_modified_since: Option<DateTime>,
    pub source_if_unmodified_since: Option<DateTime>,
    pub client_token: Option<String>,
}

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

bucket: Option<String>

The bucket name of the directory bucket containing the object.

You must use virtual-hosted-style requests in the format Bucket-name.s3express-zone-id.region-code.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--zone-id--x-s3 (for example, amzn-s3-demo-bucket--usw2-az1--x-s3). For information about bucket naming restrictions, see Directory bucket naming rules in the Amazon S3 User Guide.

key: Option<String>

Key name of the object to rename.

rename_source: Option<String>

Specifies the source for the rename operation. The value must be URL encoded.

destination_if_match: Option<String>

Renames the object only if the ETag (entity tag) value provided during the operation matches the ETag of the object in S3. The If-Match header field makes the request method conditional on ETags. If the ETag values do not match, the operation returns a 412 Precondition Failed error.

Expects the ETag value as a string.

destination_if_none_match: Option<String>

Renames the object only if the destination does not already exist in the specified directory bucket. If the object does exist when you send a request with If-None-Match:*, the S3 API will return a 412 Precondition Failed error, preventing an overwrite. The If-None-Match header prevents overwrites of existing data by validating that there's not an object with the same key name already in your directory bucket.

Expects the * character (asterisk).

destination_if_modified_since: Option<DateTime>

Renames the object if the destination exists and if it has been modified since the specified time.

destination_if_unmodified_since: Option<DateTime>

Renames the object if it hasn't been modified since the specified time.

source_if_match: Option<String>

Renames the object if the source exists and if its entity tag (ETag) matches the specified ETag.

source_if_none_match: Option<String>

Renames the object if the source exists and if its entity tag (ETag) is different than the specified ETag. If an asterisk (*) character is provided, the operation will fail and return a 412 Precondition Failed error.

source_if_modified_since: Option<DateTime>

Renames the object if the source exists and if it has been modified since the specified time.

source_if_unmodified_since: Option<DateTime>

Renames the object if the source exists and hasn't been modified since the specified time.

client_token: Option<String>

A unique string with a max of 64 ASCII characters in the ASCII range of 33 - 126.

RenameObject supports idempotency using a client token. To make an idempotent API request using RenameObject, specify a client token in the request. You should not reuse the same client token for other API requests. If you retry a request that completed successfully using the same client token and the same parameters, the retry succeeds without performing any further actions. If you retry a successful request using the same client token, but one or more of the parameters are different, the retry fails and an IdempotentParameterMismatch error is returned.

Implementations

impl RenameObjectInput

pub fn bucket(&self) -> Option<&str>

The bucket name of the directory bucket containing the object.

You must use virtual-hosted-style requests in the format Bucket-name.s3express-zone-id.region-code.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--zone-id--x-s3 (for example, amzn-s3-demo-bucket--usw2-az1--x-s3). For information about bucket naming restrictions, see Directory bucket naming rules in the Amazon S3 User Guide.

pub fn key(&self) -> Option<&str>

Key name of the object to rename.

pub fn rename_source(&self) -> Option<&str>

Specifies the source for the rename operation. The value must be URL encoded.

pub fn destination_if_match(&self) -> Option<&str>

Renames the object only if the ETag (entity tag) value provided during the operation matches the ETag of the object in S3. The If-Match header field makes the request method conditional on ETags. If the ETag values do not match, the operation returns a 412 Precondition Failed error.

Expects the ETag value as a string.

pub fn destination_if_none_match(&self) -> Option<&str>

Renames the object only if the destination does not already exist in the specified directory bucket. If the object does exist when you send a request with If-None-Match:*, the S3 API will return a 412 Precondition Failed error, preventing an overwrite. The If-None-Match header prevents overwrites of existing data by validating that there's not an object with the same key name already in your directory bucket.

Expects the * character (asterisk).

pub fn destination_if_modified_since(&self) -> Option<&DateTime>

Renames the object if the destination exists and if it has been modified since the specified time.

pub fn destination_if_unmodified_since(&self) -> Option<&DateTime>

Renames the object if it hasn't been modified since the specified time.

pub fn source_if_match(&self) -> Option<&str>

Renames the object if the source exists and if its entity tag (ETag) matches the specified ETag.

pub fn source_if_none_match(&self) -> Option<&str>

Renames the object if the source exists and if its entity tag (ETag) is different than the specified ETag. If an asterisk (*) character is provided, the operation will fail and return a 412 Precondition Failed error.

pub fn source_if_modified_since(&self) -> Option<&DateTime>

Renames the object if the source exists and if it has been modified since the specified time.

pub fn source_if_unmodified_since(&self) -> Option<&DateTime>

Renames the object if the source exists and hasn't been modified since the specified time.

pub fn client_token(&self) -> Option<&str>

A unique string with a max of 64 ASCII characters in the ASCII range of 33 - 126.

RenameObject supports idempotency using a client token. To make an idempotent API request using RenameObject, specify a client token in the request. You should not reuse the same client token for other API requests. If you retry a request that completed successfully using the same client token and the same parameters, the retry succeeds without performing any further actions. If you retry a successful request using the same client token, but one or more of the parameters are different, the retry fails and an IdempotentParameterMismatch error is returned.

impl RenameObjectInput

pub fn builder() -> RenameObjectInputBuilder

Creates a new builder-style object to manufacture RenameObjectInput.

Trait Implementations

impl Clone for RenameObjectInput

fn clone(&self) -> RenameObjectInput

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for RenameObjectInput

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

Formats the value using the given formatter.

impl PartialEq for RenameObjectInput

fn eq(&self, other: &RenameObjectInput) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for RenameObjectInput