NAME

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

DESCRIPTION

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

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

SYNOPSIS

my $s3 = Paws->service('S3');
my $ListObjectVersionsOutput = $s3->ListObjectVersions(
  Bucket          => 'MyBucketName',
  Delimiter       => 'MyDelimiter',          # OPTIONAL
  EncodingType    => 'url',                  # OPTIONAL
  KeyMarker       => 'MyKeyMarker',          # OPTIONAL
  MaxKeys         => 1,                      # OPTIONAL
  Prefix          => 'MyPrefix',             # OPTIONAL
  VersionIdMarker => 'MyVersionIdMarker',    # OPTIONAL
);

# Results:
my $CommonPrefixes      = $ListObjectVersionsOutput->CommonPrefixes;
my $DeleteMarkers       = $ListObjectVersionsOutput->DeleteMarkers;
my $Delimiter           = $ListObjectVersionsOutput->Delimiter;
my $EncodingType        = $ListObjectVersionsOutput->EncodingType;
my $IsTruncated         = $ListObjectVersionsOutput->IsTruncated;
my $KeyMarker           = $ListObjectVersionsOutput->KeyMarker;
my $MaxKeys             = $ListObjectVersionsOutput->MaxKeys;
my $Name                = $ListObjectVersionsOutput->Name;
my $NextKeyMarker       = $ListObjectVersionsOutput->NextKeyMarker;
my $NextVersionIdMarker = $ListObjectVersionsOutput->NextVersionIdMarker;
my $Prefix              = $ListObjectVersionsOutput->Prefix;
my $VersionIdMarker     = $ListObjectVersionsOutput->VersionIdMarker;
my $Versions            = $ListObjectVersionsOutput->Versions;

# Returns a L<Paws::S3::ListObjectVersionsOutput> 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/ListObjectVersions

ATTRIBUTES

REQUIRED Bucket => Str

The bucket name that contains the objects.

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.

Delimiter => Str

A delimiter is a character that you specify to group keys. All keys that contain the same string between the prefix and the first occurrence of the delimiter are grouped under a single result element in CommonPrefixes. These groups are counted as one result against the max-keys limitation. These keys are not returned elsewhere in the response.

EncodingType => Str

Valid values are: "url"

KeyMarker => Str

Specifies the key to start with when listing objects in a bucket.

MaxKeys => Int

Sets the maximum number of keys returned in the response. The response might contain fewer keys but will never contain more. If additional keys satisfy the search criteria, but were not returned because max-keys was exceeded, the response contains <isTruncated>true</isTruncated>. To return the additional keys, see key-marker and version-id-marker.

Prefix => Str

Use this parameter to select only those keys that begin with the specified prefix. You can use prefixes to separate a bucket into different groupings of keys. (You can think of using prefix to make groups in the same way you'd use a folder in a file system.) You can use prefix with delimiter to roll up numerous objects into a single result under CommonPrefixes.

VersionIdMarker => Str

Specifies the object version you want to start listing from.

SEE ALSO

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