@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.
- package/README.md +40 -0
- package/dist-cjs/index.js +594 -121
- package/dist-es/S3.js +10 -0
- package/dist-es/commands/CreateBucketMetadataConfigurationCommand.js +31 -0
- package/dist-es/commands/DeleteBucketMetadataConfigurationCommand.js +26 -0
- package/dist-es/commands/GetBucketMetadataConfigurationCommand.js +28 -0
- package/dist-es/commands/ListPartsCommand.js +1 -1
- package/dist-es/commands/UpdateBucketMetadataInventoryTableConfigurationCommand.js +31 -0
- package/dist-es/commands/UpdateBucketMetadataJournalTableConfigurationCommand.js +31 -0
- package/dist-es/commands/index.js +5 -0
- package/dist-es/models/models_0.js +16 -24
- package/dist-es/models/models_1.js +24 -0
- package/dist-es/protocols/Aws_restXml.js +325 -3
- package/dist-types/S3.d.ts +35 -0
- package/dist-types/S3Client.d.ts +7 -2
- package/dist-types/commands/AbortMultipartUploadCommand.d.ts +17 -22
- package/dist-types/commands/CompleteMultipartUploadCommand.d.ts +46 -57
- package/dist-types/commands/CopyObjectCommand.d.ts +95 -106
- package/dist-types/commands/CreateBucketCommand.d.ts +70 -82
- package/dist-types/commands/CreateBucketMetadataConfigurationCommand.d.ts +182 -0
- package/dist-types/commands/CreateBucketMetadataTableConfigurationCommand.d.ts +25 -12
- package/dist-types/commands/CreateMultipartUploadCommand.d.ts +88 -113
- package/dist-types/commands/CreateSessionCommand.d.ts +45 -50
- package/dist-types/commands/DeleteBucketAnalyticsConfigurationCommand.d.ts +7 -9
- package/dist-types/commands/DeleteBucketCommand.d.ts +10 -12
- package/dist-types/commands/DeleteBucketCorsCommand.d.ts +4 -5
- package/dist-types/commands/DeleteBucketEncryptionCommand.d.ts +16 -18
- package/dist-types/commands/DeleteBucketInventoryConfigurationCommand.d.ts +4 -6
- package/dist-types/commands/DeleteBucketLifecycleCommand.d.ts +23 -28
- package/dist-types/commands/DeleteBucketMetadataConfigurationCommand.d.ts +114 -0
- package/dist-types/commands/DeleteBucketMetadataTableConfigurationCommand.d.ts +26 -8
- package/dist-types/commands/DeleteBucketMetricsConfigurationCommand.d.ts +9 -12
- package/dist-types/commands/DeleteBucketOwnershipControlsCommand.d.ts +5 -6
- package/dist-types/commands/DeleteBucketPolicyCommand.d.ts +20 -23
- package/dist-types/commands/DeleteBucketReplicationCommand.d.ts +5 -7
- package/dist-types/commands/DeleteBucketTaggingCommand.d.ts +2 -3
- package/dist-types/commands/DeleteBucketWebsiteCommand.d.ts +9 -10
- package/dist-types/commands/DeleteObjectCommand.d.ts +37 -23
- package/dist-types/commands/DeleteObjectTaggingCommand.d.ts +7 -7
- package/dist-types/commands/DeleteObjectsCommand.d.ts +37 -44
- package/dist-types/commands/DeletePublicAccessBlockCommand.d.ts +6 -6
- package/dist-types/commands/GetBucketAccelerateConfigurationCommand.d.ts +14 -17
- package/dist-types/commands/GetBucketAclCommand.d.ts +9 -11
- package/dist-types/commands/GetBucketAnalyticsConfigurationCommand.d.ts +8 -11
- package/dist-types/commands/GetBucketCorsCommand.d.ts +4 -6
- package/dist-types/commands/GetBucketEncryptionCommand.d.ts +16 -19
- package/dist-types/commands/GetBucketInventoryConfigurationCommand.d.ts +6 -8
- package/dist-types/commands/GetBucketLifecycleConfigurationCommand.d.ts +28 -37
- package/dist-types/commands/GetBucketLocationCommand.d.ts +4 -5
- package/dist-types/commands/GetBucketLoggingCommand.d.ts +2 -2
- package/dist-types/commands/GetBucketMetadataConfigurationCommand.d.ts +146 -0
- package/dist-types/commands/GetBucketMetadataTableConfigurationCommand.d.ts +25 -8
- package/dist-types/commands/GetBucketMetricsConfigurationCommand.d.ts +10 -11
- package/dist-types/commands/GetBucketNotificationConfigurationCommand.d.ts +7 -8
- package/dist-types/commands/GetBucketOwnershipControlsCommand.d.ts +9 -8
- package/dist-types/commands/GetBucketPolicyCommand.d.ts +24 -29
- package/dist-types/commands/GetBucketPolicyStatusCommand.d.ts +5 -6
- package/dist-types/commands/GetBucketReplicationCommand.d.ts +11 -12
- package/dist-types/commands/GetBucketRequestPaymentCommand.d.ts +2 -3
- package/dist-types/commands/GetBucketTaggingCommand.d.ts +2 -3
- package/dist-types/commands/GetBucketVersioningCommand.d.ts +3 -3
- package/dist-types/commands/GetBucketWebsiteCommand.d.ts +6 -7
- package/dist-types/commands/GetObjectAclCommand.d.ts +9 -11
- package/dist-types/commands/GetObjectAttributesCommand.d.ts +55 -70
- package/dist-types/commands/GetObjectCommand.d.ts +66 -81
- package/dist-types/commands/GetObjectLegalHoldCommand.d.ts +1 -2
- package/dist-types/commands/GetObjectLockConfigurationCommand.d.ts +3 -3
- package/dist-types/commands/GetObjectRetentionCommand.d.ts +1 -2
- package/dist-types/commands/GetObjectTaggingCommand.d.ts +8 -10
- package/dist-types/commands/GetObjectTorrentCommand.d.ts +4 -5
- package/dist-types/commands/GetPublicAccessBlockCommand.d.ts +10 -12
- package/dist-types/commands/HeadBucketCommand.d.ts +33 -35
- package/dist-types/commands/HeadObjectCommand.d.ts +50 -62
- package/dist-types/commands/ListBucketAnalyticsConfigurationsCommand.d.ts +14 -17
- package/dist-types/commands/ListBucketInventoryConfigurationsCommand.d.ts +12 -15
- package/dist-types/commands/ListBucketMetricsConfigurationsCommand.d.ts +15 -18
- package/dist-types/commands/ListBucketsCommand.d.ts +10 -9
- package/dist-types/commands/ListDirectoryBucketsCommand.d.ts +9 -9
- package/dist-types/commands/ListMultipartUploadsCommand.d.ts +41 -49
- package/dist-types/commands/ListObjectVersionsCommand.d.ts +7 -9
- package/dist-types/commands/ListObjectsCommand.d.ts +8 -7
- package/dist-types/commands/ListObjectsV2Command.d.ts +28 -31
- package/dist-types/commands/ListPartsCommand.d.ts +21 -24
- package/dist-types/commands/PutBucketAccelerateConfigurationCommand.d.ts +14 -18
- package/dist-types/commands/PutBucketAclCommand.d.ts +51 -62
- package/dist-types/commands/PutBucketAnalyticsConfigurationCommand.d.ts +23 -25
- package/dist-types/commands/PutBucketCorsCommand.d.ts +23 -27
- package/dist-types/commands/PutBucketEncryptionCommand.d.ts +40 -48
- package/dist-types/commands/PutBucketIntelligentTieringConfigurationCommand.d.ts +11 -12
- package/dist-types/commands/PutBucketInventoryConfigurationCommand.d.ts +33 -37
- package/dist-types/commands/PutBucketLifecycleConfigurationCommand.d.ts +51 -60
- package/dist-types/commands/PutBucketLoggingCommand.d.ts +26 -33
- package/dist-types/commands/PutBucketMetricsConfigurationCommand.d.ts +12 -14
- package/dist-types/commands/PutBucketNotificationConfigurationCommand.d.ts +29 -35
- package/dist-types/commands/PutBucketOwnershipControlsCommand.d.ts +4 -6
- package/dist-types/commands/PutBucketPolicyCommand.d.ts +24 -29
- package/dist-types/commands/PutBucketReplicationCommand.d.ts +31 -38
- package/dist-types/commands/PutBucketRequestPaymentCommand.d.ts +4 -5
- package/dist-types/commands/PutBucketTaggingCommand.d.ts +21 -27
- package/dist-types/commands/PutBucketVersioningCommand.d.ts +20 -23
- package/dist-types/commands/PutBucketWebsiteCommand.d.ts +19 -18
- package/dist-types/commands/PutObjectAclCommand.d.ts +53 -61
- package/dist-types/commands/PutObjectCommand.d.ts +56 -66
- package/dist-types/commands/PutObjectLegalHoldCommand.d.ts +1 -3
- package/dist-types/commands/PutObjectLockConfigurationCommand.d.ts +10 -11
- package/dist-types/commands/PutObjectRetentionCommand.d.ts +4 -4
- package/dist-types/commands/PutObjectTaggingCommand.d.ts +18 -24
- package/dist-types/commands/PutPublicAccessBlockCommand.d.ts +10 -12
- package/dist-types/commands/RenameObjectCommand.d.ts +34 -40
- package/dist-types/commands/RestoreObjectCommand.d.ts +76 -85
- package/dist-types/commands/SelectObjectContentCommand.d.ts +50 -59
- package/dist-types/commands/UpdateBucketMetadataInventoryTableConfigurationCommand.d.ts +161 -0
- package/dist-types/commands/UpdateBucketMetadataJournalTableConfigurationCommand.d.ts +113 -0
- package/dist-types/commands/UploadPartCommand.d.ts +64 -74
- package/dist-types/commands/UploadPartCopyCommand.d.ts +80 -96
- package/dist-types/commands/WriteGetObjectResponseCommand.d.ts +29 -33
- package/dist-types/commands/index.d.ts +5 -0
- package/dist-types/models/models_0.d.ts +2688 -3603
- package/dist-types/models/models_1.d.ts +2120 -743
- package/dist-types/protocols/Aws_restXml.d.ts +45 -0
- package/dist-types/ts3.4/S3.d.ts +109 -0
- package/dist-types/ts3.4/S3Client.d.ts +30 -0
- package/dist-types/ts3.4/commands/CreateBucketMetadataConfigurationCommand.d.ts +47 -0
- package/dist-types/ts3.4/commands/DeleteBucketMetadataConfigurationCommand.d.ts +47 -0
- package/dist-types/ts3.4/commands/GetBucketMetadataConfigurationCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/ListObjectVersionsCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/ListObjectsCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/ListObjectsV2Command.d.ts +1 -1
- package/dist-types/ts3.4/commands/ListPartsCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/PutBucketAccelerateConfigurationCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/PutBucketAclCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/PutBucketAnalyticsConfigurationCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/UpdateBucketMetadataInventoryTableConfigurationCommand.d.ts +47 -0
- package/dist-types/ts3.4/commands/UpdateBucketMetadataJournalTableConfigurationCommand.d.ts +47 -0
- package/dist-types/ts3.4/commands/index.d.ts +5 -0
- package/dist-types/ts3.4/models/models_0.d.ts +93 -206
- package/dist-types/ts3.4/models/models_1.d.ts +238 -0
- package/dist-types/ts3.4/protocols/Aws_restXml.d.ts +60 -0
- 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
|
-
*
|
|
32
|
-
*
|
|
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
|
-
*
|
|
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
|
|
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
|
-
*
|
|
45
|
-
*
|
|
46
|
-
*
|
|
47
|
-
*
|
|
48
|
-
*
|
|
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
|
-
*
|
|
57
|
-
*
|
|
58
|
-
*
|
|
59
|
-
*
|
|
60
|
-
*
|
|
61
|
-
*
|
|
62
|
-
*
|
|
63
|
-
*
|
|
64
|
-
*
|
|
65
|
-
*
|
|
66
|
-
*
|
|
67
|
-
*
|
|
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
|
-
*
|
|
75
|
-
*
|
|
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
|
|
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
|
-
*
|
|
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
|
|
53
|
-
*
|
|
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
|
|
59
|
-
*
|
|
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
|
-
*
|
|
68
|
-
*
|
|
69
|
-
*
|
|
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
|
|
75
|
-
*
|
|
76
|
-
*
|
|
77
|
-
*
|
|
78
|
-
*
|
|
79
|
-
*
|
|
80
|
-
*
|
|
81
|
-
*
|
|
82
|
-
*
|
|
83
|
-
*
|
|
84
|
-
*
|
|
85
|
-
*
|
|
86
|
-
*
|
|
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
|
-
*
|
|
93
|
-
*
|
|
94
|
-
*
|
|
95
|
-
*
|
|
96
|
-
*
|
|
97
|
-
*
|
|
98
|
-
*
|
|
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
|
-
*
|
|
105
|
-
*
|
|
106
|
-
*
|
|
107
|
-
*
|
|
108
|
-
*
|
|
109
|
-
*
|
|
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
|
-
*
|
|
117
|
-
*
|
|
118
|
-
*
|
|
119
|
-
*
|
|
120
|
-
*
|
|
121
|
-
*
|
|
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
|
-
*
|
|
129
|
-
*
|
|
130
|
-
* <p>You can use Amazon S3 restore speed upgrade to change the restore speed to a faster
|
|
131
|
-
*
|
|
132
|
-
*
|
|
133
|
-
*
|
|
134
|
-
*
|
|
135
|
-
*
|
|
136
|
-
*
|
|
137
|
-
*
|
|
138
|
-
*
|
|
139
|
-
* <p>After restoring an archived object, you can update the restoration period by
|
|
140
|
-
*
|
|
141
|
-
*
|
|
142
|
-
*
|
|
143
|
-
*
|
|
144
|
-
* <p>If your bucket has a lifecycle configuration with a rule that includes an
|
|
145
|
-
*
|
|
146
|
-
*
|
|
147
|
-
*
|
|
148
|
-
*
|
|
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
|
-
*
|
|
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
|
-
*
|
|
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
|
-
*
|
|
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
|
-
*
|
|
202
|
-
*
|
|
203
|
-
*
|
|
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
|
-
*
|
|
35
|
-
*
|
|
36
|
-
*
|
|
37
|
-
*
|
|
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
|
-
*
|
|
42
|
-
*
|
|
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
|
-
*
|
|
49
|
-
*
|
|
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
|
-
*
|
|
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
|
-
*
|
|
71
|
-
*
|
|
72
|
-
*
|
|
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
|
-
*
|
|
79
|
-
* <p>For objects that are encrypted with customer-provided encryption keys
|
|
80
|
-
*
|
|
81
|
-
*
|
|
82
|
-
*
|
|
83
|
-
*
|
|
84
|
-
* <p>For objects that are encrypted with Amazon S3 managed keys (SSE-S3) and
|
|
85
|
-
*
|
|
86
|
-
*
|
|
87
|
-
*
|
|
88
|
-
*
|
|
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
|
-
*
|
|
96
|
-
*
|
|
97
|
-
*
|
|
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
|
-
*
|
|
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
|
-
*
|
|
110
|
-
*
|
|
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
|
-
*
|
|
116
|
-
*
|
|
117
|
-
*
|
|
118
|
-
*
|
|
119
|
-
*
|
|
120
|
-
*
|
|
121
|
-
*
|
|
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
|
|
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>
|