@aws-sdk/client-s3 3.844.0 → 3.846.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (139) hide show
  1. package/README.md +40 -0
  2. package/dist-cjs/index.js +594 -121
  3. package/dist-es/S3.js +10 -0
  4. package/dist-es/commands/CreateBucketMetadataConfigurationCommand.js +31 -0
  5. package/dist-es/commands/DeleteBucketMetadataConfigurationCommand.js +26 -0
  6. package/dist-es/commands/GetBucketMetadataConfigurationCommand.js +28 -0
  7. package/dist-es/commands/ListPartsCommand.js +1 -1
  8. package/dist-es/commands/UpdateBucketMetadataInventoryTableConfigurationCommand.js +31 -0
  9. package/dist-es/commands/UpdateBucketMetadataJournalTableConfigurationCommand.js +31 -0
  10. package/dist-es/commands/index.js +5 -0
  11. package/dist-es/models/models_0.js +16 -24
  12. package/dist-es/models/models_1.js +24 -0
  13. package/dist-es/protocols/Aws_restXml.js +325 -3
  14. package/dist-types/S3.d.ts +35 -0
  15. package/dist-types/S3Client.d.ts +7 -2
  16. package/dist-types/commands/AbortMultipartUploadCommand.d.ts +17 -22
  17. package/dist-types/commands/CompleteMultipartUploadCommand.d.ts +46 -57
  18. package/dist-types/commands/CopyObjectCommand.d.ts +95 -106
  19. package/dist-types/commands/CreateBucketCommand.d.ts +70 -82
  20. package/dist-types/commands/CreateBucketMetadataConfigurationCommand.d.ts +182 -0
  21. package/dist-types/commands/CreateBucketMetadataTableConfigurationCommand.d.ts +25 -12
  22. package/dist-types/commands/CreateMultipartUploadCommand.d.ts +88 -113
  23. package/dist-types/commands/CreateSessionCommand.d.ts +45 -50
  24. package/dist-types/commands/DeleteBucketAnalyticsConfigurationCommand.d.ts +7 -9
  25. package/dist-types/commands/DeleteBucketCommand.d.ts +10 -12
  26. package/dist-types/commands/DeleteBucketCorsCommand.d.ts +4 -5
  27. package/dist-types/commands/DeleteBucketEncryptionCommand.d.ts +16 -18
  28. package/dist-types/commands/DeleteBucketInventoryConfigurationCommand.d.ts +4 -6
  29. package/dist-types/commands/DeleteBucketLifecycleCommand.d.ts +23 -28
  30. package/dist-types/commands/DeleteBucketMetadataConfigurationCommand.d.ts +114 -0
  31. package/dist-types/commands/DeleteBucketMetadataTableConfigurationCommand.d.ts +26 -8
  32. package/dist-types/commands/DeleteBucketMetricsConfigurationCommand.d.ts +9 -12
  33. package/dist-types/commands/DeleteBucketOwnershipControlsCommand.d.ts +5 -6
  34. package/dist-types/commands/DeleteBucketPolicyCommand.d.ts +20 -23
  35. package/dist-types/commands/DeleteBucketReplicationCommand.d.ts +5 -7
  36. package/dist-types/commands/DeleteBucketTaggingCommand.d.ts +2 -3
  37. package/dist-types/commands/DeleteBucketWebsiteCommand.d.ts +9 -10
  38. package/dist-types/commands/DeleteObjectCommand.d.ts +37 -23
  39. package/dist-types/commands/DeleteObjectTaggingCommand.d.ts +7 -7
  40. package/dist-types/commands/DeleteObjectsCommand.d.ts +37 -44
  41. package/dist-types/commands/DeletePublicAccessBlockCommand.d.ts +6 -6
  42. package/dist-types/commands/GetBucketAccelerateConfigurationCommand.d.ts +14 -17
  43. package/dist-types/commands/GetBucketAclCommand.d.ts +9 -11
  44. package/dist-types/commands/GetBucketAnalyticsConfigurationCommand.d.ts +8 -11
  45. package/dist-types/commands/GetBucketCorsCommand.d.ts +4 -6
  46. package/dist-types/commands/GetBucketEncryptionCommand.d.ts +16 -19
  47. package/dist-types/commands/GetBucketInventoryConfigurationCommand.d.ts +6 -8
  48. package/dist-types/commands/GetBucketLifecycleConfigurationCommand.d.ts +28 -37
  49. package/dist-types/commands/GetBucketLocationCommand.d.ts +4 -5
  50. package/dist-types/commands/GetBucketLoggingCommand.d.ts +2 -2
  51. package/dist-types/commands/GetBucketMetadataConfigurationCommand.d.ts +146 -0
  52. package/dist-types/commands/GetBucketMetadataTableConfigurationCommand.d.ts +25 -8
  53. package/dist-types/commands/GetBucketMetricsConfigurationCommand.d.ts +10 -11
  54. package/dist-types/commands/GetBucketNotificationConfigurationCommand.d.ts +7 -8
  55. package/dist-types/commands/GetBucketOwnershipControlsCommand.d.ts +9 -8
  56. package/dist-types/commands/GetBucketPolicyCommand.d.ts +24 -29
  57. package/dist-types/commands/GetBucketPolicyStatusCommand.d.ts +5 -6
  58. package/dist-types/commands/GetBucketReplicationCommand.d.ts +11 -12
  59. package/dist-types/commands/GetBucketRequestPaymentCommand.d.ts +2 -3
  60. package/dist-types/commands/GetBucketTaggingCommand.d.ts +2 -3
  61. package/dist-types/commands/GetBucketVersioningCommand.d.ts +3 -3
  62. package/dist-types/commands/GetBucketWebsiteCommand.d.ts +6 -7
  63. package/dist-types/commands/GetObjectAclCommand.d.ts +9 -11
  64. package/dist-types/commands/GetObjectAttributesCommand.d.ts +55 -70
  65. package/dist-types/commands/GetObjectCommand.d.ts +66 -81
  66. package/dist-types/commands/GetObjectLegalHoldCommand.d.ts +1 -2
  67. package/dist-types/commands/GetObjectLockConfigurationCommand.d.ts +3 -3
  68. package/dist-types/commands/GetObjectRetentionCommand.d.ts +1 -2
  69. package/dist-types/commands/GetObjectTaggingCommand.d.ts +8 -10
  70. package/dist-types/commands/GetObjectTorrentCommand.d.ts +4 -5
  71. package/dist-types/commands/GetPublicAccessBlockCommand.d.ts +10 -12
  72. package/dist-types/commands/HeadBucketCommand.d.ts +33 -35
  73. package/dist-types/commands/HeadObjectCommand.d.ts +50 -62
  74. package/dist-types/commands/ListBucketAnalyticsConfigurationsCommand.d.ts +14 -17
  75. package/dist-types/commands/ListBucketInventoryConfigurationsCommand.d.ts +12 -15
  76. package/dist-types/commands/ListBucketMetricsConfigurationsCommand.d.ts +15 -18
  77. package/dist-types/commands/ListBucketsCommand.d.ts +10 -9
  78. package/dist-types/commands/ListDirectoryBucketsCommand.d.ts +9 -9
  79. package/dist-types/commands/ListMultipartUploadsCommand.d.ts +41 -49
  80. package/dist-types/commands/ListObjectVersionsCommand.d.ts +7 -9
  81. package/dist-types/commands/ListObjectsCommand.d.ts +8 -7
  82. package/dist-types/commands/ListObjectsV2Command.d.ts +28 -31
  83. package/dist-types/commands/ListPartsCommand.d.ts +21 -24
  84. package/dist-types/commands/PutBucketAccelerateConfigurationCommand.d.ts +14 -18
  85. package/dist-types/commands/PutBucketAclCommand.d.ts +51 -62
  86. package/dist-types/commands/PutBucketAnalyticsConfigurationCommand.d.ts +23 -25
  87. package/dist-types/commands/PutBucketCorsCommand.d.ts +23 -27
  88. package/dist-types/commands/PutBucketEncryptionCommand.d.ts +40 -48
  89. package/dist-types/commands/PutBucketIntelligentTieringConfigurationCommand.d.ts +11 -12
  90. package/dist-types/commands/PutBucketInventoryConfigurationCommand.d.ts +33 -37
  91. package/dist-types/commands/PutBucketLifecycleConfigurationCommand.d.ts +51 -60
  92. package/dist-types/commands/PutBucketLoggingCommand.d.ts +26 -33
  93. package/dist-types/commands/PutBucketMetricsConfigurationCommand.d.ts +12 -14
  94. package/dist-types/commands/PutBucketNotificationConfigurationCommand.d.ts +29 -35
  95. package/dist-types/commands/PutBucketOwnershipControlsCommand.d.ts +4 -6
  96. package/dist-types/commands/PutBucketPolicyCommand.d.ts +24 -29
  97. package/dist-types/commands/PutBucketReplicationCommand.d.ts +31 -38
  98. package/dist-types/commands/PutBucketRequestPaymentCommand.d.ts +4 -5
  99. package/dist-types/commands/PutBucketTaggingCommand.d.ts +21 -27
  100. package/dist-types/commands/PutBucketVersioningCommand.d.ts +20 -23
  101. package/dist-types/commands/PutBucketWebsiteCommand.d.ts +19 -18
  102. package/dist-types/commands/PutObjectAclCommand.d.ts +53 -61
  103. package/dist-types/commands/PutObjectCommand.d.ts +56 -66
  104. package/dist-types/commands/PutObjectLegalHoldCommand.d.ts +1 -3
  105. package/dist-types/commands/PutObjectLockConfigurationCommand.d.ts +10 -11
  106. package/dist-types/commands/PutObjectRetentionCommand.d.ts +4 -4
  107. package/dist-types/commands/PutObjectTaggingCommand.d.ts +18 -24
  108. package/dist-types/commands/PutPublicAccessBlockCommand.d.ts +10 -12
  109. package/dist-types/commands/RenameObjectCommand.d.ts +34 -40
  110. package/dist-types/commands/RestoreObjectCommand.d.ts +76 -85
  111. package/dist-types/commands/SelectObjectContentCommand.d.ts +50 -59
  112. package/dist-types/commands/UpdateBucketMetadataInventoryTableConfigurationCommand.d.ts +161 -0
  113. package/dist-types/commands/UpdateBucketMetadataJournalTableConfigurationCommand.d.ts +113 -0
  114. package/dist-types/commands/UploadPartCommand.d.ts +64 -74
  115. package/dist-types/commands/UploadPartCopyCommand.d.ts +80 -96
  116. package/dist-types/commands/WriteGetObjectResponseCommand.d.ts +29 -33
  117. package/dist-types/commands/index.d.ts +5 -0
  118. package/dist-types/models/models_0.d.ts +2688 -3603
  119. package/dist-types/models/models_1.d.ts +2120 -743
  120. package/dist-types/protocols/Aws_restXml.d.ts +45 -0
  121. package/dist-types/ts3.4/S3.d.ts +109 -0
  122. package/dist-types/ts3.4/S3Client.d.ts +30 -0
  123. package/dist-types/ts3.4/commands/CreateBucketMetadataConfigurationCommand.d.ts +47 -0
  124. package/dist-types/ts3.4/commands/DeleteBucketMetadataConfigurationCommand.d.ts +47 -0
  125. package/dist-types/ts3.4/commands/GetBucketMetadataConfigurationCommand.d.ts +51 -0
  126. package/dist-types/ts3.4/commands/ListObjectVersionsCommand.d.ts +1 -1
  127. package/dist-types/ts3.4/commands/ListObjectsCommand.d.ts +1 -1
  128. package/dist-types/ts3.4/commands/ListObjectsV2Command.d.ts +1 -1
  129. package/dist-types/ts3.4/commands/ListPartsCommand.d.ts +1 -1
  130. package/dist-types/ts3.4/commands/PutBucketAccelerateConfigurationCommand.d.ts +1 -1
  131. package/dist-types/ts3.4/commands/PutBucketAclCommand.d.ts +1 -1
  132. package/dist-types/ts3.4/commands/PutBucketAnalyticsConfigurationCommand.d.ts +1 -1
  133. package/dist-types/ts3.4/commands/UpdateBucketMetadataInventoryTableConfigurationCommand.d.ts +47 -0
  134. package/dist-types/ts3.4/commands/UpdateBucketMetadataJournalTableConfigurationCommand.d.ts +47 -0
  135. package/dist-types/ts3.4/commands/index.d.ts +5 -0
  136. package/dist-types/ts3.4/models/models_0.d.ts +93 -206
  137. package/dist-types/ts3.4/models/models_1.d.ts +238 -0
  138. package/dist-types/ts3.4/protocols/Aws_restXml.d.ts +60 -0
  139. package/package.json +15 -15
@@ -27,53 +27,47 @@ declare const RenameObjectCommand_base: {
27
27
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
28
  };
29
29
  /**
30
- * <p>Renames an existing object in a directory bucket that uses the S3 Express One Zone
31
- * storage class. You can use <code>RenameObject</code> by specifying an existing object’s
32
- * name as the source and the new name of the object as the destination within the same
33
- * directory bucket.</p>
30
+ * <p>Renames an existing object in a directory bucket that uses the S3 Express One Zone storage class.
31
+ * You can use <code>RenameObject</code> by specifying an existing object’s name as the source and the new
32
+ * name of the object as the destination within the same directory bucket.</p>
34
33
  * <note>
35
34
  * <p>
36
- * <code>RenameObject</code> is only supported for objects stored in the S3 Express One Zone
37
- * storage class.</p>
35
+ * <code>RenameObject</code> is only supported for objects stored in the S3 Express One Zone storage
36
+ * class.</p>
38
37
  * </note>
39
- * <p> To prevent overwriting an object, you can use the <code>If-None-Match</code> conditional header.</p>
38
+ * <p> To prevent overwriting an object, you can use the <code>If-None-Match</code> conditional
39
+ * header.</p>
40
40
  * <ul>
41
41
  * <li>
42
42
  * <p>
43
- * <b>If-None-Match</b> - Renames the object only if
44
- * an object with the specified name does not already exist in the directory bucket. If
45
- * you don't want to overwrite an existing object, you can add the
46
- * <code>If-None-Match</code> conditional header with the value <code>‘*’</code> in
47
- * the <code>RenameObject</code> request. Amazon S3 then returns a <code>412 Precondition
48
- * Failed</code> error if the object with the specified name already exists.
49
- * For more information, see <a href="https://datatracker.ietf.org/doc/rfc7232/">RFC 7232</a>.</p>
43
+ * <b>If-None-Match</b> - Renames the object only if an object
44
+ * with the specified name does not already exist in the directory bucket. If you don't want to
45
+ * overwrite an existing object, you can add the <code>If-None-Match</code> conditional header with the
46
+ * value <code>‘*’</code> in the <code>RenameObject</code> request. Amazon S3 then returns a <code>412
47
+ * Precondition Failed</code> error if the object with the specified name already exists. For more
48
+ * information, see <a href="https://datatracker.ietf.org/doc/rfc7232/">RFC 7232</a>.</p>
50
49
  * </li>
51
50
  * </ul>
52
51
  * <dl>
53
52
  * <dt>Permissions</dt>
54
53
  * <dd>
55
- * <p> To grant access to the <code>RenameObject</code> operation on a directory
56
- * bucket, we recommend that you use the <code>CreateSession</code> operation for
57
- * session-based authorization. Specifically, you grant the
58
- * <code>s3express:CreateSession</code> permission to the directory bucket in a
59
- * bucket policy or an IAM identity-based policy. Then, you make the
60
- * <code>CreateSession</code> API call on the directory bucket to obtain a session
61
- * token. With the session token in your request header, you can make API requests to
62
- * this operation. After the session token expires, you make another
63
- * <code>CreateSession</code> API call to generate a new session token for use.
64
- * The Amazon Web Services CLI and SDKs will create and manage your session including refreshing
65
- * the session token automatically to avoid service interruptions when a session
66
- * expires. In your bucket policy, you can specify the
67
- * <code>s3express:SessionMode</code> condition key to control who can create a
68
- * <code>ReadWrite</code> or <code>ReadOnly</code> session. A
69
- * <code>ReadWrite</code> session is required for executing all the Zonal endpoint
70
- * API operations, including <code>RenameObject</code>. For more information about
71
- * authorization, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateSession.html">
54
+ * <p> To grant access to the <code>RenameObject</code> operation on a directory bucket, we
55
+ * recommend that you use the <code>CreateSession</code> operation for session-based authorization.
56
+ * Specifically, you grant the <code>s3express:CreateSession</code> permission to the directory
57
+ * bucket in a bucket policy or an IAM identity-based policy. Then, you make the
58
+ * <code>CreateSession</code> API call on the directory bucket to obtain a session token. With the
59
+ * session token in your request header, you can make API requests to this operation. After the
60
+ * session token expires, you make another <code>CreateSession</code> API call to generate a new
61
+ * session token for use. The Amazon Web Services CLI and SDKs will create and manage your session including
62
+ * refreshing the session token automatically to avoid service interruptions when a session expires.
63
+ * In your bucket policy, you can specify the <code>s3express:SessionMode</code> condition key to
64
+ * control who can create a <code>ReadWrite</code> or <code>ReadOnly</code> session. A
65
+ * <code>ReadWrite</code> session is required for executing all the Zonal endpoint API operations,
66
+ * including <code>RenameObject</code>. For more information about authorization, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateSession.html">
72
67
  * <code>CreateSession</code>
73
- * </a>. To learn more about Zonal endpoint API
74
- * operations, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-express-create-session.html">Authorizing
75
- * Zonal endpoint API operations with CreateSession</a> in the <i>Amazon S3
76
- * User Guide</i>. </p>
68
+ * </a>. To learn more about Zonal endpoint API operations, see
69
+ * <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-express-create-session.html">Authorizing Zonal endpoint API operations with CreateSession</a> in the <i>Amazon S3 User
70
+ * Guide</i>. </p>
77
71
  * </dd>
78
72
  * <dt>HTTP Host header syntax</dt>
79
73
  * <dd>
@@ -115,12 +109,12 @@ declare const RenameObjectCommand_base: {
115
109
  * @see {@link S3ClientResolvedConfig | config} for S3Client's `config` shape.
116
110
  *
117
111
  * @throws {@link IdempotencyParameterMismatch} (client fault)
118
- * <p>Parameters on this idempotent request are inconsistent with parameters used in previous request(s).
119
- * </p>
120
- * <p>For a list of error codes and more information on Amazon S3 errors, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/ErrorResponses.html#ErrorCodeList">Error
121
- * codes</a>.</p>
112
+ * <p>Parameters on this idempotent request are inconsistent with parameters used in previous request(s). </p>
113
+ * <p>For a list of error codes and more information on Amazon S3 errors, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/ErrorResponses.html#ErrorCodeList">Error codes</a>.</p>
122
114
  * <note>
123
- * <p>Idempotency ensures that an API request completes no more than one time. With an idempotent request, if the original request completes successfully, any subsequent retries complete successfully without performing any further actions.</p>
115
+ * <p>Idempotency ensures that an API request completes no more than one time. With an idempotent
116
+ * request, if the original request completes successfully, any subsequent retries complete successfully
117
+ * without performing any further actions.</p>
124
118
  * </note>
125
119
  *
126
120
  * @throws {@link S3ServiceException}
@@ -40,7 +40,7 @@ declare const RestoreObjectCommand_base: {
40
40
  * </li>
41
41
  * </ul>
42
42
  * <p>For more information about the <code>S3</code> structure in the request body, see the
43
- * following:</p>
43
+ * following:</p>
44
44
  * <ul>
45
45
  * <li>
46
46
  * <p>
@@ -49,117 +49,108 @@ declare const RestoreObjectCommand_base: {
49
49
  * </li>
50
50
  * <li>
51
51
  * <p>
52
- * <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/S3_ACLs_UsingACLs.html">Managing Access with ACLs</a> in the
53
- * <i>Amazon S3 User Guide</i>
52
+ * <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/S3_ACLs_UsingACLs.html">Managing Access
53
+ * with ACLs</a> in the <i>Amazon S3 User Guide</i>
54
54
  * </p>
55
55
  * </li>
56
56
  * <li>
57
57
  * <p>
58
- * <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/serv-side-encryption.html">Protecting Data Using Server-Side Encryption</a> in the
59
- * <i>Amazon S3 User Guide</i>
58
+ * <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/serv-side-encryption.html">Protecting Data
59
+ * Using Server-Side Encryption</a> in the <i>Amazon S3 User Guide</i>
60
60
  * </p>
61
61
  * </li>
62
62
  * </ul>
63
63
  * <dl>
64
64
  * <dt>Permissions</dt>
65
65
  * <dd>
66
- * <p>To use this operation, you must have permissions to perform the
67
- * <code>s3:RestoreObject</code> action. The bucket owner has this permission by
68
- * default and can grant this permission to others. For more information about
69
- * permissions, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources">Permissions Related to Bucket Subresource Operations</a> and <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html">Managing Access Permissions to Your Amazon S3 Resources</a> in the
70
- * <i>Amazon S3 User Guide</i>.</p>
66
+ * <p>To use this operation, you must have permissions to perform the <code>s3:RestoreObject</code>
67
+ * action. The bucket owner has this permission by default and can grant this permission to others.
68
+ * For more information about permissions, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources">Permissions Related to Bucket Subresource Operations</a> and <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html">Managing Access Permissions to Your Amazon S3
69
+ * Resources</a> in the <i>Amazon S3 User Guide</i>.</p>
71
70
  * </dd>
72
71
  * <dt>Restoring objects</dt>
73
72
  * <dd>
74
- * <p>Objects that you archive to the S3 Glacier Flexible Retrieval or S3 Glacier Deep Archive storage class, and S3 Intelligent-Tiering Archive or
75
- * S3 Intelligent-Tiering Deep Archive tiers, are not accessible in real time. For objects in the
76
- * S3 Glacier Flexible Retrieval or S3 Glacier Deep Archive
77
- * storage classes, you must first initiate a restore request, and then wait until a
78
- * temporary copy of the object is available. If you want a permanent copy of the
79
- * object, create a copy of it in the Amazon S3 Standard storage class in your S3 bucket.
80
- * To access an archived object, you must restore the object for the duration (number
81
- * of days) that you specify. For objects in the Archive Access or Deep Archive
82
- * Access tiers of S3 Intelligent-Tiering, you must first initiate a restore request,
83
- * and then wait until the object is moved into the Frequent Access tier.</p>
84
- * <p>To restore a specific object version, you can provide a version ID. If you
85
- * don't provide a version ID, Amazon S3 restores the current version.</p>
86
- * <p>When restoring an archived object, you can specify one of the following data
87
- * access tier options in the <code>Tier</code> element of the request body: </p>
73
+ * <p>Objects that you archive to the S3 Glacier Flexible Retrieval or S3 Glacier Deep Archive
74
+ * storage class, and S3 Intelligent-Tiering Archive or S3 Intelligent-Tiering Deep Archive tiers, are not accessible in
75
+ * real time. For objects in the S3 Glacier Flexible Retrieval or S3 Glacier Deep Archive
76
+ * storage classes, you must first initiate a restore request, and then wait until a temporary copy
77
+ * of the object is available. If you want a permanent copy of the object, create a copy of it in the
78
+ * Amazon S3 Standard storage class in your S3 bucket. To access an archived object, you must restore the
79
+ * object for the duration (number of days) that you specify. For objects in the Archive Access or
80
+ * Deep Archive Access tiers of S3 Intelligent-Tiering, you must first initiate a restore request, and
81
+ * then wait until the object is moved into the Frequent Access tier.</p>
82
+ * <p>To restore a specific object version, you can provide a version ID. If you don't provide a
83
+ * version ID, Amazon S3 restores the current version.</p>
84
+ * <p>When restoring an archived object, you can specify one of the following data access tier
85
+ * options in the <code>Tier</code> element of the request body: </p>
88
86
  * <ul>
89
87
  * <li>
90
88
  * <p>
91
- * <code>Expedited</code> - Expedited retrievals allow you to quickly access
92
- * your data stored in the S3 Glacier Flexible Retrieval storage class or S3 Intelligent-Tiering Archive tier when occasional urgent requests
93
- * for restoring archives are required. For all but the largest archived
94
- * objects (250 MB+), data accessed using Expedited retrievals is typically
95
- * made available within 1–5 minutes. Provisioned capacity ensures that
96
- * retrieval capacity for Expedited retrievals is available when you need it.
97
- * Expedited retrievals and provisioned capacity are not available for objects
98
- * stored in the S3 Glacier Deep Archive storage class or
99
- * S3 Intelligent-Tiering Deep Archive tier.</p>
89
+ * <code>Expedited</code> - Expedited retrievals allow you to quickly access your data stored
90
+ * in the S3 Glacier Flexible Retrieval storage class or S3 Intelligent-Tiering Archive tier when occasional
91
+ * urgent requests for restoring archives are required. For all but the largest archived objects
92
+ * (250 MB+), data accessed using Expedited retrievals is typically made available within 1–5
93
+ * minutes. Provisioned capacity ensures that retrieval capacity for Expedited retrievals is
94
+ * available when you need it. Expedited retrievals and provisioned capacity are not available
95
+ * for objects stored in the S3 Glacier Deep Archive storage class or
96
+ * S3 Intelligent-Tiering Deep Archive tier.</p>
100
97
  * </li>
101
98
  * <li>
102
99
  * <p>
103
- * <code>Standard</code> - Standard retrievals allow you to access any of
104
- * your archived objects within several hours. This is the default option for
105
- * retrieval requests that do not specify the retrieval option. Standard
106
- * retrievals typically finish within 3–5 hours for objects stored in the
107
- * S3 Glacier Flexible Retrieval storage class or
108
- * S3 Intelligent-Tiering Archive tier. They typically finish within 12 hours for
109
- * objects stored in the S3 Glacier Deep Archive storage class or
110
- * S3 Intelligent-Tiering Deep Archive tier. Standard retrievals are free for objects stored
111
- * in S3 Intelligent-Tiering.</p>
100
+ * <code>Standard</code> - Standard retrievals allow you to access any of your archived
101
+ * objects within several hours. This is the default option for retrieval requests that do not
102
+ * specify the retrieval option. Standard retrievals typically finish within 3–5 hours for
103
+ * objects stored in the S3 Glacier Flexible Retrieval storage class or S3 Intelligent-Tiering Archive tier.
104
+ * They typically finish within 12 hours for objects stored in the
105
+ * S3 Glacier Deep Archive storage class or S3 Intelligent-Tiering Deep Archive tier. Standard
106
+ * retrievals are free for objects stored in S3 Intelligent-Tiering.</p>
112
107
  * </li>
113
108
  * <li>
114
109
  * <p>
115
- * <code>Bulk</code> - Bulk retrievals free for objects stored in the
116
- * S3 Glacier Flexible Retrieval and S3 Intelligent-Tiering storage classes,
117
- * enabling you to retrieve large amounts, even petabytes, of data at no cost.
118
- * Bulk retrievals typically finish within 5–12 hours for objects stored in the
119
- * S3 Glacier Flexible Retrieval storage class or
120
- * S3 Intelligent-Tiering Archive tier. Bulk retrievals are also the lowest-cost
121
- * retrieval option when restoring objects from
122
- * S3 Glacier Deep Archive. They typically finish within 48 hours for
123
- * objects stored in the S3 Glacier Deep Archive storage class or
124
- * S3 Intelligent-Tiering Deep Archive tier. </p>
110
+ * <code>Bulk</code> - Bulk retrievals free for objects stored in the S3 Glacier Flexible
111
+ * Retrieval and S3 Intelligent-Tiering storage classes, enabling you to retrieve large amounts,
112
+ * even petabytes, of data at no cost. Bulk retrievals typically finish within 5–12 hours for
113
+ * objects stored in the S3 Glacier Flexible Retrieval storage class or S3 Intelligent-Tiering Archive tier.
114
+ * Bulk retrievals are also the lowest-cost retrieval option when restoring objects from
115
+ * S3 Glacier Deep Archive. They typically finish within 48 hours for objects stored in
116
+ * the S3 Glacier Deep Archive storage class or S3 Intelligent-Tiering Deep Archive tier. </p>
125
117
  * </li>
126
118
  * </ul>
127
- * <p>For more information about archive retrieval options and provisioned capacity
128
- * for <code>Expedited</code> data access, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/restoring-objects.html">Restoring Archived
129
- * Objects</a> in the <i>Amazon S3 User Guide</i>. </p>
130
- * <p>You can use Amazon S3 restore speed upgrade to change the restore speed to a faster
131
- * speed while it is in progress. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/restoring-objects.html#restoring-objects-upgrade-tier.title.html"> Upgrading the speed of an in-progress restore</a> in the
132
- * <i>Amazon S3 User Guide</i>. </p>
133
- * <p>To get the status of object restoration, you can send a <code>HEAD</code>
134
- * request. Operations return the <code>x-amz-restore</code> header, which provides
135
- * information about the restoration status, in the response. You can use Amazon S3 event
136
- * notifications to notify you when a restore is initiated or completed. For more
137
- * information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/NotificationHowTo.html">Configuring Amazon S3 Event
138
- * Notifications</a> in the <i>Amazon S3 User Guide</i>.</p>
139
- * <p>After restoring an archived object, you can update the restoration period by
140
- * reissuing the request with a new period. Amazon S3 updates the restoration period
141
- * relative to the current time and charges only for the request-there are no
142
- * data transfer charges. You cannot update the restoration period when Amazon S3 is
143
- * actively processing your current restore request for the object.</p>
144
- * <p>If your bucket has a lifecycle configuration with a rule that includes an
145
- * expiration action, the object expiration overrides the life span that you specify
146
- * in a restore request. For example, if you restore an object copy for 10 days, but
147
- * the object is scheduled to expire in 3 days, Amazon S3 deletes the object in 3 days.
148
- * For more information about lifecycle configuration, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketLifecycleConfiguration.html">PutBucketLifecycleConfiguration</a> and <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/object-lifecycle-mgmt.html">Object Lifecycle
149
- * Management</a> in <i>Amazon S3 User Guide</i>.</p>
119
+ * <p>For more information about archive retrieval options and provisioned capacity for
120
+ * <code>Expedited</code> data access, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/restoring-objects.html">Restoring Archived Objects</a> in the
121
+ * <i>Amazon S3 User Guide</i>. </p>
122
+ * <p>You can use Amazon S3 restore speed upgrade to change the restore speed to a faster speed while it
123
+ * is in progress. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/restoring-objects.html#restoring-objects-upgrade-tier.title.html">
124
+ * Upgrading the speed of an in-progress restore</a> in the
125
+ * <i>Amazon S3 User Guide</i>. </p>
126
+ * <p>To get the status of object restoration, you can send a <code>HEAD</code> request. Operations
127
+ * return the <code>x-amz-restore</code> header, which provides information about the restoration
128
+ * status, in the response. You can use Amazon S3 event notifications to notify you when a restore is
129
+ * initiated or completed. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/NotificationHowTo.html">Configuring Amazon S3 Event Notifications</a> in
130
+ * the <i>Amazon S3 User Guide</i>.</p>
131
+ * <p>After restoring an archived object, you can update the restoration period by reissuing the
132
+ * request with a new period. Amazon S3 updates the restoration period relative to the current time and
133
+ * charges only for the request-there are no data transfer charges. You cannot update the
134
+ * restoration period when Amazon S3 is actively processing your current restore request for the
135
+ * object.</p>
136
+ * <p>If your bucket has a lifecycle configuration with a rule that includes an expiration action,
137
+ * the object expiration overrides the life span that you specify in a restore request. For example,
138
+ * if you restore an object copy for 10 days, but the object is scheduled to expire in 3 days, Amazon S3
139
+ * deletes the object in 3 days. For more information about lifecycle configuration, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketLifecycleConfiguration.html">PutBucketLifecycleConfiguration</a> and <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/object-lifecycle-mgmt.html">Object Lifecycle Management</a> in
140
+ * <i>Amazon S3 User Guide</i>.</p>
150
141
  * </dd>
151
142
  * <dt>Responses</dt>
152
143
  * <dd>
153
- * <p>A successful action returns either the <code>200 OK</code> or <code>202
154
- * Accepted</code> status code. </p>
144
+ * <p>A successful action returns either the <code>200 OK</code> or <code>202 Accepted</code> status
145
+ * code. </p>
155
146
  * <ul>
156
147
  * <li>
157
- * <p>If the object is not previously restored, then Amazon S3 returns <code>202
158
- * Accepted</code> in the response. </p>
148
+ * <p>If the object is not previously restored, then Amazon S3 returns <code>202 Accepted</code> in
149
+ * the response. </p>
159
150
  * </li>
160
151
  * <li>
161
- * <p>If the object is previously restored, Amazon S3 returns <code>200 OK</code> in
162
- * the response. </p>
152
+ * <p>If the object is previously restored, Amazon S3 returns <code>200 OK</code> in the response.
153
+ * </p>
163
154
  * </li>
164
155
  * </ul>
165
156
  * <ul>
@@ -197,10 +188,10 @@ declare const RestoreObjectCommand_base: {
197
188
  * </li>
198
189
  * <li>
199
190
  * <p>
200
- * <i>Cause: expedited retrievals are currently not available.
201
- * Try again later. (Returned if there is insufficient capacity to
202
- * process the Expedited request. This error applies only to Expedited
203
- * retrievals and not to S3 Standard or Bulk retrievals.)</i>
191
+ * <i>Cause: expedited retrievals are currently not available. Try again later.
192
+ * (Returned if there is insufficient capacity to process the Expedited request. This error
193
+ * applies only to Expedited retrievals and not to S3 Standard or Bulk
194
+ * retrievals.)</i>
204
195
  * </p>
205
196
  * </li>
206
197
  * <li>
@@ -30,104 +30,95 @@ declare const SelectObjectContentCommand_base: {
30
30
  * <note>
31
31
  * <p>This operation is not supported for directory buckets.</p>
32
32
  * </note>
33
- * <p>This action filters the contents of an Amazon S3 object based on a simple structured query
34
- * language (SQL) statement. In the request, along with the SQL expression, you must also
35
- * specify a data serialization format (JSON, CSV, or Apache Parquet) of the object. Amazon S3 uses
36
- * this format to parse object data into records, and returns only records that match the
37
- * specified SQL expression. You must also specify the data serialization format for the
38
- * response.</p>
33
+ * <p>This action filters the contents of an Amazon S3 object based on a simple structured query language (SQL)
34
+ * statement. In the request, along with the SQL expression, you must also specify a data serialization
35
+ * format (JSON, CSV, or Apache Parquet) of the object. Amazon S3 uses this format to parse object data into
36
+ * records, and returns only records that match the specified SQL expression. You must also specify the
37
+ * data serialization format for the response.</p>
39
38
  * <p>This functionality is not supported for Amazon S3 on Outposts.</p>
40
- * <p>For more information about Amazon S3 Select, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/selecting-content-from-objects.html">Selecting Content from
41
- * Objects</a> and <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-glacier-select-sql-reference-select.html">SELECT
42
- * Command</a> in the <i>Amazon S3 User Guide</i>.</p>
39
+ * <p>For more information about Amazon S3 Select, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/selecting-content-from-objects.html">Selecting Content from Objects</a>
40
+ * and <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-glacier-select-sql-reference-select.html">SELECT Command</a> in
41
+ * the <i>Amazon S3 User Guide</i>.</p>
43
42
  * <p></p>
44
43
  * <dl>
45
44
  * <dt>Permissions</dt>
46
45
  * <dd>
47
- * <p>You must have the <code>s3:GetObject</code> permission for this operation. Amazon S3
48
- * Select does not support anonymous access. For more information about permissions,
49
- * see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/using-with-s3-actions.html">Specifying Permissions in
50
- * a Policy</a> in the <i>Amazon S3 User Guide</i>.</p>
46
+ * <p>You must have the <code>s3:GetObject</code> permission for this operation. Amazon S3 Select does
47
+ * not support anonymous access. For more information about permissions, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/using-with-s3-actions.html">Specifying Permissions
48
+ * in a Policy</a> in the <i>Amazon S3 User Guide</i>.</p>
51
49
  * </dd>
52
50
  * <dt>Object Data Formats</dt>
53
51
  * <dd>
54
- * <p>You can use Amazon S3 Select to query objects that have the following format
55
- * properties:</p>
52
+ * <p>You can use Amazon S3 Select to query objects that have the following format properties:</p>
56
53
  * <ul>
57
54
  * <li>
58
55
  * <p>
59
- * <i>CSV, JSON, and Parquet</i> - Objects must be in CSV,
60
- * JSON, or Parquet format.</p>
56
+ * <i>CSV, JSON, and Parquet</i> - Objects must be in CSV, JSON, or Parquet
57
+ * format.</p>
61
58
  * </li>
62
59
  * <li>
63
60
  * <p>
64
- * <i>UTF-8</i> - UTF-8 is the only encoding type Amazon S3 Select
65
- * supports.</p>
61
+ * <i>UTF-8</i> - UTF-8 is the only encoding type Amazon S3 Select supports.</p>
66
62
  * </li>
67
63
  * <li>
68
64
  * <p>
69
- * <i>GZIP or BZIP2</i> - CSV and JSON files can be compressed
70
- * using GZIP or BZIP2. GZIP and BZIP2 are the only compression formats that
71
- * Amazon S3 Select supports for CSV and JSON files. Amazon S3 Select supports columnar
72
- * compression for Parquet using GZIP or Snappy. Amazon S3 Select does not support
73
- * whole-object compression for Parquet objects.</p>
65
+ * <i>GZIP or BZIP2</i> - CSV and JSON files can be compressed using GZIP or
66
+ * BZIP2. GZIP and BZIP2 are the only compression formats that Amazon S3 Select supports for CSV and
67
+ * JSON files. Amazon S3 Select supports columnar compression for Parquet using GZIP or Snappy. Amazon S3
68
+ * Select does not support whole-object compression for Parquet objects.</p>
74
69
  * </li>
75
70
  * <li>
76
71
  * <p>
77
- * <i>Server-side encryption</i> - Amazon S3 Select supports
78
- * querying objects that are protected with server-side encryption.</p>
79
- * <p>For objects that are encrypted with customer-provided encryption keys
80
- * (SSE-C), you must use HTTPS, and you must use the headers that are
81
- * documented in the <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObject.html">GetObject</a>. For more
82
- * information about SSE-C, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/ServerSideEncryptionCustomerKeys.html">Server-Side Encryption (Using Customer-Provided Encryption Keys)</a>
83
- * in the <i>Amazon S3 User Guide</i>.</p>
84
- * <p>For objects that are encrypted with Amazon S3 managed keys (SSE-S3) and
85
- * Amazon Web Services KMS keys (SSE-KMS), server-side encryption is handled transparently,
86
- * so you don't need to specify anything. For more information about
87
- * server-side encryption, including SSE-S3 and SSE-KMS, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/serv-side-encryption.html">Protecting Data Using Server-Side Encryption</a> in the
88
- * <i>Amazon S3 User Guide</i>.</p>
72
+ * <i>Server-side encryption</i> - Amazon S3 Select supports querying objects that
73
+ * are protected with server-side encryption.</p>
74
+ * <p>For objects that are encrypted with customer-provided encryption keys (SSE-C), you must
75
+ * use HTTPS, and you must use the headers that are documented in the <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObject.html">GetObject</a>. For more information about
76
+ * SSE-C, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/ServerSideEncryptionCustomerKeys.html">Server-Side Encryption
77
+ * (Using Customer-Provided Encryption Keys)</a> in the
78
+ * <i>Amazon S3 User Guide</i>.</p>
79
+ * <p>For objects that are encrypted with Amazon S3 managed keys (SSE-S3) and Amazon Web Services KMS keys
80
+ * (SSE-KMS), server-side encryption is handled transparently, so you don't need to specify
81
+ * anything. For more information about server-side encryption, including SSE-S3 and SSE-KMS, see
82
+ * <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/serv-side-encryption.html">Protecting
83
+ * Data Using Server-Side Encryption</a> in the
84
+ * <i>Amazon S3 User Guide</i>.</p>
89
85
  * </li>
90
86
  * </ul>
91
87
  * </dd>
92
88
  * <dt>Working with the Response Body</dt>
93
89
  * <dd>
94
- * <p>Given the response size is unknown, Amazon S3 Select streams the response as a
95
- * series of messages and includes a <code>Transfer-Encoding</code> header with
96
- * <code>chunked</code> as its value in the response. For more information, see
97
- * <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/RESTSelectObjectAppendix.html">Appendix:
98
- * SelectObjectContent
99
- * Response</a>.</p>
90
+ * <p>Given the response size is unknown, Amazon S3 Select streams the response as a series of messages
91
+ * and includes a <code>Transfer-Encoding</code> header with <code>chunked</code> as its value in the
92
+ * response. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/RESTSelectObjectAppendix.html">Appendix: SelectObjectContent
93
+ * Response</a>.</p>
100
94
  * </dd>
101
95
  * <dt>GetObject Support</dt>
102
96
  * <dd>
103
97
  * <p>The <code>SelectObjectContent</code> action does not support the following
104
- * <code>GetObject</code> functionality. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObject.html">GetObject</a>.</p>
98
+ * <code>GetObject</code> functionality. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObject.html">GetObject</a>.</p>
105
99
  * <ul>
106
100
  * <li>
107
101
  * <p>
108
- * <code>Range</code>: Although you can specify a scan range for an Amazon S3 Select
109
- * request (see <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_SelectObjectContent.html#AmazonS3-SelectObjectContent-request-ScanRange">SelectObjectContentRequest - ScanRange</a> in the request
110
- * parameters), you cannot specify the range of bytes of an object to return.
111
- * </p>
102
+ * <code>Range</code>: Although you can specify a scan range for an Amazon S3 Select request (see
103
+ * <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_SelectObjectContent.html#AmazonS3-SelectObjectContent-request-ScanRange">SelectObjectContentRequest - ScanRange</a> in the request parameters), you
104
+ * cannot specify the range of bytes of an object to return. </p>
112
105
  * </li>
113
106
  * <li>
114
- * <p>The <code>GLACIER</code>, <code>DEEP_ARCHIVE</code>, and
115
- * <code>REDUCED_REDUNDANCY</code> storage classes, or the
116
- * <code>ARCHIVE_ACCESS</code> and <code>DEEP_ARCHIVE_ACCESS</code> access
117
- * tiers of the <code>INTELLIGENT_TIERING</code> storage class: You cannot
118
- * query objects in the <code>GLACIER</code>, <code>DEEP_ARCHIVE</code>, or
119
- * <code>REDUCED_REDUNDANCY</code> storage classes, nor objects in the
120
- * <code>ARCHIVE_ACCESS</code> or <code>DEEP_ARCHIVE_ACCESS</code> access
121
- * tiers of the <code>INTELLIGENT_TIERING</code> storage class. For more
122
- * information about storage classes, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/storage-class-intro.html">Using Amazon S3
123
- * storage classes</a> in the
124
- * <i>Amazon S3 User Guide</i>.</p>
107
+ * <p>The <code>GLACIER</code>, <code>DEEP_ARCHIVE</code>, and <code>REDUCED_REDUNDANCY</code>
108
+ * storage classes, or the <code>ARCHIVE_ACCESS</code> and <code>DEEP_ARCHIVE_ACCESS</code>
109
+ * access tiers of the <code>INTELLIGENT_TIERING</code> storage class: You cannot query objects
110
+ * in the <code>GLACIER</code>, <code>DEEP_ARCHIVE</code>, or <code>REDUCED_REDUNDANCY</code>
111
+ * storage classes, nor objects in the <code>ARCHIVE_ACCESS</code> or
112
+ * <code>DEEP_ARCHIVE_ACCESS</code> access tiers of the <code>INTELLIGENT_TIERING</code>
113
+ * storage class. For more information about storage classes, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/storage-class-intro.html">Using Amazon S3 storage classes</a>
114
+ * in the <i>Amazon S3 User Guide</i>.</p>
125
115
  * </li>
126
116
  * </ul>
127
117
  * </dd>
128
118
  * <dt>Special Errors</dt>
129
119
  * <dd>
130
- * <p>For a list of special errors for this operation, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/ErrorResponses.html#SelectObjectContentErrorCodeList">List of SELECT Object Content Error Codes</a>
120
+ * <p>For a list of special errors for this operation, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/ErrorResponses.html#SelectObjectContentErrorCodeList">List of SELECT
121
+ * Object Content Error Codes</a>
131
122
  * </p>
132
123
  * </dd>
133
124
  * </dl>