Struct bonsaidb::keystorage::s3::aws_sdk_s3::operation::put_object_retention::builders::PutObjectRetentionFluentBuilder

pub struct PutObjectRetentionFluentBuilder { /* private fields */ }

Fluent builder constructing a request to PutObjectRetention.

Places an Object Retention configuration on an object. For more information, see Locking Objects. Users or accounts require the s3:PutObjectRetention permission in order to place an Object Retention configuration on objects. Bypassing a Governance Retention configuration requires the s3:BypassGovernanceRetention permission.

This action is not supported by Amazon S3 on Outposts.

Implementations

impl PutObjectRetentionFluentBuilder

pub fn as_input(&self) -> &PutObjectRetentionInputBuilder

Access the PutObjectRetention as a reference.

pub async fn send( self ) -> impl Future<Output = Result<PutObjectRetentionOutput, SdkError<PutObjectRetentionError, 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<PutObjectRetentionOutput, PutObjectRetentionError, PutObjectRetentionFluentBuilder>, SdkError<PutObjectRetentionError, Response>>>

Consumes this builder, creating a customizable operation that can be modified before being sent.

pub fn bucket(self, input: impl Into<String>) -> PutObjectRetentionFluentBuilder

The bucket name that contains the object you want to apply this Object Retention configuration to.

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.

pub fn set_bucket( self, input: Option<String> ) -> PutObjectRetentionFluentBuilder

The bucket name that contains the object you want to apply this Object Retention configuration to.

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.

pub fn get_bucket(&self) -> &Option<String>

The bucket name that contains the object you want to apply this Object Retention configuration to.

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.

pub fn key(self, input: impl Into<String>) -> PutObjectRetentionFluentBuilder

The key name for the object that you want to apply this Object Retention configuration to.

pub fn set_key(self, input: Option<String>) -> PutObjectRetentionFluentBuilder

The key name for the object that you want to apply this Object Retention configuration to.

pub fn get_key(&self) -> &Option<String>

The key name for the object that you want to apply this Object Retention configuration to.

pub fn retention( self, input: ObjectLockRetention ) -> PutObjectRetentionFluentBuilder

The container element for the Object Retention configuration.

pub fn set_retention( self, input: Option<ObjectLockRetention> ) -> PutObjectRetentionFluentBuilder

The container element for the Object Retention configuration.

pub fn get_retention(&self) -> &Option<ObjectLockRetention>

The container element for the Object Retention configuration.

pub fn request_payer( self, input: RequestPayer ) -> PutObjectRetentionFluentBuilder

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> ) -> PutObjectRetentionFluentBuilder

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>

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 version_id( self, input: impl Into<String> ) -> PutObjectRetentionFluentBuilder

The version ID for the object that you want to apply this Object Retention configuration to.

pub fn set_version_id( self, input: Option<String> ) -> PutObjectRetentionFluentBuilder

The version ID for the object that you want to apply this Object Retention configuration to.

pub fn get_version_id(&self) -> &Option<String>

The version ID for the object that you want to apply this Object Retention configuration to.

pub fn bypass_governance_retention( self, input: bool ) -> PutObjectRetentionFluentBuilder

Indicates whether this action should bypass Governance-mode restrictions.

pub fn set_bypass_governance_retention( self, input: Option<bool> ) -> PutObjectRetentionFluentBuilder

Indicates whether this action should bypass Governance-mode restrictions.

pub fn get_bypass_governance_retention(&self) -> &Option<bool>

Indicates whether this action should bypass Governance-mode restrictions.

pub fn content_md5( self, input: impl Into<String> ) -> PutObjectRetentionFluentBuilder

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> ) -> PutObjectRetentionFluentBuilder

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>

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 ) -> PutObjectRetentionFluentBuilder

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> ) -> PutObjectRetentionFluentBuilder

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>

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 expected_bucket_owner( self, input: impl Into<String> ) -> PutObjectRetentionFluentBuilder

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> ) -> PutObjectRetentionFluentBuilder

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>

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).

Trait Implementations

impl Clone for PutObjectRetentionFluentBuilder

fn clone(&self) -> PutObjectRetentionFluentBuilder

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for PutObjectRetentionFluentBuilder

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

Formats the value using the given formatter.