1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159
// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
#[allow(missing_docs)] // documentation missing in model
#[non_exhaustive]
#[derive(::std::clone::Clone, ::std::cmp::PartialEq)]
pub struct HeadObjectOutput {
/// <p>Specifies whether the object retrieved was (true) or was not (false) a Delete Marker. If false, this response header does not appear in the response.</p><note>
/// <p>This functionality is not supported for directory buckets.</p>
/// </note>
pub delete_marker: ::std::option::Option<bool>,
/// <p>Indicates that a range of bytes was specified.</p>
pub accept_ranges: ::std::option::Option<::std::string::String>,
/// <p>If the object expiration is configured (see <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketLifecycleConfiguration.html"> <code>PutBucketLifecycleConfiguration</code> </a>), the response includes this header. It includes the <code>expiry-date</code> and <code>rule-id</code> key-value pairs providing object expiration information. The value of the <code>rule-id</code> is URL-encoded.</p><note>
/// <p>This functionality is not supported for directory buckets.</p>
/// </note>
pub expiration: ::std::option::Option<::std::string::String>,
/// <p>If the object is an archived object (an object whose storage class is GLACIER), the response includes this header if either the archive restoration is in progress (see <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_RestoreObject.html">RestoreObject</a> or an archive copy is already restored.</p>
/// <p>If an archive copy is already restored, the header value indicates when Amazon S3 is scheduled to delete the object copy. For example:</p>
/// <p><code>x-amz-restore: ongoing-request="false", expiry-date="Fri, 21 Dec 2012 00:00:00 GMT"</code></p>
/// <p>If the object restoration is in progress, the header returns the value <code>ongoing-request="true"</code>.</p>
/// <p>For more information about archiving objects, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/object-lifecycle-mgmt.html#lifecycle-transition-general-considerations">Transitioning Objects: General Considerations</a>.</p><note>
/// <p>This functionality is not supported for directory buckets. Only the S3 Express One Zone storage class is supported by directory buckets to store objects.</p>
/// </note>
pub restore: ::std::option::Option<::std::string::String>,
/// <p>The archive state of the head object.</p><note>
/// <p>This functionality is not supported for directory buckets.</p>
/// </note>
pub archive_status: ::std::option::Option<crate::types::ArchiveStatus>,
/// <p>Date and time when the object was last modified.</p>
pub last_modified: ::std::option::Option<::aws_smithy_types::DateTime>,
/// <p>Size of the body in bytes.</p>
pub content_length: ::std::option::Option<i64>,
/// <p>The base64-encoded, 32-bit CRC32 checksum of the object. This will only be present if it was uploaded with the object. When you use an API operation on an object that was uploaded using multipart uploads, this value may not be a direct checksum value of the full object. Instead, it's a calculation based on the checksum values of each individual part. For more information about how checksums are calculated with multipart uploads, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html#large-object-checksums"> Checking object integrity</a> in the <i>Amazon S3 User Guide</i>.</p>
pub checksum_crc32: ::std::option::Option<::std::string::String>,
/// <p>The base64-encoded, 32-bit CRC32C checksum of the object. This will only be present if it was uploaded with the object. When you use an API operation on an object that was uploaded using multipart uploads, this value may not be a direct checksum value of the full object. Instead, it's a calculation based on the checksum values of each individual part. For more information about how checksums are calculated with multipart uploads, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html#large-object-checksums"> Checking object integrity</a> in the <i>Amazon S3 User Guide</i>.</p>
pub checksum_crc32_c: ::std::option::Option<::std::string::String>,
/// <p>The base64-encoded, 160-bit SHA-1 digest of the object. This will only be present if it was uploaded with the object. When you use the API operation on an object that was uploaded using multipart uploads, this value may not be a direct checksum value of the full object. Instead, it's a calculation based on the checksum values of each individual part. For more information about how checksums are calculated with multipart uploads, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html#large-object-checksums"> Checking object integrity</a> in the <i>Amazon S3 User Guide</i>.</p>
pub checksum_sha1: ::std::option::Option<::std::string::String>,
/// <p>The base64-encoded, 256-bit SHA-256 digest of the object. This will only be present if it was uploaded with the object. When you use an API operation on an object that was uploaded using multipart uploads, this value may not be a direct checksum value of the full object. Instead, it's a calculation based on the checksum values of each individual part. For more information about how checksums are calculated with multipart uploads, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html#large-object-checksums"> Checking object integrity</a> in the <i>Amazon S3 User Guide</i>.</p>
pub checksum_sha256: ::std::option::Option<::std::string::String>,
/// <p>An entity tag (ETag) is an opaque identifier assigned by a web server to a specific version of a resource found at a URL.</p>
pub e_tag: ::std::option::Option<::std::string::String>,
/// <p>This is set to the number of metadata entries not returned in <code>x-amz-meta</code> 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.</p><note>
/// <p>This functionality is not supported for directory buckets.</p>
/// </note>
pub missing_meta: ::std::option::Option<i32>,
/// <p>Version ID of the object.</p><note>
/// <p>This functionality is not supported for directory buckets.</p>
/// </note>
pub version_id: ::std::option::Option<::std::string::String>,
/// <p>Specifies caching behavior along the request/reply chain.</p>
pub cache_control: ::std::option::Option<::std::string::String>,
/// <p>Specifies presentational information for the object.</p>
pub content_disposition: ::std::option::Option<::std::string::String>,
/// <p>Indicates 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.</p>
pub content_encoding: ::std::option::Option<::std::string::String>,
/// <p>The language the content is in.</p>
pub content_language: ::std::option::Option<::std::string::String>,
/// <p>A standard MIME type describing the format of the object data.</p>
pub content_type: ::std::option::Option<::std::string::String>,
/// <p>The date and time at which the object is no longer cacheable.</p>
pub expires: ::std::option::Option<::aws_smithy_types::DateTime>,
/// <p>If the bucket is configured as a website, redirects requests for this object to another object in the same bucket or to an external URL. Amazon S3 stores the value of this header in the object metadata.</p><note>
/// <p>This functionality is not supported for directory buckets.</p>
/// </note>
pub website_redirect_location: ::std::option::Option<::std::string::String>,
/// <p>The server-side encryption algorithm used when you store this object in Amazon S3 (for example, <code>AES256</code>, <code>aws:kms</code>, <code>aws:kms:dsse</code>).</p><note>
/// <p>For directory buckets, only server-side encryption with Amazon S3 managed keys (SSE-S3) (<code>AES256</code>) is supported.</p>
/// </note>
pub server_side_encryption: ::std::option::Option<crate::types::ServerSideEncryption>,
/// <p>A map of metadata to store with the object in S3.</p>
pub metadata: ::std::option::Option<::std::collections::HashMap<::std::string::String, ::std::string::String>>,
/// <p>If server-side encryption with a customer-provided encryption key was requested, the response will include this header to confirm the encryption algorithm that's used.</p><note>
/// <p>This functionality is not supported for directory buckets.</p>
/// </note>
pub sse_customer_algorithm: ::std::option::Option<::std::string::String>,
/// <p>If server-side encryption with a customer-provided encryption key was requested, the response will include this header to provide the round-trip message integrity verification of the customer-provided encryption key.</p><note>
/// <p>This functionality is not supported for directory buckets.</p>
/// </note>
pub sse_customer_key_md5: ::std::option::Option<::std::string::String>,
/// <p>If present, indicates the ID of the Key Management Service (KMS) symmetric encryption customer managed key that was used for the object.</p><note>
/// <p>This functionality is not supported for directory buckets.</p>
/// </note>
pub ssekms_key_id: ::std::option::Option<::std::string::String>,
/// <p>Indicates whether the object uses an S3 Bucket Key for server-side encryption with Key Management Service (KMS) keys (SSE-KMS).</p><note>
/// <p>This functionality is not supported for directory buckets.</p>
/// </note>
pub bucket_key_enabled: ::std::option::Option<bool>,
/// <p>Provides storage class information of the object. Amazon S3 returns this header for all objects except for S3 Standard storage class objects.</p>
/// <p>For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/storage-class-intro.html">Storage Classes</a>.</p><note>
/// <p><b>Directory buckets </b> - Only the S3 Express One Zone storage class is supported by directory buckets to store objects.</p>
/// </note>
pub storage_class: ::std::option::Option<crate::types::StorageClass>,
/// <p>If present, indicates that the requester was successfully charged for the request.</p><note>
/// <p>This functionality is not supported for directory buckets.</p>
/// </note>
pub request_charged: ::std::option::Option<crate::types::RequestCharged>,
/// <p>Amazon S3 can return this header if your request involves a bucket that is either a source or a destination in a replication rule.</p>
/// <p>In replication, you have a source bucket on which you configure replication and destination bucket or buckets where Amazon S3 stores object replicas. When you request an object (<code>GetObject</code>) or object metadata (<code>HeadObject</code>) from these buckets, Amazon S3 will return the <code>x-amz-replication-status</code> header in the response as follows:</p>
/// <ul>
/// <li>
/// <p><b>If requesting an object from the source bucket</b>, Amazon S3 will return the <code>x-amz-replication-status</code> header if the object in your request is eligible for replication.</p>
/// <p>For example, suppose that in your replication configuration, you specify object prefix <code>TaxDocs</code> requesting Amazon S3 to replicate objects with key prefix <code>TaxDocs</code>. Any objects you upload with this key name prefix, for example <code>TaxDocs/document1.pdf</code>, are eligible for replication. For any object request with this key name prefix, Amazon S3 will return the <code>x-amz-replication-status</code> header with value PENDING, COMPLETED or FAILED indicating object replication status.</p></li>
/// <li>
/// <p><b>If requesting an object from a destination bucket</b>, Amazon S3 will return the <code>x-amz-replication-status</code> header with value REPLICA if the object in your request is a replica that Amazon S3 created and there is no replica modification replication in progress.</p></li>
/// <li>
/// <p><b>When replicating objects to multiple destination buckets</b>, the <code>x-amz-replication-status</code> header acts differently. The header of the source object will only return a value of COMPLETED when replication is successful to all destinations. The header will remain at value PENDING until replication has completed for all destinations. If one or more destinations fails replication the header will return FAILED.</p></li>
/// </ul>
/// <p>For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/NotificationHowTo.html">Replication</a>.</p><note>
/// <p>This functionality is not supported for directory buckets.</p>
/// </note>
pub replication_status: ::std::option::Option<crate::types::ReplicationStatus>,
/// <p>The count of parts this object has. This value is only returned if you specify <code>partNumber</code> in your request and the object was uploaded as a multipart upload.</p>
pub parts_count: ::std::option::Option<i32>,
/// <p>The Object Lock mode, if any, that's in effect for this object. This header is only returned if the requester has the <code>s3:GetObjectRetention</code> permission. For more information about S3 Object Lock, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/object-lock.html">Object Lock</a>.</p><note>
/// <p>This functionality is not supported for directory buckets.</p>
/// </note>
pub object_lock_mode: ::std::option::Option<crate::types::ObjectLockMode>,
/// <p>The date and time when the Object Lock retention period expires. This header is only returned if the requester has the <code>s3:GetObjectRetention</code> permission.</p><note>
/// <p>This functionality is not supported for directory buckets.</p>
/// </note>
pub object_lock_retain_until_date: ::std::option::Option<::aws_smithy_types::DateTime>,
/// <p>Specifies whether a legal hold is in effect for this object. This header is only returned if the requester has the <code>s3:GetObjectLegalHold</code> permission. This header is not returned if the specified version of this object has never had a legal hold applied. For more information about S3 Object Lock, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/object-lock.html">Object Lock</a>.</p><note>
/// <p>This functionality is not supported for directory buckets.</p>
/// </note>
pub object_lock_legal_hold_status: ::std::option::Option<crate::types::ObjectLockLegalHoldStatus>,
_extended_request_id: Option<String>,
_request_id: Option<String>,
}
impl HeadObjectOutput {
/// <p>Specifies whether the object retrieved was (true) or was not (false) a Delete Marker. If false, this response header does not appear in the response.</p><note>
/// <p>This functionality is not supported for directory buckets.</p>
/// </note>
pub fn delete_marker(&self) -> ::std::option::Option<bool> {
self.delete_marker
}
/// <p>Indicates that a range of bytes was specified.</p>
pub fn accept_ranges(&self) -> ::std::option::Option<&str> {
self.accept_ranges.as_deref()
}
/// <p>If the object expiration is configured (see <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketLifecycleConfiguration.html"> <code>PutBucketLifecycleConfiguration</code> </a>), the response includes this header. It includes the <code>expiry-date</code> and <code>rule-id</code> key-value pairs providing object expiration information. The value of the <code>rule-id</code> is URL-encoded.</p><note>
/// <p>This functionality is not supported for directory buckets.</p>
/// </note>
pub fn expiration(&self) -> ::std::option::Option<&str> {
self.expiration.as_deref()
}
/// <p>If the object is an archived object (an object whose storage class is GLACIER), the response includes this header if either the archive restoration is in progress (see <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_RestoreObject.html">RestoreObject</a> or an archive copy is already restored.</p>
/// <p>If an archive copy is already restored, the header value indicates when Amazon S3 is scheduled to delete the object copy. For example:</p>
/// <p><code>x-amz-restore: ongoing-request="false", expiry-date="Fri, 21 Dec 2012 00:00:00 GMT"</code></p>
/// <p>If the object restoration is in progress, the header returns the value <code>ongoing-request="true"</code>.</p>
/// <p>For more information about archiving objects, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/object-lifecycle-mgmt.html#lifecycle-transition-general-considerations">Transitioning Objects: General Considerations</a>.</p><note>
/// <p>This functionality is not supported for directory buckets. Only the S3 Express One Zone storage class is supported by directory buckets to store objects.</p>
/// </note>
pub fn restore(&self) -> ::std::option::Option<&str> {
self.restore.as_deref()
}
/// <p>The archive state of the head object.</p><note>
/// <p>This functionality is not supported for directory buckets.</p>
/// </note>
pub fn archive_status(&self) -> ::std::option::Option<&crate::types::ArchiveStatus> {
self.archive_status.as_ref()
}
/// <p>Date and time when the object was last modified.</p>
pub fn last_modified(&self) -> ::std::option::Option<&::aws_smithy_types::DateTime> {
self.last_modified.as_ref()
}
/// <p>Size of the body in bytes.</p>
pub fn content_length(&self) -> ::std::option::Option<i64> {
self.content_length
}
/// <p>The base64-encoded, 32-bit CRC32 checksum of the object. This will only be present if it was uploaded with the object. When you use an API operation on an object that was uploaded using multipart uploads, this value may not be a direct checksum value of the full object. Instead, it's a calculation based on the checksum values of each individual part. For more information about how checksums are calculated with multipart uploads, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html#large-object-checksums"> Checking object integrity</a> in the <i>Amazon S3 User Guide</i>.</p>
pub fn checksum_crc32(&self) -> ::std::option::Option<&str> {
self.checksum_crc32.as_deref()
}
/// <p>The base64-encoded, 32-bit CRC32C checksum of the object. This will only be present if it was uploaded with the object. When you use an API operation on an object that was uploaded using multipart uploads, this value may not be a direct checksum value of the full object. Instead, it's a calculation based on the checksum values of each individual part. For more information about how checksums are calculated with multipart uploads, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html#large-object-checksums"> Checking object integrity</a> in the <i>Amazon S3 User Guide</i>.</p>
pub fn checksum_crc32_c(&self) -> ::std::option::Option<&str> {
self.checksum_crc32_c.as_deref()
}
/// <p>The base64-encoded, 160-bit SHA-1 digest of the object. This will only be present if it was uploaded with the object. When you use the API operation on an object that was uploaded using multipart uploads, this value may not be a direct checksum value of the full object. Instead, it's a calculation based on the checksum values of each individual part. For more information about how checksums are calculated with multipart uploads, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html#large-object-checksums"> Checking object integrity</a> in the <i>Amazon S3 User Guide</i>.</p>
pub fn checksum_sha1(&self) -> ::std::option::Option<&str> {
self.checksum_sha1.as_deref()
}
/// <p>The base64-encoded, 256-bit SHA-256 digest of the object. This will only be present if it was uploaded with the object. When you use an API operation on an object that was uploaded using multipart uploads, this value may not be a direct checksum value of the full object. Instead, it's a calculation based on the checksum values of each individual part. For more information about how checksums are calculated with multipart uploads, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html#large-object-checksums"> Checking object integrity</a> in the <i>Amazon S3 User Guide</i>.</p>
pub fn checksum_sha256(&self) -> ::std::option::Option<&str> {
self.checksum_sha256.as_deref()
}
/// <p>An entity tag (ETag) is an opaque identifier assigned by a web server to a specific version of a resource found at a URL.</p>
pub fn e_tag(&self) -> ::std::option::Option<&str> {
self.e_tag.as_deref()
}
/// <p>This is set to the number of metadata entries not returned in <code>x-amz-meta</code> 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.</p><note>
/// <p>This functionality is not supported for directory buckets.</p>
/// </note>
pub fn missing_meta(&self) -> ::std::option::Option<i32> {
self.missing_meta
}
/// <p>Version ID of the object.</p><note>
/// <p>This functionality is not supported for directory buckets.</p>
/// </note>
pub fn version_id(&self) -> ::std::option::Option<&str> {
self.version_id.as_deref()
}
/// <p>Specifies caching behavior along the request/reply chain.</p>
pub fn cache_control(&self) -> ::std::option::Option<&str> {
self.cache_control.as_deref()
}
/// <p>Specifies presentational information for the object.</p>
pub fn content_disposition(&self) -> ::std::option::Option<&str> {
self.content_disposition.as_deref()
}
/// <p>Indicates 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.</p>
pub fn content_encoding(&self) -> ::std::option::Option<&str> {
self.content_encoding.as_deref()
}
/// <p>The language the content is in.</p>
pub fn content_language(&self) -> ::std::option::Option<&str> {
self.content_language.as_deref()
}
/// <p>A standard MIME type describing the format of the object data.</p>
pub fn content_type(&self) -> ::std::option::Option<&str> {
self.content_type.as_deref()
}
/// <p>The date and time at which the object is no longer cacheable.</p>
pub fn expires(&self) -> ::std::option::Option<&::aws_smithy_types::DateTime> {
self.expires.as_ref()
}
/// <p>If the bucket is configured as a website, redirects requests for this object to another object in the same bucket or to an external URL. Amazon S3 stores the value of this header in the object metadata.</p><note>
/// <p>This functionality is not supported for directory buckets.</p>
/// </note>
pub fn website_redirect_location(&self) -> ::std::option::Option<&str> {
self.website_redirect_location.as_deref()
}
/// <p>The server-side encryption algorithm used when you store this object in Amazon S3 (for example, <code>AES256</code>, <code>aws:kms</code>, <code>aws:kms:dsse</code>).</p><note>
/// <p>For directory buckets, only server-side encryption with Amazon S3 managed keys (SSE-S3) (<code>AES256</code>) is supported.</p>
/// </note>
pub fn server_side_encryption(&self) -> ::std::option::Option<&crate::types::ServerSideEncryption> {
self.server_side_encryption.as_ref()
}
/// <p>A map of metadata to store with the object in S3.</p>
pub fn metadata(&self) -> ::std::option::Option<&::std::collections::HashMap<::std::string::String, ::std::string::String>> {
self.metadata.as_ref()
}
/// <p>If server-side encryption with a customer-provided encryption key was requested, the response will include this header to confirm the encryption algorithm that's used.</p><note>
/// <p>This functionality is not supported for directory buckets.</p>
/// </note>
pub fn sse_customer_algorithm(&self) -> ::std::option::Option<&str> {
self.sse_customer_algorithm.as_deref()
}
/// <p>If server-side encryption with a customer-provided encryption key was requested, the response will include this header to provide the round-trip message integrity verification of the customer-provided encryption key.</p><note>
/// <p>This functionality is not supported for directory buckets.</p>
/// </note>
pub fn sse_customer_key_md5(&self) -> ::std::option::Option<&str> {
self.sse_customer_key_md5.as_deref()
}
/// <p>If present, indicates the ID of the Key Management Service (KMS) symmetric encryption customer managed key that was used for the object.</p><note>
/// <p>This functionality is not supported for directory buckets.</p>
/// </note>
pub fn ssekms_key_id(&self) -> ::std::option::Option<&str> {
self.ssekms_key_id.as_deref()
}
/// <p>Indicates whether the object uses an S3 Bucket Key for server-side encryption with Key Management Service (KMS) keys (SSE-KMS).</p><note>
/// <p>This functionality is not supported for directory buckets.</p>
/// </note>
pub fn bucket_key_enabled(&self) -> ::std::option::Option<bool> {
self.bucket_key_enabled
}
/// <p>Provides storage class information of the object. Amazon S3 returns this header for all objects except for S3 Standard storage class objects.</p>
/// <p>For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/storage-class-intro.html">Storage Classes</a>.</p><note>
/// <p><b>Directory buckets </b> - Only the S3 Express One Zone storage class is supported by directory buckets to store objects.</p>
/// </note>
pub fn storage_class(&self) -> ::std::option::Option<&crate::types::StorageClass> {
self.storage_class.as_ref()
}
/// <p>If present, indicates that the requester was successfully charged for the request.</p><note>
/// <p>This functionality is not supported for directory buckets.</p>
/// </note>
pub fn request_charged(&self) -> ::std::option::Option<&crate::types::RequestCharged> {
self.request_charged.as_ref()
}
/// <p>Amazon S3 can return this header if your request involves a bucket that is either a source or a destination in a replication rule.</p>
/// <p>In replication, you have a source bucket on which you configure replication and destination bucket or buckets where Amazon S3 stores object replicas. When you request an object (<code>GetObject</code>) or object metadata (<code>HeadObject</code>) from these buckets, Amazon S3 will return the <code>x-amz-replication-status</code> header in the response as follows:</p>
/// <ul>
/// <li>
/// <p><b>If requesting an object from the source bucket</b>, Amazon S3 will return the <code>x-amz-replication-status</code> header if the object in your request is eligible for replication.</p>
/// <p>For example, suppose that in your replication configuration, you specify object prefix <code>TaxDocs</code> requesting Amazon S3 to replicate objects with key prefix <code>TaxDocs</code>. Any objects you upload with this key name prefix, for example <code>TaxDocs/document1.pdf</code>, are eligible for replication. For any object request with this key name prefix, Amazon S3 will return the <code>x-amz-replication-status</code> header with value PENDING, COMPLETED or FAILED indicating object replication status.</p></li>
/// <li>
/// <p><b>If requesting an object from a destination bucket</b>, Amazon S3 will return the <code>x-amz-replication-status</code> header with value REPLICA if the object in your request is a replica that Amazon S3 created and there is no replica modification replication in progress.</p></li>
/// <li>
/// <p><b>When replicating objects to multiple destination buckets</b>, the <code>x-amz-replication-status</code> header acts differently. The header of the source object will only return a value of COMPLETED when replication is successful to all destinations. The header will remain at value PENDING until replication has completed for all destinations. If one or more destinations fails replication the header will return FAILED.</p></li>
/// </ul>
/// <p>For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/NotificationHowTo.html">Replication</a>.</p><note>
/// <p>This functionality is not supported for directory buckets.</p>
/// </note>
pub fn replication_status(&self) -> ::std::option::Option<&crate::types::ReplicationStatus> {
self.replication_status.as_ref()
}
/// <p>The count of parts this object has. This value is only returned if you specify <code>partNumber</code> in your request and the object was uploaded as a multipart upload.</p>
pub fn parts_count(&self) -> ::std::option::Option<i32> {
self.parts_count
}
/// <p>The Object Lock mode, if any, that's in effect for this object. This header is only returned if the requester has the <code>s3:GetObjectRetention</code> permission. For more information about S3 Object Lock, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/object-lock.html">Object Lock</a>.</p><note>
/// <p>This functionality is not supported for directory buckets.</p>
/// </note>
pub fn object_lock_mode(&self) -> ::std::option::Option<&crate::types::ObjectLockMode> {
self.object_lock_mode.as_ref()
}
/// <p>The date and time when the Object Lock retention period expires. This header is only returned if the requester has the <code>s3:GetObjectRetention</code> permission.</p><note>
/// <p>This functionality is not supported for directory buckets.</p>
/// </note>
pub fn object_lock_retain_until_date(&self) -> ::std::option::Option<&::aws_smithy_types::DateTime> {
self.object_lock_retain_until_date.as_ref()
}
/// <p>Specifies whether a legal hold is in effect for this object. This header is only returned if the requester has the <code>s3:GetObjectLegalHold</code> permission. This header is not returned if the specified version of this object has never had a legal hold applied. For more information about S3 Object Lock, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/object-lock.html">Object Lock</a>.</p><note>
/// <p>This functionality is not supported for directory buckets.</p>
/// </note>
pub fn object_lock_legal_hold_status(&self) -> ::std::option::Option<&crate::types::ObjectLockLegalHoldStatus> {
self.object_lock_legal_hold_status.as_ref()
}
}
impl ::std::fmt::Debug for HeadObjectOutput {
fn fmt(&self, f: &mut ::std::fmt::Formatter<'_>) -> ::std::fmt::Result {
let mut formatter = f.debug_struct("HeadObjectOutput");
formatter.field("delete_marker", &self.delete_marker);
formatter.field("accept_ranges", &self.accept_ranges);
formatter.field("expiration", &self.expiration);
formatter.field("restore", &self.restore);
formatter.field("archive_status", &self.archive_status);
formatter.field("last_modified", &self.last_modified);
formatter.field("content_length", &self.content_length);
formatter.field("checksum_crc32", &self.checksum_crc32);
formatter.field("checksum_crc32_c", &self.checksum_crc32_c);
formatter.field("checksum_sha1", &self.checksum_sha1);
formatter.field("checksum_sha256", &self.checksum_sha256);
formatter.field("e_tag", &self.e_tag);
formatter.field("missing_meta", &self.missing_meta);
formatter.field("version_id", &self.version_id);
formatter.field("cache_control", &self.cache_control);
formatter.field("content_disposition", &self.content_disposition);
formatter.field("content_encoding", &self.content_encoding);
formatter.field("content_language", &self.content_language);
formatter.field("content_type", &self.content_type);
formatter.field("expires", &self.expires);
formatter.field("website_redirect_location", &self.website_redirect_location);
formatter.field("server_side_encryption", &self.server_side_encryption);
formatter.field("metadata", &self.metadata);
formatter.field("sse_customer_algorithm", &self.sse_customer_algorithm);
formatter.field("sse_customer_key_md5", &self.sse_customer_key_md5);
formatter.field("ssekms_key_id", &"*** Sensitive Data Redacted ***");
formatter.field("bucket_key_enabled", &self.bucket_key_enabled);
formatter.field("storage_class", &self.storage_class);
formatter.field("request_charged", &self.request_charged);
formatter.field("replication_status", &self.replication_status);
formatter.field("parts_count", &self.parts_count);
formatter.field("object_lock_mode", &self.object_lock_mode);
formatter.field("object_lock_retain_until_date", &self.object_lock_retain_until_date);
formatter.field("object_lock_legal_hold_status", &self.object_lock_legal_hold_status);
formatter.field("_extended_request_id", &self._extended_request_id);
formatter.field("_request_id", &self._request_id);
formatter.finish()
}
}
impl crate::s3_request_id::RequestIdExt for HeadObjectOutput {
fn extended_request_id(&self) -> Option<&str> {
self._extended_request_id.as_deref()
}
}
impl ::aws_types::request_id::RequestId for HeadObjectOutput {
fn request_id(&self) -> Option<&str> {
self._request_id.as_deref()
}
}
impl HeadObjectOutput {
/// Creates a new builder-style object to manufacture [`HeadObjectOutput`](crate::operation::head_object::HeadObjectOutput).
pub fn builder() -> crate::operation::head_object::builders::HeadObjectOutputBuilder {
crate::operation::head_object::builders::HeadObjectOutputBuilder::default()
}
}
/// A builder for [`HeadObjectOutput`](crate::operation::head_object::HeadObjectOutput).
#[non_exhaustive]
#[derive(::std::clone::Clone, ::std::cmp::PartialEq, ::std::default::Default)]
pub struct HeadObjectOutputBuilder {
pub(crate) delete_marker: ::std::option::Option<bool>,
pub(crate) accept_ranges: ::std::option::Option<::std::string::String>,
pub(crate) expiration: ::std::option::Option<::std::string::String>,
pub(crate) restore: ::std::option::Option<::std::string::String>,
pub(crate) archive_status: ::std::option::Option<crate::types::ArchiveStatus>,
pub(crate) last_modified: ::std::option::Option<::aws_smithy_types::DateTime>,
pub(crate) content_length: ::std::option::Option<i64>,
pub(crate) checksum_crc32: ::std::option::Option<::std::string::String>,
pub(crate) checksum_crc32_c: ::std::option::Option<::std::string::String>,
pub(crate) checksum_sha1: ::std::option::Option<::std::string::String>,
pub(crate) checksum_sha256: ::std::option::Option<::std::string::String>,
pub(crate) e_tag: ::std::option::Option<::std::string::String>,
pub(crate) missing_meta: ::std::option::Option<i32>,
pub(crate) version_id: ::std::option::Option<::std::string::String>,
pub(crate) cache_control: ::std::option::Option<::std::string::String>,
pub(crate) content_disposition: ::std::option::Option<::std::string::String>,
pub(crate) content_encoding: ::std::option::Option<::std::string::String>,
pub(crate) content_language: ::std::option::Option<::std::string::String>,
pub(crate) content_type: ::std::option::Option<::std::string::String>,
pub(crate) expires: ::std::option::Option<::aws_smithy_types::DateTime>,
pub(crate) website_redirect_location: ::std::option::Option<::std::string::String>,
pub(crate) server_side_encryption: ::std::option::Option<crate::types::ServerSideEncryption>,
pub(crate) metadata: ::std::option::Option<::std::collections::HashMap<::std::string::String, ::std::string::String>>,
pub(crate) sse_customer_algorithm: ::std::option::Option<::std::string::String>,
pub(crate) sse_customer_key_md5: ::std::option::Option<::std::string::String>,
pub(crate) ssekms_key_id: ::std::option::Option<::std::string::String>,
pub(crate) bucket_key_enabled: ::std::option::Option<bool>,
pub(crate) storage_class: ::std::option::Option<crate::types::StorageClass>,
pub(crate) request_charged: ::std::option::Option<crate::types::RequestCharged>,
pub(crate) replication_status: ::std::option::Option<crate::types::ReplicationStatus>,
pub(crate) parts_count: ::std::option::Option<i32>,
pub(crate) object_lock_mode: ::std::option::Option<crate::types::ObjectLockMode>,
pub(crate) object_lock_retain_until_date: ::std::option::Option<::aws_smithy_types::DateTime>,
pub(crate) object_lock_legal_hold_status: ::std::option::Option<crate::types::ObjectLockLegalHoldStatus>,
_extended_request_id: Option<String>,
_request_id: Option<String>,
}
impl HeadObjectOutputBuilder {
/// <p>Specifies whether the object retrieved was (true) or was not (false) a Delete Marker. If false, this response header does not appear in the response.</p><note>
/// <p>This functionality is not supported for directory buckets.</p>
/// </note>
pub fn delete_marker(mut self, input: bool) -> Self {
self.delete_marker = ::std::option::Option::Some(input);
self
}
/// <p>Specifies whether the object retrieved was (true) or was not (false) a Delete Marker. If false, this response header does not appear in the response.</p><note>
/// <p>This functionality is not supported for directory buckets.</p>
/// </note>
pub fn set_delete_marker(mut self, input: ::std::option::Option<bool>) -> Self {
self.delete_marker = input;
self
}
/// <p>Specifies whether the object retrieved was (true) or was not (false) a Delete Marker. If false, this response header does not appear in the response.</p><note>
/// <p>This functionality is not supported for directory buckets.</p>
/// </note>
pub fn get_delete_marker(&self) -> &::std::option::Option<bool> {
&self.delete_marker
}
/// <p>Indicates that a range of bytes was specified.</p>
pub fn accept_ranges(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.accept_ranges = ::std::option::Option::Some(input.into());
self
}
/// <p>Indicates that a range of bytes was specified.</p>
pub fn set_accept_ranges(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.accept_ranges = input;
self
}
/// <p>Indicates that a range of bytes was specified.</p>
pub fn get_accept_ranges(&self) -> &::std::option::Option<::std::string::String> {
&self.accept_ranges
}
/// <p>If the object expiration is configured (see <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketLifecycleConfiguration.html"> <code>PutBucketLifecycleConfiguration</code> </a>), the response includes this header. It includes the <code>expiry-date</code> and <code>rule-id</code> key-value pairs providing object expiration information. The value of the <code>rule-id</code> is URL-encoded.</p><note>
/// <p>This functionality is not supported for directory buckets.</p>
/// </note>
pub fn expiration(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.expiration = ::std::option::Option::Some(input.into());
self
}
/// <p>If the object expiration is configured (see <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketLifecycleConfiguration.html"> <code>PutBucketLifecycleConfiguration</code> </a>), the response includes this header. It includes the <code>expiry-date</code> and <code>rule-id</code> key-value pairs providing object expiration information. The value of the <code>rule-id</code> is URL-encoded.</p><note>
/// <p>This functionality is not supported for directory buckets.</p>
/// </note>
pub fn set_expiration(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.expiration = input;
self
}
/// <p>If the object expiration is configured (see <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketLifecycleConfiguration.html"> <code>PutBucketLifecycleConfiguration</code> </a>), the response includes this header. It includes the <code>expiry-date</code> and <code>rule-id</code> key-value pairs providing object expiration information. The value of the <code>rule-id</code> is URL-encoded.</p><note>
/// <p>This functionality is not supported for directory buckets.</p>
/// </note>
pub fn get_expiration(&self) -> &::std::option::Option<::std::string::String> {
&self.expiration
}
/// <p>If the object is an archived object (an object whose storage class is GLACIER), the response includes this header if either the archive restoration is in progress (see <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_RestoreObject.html">RestoreObject</a> or an archive copy is already restored.</p>
/// <p>If an archive copy is already restored, the header value indicates when Amazon S3 is scheduled to delete the object copy. For example:</p>
/// <p><code>x-amz-restore: ongoing-request="false", expiry-date="Fri, 21 Dec 2012 00:00:00 GMT"</code></p>
/// <p>If the object restoration is in progress, the header returns the value <code>ongoing-request="true"</code>.</p>
/// <p>For more information about archiving objects, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/object-lifecycle-mgmt.html#lifecycle-transition-general-considerations">Transitioning Objects: General Considerations</a>.</p><note>
/// <p>This functionality is not supported for directory buckets. Only the S3 Express One Zone storage class is supported by directory buckets to store objects.</p>
/// </note>
pub fn restore(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.restore = ::std::option::Option::Some(input.into());
self
}
/// <p>If the object is an archived object (an object whose storage class is GLACIER), the response includes this header if either the archive restoration is in progress (see <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_RestoreObject.html">RestoreObject</a> or an archive copy is already restored.</p>
/// <p>If an archive copy is already restored, the header value indicates when Amazon S3 is scheduled to delete the object copy. For example:</p>
/// <p><code>x-amz-restore: ongoing-request="false", expiry-date="Fri, 21 Dec 2012 00:00:00 GMT"</code></p>
/// <p>If the object restoration is in progress, the header returns the value <code>ongoing-request="true"</code>.</p>
/// <p>For more information about archiving objects, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/object-lifecycle-mgmt.html#lifecycle-transition-general-considerations">Transitioning Objects: General Considerations</a>.</p><note>
/// <p>This functionality is not supported for directory buckets. Only the S3 Express One Zone storage class is supported by directory buckets to store objects.</p>
/// </note>
pub fn set_restore(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.restore = input;
self
}
/// <p>If the object is an archived object (an object whose storage class is GLACIER), the response includes this header if either the archive restoration is in progress (see <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_RestoreObject.html">RestoreObject</a> or an archive copy is already restored.</p>
/// <p>If an archive copy is already restored, the header value indicates when Amazon S3 is scheduled to delete the object copy. For example:</p>
/// <p><code>x-amz-restore: ongoing-request="false", expiry-date="Fri, 21 Dec 2012 00:00:00 GMT"</code></p>
/// <p>If the object restoration is in progress, the header returns the value <code>ongoing-request="true"</code>.</p>
/// <p>For more information about archiving objects, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/object-lifecycle-mgmt.html#lifecycle-transition-general-considerations">Transitioning Objects: General Considerations</a>.</p><note>
/// <p>This functionality is not supported for directory buckets. Only the S3 Express One Zone storage class is supported by directory buckets to store objects.</p>
/// </note>
pub fn get_restore(&self) -> &::std::option::Option<::std::string::String> {
&self.restore
}
/// <p>The archive state of the head object.</p><note>
/// <p>This functionality is not supported for directory buckets.</p>
/// </note>
pub fn archive_status(mut self, input: crate::types::ArchiveStatus) -> Self {
self.archive_status = ::std::option::Option::Some(input);
self
}
/// <p>The archive state of the head object.</p><note>
/// <p>This functionality is not supported for directory buckets.</p>
/// </note>
pub fn set_archive_status(mut self, input: ::std::option::Option<crate::types::ArchiveStatus>) -> Self {
self.archive_status = input;
self
}
/// <p>The archive state of the head object.</p><note>
/// <p>This functionality is not supported for directory buckets.</p>
/// </note>
pub fn get_archive_status(&self) -> &::std::option::Option<crate::types::ArchiveStatus> {
&self.archive_status
}
/// <p>Date and time when the object was last modified.</p>
pub fn last_modified(mut self, input: ::aws_smithy_types::DateTime) -> Self {
self.last_modified = ::std::option::Option::Some(input);
self
}
/// <p>Date and time when the object was last modified.</p>
pub fn set_last_modified(mut self, input: ::std::option::Option<::aws_smithy_types::DateTime>) -> Self {
self.last_modified = input;
self
}
/// <p>Date and time when the object was last modified.</p>
pub fn get_last_modified(&self) -> &::std::option::Option<::aws_smithy_types::DateTime> {
&self.last_modified
}
/// <p>Size of the body in bytes.</p>
pub fn content_length(mut self, input: i64) -> Self {
self.content_length = ::std::option::Option::Some(input);
self
}
/// <p>Size of the body in bytes.</p>
pub fn set_content_length(mut self, input: ::std::option::Option<i64>) -> Self {
self.content_length = input;
self
}
/// <p>Size of the body in bytes.</p>
pub fn get_content_length(&self) -> &::std::option::Option<i64> {
&self.content_length
}
/// <p>The base64-encoded, 32-bit CRC32 checksum of the object. This will only be present if it was uploaded with the object. When you use an API operation on an object that was uploaded using multipart uploads, this value may not be a direct checksum value of the full object. Instead, it's a calculation based on the checksum values of each individual part. For more information about how checksums are calculated with multipart uploads, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html#large-object-checksums"> Checking object integrity</a> in the <i>Amazon S3 User Guide</i>.</p>
pub fn checksum_crc32(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.checksum_crc32 = ::std::option::Option::Some(input.into());
self
}
/// <p>The base64-encoded, 32-bit CRC32 checksum of the object. This will only be present if it was uploaded with the object. When you use an API operation on an object that was uploaded using multipart uploads, this value may not be a direct checksum value of the full object. Instead, it's a calculation based on the checksum values of each individual part. For more information about how checksums are calculated with multipart uploads, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html#large-object-checksums"> Checking object integrity</a> in the <i>Amazon S3 User Guide</i>.</p>
pub fn set_checksum_crc32(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.checksum_crc32 = input;
self
}
/// <p>The base64-encoded, 32-bit CRC32 checksum of the object. This will only be present if it was uploaded with the object. When you use an API operation on an object that was uploaded using multipart uploads, this value may not be a direct checksum value of the full object. Instead, it's a calculation based on the checksum values of each individual part. For more information about how checksums are calculated with multipart uploads, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html#large-object-checksums"> Checking object integrity</a> in the <i>Amazon S3 User Guide</i>.</p>
pub fn get_checksum_crc32(&self) -> &::std::option::Option<::std::string::String> {
&self.checksum_crc32
}
/// <p>The base64-encoded, 32-bit CRC32C checksum of the object. This will only be present if it was uploaded with the object. When you use an API operation on an object that was uploaded using multipart uploads, this value may not be a direct checksum value of the full object. Instead, it's a calculation based on the checksum values of each individual part. For more information about how checksums are calculated with multipart uploads, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html#large-object-checksums"> Checking object integrity</a> in the <i>Amazon S3 User Guide</i>.</p>
pub fn checksum_crc32_c(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.checksum_crc32_c = ::std::option::Option::Some(input.into());
self
}
/// <p>The base64-encoded, 32-bit CRC32C checksum of the object. This will only be present if it was uploaded with the object. When you use an API operation on an object that was uploaded using multipart uploads, this value may not be a direct checksum value of the full object. Instead, it's a calculation based on the checksum values of each individual part. For more information about how checksums are calculated with multipart uploads, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html#large-object-checksums"> Checking object integrity</a> in the <i>Amazon S3 User Guide</i>.</p>
pub fn set_checksum_crc32_c(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.checksum_crc32_c = input;
self
}
/// <p>The base64-encoded, 32-bit CRC32C checksum of the object. This will only be present if it was uploaded with the object. When you use an API operation on an object that was uploaded using multipart uploads, this value may not be a direct checksum value of the full object. Instead, it's a calculation based on the checksum values of each individual part. For more information about how checksums are calculated with multipart uploads, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html#large-object-checksums"> Checking object integrity</a> in the <i>Amazon S3 User Guide</i>.</p>
pub fn get_checksum_crc32_c(&self) -> &::std::option::Option<::std::string::String> {
&self.checksum_crc32_c
}
/// <p>The base64-encoded, 160-bit SHA-1 digest of the object. This will only be present if it was uploaded with the object. When you use the API operation on an object that was uploaded using multipart uploads, this value may not be a direct checksum value of the full object. Instead, it's a calculation based on the checksum values of each individual part. For more information about how checksums are calculated with multipart uploads, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html#large-object-checksums"> Checking object integrity</a> in the <i>Amazon S3 User Guide</i>.</p>
pub fn checksum_sha1(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.checksum_sha1 = ::std::option::Option::Some(input.into());
self
}
/// <p>The base64-encoded, 160-bit SHA-1 digest of the object. This will only be present if it was uploaded with the object. When you use the API operation on an object that was uploaded using multipart uploads, this value may not be a direct checksum value of the full object. Instead, it's a calculation based on the checksum values of each individual part. For more information about how checksums are calculated with multipart uploads, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html#large-object-checksums"> Checking object integrity</a> in the <i>Amazon S3 User Guide</i>.</p>
pub fn set_checksum_sha1(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.checksum_sha1 = input;
self
}
/// <p>The base64-encoded, 160-bit SHA-1 digest of the object. This will only be present if it was uploaded with the object. When you use the API operation on an object that was uploaded using multipart uploads, this value may not be a direct checksum value of the full object. Instead, it's a calculation based on the checksum values of each individual part. For more information about how checksums are calculated with multipart uploads, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html#large-object-checksums"> Checking object integrity</a> in the <i>Amazon S3 User Guide</i>.</p>
pub fn get_checksum_sha1(&self) -> &::std::option::Option<::std::string::String> {
&self.checksum_sha1
}
/// <p>The base64-encoded, 256-bit SHA-256 digest of the object. This will only be present if it was uploaded with the object. When you use an API operation on an object that was uploaded using multipart uploads, this value may not be a direct checksum value of the full object. Instead, it's a calculation based on the checksum values of each individual part. For more information about how checksums are calculated with multipart uploads, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html#large-object-checksums"> Checking object integrity</a> in the <i>Amazon S3 User Guide</i>.</p>
pub fn checksum_sha256(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.checksum_sha256 = ::std::option::Option::Some(input.into());
self
}
/// <p>The base64-encoded, 256-bit SHA-256 digest of the object. This will only be present if it was uploaded with the object. When you use an API operation on an object that was uploaded using multipart uploads, this value may not be a direct checksum value of the full object. Instead, it's a calculation based on the checksum values of each individual part. For more information about how checksums are calculated with multipart uploads, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html#large-object-checksums"> Checking object integrity</a> in the <i>Amazon S3 User Guide</i>.</p>
pub fn set_checksum_sha256(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.checksum_sha256 = input;
self
}
/// <p>The base64-encoded, 256-bit SHA-256 digest of the object. This will only be present if it was uploaded with the object. When you use an API operation on an object that was uploaded using multipart uploads, this value may not be a direct checksum value of the full object. Instead, it's a calculation based on the checksum values of each individual part. For more information about how checksums are calculated with multipart uploads, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html#large-object-checksums"> Checking object integrity</a> in the <i>Amazon S3 User Guide</i>.</p>
pub fn get_checksum_sha256(&self) -> &::std::option::Option<::std::string::String> {
&self.checksum_sha256
}
/// <p>An entity tag (ETag) is an opaque identifier assigned by a web server to a specific version of a resource found at a URL.</p>
pub fn e_tag(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.e_tag = ::std::option::Option::Some(input.into());
self
}
/// <p>An entity tag (ETag) is an opaque identifier assigned by a web server to a specific version of a resource found at a URL.</p>
pub fn set_e_tag(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.e_tag = input;
self
}
/// <p>An entity tag (ETag) is an opaque identifier assigned by a web server to a specific version of a resource found at a URL.</p>
pub fn get_e_tag(&self) -> &::std::option::Option<::std::string::String> {
&self.e_tag
}
/// <p>This is set to the number of metadata entries not returned in <code>x-amz-meta</code> 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.</p><note>
/// <p>This functionality is not supported for directory buckets.</p>
/// </note>
pub fn missing_meta(mut self, input: i32) -> Self {
self.missing_meta = ::std::option::Option::Some(input);
self
}
/// <p>This is set to the number of metadata entries not returned in <code>x-amz-meta</code> 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.</p><note>
/// <p>This functionality is not supported for directory buckets.</p>
/// </note>
pub fn set_missing_meta(mut self, input: ::std::option::Option<i32>) -> Self {
self.missing_meta = input;
self
}
/// <p>This is set to the number of metadata entries not returned in <code>x-amz-meta</code> 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.</p><note>
/// <p>This functionality is not supported for directory buckets.</p>
/// </note>
pub fn get_missing_meta(&self) -> &::std::option::Option<i32> {
&self.missing_meta
}
/// <p>Version ID of the object.</p><note>
/// <p>This functionality is not supported for directory buckets.</p>
/// </note>
pub fn version_id(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.version_id = ::std::option::Option::Some(input.into());
self
}
/// <p>Version ID of the object.</p><note>
/// <p>This functionality is not supported for directory buckets.</p>
/// </note>
pub fn set_version_id(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.version_id = input;
self
}
/// <p>Version ID of the object.</p><note>
/// <p>This functionality is not supported for directory buckets.</p>
/// </note>
pub fn get_version_id(&self) -> &::std::option::Option<::std::string::String> {
&self.version_id
}
/// <p>Specifies caching behavior along the request/reply chain.</p>
pub fn cache_control(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.cache_control = ::std::option::Option::Some(input.into());
self
}
/// <p>Specifies caching behavior along the request/reply chain.</p>
pub fn set_cache_control(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.cache_control = input;
self
}
/// <p>Specifies caching behavior along the request/reply chain.</p>
pub fn get_cache_control(&self) -> &::std::option::Option<::std::string::String> {
&self.cache_control
}
/// <p>Specifies presentational information for the object.</p>
pub fn content_disposition(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.content_disposition = ::std::option::Option::Some(input.into());
self
}
/// <p>Specifies presentational information for the object.</p>
pub fn set_content_disposition(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.content_disposition = input;
self
}
/// <p>Specifies presentational information for the object.</p>
pub fn get_content_disposition(&self) -> &::std::option::Option<::std::string::String> {
&self.content_disposition
}
/// <p>Indicates 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.</p>
pub fn content_encoding(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.content_encoding = ::std::option::Option::Some(input.into());
self
}
/// <p>Indicates 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.</p>
pub fn set_content_encoding(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.content_encoding = input;
self
}
/// <p>Indicates 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.</p>
pub fn get_content_encoding(&self) -> &::std::option::Option<::std::string::String> {
&self.content_encoding
}
/// <p>The language the content is in.</p>
pub fn content_language(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.content_language = ::std::option::Option::Some(input.into());
self
}
/// <p>The language the content is in.</p>
pub fn set_content_language(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.content_language = input;
self
}
/// <p>The language the content is in.</p>
pub fn get_content_language(&self) -> &::std::option::Option<::std::string::String> {
&self.content_language
}
/// <p>A standard MIME type describing the format of the object data.</p>
pub fn content_type(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.content_type = ::std::option::Option::Some(input.into());
self
}
/// <p>A standard MIME type describing the format of the object data.</p>
pub fn set_content_type(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.content_type = input;
self
}
/// <p>A standard MIME type describing the format of the object data.</p>
pub fn get_content_type(&self) -> &::std::option::Option<::std::string::String> {
&self.content_type
}
/// <p>The date and time at which the object is no longer cacheable.</p>
pub fn expires(mut self, input: ::aws_smithy_types::DateTime) -> Self {
self.expires = ::std::option::Option::Some(input);
self
}
/// <p>The date and time at which the object is no longer cacheable.</p>
pub fn set_expires(mut self, input: ::std::option::Option<::aws_smithy_types::DateTime>) -> Self {
self.expires = input;
self
}
/// <p>The date and time at which the object is no longer cacheable.</p>
pub fn get_expires(&self) -> &::std::option::Option<::aws_smithy_types::DateTime> {
&self.expires
}
/// <p>If the bucket is configured as a website, redirects requests for this object to another object in the same bucket or to an external URL. Amazon S3 stores the value of this header in the object metadata.</p><note>
/// <p>This functionality is not supported for directory buckets.</p>
/// </note>
pub fn website_redirect_location(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.website_redirect_location = ::std::option::Option::Some(input.into());
self
}
/// <p>If the bucket is configured as a website, redirects requests for this object to another object in the same bucket or to an external URL. Amazon S3 stores the value of this header in the object metadata.</p><note>
/// <p>This functionality is not supported for directory buckets.</p>
/// </note>
pub fn set_website_redirect_location(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.website_redirect_location = input;
self
}
/// <p>If the bucket is configured as a website, redirects requests for this object to another object in the same bucket or to an external URL. Amazon S3 stores the value of this header in the object metadata.</p><note>
/// <p>This functionality is not supported for directory buckets.</p>
/// </note>
pub fn get_website_redirect_location(&self) -> &::std::option::Option<::std::string::String> {
&self.website_redirect_location
}
/// <p>The server-side encryption algorithm used when you store this object in Amazon S3 (for example, <code>AES256</code>, <code>aws:kms</code>, <code>aws:kms:dsse</code>).</p><note>
/// <p>For directory buckets, only server-side encryption with Amazon S3 managed keys (SSE-S3) (<code>AES256</code>) is supported.</p>
/// </note>
pub fn server_side_encryption(mut self, input: crate::types::ServerSideEncryption) -> Self {
self.server_side_encryption = ::std::option::Option::Some(input);
self
}
/// <p>The server-side encryption algorithm used when you store this object in Amazon S3 (for example, <code>AES256</code>, <code>aws:kms</code>, <code>aws:kms:dsse</code>).</p><note>
/// <p>For directory buckets, only server-side encryption with Amazon S3 managed keys (SSE-S3) (<code>AES256</code>) is supported.</p>
/// </note>
pub fn set_server_side_encryption(mut self, input: ::std::option::Option<crate::types::ServerSideEncryption>) -> Self {
self.server_side_encryption = input;
self
}
/// <p>The server-side encryption algorithm used when you store this object in Amazon S3 (for example, <code>AES256</code>, <code>aws:kms</code>, <code>aws:kms:dsse</code>).</p><note>
/// <p>For directory buckets, only server-side encryption with Amazon S3 managed keys (SSE-S3) (<code>AES256</code>) is supported.</p>
/// </note>
pub fn get_server_side_encryption(&self) -> &::std::option::Option<crate::types::ServerSideEncryption> {
&self.server_side_encryption
}
/// Adds a key-value pair to `metadata`.
///
/// To override the contents of this collection use [`set_metadata`](Self::set_metadata).
///
/// <p>A map of metadata to store with the object in S3.</p>
pub fn metadata(mut self, k: impl ::std::convert::Into<::std::string::String>, v: impl ::std::convert::Into<::std::string::String>) -> Self {
let mut hash_map = self.metadata.unwrap_or_default();
hash_map.insert(k.into(), v.into());
self.metadata = ::std::option::Option::Some(hash_map);
self
}
/// <p>A map of metadata to store with the object in S3.</p>
pub fn set_metadata(mut self, input: ::std::option::Option<::std::collections::HashMap<::std::string::String, ::std::string::String>>) -> Self {
self.metadata = input;
self
}
/// <p>A map of metadata to store with the object in S3.</p>
pub fn get_metadata(&self) -> &::std::option::Option<::std::collections::HashMap<::std::string::String, ::std::string::String>> {
&self.metadata
}
/// <p>If server-side encryption with a customer-provided encryption key was requested, the response will include this header to confirm the encryption algorithm that's used.</p><note>
/// <p>This functionality is not supported for directory buckets.</p>
/// </note>
pub fn sse_customer_algorithm(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.sse_customer_algorithm = ::std::option::Option::Some(input.into());
self
}
/// <p>If server-side encryption with a customer-provided encryption key was requested, the response will include this header to confirm the encryption algorithm that's used.</p><note>
/// <p>This functionality is not supported for directory buckets.</p>
/// </note>
pub fn set_sse_customer_algorithm(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.sse_customer_algorithm = input;
self
}
/// <p>If server-side encryption with a customer-provided encryption key was requested, the response will include this header to confirm the encryption algorithm that's used.</p><note>
/// <p>This functionality is not supported for directory buckets.</p>
/// </note>
pub fn get_sse_customer_algorithm(&self) -> &::std::option::Option<::std::string::String> {
&self.sse_customer_algorithm
}
/// <p>If server-side encryption with a customer-provided encryption key was requested, the response will include this header to provide the round-trip message integrity verification of the customer-provided encryption key.</p><note>
/// <p>This functionality is not supported for directory buckets.</p>
/// </note>
pub fn sse_customer_key_md5(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.sse_customer_key_md5 = ::std::option::Option::Some(input.into());
self
}
/// <p>If server-side encryption with a customer-provided encryption key was requested, the response will include this header to provide the round-trip message integrity verification of the customer-provided encryption key.</p><note>
/// <p>This functionality is not supported for directory buckets.</p>
/// </note>
pub fn set_sse_customer_key_md5(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.sse_customer_key_md5 = input;
self
}
/// <p>If server-side encryption with a customer-provided encryption key was requested, the response will include this header to provide the round-trip message integrity verification of the customer-provided encryption key.</p><note>
/// <p>This functionality is not supported for directory buckets.</p>
/// </note>
pub fn get_sse_customer_key_md5(&self) -> &::std::option::Option<::std::string::String> {
&self.sse_customer_key_md5
}
/// <p>If present, indicates the ID of the Key Management Service (KMS) symmetric encryption customer managed key that was used for the object.</p><note>
/// <p>This functionality is not supported for directory buckets.</p>
/// </note>
pub fn ssekms_key_id(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.ssekms_key_id = ::std::option::Option::Some(input.into());
self
}
/// <p>If present, indicates the ID of the Key Management Service (KMS) symmetric encryption customer managed key that was used for the object.</p><note>
/// <p>This functionality is not supported for directory buckets.</p>
/// </note>
pub fn set_ssekms_key_id(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.ssekms_key_id = input;
self
}
/// <p>If present, indicates the ID of the Key Management Service (KMS) symmetric encryption customer managed key that was used for the object.</p><note>
/// <p>This functionality is not supported for directory buckets.</p>
/// </note>
pub fn get_ssekms_key_id(&self) -> &::std::option::Option<::std::string::String> {
&self.ssekms_key_id
}
/// <p>Indicates whether the object uses an S3 Bucket Key for server-side encryption with Key Management Service (KMS) keys (SSE-KMS).</p><note>
/// <p>This functionality is not supported for directory buckets.</p>
/// </note>
pub fn bucket_key_enabled(mut self, input: bool) -> Self {
self.bucket_key_enabled = ::std::option::Option::Some(input);
self
}
/// <p>Indicates whether the object uses an S3 Bucket Key for server-side encryption with Key Management Service (KMS) keys (SSE-KMS).</p><note>
/// <p>This functionality is not supported for directory buckets.</p>
/// </note>
pub fn set_bucket_key_enabled(mut self, input: ::std::option::Option<bool>) -> Self {
self.bucket_key_enabled = input;
self
}
/// <p>Indicates whether the object uses an S3 Bucket Key for server-side encryption with Key Management Service (KMS) keys (SSE-KMS).</p><note>
/// <p>This functionality is not supported for directory buckets.</p>
/// </note>
pub fn get_bucket_key_enabled(&self) -> &::std::option::Option<bool> {
&self.bucket_key_enabled
}
/// <p>Provides storage class information of the object. Amazon S3 returns this header for all objects except for S3 Standard storage class objects.</p>
/// <p>For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/storage-class-intro.html">Storage Classes</a>.</p><note>
/// <p><b>Directory buckets </b> - Only the S3 Express One Zone storage class is supported by directory buckets to store objects.</p>
/// </note>
pub fn storage_class(mut self, input: crate::types::StorageClass) -> Self {
self.storage_class = ::std::option::Option::Some(input);
self
}
/// <p>Provides storage class information of the object. Amazon S3 returns this header for all objects except for S3 Standard storage class objects.</p>
/// <p>For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/storage-class-intro.html">Storage Classes</a>.</p><note>
/// <p><b>Directory buckets </b> - Only the S3 Express One Zone storage class is supported by directory buckets to store objects.</p>
/// </note>
pub fn set_storage_class(mut self, input: ::std::option::Option<crate::types::StorageClass>) -> Self {
self.storage_class = input;
self
}
/// <p>Provides storage class information of the object. Amazon S3 returns this header for all objects except for S3 Standard storage class objects.</p>
/// <p>For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/storage-class-intro.html">Storage Classes</a>.</p><note>
/// <p><b>Directory buckets </b> - Only the S3 Express One Zone storage class is supported by directory buckets to store objects.</p>
/// </note>
pub fn get_storage_class(&self) -> &::std::option::Option<crate::types::StorageClass> {
&self.storage_class
}
/// <p>If present, indicates that the requester was successfully charged for the request.</p><note>
/// <p>This functionality is not supported for directory buckets.</p>
/// </note>
pub fn request_charged(mut self, input: crate::types::RequestCharged) -> Self {
self.request_charged = ::std::option::Option::Some(input);
self
}
/// <p>If present, indicates that the requester was successfully charged for the request.</p><note>
/// <p>This functionality is not supported for directory buckets.</p>
/// </note>
pub fn set_request_charged(mut self, input: ::std::option::Option<crate::types::RequestCharged>) -> Self {
self.request_charged = input;
self
}
/// <p>If present, indicates that the requester was successfully charged for the request.</p><note>
/// <p>This functionality is not supported for directory buckets.</p>
/// </note>
pub fn get_request_charged(&self) -> &::std::option::Option<crate::types::RequestCharged> {
&self.request_charged
}
/// <p>Amazon S3 can return this header if your request involves a bucket that is either a source or a destination in a replication rule.</p>
/// <p>In replication, you have a source bucket on which you configure replication and destination bucket or buckets where Amazon S3 stores object replicas. When you request an object (<code>GetObject</code>) or object metadata (<code>HeadObject</code>) from these buckets, Amazon S3 will return the <code>x-amz-replication-status</code> header in the response as follows:</p>
/// <ul>
/// <li>
/// <p><b>If requesting an object from the source bucket</b>, Amazon S3 will return the <code>x-amz-replication-status</code> header if the object in your request is eligible for replication.</p>
/// <p>For example, suppose that in your replication configuration, you specify object prefix <code>TaxDocs</code> requesting Amazon S3 to replicate objects with key prefix <code>TaxDocs</code>. Any objects you upload with this key name prefix, for example <code>TaxDocs/document1.pdf</code>, are eligible for replication. For any object request with this key name prefix, Amazon S3 will return the <code>x-amz-replication-status</code> header with value PENDING, COMPLETED or FAILED indicating object replication status.</p></li>
/// <li>
/// <p><b>If requesting an object from a destination bucket</b>, Amazon S3 will return the <code>x-amz-replication-status</code> header with value REPLICA if the object in your request is a replica that Amazon S3 created and there is no replica modification replication in progress.</p></li>
/// <li>
/// <p><b>When replicating objects to multiple destination buckets</b>, the <code>x-amz-replication-status</code> header acts differently. The header of the source object will only return a value of COMPLETED when replication is successful to all destinations. The header will remain at value PENDING until replication has completed for all destinations. If one or more destinations fails replication the header will return FAILED.</p></li>
/// </ul>
/// <p>For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/NotificationHowTo.html">Replication</a>.</p><note>
/// <p>This functionality is not supported for directory buckets.</p>
/// </note>
pub fn replication_status(mut self, input: crate::types::ReplicationStatus) -> Self {
self.replication_status = ::std::option::Option::Some(input);
self
}
/// <p>Amazon S3 can return this header if your request involves a bucket that is either a source or a destination in a replication rule.</p>
/// <p>In replication, you have a source bucket on which you configure replication and destination bucket or buckets where Amazon S3 stores object replicas. When you request an object (<code>GetObject</code>) or object metadata (<code>HeadObject</code>) from these buckets, Amazon S3 will return the <code>x-amz-replication-status</code> header in the response as follows:</p>
/// <ul>
/// <li>
/// <p><b>If requesting an object from the source bucket</b>, Amazon S3 will return the <code>x-amz-replication-status</code> header if the object in your request is eligible for replication.</p>
/// <p>For example, suppose that in your replication configuration, you specify object prefix <code>TaxDocs</code> requesting Amazon S3 to replicate objects with key prefix <code>TaxDocs</code>. Any objects you upload with this key name prefix, for example <code>TaxDocs/document1.pdf</code>, are eligible for replication. For any object request with this key name prefix, Amazon S3 will return the <code>x-amz-replication-status</code> header with value PENDING, COMPLETED or FAILED indicating object replication status.</p></li>
/// <li>
/// <p><b>If requesting an object from a destination bucket</b>, Amazon S3 will return the <code>x-amz-replication-status</code> header with value REPLICA if the object in your request is a replica that Amazon S3 created and there is no replica modification replication in progress.</p></li>
/// <li>
/// <p><b>When replicating objects to multiple destination buckets</b>, the <code>x-amz-replication-status</code> header acts differently. The header of the source object will only return a value of COMPLETED when replication is successful to all destinations. The header will remain at value PENDING until replication has completed for all destinations. If one or more destinations fails replication the header will return FAILED.</p></li>
/// </ul>
/// <p>For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/NotificationHowTo.html">Replication</a>.</p><note>
/// <p>This functionality is not supported for directory buckets.</p>
/// </note>
pub fn set_replication_status(mut self, input: ::std::option::Option<crate::types::ReplicationStatus>) -> Self {
self.replication_status = input;
self
}
/// <p>Amazon S3 can return this header if your request involves a bucket that is either a source or a destination in a replication rule.</p>
/// <p>In replication, you have a source bucket on which you configure replication and destination bucket or buckets where Amazon S3 stores object replicas. When you request an object (<code>GetObject</code>) or object metadata (<code>HeadObject</code>) from these buckets, Amazon S3 will return the <code>x-amz-replication-status</code> header in the response as follows:</p>
/// <ul>
/// <li>
/// <p><b>If requesting an object from the source bucket</b>, Amazon S3 will return the <code>x-amz-replication-status</code> header if the object in your request is eligible for replication.</p>
/// <p>For example, suppose that in your replication configuration, you specify object prefix <code>TaxDocs</code> requesting Amazon S3 to replicate objects with key prefix <code>TaxDocs</code>. Any objects you upload with this key name prefix, for example <code>TaxDocs/document1.pdf</code>, are eligible for replication. For any object request with this key name prefix, Amazon S3 will return the <code>x-amz-replication-status</code> header with value PENDING, COMPLETED or FAILED indicating object replication status.</p></li>
/// <li>
/// <p><b>If requesting an object from a destination bucket</b>, Amazon S3 will return the <code>x-amz-replication-status</code> header with value REPLICA if the object in your request is a replica that Amazon S3 created and there is no replica modification replication in progress.</p></li>
/// <li>
/// <p><b>When replicating objects to multiple destination buckets</b>, the <code>x-amz-replication-status</code> header acts differently. The header of the source object will only return a value of COMPLETED when replication is successful to all destinations. The header will remain at value PENDING until replication has completed for all destinations. If one or more destinations fails replication the header will return FAILED.</p></li>
/// </ul>
/// <p>For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/NotificationHowTo.html">Replication</a>.</p><note>
/// <p>This functionality is not supported for directory buckets.</p>
/// </note>
pub fn get_replication_status(&self) -> &::std::option::Option<crate::types::ReplicationStatus> {
&self.replication_status
}
/// <p>The count of parts this object has. This value is only returned if you specify <code>partNumber</code> in your request and the object was uploaded as a multipart upload.</p>
pub fn parts_count(mut self, input: i32) -> Self {
self.parts_count = ::std::option::Option::Some(input);
self
}
/// <p>The count of parts this object has. This value is only returned if you specify <code>partNumber</code> in your request and the object was uploaded as a multipart upload.</p>
pub fn set_parts_count(mut self, input: ::std::option::Option<i32>) -> Self {
self.parts_count = input;
self
}
/// <p>The count of parts this object has. This value is only returned if you specify <code>partNumber</code> in your request and the object was uploaded as a multipart upload.</p>
pub fn get_parts_count(&self) -> &::std::option::Option<i32> {
&self.parts_count
}
/// <p>The Object Lock mode, if any, that's in effect for this object. This header is only returned if the requester has the <code>s3:GetObjectRetention</code> permission. For more information about S3 Object Lock, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/object-lock.html">Object Lock</a>.</p><note>
/// <p>This functionality is not supported for directory buckets.</p>
/// </note>
pub fn object_lock_mode(mut self, input: crate::types::ObjectLockMode) -> Self {
self.object_lock_mode = ::std::option::Option::Some(input);
self
}
/// <p>The Object Lock mode, if any, that's in effect for this object. This header is only returned if the requester has the <code>s3:GetObjectRetention</code> permission. For more information about S3 Object Lock, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/object-lock.html">Object Lock</a>.</p><note>
/// <p>This functionality is not supported for directory buckets.</p>
/// </note>
pub fn set_object_lock_mode(mut self, input: ::std::option::Option<crate::types::ObjectLockMode>) -> Self {
self.object_lock_mode = input;
self
}
/// <p>The Object Lock mode, if any, that's in effect for this object. This header is only returned if the requester has the <code>s3:GetObjectRetention</code> permission. For more information about S3 Object Lock, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/object-lock.html">Object Lock</a>.</p><note>
/// <p>This functionality is not supported for directory buckets.</p>
/// </note>
pub fn get_object_lock_mode(&self) -> &::std::option::Option<crate::types::ObjectLockMode> {
&self.object_lock_mode
}
/// <p>The date and time when the Object Lock retention period expires. This header is only returned if the requester has the <code>s3:GetObjectRetention</code> permission.</p><note>
/// <p>This functionality is not supported for directory buckets.</p>
/// </note>
pub fn object_lock_retain_until_date(mut self, input: ::aws_smithy_types::DateTime) -> Self {
self.object_lock_retain_until_date = ::std::option::Option::Some(input);
self
}
/// <p>The date and time when the Object Lock retention period expires. This header is only returned if the requester has the <code>s3:GetObjectRetention</code> permission.</p><note>
/// <p>This functionality is not supported for directory buckets.</p>
/// </note>
pub fn set_object_lock_retain_until_date(mut self, input: ::std::option::Option<::aws_smithy_types::DateTime>) -> Self {
self.object_lock_retain_until_date = input;
self
}
/// <p>The date and time when the Object Lock retention period expires. This header is only returned if the requester has the <code>s3:GetObjectRetention</code> permission.</p><note>
/// <p>This functionality is not supported for directory buckets.</p>
/// </note>
pub fn get_object_lock_retain_until_date(&self) -> &::std::option::Option<::aws_smithy_types::DateTime> {
&self.object_lock_retain_until_date
}
/// <p>Specifies whether a legal hold is in effect for this object. This header is only returned if the requester has the <code>s3:GetObjectLegalHold</code> permission. This header is not returned if the specified version of this object has never had a legal hold applied. For more information about S3 Object Lock, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/object-lock.html">Object Lock</a>.</p><note>
/// <p>This functionality is not supported for directory buckets.</p>
/// </note>
pub fn object_lock_legal_hold_status(mut self, input: crate::types::ObjectLockLegalHoldStatus) -> Self {
self.object_lock_legal_hold_status = ::std::option::Option::Some(input);
self
}
/// <p>Specifies whether a legal hold is in effect for this object. This header is only returned if the requester has the <code>s3:GetObjectLegalHold</code> permission. This header is not returned if the specified version of this object has never had a legal hold applied. For more information about S3 Object Lock, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/object-lock.html">Object Lock</a>.</p><note>
/// <p>This functionality is not supported for directory buckets.</p>
/// </note>
pub fn set_object_lock_legal_hold_status(mut self, input: ::std::option::Option<crate::types::ObjectLockLegalHoldStatus>) -> Self {
self.object_lock_legal_hold_status = input;
self
}
/// <p>Specifies whether a legal hold is in effect for this object. This header is only returned if the requester has the <code>s3:GetObjectLegalHold</code> permission. This header is not returned if the specified version of this object has never had a legal hold applied. For more information about S3 Object Lock, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/object-lock.html">Object Lock</a>.</p><note>
/// <p>This functionality is not supported for directory buckets.</p>
/// </note>
pub fn get_object_lock_legal_hold_status(&self) -> &::std::option::Option<crate::types::ObjectLockLegalHoldStatus> {
&self.object_lock_legal_hold_status
}
pub(crate) fn _extended_request_id(mut self, extended_request_id: impl Into<String>) -> Self {
self._extended_request_id = Some(extended_request_id.into());
self
}
pub(crate) fn _set_extended_request_id(&mut self, extended_request_id: Option<String>) -> &mut Self {
self._extended_request_id = extended_request_id;
self
}
pub(crate) fn _request_id(mut self, request_id: impl Into<String>) -> Self {
self._request_id = Some(request_id.into());
self
}
pub(crate) fn _set_request_id(&mut self, request_id: Option<String>) -> &mut Self {
self._request_id = request_id;
self
}
/// Consumes the builder and constructs a [`HeadObjectOutput`](crate::operation::head_object::HeadObjectOutput).
pub fn build(self) -> crate::operation::head_object::HeadObjectOutput {
crate::operation::head_object::HeadObjectOutput {
delete_marker: self.delete_marker,
accept_ranges: self.accept_ranges,
expiration: self.expiration,
restore: self.restore,
archive_status: self.archive_status,
last_modified: self.last_modified,
content_length: self.content_length,
checksum_crc32: self.checksum_crc32,
checksum_crc32_c: self.checksum_crc32_c,
checksum_sha1: self.checksum_sha1,
checksum_sha256: self.checksum_sha256,
e_tag: self.e_tag,
missing_meta: self.missing_meta,
version_id: self.version_id,
cache_control: self.cache_control,
content_disposition: self.content_disposition,
content_encoding: self.content_encoding,
content_language: self.content_language,
content_type: self.content_type,
expires: self.expires,
website_redirect_location: self.website_redirect_location,
server_side_encryption: self.server_side_encryption,
metadata: self.metadata,
sse_customer_algorithm: self.sse_customer_algorithm,
sse_customer_key_md5: self.sse_customer_key_md5,
ssekms_key_id: self.ssekms_key_id,
bucket_key_enabled: self.bucket_key_enabled,
storage_class: self.storage_class,
request_charged: self.request_charged,
replication_status: self.replication_status,
parts_count: self.parts_count,
object_lock_mode: self.object_lock_mode,
object_lock_retain_until_date: self.object_lock_retain_until_date,
object_lock_legal_hold_status: self.object_lock_legal_hold_status,
_extended_request_id: self._extended_request_id,
_request_id: self._request_id,
}
}
}
impl ::std::fmt::Debug for HeadObjectOutputBuilder {
fn fmt(&self, f: &mut ::std::fmt::Formatter<'_>) -> ::std::fmt::Result {
let mut formatter = f.debug_struct("HeadObjectOutputBuilder");
formatter.field("delete_marker", &self.delete_marker);
formatter.field("accept_ranges", &self.accept_ranges);
formatter.field("expiration", &self.expiration);
formatter.field("restore", &self.restore);
formatter.field("archive_status", &self.archive_status);
formatter.field("last_modified", &self.last_modified);
formatter.field("content_length", &self.content_length);
formatter.field("checksum_crc32", &self.checksum_crc32);
formatter.field("checksum_crc32_c", &self.checksum_crc32_c);
formatter.field("checksum_sha1", &self.checksum_sha1);
formatter.field("checksum_sha256", &self.checksum_sha256);
formatter.field("e_tag", &self.e_tag);
formatter.field("missing_meta", &self.missing_meta);
formatter.field("version_id", &self.version_id);
formatter.field("cache_control", &self.cache_control);
formatter.field("content_disposition", &self.content_disposition);
formatter.field("content_encoding", &self.content_encoding);
formatter.field("content_language", &self.content_language);
formatter.field("content_type", &self.content_type);
formatter.field("expires", &self.expires);
formatter.field("website_redirect_location", &self.website_redirect_location);
formatter.field("server_side_encryption", &self.server_side_encryption);
formatter.field("metadata", &self.metadata);
formatter.field("sse_customer_algorithm", &self.sse_customer_algorithm);
formatter.field("sse_customer_key_md5", &self.sse_customer_key_md5);
formatter.field("ssekms_key_id", &"*** Sensitive Data Redacted ***");
formatter.field("bucket_key_enabled", &self.bucket_key_enabled);
formatter.field("storage_class", &self.storage_class);
formatter.field("request_charged", &self.request_charged);
formatter.field("replication_status", &self.replication_status);
formatter.field("parts_count", &self.parts_count);
formatter.field("object_lock_mode", &self.object_lock_mode);
formatter.field("object_lock_retain_until_date", &self.object_lock_retain_until_date);
formatter.field("object_lock_legal_hold_status", &self.object_lock_legal_hold_status);
formatter.field("_extended_request_id", &self._extended_request_id);
formatter.field("_request_id", &self._request_id);
formatter.finish()
}
}