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');
    # To list objects in a bucket
    # The following example list two objects in a bucket.
    my $ListObjectsOutput = $s3->ListObjects(
      'Bucket'  => 'examplebucket',
      'MaxKeys' => 2
    );

    # Results:
    my $Contents   = $ListObjectsOutput->Contents;
    my $NextMarker = $ListObjectsOutput->NextMarker;

    # 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

The name of the bucket containing the objects.

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.

Delimiter => Str

A delimiter is a character you use to group keys.

EncodingType => Str

Valid values are: "url"

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.

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. By default the action returns up to 1,000 key names. 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

cpanm Paws

perl -MCPAN -e shell
install Paws