Struct bonsaidb::keystorage::s3::aws_sdk_s3::operation::put_object_tagging::builders::PutObjectTaggingFluentBuilder
pub struct PutObjectTaggingFluentBuilder { /* private fields */ }
Expand description
Fluent builder constructing a request to PutObjectTagging
.
Sets the supplied tag-set to an object that already exists in a bucket. A tag is a key-value pair. For more information, see Object Tagging.
You can associate tags with an object by sending a PUT request against the tagging subresource that is associated with the object. You can retrieve tags by sending a GET request. For more information, see GetObjectTagging.
For tagging-related restrictions related to characters and encodings, see Tag Restrictions. Note that Amazon S3 limits the maximum number of tags to 10 tags per object.
To use this operation, you must have permission to perform the s3:PutObjectTagging
action. By default, the bucket owner has this permission and can grant this permission to others.
To put tags of any other version, use the versionId
query parameter. You also need permission for the s3:PutObjectVersionTagging
action.
PutObjectTagging
has the following special errors. For more Amazon S3 errors see, Error Responses.
-
InvalidTag
- The tag provided was not a valid tag. This error can occur if the tag did not pass input validation. For more information, see Object Tagging. -
MalformedXML
- The XML provided does not match the schema. -
OperationAborted
- A conflicting conditional action is currently in progress against this resource. Please try again. -
InternalError
- The service was unable to apply the provided tag to the object.
The following operations are related to PutObjectTagging
:
Implementations§
§impl PutObjectTaggingFluentBuilder
impl PutObjectTaggingFluentBuilder
pub fn as_input(&self) -> &PutObjectTaggingInputBuilder
pub fn as_input(&self) -> &PutObjectTaggingInputBuilder
Access the PutObjectTagging as a reference.
pub async fn send(
self
) -> impl Future<Output = Result<PutObjectTaggingOutput, SdkError<PutObjectTaggingError, Response<SdkBody>>>>
pub async fn send( self ) -> impl Future<Output = Result<PutObjectTaggingOutput, SdkError<PutObjectTaggingError, Response<SdkBody>>>>
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.
pub async fn customize(
self
) -> impl Future<Output = Result<CustomizableOperation<PutObjectTaggingOutput, PutObjectTaggingError, PutObjectTaggingFluentBuilder>, SdkError<PutObjectTaggingError, Response>>>
pub async fn customize( self ) -> impl Future<Output = Result<CustomizableOperation<PutObjectTaggingOutput, PutObjectTaggingError, PutObjectTaggingFluentBuilder>, SdkError<PutObjectTaggingError, Response>>>
Consumes this builder, creating a customizable operation that can be modified before being sent.
pub fn bucket(self, input: impl Into<String>) -> PutObjectTaggingFluentBuilder
pub fn bucket(self, input: impl Into<String>) -> PutObjectTaggingFluentBuilder
The bucket name containing the object.
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 set_bucket(self, input: Option<String>) -> PutObjectTaggingFluentBuilder
pub fn set_bucket(self, input: Option<String>) -> PutObjectTaggingFluentBuilder
The bucket name containing the object.
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 get_bucket(&self) -> &Option<String>
pub fn get_bucket(&self) -> &Option<String>
The bucket name containing the object.
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 key(self, input: impl Into<String>) -> PutObjectTaggingFluentBuilder
pub fn key(self, input: impl Into<String>) -> PutObjectTaggingFluentBuilder
Name of the object key.
pub fn set_key(self, input: Option<String>) -> PutObjectTaggingFluentBuilder
pub fn set_key(self, input: Option<String>) -> PutObjectTaggingFluentBuilder
Name of the object key.
pub fn version_id(
self,
input: impl Into<String>
) -> PutObjectTaggingFluentBuilder
pub fn version_id( self, input: impl Into<String> ) -> PutObjectTaggingFluentBuilder
The versionId of the object that the tag-set will be added to.
pub fn set_version_id(
self,
input: Option<String>
) -> PutObjectTaggingFluentBuilder
pub fn set_version_id( self, input: Option<String> ) -> PutObjectTaggingFluentBuilder
The versionId of the object that the tag-set will be added to.
pub fn get_version_id(&self) -> &Option<String>
pub fn get_version_id(&self) -> &Option<String>
The versionId of the object that the tag-set will be added to.
pub fn content_md5(
self,
input: impl Into<String>
) -> PutObjectTaggingFluentBuilder
pub fn content_md5( self, input: impl Into<String> ) -> PutObjectTaggingFluentBuilder
The MD5 hash for the request body.
For requests made using the Amazon Web Services Command Line Interface (CLI) or Amazon Web Services SDKs, this field is calculated automatically.
pub fn set_content_md5(
self,
input: Option<String>
) -> PutObjectTaggingFluentBuilder
pub fn set_content_md5( self, input: Option<String> ) -> PutObjectTaggingFluentBuilder
The MD5 hash for the request body.
For requests made using the Amazon Web Services Command Line Interface (CLI) or Amazon Web Services SDKs, this field is calculated automatically.
pub fn get_content_md5(&self) -> &Option<String>
pub fn get_content_md5(&self) -> &Option<String>
The MD5 hash for the request body.
For requests made using the Amazon Web Services Command Line Interface (CLI) or Amazon Web Services SDKs, this field is calculated automatically.
pub fn checksum_algorithm(
self,
input: ChecksumAlgorithm
) -> PutObjectTaggingFluentBuilder
pub fn checksum_algorithm( self, input: ChecksumAlgorithm ) -> PutObjectTaggingFluentBuilder
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 set_checksum_algorithm(
self,
input: Option<ChecksumAlgorithm>
) -> PutObjectTaggingFluentBuilder
pub fn set_checksum_algorithm( self, input: Option<ChecksumAlgorithm> ) -> PutObjectTaggingFluentBuilder
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 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 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 tagging(self, input: Tagging) -> PutObjectTaggingFluentBuilder
pub fn tagging(self, input: Tagging) -> PutObjectTaggingFluentBuilder
Container for the TagSet
and Tag
elements
pub fn set_tagging(
self,
input: Option<Tagging>
) -> PutObjectTaggingFluentBuilder
pub fn set_tagging( self, input: Option<Tagging> ) -> PutObjectTaggingFluentBuilder
Container for the TagSet
and Tag
elements
pub fn get_tagging(&self) -> &Option<Tagging>
pub fn get_tagging(&self) -> &Option<Tagging>
Container for the TagSet
and Tag
elements
pub fn expected_bucket_owner(
self,
input: impl Into<String>
) -> PutObjectTaggingFluentBuilder
pub fn expected_bucket_owner( self, input: impl Into<String> ) -> PutObjectTaggingFluentBuilder
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).
pub fn set_expected_bucket_owner(
self,
input: Option<String>
) -> PutObjectTaggingFluentBuilder
pub fn set_expected_bucket_owner( self, input: Option<String> ) -> PutObjectTaggingFluentBuilder
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).
pub 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 bucket is owned by a different account, the request fails with the HTTP status code 403 Forbidden
(access denied).
pub fn request_payer(self, input: RequestPayer) -> PutObjectTaggingFluentBuilder
pub fn request_payer(self, input: RequestPayer) -> PutObjectTaggingFluentBuilder
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 set_request_payer(
self,
input: Option<RequestPayer>
) -> PutObjectTaggingFluentBuilder
pub fn set_request_payer( self, input: Option<RequestPayer> ) -> PutObjectTaggingFluentBuilder
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 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 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.
Trait Implementations§
§impl Clone for PutObjectTaggingFluentBuilder
impl Clone for PutObjectTaggingFluentBuilder
§fn clone(&self) -> PutObjectTaggingFluentBuilder
fn clone(&self) -> PutObjectTaggingFluentBuilder
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read more