Struct aws_sdk_s3::input::PutObjectRetentionInput

source · [−]

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

Implementations

source

impl PutObjectRetentionInput

source

pub async fn make_operation(
&self,
_config: &Config
) -> Result<Operation<PutObjectRetention, AwsErrorRetryPolicy>, BuildError>

Consumes the builder and constructs an Operation<PutObjectRetention>

source

pub fn builder() -> Builder

Creates a new builder-style object to manufacture PutObjectRetentionInput.

source

impl PutObjectRetentionInput

source

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

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.

source

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

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

source

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

The container element for the Object Retention configuration.

source

pub fn 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. For information about downloading objects from Requester Pays buckets, see Downloading Objects in Requester Pays Buckets in the Amazon S3 User Guide.

source

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

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

source

pub fn bypass_governance_retention(&self) -> bool

Indicates whether this action should bypass Governance-mode restrictions.

source

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

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.

source

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

source

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

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