NAME

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

DESCRIPTION

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

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

SYNOPSIS

    my $s3 = Paws->service('S3');
    # To retrieve an object
    # The following example retrieves an object for an S3 bucket.
    my $GetObjectOutput = $s3->GetObject(
      'Bucket' => 'examplebucket',
      'Key'    => 'HappyFace.jpg'
    );
    # Results:
    my $AcceptRanges  = $GetObjectOutput->AcceptRanges;
    my $ContentLength = $GetObjectOutput->ContentLength;
    my $ContentType   = $GetObjectOutput->ContentType;
    my $ETag          = $GetObjectOutput->ETag;
    my $LastModified  = $GetObjectOutput->LastModified;
    my $Metadata      = $GetObjectOutput->Metadata;
    my $TagCount      = $GetObjectOutput->TagCount;
    my $VersionId     = $GetObjectOutput->VersionId;
    # Returns a L<Paws::S3::GetObjectOutput> object.
    # To retrieve a byte range of an object
    # The following example retrieves an object for an S3 bucket. The request
    # specifies the range header to retrieve a specific byte range.
    my $GetObjectOutput = $s3->GetObject(
      'Bucket' => 'examplebucket',
      'Key'    => 'SampleFile.txt',
      'Range'  => 'bytes=0-9'
    );
    # Results:
    my $AcceptRanges  = $GetObjectOutput->AcceptRanges;
    my $ContentLength = $GetObjectOutput->ContentLength;
    my $ContentRange  = $GetObjectOutput->ContentRange;
    my $ContentType   = $GetObjectOutput->ContentType;
    my $ETag          = $GetObjectOutput->ETag;
    my $LastModified  = $GetObjectOutput->LastModified;
    my $Metadata      = $GetObjectOutput->Metadata;
    my $VersionId     = $GetObjectOutput->VersionId;
    # Returns a L<Paws::S3::GetObjectOutput> 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/GetObject>

ATTRIBUTES

REQUIRED Bucket => Str

The bucket name containing the object.

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.

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.

IfMatch => Str

Return the object only if its entity tag (ETag) is the same as the one specified, otherwise return a 412 (precondition failed).

IfModifiedSince => Str

Return the object only if it has been modified since the specified time, otherwise return a 304 (not modified).

IfNoneMatch => Str

Return the object only if its entity tag (ETag) is different from the one specified, otherwise return a 304 (not modified).

IfUnmodifiedSince => Str

Return the object only if it has not been modified since the specified time, otherwise return a 412 (precondition failed).

REQUIRED Key => Str

Key of the object to get.

PartNumber => Int

Part number of the object being read. This is a positive integer between 1 and 10,000. Effectively performs a 'ranged' GET request for the part specified. Useful for downloading just a part of an object.

Range => Str

Downloads the specified range bytes of an object. For more information about the HTTP Range header, see https://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.35 (https://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.35).

Amazon S3 doesn't support retrieving multiple ranges of data per "GET" request.

RequestPayer => Str

Valid values are: "requester"

ResponseCacheControl => Str

Sets the "Cache-Control" header of the response.

ResponseContentDisposition => Str

Sets the "Content-Disposition" header of the response

ResponseContentEncoding => Str

Sets the "Content-Encoding" header of the response.

ResponseContentLanguage => Str

Sets the "Content-Language" header of the response.

ResponseContentType => Str

Sets the "Content-Type" header of the response.

ResponseExpires => Str

Sets the "Expires" header of the response.

SSECustomerAlgorithm => Str

Specifies the algorithm to use to when decrypting the object (for example, AES256).

SSECustomerKey => Str

Specifies the customer-provided encryption key for Amazon S3 used to encrypt the data. This value is used to decrypt the object when recovering it and must match the one used when storing the data. The key must be appropriate for use with the algorithm specified in the "x-amz-server-side-encryption-customer-algorithm" header.

SSECustomerKeyMD5 => Str

Specifies the 128-bit MD5 digest of the encryption key according to RFC 1321. Amazon S3 uses this header for a message integrity check to ensure that the encryption key was transmitted without error.

VersionId => Str

VersionId used to reference a specific version of the object.

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>