NAME

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

DESCRIPTION

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

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

SYNOPSIS

    my $s3 = Paws->service('S3');
    my $ListObjectsV2Output = $s3->ListObjectsV2(
      Bucket            => 'MyBucketName',
      ContinuationToken => 'MyToken',         # OPTIONAL
      Delimiter         => 'MyDelimiter',     # OPTIONAL
      EncodingType      => 'url',             # OPTIONAL
      FetchOwner        => 1,                 # OPTIONAL
      MaxKeys           => 1,                 # OPTIONAL
      Prefix            => 'MyPrefix',        # OPTIONAL
      RequestPayer      => 'requester',       # OPTIONAL
      StartAfter        => 'MyStartAfter',    # OPTIONAL
    );

    # Results:
    my $CommonPrefixes        = $ListObjectsV2Output->CommonPrefixes;
    my $Contents              = $ListObjectsV2Output->Contents;
    my $ContinuationToken     = $ListObjectsV2Output->ContinuationToken;
    my $Delimiter             = $ListObjectsV2Output->Delimiter;
    my $EncodingType          = $ListObjectsV2Output->EncodingType;
    my $IsTruncated           = $ListObjectsV2Output->IsTruncated;
    my $KeyCount              = $ListObjectsV2Output->KeyCount;
    my $MaxKeys               = $ListObjectsV2Output->MaxKeys;
    my $Name                  = $ListObjectsV2Output->Name;
    my $NextContinuationToken = $ListObjectsV2Output->NextContinuationToken;
    my $Prefix                = $ListObjectsV2Output->Prefix;
    my $StartAfter            = $ListObjectsV2Output->StartAfter;

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

ATTRIBUTES

REQUIRED Bucket => Str

Name of the bucket to list.

ContinuationToken => Str

ContinuationToken indicates Amazon S3 that the list is being continued on this bucket with a token. ContinuationToken is obfuscated and is not a real key

Delimiter => Str

A delimiter is a character you use to group keys.

EncodingType => Str

Encoding type used by Amazon S3 to encode object keys in the response.

Valid values are: "url"

FetchOwner => Bool

The owner field is not present in listV2 by default, if you want to return owner field with each key in the result then set the fetch owner field to true

MaxKeys => Int

Sets the maximum number of keys returned in the response. The response might contain fewer keys but will never contain more.

Prefix => Str

Limits the response to keys that begin with the specified prefix.

RequestPayer => Str

Confirms that the requester knows that she or he will be charged for the list objects request in V2 style. Bucket owners need not specify this parameter in their requests.

Valid values are: "requester"

StartAfter => Str

StartAfter is where you want Amazon S3 to start listing from. Amazon S3 starts listing after this specified key. StartAfter can be any key in the bucket

SEE ALSO

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