@aws-sdk/client-s3 3.697.0 → 3.699.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 +4 -4
|
@@ -28,7 +28,7 @@ declare const GetBucketPolicyStatusCommand_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>Retrieves the policy status for an Amazon S3 bucket, indicating whether the bucket is public.
|
|
34
34
|
* In order to use this operation, you must have the <code>s3:GetBucketPolicyStatus</code>
|
|
@@ -28,7 +28,7 @@ declare const GetBucketReplicationCommand_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 the replication configuration of a bucket.</p>
|
|
34
34
|
* <note>
|
|
@@ -28,7 +28,7 @@ declare const GetBucketRequestPaymentCommand_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 the request payment configuration of a bucket. To use this version of the
|
|
34
34
|
* operation, you must be the bucket owner. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/RequesterPaysBuckets.html">Requester Pays
|
|
@@ -28,7 +28,7 @@ declare const GetBucketTaggingCommand_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 the tag set associated with the bucket.</p>
|
|
34
34
|
* <p>To use this operation, you must have permission to perform the
|
|
@@ -28,7 +28,7 @@ declare const GetBucketVersioningCommand_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 the versioning state of a bucket.</p>
|
|
34
34
|
* <p>To retrieve the versioning state of a bucket, you must be the bucket owner.</p>
|
|
@@ -28,7 +28,7 @@ declare const GetBucketWebsiteCommand_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 the website configuration for a bucket. To host website on Amazon S3, you can
|
|
34
34
|
* configure a bucket as website by adding a website configuration. For more information about
|
|
@@ -28,7 +28,7 @@ declare const GetObjectAclCommand_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 the access control list (ACL) of an object. To use this operation, you must have
|
|
34
34
|
* <code>s3:GetObjectAcl</code> permissions or <code>READ_ACP</code> access to the object.
|
|
@@ -35,7 +35,8 @@ declare const GetObjectAttributesCommand_base: {
|
|
|
35
35
|
* can be returned with a single call to <code>GetObjectAttributes</code>.</p>
|
|
36
36
|
* <note>
|
|
37
37
|
* <p>
|
|
38
|
-
* <b>Directory buckets</b> -
|
|
38
|
+
* <b>Directory buckets</b> -
|
|
39
|
+
* 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>
|
|
39
40
|
* </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
|
|
40
41
|
* <i>Amazon S3 User Guide</i>.</p>
|
|
41
42
|
* </note>
|
|
@@ -45,26 +46,29 @@ declare const GetObjectAttributesCommand_base: {
|
|
|
45
46
|
* <ul>
|
|
46
47
|
* <li>
|
|
47
48
|
* <p>
|
|
48
|
-
* <b>General purpose bucket permissions</b> - To
|
|
49
|
-
* <code>GetObjectAttributes</code>, you must have READ access to the
|
|
50
|
-
*
|
|
51
|
-
*
|
|
52
|
-
*
|
|
53
|
-
*
|
|
54
|
-
*
|
|
55
|
-
*
|
|
56
|
-
*
|
|
57
|
-
*
|
|
49
|
+
* <b>General purpose bucket permissions</b> - To
|
|
50
|
+
* use <code>GetObjectAttributes</code>, you must have READ access to the
|
|
51
|
+
* object. The permissions that you need to use this operation depend on
|
|
52
|
+
* whether the bucket is versioned. If the bucket is versioned, you need both
|
|
53
|
+
* the <code>s3:GetObjectVersion</code> and
|
|
54
|
+
* <code>s3:GetObjectVersionAttributes</code> permissions for this
|
|
55
|
+
* operation. If the bucket is not versioned, you need the
|
|
56
|
+
* <code>s3:GetObject</code> and <code>s3:GetObjectAttributes</code>
|
|
57
|
+
* permissions. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/using-with-s3-actions.html">Specifying
|
|
58
|
+
* Permissions in a Policy</a> in the
|
|
59
|
+
* <i>Amazon S3 User Guide</i>. If the object that you request does
|
|
60
|
+
* not exist, the error Amazon S3 returns depends on whether you also have the
|
|
61
|
+
* <code>s3:ListBucket</code> permission.</p>
|
|
58
62
|
* <ul>
|
|
59
63
|
* <li>
|
|
60
|
-
* <p>If you have the <code>s3:ListBucket</code> permission on the
|
|
61
|
-
* returns an HTTP status code <code>404 Not Found</code>
|
|
62
|
-
* error.</p>
|
|
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
|
+
* ("no such key") error.</p>
|
|
63
67
|
* </li>
|
|
64
68
|
* <li>
|
|
65
|
-
* <p>If you don't have the <code>s3:ListBucket</code> permission, Amazon S3
|
|
66
|
-
* an HTTP status code <code>403 Forbidden</code> ("access
|
|
67
|
-
* 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> ("access
|
|
71
|
+
* denied") error.</p>
|
|
68
72
|
* </li>
|
|
69
73
|
* </ul>
|
|
70
74
|
* </li>
|
|
@@ -76,9 +80,12 @@ declare const GetObjectAttributesCommand_base: {
|
|
|
76
80
|
* 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">
|
|
77
81
|
* <code>CreateSession</code>
|
|
78
82
|
* </a>.</p>
|
|
79
|
-
* <p>If
|
|
80
|
-
*
|
|
81
|
-
*
|
|
83
|
+
* <p>If
|
|
84
|
+
* the
|
|
85
|
+
* object is encrypted with SSE-KMS, you must also have the
|
|
86
|
+
* <code>kms:GenerateDataKey</code> and <code>kms:Decrypt</code> permissions
|
|
87
|
+
* in IAM identity-based policies and KMS key policies for the KMS
|
|
88
|
+
* key.</p>
|
|
82
89
|
* </li>
|
|
83
90
|
* </ul>
|
|
84
91
|
* </dd>
|
|
@@ -86,16 +93,22 @@ declare const GetObjectAttributesCommand_base: {
|
|
|
86
93
|
* <dd>
|
|
87
94
|
* <note>
|
|
88
95
|
* <p>Encryption request headers, like <code>x-amz-server-side-encryption</code>,
|
|
89
|
-
*
|
|
90
|
-
*
|
|
91
|
-
*
|
|
92
|
-
*
|
|
93
|
-
*
|
|
94
|
-
*
|
|
96
|
+
* should not be sent for <code>HEAD</code> requests if your object uses
|
|
97
|
+
* server-side encryption with Key Management Service (KMS) keys (SSE-KMS), dual-layer
|
|
98
|
+
* server-side encryption with Amazon Web Services KMS keys (DSSE-KMS), or server-side
|
|
99
|
+
* encryption with Amazon S3 managed encryption keys (SSE-S3). The
|
|
100
|
+
* <code>x-amz-server-side-encryption</code> header is used when you
|
|
101
|
+
* <code>PUT</code> an object to S3 and want to specify the encryption method.
|
|
102
|
+
* If you include this header in a <code>GET</code> request for an object that
|
|
103
|
+
* uses these types of keys, you’ll get an HTTP <code>400 Bad Request</code>
|
|
104
|
+
* error. It's because the encryption method can't be changed when you retrieve
|
|
105
|
+
* the object.</p>
|
|
95
106
|
* </note>
|
|
96
107
|
* <p>If you encrypt an object by using server-side encryption with customer-provided
|
|
97
|
-
* encryption keys (SSE-C) when you store the object in Amazon S3, then when you retrieve
|
|
98
|
-
* metadata from the object, you must use the following headers to provide the
|
|
108
|
+
* encryption keys (SSE-C) when you store the object in Amazon S3, then when you retrieve
|
|
109
|
+
* the metadata from the object, you must use the following headers to provide the
|
|
110
|
+
* encryption key for the server to be able to retrieve the object's metadata. The
|
|
111
|
+
* headers are: </p>
|
|
99
112
|
* <ul>
|
|
100
113
|
* <li>
|
|
101
114
|
* <p>
|
|
@@ -113,12 +126,13 @@ declare const GetObjectAttributesCommand_base: {
|
|
|
113
126
|
* </p>
|
|
114
127
|
* </li>
|
|
115
128
|
* </ul>
|
|
116
|
-
* <p>For more information about SSE-C, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/ServerSideEncryptionCustomerKeys.html">Server-Side
|
|
117
|
-
*
|
|
118
|
-
* User Guide</i>.</p>
|
|
129
|
+
* <p>For more information about SSE-C, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/ServerSideEncryptionCustomerKeys.html">Server-Side
|
|
130
|
+
* Encryption (Using Customer-Provided Encryption Keys)</a> in the
|
|
131
|
+
* <i>Amazon S3 User Guide</i>.</p>
|
|
119
132
|
* <note>
|
|
120
133
|
* <p>
|
|
121
|
-
* <b>Directory bucket permissions</b> -
|
|
134
|
+
* <b>Directory bucket permissions</b> -
|
|
135
|
+
* For directory buckets, there are only two supported options for server-side encryption: server-side encryption with Amazon S3 managed keys (SSE-S3) (<code>AES256</code>) and server-side encryption with KMS keys (SSE-KMS) (<code>aws:kms</code>). We recommend that the bucket's default encryption uses the desired encryption configuration and you don't override the bucket default encryption in your
|
|
122
136
|
* <code>CreateSession</code> requests or <code>PUT</code> object requests. Then, new objects
|
|
123
137
|
* are automatically encrypted with the desired encryption settings. For more
|
|
124
138
|
* 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>. For more information about the encryption overriding behaviors in directory buckets, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-express-specifying-kms-encryption.html">Specifying server-side encryption with KMS for new object uploads</a>.</p>
|
|
@@ -127,43 +141,47 @@ declare const GetObjectAttributesCommand_base: {
|
|
|
127
141
|
* <dt>Versioning</dt>
|
|
128
142
|
* <dd>
|
|
129
143
|
* <p>
|
|
130
|
-
* <b>Directory buckets</b> -
|
|
131
|
-
*
|
|
144
|
+
* <b>Directory buckets</b> -
|
|
145
|
+
* 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> to the
|
|
146
|
+
* <code>versionId</code> query parameter in the request.</p>
|
|
132
147
|
* </dd>
|
|
133
148
|
* <dt>Conditional request headers</dt>
|
|
134
149
|
* <dd>
|
|
135
150
|
* <p>Consider the following when using request headers:</p>
|
|
136
151
|
* <ul>
|
|
137
152
|
* <li>
|
|
138
|
-
* <p>If both of the <code>If-Match</code> and <code>If-Unmodified-Since</code>
|
|
139
|
-
* are present in the request as follows, then Amazon S3 returns the HTTP
|
|
140
|
-
* <code>200 OK</code> and the data requested:</p>
|
|
153
|
+
* <p>If both of the <code>If-Match</code> and <code>If-Unmodified-Since</code>
|
|
154
|
+
* headers are present in the request as follows, then Amazon S3 returns the HTTP
|
|
155
|
+
* status code <code>200 OK</code> and the data requested:</p>
|
|
141
156
|
* <ul>
|
|
142
157
|
* <li>
|
|
143
158
|
* <p>
|
|
144
|
-
* <code>If-Match</code> condition evaluates to
|
|
159
|
+
* <code>If-Match</code> condition evaluates to
|
|
160
|
+
* <code>true</code>.</p>
|
|
145
161
|
* </li>
|
|
146
162
|
* <li>
|
|
147
163
|
* <p>
|
|
148
164
|
* <code>If-Unmodified-Since</code> condition evaluates to
|
|
149
|
-
*
|
|
165
|
+
* <code>false</code>.</p>
|
|
150
166
|
* </li>
|
|
151
167
|
* </ul>
|
|
152
168
|
* <p>For more information about conditional requests, see <a href="https://tools.ietf.org/html/rfc7232">RFC 7232</a>.</p>
|
|
153
169
|
* </li>
|
|
154
170
|
* <li>
|
|
155
|
-
* <p>If both of the <code>If-None-Match</code> and
|
|
156
|
-
*
|
|
157
|
-
* <code>304 Not
|
|
171
|
+
* <p>If both of the <code>If-None-Match</code> and
|
|
172
|
+
* <code>If-Modified-Since</code> headers are present in the request as
|
|
173
|
+
* follows, then Amazon S3 returns the HTTP status code <code>304 Not
|
|
174
|
+
* Modified</code>:</p>
|
|
158
175
|
* <ul>
|
|
159
176
|
* <li>
|
|
160
177
|
* <p>
|
|
161
|
-
* <code>If-None-Match</code> condition evaluates to
|
|
178
|
+
* <code>If-None-Match</code> condition evaluates to
|
|
179
|
+
* <code>false</code>.</p>
|
|
162
180
|
* </li>
|
|
163
181
|
* <li>
|
|
164
182
|
* <p>
|
|
165
183
|
* <code>If-Modified-Since</code> condition evaluates to
|
|
166
|
-
*
|
|
184
|
+
* <code>true</code>.</p>
|
|
167
185
|
* </li>
|
|
168
186
|
* </ul>
|
|
169
187
|
* <p>For more information about conditional requests, see <a href="https://tools.ietf.org/html/rfc7232">RFC 7232</a>.</p>
|
|
@@ -31,16 +31,18 @@ declare const GetObjectCommand_base: {
|
|
|
31
31
|
* <p>Retrieves an object from Amazon S3.</p>
|
|
32
32
|
* <p>In the <code>GetObject</code> request, specify the full key name for the object.</p>
|
|
33
33
|
* <p>
|
|
34
|
-
* <b>General purpose buckets</b> - Both the virtual-hosted-style
|
|
35
|
-
* the
|
|
36
|
-
*
|
|
37
|
-
*
|
|
38
|
-
*
|
|
34
|
+
* <b>General purpose buckets</b> - Both the virtual-hosted-style
|
|
35
|
+
* requests and the path-style requests are supported. For a virtual hosted-style request
|
|
36
|
+
* example, if you have the object <code>photos/2006/February/sample.jpg</code>, specify the
|
|
37
|
+
* object key name as <code>/photos/2006/February/sample.jpg</code>. For a path-style request
|
|
38
|
+
* example, if you have the object <code>photos/2006/February/sample.jpg</code> in the bucket
|
|
39
|
+
* named <code>examplebucket</code>, specify the object key name as
|
|
39
40
|
* <code>/examplebucket/photos/2006/February/sample.jpg</code>. For more information about
|
|
40
41
|
* request types, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/VirtualHosting.html#VirtualHostingSpecifyBucket">HTTP Host
|
|
41
42
|
* Header Bucket Specification</a> in the <i>Amazon S3 User Guide</i>.</p>
|
|
42
43
|
* <p>
|
|
43
|
-
* <b>Directory buckets</b> -
|
|
44
|
+
* <b>Directory buckets</b> -
|
|
45
|
+
* Only virtual-hosted-style requests are supported. For a virtual hosted-style request example, if you have the object <code>photos/2006/February/sample.jpg</code> in the bucket named <code>examplebucket--use1-az5--x-s3</code>, specify the object key name as <code>/photos/2006/February/sample.jpg</code>. Also, when you make requests to this API operation, your requests are sent 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>
|
|
44
46
|
* </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
|
|
45
47
|
* <i>Amazon S3 User Guide</i>.</p>
|
|
46
48
|
* <dl>
|
|
@@ -49,28 +51,35 @@ declare const GetObjectCommand_base: {
|
|
|
49
51
|
* <ul>
|
|
50
52
|
* <li>
|
|
51
53
|
* <p>
|
|
52
|
-
* <b>General purpose bucket permissions</b> - You
|
|
53
|
-
*
|
|
54
|
-
*
|
|
55
|
-
*
|
|
56
|
-
*
|
|
57
|
-
* <
|
|
58
|
-
*
|
|
59
|
-
* <p>If you request
|
|
60
|
-
*
|
|
61
|
-
*
|
|
62
|
-
*
|
|
63
|
-
* <p>If the
|
|
64
|
-
*
|
|
54
|
+
* <b>General purpose bucket permissions</b> - You
|
|
55
|
+
* must have the required permissions in a policy. To use
|
|
56
|
+
* <code>GetObject</code>, you must have the <code>READ</code> access to the
|
|
57
|
+
* object (or version). If you grant <code>READ</code> access to the anonymous
|
|
58
|
+
* user, the <code>GetObject</code> operation returns the object without using
|
|
59
|
+
* an authorization header. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/using-with-s3-actions.html">Specifying permissions in a policy</a> in the
|
|
60
|
+
* <i>Amazon S3 User Guide</i>.</p>
|
|
61
|
+
* <p>If you include a <code>versionId</code> in your request header, you must
|
|
62
|
+
* have the <code>s3:GetObjectVersion</code> permission to access a specific
|
|
63
|
+
* version of an object. The <code>s3:GetObject</code> permission is not
|
|
64
|
+
* required in this scenario.</p>
|
|
65
|
+
* <p>If you request the current version of an object without a specific
|
|
66
|
+
* <code>versionId</code> in the request header, only the
|
|
67
|
+
* <code>s3:GetObject</code> permission is required. The
|
|
68
|
+
* <code>s3:GetObjectVersion</code> permission is not required in this
|
|
69
|
+
* scenario. </p>
|
|
70
|
+
* <p>If the object that you request doesn’t exist, the error that Amazon S3 returns
|
|
71
|
+
* depends on whether you also have the <code>s3:ListBucket</code>
|
|
65
72
|
* permission.</p>
|
|
66
73
|
* <ul>
|
|
67
74
|
* <li>
|
|
68
|
-
* <p>If you have the <code>s3:ListBucket</code> permission on the
|
|
69
|
-
* returns an HTTP status code <code>404 Not Found</code>
|
|
75
|
+
* <p>If you have the <code>s3:ListBucket</code> permission on the
|
|
76
|
+
* bucket, Amazon S3 returns an HTTP status code <code>404 Not Found</code>
|
|
77
|
+
* error.</p>
|
|
70
78
|
* </li>
|
|
71
79
|
* <li>
|
|
72
|
-
* <p>If you don’t have the <code>s3:ListBucket</code> permission, Amazon S3
|
|
73
|
-
* HTTP status code <code>403 Access Denied</code>
|
|
80
|
+
* <p>If you don’t have the <code>s3:ListBucket</code> permission, Amazon S3
|
|
81
|
+
* returns an HTTP status code <code>403 Access Denied</code>
|
|
82
|
+
* error.</p>
|
|
74
83
|
* </li>
|
|
75
84
|
* </ul>
|
|
76
85
|
* </li>
|
|
@@ -82,50 +91,60 @@ declare const GetObjectCommand_base: {
|
|
|
82
91
|
* 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">
|
|
83
92
|
* <code>CreateSession</code>
|
|
84
93
|
* </a>.</p>
|
|
85
|
-
* <p>If
|
|
86
|
-
*
|
|
87
|
-
*
|
|
94
|
+
* <p>If
|
|
95
|
+
* the
|
|
96
|
+
* object is encrypted using SSE-KMS, you must also have the
|
|
97
|
+
* <code>kms:GenerateDataKey</code> and <code>kms:Decrypt</code> permissions
|
|
98
|
+
* in IAM identity-based policies and KMS key policies for the KMS
|
|
99
|
+
* key.</p>
|
|
88
100
|
* </li>
|
|
89
101
|
* </ul>
|
|
90
102
|
* </dd>
|
|
91
103
|
* <dt>Storage classes</dt>
|
|
92
104
|
* <dd>
|
|
93
|
-
* <p>If the object you are retrieving is stored in the S3 Glacier Flexible Retrieval
|
|
94
|
-
*
|
|
95
|
-
* S3 Intelligent-Tiering
|
|
96
|
-
* copy using <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_RestoreObject.html">RestoreObject</a>. Otherwise, this operation returns an
|
|
97
|
-
*
|
|
98
|
-
* see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/restoring-objects.html">Restoring
|
|
99
|
-
*
|
|
105
|
+
* <p>If the object you are retrieving is stored in the S3 Glacier Flexible Retrieval
|
|
106
|
+
* storage class, the S3 Glacier Deep Archive storage class, the
|
|
107
|
+
* S3 Intelligent-Tiering Archive Access tier, or the S3 Intelligent-Tiering Deep Archive Access tier,
|
|
108
|
+
* before you can retrieve the object you must first restore a copy using <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_RestoreObject.html">RestoreObject</a>. Otherwise, this operation returns an
|
|
109
|
+
* <code>InvalidObjectState</code> error. For information about restoring archived
|
|
110
|
+
* objects, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/restoring-objects.html">Restoring Archived
|
|
111
|
+
* Objects</a> in the <i>Amazon S3 User Guide</i>.</p>
|
|
100
112
|
* <p>
|
|
101
|
-
* <b>Directory buckets </b> -
|
|
113
|
+
* <b>Directory buckets </b> -
|
|
114
|
+
* For directory buckets, only the S3 Express One Zone storage class is supported to store newly created objects.
|
|
102
115
|
* Unsupported storage class values won't write a destination object and will respond with the HTTP status code <code>400 Bad Request</code>.</p>
|
|
103
116
|
* </dd>
|
|
104
117
|
* <dt>Encryption</dt>
|
|
105
118
|
* <dd>
|
|
106
|
-
* <p>Encryption request headers, like <code>x-amz-server-side-encryption</code>,
|
|
107
|
-
* be sent for the <code>GetObject</code> requests, if your object uses
|
|
108
|
-
*
|
|
109
|
-
*
|
|
119
|
+
* <p>Encryption request headers, like <code>x-amz-server-side-encryption</code>,
|
|
120
|
+
* should not be sent for the <code>GetObject</code> requests, if your object uses
|
|
121
|
+
* server-side encryption with Amazon S3 managed encryption keys (SSE-S3), server-side
|
|
122
|
+
* encryption with Key Management Service (KMS) keys (SSE-KMS), or dual-layer server-side
|
|
123
|
+
* encryption with Amazon Web Services KMS keys (DSSE-KMS). If you include the header in your
|
|
124
|
+
* <code>GetObject</code> requests for the object that uses these types of keys,
|
|
125
|
+
* you’ll get an HTTP <code>400 Bad Request</code> error.</p>
|
|
110
126
|
* <p>
|
|
111
|
-
* <b>Directory buckets</b> -
|
|
127
|
+
* <b>Directory buckets</b> -
|
|
128
|
+
* 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
|
|
112
129
|
* 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>
|
|
113
130
|
* </dd>
|
|
114
131
|
* <dt>Overriding response header values through the request</dt>
|
|
115
132
|
* <dd>
|
|
116
133
|
* <p>There are times when you want to override certain response header values of a
|
|
117
134
|
* <code>GetObject</code> response. For example, you might override the
|
|
118
|
-
* <code>Content-Disposition</code> response header value through your
|
|
119
|
-
*
|
|
120
|
-
* <p>You can override values for a set of response headers. These modified response
|
|
121
|
-
*
|
|
122
|
-
*
|
|
123
|
-
*
|
|
124
|
-
*
|
|
125
|
-
*
|
|
126
|
-
*
|
|
127
|
-
*
|
|
128
|
-
*
|
|
135
|
+
* <code>Content-Disposition</code> response header value through your
|
|
136
|
+
* <code>GetObject</code> request.</p>
|
|
137
|
+
* <p>You can override values for a set of response headers. These modified response
|
|
138
|
+
* header values are included only in a successful response, that is, when the HTTP
|
|
139
|
+
* status code <code>200 OK</code> is returned. The headers you can override using
|
|
140
|
+
* the following query parameters in the request are a subset of the headers that
|
|
141
|
+
* Amazon S3 accepts when you create an object. </p>
|
|
142
|
+
* <p>The response headers that you can override for the <code>GetObject</code>
|
|
143
|
+
* response are <code>Cache-Control</code>, <code>Content-Disposition</code>,
|
|
144
|
+
* <code>Content-Encoding</code>, <code>Content-Language</code>,
|
|
145
|
+
* <code>Content-Type</code>, and <code>Expires</code>.</p>
|
|
146
|
+
* <p>To override values for a set of response headers in the <code>GetObject</code>
|
|
147
|
+
* response, you can use the following query parameters in the request.</p>
|
|
129
148
|
* <ul>
|
|
130
149
|
* <li>
|
|
131
150
|
* <p>
|
|
@@ -159,9 +178,9 @@ declare const GetObjectCommand_base: {
|
|
|
159
178
|
* </li>
|
|
160
179
|
* </ul>
|
|
161
180
|
* <note>
|
|
162
|
-
* <p>When you use these parameters, you must sign the request by using either an
|
|
163
|
-
* presigned URL. These parameters cannot be used with
|
|
164
|
-
* unsigned (anonymous) request.</p>
|
|
181
|
+
* <p>When you use these parameters, you must sign the request by using either an
|
|
182
|
+
* Authorization header or a presigned URL. These parameters cannot be used with
|
|
183
|
+
* an unsigned (anonymous) request.</p>
|
|
165
184
|
* </note>
|
|
166
185
|
* </dd>
|
|
167
186
|
* <dt>HTTP Host header syntax</dt>
|
|
@@ -267,13 +286,13 @@ declare const GetObjectCommand_base: {
|
|
|
267
286
|
*
|
|
268
287
|
* @throws {@link InvalidObjectState} (client fault)
|
|
269
288
|
* <p>Object is archived and inaccessible until restored.</p>
|
|
270
|
-
* <p>If the object you are retrieving is stored in the S3 Glacier Flexible Retrieval storage
|
|
271
|
-
* S3 Glacier Deep Archive storage class, the S3 Intelligent-Tiering Archive Access
|
|
272
|
-
* S3 Intelligent-Tiering Deep Archive Access tier, before you can retrieve the object you
|
|
273
|
-
* copy using <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_RestoreObject.html">RestoreObject</a>. Otherwise, this
|
|
274
|
-
* <code>InvalidObjectState</code> error. For information about restoring
|
|
275
|
-
* see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/restoring-objects.html">Restoring
|
|
276
|
-
*
|
|
289
|
+
* <p>If the object you are retrieving is stored in the S3 Glacier Flexible Retrieval storage
|
|
290
|
+
* class, the S3 Glacier Deep Archive storage class, the S3 Intelligent-Tiering Archive Access
|
|
291
|
+
* tier, or the S3 Intelligent-Tiering Deep Archive Access tier, before you can retrieve the object you
|
|
292
|
+
* must first restore a copy using <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_RestoreObject.html">RestoreObject</a>. Otherwise, this
|
|
293
|
+
* operation returns an <code>InvalidObjectState</code> error. For information about restoring
|
|
294
|
+
* archived objects, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/restoring-objects.html">Restoring Archived Objects</a> in
|
|
295
|
+
* the <i>Amazon S3 User Guide</i>.</p>
|
|
277
296
|
*
|
|
278
297
|
* @throws {@link NoSuchKey} (client fault)
|
|
279
298
|
* <p>The specified key does not exist.</p>
|
|
@@ -28,7 +28,7 @@ declare const GetObjectLegalHoldCommand_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>Gets an object's current legal hold status. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/object-lock.html">Locking
|
|
34
34
|
* Objects</a>.</p>
|
|
@@ -28,7 +28,7 @@ declare const GetObjectLockConfigurationCommand_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>Gets the Object Lock configuration for a bucket. The rule specified in the Object Lock
|
|
34
34
|
* configuration will be applied by default to every new object placed in the specified
|
|
@@ -28,7 +28,7 @@ declare const GetObjectRetentionCommand_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>Retrieves an object's retention settings. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/object-lock.html">Locking
|
|
34
34
|
* Objects</a>.</p>
|
|
@@ -28,7 +28,7 @@ declare const GetObjectTaggingCommand_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 the tag-set of an object. You send the GET request against the tagging
|
|
34
34
|
* subresource associated with the object.</p>
|
|
@@ -29,7 +29,7 @@ declare const GetObjectTorrentCommand_base: {
|
|
|
29
29
|
};
|
|
30
30
|
/**
|
|
31
31
|
* <note>
|
|
32
|
-
* <p>This operation is not supported
|
|
32
|
+
* <p>This operation is not supported for directory buckets.</p>
|
|
33
33
|
* </note>
|
|
34
34
|
* <p>Returns torrent files from a bucket. BitTorrent can save you bandwidth when you're
|
|
35
35
|
* distributing large files.</p>
|
|
@@ -28,7 +28,7 @@ declare const GetPublicAccessBlockCommand_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>Retrieves the <code>PublicAccessBlock</code> configuration for an Amazon S3 bucket. To use
|
|
34
34
|
* this operation, you must have the <code>s3:GetBucketPublicAccessBlock</code> permission.
|