The Perl Toolchain Summit needs more sponsors. If your company depends on Perl, please support this very important event.

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');
    my $GetObjectOutput = $s3->GetObject(
      Bucket                     => 'MyBucketName',
      Key                        => 'MyObjectKey',
      IfMatch                    => 'MyIfMatch',                      # OPTIONAL
      IfModifiedSince            => '1970-01-01T01:00:00',            # OPTIONAL
      IfNoneMatch                => 'MyIfNoneMatch',                  # OPTIONAL
      IfUnmodifiedSince          => '1970-01-01T01:00:00',            # OPTIONAL
      PartNumber                 => 1,                                # OPTIONAL
      Range                      => 'MyRange',                        # OPTIONAL
      RequestPayer               => 'requester',                      # OPTIONAL
      ResponseCacheControl       => 'MyResponseCacheControl',         # OPTIONAL
      ResponseContentDisposition => 'MyResponseContentDisposition',   # OPTIONAL
      ResponseContentEncoding    => 'MyResponseContentEncoding',      # OPTIONAL
      ResponseContentLanguage    => 'MyResponseContentLanguage',      # OPTIONAL
      ResponseContentType        => 'MyResponseContentType',          # OPTIONAL
      ResponseExpires            => '1970-01-01T01:00:00',            # OPTIONAL
      SSECustomerAlgorithm       => 'MySSECustomerAlgorithm',         # OPTIONAL
      SSECustomerKey             => 'MySSECustomerKey',               # OPTIONAL
      SSECustomerKeyMD5          => 'MySSECustomerKeyMD5',            # OPTIONAL
      VersionId                  => 'MyObjectVersionId',              # OPTIONAL
    );

    # Results:
    my $AcceptRanges              = $GetObjectOutput->AcceptRanges;
    my $Body                      = $GetObjectOutput->Body;
    my $CacheControl              = $GetObjectOutput->CacheControl;
    my $ContentDisposition        = $GetObjectOutput->ContentDisposition;
    my $ContentEncoding           = $GetObjectOutput->ContentEncoding;
    my $ContentLanguage           = $GetObjectOutput->ContentLanguage;
    my $ContentLength             = $GetObjectOutput->ContentLength;
    my $ContentRange              = $GetObjectOutput->ContentRange;
    my $ContentType               = $GetObjectOutput->ContentType;
    my $DeleteMarker              = $GetObjectOutput->DeleteMarker;
    my $ETag                      = $GetObjectOutput->ETag;
    my $Expiration                = $GetObjectOutput->Expiration;
    my $Expires                   = $GetObjectOutput->Expires;
    my $LastModified              = $GetObjectOutput->LastModified;
    my $Metadata                  = $GetObjectOutput->Metadata;
    my $MissingMeta               = $GetObjectOutput->MissingMeta;
    my $ObjectLockLegalHoldStatus = $GetObjectOutput->ObjectLockLegalHoldStatus;
    my $ObjectLockMode            = $GetObjectOutput->ObjectLockMode;
    my $ObjectLockRetainUntilDate = $GetObjectOutput->ObjectLockRetainUntilDate;
    my $PartsCount                = $GetObjectOutput->PartsCount;
    my $ReplicationStatus         = $GetObjectOutput->ReplicationStatus;
    my $RequestCharged            = $GetObjectOutput->RequestCharged;
    my $Restore                   = $GetObjectOutput->Restore;
    my $SSECustomerAlgorithm      = $GetObjectOutput->SSECustomerAlgorithm;
    my $SSECustomerKeyMD5         = $GetObjectOutput->SSECustomerKeyMD5;
    my $SSEKMSKeyId               = $GetObjectOutput->SSEKMSKeyId;
    my $ServerSideEncryption      = $GetObjectOutput->ServerSideEncryption;
    my $StorageClass              = $GetObjectOutput->StorageClass;
    my $TagCount                  = $GetObjectOutput->TagCount;
    my $VersionId                 = $GetObjectOutput->VersionId;
    my $WebsiteRedirectLocation   = $GetObjectOutput->WebsiteRedirectLocation;

    # 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

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

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, go to http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.35.

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 encrypting the object (e.g., AES256).

SSECustomerKey => Str

Specifies the customer-provided encryption key for Amazon S3 to use in encrypting data. This value is used to store the object and then it is discarded; Amazon does not store the encryption key. 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 the encryption key was transmitted without error.

VersionId => Str

VersionId used to reference a specific version of the object.

SEE ALSO

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