pub struct RenameObjectFluentBuilder { /* private fields */ }
Expand description
Fluent builder constructing a request to RenameObject
.
Renames an existing object in a directory bucket that uses the S3 Express One Zone storage class. You can use RenameObject
by specifying an existing object’s name as the source and the new name of the object as the destination within the same directory bucket.
RenameObject
is only supported for objects stored in the S3 Express One Zone storage class.
To prevent overwriting an object, you can use the If-None-Match
conditional header.
-
If-None-Match - Renames the object only if an object with the specified name does not already exist in the directory bucket. If you don't want to overwrite an existing object, you can add the
If-None-Match
conditional header with the value‘*’
in theRenameObject
request. Amazon S3 then returns a412 Precondition Failed
error if the object with the specified name already exists. For more information, see RFC 7232.
- Permissions
-
To grant access to the
RenameObject
operation on a directory bucket, we recommend that you use theCreateSession
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 directory 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. The Amazon Web Services CLI and SDKs will create and manage your session including refreshing the session token automatically to avoid service interruptions when a session expires. In your bucket policy, you can specify thes3express:SessionMode
condition key to control who can create aReadWrite
orReadOnly
session. AReadWrite
session is required for executing all the Zonal endpoint API operations, includingRenameObject
. For more information about authorization, seeCreateSession
. To learn more about Zonal endpoint API operations, see Authorizing Zonal endpoint API operations with CreateSession in the Amazon S3 User Guide. - HTTP Host header syntax
-
Directory buckets - The HTTP Host header syntax is
Bucket-name.s3express-zone-id.region-code.amazonaws.com
.
Implementations§
Source§impl RenameObjectFluentBuilder
impl RenameObjectFluentBuilder
Sourcepub fn as_input(&self) -> &RenameObjectInputBuilder
pub fn as_input(&self) -> &RenameObjectInputBuilder
Access the RenameObject as a reference.
Sourcepub async fn send(
self,
) -> Result<RenameObjectOutput, SdkError<RenameObjectError, HttpResponse>>
pub async fn send( self, ) -> Result<RenameObjectOutput, SdkError<RenameObjectError, 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<RenameObjectOutput, RenameObjectError, Self>
pub fn customize( self, ) -> CustomizableOperation<RenameObjectOutput, RenameObjectError, Self>
Consumes this builder, creating a customizable operation that can be modified before being sent.
Sourcepub fn bucket(self, input: impl Into<String>) -> Self
pub fn bucket(self, input: impl Into<String>) -> Self
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.
Sourcepub fn set_bucket(self, input: Option<String>) -> Self
pub fn set_bucket(self, input: Option<String>) -> Self
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.
Sourcepub fn get_bucket(&self) -> &Option<String>
pub fn get_bucket(&self) -> &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.
Sourcepub fn rename_source(self, input: impl Into<String>) -> Self
pub fn rename_source(self, input: impl Into<String>) -> Self
Specifies the source for the rename operation. The value must be URL encoded.
Sourcepub fn set_rename_source(self, input: Option<String>) -> Self
pub fn set_rename_source(self, input: Option<String>) -> Self
Specifies the source for the rename operation. The value must be URL encoded.
Sourcepub fn get_rename_source(&self) -> &Option<String>
pub fn get_rename_source(&self) -> &Option<String>
Specifies the source for the rename operation. The value must be URL encoded.
Sourcepub fn destination_if_match(self, input: impl Into<String>) -> Self
pub fn destination_if_match(self, input: impl Into<String>) -> Self
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.
Sourcepub fn set_destination_if_match(self, input: Option<String>) -> Self
pub fn set_destination_if_match(self, input: Option<String>) -> Self
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.
Sourcepub fn get_destination_if_match(&self) -> &Option<String>
pub fn get_destination_if_match(&self) -> &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.
Sourcepub fn destination_if_none_match(self, input: impl Into<String>) -> Self
pub fn destination_if_none_match(self, input: impl Into<String>) -> Self
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).
Sourcepub fn set_destination_if_none_match(self, input: Option<String>) -> Self
pub fn set_destination_if_none_match(self, input: Option<String>) -> Self
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).
Sourcepub fn get_destination_if_none_match(&self) -> &Option<String>
pub fn get_destination_if_none_match(&self) -> &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).
Sourcepub fn destination_if_modified_since(self, input: DateTime) -> Self
pub fn destination_if_modified_since(self, input: DateTime) -> Self
Renames the object if the destination exists and if it has been modified since the specified time.
Sourcepub fn set_destination_if_modified_since(self, input: Option<DateTime>) -> Self
pub fn set_destination_if_modified_since(self, input: Option<DateTime>) -> Self
Renames the object if the destination exists and if it has been modified since the specified time.
Sourcepub fn get_destination_if_modified_since(&self) -> &Option<DateTime>
pub fn get_destination_if_modified_since(&self) -> &Option<DateTime>
Renames the object if the destination exists and if it has been modified since the specified time.
Sourcepub fn destination_if_unmodified_since(self, input: DateTime) -> Self
pub fn destination_if_unmodified_since(self, input: DateTime) -> Self
Renames the object if it hasn't been modified since the specified time.
Sourcepub fn set_destination_if_unmodified_since(
self,
input: Option<DateTime>,
) -> Self
pub fn set_destination_if_unmodified_since( self, input: Option<DateTime>, ) -> Self
Renames the object if it hasn't been modified since the specified time.
Sourcepub fn get_destination_if_unmodified_since(&self) -> &Option<DateTime>
pub fn get_destination_if_unmodified_since(&self) -> &Option<DateTime>
Renames the object if it hasn't been modified since the specified time.
Sourcepub fn source_if_match(self, input: impl Into<String>) -> Self
pub fn source_if_match(self, input: impl Into<String>) -> Self
Renames the object if the source exists and if its entity tag (ETag) matches the specified ETag.
Sourcepub fn set_source_if_match(self, input: Option<String>) -> Self
pub fn set_source_if_match(self, input: Option<String>) -> Self
Renames the object if the source exists and if its entity tag (ETag) matches the specified ETag.
Sourcepub fn get_source_if_match(&self) -> &Option<String>
pub fn get_source_if_match(&self) -> &Option<String>
Renames the object if the source exists and if its entity tag (ETag) matches the specified ETag.
Sourcepub fn source_if_none_match(self, input: impl Into<String>) -> Self
pub fn source_if_none_match(self, input: impl Into<String>) -> Self
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.
Sourcepub fn set_source_if_none_match(self, input: Option<String>) -> Self
pub fn set_source_if_none_match(self, input: Option<String>) -> Self
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.
Sourcepub fn get_source_if_none_match(&self) -> &Option<String>
pub fn get_source_if_none_match(&self) -> &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.
Sourcepub fn source_if_modified_since(self, input: DateTime) -> Self
pub fn source_if_modified_since(self, input: DateTime) -> Self
Renames the object if the source exists and if it has been modified since the specified time.
Sourcepub fn set_source_if_modified_since(self, input: Option<DateTime>) -> Self
pub fn set_source_if_modified_since(self, input: Option<DateTime>) -> Self
Renames the object if the source exists and if it has been modified since the specified time.
Sourcepub fn get_source_if_modified_since(&self) -> &Option<DateTime>
pub fn get_source_if_modified_since(&self) -> &Option<DateTime>
Renames the object if the source exists and if it has been modified since the specified time.
Sourcepub fn source_if_unmodified_since(self, input: DateTime) -> Self
pub fn source_if_unmodified_since(self, input: DateTime) -> Self
Renames the object if the source exists and hasn't been modified since the specified time.
Sourcepub fn set_source_if_unmodified_since(self, input: Option<DateTime>) -> Self
pub fn set_source_if_unmodified_since(self, input: Option<DateTime>) -> Self
Renames the object if the source exists and hasn't been modified since the specified time.
Sourcepub fn get_source_if_unmodified_since(&self) -> &Option<DateTime>
pub fn get_source_if_unmodified_since(&self) -> &Option<DateTime>
Renames the object if the source exists and hasn't been modified since the specified time.
Sourcepub fn client_token(self, input: impl Into<String>) -> Self
pub fn client_token(self, input: impl Into<String>) -> Self
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.
Sourcepub fn set_client_token(self, input: Option<String>) -> Self
pub fn set_client_token(self, input: Option<String>) -> Self
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.
Sourcepub fn get_client_token(&self) -> &Option<String>
pub fn get_client_token(&self) -> &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.
Trait Implementations§
Source§impl Clone for RenameObjectFluentBuilder
impl Clone for RenameObjectFluentBuilder
Source§fn clone(&self) -> RenameObjectFluentBuilder
fn clone(&self) -> RenameObjectFluentBuilder
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moreAuto Trait Implementations§
impl Freeze for RenameObjectFluentBuilder
impl !RefUnwindSafe for RenameObjectFluentBuilder
impl Send for RenameObjectFluentBuilder
impl Sync for RenameObjectFluentBuilder
impl Unpin for RenameObjectFluentBuilder
impl !UnwindSafe for RenameObjectFluentBuilder
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
Source§impl<T> Instrument for T
impl<T> Instrument for T
Source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
Source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left
is true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left(&self)
returns true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read moreSource§impl<T> Paint for Twhere
T: ?Sized,
impl<T> Paint for Twhere
T: ?Sized,
Source§fn fg(&self, value: Color) -> Painted<&T>
fn fg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self
with the foreground set to
value
.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like red()
and
green()
, which have the same functionality but are
pithier.
§Example
Set foreground color to white using fg()
:
use yansi::{Paint, Color};
painted.fg(Color::White);
Set foreground color to white using white()
.
use yansi::Paint;
painted.white();
Source§fn bright_black(&self) -> Painted<&T>
fn bright_black(&self) -> Painted<&T>
Source§fn bright_red(&self) -> Painted<&T>
fn bright_red(&self) -> Painted<&T>
Source§fn bright_green(&self) -> Painted<&T>
fn bright_green(&self) -> Painted<&T>
Source§fn bright_yellow(&self) -> Painted<&T>
fn bright_yellow(&self) -> Painted<&T>
Source§fn bright_blue(&self) -> Painted<&T>
fn bright_blue(&self) -> Painted<&T>
Source§fn bright_magenta(&self) -> Painted<&T>
fn bright_magenta(&self) -> Painted<&T>
Source§fn bright_cyan(&self) -> Painted<&T>
fn bright_cyan(&self) -> Painted<&T>
Source§fn bright_white(&self) -> Painted<&T>
fn bright_white(&self) -> Painted<&T>
Source§fn bg(&self, value: Color) -> Painted<&T>
fn bg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self
with the background set to
value
.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like on_red()
and
on_green()
, which have the same functionality but
are pithier.
§Example
Set background color to red using fg()
:
use yansi::{Paint, Color};
painted.bg(Color::Red);
Set background color to red using on_red()
.
use yansi::Paint;
painted.on_red();
Source§fn on_primary(&self) -> Painted<&T>
fn on_primary(&self) -> Painted<&T>
Source§fn on_magenta(&self) -> Painted<&T>
fn on_magenta(&self) -> Painted<&T>
Source§fn on_bright_black(&self) -> Painted<&T>
fn on_bright_black(&self) -> Painted<&T>
Source§fn on_bright_red(&self) -> Painted<&T>
fn on_bright_red(&self) -> Painted<&T>
Source§fn on_bright_green(&self) -> Painted<&T>
fn on_bright_green(&self) -> Painted<&T>
Source§fn on_bright_yellow(&self) -> Painted<&T>
fn on_bright_yellow(&self) -> Painted<&T>
Source§fn on_bright_blue(&self) -> Painted<&T>
fn on_bright_blue(&self) -> Painted<&T>
Source§fn on_bright_magenta(&self) -> Painted<&T>
fn on_bright_magenta(&self) -> Painted<&T>
Source§fn on_bright_cyan(&self) -> Painted<&T>
fn on_bright_cyan(&self) -> Painted<&T>
Source§fn on_bright_white(&self) -> Painted<&T>
fn on_bright_white(&self) -> Painted<&T>
Source§fn attr(&self, value: Attribute) -> Painted<&T>
fn attr(&self, value: Attribute) -> Painted<&T>
Enables the styling Attribute
value
.
This method should be used rarely. Instead, prefer to use
attribute-specific builder methods like bold()
and
underline()
, which have the same functionality
but are pithier.
§Example
Make text bold using attr()
:
use yansi::{Paint, Attribute};
painted.attr(Attribute::Bold);
Make text bold using using bold()
.
use yansi::Paint;
painted.bold();
Source§fn rapid_blink(&self) -> Painted<&T>
fn rapid_blink(&self) -> Painted<&T>
Source§fn quirk(&self, value: Quirk) -> Painted<&T>
fn quirk(&self, value: Quirk) -> Painted<&T>
Enables the yansi
Quirk
value
.
This method should be used rarely. Instead, prefer to use quirk-specific
builder methods like mask()
and
wrap()
, which have the same functionality but are
pithier.
§Example
Enable wrapping using .quirk()
:
use yansi::{Paint, Quirk};
painted.quirk(Quirk::Wrap);
Enable wrapping using wrap()
.
use yansi::Paint;
painted.wrap();
Source§fn clear(&self) -> Painted<&T>
👎Deprecated since 1.0.1: renamed to resetting()
due to conflicts with Vec::clear()
.
The clear()
method will be removed in a future release.
fn clear(&self) -> Painted<&T>
resetting()
due to conflicts with Vec::clear()
.
The clear()
method will be removed in a future release.Source§fn whenever(&self, value: Condition) -> Painted<&T>
fn whenever(&self, value: Condition) -> Painted<&T>
Conditionally enable styling based on whether the Condition
value
applies. Replaces any previous condition.
See the crate level docs for more details.
§Example
Enable styling painted
only when both stdout
and stderr
are TTYs:
use yansi::{Paint, Condition};
painted.red().on_yellow().whenever(Condition::STDOUTERR_ARE_TTY);