@aws-sdk/client-s3 3.697.0 → 3.698.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/dist-cjs/index.js +152 -5
- package/dist-es/models/models_1.js +48 -0
- package/dist-es/protocols/Aws_restXml.js +75 -4
- package/dist-types/commands/AbortMultipartUploadCommand.d.ts +16 -13
- package/dist-types/commands/CompleteMultipartUploadCommand.d.ts +47 -42
- package/dist-types/commands/CopyObjectCommand.d.ts +77 -57
- package/dist-types/commands/CreateBucketCommand.d.ts +60 -45
- package/dist-types/commands/CreateMultipartUploadCommand.d.ts +92 -66
- package/dist-types/commands/CreateSessionCommand.d.ts +30 -16
- package/dist-types/commands/DeleteBucketAnalyticsConfigurationCommand.d.ts +1 -1
- package/dist-types/commands/DeleteBucketCommand.d.ts +10 -3
- package/dist-types/commands/DeleteBucketCorsCommand.d.ts +1 -1
- package/dist-types/commands/DeleteBucketEncryptionCommand.d.ts +18 -10
- package/dist-types/commands/DeleteBucketIntelligentTieringConfigurationCommand.d.ts +1 -1
- package/dist-types/commands/DeleteBucketInventoryConfigurationCommand.d.ts +1 -1
- package/dist-types/commands/DeleteBucketLifecycleCommand.d.ts +52 -9
- package/dist-types/commands/DeleteBucketMetricsConfigurationCommand.d.ts +1 -1
- package/dist-types/commands/DeleteBucketOwnershipControlsCommand.d.ts +1 -1
- package/dist-types/commands/DeleteBucketPolicyCommand.d.ts +25 -21
- package/dist-types/commands/DeleteBucketReplicationCommand.d.ts +1 -1
- package/dist-types/commands/DeleteBucketTaggingCommand.d.ts +1 -1
- package/dist-types/commands/DeleteBucketWebsiteCommand.d.ts +1 -1
- package/dist-types/commands/DeleteObjectCommand.d.ts +3 -0
- package/dist-types/commands/DeleteObjectTaggingCommand.d.ts +1 -1
- package/dist-types/commands/DeleteObjectsCommand.d.ts +41 -27
- package/dist-types/commands/DeletePublicAccessBlockCommand.d.ts +1 -1
- package/dist-types/commands/GetBucketAccelerateConfigurationCommand.d.ts +1 -1
- package/dist-types/commands/GetBucketAclCommand.d.ts +1 -1
- package/dist-types/commands/GetBucketAnalyticsConfigurationCommand.d.ts +1 -1
- package/dist-types/commands/GetBucketCorsCommand.d.ts +1 -1
- package/dist-types/commands/GetBucketEncryptionCommand.d.ts +18 -10
- package/dist-types/commands/GetBucketIntelligentTieringConfigurationCommand.d.ts +1 -1
- package/dist-types/commands/GetBucketInventoryConfigurationCommand.d.ts +1 -1
- package/dist-types/commands/GetBucketLifecycleConfigurationCommand.d.ts +61 -17
- package/dist-types/commands/GetBucketLocationCommand.d.ts +1 -1
- package/dist-types/commands/GetBucketLoggingCommand.d.ts +1 -1
- package/dist-types/commands/GetBucketMetricsConfigurationCommand.d.ts +1 -1
- package/dist-types/commands/GetBucketNotificationConfigurationCommand.d.ts +1 -1
- package/dist-types/commands/GetBucketOwnershipControlsCommand.d.ts +1 -1
- package/dist-types/commands/GetBucketPolicyCommand.d.ts +30 -21
- package/dist-types/commands/GetBucketPolicyStatusCommand.d.ts +1 -1
- package/dist-types/commands/GetBucketReplicationCommand.d.ts +1 -1
- package/dist-types/commands/GetBucketRequestPaymentCommand.d.ts +1 -1
- package/dist-types/commands/GetBucketTaggingCommand.d.ts +1 -1
- package/dist-types/commands/GetBucketVersioningCommand.d.ts +1 -1
- package/dist-types/commands/GetBucketWebsiteCommand.d.ts +1 -1
- package/dist-types/commands/GetObjectAclCommand.d.ts +1 -1
- package/dist-types/commands/GetObjectAttributesCommand.d.ts +62 -44
- package/dist-types/commands/GetObjectCommand.d.ts +79 -60
- package/dist-types/commands/GetObjectLegalHoldCommand.d.ts +1 -1
- package/dist-types/commands/GetObjectLockConfigurationCommand.d.ts +1 -1
- package/dist-types/commands/GetObjectRetentionCommand.d.ts +1 -1
- package/dist-types/commands/GetObjectTaggingCommand.d.ts +1 -1
- package/dist-types/commands/GetObjectTorrentCommand.d.ts +1 -1
- package/dist-types/commands/GetPublicAccessBlockCommand.d.ts +1 -1
- package/dist-types/commands/HeadBucketCommand.d.ts +32 -16
- package/dist-types/commands/HeadObjectCommand.d.ts +60 -38
- package/dist-types/commands/ListBucketAnalyticsConfigurationsCommand.d.ts +1 -1
- package/dist-types/commands/ListBucketIntelligentTieringConfigurationsCommand.d.ts +1 -1
- package/dist-types/commands/ListBucketInventoryConfigurationsCommand.d.ts +1 -1
- package/dist-types/commands/ListBucketMetricsConfigurationsCommand.d.ts +1 -1
- package/dist-types/commands/ListBucketsCommand.d.ts +6 -6
- package/dist-types/commands/ListDirectoryBucketsCommand.d.ts +10 -4
- package/dist-types/commands/ListMultipartUploadsCommand.d.ts +50 -33
- package/dist-types/commands/ListObjectVersionsCommand.d.ts +1 -1
- package/dist-types/commands/ListObjectsCommand.d.ts +1 -1
- package/dist-types/commands/ListObjectsV2Command.d.ts +23 -14
- package/dist-types/commands/ListPartsCommand.d.ts +22 -17
- package/dist-types/commands/PutBucketAccelerateConfigurationCommand.d.ts +1 -1
- package/dist-types/commands/PutBucketAclCommand.d.ts +1 -1
- package/dist-types/commands/PutBucketAnalyticsConfigurationCommand.d.ts +1 -1
- package/dist-types/commands/PutBucketCorsCommand.d.ts +1 -1
- package/dist-types/commands/PutBucketEncryptionCommand.d.ts +47 -32
- package/dist-types/commands/PutBucketIntelligentTieringConfigurationCommand.d.ts +1 -1
- package/dist-types/commands/PutBucketInventoryConfigurationCommand.d.ts +1 -1
- package/dist-types/commands/PutBucketLifecycleConfigurationCommand.d.ts +84 -45
- package/dist-types/commands/PutBucketLoggingCommand.d.ts +1 -1
- package/dist-types/commands/PutBucketMetricsConfigurationCommand.d.ts +1 -1
- package/dist-types/commands/PutBucketNotificationConfigurationCommand.d.ts +1 -1
- package/dist-types/commands/PutBucketOwnershipControlsCommand.d.ts +1 -1
- package/dist-types/commands/PutBucketPolicyCommand.d.ts +30 -21
- package/dist-types/commands/PutBucketReplicationCommand.d.ts +3 -4
- package/dist-types/commands/PutBucketRequestPaymentCommand.d.ts +1 -1
- package/dist-types/commands/PutBucketTaggingCommand.d.ts +1 -1
- package/dist-types/commands/PutBucketVersioningCommand.d.ts +3 -6
- package/dist-types/commands/PutBucketWebsiteCommand.d.ts +1 -1
- package/dist-types/commands/PutObjectAclCommand.d.ts +1 -1
- package/dist-types/commands/PutObjectCommand.d.ts +83 -35
- package/dist-types/commands/PutObjectLegalHoldCommand.d.ts +1 -1
- package/dist-types/commands/PutObjectLockConfigurationCommand.d.ts +3 -3
- package/dist-types/commands/PutObjectRetentionCommand.d.ts +2 -2
- package/dist-types/commands/PutObjectTaggingCommand.d.ts +1 -1
- package/dist-types/commands/PutPublicAccessBlockCommand.d.ts +1 -1
- package/dist-types/commands/RestoreObjectCommand.d.ts +1 -1
- package/dist-types/commands/SelectObjectContentCommand.d.ts +1 -1
- package/dist-types/commands/UploadPartCommand.d.ts +52 -41
- package/dist-types/commands/UploadPartCopyCommand.d.ts +53 -39
- package/dist-types/commands/WriteGetObjectResponseCommand.d.ts +1 -1
- package/dist-types/models/models_0.d.ts +938 -632
- package/dist-types/models/models_1.d.ts +230 -135
- package/dist-types/ts3.4/models/models_0.d.ts +7 -0
- package/dist-types/ts3.4/models/models_1.d.ts +24 -0
- package/package.json +1 -1
|
@@ -27,24 +27,33 @@ declare const HeadBucketCommand_base: {
|
|
|
27
27
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
|
-
* <p>You can use this operation to determine if a bucket exists and if you have permission to
|
|
31
|
-
*
|
|
30
|
+
* <p>You can use this operation to determine if a bucket exists and if you have permission to
|
|
31
|
+
* access it. The action returns a <code>200 OK</code> if the bucket exists and you have
|
|
32
|
+
* permission to access it.</p>
|
|
32
33
|
* <note>
|
|
33
34
|
* <p>If the bucket does not exist or you do not have permission to access it, the
|
|
34
|
-
*
|
|
35
|
-
*
|
|
36
|
-
*
|
|
35
|
+
* <code>HEAD</code> request returns a generic <code>400 Bad Request</code>, <code>403
|
|
36
|
+
* Forbidden</code> or <code>404 Not Found</code> code. A message body is not included,
|
|
37
|
+
* so you cannot determine the exception beyond these HTTP response codes.</p>
|
|
37
38
|
* </note>
|
|
38
39
|
* <dl>
|
|
39
40
|
* <dt>Authentication and authorization</dt>
|
|
40
41
|
* <dd>
|
|
41
42
|
* <p>
|
|
42
|
-
* <b>General purpose buckets</b> - Request to public
|
|
43
|
-
*
|
|
43
|
+
* <b>General purpose buckets</b> - Request to public
|
|
44
|
+
* buckets that grant the s3:ListBucket permission publicly do not need to be signed.
|
|
45
|
+
* All other <code>HeadBucket</code> requests must be authenticated and signed by
|
|
46
|
+
* using IAM credentials (access key ID and secret access key for the IAM
|
|
47
|
+
* identities). All headers with the <code>x-amz-</code> prefix, including
|
|
48
|
+
* <code>x-amz-copy-source</code>, must be signed. For more information, see
|
|
49
|
+
* <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/RESTAuthentication.html">REST Authentication</a>.</p>
|
|
44
50
|
* <p>
|
|
45
|
-
* <b>Directory buckets</b> - You must use IAM
|
|
46
|
-
*
|
|
47
|
-
*
|
|
51
|
+
* <b>Directory buckets</b> - You must use IAM
|
|
52
|
+
* credentials to authenticate and authorize your access to the
|
|
53
|
+
* <code>HeadBucket</code> API operation, instead of using the temporary security
|
|
54
|
+
* credentials through the <code>CreateSession</code> API operation.</p>
|
|
55
|
+
* <p>Amazon Web Services CLI or SDKs handles authentication and authorization on your
|
|
56
|
+
* behalf.</p>
|
|
48
57
|
* </dd>
|
|
49
58
|
* <dt>Permissions</dt>
|
|
50
59
|
* <dd>
|
|
@@ -52,10 +61,13 @@ declare const HeadBucketCommand_base: {
|
|
|
52
61
|
* <ul>
|
|
53
62
|
* <li>
|
|
54
63
|
* <p>
|
|
55
|
-
* <b>General purpose bucket permissions</b> - To
|
|
56
|
-
*
|
|
57
|
-
*
|
|
58
|
-
*
|
|
64
|
+
* <b>General purpose bucket permissions</b> - To
|
|
65
|
+
* use this operation, you must have permissions to perform the
|
|
66
|
+
* <code>s3:ListBucket</code> action. The bucket owner has this permission
|
|
67
|
+
* by default and can grant this permission to others. For more information
|
|
68
|
+
* about permissions, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html">Managing access
|
|
69
|
+
* permissions to your Amazon S3 resources</a> in the
|
|
70
|
+
* <i>Amazon S3 User Guide</i>.</p>
|
|
59
71
|
* </li>
|
|
60
72
|
* <li>
|
|
61
73
|
* <p>
|
|
@@ -63,8 +75,12 @@ declare const HeadBucketCommand_base: {
|
|
|
63
75
|
* You must have the <b>
|
|
64
76
|
* <code>s3express:CreateSession</code>
|
|
65
77
|
* </b> permission in the
|
|
66
|
-
* <code>Action</code> element of a policy. By default, the session is in
|
|
67
|
-
*
|
|
78
|
+
* <code>Action</code> element of a policy. By default, the session is in
|
|
79
|
+
* the <code>ReadWrite</code> mode. If you want to restrict the access, you can
|
|
80
|
+
* explicitly set the <code>s3express:SessionMode</code> condition key to
|
|
81
|
+
* <code>ReadOnly</code> on the bucket.</p>
|
|
82
|
+
* <p>For more information about example bucket policies, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-express-security-iam-example-bucket-policies.html">Example bucket policies for S3 Express One Zone</a> and <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-express-security-iam-identity-policies.html">Amazon Web Services Identity and Access Management (IAM) identity-based policies for
|
|
83
|
+
* S3 Express One Zone</a> in the <i>Amazon S3 User Guide</i>.</p>
|
|
68
84
|
* </li>
|
|
69
85
|
* </ul>
|
|
70
86
|
* </dd>
|
|
@@ -28,17 +28,19 @@ declare const HeadObjectCommand_base: {
|
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
30
|
* <p>The <code>HEAD</code> operation retrieves metadata from an object without returning the
|
|
31
|
-
* object itself. This operation is useful if you're interested only in an object's
|
|
31
|
+
* object itself. This operation is useful if you're interested only in an object's
|
|
32
|
+
* metadata.</p>
|
|
32
33
|
* <note>
|
|
33
|
-
* <p>A <code>HEAD</code> request has the same options as a <code>GET</code> operation on
|
|
34
|
-
*
|
|
35
|
-
*
|
|
36
|
-
*
|
|
37
|
-
*
|
|
38
|
-
*
|
|
34
|
+
* <p>A <code>HEAD</code> request has the same options as a <code>GET</code> operation on
|
|
35
|
+
* an object. The response is identical to the <code>GET</code> response except that there
|
|
36
|
+
* is no response body. Because of this, if the <code>HEAD</code> request generates an
|
|
37
|
+
* error, it returns a generic code, such as <code>400 Bad Request</code>, <code>403
|
|
38
|
+
* Forbidden</code>, <code>404 Not Found</code>, <code>405 Method Not Allowed</code>,
|
|
39
|
+
* <code>412 Precondition Failed</code>, or <code>304 Not Modified</code>. It's not
|
|
40
|
+
* possible to retrieve the exact exception of these error codes.</p>
|
|
39
41
|
* </note>
|
|
40
42
|
* <p>Request headers are limited to 8 KB in size. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/RESTCommonRequestHeaders.html">Common
|
|
41
|
-
*
|
|
43
|
+
* Request Headers</a>.</p>
|
|
42
44
|
* <dl>
|
|
43
45
|
* <dt>Permissions</dt>
|
|
44
46
|
* <dd>
|
|
@@ -47,20 +49,25 @@ declare const HeadObjectCommand_base: {
|
|
|
47
49
|
* <li>
|
|
48
50
|
* <p>
|
|
49
51
|
* <b>General purpose bucket permissions</b> - To
|
|
50
|
-
* use <code>HEAD</code>, you must have the <code>s3:GetObject</code>
|
|
51
|
-
*
|
|
52
|
-
*
|
|
53
|
-
*
|
|
54
|
-
*
|
|
55
|
-
*
|
|
52
|
+
* use <code>HEAD</code>, you must have the <code>s3:GetObject</code>
|
|
53
|
+
* permission. You need the relevant read object (or version) permission for
|
|
54
|
+
* this operation. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/list_amazons3.html">Actions, resources, and
|
|
55
|
+
* condition keys for Amazon S3</a> in the <i>Amazon S3 User
|
|
56
|
+
* Guide</i>. For more information about the permissions to S3 API
|
|
57
|
+
* operations by S3 resource types, see <a href="/AmazonS3/latest/userguide/using-with-s3-policy-actions.html">Required permissions for Amazon S3 API operations</a> in the
|
|
58
|
+
* <i>Amazon S3 User Guide</i>.</p>
|
|
59
|
+
* <p>If the object you request doesn't exist, the error that Amazon S3 returns
|
|
60
|
+
* depends on whether you also have the <code>s3:ListBucket</code>
|
|
61
|
+
* permission.</p>
|
|
56
62
|
* <ul>
|
|
57
63
|
* <li>
|
|
58
|
-
* <p>If you have the <code>s3:ListBucket</code> permission on the
|
|
59
|
-
* returns an HTTP status code <code>404 Not Found</code>
|
|
64
|
+
* <p>If you have the <code>s3:ListBucket</code> permission on the
|
|
65
|
+
* bucket, Amazon S3 returns an HTTP status code <code>404 Not Found</code>
|
|
66
|
+
* error.</p>
|
|
60
67
|
* </li>
|
|
61
68
|
* <li>
|
|
62
|
-
* <p>If you don’t have the <code>s3:ListBucket</code> permission, Amazon S3
|
|
63
|
-
* an HTTP status code <code>403 Forbidden</code> error.</p>
|
|
69
|
+
* <p>If you don’t have the <code>s3:ListBucket</code> permission, Amazon S3
|
|
70
|
+
* returns an HTTP status code <code>403 Forbidden</code> error.</p>
|
|
64
71
|
* </li>
|
|
65
72
|
* </ul>
|
|
66
73
|
* </li>
|
|
@@ -72,9 +79,11 @@ declare const HeadObjectCommand_base: {
|
|
|
72
79
|
* Amazon Web Services CLI or SDKs create session and refresh the session token automatically to avoid service interruptions when a session expires. For more information about authorization, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateSession.html">
|
|
73
80
|
* <code>CreateSession</code>
|
|
74
81
|
* </a>.</p>
|
|
75
|
-
* <p>If you enable <code>x-amz-checksum-mode</code> in the request and the
|
|
76
|
-
* Amazon Web Services Key Management Service (Amazon Web Services KMS), you must
|
|
77
|
-
* <code>kms:GenerateDataKey</code> and <code>kms:Decrypt</code>
|
|
82
|
+
* <p>If you enable <code>x-amz-checksum-mode</code> in the request and the
|
|
83
|
+
* object is encrypted with Amazon Web Services Key Management Service (Amazon Web Services KMS), you must
|
|
84
|
+
* also have the <code>kms:GenerateDataKey</code> and <code>kms:Decrypt</code>
|
|
85
|
+
* permissions in IAM identity-based policies and KMS key policies for the
|
|
86
|
+
* KMS key to retrieve the checksum of the object.</p>
|
|
78
87
|
* </li>
|
|
79
88
|
* </ul>
|
|
80
89
|
* </dd>
|
|
@@ -82,16 +91,22 @@ declare const HeadObjectCommand_base: {
|
|
|
82
91
|
* <dd>
|
|
83
92
|
* <note>
|
|
84
93
|
* <p>Encryption request headers, like <code>x-amz-server-side-encryption</code>,
|
|
85
|
-
*
|
|
86
|
-
*
|
|
87
|
-
*
|
|
88
|
-
*
|
|
89
|
-
*
|
|
90
|
-
*
|
|
94
|
+
* should not be sent for <code>HEAD</code> requests if your object uses
|
|
95
|
+
* server-side encryption with Key Management Service (KMS) keys (SSE-KMS), dual-layer
|
|
96
|
+
* server-side encryption with Amazon Web Services KMS keys (DSSE-KMS), or server-side
|
|
97
|
+
* encryption with Amazon S3 managed encryption keys (SSE-S3). The
|
|
98
|
+
* <code>x-amz-server-side-encryption</code> header is used when you
|
|
99
|
+
* <code>PUT</code> an object to S3 and want to specify the encryption method.
|
|
100
|
+
* If you include this header in a <code>HEAD</code> request for an object that
|
|
101
|
+
* uses these types of keys, you’ll get an HTTP <code>400 Bad Request</code>
|
|
102
|
+
* error. It's because the encryption method can't be changed when you retrieve
|
|
103
|
+
* the object.</p>
|
|
91
104
|
* </note>
|
|
92
105
|
* <p>If you encrypt an object by using server-side encryption with customer-provided
|
|
93
|
-
*
|
|
94
|
-
*
|
|
106
|
+
* encryption keys (SSE-C) when you store the object in Amazon S3, then when you retrieve
|
|
107
|
+
* the metadata from the object, you must use the following headers to provide the
|
|
108
|
+
* encryption key for the server to be able to retrieve the object's metadata. The
|
|
109
|
+
* headers are: </p>
|
|
95
110
|
* <ul>
|
|
96
111
|
* <li>
|
|
97
112
|
* <p>
|
|
@@ -109,12 +124,13 @@ declare const HeadObjectCommand_base: {
|
|
|
109
124
|
* </p>
|
|
110
125
|
* </li>
|
|
111
126
|
* </ul>
|
|
112
|
-
* <p>For more information about SSE-C, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/ServerSideEncryptionCustomerKeys.html">Server-Side
|
|
113
|
-
*
|
|
114
|
-
*
|
|
127
|
+
* <p>For more information about SSE-C, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/ServerSideEncryptionCustomerKeys.html">Server-Side
|
|
128
|
+
* Encryption (Using Customer-Provided Encryption Keys)</a> in the
|
|
129
|
+
* <i>Amazon S3 User Guide</i>.</p>
|
|
115
130
|
* <note>
|
|
116
131
|
* <p>
|
|
117
|
-
* <b>Directory bucket </b> -
|
|
132
|
+
* <b>Directory bucket </b> -
|
|
133
|
+
* For directory buckets, there are only two supported options for server-side encryption: SSE-S3 and SSE-KMS. SSE-C isn't supported. For more
|
|
118
134
|
* information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-express-serv-side-encryption.html">Protecting data with server-side encryption</a> in the <i>Amazon S3 User Guide</i>. </p>
|
|
119
135
|
* </note>
|
|
120
136
|
* </dd>
|
|
@@ -122,22 +138,28 @@ declare const HeadObjectCommand_base: {
|
|
|
122
138
|
* <dd>
|
|
123
139
|
* <ul>
|
|
124
140
|
* <li>
|
|
125
|
-
* <p>If the current version of the object is a delete marker, Amazon S3 behaves as
|
|
141
|
+
* <p>If the current version of the object is a delete marker, Amazon S3 behaves as
|
|
142
|
+
* if the object was deleted and includes <code>x-amz-delete-marker:
|
|
143
|
+
* true</code> in the response.</p>
|
|
126
144
|
* </li>
|
|
127
145
|
* <li>
|
|
128
|
-
* <p>If the specified version is a delete marker, the response returns a
|
|
146
|
+
* <p>If the specified version is a delete marker, the response returns a
|
|
147
|
+
* <code>405 Method Not Allowed</code> error and the <code>Last-Modified:
|
|
148
|
+
* timestamp</code> response header.</p>
|
|
129
149
|
* </li>
|
|
130
150
|
* </ul>
|
|
131
151
|
* <note>
|
|
132
152
|
* <ul>
|
|
133
153
|
* <li>
|
|
134
154
|
* <p>
|
|
135
|
-
* <b>Directory buckets</b> -
|
|
155
|
+
* <b>Directory buckets</b> -
|
|
156
|
+
* Delete marker is not supported for directory buckets.</p>
|
|
136
157
|
* </li>
|
|
137
158
|
* <li>
|
|
138
159
|
* <p>
|
|
139
|
-
* <b>Directory buckets</b> -
|
|
140
|
-
*
|
|
160
|
+
* <b>Directory buckets</b> -
|
|
161
|
+
* S3 Versioning isn't enabled and supported for directory buckets. For this API operation, only the <code>null</code> value of the version ID is supported by directory buckets. You can only specify <code>null</code>
|
|
162
|
+
* to the <code>versionId</code> query parameter in the request.</p>
|
|
141
163
|
* </li>
|
|
142
164
|
* </ul>
|
|
143
165
|
* </note>
|
|
@@ -28,7 +28,7 @@ declare const ListBucketAnalyticsConfigurationsCommand_base: {
|
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
30
|
* <note>
|
|
31
|
-
* <p>This operation is not supported
|
|
31
|
+
* <p>This operation is not supported for directory buckets.</p>
|
|
32
32
|
* </note>
|
|
33
33
|
* <p>Lists the analytics configurations for the bucket. You can have up to 1,000 analytics
|
|
34
34
|
* configurations per bucket.</p>
|
|
@@ -28,7 +28,7 @@ declare const ListBucketIntelligentTieringConfigurationsCommand_base: {
|
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
30
|
* <note>
|
|
31
|
-
* <p>This operation is not supported
|
|
31
|
+
* <p>This operation is not supported for directory buckets.</p>
|
|
32
32
|
* </note>
|
|
33
33
|
* <p>Lists the S3 Intelligent-Tiering configuration from the specified bucket.</p>
|
|
34
34
|
* <p>The S3 Intelligent-Tiering storage class is designed to optimize storage costs by automatically moving data to the most cost-effective storage access tier, without performance impact or operational overhead. S3 Intelligent-Tiering delivers automatic cost savings in three low latency and high throughput access tiers. To get the lowest storage cost on data that can be accessed in minutes to hours, you can choose to activate additional archiving capabilities.</p>
|
|
@@ -28,7 +28,7 @@ declare const ListBucketInventoryConfigurationsCommand_base: {
|
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
30
|
* <note>
|
|
31
|
-
* <p>This operation is not supported
|
|
31
|
+
* <p>This operation is not supported for directory buckets.</p>
|
|
32
32
|
* </note>
|
|
33
33
|
* <p>Returns a list of inventory configurations for the bucket. You can have up to 1,000
|
|
34
34
|
* analytics configurations per bucket.</p>
|
|
@@ -28,7 +28,7 @@ declare const ListBucketMetricsConfigurationsCommand_base: {
|
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
30
|
* <note>
|
|
31
|
-
* <p>This operation is not supported
|
|
31
|
+
* <p>This operation is not supported for directory buckets.</p>
|
|
32
32
|
* </note>
|
|
33
33
|
* <p>Lists the metrics configurations for the bucket. The metrics configurations are only for
|
|
34
34
|
* the request metrics of the bucket and do not provide information on daily storage metrics.
|
|
@@ -28,17 +28,17 @@ declare const ListBucketsCommand_base: {
|
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
30
|
* <note>
|
|
31
|
-
* <p>This operation is not supported
|
|
31
|
+
* <p>This operation is not supported for directory buckets.</p>
|
|
32
32
|
* </note>
|
|
33
|
-
* <p>Returns a list of all buckets owned by the authenticated sender of the request. To use
|
|
34
|
-
* this operation, you must
|
|
33
|
+
* <p>Returns a list of all buckets owned by the authenticated sender of the request. To grant IAM permission to use
|
|
34
|
+
* this operation, you must add the <code>s3:ListAllMyBuckets</code> policy action. </p>
|
|
35
35
|
* <p>For information about Amazon S3 buckets, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/creating-buckets-s3.html">Creating, configuring, and
|
|
36
36
|
* working with Amazon S3 buckets</a>.</p>
|
|
37
37
|
* <important>
|
|
38
|
-
* <p>We strongly recommend using only paginated requests. Unpaginated requests are only supported for
|
|
38
|
+
* <p>We strongly recommend using only paginated <code>ListBuckets</code> requests. Unpaginated <code>ListBuckets</code> requests are only supported for
|
|
39
39
|
* Amazon Web Services accounts set to the default general purpose bucket quota of 10,000. If you have an approved
|
|
40
|
-
* general purpose bucket quota above 10,000, you must send paginated requests to list your account’s buckets.
|
|
41
|
-
* All unpaginated ListBuckets requests will be rejected for Amazon Web Services accounts with a general purpose bucket quota
|
|
40
|
+
* general purpose bucket quota above 10,000, you must send paginated <code>ListBuckets</code> requests to list your account’s buckets.
|
|
41
|
+
* All unpaginated <code>ListBuckets</code> requests will be rejected for Amazon Web Services accounts with a general purpose bucket quota
|
|
42
42
|
* greater than 10,000. </p>
|
|
43
43
|
* </important>
|
|
44
44
|
* @example
|
|
@@ -27,7 +27,8 @@ declare const ListDirectoryBucketsCommand_base: {
|
|
|
27
27
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
|
-
* <p>Returns a list of all Amazon S3 directory buckets owned by the authenticated sender of the
|
|
30
|
+
* <p>Returns a list of all Amazon S3 directory buckets owned by the authenticated sender of the
|
|
31
|
+
* request. For more information about directory buckets, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/directory-buckets-overview.html">Directory buckets</a> in the <i>Amazon S3 User Guide</i>.</p>
|
|
31
32
|
* <note>
|
|
32
33
|
* <p>
|
|
33
34
|
* <b>Directory buckets </b> - For directory buckets, you must make requests for this API operation to the Regional endpoint. These endpoints support path-style requests in the format <code>https://s3express-control.<i>region_code</i>.amazonaws.com/<i>bucket-name</i>
|
|
@@ -38,16 +39,21 @@ declare const ListDirectoryBucketsCommand_base: {
|
|
|
38
39
|
* <dl>
|
|
39
40
|
* <dt>Permissions</dt>
|
|
40
41
|
* <dd>
|
|
41
|
-
* <p>You must have the <code>s3express:ListAllMyDirectoryBuckets</code> permission
|
|
42
|
+
* <p>You must have the <code>s3express:ListAllMyDirectoryBuckets</code> permission
|
|
43
|
+
* in an IAM identity-based policy instead of a bucket policy. Cross-account access to this API operation isn't supported. This operation can only be performed by the Amazon Web Services account that owns the resource.
|
|
44
|
+
* For more information about directory bucket policies and permissions, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-express-security-iam.html">Amazon Web Services Identity and Access Management (IAM) for S3 Express One Zone</a> in the <i>Amazon S3 User Guide</i>.</p>
|
|
42
45
|
* </dd>
|
|
43
46
|
* <dt>HTTP Host header syntax</dt>
|
|
44
47
|
* <dd>
|
|
45
48
|
* <p>
|
|
46
|
-
* <b>Directory buckets </b> - The HTTP Host
|
|
49
|
+
* <b>Directory buckets </b> - The HTTP Host
|
|
50
|
+
* header syntax is
|
|
51
|
+
* <code>s3express-control.<i>region</i>.amazonaws.com</code>.</p>
|
|
47
52
|
* </dd>
|
|
48
53
|
* </dl>
|
|
49
54
|
* <note>
|
|
50
|
-
* <p> The <code>BucketRegion</code> response element is not part of the
|
|
55
|
+
* <p> The <code>BucketRegion</code> response element is not part of the
|
|
56
|
+
* <code>ListDirectoryBuckets</code> Response Syntax.</p>
|
|
51
57
|
* </note>
|
|
52
58
|
* @example
|
|
53
59
|
* Use a bare-bones client and the command you need to make an API call.
|
|
@@ -27,39 +27,47 @@ declare const ListMultipartUploadsCommand_base: {
|
|
|
27
27
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
|
-
* <p>This operation lists in-progress multipart uploads in a bucket. An in-progress multipart
|
|
31
|
-
* multipart upload that has been initiated by the
|
|
32
|
-
*
|
|
30
|
+
* <p>This operation lists in-progress multipart uploads in a bucket. An in-progress multipart
|
|
31
|
+
* upload is a multipart upload that has been initiated by the
|
|
32
|
+
* <code>CreateMultipartUpload</code> request, but has not yet been completed or
|
|
33
|
+
* aborted.</p>
|
|
33
34
|
* <note>
|
|
34
35
|
* <p>
|
|
35
|
-
* <b>Directory buckets</b> -
|
|
36
|
-
*
|
|
37
|
-
*
|
|
38
|
-
* uploads
|
|
39
|
-
*
|
|
36
|
+
* <b>Directory buckets</b> - If multipart uploads in
|
|
37
|
+
* a directory bucket are in progress, you can't delete the bucket until all the
|
|
38
|
+
* in-progress multipart uploads are aborted or completed. To delete these in-progress
|
|
39
|
+
* multipart uploads, use the <code>ListMultipartUploads</code> operation to list the
|
|
40
|
+
* in-progress multipart uploads in the bucket and use the
|
|
41
|
+
* <code>AbortMultipartUpload</code> operation to abort all the in-progress multipart
|
|
42
|
+
* uploads. </p>
|
|
40
43
|
* </note>
|
|
41
|
-
* <p>The <code>ListMultipartUploads</code> operation returns a maximum of 1,000 multipart
|
|
42
|
-
* uploads is also the default
|
|
43
|
-
*
|
|
44
|
-
*
|
|
45
|
-
* satisfy your <code>ListMultipartUploads</code> request, the response returns
|
|
46
|
-
*
|
|
47
|
-
*
|
|
48
|
-
*
|
|
49
|
-
*
|
|
50
|
-
*
|
|
44
|
+
* <p>The <code>ListMultipartUploads</code> operation returns a maximum of 1,000 multipart
|
|
45
|
+
* uploads in the response. The limit of 1,000 multipart uploads is also the default value.
|
|
46
|
+
* You can further limit the number of uploads in a response by specifying the
|
|
47
|
+
* <code>max-uploads</code> request parameter. If there are more than 1,000 multipart
|
|
48
|
+
* uploads that satisfy your <code>ListMultipartUploads</code> request, the response returns
|
|
49
|
+
* an <code>IsTruncated</code> element with the value of <code>true</code>, a
|
|
50
|
+
* <code>NextKeyMarker</code> element, and a <code>NextUploadIdMarker</code> element. To
|
|
51
|
+
* list the remaining multipart uploads, you need to make subsequent
|
|
52
|
+
* <code>ListMultipartUploads</code> requests. In these requests, include two query
|
|
53
|
+
* parameters: <code>key-marker</code> and <code>upload-id-marker</code>. Set the value of
|
|
54
|
+
* <code>key-marker</code> to the <code>NextKeyMarker</code> value from the previous
|
|
55
|
+
* response. Similarly, set the value of <code>upload-id-marker</code> to the
|
|
56
|
+
* <code>NextUploadIdMarker</code> value from the previous response.</p>
|
|
51
57
|
* <note>
|
|
52
58
|
* <p>
|
|
53
|
-
* <b>Directory buckets</b> - The
|
|
54
|
-
*
|
|
55
|
-
*
|
|
59
|
+
* <b>Directory buckets</b> - The
|
|
60
|
+
* <code>upload-id-marker</code> element and the <code>NextUploadIdMarker</code> element
|
|
61
|
+
* aren't supported by directory buckets. To list the additional multipart uploads, you
|
|
62
|
+
* only need to set the value of <code>key-marker</code> to the <code>NextKeyMarker</code>
|
|
63
|
+
* value from the previous response. </p>
|
|
56
64
|
* </note>
|
|
57
65
|
* <p>For more information about multipart uploads, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/uploadobjusingmpu.html">Uploading Objects Using Multipart
|
|
58
|
-
*
|
|
59
|
-
* User Guide</i>.</p>
|
|
66
|
+
* Upload</a> in the <i>Amazon S3 User Guide</i>.</p>
|
|
60
67
|
* <note>
|
|
61
68
|
* <p>
|
|
62
|
-
* <b>Directory buckets</b> -
|
|
69
|
+
* <b>Directory buckets</b> -
|
|
70
|
+
* For directory buckets, you must make requests for this API operation to the Zonal endpoint. These endpoints support virtual-hosted-style requests in the format <code>https://<i>bucket_name</i>.s3express-<i>az_id</i>.<i>region</i>.amazonaws.com/<i>key-name</i>
|
|
63
71
|
* </code>. Path-style requests are not supported. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-express-Regions-and-Zones.html">Regional and Zonal endpoints</a> in the
|
|
64
72
|
* <i>Amazon S3 User Guide</i>.</p>
|
|
65
73
|
* </note>
|
|
@@ -69,9 +77,10 @@ declare const ListMultipartUploadsCommand_base: {
|
|
|
69
77
|
* <ul>
|
|
70
78
|
* <li>
|
|
71
79
|
* <p>
|
|
72
|
-
* <b>General purpose bucket permissions</b> - For
|
|
73
|
-
*
|
|
74
|
-
*
|
|
80
|
+
* <b>General purpose bucket permissions</b> - For
|
|
81
|
+
* information about permissions required to use the multipart upload API, see
|
|
82
|
+
* <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/mpuAndPermissions.html">Multipart Upload and
|
|
83
|
+
* Permissions</a> in the <i>Amazon S3 User Guide</i>.</p>
|
|
75
84
|
* </li>
|
|
76
85
|
* <li>
|
|
77
86
|
* <p>
|
|
@@ -89,22 +98,30 @@ declare const ListMultipartUploadsCommand_base: {
|
|
|
89
98
|
* <ul>
|
|
90
99
|
* <li>
|
|
91
100
|
* <p>
|
|
92
|
-
* <b>General purpose bucket</b> - In the
|
|
101
|
+
* <b>General purpose bucket</b> - In the
|
|
102
|
+
* <code>ListMultipartUploads</code> response, the multipart uploads are
|
|
103
|
+
* sorted based on two criteria:</p>
|
|
93
104
|
* <ul>
|
|
94
105
|
* <li>
|
|
95
|
-
* <p>Key-based sorting - Multipart uploads are initially sorted
|
|
106
|
+
* <p>Key-based sorting - Multipart uploads are initially sorted
|
|
107
|
+
* in ascending order based on their object keys.</p>
|
|
96
108
|
* </li>
|
|
97
109
|
* <li>
|
|
98
|
-
* <p>Time-based sorting - For uploads that share the same object
|
|
99
|
-
* they are further sorted in ascending order based on the upload
|
|
110
|
+
* <p>Time-based sorting - For uploads that share the same object
|
|
111
|
+
* key, they are further sorted in ascending order based on the upload
|
|
112
|
+
* initiation time. Among uploads with the same key, the one that was
|
|
113
|
+
* initiated first will appear before the ones that were initiated
|
|
114
|
+
* later.</p>
|
|
100
115
|
* </li>
|
|
101
116
|
* </ul>
|
|
102
117
|
* </li>
|
|
103
118
|
* <li>
|
|
104
119
|
* <p>
|
|
105
|
-
* <b>Directory bucket</b> - In the
|
|
120
|
+
* <b>Directory bucket</b> - In the
|
|
121
|
+
* <code>ListMultipartUploads</code> response, the multipart uploads aren't
|
|
122
|
+
* sorted lexicographically based on the object keys.
|
|
106
123
|
*
|
|
107
|
-
*
|
|
124
|
+
* </p>
|
|
108
125
|
* </li>
|
|
109
126
|
* </ul>
|
|
110
127
|
* </dd>
|
|
@@ -28,7 +28,7 @@ declare const ListObjectVersionsCommand_base: {
|
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
30
|
* <note>
|
|
31
|
-
* <p>This operation is not supported
|
|
31
|
+
* <p>This operation is not supported for directory buckets.</p>
|
|
32
32
|
* </note>
|
|
33
33
|
* <p>Returns metadata about all versions of the objects in a bucket. You can also use request
|
|
34
34
|
* parameters as selection criteria to return metadata about a subset of all the object
|
|
@@ -28,7 +28,7 @@ declare const ListObjectsCommand_base: {
|
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
30
|
* <note>
|
|
31
|
-
* <p>This operation is not supported
|
|
31
|
+
* <p>This operation is not supported for directory buckets.</p>
|
|
32
32
|
* </note>
|
|
33
33
|
* <p>Returns some or all (up to 1,000) of the objects in a bucket. You can use the request
|
|
34
34
|
* parameters as selection criteria to return a subset of the objects in a bucket. A 200 OK
|
|
@@ -31,24 +31,27 @@ declare const ListObjectsV2Command_base: {
|
|
|
31
31
|
* use the request parameters as selection criteria to return a subset of the objects in a
|
|
32
32
|
* bucket. A <code>200 OK</code> response can contain valid or invalid XML. Make sure to
|
|
33
33
|
* design your application to parse the contents of the response and handle it appropriately.
|
|
34
|
-
*
|
|
35
34
|
* For more information about listing objects, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/ListingKeysUsingAPIs.html">Listing object keys
|
|
36
|
-
* programmatically</a> in the <i>Amazon S3 User Guide</i>. To get a list of
|
|
35
|
+
* programmatically</a> in the <i>Amazon S3 User Guide</i>. To get a list of
|
|
36
|
+
* your buckets, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListBuckets.html">ListBuckets</a>.</p>
|
|
37
37
|
* <note>
|
|
38
38
|
* <ul>
|
|
39
39
|
* <li>
|
|
40
40
|
* <p>
|
|
41
|
-
* <b>General purpose bucket</b> - For general purpose buckets,
|
|
41
|
+
* <b>General purpose bucket</b> - For general purpose buckets,
|
|
42
|
+
* <code>ListObjectsV2</code> doesn't return prefixes that are related only to
|
|
43
|
+
* in-progress multipart uploads.</p>
|
|
42
44
|
* </li>
|
|
43
45
|
* <li>
|
|
44
46
|
* <p>
|
|
45
|
-
* <b>Directory buckets</b> -
|
|
46
|
-
*
|
|
47
|
-
*
|
|
47
|
+
* <b>Directory buckets</b> - For
|
|
48
|
+
* directory buckets, <code>ListObjectsV2</code> response includes the prefixes that
|
|
49
|
+
* are related only to in-progress multipart uploads. </p>
|
|
48
50
|
* </li>
|
|
49
51
|
* <li>
|
|
50
52
|
* <p>
|
|
51
|
-
* <b>Directory buckets</b> -
|
|
53
|
+
* <b>Directory buckets</b> -
|
|
54
|
+
* For directory buckets, you must make requests for this API operation to the Zonal endpoint. These endpoints support virtual-hosted-style requests in the format <code>https://<i>bucket_name</i>.s3express-<i>az_id</i>.<i>region</i>.amazonaws.com/<i>key-name</i>
|
|
52
55
|
* </code>. Path-style requests are not supported. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-express-Regions-and-Zones.html">Regional and Zonal endpoints</a> in the
|
|
53
56
|
* <i>Amazon S3 User Guide</i>.</p>
|
|
54
57
|
* </li>
|
|
@@ -60,11 +63,13 @@ declare const ListObjectsV2Command_base: {
|
|
|
60
63
|
* <ul>
|
|
61
64
|
* <li>
|
|
62
65
|
* <p>
|
|
63
|
-
* <b>General purpose bucket permissions</b> - To
|
|
64
|
-
*
|
|
65
|
-
*
|
|
66
|
-
*
|
|
67
|
-
* <
|
|
66
|
+
* <b>General purpose bucket permissions</b> - To
|
|
67
|
+
* use this operation, you must have READ access to the bucket. You must have
|
|
68
|
+
* permission to perform the <code>s3:ListBucket</code> action. The bucket
|
|
69
|
+
* owner has this permission by default and can grant this permission to
|
|
70
|
+
* 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
|
|
71
|
+
* Permissions to Your Amazon S3 Resources</a> in the
|
|
72
|
+
* <i>Amazon S3 User Guide</i>.</p>
|
|
68
73
|
* </li>
|
|
69
74
|
* <li>
|
|
70
75
|
* <p>
|
|
@@ -82,11 +87,15 @@ declare const ListObjectsV2Command_base: {
|
|
|
82
87
|
* <ul>
|
|
83
88
|
* <li>
|
|
84
89
|
* <p>
|
|
85
|
-
* <b>General purpose bucket</b> - For
|
|
90
|
+
* <b>General purpose bucket</b> - For
|
|
91
|
+
* general purpose buckets, <code>ListObjectsV2</code> returns objects in
|
|
92
|
+
* lexicographical order based on their key names.</p>
|
|
86
93
|
* </li>
|
|
87
94
|
* <li>
|
|
88
95
|
* <p>
|
|
89
|
-
* <b>Directory bucket</b> - For
|
|
96
|
+
* <b>Directory bucket</b> - For
|
|
97
|
+
* directory buckets, <code>ListObjectsV2</code> does not return objects in
|
|
98
|
+
* lexicographical order.</p>
|
|
90
99
|
* </li>
|
|
91
100
|
* </ul>
|
|
92
101
|
* </dd>
|