Struct aws_sdk_s3::operation::put_object_retention::builders::PutObjectRetentionInputBuilder

#[non_exhaustive]
pub struct PutObjectRetentionInputBuilder { /* private fields */ }

A builder for PutObjectRetentionInput.

Implementations

impl PutObjectRetentionInputBuilder

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

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

Access points - When you use this action with an access point, you must provide the alias of the access point in place of the bucket name or specify the access point ARN. When using the access point ARN, 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.

This field is required.

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

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

Access points - When you use this action with an access point, you must provide the alias of the access point in place of the bucket name or specify the access point ARN. When using the access point ARN, 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.

Access points - When you use this action with an access point, you must provide the alias of the access point in place of the bucket name or specify the access point ARN. When using the access point ARN, 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>) -> Self

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

This field is required.

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

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

The container element for the Object Retention configuration.

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

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

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

This functionality is not supported for directory buckets.

pub fn set_request_payer(self, input: Option<RequestPayer>) -> Self

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

This functionality is not supported for directory buckets.

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

This functionality is not supported for directory buckets.

pub fn version_id(self, input: impl Into<String>) -> Self

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

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

Indicates whether this action should bypass Governance-mode restrictions.

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

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

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

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

Indicates the algorithm used to create the checksum for the object when you use the SDK. This header will not provide any additional functionality if you don't use the SDK. When you send 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>) -> Self

Indicates the algorithm used to create the checksum for the object when you use the SDK. This header will not provide any additional functionality if you don't use the SDK. When you send 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 you use the SDK. This header will not provide any additional functionality if you don't use the SDK. When you send 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>) -> Self

The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).

pub fn set_expected_bucket_owner(self, input: Option<String>) -> Self

The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, 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 account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).

pub fn build(self) -> Result<PutObjectRetentionInput, BuildError>

Consumes the builder and constructs a PutObjectRetentionInput.

impl PutObjectRetentionInputBuilder

pub async fn send_with( self, client: &Client, ) -> Result<PutObjectRetentionOutput, SdkError<PutObjectRetentionError, HttpResponse>>

Sends a request with this input using the given client.

Trait Implementations

impl Clone for PutObjectRetentionInputBuilder

fn clone(&self) -> PutObjectRetentionInputBuilder

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for PutObjectRetentionInputBuilder

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

Formats the value using the given formatter.

impl Default for PutObjectRetentionInputBuilder

fn default() -> PutObjectRetentionInputBuilder

Returns the “default value” for a type.

impl PartialEq for PutObjectRetentionInputBuilder

fn eq(&self, other: &PutObjectRetentionInputBuilder) -> 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 PutObjectRetentionInputBuilder