| 1 | |||
| 2 | package Paws::S3::HeadObjectOutput; | ||
| 3 | use Moose; | ||
| 4 | has AcceptRanges => (is => 'ro', isa => 'Str', header_name => 'accept-ranges', traits => ['ParamInHeader']); | ||
| 5 | has ArchiveStatus => (is => 'ro', isa => 'Str', header_name => 'x-amz-archive-status', traits => ['ParamInHeader']); | ||
| 6 | has BucketKeyEnabled => (is => 'ro', isa => 'Bool', header_name => 'x-amz-server-side-encryption-bucket-key-enabled', traits => ['ParamInHeader']); | ||
| 7 | has CacheControl => (is => 'ro', isa => 'Str', header_name => 'Cache-Control', traits => ['ParamInHeader']); | ||
| 8 | has ContentDisposition => (is => 'ro', isa => 'Str', header_name => 'Content-Disposition', traits => ['ParamInHeader']); | ||
| 9 | has ContentEncoding => (is => 'ro', isa => 'Str', header_name => 'Content-Encoding', traits => ['ParamInHeader']); | ||
| 10 | has ContentLanguage => (is => 'ro', isa => 'Str', header_name => 'Content-Language', traits => ['ParamInHeader']); | ||
| 11 | has ContentLength => (is => 'ro', isa => 'Int', header_name => 'Content-Length', traits => ['ParamInHeader']); | ||
| 12 | has ContentType => (is => 'ro', isa => 'Str', header_name => 'Content-Type', traits => ['ParamInHeader']); | ||
| 13 | has DeleteMarker => (is => 'ro', isa => 'Bool', header_name => 'x-amz-delete-marker', traits => ['ParamInHeader']); | ||
| 14 | has ETag => (is => 'ro', isa => 'Str', header_name => 'ETag', traits => ['ParamInHeader']); | ||
| 15 | has Expiration => (is => 'ro', isa => 'Str', header_name => 'x-amz-expiration', traits => ['ParamInHeader']); | ||
| 16 | has Expires => (is => 'ro', isa => 'Str', header_name => 'Expires', traits => ['ParamInHeader']); | ||
| 17 | has LastModified => (is => 'ro', isa => 'Str', header_name => 'Last-Modified', traits => ['ParamInHeader']); | ||
| 18 | has Metadata => (is => 'ro', isa => 'Paws::S3::Metadata', header_prefix => 'x-amz-meta-', traits => ['ParamInHeaders']); | ||
| 19 | has MissingMeta => (is => 'ro', isa => 'Int', header_name => 'x-amz-missing-meta', traits => ['ParamInHeader']); | ||
| 20 | has ObjectLockLegalHoldStatus => (is => 'ro', isa => 'Str', header_name => 'x-amz-object-lock-legal-hold', traits => ['ParamInHeader']); | ||
| 21 | has ObjectLockMode => (is => 'ro', isa => 'Str', header_name => 'x-amz-object-lock-mode', traits => ['ParamInHeader']); | ||
| 22 | has ObjectLockRetainUntilDate => (is => 'ro', isa => 'Str', header_name => 'x-amz-object-lock-retain-until-date', traits => ['ParamInHeader']); | ||
| 23 | has PartsCount => (is => 'ro', isa => 'Int', header_name => 'x-amz-mp-parts-count', traits => ['ParamInHeader']); | ||
| 24 | has ReplicationStatus => (is => 'ro', isa => 'Str', header_name => 'x-amz-replication-status', traits => ['ParamInHeader']); | ||
| 25 | has RequestCharged => (is => 'ro', isa => 'Str', header_name => 'x-amz-request-charged', traits => ['ParamInHeader']); | ||
| 26 | has Restore => (is => 'ro', isa => 'Str', header_name => 'x-amz-restore', traits => ['ParamInHeader']); | ||
| 27 | has ServerSideEncryption => (is => 'ro', isa => 'Str', header_name => 'x-amz-server-side-encryption', traits => ['ParamInHeader']); | ||
| 28 | has SSECustomerAlgorithm => (is => 'ro', isa => 'Str', header_name => 'x-amz-server-side-encryption-customer-algorithm', traits => ['ParamInHeader']); | ||
| 29 | has SSECustomerKeyMD5 => (is => 'ro', isa => 'Str', header_name => 'x-amz-server-side-encryption-customer-key-MD5', traits => ['ParamInHeader']); | ||
| 30 | has SSEKMSKeyId => (is => 'ro', isa => 'Str', header_name => 'x-amz-server-side-encryption-aws-kms-key-id', traits => ['ParamInHeader']); | ||
| 31 | has StorageClass => (is => 'ro', isa => 'Str', header_name => 'x-amz-storage-class', traits => ['ParamInHeader']); | ||
| 32 | has VersionId => (is => 'ro', isa => 'Str', header_name => 'x-amz-version-id', traits => ['ParamInHeader']); | ||
| 33 | has WebsiteRedirectLocation => (is => 'ro', isa => 'Str', header_name => 'x-amz-website-redirect-location', traits => ['ParamInHeader']); | ||
| 34 | |||
| 35 | |||
| 36 | has _request_id => (is => 'ro', isa => 'Str'); | ||
| 37 | 1; | ||
| 38 | |||
| 39 | ### main pod documentation begin ### | ||
| 40 | |||
| 41 | =head1 NAME | ||
| 42 | |||
| 43 | Paws::S3::HeadObjectOutput | ||
| 44 | |||
| 45 | =head1 ATTRIBUTES | ||
| 46 | |||
| 47 | |||
| 48 | =head2 AcceptRanges => Str | ||
| 49 | |||
| 50 | Indicates that a range of bytes was specified. | ||
| 51 | |||
| 52 | |||
| 53 | |||
| 54 | =head2 ArchiveStatus => Str | ||
| 55 | |||
| 56 | The archive state of the head object. | ||
| 57 | |||
| 58 | Valid values are: C<"ARCHIVE_ACCESS">, C<"DEEP_ARCHIVE_ACCESS"> | ||
| 59 | |||
| 60 | =head2 BucketKeyEnabled => Bool | ||
| 61 | |||
| 62 | Indicates whether the object uses an S3 Bucket Key for server-side | ||
| 63 | encryption with AWS KMS (SSE-KMS). | ||
| 64 | |||
| 65 | |||
| 66 | |||
| 67 | =head2 CacheControl => Str | ||
| 68 | |||
| 69 | Specifies caching behavior along the request/reply chain. | ||
| 70 | |||
| 71 | |||
| 72 | |||
| 73 | =head2 ContentDisposition => Str | ||
| 74 | |||
| 75 | Specifies presentational information for the object. | ||
| 76 | |||
| 77 | |||
| 78 | |||
| 79 | =head2 ContentEncoding => Str | ||
| 80 | |||
| 81 | Specifies what content encodings have been applied to the object and | ||
| 82 | thus what decoding mechanisms must be applied to obtain the media-type | ||
| 83 | referenced by the Content-Type header field. | ||
| 84 | |||
| 85 | |||
| 86 | |||
| 87 | =head2 ContentLanguage => Str | ||
| 88 | |||
| 89 | The language the content is in. | ||
| 90 | |||
| 91 | |||
| 92 | |||
| 93 | =head2 ContentLength => Int | ||
| 94 | |||
| 95 | Size of the body in bytes. | ||
| 96 | |||
| 97 | |||
| 98 | |||
| 99 | =head2 ContentType => Str | ||
| 100 | |||
| 101 | A standard MIME type describing the format of the object data. | ||
| 102 | |||
| 103 | |||
| 104 | |||
| 105 | =head2 DeleteMarker => Bool | ||
| 106 | |||
| 107 | Specifies whether the object retrieved was (true) or was not (false) a | ||
| 108 | Delete Marker. If false, this response header does not appear in the | ||
| 109 | response. | ||
| 110 | |||
| 111 | |||
| 112 | |||
| 113 | =head2 ETag => Str | ||
| 114 | |||
| 115 | An ETag is an opaque identifier assigned by a web server to a specific | ||
| 116 | version of a resource found at a URL. | ||
| 117 | |||
| 118 | |||
| 119 | |||
| 120 | =head2 Expiration => Str | ||
| 121 | |||
| 122 | If the object expiration is configured (see PUT Bucket lifecycle), the | ||
| 123 | response includes this header. It includes the expiry-date and rule-id | ||
| 124 | key-value pairs providing object expiration information. The value of | ||
| 125 | the rule-id is URL encoded. | ||
| 126 | |||
| 127 | |||
| 128 | |||
| 129 | =head2 Expires => Str | ||
| 130 | |||
| 131 | The date and time at which the object is no longer cacheable. | ||
| 132 | |||
| 133 | |||
| 134 | |||
| 135 | =head2 LastModified => Str | ||
| 136 | |||
| 137 | Creation date of the object. | ||
| 138 | |||
| 139 | |||
| 140 | |||
| 141 | =head2 Metadata => L<Paws::S3::Metadata> | ||
| 142 | |||
| 143 | A map of metadata to store with the object in S3. | ||
| 144 | |||
| 145 | |||
| 146 | |||
| 147 | =head2 MissingMeta => Int | ||
| 148 | |||
| 149 | This is set to the number of metadata entries not returned in | ||
| 150 | C<x-amz-meta> headers. This can happen if you create metadata using an | ||
| 151 | API like SOAP that supports more flexible metadata than the REST API. | ||
| 152 | For example, using SOAP, you can create metadata whose values are not | ||
| 153 | legal HTTP headers. | ||
| 154 | |||
| 155 | |||
| 156 | |||
| 157 | =head2 ObjectLockLegalHoldStatus => Str | ||
| 158 | |||
| 159 | Specifies whether a legal hold is in effect for this object. This | ||
| 160 | header is only returned if the requester has the | ||
| 161 | C<s3:GetObjectLegalHold> permission. This header is not returned if the | ||
| 162 | specified version of this object has never had a legal hold applied. | ||
| 163 | For more information about S3 Object Lock, see Object Lock | ||
| 164 | (https://docs.aws.amazon.com/AmazonS3/latest/dev/object-lock.html). | ||
| 165 | |||
| 166 | Valid values are: C<"ON">, C<"OFF"> | ||
| 167 | |||
| 168 | =head2 ObjectLockMode => Str | ||
| 169 | |||
| 170 | The Object Lock mode, if any, that's in effect for this object. This | ||
| 171 | header is only returned if the requester has the | ||
| 172 | C<s3:GetObjectRetention> permission. For more information about S3 | ||
| 173 | Object Lock, see Object Lock | ||
| 174 | (https://docs.aws.amazon.com/AmazonS3/latest/dev/object-lock.html). | ||
| 175 | |||
| 176 | Valid values are: C<"GOVERNANCE">, C<"COMPLIANCE"> | ||
| 177 | |||
| 178 | =head2 ObjectLockRetainUntilDate => Str | ||
| 179 | |||
| 180 | The date and time when the Object Lock retention period expires. This | ||
| 181 | header is only returned if the requester has the | ||
| 182 | C<s3:GetObjectRetention> permission. | ||
| 183 | |||
| 184 | |||
| 185 | |||
| 186 | =head2 PartsCount => Int | ||
| 187 | |||
| 188 | The count of parts this object has. | ||
| 189 | |||
| 190 | |||
| 191 | |||
| 192 | =head2 ReplicationStatus => Str | ||
| 193 | |||
| 194 | Amazon S3 can return this header if your request involves a bucket that | ||
| 195 | is either a source or a destination in a replication rule. | ||
| 196 | |||
| 197 | In replication, you have a source bucket on which you configure | ||
| 198 | replication and destination bucket or buckets where Amazon S3 stores | ||
| 199 | object replicas. When you request an object (C<GetObject>) or object | ||
| 200 | metadata (C<HeadObject>) from these buckets, Amazon S3 will return the | ||
| 201 | C<x-amz-replication-status> header in the response as follows: | ||
| 202 | |||
| 203 | =over | ||
| 204 | |||
| 205 | =item * | ||
| 206 | |||
| 207 | If requesting an object from the source bucket E<mdash> Amazon S3 will | ||
| 208 | return the C<x-amz-replication-status> header if the object in your | ||
| 209 | request is eligible for replication. | ||
| 210 | |||
| 211 | For example, suppose that in your replication configuration, you | ||
| 212 | specify object prefix C<TaxDocs> requesting Amazon S3 to replicate | ||
| 213 | objects with key prefix C<TaxDocs>. Any objects you upload with this | ||
| 214 | key name prefix, for example C<TaxDocs/document1.pdf>, are eligible for | ||
| 215 | replication. For any object request with this key name prefix, Amazon | ||
| 216 | S3 will return the C<x-amz-replication-status> header with value | ||
| 217 | PENDING, COMPLETED or FAILED indicating object replication status. | ||
| 218 | |||
| 219 | =item * | ||
| 220 | |||
| 221 | If requesting an object from a destination bucket E<mdash> Amazon S3 | ||
| 222 | will return the C<x-amz-replication-status> header with value REPLICA | ||
| 223 | if the object in your request is a replica that Amazon S3 created and | ||
| 224 | there is no replica modification replication in progress. | ||
| 225 | |||
| 226 | =item * | ||
| 227 | |||
| 228 | When replicating objects to multiple destination buckets the | ||
| 229 | C<x-amz-replication-status> header acts differently. The header of the | ||
| 230 | source object will only return a value of COMPLETED when replication is | ||
| 231 | successful to all destinations. The header will remain at value PENDING | ||
| 232 | until replication has completed for all destinations. If one or more | ||
| 233 | destinations fails replication the header will return FAILED. | ||
| 234 | |||
| 235 | =back | ||
| 236 | |||
| 237 | For more information, see Replication | ||
| 238 | (https://docs.aws.amazon.com/AmazonS3/latest/dev/NotificationHowTo.html). | ||
| 239 | |||
| 240 | Valid values are: C<"COMPLETE">, C<"PENDING">, C<"FAILED">, C<"REPLICA"> | ||
| 241 | |||
| 242 | =head2 RequestCharged => Str | ||
| 243 | |||
| 244 | |||
| 245 | |||
| 246 | Valid values are: C<"requester"> | ||
| 247 | |||
| 248 | =head2 Restore => Str | ||
| 249 | |||
| 250 | If the object is an archived object (an object whose storage class is | ||
| 251 | GLACIER), the response includes this header if either the archive | ||
| 252 | restoration is in progress (see RestoreObject | ||
| 253 | (https://docs.aws.amazon.com/AmazonS3/latest/API/API_RestoreObject.html) | ||
| 254 | or an archive copy is already restored. | ||
| 255 | |||
| 256 | If an archive copy is already restored, the header value indicates when | ||
| 257 | Amazon S3 is scheduled to delete the object copy. For example: | ||
| 258 | |||
| 259 | C<x-amz-restore: ongoing-request="false", expiry-date="Fri, 21 Dec 2012 | ||
| 260 | 00:00:00 GMT"> | ||
| 261 | |||
| 262 | If the object restoration is in progress, the header returns the value | ||
| 263 | C<ongoing-request="true">. | ||
| 264 | |||
| 265 | For more information about archiving objects, see Transitioning | ||
| 266 | Objects: General Considerations | ||
| 267 | (https://docs.aws.amazon.com/AmazonS3/latest/dev/object-lifecycle-mgmt.html#lifecycle-transition-general-considerations). | ||
| 268 | |||
| 269 | |||
| 270 | |||
| 271 | =head2 ServerSideEncryption => Str | ||
| 272 | |||
| 273 | If the object is stored using server-side encryption either with an AWS | ||
| 274 | KMS customer master key (CMK) or an Amazon S3-managed encryption key, | ||
| 275 | the response includes this header with the value of the server-side | ||
| 276 | encryption algorithm used when storing this object in Amazon S3 (for | ||
| 277 | example, AES256, aws:kms). | ||
| 278 | |||
| 279 | Valid values are: C<"AES256">, C<"aws:kms"> | ||
| 280 | |||
| 281 | =head2 SSECustomerAlgorithm => Str | ||
| 282 | |||
| 283 | If server-side encryption with a customer-provided encryption key was | ||
| 284 | requested, the response will include this header confirming the | ||
| 285 | encryption algorithm used. | ||
| 286 | |||
| 287 | |||
| 288 | |||
| 289 | =head2 SSECustomerKeyMD5 => Str | ||
| 290 | |||
| 291 | If server-side encryption with a customer-provided encryption key was | ||
| 292 | requested, the response will include this header to provide round-trip | ||
| 293 | message integrity verification of the customer-provided encryption key. | ||
| 294 | |||
| 295 | |||
| 296 | |||
| 297 | =head2 SSEKMSKeyId => Str | ||
| 298 | |||
| 299 | If present, specifies the ID of the AWS Key Management Service (AWS | ||
| 300 | KMS) symmetric customer managed customer master key (CMK) that was used | ||
| 301 | for the object. | ||
| 302 | |||
| 303 | |||
| 304 | |||
| 305 | =head2 StorageClass => Str | ||
| 306 | |||
| 307 | Provides storage class information of the object. Amazon S3 returns | ||
| 308 | this header for all objects except for S3 Standard storage class | ||
| 309 | objects. | ||
| 310 | |||
| 311 | For more information, see Storage Classes | ||
| 312 | (https://docs.aws.amazon.com/AmazonS3/latest/dev/storage-class-intro.html). | ||
| 313 | |||
| 314 | Valid values are: C<"STANDARD">, C<"REDUCED_REDUNDANCY">, C<"STANDARD_IA">, C<"ONEZONE_IA">, C<"INTELLIGENT_TIERING">, C<"GLACIER">, C<"DEEP_ARCHIVE">, C<"OUTPOSTS"> | ||
| 315 | |||
| 316 | =head2 VersionId => Str | ||
| 317 | |||
| 318 | Version of the object. | ||
| 319 | |||
| 320 | |||
| 321 | |||
| 322 | =head2 WebsiteRedirectLocation => Str | ||
| 323 | |||
| 324 | If the bucket is configured as a website, redirects requests for this | ||
| 325 | object to another object in the same bucket or to an external URL. | ||
| 326 | Amazon S3 stores the value of this header in the object metadata. | ||
| 327 | |||
| 328 | |||
| 329 | |||
| 330 | |||
| 331 | =cut | ||
| 332 |