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');
  # To delete multiple object versions from a versioned bucket
  # The following example deletes objects from a bucket. The request specifies
  # object versions. S3 deletes specific object versions and returns the key and
  # versions of deleted objects in the response.
    my $DeleteObjectsOutput = $s3->DeleteObjects(
      'Bucket' => 'examplebucket',
      'Delete' => {
        'Objects' => [

          {
            'Key'       => 'HappyFace.jpg',
            'VersionId' => '2LWg7lQLnY41.maGB5Z6SWW.dcq0vx7b'
          },

          {
            'Key'       => 'HappyFace.jpg',
            'VersionId' => 'yoz3HB.ZhCS_tKVEmIOr7qYyyAaZSKVd'
          }
        ],
        'Quiet' => 0
      }
    );

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

 # Returns a L<Paws::S3::DeleteObjectsOutput> object.
 # To delete multiple objects from a versioned bucket
 # The following example deletes objects from a bucket. The bucket is versioned,
 # and the request does not specify the object version to delete. In this case,
 # all versions remain in the bucket and S3 adds a delete marker.
    my $DeleteObjectsOutput = $s3->DeleteObjects(
      'Bucket' => 'examplebucket',
      'Delete' => {
        'Objects' => [

          {
            'Key' => 'objectkey1'
          },

          {
            'Key' => 'objectkey2'
          }
        ],
        'Quiet' => 0
      }
    );

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

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

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.

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.

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

cpanm Paws

perl -MCPAN -e shell
install Paws