NAME

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

DESCRIPTION

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

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

SYNOPSIS

my $s3 = Paws->service('S3');
my $DeleteObjectsOutput = $s3->DeleteObjects(
  Bucket => 'MyBucketName',
  Delete => {
    Objects => [
      {
        Key       => 'MyObjectKey',          # min: 1
        VersionId => 'MyObjectVersionId',    # OPTIONAL
      },
      ...
    ],
    Quiet => 1,                              # OPTIONAL
  },
  BypassGovernanceRetention => 1,                 # OPTIONAL
  ContentLength             => 1,                 # OPTIONAL
  ContentMD5                => 'MyContentMD5',    # OPTIONAL
  MFA                       => 'MyMFA',           # OPTIONAL
  RequestPayer              => 'requester',       # OPTIONAL
);

# Results:
my $Deleted        = $DeleteObjectsOutput->Deleted;
my $Errors         = $DeleteObjectsOutput->Errors;
my $RequestCharged = $DeleteObjectsOutput->RequestCharged;

# Returns a L<Paws::S3::DeleteObjectsOutput> object.

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/DeleteObjects

ATTRIBUTES

REQUIRED Bucket => Str

The bucket name containing the objects to delete.

When using this API 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 operation using 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/dev/using-access-points.html) in the Amazon Simple Storage Service Developer Guide.

BypassGovernanceRetention => Bool

Specifies whether you want to delete this object even if it has a Governance-type Object Lock in place. You must have sufficient permissions to perform this operation.

ContentLength => Int

Size of the body in bytes.

ContentMD5 => Str

REQUIRED Delete => Paws::S3::Delete

Container for the request.

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"

SEE ALSO

This class forms part of Paws, documenting arguments for method DeleteObjects 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