NAME

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

DESCRIPTION

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

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

SYNOPSIS

    my $s3 = Paws->service('S3');
    $s3->WriteGetObjectResponse(
      RequestRoute       => 'MyRequestRoute',
      RequestToken       => 'MyRequestToken',
      AcceptRanges       => 'MyAcceptRanges',                      # OPTIONAL
      Body               => 'BlobBody',                            # OPTIONAL
      BucketKeyEnabled   => 1,                                     # OPTIONAL
      CacheControl       => 'MyCacheControl',                      # OPTIONAL
      ContentDisposition => 'MyContentDisposition',                # OPTIONAL
      ContentEncoding    => 'MyContentEncoding',                   # OPTIONAL
      ContentLanguage    => 'MyContentLanguage',                   # OPTIONAL
      ContentLength      => 1,                                     # OPTIONAL
      ContentRange       => 'MyContentRange',                      # OPTIONAL
      ContentType        => 'MyContentType',                       # OPTIONAL
      DeleteMarker       => 1,                                     # OPTIONAL
      ETag               => 'MyETag',                              # OPTIONAL
      ErrorCode          => 'MyErrorCode',                         # OPTIONAL
      ErrorMessage       => 'MyErrorMessage',                      # OPTIONAL
      Expiration         => 'MyExpiration',                        # OPTIONAL
      Expires            => '1970-01-01T01:00:00',                 # OPTIONAL
      LastModified       => '1970-01-01T01:00:00',                 # OPTIONAL
      Metadata    => { 'MyMetadataKey' => 'MyMetadataValue', },    # OPTIONAL
      MissingMeta => 1,                                            # OPTIONAL
      ObjectLockLegalHoldStatus => 'ON',                           # OPTIONAL
      ObjectLockMode            => 'GOVERNANCE',                   # OPTIONAL
      ObjectLockRetainUntilDate => '1970-01-01T01:00:00',          # OPTIONAL
      PartsCount                => 1,                              # OPTIONAL
      ReplicationStatus         => 'COMPLETE',                     # OPTIONAL
      RequestCharged            => 'requester',                    # OPTIONAL
      Restore                   => 'MyRestore',                    # OPTIONAL
      SSECustomerAlgorithm      => 'MySSECustomerAlgorithm',       # OPTIONAL
      SSECustomerKeyMD5         => 'MySSECustomerKeyMD5',          # OPTIONAL
      SSEKMSKeyId               => 'MySSEKMSKeyId',                # OPTIONAL
      ServerSideEncryption      => 'AES256',                       # OPTIONAL
      StatusCode                => 1,                              # OPTIONAL
      StorageClass              => 'STANDARD',                     # OPTIONAL
      TagCount                  => 1,                              # OPTIONAL
      VersionId                 => 'MyObjectVersionId',            # OPTIONAL
    );

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/WriteGetObjectResponse>

ATTRIBUTES

AcceptRanges => Str

Indicates that a range of bytes was specified.

Body => Str

The object data.

BucketKeyEnabled => Bool

Indicates whether the object stored in Amazon S3 uses an S3 bucket key for server-side encryption with AWS KMS (SSE-KMS).

CacheControl => Str

Specifies caching behavior along the request/reply chain.

ContentDisposition => Str

Specifies presentational information for the object.

ContentEncoding => Str

Specifies what content encodings have been applied to the object and thus what decoding mechanisms must be applied to obtain the media-type referenced by the Content-Type header field.

ContentLanguage => Str

The language the content is in.

ContentLength => Int

The size of the content body in bytes.

ContentRange => Str

The portion of the object returned in the response.

ContentType => Str

A standard MIME type describing the format of the object data.

DeleteMarker => Bool

Specifies whether an object stored in Amazon S3 is ("true") or is not ("false") a delete marker.

ErrorCode => Str

A string that uniquely identifies an error condition. Returned in the <Code> tag of the error XML response for a corresponding "GetObject" call. Cannot be used with a successful "StatusCode" header or when the transformed object is provided in the body. All error codes from S3 are sentence-cased. Regex value is "^[A-Z][a-zA-Z]+$".

ErrorMessage => Str

Contains a generic description of the error condition. Returned in the <Message> tag of the error XML response for a corresponding "GetObject" call. Cannot be used with a successful "StatusCode" header or when the transformed object is provided in body.

ETag => Str

An opaque identifier assigned by a web server to a specific version of a resource found at a URL.

Expiration => Str

If object stored in Amazon S3 expiration is configured (see PUT Bucket lifecycle) it includes expiry-date and rule-id key-value pairs providing object expiration information. The value of the rule-id is URL encoded.

Expires => Str

The date and time at which the object is no longer cacheable.

LastModified => Str

The date and time that the object was last modified.

Metadata => Paws::S3::Metadata

A map of metadata to store with the object in S3.

MissingMeta => Int

Set to the number of metadata entries not returned in "x-amz-meta" headers. This can happen if you create metadata using an API like SOAP that supports more flexible metadata than the REST API. For example, using SOAP, you can create metadata whose values are not legal HTTP headers.

ObjectLockLegalHoldStatus => Str

Indicates whether an object stored in Amazon S3 has an active legal hold.

Valid values are: "ON", "OFF"

ObjectLockMode => Str

Indicates whether an object stored in Amazon S3 has Object Lock enabled. For more information about S3 Object Lock, see Object Lock (https://docs.aws.amazon.com/AmazonS3/latest/userguide/object-lock.html).

Valid values are: "GOVERNANCE", "COMPLIANCE"

ObjectLockRetainUntilDate => Str

The date and time when Object Lock is configured to expire.

PartsCount => Int

The count of parts this object has.

ReplicationStatus => Str

Indicates if request involves bucket that is either a source or destination in a Replication rule. For more information about S3 Replication, see Replication (https://docs.aws.amazon.com/AmazonS3/latest/userguide/replication.html).

Valid values are: "COMPLETE", "PENDING", "FAILED", "REPLICA"

RequestCharged => Str

Valid values are: "requester"

REQUIRED RequestRoute => Str

Route prefix to the HTTP URL generated.

REQUIRED RequestToken => Str

A single use encrypted token that maps "WriteGetObjectResponse" to the end user "GetObject" request.

Restore => Str

Provides information about object restoration operation and expiration time of the restored object copy.

ServerSideEncryption => Str

The server-side encryption algorithm used when storing requested object in Amazon S3 (for example, AES256, aws:kms).

Valid values are: "AES256", "aws:kms"

SSECustomerAlgorithm => Str

Encryption algorithm used if server-side encryption with a customer-provided encryption key was specified for object stored in Amazon S3.

SSECustomerKeyMD5 => Str

128-bit MD5 digest of customer-provided encryption key used in Amazon S3 to encrypt data stored in S3. For more information, see Protecting data using server-side encryption with customer-provided encryption keys (SSE-C) (https://docs.aws.amazon.com/AmazonS3/latest/userguide/ServerSideEncryptionCustomerKeys.html).

SSEKMSKeyId => Str

If present, specifies the ID of the AWS Key Management Service (AWS KMS) symmetric customer managed customer master key (CMK) that was used for stored in Amazon S3 object.

StatusCode => Int

The integer status code for an HTTP response of a corresponding "GetObject" request.

Status Codes

200 - OK
206 - Partial Content
304 - Not Modified
400 - Bad Request
401 - Unauthorized
403 - Forbidden
404 - Not Found
405 - Method Not Allowed
409 - Conflict
411 - Length Required
412 - Precondition Failed
416 - Range Not Satisfiable
500 - Internal Server Error
503 - Service Unavailable

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>