NAME

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

DESCRIPTION

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

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

SYNOPSIS

    my $s3 = Paws->service('S3');
    my $ListObjectsOutput = $s3->ListObjects(
      Bucket       => 'MyBucketName',
      Delimiter    => 'MyDelimiter',    # OPTIONAL
      EncodingType => 'url',            # OPTIONAL
      Marker       => 'MyMarker',       # OPTIONAL
      MaxKeys      => 1,                # OPTIONAL
      Prefix       => 'MyPrefix',       # OPTIONAL
      RequestPayer => 'requester',      # OPTIONAL
    );

    # Results:
    my $CommonPrefixes = $ListObjectsOutput->CommonPrefixes;
    my $Contents       = $ListObjectsOutput->Contents;
    my $Delimiter      = $ListObjectsOutput->Delimiter;
    my $EncodingType   = $ListObjectsOutput->EncodingType;
    my $IsTruncated    = $ListObjectsOutput->IsTruncated;
    my $Marker         = $ListObjectsOutput->Marker;
    my $MaxKeys        = $ListObjectsOutput->MaxKeys;
    my $Name           = $ListObjectsOutput->Name;
    my $NextMarker     = $ListObjectsOutput->NextMarker;
    my $Prefix         = $ListObjectsOutput->Prefix;

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

ATTRIBUTES

REQUIRED Bucket => Str

Delimiter => Str

A delimiter is a character you use to group keys.

EncodingType => Str

Valid values are: "url"

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

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. Bucket owners need not specify this parameter in their requests.

Valid values are: "requester"

SEE ALSO

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