The London Perl and Raku Workshop takes place on 26th Oct 2024. If your company depends on Perl, please consider sponsoring and/or attending.

NAME

Paws::S3::DeleteObject - Arguments for method DeleteObject on Paws::S3

DESCRIPTION

This class represents the parameters used for calling the method DeleteObject on the Amazon Simple Storage Service service. Use the attributes of this class as arguments to method DeleteObject.

You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to DeleteObject.

SYNOPSIS

my $s3 = Paws->service('S3');
# To delete an object
# The following example deletes an object from an S3 bucket.
my $DeleteObjectOutput = $s3->DeleteObject(
  'Bucket' => 'examplebucket',
  'Key'    => 'objectkey.jpg'
);

# To delete an object (from a non-versioned bucket)
# The following example deletes an object from a non-versioned bucket.
my $DeleteObjectOutput = $s3->DeleteObject(
  'Bucket' => 'ExampleBucket',
  'Key'    => 'HappyFace.jpg'
);

Values for attributes that are native types (Int, String, Float, etc) can passed as-is (scalar values). Values for complex Types (objects) can be passed as a HashRef. The keys and values of the hashref will be used to instance the underlying object. For the AWS API documentation, see https://docs.aws.amazon.com/goto/WebAPI/s3/DeleteObject

ATTRIBUTES

REQUIRED Bucket => 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 AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using access points (https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html) 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 AWS 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 (https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html) in the Amazon S3 User Guide.

BypassGovernanceRetention => Bool

Indicates whether S3 Object Lock should bypass Governance-mode restrictions to process this operation.

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

REQUIRED Key => Str

Key name of the object to delete.

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

RequestPayer => Str

Valid values are: "requester"

VersionId => Str

VersionId used to reference a specific version of the object.

SEE ALSO

This class forms part of Paws, documenting arguments for method DeleteObject in Paws::S3

BUGS and CONTRIBUTIONS

The source code is located here: https://github.com/pplu/aws-sdk-perl

Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues