@aws-sdk/client-s3 3.326.0 → 3.328.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 (87) hide show
  1. package/dist-types/commands/AbortMultipartUploadCommand.d.ts +2 -2
  2. package/dist-types/commands/CompleteMultipartUploadCommand.d.ts +22 -14
  3. package/dist-types/commands/CopyObjectCommand.d.ts +171 -144
  4. package/dist-types/commands/CreateBucketCommand.d.ts +128 -118
  5. package/dist-types/commands/CreateMultipartUploadCommand.d.ts +73 -48
  6. package/dist-types/commands/DeleteBucketAnalyticsConfigurationCommand.d.ts +2 -2
  7. package/dist-types/commands/DeleteBucketCommand.d.ts +1 -3
  8. package/dist-types/commands/DeleteBucketCorsCommand.d.ts +3 -5
  9. package/dist-types/commands/DeleteBucketEncryptionCommand.d.ts +8 -8
  10. package/dist-types/commands/DeleteBucketIntelligentTieringConfigurationCommand.d.ts +1 -2
  11. package/dist-types/commands/DeleteBucketInventoryConfigurationCommand.d.ts +2 -2
  12. package/dist-types/commands/DeleteBucketLifecycleCommand.d.ts +1 -2
  13. package/dist-types/commands/DeleteBucketMetricsConfigurationCommand.d.ts +5 -5
  14. package/dist-types/commands/DeleteBucketOwnershipControlsCommand.d.ts +2 -2
  15. package/dist-types/commands/DeleteBucketPolicyCommand.d.ts +6 -3
  16. package/dist-types/commands/DeleteBucketReplicationCommand.d.ts +4 -3
  17. package/dist-types/commands/DeleteObjectCommand.d.ts +21 -21
  18. package/dist-types/commands/DeleteObjectTaggingCommand.d.ts +13 -15
  19. package/dist-types/commands/DeleteObjectsCommand.d.ts +35 -36
  20. package/dist-types/commands/DeletePublicAccessBlockCommand.d.ts +2 -2
  21. package/dist-types/commands/GetBucketAccelerateConfigurationCommand.d.ts +6 -7
  22. package/dist-types/commands/GetBucketAclCommand.d.ts +14 -10
  23. package/dist-types/commands/GetBucketAnalyticsConfigurationCommand.d.ts +6 -7
  24. package/dist-types/commands/GetBucketCorsCommand.d.ts +5 -0
  25. package/dist-types/commands/GetBucketEncryptionCommand.d.ts +7 -7
  26. package/dist-types/commands/GetBucketIntelligentTieringConfigurationCommand.d.ts +1 -2
  27. package/dist-types/commands/GetBucketInventoryConfigurationCommand.d.ts +2 -2
  28. package/dist-types/commands/GetBucketLifecycleConfigurationCommand.d.ts +4 -4
  29. package/dist-types/commands/GetBucketLocationCommand.d.ts +10 -2
  30. package/dist-types/commands/GetBucketLoggingCommand.d.ts +1 -1
  31. package/dist-types/commands/GetBucketMetricsConfigurationCommand.d.ts +5 -6
  32. package/dist-types/commands/GetBucketNotificationConfigurationCommand.d.ts +7 -2
  33. package/dist-types/commands/GetBucketOwnershipControlsCommand.d.ts +4 -3
  34. package/dist-types/commands/GetBucketPolicyCommand.d.ts +11 -3
  35. package/dist-types/commands/GetBucketPolicyStatusCommand.d.ts +1 -1
  36. package/dist-types/commands/GetBucketRequestPaymentCommand.d.ts +2 -1
  37. package/dist-types/commands/GetBucketWebsiteCommand.d.ts +2 -3
  38. package/dist-types/commands/GetObjectAclCommand.d.ts +5 -7
  39. package/dist-types/commands/GetObjectAttributesCommand.d.ts +42 -45
  40. package/dist-types/commands/GetObjectCommand.d.ts +116 -112
  41. package/dist-types/commands/GetObjectLockConfigurationCommand.d.ts +1 -2
  42. package/dist-types/commands/GetObjectRetentionCommand.d.ts +2 -1
  43. package/dist-types/commands/GetObjectTaggingCommand.d.ts +5 -5
  44. package/dist-types/commands/GetObjectTorrentCommand.d.ts +1 -1
  45. package/dist-types/commands/GetPublicAccessBlockCommand.d.ts +1 -1
  46. package/dist-types/commands/HeadBucketCommand.d.ts +19 -9
  47. package/dist-types/commands/HeadObjectCommand.d.ts +36 -33
  48. package/dist-types/commands/ListBucketAnalyticsConfigurationsCommand.d.ts +4 -4
  49. package/dist-types/commands/ListBucketIntelligentTieringConfigurationsCommand.d.ts +1 -2
  50. package/dist-types/commands/ListBucketInventoryConfigurationsCommand.d.ts +5 -5
  51. package/dist-types/commands/ListBucketMetricsConfigurationsCommand.d.ts +6 -7
  52. package/dist-types/commands/ListBucketsCommand.d.ts +9 -7
  53. package/dist-types/commands/ListMultipartUploadsCommand.d.ts +2 -2
  54. package/dist-types/commands/ListObjectVersionsCommand.d.ts +3 -6
  55. package/dist-types/commands/ListObjectsV2Command.d.ts +13 -14
  56. package/dist-types/commands/ListPartsCommand.d.ts +3 -4
  57. package/dist-types/commands/PutBucketAccelerateConfigurationCommand.d.ts +4 -3
  58. package/dist-types/commands/PutBucketAclCommand.d.ts +114 -111
  59. package/dist-types/commands/PutBucketAnalyticsConfigurationCommand.d.ts +7 -10
  60. package/dist-types/commands/PutBucketCorsCommand.d.ts +3 -5
  61. package/dist-types/commands/PutBucketEncryptionCommand.d.ts +17 -17
  62. package/dist-types/commands/PutBucketIntelligentTieringConfigurationCommand.d.ts +31 -59
  63. package/dist-types/commands/PutBucketInventoryConfigurationCommand.d.ts +50 -65
  64. package/dist-types/commands/PutBucketLifecycleConfigurationCommand.d.ts +64 -62
  65. package/dist-types/commands/PutBucketLoggingCommand.d.ts +45 -39
  66. package/dist-types/commands/PutBucketMetricsConfigurationCommand.d.ts +4 -4
  67. package/dist-types/commands/PutBucketNotificationConfigurationCommand.d.ts +9 -12
  68. package/dist-types/commands/PutBucketOwnershipControlsCommand.d.ts +4 -2
  69. package/dist-types/commands/PutBucketPolicyCommand.d.ts +8 -4
  70. package/dist-types/commands/PutBucketReplicationCommand.d.ts +31 -28
  71. package/dist-types/commands/PutBucketRequestPaymentCommand.d.ts +1 -1
  72. package/dist-types/commands/PutBucketTaggingCommand.d.ts +12 -12
  73. package/dist-types/commands/PutBucketVersioningCommand.d.ts +7 -9
  74. package/dist-types/commands/PutObjectAclCommand.d.ts +123 -119
  75. package/dist-types/commands/PutObjectCommand.d.ts +81 -90
  76. package/dist-types/commands/PutObjectLockConfigurationCommand.d.ts +7 -8
  77. package/dist-types/commands/PutObjectRetentionCommand.d.ts +3 -4
  78. package/dist-types/commands/PutObjectTaggingCommand.d.ts +7 -9
  79. package/dist-types/commands/PutPublicAccessBlockCommand.d.ts +2 -4
  80. package/dist-types/commands/RestoreObjectCommand.d.ts +175 -199
  81. package/dist-types/commands/SelectObjectContentCommand.d.ts +83 -90
  82. package/dist-types/commands/UploadPartCommand.d.ts +26 -22
  83. package/dist-types/commands/UploadPartCopyCommand.d.ts +78 -76
  84. package/dist-types/commands/WriteGetObjectResponseCommand.d.ts +32 -21
  85. package/dist-types/models/models_0.d.ts +468 -382
  86. package/dist-types/models/models_1.d.ts +82 -80
  87. package/package.json +9 -9
@@ -32,9 +32,8 @@ export interface PutObjectTaggingCommandOutput extends PutObjectTaggingOutput, _
32
32
  * <p>To put tags of any other version, use the <code>versionId</code> query parameter. You
33
33
  * also need permission for the <code>s3:PutObjectVersionTagging</code> action.</p>
34
34
  * <p>For information about the Amazon S3 object tagging feature, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/object-tagging.html">Object Tagging</a>.</p>
35
- * <p class="title">
36
- * <b>Special Errors</b>
37
- * </p>
35
+ * <p>
36
+ * <code>PutObjectTagging</code> has the following special errors:</p>
38
37
  * <ul>
39
38
  * <li>
40
39
  * <ul>
@@ -46,7 +45,8 @@ export interface PutObjectTaggingCommandOutput extends PutObjectTaggingOutput, _
46
45
  * <li>
47
46
  * <p>
48
47
  * <i>Cause: The tag provided was not a valid tag. This error can occur
49
- * if the tag did not pass input validation. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/object-tagging.html">Object Tagging</a>.</i>
48
+ * if the tag did not pass input validation. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/object-tagging.html">Object
49
+ * Tagging</a>.</i>
50
50
  * </p>
51
51
  * </li>
52
52
  * </ul>
@@ -74,8 +74,8 @@ export interface PutObjectTaggingCommandOutput extends PutObjectTaggingOutput, _
74
74
  * </li>
75
75
  * <li>
76
76
  * <p>
77
- * <i>Cause: A conflicting conditional action is currently in
78
- * progress against this resource. Please try again.</i>
77
+ * <i>Cause: A conflicting conditional action is currently in progress
78
+ * against this resource. Please try again.</i>
79
79
  * </p>
80
80
  * </li>
81
81
  * </ul>
@@ -96,9 +96,7 @@ export interface PutObjectTaggingCommandOutput extends PutObjectTaggingOutput, _
96
96
  * </ul>
97
97
  * </li>
98
98
  * </ul>
99
- * <p class="title">
100
- * <b>Related Resources</b>
101
- * </p>
99
+ * <p>The following operations are related to <code>PutObjectTagging</code>:</p>
102
100
  * <ul>
103
101
  * <li>
104
102
  * <p>
@@ -22,7 +22,7 @@ export interface PutPublicAccessBlockCommandOutput extends __MetadataBearer {
22
22
  * <p>Creates or modifies the <code>PublicAccessBlock</code> configuration for an Amazon S3 bucket.
23
23
  * To use this operation, you must have the <code>s3:PutBucketPublicAccessBlock</code>
24
24
  * permission. For more information about Amazon S3 permissions, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/using-with-s3-actions.html">Specifying Permissions in a
25
- * Policy</a>.</p>
25
+ * Policy</a>.</p>
26
26
  * <important>
27
27
  * <p>When Amazon S3 evaluates the <code>PublicAccessBlock</code> configuration for a bucket or
28
28
  * an object, it checks the <code>PublicAccessBlock</code> configuration for both the
@@ -32,9 +32,7 @@ export interface PutPublicAccessBlockCommandOutput extends __MetadataBearer {
32
32
  * account-level settings.</p>
33
33
  * </important>
34
34
  * <p>For more information about when Amazon S3 considers a bucket or an object public, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/access-control-block-public-access.html#access-control-block-public-access-policy-status">The Meaning of "Public"</a>.</p>
35
- * <p class="title">
36
- * <b>Related Resources</b>
37
- * </p>
35
+ * <p>The following operations are related to <code>PutPublicAccessBlock</code>:</p>
38
36
  * <ul>
39
37
  * <li>
40
38
  * <p>
@@ -32,84 +32,57 @@ export interface RestoreObjectCommandOutput extends RestoreObjectOutput, __Metad
32
32
  * <code>restore an archive</code> - Restore an archived object</p>
33
33
  * </li>
34
34
  * </ul>
35
- * <p>To use this operation, you must have permissions to perform the
36
- * <code>s3:RestoreObject</code> action. The bucket owner has this permission by default
37
- * and can grant this permission to others. 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
38
- * Resources</a> in the <i>Amazon S3 User Guide</i>.</p>
39
- * <p>
40
- * <b>Querying Archives with Select Requests</b>
41
- * </p>
42
- * <p>You use a select type of request to perform SQL queries on archived objects. The
43
- * archived objects that are being queried by the select request must be formatted as
44
- * uncompressed comma-separated values (CSV) files. You can run queries and custom analytics
45
- * on your archived data without having to restore your data to a hotter Amazon S3 tier. For an
46
- * overview about select requests, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/querying-glacier-archives.html">Querying Archived Objects</a> in the <i>Amazon S3 User Guide</i>.</p>
47
- * <p>When making a select request, do the following:</p>
35
+ * <p>For more information about the <code>S3</code> structure in the request body, see the
36
+ * following:</p>
48
37
  * <ul>
49
38
  * <li>
50
- * <p>Define an output location for the select query's output. This must be an Amazon S3
51
- * bucket in the same Amazon Web Services Region as the bucket that contains the archive object that is
52
- * being queried. The Amazon Web Services account that initiates the job must have permissions to write
53
- * to the S3 bucket. You can specify the storage class and encryption for the output
54
- * objects stored in the bucket. For more information about output, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/querying-glacier-archives.html">Querying Archived Objects</a>
55
- * in the <i>Amazon S3 User Guide</i>.</p>
56
- * <p>For more information about the <code>S3</code> structure in the request body, see
57
- * the following:</p>
58
- * <ul>
59
- * <li>
60
- * <p>
61
- * <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutObject.html">PutObject</a>
62
- * </p>
63
- * </li>
64
- * <li>
65
- * <p>
66
- * <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/S3_ACLs_UsingACLs.html">Managing Access with
67
- * ACLs</a> in the <i>Amazon S3 User Guide</i>
68
- * </p>
69
- * </li>
70
- * <li>
71
- * <p>
72
- * <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/serv-side-encryption.html">Protecting Data Using
39
+ * <p>
40
+ * <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutObject.html">PutObject</a>
41
+ * </p>
42
+ * </li>
43
+ * <li>
44
+ * <p>
45
+ * <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/S3_ACLs_UsingACLs.html">Managing Access with ACLs</a> in the
46
+ * <i>Amazon S3 User Guide</i>
47
+ * </p>
48
+ * </li>
49
+ * <li>
50
+ * <p>
51
+ * <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/serv-side-encryption.html">Protecting Data Using
73
52
  * Server-Side Encryption</a> in the
74
53
  * <i>Amazon S3 User Guide</i>
75
- * </p>
76
- * </li>
77
- * </ul>
54
+ * </p>
78
55
  * </li>
79
- * <li>
80
- * <p>Define the SQL expression for the <code>SELECT</code> type of restoration for your
56
+ * </ul>
57
+ * <p>Define the SQL expression for the <code>SELECT</code> type of restoration for your
81
58
  * query in the request body's <code>SelectParameters</code> structure. You can use
82
59
  * expressions like the following examples.</p>
83
- * <ul>
84
- * <li>
85
- * <p>The following expression returns all records from the specified
60
+ * <ul>
61
+ * <li>
62
+ * <p>The following expression returns all records from the specified
86
63
  * object.</p>
87
- * <p>
88
- * <code>SELECT * FROM Object</code>
89
- * </p>
90
- * </li>
91
- * <li>
92
- * <p>Assuming that you are not using any headers for data stored in the object,
64
+ * <p>
65
+ * <code>SELECT * FROM Object</code>
66
+ * </p>
67
+ * </li>
68
+ * <li>
69
+ * <p>Assuming that you are not using any headers for data stored in the object,
93
70
  * you can specify columns with positional headers.</p>
94
- * <p>
95
- * <code>SELECT s._1, s._2 FROM Object s WHERE s._3 > 100</code>
96
- * </p>
97
- * </li>
98
- * <li>
99
- * <p>If you have headers and you set the <code>fileHeaderInfo</code> in the
71
+ * <p>
72
+ * <code>SELECT s._1, s._2 FROM Object s WHERE s._3 > 100</code>
73
+ * </p>
74
+ * </li>
75
+ * <li>
76
+ * <p>If you have headers and you set the <code>fileHeaderInfo</code> in the
100
77
  * <code>CSV</code> structure in the request body to <code>USE</code>, you can
101
78
  * specify headers in the query. (If you set the <code>fileHeaderInfo</code> field
102
79
  * to <code>IGNORE</code>, the first row is skipped for the query.) You cannot mix
103
80
  * ordinal positions with header column names. </p>
104
- * <p>
105
- * <code>SELECT s.Id, s.FirstName, s.SSN FROM S3Object s</code>
106
- * </p>
107
- * </li>
108
- * </ul>
81
+ * <p>
82
+ * <code>SELECT s.Id, s.FirstName, s.SSN FROM S3Object s</code>
83
+ * </p>
109
84
  * </li>
110
85
  * </ul>
111
- * <p>For more information about using SQL with S3 Glacier Select restore, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-glacier-select-sql-reference.html">SQL Reference for Amazon S3 Select and
112
- * S3 Glacier Select</a> in the <i>Amazon S3 User Guide</i>. </p>
113
86
  * <p>When making a select request, you can also do the following:</p>
114
87
  * <ul>
115
88
  * <li>
@@ -125,165 +98,175 @@ export interface RestoreObjectCommandOutput extends RestoreObjectOutput, __Metad
125
98
  * <ul>
126
99
  * <li>
127
100
  * <p>The output results are new Amazon S3 objects. Unlike archive retrievals, they are
128
- * stored until explicitly deleted-manually or through a lifecycle policy.</p>
101
+ * stored until explicitly deleted-manually or through a lifecycle configuration.</p>
129
102
  * </li>
130
103
  * <li>
131
104
  * <p>You can issue more than one select request on the same Amazon S3 object. Amazon S3 doesn't
132
- * deduplicate requests, so avoid issuing duplicate requests.</p>
105
+ * duplicate requests, so avoid issuing duplicate requests.</p>
133
106
  * </li>
134
107
  * <li>
135
108
  * <p> Amazon S3 accepts a select request even if the object has already been restored. A
136
109
  * select request doesn’t return error response <code>409</code>.</p>
137
110
  * </li>
138
111
  * </ul>
139
- * <p>
140
- * <b>Restoring objects</b>
141
- * </p>
142
- * <p>Objects that you archive to the S3 Glacier or
143
- * S3 Glacier Deep Archive storage class, and S3 Intelligent-Tiering Archive or
144
- * S3 Intelligent-Tiering Deep Archive tiers are not accessible in real time. For objects in
145
- * Archive Access or Deep Archive Access tiers you must first initiate a restore request, and
146
- * then wait until the object is moved into the Frequent Access tier. For objects in
147
- * S3 Glacier or S3 Glacier Deep Archive storage classes you must
148
- * first initiate a restore request, and then wait until a temporary copy of the object is
149
- * available. To access an archived object, you must restore the object for the duration
150
- * (number of days) that you specify.</p>
151
- * <p>To restore a specific object version, you can provide a version ID. If you don't provide
152
- * a version ID, Amazon S3 restores the current version.</p>
153
- * <p>When restoring an archived object (or using a select request), you can specify one of
154
- * the following data access tier options in the <code>Tier</code> element of the request
155
- * body: </p>
156
- * <ul>
157
- * <li>
158
- * <p>
159
- * <code>Expedited</code> - Expedited retrievals allow you to quickly access your
160
- * data stored in the S3 Glacier storage class or S3 Intelligent-Tiering Archive
161
- * tier when occasional urgent requests for a subset of archives are required. For all
162
- * but the largest archived objects (250 MB+), data accessed using Expedited retrievals
163
- * is typically made available within 1–5 minutes. Provisioned capacity ensures that
164
- * retrieval capacity for Expedited retrievals is available when you need it. Expedited
165
- * retrievals and provisioned capacity are not available for objects stored in the
166
- * S3 Glacier Deep Archive storage class or S3 Intelligent-Tiering Deep Archive tier.</p>
167
- * </li>
168
- * <li>
169
- * <p>
170
- * <code>Standard</code> - Standard retrievals allow you to access any of your
171
- * archived objects within several hours. This is the default option for retrieval
172
- * requests that do not specify the retrieval option. Standard retrievals typically
173
- * finish within 3–5 hours for objects stored in the S3 Glacier storage
174
- * class or S3 Intelligent-Tiering Archive tier. They typically finish within 12 hours for
175
- * objects stored in the S3 Glacier Deep Archive storage class or
176
- * S3 Intelligent-Tiering Deep Archive tier. Standard retrievals are free for objects stored in
177
- * S3 Intelligent-Tiering.</p>
178
- * </li>
179
- * <li>
180
- * <p>
181
- * <code>Bulk</code> - Bulk retrievals are the lowest-cost retrieval option in
182
- * S3 Glacier, enabling you to retrieve large amounts, even petabytes, of data
183
- * inexpensively. Bulk retrievals typically finish within 5–12 hours for objects stored
184
- * in the S3 Glacier storage class or S3 Intelligent-Tiering Archive tier. They
185
- * typically finish within 48 hours for objects stored in the
186
- * S3 Glacier Deep Archive storage class or S3 Intelligent-Tiering Deep Archive tier. Bulk
187
- * retrievals are free for objects stored in S3 Intelligent-Tiering.</p>
188
- * </li>
189
- * </ul>
190
- * <p>For more information about archive retrieval options and provisioned capacity for
191
- * <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 <i>Amazon S3 User Guide</i>. </p>
192
- * <p>You can use Amazon S3 restore speed upgrade to change the restore speed to a faster speed
193
- * 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">
194
- * Upgrading the speed of an in-progress restore</a> in the
195
- * <i>Amazon S3 User Guide</i>. </p>
196
- * <p>To get the status of object restoration, you can send a <code>HEAD</code> request.
197
- * Operations return the <code>x-amz-restore</code> header, which provides information about
198
- * the restoration status, in the response. You can use Amazon S3 event notifications to notify you
199
- * when a restore is 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
200
- * the <i>Amazon S3 User Guide</i>.</p>
201
- * <p>After restoring an archived object, you can update the restoration period by reissuing
202
- * the request with a new period. Amazon S3 updates the restoration period relative to the current
203
- * time and charges only for the request-there are no data transfer charges. You cannot
204
- * update the restoration period when Amazon S3 is actively processing your current restore request
205
- * for the object.</p>
206
- * <p>If your bucket has a lifecycle configuration with a rule that includes an expiration
207
- * action, the object expiration overrides the life span that you specify in a restore
208
- * request. For example, if you restore an object copy for 10 days, but the object is
209
- * scheduled to expire in 3 days, Amazon S3 deletes the object in 3 days. For more information
210
- * 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
211
- * <i>Amazon S3 User Guide</i>.</p>
212
- * <p>
213
- * <b>Responses</b>
214
- * </p>
215
- * <p>A successful action returns either the <code>200 OK</code> or <code>202
216
- * Accepted</code> status code. </p>
217
- * <ul>
218
- * <li>
219
- * <p>If the object is not previously restored, then Amazon S3 returns <code>202
220
- * Accepted</code> in the response. </p>
221
- * </li>
222
- * <li>
223
- * <p>If the object is previously restored, Amazon S3 returns <code>200 OK</code> in the
224
- * response. </p>
225
- * </li>
226
- * </ul>
227
- * <p class="title">
228
- * <b>Special Errors</b>
229
- * </p>
230
- * <ul>
231
- * <li>
112
+ * <dl>
113
+ * <dt>Permissions</dt>
114
+ * <dd>
115
+ * <p>To use this operation, you must have permissions to perform the
116
+ * <code>s3:RestoreObject</code> action. The bucket owner has this permission by default
117
+ * and can grant this permission to others. 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
118
+ * Access Permissions to Your Amazon S3 Resources</a> in the
119
+ * <i>Amazon S3 User Guide</i>.</p>
120
+ * </dd>
121
+ * <dt>Restoring objects</dt>
122
+ * <dd>
123
+ * <p>Objects that you archive to the S3 Glacier Flexible Retrieval or
124
+ * S3 Glacier Deep Archive storage class, and S3 Intelligent-Tiering Archive or
125
+ * S3 Intelligent-Tiering Deep Archive tiers, are not accessible in real time. For objects in the
126
+ * S3 Glacier Flexible Retrieval or S3 Glacier Deep Archive storage
127
+ * classes, you must first initiate a restore request, and then wait until a temporary copy of
128
+ * the object is available. If you want a permanent copy of the object, create a copy of it in
129
+ * the Amazon S3 Standard storage class in your S3 bucket. To access an archived object, you must
130
+ * restore the object for the duration (number of days) that you specify. For objects in the
131
+ * Archive Access or Deep Archive Access tiers of S3 Intelligent-Tiering, you must first
132
+ * initiate a restore request, and then wait until the object is moved into the Frequent
133
+ * Access tier.</p>
134
+ * <p>To restore a specific object version, you can provide a version ID. If you don't provide
135
+ * a version ID, Amazon S3 restores the current version.</p>
136
+ * <p>When restoring an archived object, you can specify one of the following data access tier
137
+ * options in the <code>Tier</code> element of the request body: </p>
232
138
  * <ul>
233
139
  * <li>
234
140
  * <p>
235
- * <i>Code: RestoreAlreadyInProgress</i>
236
- * </p>
237
- * </li>
238
- * <li>
239
- * <p>
240
- * <i>Cause: Object restore is already in progress. (This error does not
241
- * apply to SELECT type requests.)</i>
242
- * </p>
141
+ * <code>Expedited</code> - Expedited retrievals allow you to quickly access your
142
+ * data stored in the S3 Glacier Flexible Retrieval storage class or
143
+ * S3 Intelligent-Tiering Archive tier when occasional urgent requests for restoring archives
144
+ * are required. For all but the largest archived objects (250 MB+), data accessed using
145
+ * Expedited retrievals is typically made available within 1–5 minutes. Provisioned
146
+ * capacity ensures that retrieval capacity for Expedited retrievals is available when
147
+ * you need it. Expedited retrievals and provisioned capacity are not available for
148
+ * objects stored in the S3 Glacier Deep Archive storage class or
149
+ * S3 Intelligent-Tiering Deep Archive tier.</p>
243
150
  * </li>
244
151
  * <li>
245
152
  * <p>
246
- * <i>HTTP Status Code: 409 Conflict</i>
247
- * </p>
153
+ * <code>Standard</code> - Standard retrievals allow you to access any of your
154
+ * archived objects within several hours. This is the default option for retrieval
155
+ * requests that do not specify the retrieval option. Standard retrievals typically
156
+ * finish within 3–5 hours for objects stored in the S3 Glacier Flexible
157
+ * Retrieval storage class or S3 Intelligent-Tiering Archive tier. They typically finish within
158
+ * 12 hours for objects stored in the S3 Glacier Deep Archive storage class or
159
+ * S3 Intelligent-Tiering Deep Archive tier. Standard retrievals are free for objects stored in
160
+ * S3 Intelligent-Tiering.</p>
248
161
  * </li>
249
162
  * <li>
250
163
  * <p>
251
- * <i>SOAP Fault Code Prefix: Client</i>
252
- * </p>
164
+ * <code>Bulk</code> - Bulk retrievals free for objects stored in the S3 Glacier
165
+ * Flexible Retrieval and S3 Intelligent-Tiering storage classes, enabling you to
166
+ * retrieve large amounts, even petabytes, of data at no cost. Bulk retrievals typically
167
+ * finish within 5–12 hours for objects stored in the S3 Glacier
168
+ * Flexible Retrieval storage class or S3 Intelligent-Tiering Archive tier. Bulk retrievals are
169
+ * also the lowest-cost retrieval option when restoring objects from
170
+ * S3 Glacier Deep Archive. They typically finish within 48 hours for objects
171
+ * stored in the S3 Glacier Deep Archive storage class or S3 Intelligent-Tiering Deep Archive
172
+ * tier. </p>
253
173
  * </li>
254
174
  * </ul>
255
- * </li>
256
- * <li>
175
+ * <p>For more information about archive retrieval options and provisioned capacity for
176
+ * <code>Expedited</code> data access, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/restoring-objects.html">Restoring Archived Objects</a> in
177
+ * the <i>Amazon S3 User Guide</i>. </p>
178
+ * <p>You can use Amazon S3 restore speed upgrade to change the restore speed to a faster speed
179
+ * 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
180
+ * <i>Amazon S3 User Guide</i>. </p>
181
+ * <p>To get the status of object restoration, you can send a <code>HEAD</code> request.
182
+ * Operations return the <code>x-amz-restore</code> header, which provides information about
183
+ * the restoration status, in the response. You can use Amazon S3 event notifications to notify you
184
+ * when a restore is initiated or completed. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/NotificationHowTo.html">Configuring Amazon S3
185
+ * Event Notifications</a> in the <i>Amazon S3 User Guide</i>.</p>
186
+ * <p>After restoring an archived object, you can update the restoration period by reissuing
187
+ * the request with a new period. Amazon S3 updates the restoration period relative to the current
188
+ * time and charges only for the request-there are no data transfer charges. You cannot
189
+ * update the restoration period when Amazon S3 is actively processing your current restore request
190
+ * for the object.</p>
191
+ * <p>If your bucket has a lifecycle configuration with a rule that includes an expiration
192
+ * action, the object expiration overrides the life span that you specify in a restore
193
+ * request. For example, if you restore an object copy for 10 days, but the object is
194
+ * scheduled to expire in 3 days, Amazon S3 deletes the object in 3 days. For more information
195
+ * 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>
196
+ * in <i>Amazon S3 User Guide</i>.</p>
197
+ * </dd>
198
+ * <dt>Responses</dt>
199
+ * <dd>
200
+ * <p>A successful action returns either the <code>200 OK</code> or <code>202 Accepted</code>
201
+ * status code. </p>
257
202
  * <ul>
258
203
  * <li>
259
- * <p>
260
- * <i>Code: GlacierExpeditedRetrievalNotAvailable</i>
261
- * </p>
204
+ * <p>If the object is not previously restored, then Amazon S3 returns <code>202
205
+ * Accepted</code> in the response. </p>
262
206
  * </li>
263
207
  * <li>
264
- * <p>
265
- * <i>Cause: expedited retrievals are currently not available. Try again
266
- * later. (Returned if there is insufficient capacity to process the Expedited
267
- * request. This error applies only to Expedited retrievals and not to
268
- * S3 Standard or Bulk retrievals.)</i>
269
- * </p>
208
+ * <p>If the object is previously restored, Amazon S3 returns <code>200 OK</code> in the
209
+ * response. </p>
270
210
  * </li>
211
+ * </ul>
212
+ * <ul>
271
213
  * <li>
272
- * <p>
273
- * <i>HTTP Status Code: 503</i>
274
- * </p>
214
+ * <p>Special errors:</p>
215
+ * <ul>
216
+ * <li>
217
+ * <p>
218
+ * <i>Code: RestoreAlreadyInProgress</i>
219
+ * </p>
220
+ * </li>
221
+ * <li>
222
+ * <p>
223
+ * <i>Cause: Object restore is already in progress. (This error does not
224
+ * apply to SELECT type requests.)</i>
225
+ * </p>
226
+ * </li>
227
+ * <li>
228
+ * <p>
229
+ * <i>HTTP Status Code: 409 Conflict</i>
230
+ * </p>
231
+ * </li>
232
+ * <li>
233
+ * <p>
234
+ * <i>SOAP Fault Code Prefix: Client</i>
235
+ * </p>
236
+ * </li>
237
+ * </ul>
275
238
  * </li>
276
239
  * <li>
277
- * <p>
278
- * <i>SOAP Fault Code Prefix: N/A</i>
279
- * </p>
240
+ * <ul>
241
+ * <li>
242
+ * <p>
243
+ * <i>Code: GlacierExpeditedRetrievalNotAvailable</i>
244
+ * </p>
245
+ * </li>
246
+ * <li>
247
+ * <p>
248
+ * <i>Cause: expedited retrievals are currently not available. Try again
249
+ * later. (Returned if there is insufficient capacity to process the Expedited
250
+ * request. This error applies only to Expedited retrievals and not to
251
+ * S3 Standard or Bulk retrievals.)</i>
252
+ * </p>
253
+ * </li>
254
+ * <li>
255
+ * <p>
256
+ * <i>HTTP Status Code: 503</i>
257
+ * </p>
258
+ * </li>
259
+ * <li>
260
+ * <p>
261
+ * <i>SOAP Fault Code Prefix: N/A</i>
262
+ * </p>
263
+ * </li>
264
+ * </ul>
280
265
  * </li>
281
266
  * </ul>
282
- * </li>
283
- * </ul>
284
- * <p class="title">
285
- * <b>Related Resources</b>
286
- * </p>
267
+ * </dd>
268
+ * </dl>
269
+ * <p>The following operations are related to <code>RestoreObject</code>:</p>
287
270
  * <ul>
288
271
  * <li>
289
272
  * <p>
@@ -295,13 +278,6 @@ export interface RestoreObjectCommandOutput extends RestoreObjectOutput, __Metad
295
278
  * <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketNotificationConfiguration.html">GetBucketNotificationConfiguration</a>
296
279
  * </p>
297
280
  * </li>
298
- * <li>
299
- * <p>
300
- * <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-glacier-select-sql-reference.html">SQL Reference for
301
- * Amazon S3 Select and S3 Glacier Select </a> in the
302
- * <i>Amazon S3 User Guide</i>
303
- * </p>
304
- * </li>
305
281
  * </ul>
306
282
  * @example
307
283
  * Use a bare-bones client and the command you need to make an API call.