Struct aws_sdk_s3::input::DeleteObjectInput

#[non_exhaustive]
pub struct DeleteObjectInput {
    pub bucket: Option<String>,
    pub key: Option<String>,
    pub mfa: Option<String>,
    pub version_id: Option<String>,
    pub request_payer: Option<RequestPayer>,
    pub bypass_governance_retention: bool,
    pub expected_bucket_owner: Option<String>,
}

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

bucket: Option<String>

The bucket name of the bucket 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 using 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 using this action using S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts bucket ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see Using S3 on Outposts in the Amazon S3 User Guide.

key: Option<String>

Key name of the object to delete.

mfa: Option<String>

The concatenation of the authentication device's serial number, a space, and the value that is displayed on your authentication device. Required to permanently delete a versioned object if versioning is configured with MFA delete enabled.

version_id: Option<String>

VersionId used to reference a specific version of the object.

request_payer: 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 Requestor Pays Buckets in the Amazon S3 User Guide.

bypass_governance_retention: bool

Indicates whether S3 Object Lock should bypass Governance-mode restrictions to process this operation. To use this header, you must have the s3:PutBucketPublicAccessBlock permission.

expected_bucket_owner: Option<String>

The account ID of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error.

Implementations

impl DeleteObjectInput

pub async fn presigned(
    self,
    config: &Config,
    presigning_config: PresigningConfig
) -> Result<PresignedRequest, SdkError<DeleteObjectError>>

Creates a presigned request for this operation.

The credentials provider from the config will be used to generate the request’s signature. The presigning_config provides additional presigning-specific config values, such as the amount of time the request should be valid for after creation.

Presigned requests can be given to other users or applications to access a resource or perform an operation without having access to the AWS security credentials.

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

Consumes the builder and constructs an Operation<DeleteObject>

pub fn builder() -> Builder

Creates a new builder-style object to manufacture DeleteObjectInput.

impl DeleteObjectInput

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

The bucket name of the bucket 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 using 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 using this action using S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts bucket ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see Using S3 on Outposts in the Amazon S3 User Guide.

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

Key name of the object to delete.

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

The concatenation of the authentication device's serial number, a space, and the value that is displayed on your authentication device. Required to permanently delete a versioned object if versioning is configured with MFA delete enabled.

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

VersionId used to reference a specific version of the object.

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 Requestor Pays Buckets in the Amazon S3 User Guide.

pub fn bypass_governance_retention(&self) -> bool

Indicates whether S3 Object Lock should bypass Governance-mode restrictions to process this operation. To use this header, you must have the s3:PutBucketPublicAccessBlock permission.

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 will fail with an HTTP 403 (Access Denied) error.

Trait Implementations

impl Clone for DeleteObjectInput

fn clone(&self) -> DeleteObjectInput

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for DeleteObjectInput

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

Formats the value using the given formatter.

impl PartialEq<DeleteObjectInput> for DeleteObjectInput

fn eq(&self, other: &DeleteObjectInput) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &DeleteObjectInput) -> bool

This method tests for !=.

impl StructuralPartialEq for DeleteObjectInput