@aws-sdk/client-s3 3.258.0 → 3.261.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/endpoint/ruleset.js +3 -3
- package/dist-cjs/protocols/Aws_restXml.js +1 -1
- package/dist-es/endpoint/ruleset.js +3 -3
- package/dist-es/protocols/Aws_restXml.js +1 -1
- package/dist-types/S3.d.ts +41 -356
- package/dist-types/commands/CompleteMultipartUploadCommand.d.ts +0 -3
- package/dist-types/commands/CopyObjectCommand.d.ts +0 -2
- package/dist-types/commands/CreateBucketCommand.d.ts +0 -1
- package/dist-types/commands/CreateMultipartUploadCommand.d.ts +0 -12
- package/dist-types/commands/DeleteBucketAnalyticsConfigurationCommand.d.ts +0 -2
- package/dist-types/commands/DeleteBucketCommand.d.ts +0 -1
- package/dist-types/commands/DeleteBucketCorsCommand.d.ts +0 -1
- package/dist-types/commands/DeleteBucketEncryptionCommand.d.ts +0 -1
- package/dist-types/commands/DeleteBucketLifecycleCommand.d.ts +0 -2
- package/dist-types/commands/DeleteBucketMetricsConfigurationCommand.d.ts +0 -2
- package/dist-types/commands/DeleteBucketPolicyCommand.d.ts +0 -3
- package/dist-types/commands/DeleteBucketReplicationCommand.d.ts +0 -2
- package/dist-types/commands/DeleteBucketTaggingCommand.d.ts +0 -1
- package/dist-types/commands/DeleteBucketWebsiteCommand.d.ts +0 -3
- package/dist-types/commands/DeleteObjectCommand.d.ts +0 -5
- package/dist-types/commands/DeleteObjectTaggingCommand.d.ts +0 -3
- package/dist-types/commands/DeleteObjectsCommand.d.ts +0 -5
- package/dist-types/commands/DeletePublicAccessBlockCommand.d.ts +0 -1
- package/dist-types/commands/GetBucketAccelerateConfigurationCommand.d.ts +0 -1
- package/dist-types/commands/GetBucketAclCommand.d.ts +0 -1
- package/dist-types/commands/GetBucketAnalyticsConfigurationCommand.d.ts +0 -1
- package/dist-types/commands/GetBucketCorsCommand.d.ts +0 -3
- package/dist-types/commands/GetBucketInventoryConfigurationCommand.d.ts +0 -3
- package/dist-types/commands/GetBucketLifecycleConfigurationCommand.d.ts +0 -2
- package/dist-types/commands/GetBucketLocationCommand.d.ts +0 -3
- package/dist-types/commands/GetBucketLoggingCommand.d.ts +0 -1
- package/dist-types/commands/GetBucketMetricsConfigurationCommand.d.ts +0 -3
- package/dist-types/commands/GetBucketNotificationConfigurationCommand.d.ts +0 -3
- package/dist-types/commands/GetBucketPolicyCommand.d.ts +0 -4
- package/dist-types/commands/GetBucketPolicyStatusCommand.d.ts +0 -2
- package/dist-types/commands/GetBucketReplicationCommand.d.ts +0 -5
- package/dist-types/commands/GetBucketRequestPaymentCommand.d.ts +0 -1
- package/dist-types/commands/GetBucketTaggingCommand.d.ts +0 -2
- package/dist-types/commands/GetBucketVersioningCommand.d.ts +0 -2
- package/dist-types/commands/GetObjectAclCommand.d.ts +1 -1
- package/dist-types/commands/GetObjectAttributesCommand.d.ts +40 -46
- package/dist-types/commands/GetObjectCommand.d.ts +0 -20
- package/dist-types/commands/GetObjectLegalHoldCommand.d.ts +0 -1
- package/dist-types/commands/GetObjectLockConfigurationCommand.d.ts +0 -1
- package/dist-types/commands/GetObjectRetentionCommand.d.ts +0 -1
- package/dist-types/commands/GetObjectTaggingCommand.d.ts +0 -4
- package/dist-types/commands/GetPublicAccessBlockCommand.d.ts +0 -3
- package/dist-types/commands/HeadBucketCommand.d.ts +0 -5
- package/dist-types/commands/HeadObjectCommand.d.ts +0 -7
- package/dist-types/commands/ListBucketAnalyticsConfigurationsCommand.d.ts +0 -4
- package/dist-types/commands/ListBucketInventoryConfigurationsCommand.d.ts +0 -4
- package/dist-types/commands/ListBucketMetricsConfigurationsCommand.d.ts +0 -4
- package/dist-types/commands/ListMultipartUploadsCommand.d.ts +0 -5
- package/dist-types/commands/ListObjectsCommand.d.ts +0 -2
- package/dist-types/commands/ListObjectsV2Command.d.ts +0 -4
- package/dist-types/commands/ListPartsCommand.d.ts +0 -3
- package/dist-types/commands/PutBucketAccelerateConfigurationCommand.d.ts +0 -8
- package/dist-types/commands/PutBucketAclCommand.d.ts +0 -7
- package/dist-types/commands/PutBucketAnalyticsConfigurationCommand.d.ts +0 -11
- package/dist-types/commands/PutBucketCorsCommand.d.ts +0 -1
- package/dist-types/commands/PutBucketEncryptionCommand.d.ts +0 -1
- package/dist-types/commands/PutBucketIntelligentTieringConfigurationCommand.d.ts +0 -1
- package/dist-types/commands/PutBucketInventoryConfigurationCommand.d.ts +0 -2
- package/dist-types/commands/PutBucketLifecycleConfigurationCommand.d.ts +0 -15
- package/dist-types/commands/PutBucketLoggingCommand.d.ts +0 -9
- package/dist-types/commands/PutBucketMetricsConfigurationCommand.d.ts +0 -4
- package/dist-types/commands/PutBucketNotificationConfigurationCommand.d.ts +0 -8
- package/dist-types/commands/PutBucketPolicyCommand.d.ts +0 -3
- package/dist-types/commands/PutBucketReplicationCommand.d.ts +0 -8
- package/dist-types/commands/PutBucketRequestPaymentCommand.d.ts +0 -1
- package/dist-types/commands/PutBucketTaggingCommand.d.ts +0 -4
- package/dist-types/commands/PutBucketVersioningCommand.d.ts +0 -6
- package/dist-types/commands/PutBucketWebsiteCommand.d.ts +0 -4
- package/dist-types/commands/PutObjectAclCommand.d.ts +0 -3
- package/dist-types/commands/PutObjectCommand.d.ts +0 -8
- package/dist-types/commands/PutObjectTaggingCommand.d.ts +0 -12
- package/dist-types/commands/PutPublicAccessBlockCommand.d.ts +0 -6
- package/dist-types/commands/RestoreObjectCommand.d.ts +0 -1
- package/dist-types/commands/SelectObjectContentCommand.d.ts +0 -3
- package/dist-types/commands/UploadPartCommand.d.ts +0 -18
- package/dist-types/commands/UploadPartCopyCommand.d.ts +0 -10
- package/dist-types/models/models_0.d.ts +21 -50
- package/dist-types/models/models_1.d.ts +52 -53
- package/package.json +12 -12
|
@@ -11,98 +11,93 @@ export interface GetObjectAttributesCommandOutput extends GetObjectAttributesOut
|
|
|
11
11
|
* <p>Retrieves all the metadata from an object without returning the object itself. This
|
|
12
12
|
* action is useful if you're interested only in an object's metadata. To use
|
|
13
13
|
* <code>GetObjectAttributes</code>, you must have READ access to the object.</p>
|
|
14
|
-
*
|
|
15
|
-
* <p>
|
|
14
|
+
* <p>
|
|
16
15
|
* <code>GetObjectAttributes</code> combines the functionality of
|
|
17
16
|
* <code>GetObjectAcl</code>, <code>GetObjectLegalHold</code>,
|
|
18
17
|
* <code>GetObjectLockConfiguration</code>, <code>GetObjectRetention</code>,
|
|
19
18
|
* <code>GetObjectTagging</code>, <code>HeadObject</code>, and <code>ListParts</code>. All
|
|
20
19
|
* of the data returned with each of those individual calls can be returned with a single call
|
|
21
20
|
* to <code>GetObjectAttributes</code>.</p>
|
|
22
|
-
*
|
|
23
|
-
* <p>If you encrypt an object by using server-side encryption with customer-provided
|
|
21
|
+
* <p>If you encrypt an object by using server-side encryption with customer-provided
|
|
24
22
|
* encryption keys (SSE-C) when you store the object in Amazon S3, then when you retrieve the
|
|
25
23
|
* metadata from the object, you must use the following headers:</p>
|
|
26
|
-
*
|
|
24
|
+
* <ul>
|
|
27
25
|
* <li>
|
|
28
|
-
*
|
|
26
|
+
* <p>
|
|
29
27
|
* <code>x-amz-server-side-encryption-customer-algorithm</code>
|
|
30
28
|
* </p>
|
|
31
29
|
* </li>
|
|
32
30
|
* <li>
|
|
33
|
-
*
|
|
31
|
+
* <p>
|
|
34
32
|
* <code>x-amz-server-side-encryption-customer-key</code>
|
|
35
33
|
* </p>
|
|
36
34
|
* </li>
|
|
37
35
|
* <li>
|
|
38
|
-
*
|
|
36
|
+
* <p>
|
|
39
37
|
* <code>x-amz-server-side-encryption-customer-key-MD5</code>
|
|
40
38
|
* </p>
|
|
41
39
|
* </li>
|
|
42
40
|
* </ul>
|
|
43
|
-
*
|
|
41
|
+
* <p>For more information about SSE-C, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/ServerSideEncryptionCustomerKeys.html">Server-Side Encryption
|
|
44
42
|
* (Using Customer-Provided Encryption Keys)</a> in the
|
|
45
43
|
* <i>Amazon S3 User Guide</i>.</p>
|
|
46
|
-
*
|
|
44
|
+
* <note>
|
|
47
45
|
* <ul>
|
|
48
46
|
* <li>
|
|
49
|
-
*
|
|
47
|
+
* <p>Encryption request headers, such as
|
|
50
48
|
* <code>x-amz-server-side-encryption</code>, should not be sent for GET requests
|
|
51
49
|
* if your object uses server-side encryption with Amazon Web Services KMS keys stored in Amazon Web Services Key
|
|
52
50
|
* Management Service (SSE-KMS) or server-side encryption with Amazon S3 managed
|
|
53
51
|
* encryption keys (SSE-S3). If your object does use these types of keys, you'll get
|
|
54
52
|
* an HTTP <code>400 Bad Request</code> error.</p>
|
|
55
|
-
*
|
|
53
|
+
* </li>
|
|
56
54
|
* <li>
|
|
57
55
|
* <p>
|
|
58
56
|
* The last modified property in this case is the creation date of the object.</p>
|
|
59
|
-
*
|
|
57
|
+
* </li>
|
|
60
58
|
* </ul>
|
|
61
|
-
*
|
|
62
|
-
*
|
|
63
|
-
*
|
|
64
|
-
* <ul>
|
|
59
|
+
* </note>
|
|
60
|
+
* <p>Consider the following when using request headers:</p>
|
|
61
|
+
* <ul>
|
|
65
62
|
* <li>
|
|
66
|
-
*
|
|
63
|
+
* <p> If both of the <code>If-Match</code> and <code>If-Unmodified-Since</code>
|
|
67
64
|
* headers are present in the request as follows, then Amazon S3 returns the HTTP
|
|
68
65
|
* status code <code>200 OK</code> and the data requested:</p>
|
|
69
|
-
*
|
|
66
|
+
* <ul>
|
|
70
67
|
* <li>
|
|
71
68
|
* <p>
|
|
72
69
|
* <code>If-Match</code> condition evaluates to <code>true</code>.</p>
|
|
73
70
|
* </li>
|
|
74
71
|
* <li>
|
|
75
|
-
*
|
|
72
|
+
* <p>
|
|
76
73
|
* <code>If-Unmodified-Since</code> condition evaluates to
|
|
77
74
|
* <code>false</code>.</p>
|
|
78
|
-
*
|
|
75
|
+
* </li>
|
|
79
76
|
* </ul>
|
|
80
77
|
* </li>
|
|
81
78
|
* <li>
|
|
82
|
-
*
|
|
79
|
+
* <p>If both of the <code>If-None-Match</code> and <code>If-Modified-Since</code>
|
|
83
80
|
* headers are present in the request as follows, then Amazon S3 returns the HTTP status code
|
|
84
81
|
* <code>304 Not Modified</code>:</p>
|
|
85
|
-
*
|
|
82
|
+
* <ul>
|
|
86
83
|
* <li>
|
|
87
|
-
*
|
|
84
|
+
* <p>
|
|
88
85
|
* <code>If-None-Match</code> condition evaluates to
|
|
89
86
|
* <code>false</code>.</p>
|
|
90
|
-
*
|
|
87
|
+
* </li>
|
|
91
88
|
* <li>
|
|
92
|
-
*
|
|
89
|
+
* <p>
|
|
93
90
|
* <code>If-Modified-Since</code> condition evaluates to
|
|
94
91
|
* <code>true</code>.</p>
|
|
95
|
-
*
|
|
92
|
+
* </li>
|
|
96
93
|
* </ul>
|
|
97
94
|
* </li>
|
|
98
95
|
* </ul>
|
|
99
|
-
*
|
|
100
|
-
*
|
|
101
|
-
*
|
|
102
|
-
* <p>
|
|
96
|
+
* <p>For more information about conditional requests, see <a href="https://tools.ietf.org/html/rfc7232">RFC 7232</a>.</p>
|
|
97
|
+
* <p>
|
|
103
98
|
* <b>Permissions</b>
|
|
104
99
|
* </p>
|
|
105
|
-
*
|
|
100
|
+
* <p>The permissions that you need to use this operation depend on whether the bucket is
|
|
106
101
|
* versioned. If the bucket is versioned, you need both the <code>s3:GetObjectVersion</code>
|
|
107
102
|
* and <code>s3:GetObjectVersionAttributes</code> permissions for this operation. If the
|
|
108
103
|
* bucket is not versioned, you need the <code>s3:GetObject</code> and
|
|
@@ -110,56 +105,55 @@ export interface GetObjectAttributesCommandOutput extends GetObjectAttributesOut
|
|
|
110
105
|
* Permissions in a Policy</a> in the <i>Amazon S3 User Guide</i>. If the
|
|
111
106
|
* object that you request does not exist, the error Amazon S3 returns depends on whether you also
|
|
112
107
|
* have the <code>s3:ListBucket</code> permission.</p>
|
|
113
|
-
*
|
|
108
|
+
* <ul>
|
|
114
109
|
* <li>
|
|
115
|
-
*
|
|
110
|
+
* <p>If you have the <code>s3:ListBucket</code> permission on the bucket, Amazon S3
|
|
116
111
|
* returns an HTTP status code <code>404 Not Found</code> ("no such key") error.</p>
|
|
117
112
|
* </li>
|
|
118
113
|
* <li>
|
|
119
|
-
*
|
|
114
|
+
* <p>If you don't have the <code>s3:ListBucket</code> permission, Amazon S3 returns an
|
|
120
115
|
* HTTP status code <code>403 Forbidden</code> ("access denied") error.</p>
|
|
121
116
|
* </li>
|
|
122
117
|
* </ul>
|
|
123
|
-
*
|
|
124
|
-
*
|
|
125
|
-
* <ul>
|
|
118
|
+
* <p>The following actions are related to <code>GetObjectAttributes</code>:</p>
|
|
119
|
+
* <ul>
|
|
126
120
|
* <li>
|
|
127
|
-
*
|
|
121
|
+
* <p>
|
|
128
122
|
* <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObject.html">GetObject</a>
|
|
129
123
|
* </p>
|
|
130
124
|
* </li>
|
|
131
125
|
* <li>
|
|
132
|
-
*
|
|
126
|
+
* <p>
|
|
133
127
|
* <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObjectAcl.html">GetObjectAcl</a>
|
|
134
128
|
* </p>
|
|
135
129
|
* </li>
|
|
136
130
|
* <li>
|
|
137
|
-
*
|
|
131
|
+
* <p>
|
|
138
132
|
* <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObjectLegalHold.html">GetObjectLegalHold</a>
|
|
139
133
|
* </p>
|
|
140
134
|
* </li>
|
|
141
135
|
* <li>
|
|
142
|
-
*
|
|
136
|
+
* <p>
|
|
143
137
|
* <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObjectLockConfiguration.html">GetObjectLockConfiguration</a>
|
|
144
138
|
* </p>
|
|
145
139
|
* </li>
|
|
146
140
|
* <li>
|
|
147
|
-
*
|
|
141
|
+
* <p>
|
|
148
142
|
* <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObjectRetention.html">GetObjectRetention</a>
|
|
149
143
|
* </p>
|
|
150
144
|
* </li>
|
|
151
145
|
* <li>
|
|
152
|
-
*
|
|
146
|
+
* <p>
|
|
153
147
|
* <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObjectTagging.html">GetObjectTagging</a>
|
|
154
148
|
* </p>
|
|
155
149
|
* </li>
|
|
156
150
|
* <li>
|
|
157
|
-
*
|
|
151
|
+
* <p>
|
|
158
152
|
* <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_HeadObject.html">HeadObject</a>
|
|
159
153
|
* </p>
|
|
160
154
|
* </li>
|
|
161
155
|
* <li>
|
|
162
|
-
*
|
|
156
|
+
* <p>
|
|
163
157
|
* <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListParts.html">ListParts</a>
|
|
164
158
|
* </p>
|
|
165
159
|
* </li>
|
|
@@ -11,12 +11,10 @@ export interface GetObjectCommandOutput extends __WithSdkStreamMixin<GetObjectOu
|
|
|
11
11
|
* <p>Retrieves objects from Amazon S3. To use <code>GET</code>, you must have <code>READ</code>
|
|
12
12
|
* access to the object. If you grant <code>READ</code> access to the anonymous user, you can
|
|
13
13
|
* return the object without using an authorization header.</p>
|
|
14
|
-
*
|
|
15
14
|
* <p>An Amazon S3 bucket has no directory hierarchy such as you would find in a typical computer
|
|
16
15
|
* file system. You can, however, create a logical hierarchy by using object key names that
|
|
17
16
|
* imply a folder structure. For example, instead of naming an object <code>sample.jpg</code>,
|
|
18
17
|
* you can name it <code>photos/2006/February/sample.jpg</code>.</p>
|
|
19
|
-
*
|
|
20
18
|
* <p>To get an object from such a logical hierarchy, specify the full key name for the object
|
|
21
19
|
* in the <code>GET</code> operation. For a virtual hosted-style request example, if you have
|
|
22
20
|
* the object <code>photos/2006/February/sample.jpg</code>, specify the resource as
|
|
@@ -25,9 +23,7 @@ export interface GetObjectCommandOutput extends __WithSdkStreamMixin<GetObjectOu
|
|
|
25
23
|
* <code>examplebucket</code>, specify the resource as
|
|
26
24
|
* <code>/examplebucket/photos/2006/February/sample.jpg</code>. For more information about
|
|
27
25
|
* request types, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/VirtualHosting.html#VirtualHostingSpecifyBucket">HTTP Host Header Bucket Specification</a>.</p>
|
|
28
|
-
*
|
|
29
26
|
* <p>For more information about returning the ACL of an object, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObjectAcl.html">GetObjectAcl</a>.</p>
|
|
30
|
-
*
|
|
31
27
|
* <p>If the object you are retrieving is stored in the S3 Glacier or
|
|
32
28
|
* S3 Glacier Deep Archive storage class, or S3 Intelligent-Tiering Archive or
|
|
33
29
|
* S3 Intelligent-Tiering Deep Archive tiers, before you can retrieve the object you must first restore a
|
|
@@ -35,7 +31,6 @@ export interface GetObjectCommandOutput extends __WithSdkStreamMixin<GetObjectOu
|
|
|
35
31
|
* <code>InvalidObjectStateError</code> error. For information about restoring archived
|
|
36
32
|
* objects, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/restoring-objects.html">Restoring Archived
|
|
37
33
|
* Objects</a>.</p>
|
|
38
|
-
*
|
|
39
34
|
* <p>Encryption request headers, like <code>x-amz-server-side-encryption</code>, should not
|
|
40
35
|
* be sent for GET requests if your object uses server-side encryption with KMS keys (SSE-KMS)
|
|
41
36
|
* or server-side encryption with Amazon S3–managed encryption keys (SSE-S3). If your
|
|
@@ -56,12 +51,10 @@ export interface GetObjectCommandOutput extends __WithSdkStreamMixin<GetObjectOu
|
|
|
56
51
|
* </ul>
|
|
57
52
|
* <p>For more information about SSE-C, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/ServerSideEncryptionCustomerKeys.html">Server-Side Encryption (Using
|
|
58
53
|
* Customer-Provided Encryption Keys)</a>.</p>
|
|
59
|
-
*
|
|
60
54
|
* <p>Assuming you have the relevant permission to read object tags, the response also returns the
|
|
61
55
|
* <code>x-amz-tagging-count</code> header that provides the count of number of tags
|
|
62
56
|
* associated with the object. You can use <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObjectTagging.html">GetObjectTagging</a> to retrieve
|
|
63
57
|
* the tag set associated with an object.</p>
|
|
64
|
-
*
|
|
65
58
|
* <p>
|
|
66
59
|
* <b>Permissions</b>
|
|
67
60
|
* </p>
|
|
@@ -79,14 +72,11 @@ export interface GetObjectCommandOutput extends __WithSdkStreamMixin<GetObjectOu
|
|
|
79
72
|
* HTTP status code 403 ("access denied") error.</p>
|
|
80
73
|
* </li>
|
|
81
74
|
* </ul>
|
|
82
|
-
*
|
|
83
|
-
*
|
|
84
75
|
* <p>
|
|
85
76
|
* <b>Versioning</b>
|
|
86
77
|
* </p>
|
|
87
78
|
* <p>By default, the GET action returns the current version of an object. To return a
|
|
88
79
|
* different version, use the <code>versionId</code> subresource.</p>
|
|
89
|
-
*
|
|
90
80
|
* <note>
|
|
91
81
|
* <ul>
|
|
92
82
|
* <li>
|
|
@@ -103,17 +93,13 @@ export interface GetObjectCommandOutput extends __WithSdkStreamMixin<GetObjectOu
|
|
|
103
93
|
* </li>
|
|
104
94
|
* </ul>
|
|
105
95
|
* </note>
|
|
106
|
-
*
|
|
107
|
-
*
|
|
108
96
|
* <p>For more information about versioning, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketVersioning.html">PutBucketVersioning</a>. </p>
|
|
109
|
-
*
|
|
110
97
|
* <p>
|
|
111
98
|
* <b>Overriding Response Header Values</b>
|
|
112
99
|
* </p>
|
|
113
100
|
* <p>There are times when you want to override certain response header values in a GET
|
|
114
101
|
* response. For example, you might override the <code>Content-Disposition</code> response
|
|
115
102
|
* header value in your GET request.</p>
|
|
116
|
-
*
|
|
117
103
|
* <p>You can override values for a set of response headers using the following query
|
|
118
104
|
* parameters. These response header values are sent only on a successful request, that is,
|
|
119
105
|
* when status code 200 OK is returned. The set of headers you can override using these
|
|
@@ -122,7 +108,6 @@ export interface GetObjectCommandOutput extends __WithSdkStreamMixin<GetObjectOu
|
|
|
122
108
|
* <code>Content-Language</code>, <code>Expires</code>, <code>Cache-Control</code>,
|
|
123
109
|
* <code>Content-Disposition</code>, and <code>Content-Encoding</code>. To override these
|
|
124
110
|
* header values in the GET response, you use the following request parameters.</p>
|
|
125
|
-
*
|
|
126
111
|
* <note>
|
|
127
112
|
* <p>You must sign the request, either using an Authorization header or a presigned URL,
|
|
128
113
|
* when using these parameters. They cannot be used with an unsigned (anonymous)
|
|
@@ -160,23 +145,18 @@ export interface GetObjectCommandOutput extends __WithSdkStreamMixin<GetObjectOu
|
|
|
160
145
|
* </p>
|
|
161
146
|
* </li>
|
|
162
147
|
* </ul>
|
|
163
|
-
*
|
|
164
148
|
* <p>
|
|
165
149
|
* <b>Additional Considerations about Request Headers</b>
|
|
166
150
|
* </p>
|
|
167
|
-
*
|
|
168
151
|
* <p>If both of the <code>If-Match</code> and <code>If-Unmodified-Since</code> headers are
|
|
169
152
|
* present in the request as follows: <code>If-Match</code> condition evaluates to
|
|
170
153
|
* <code>true</code>, and; <code>If-Unmodified-Since</code> condition evaluates to
|
|
171
154
|
* <code>false</code>; then, S3 returns 200 OK and the data requested. </p>
|
|
172
|
-
*
|
|
173
155
|
* <p>If both of the <code>If-None-Match</code> and <code>If-Modified-Since</code> headers are
|
|
174
156
|
* present in the request as follows:<code> If-None-Match</code> condition evaluates to
|
|
175
157
|
* <code>false</code>, and; <code>If-Modified-Since</code> condition evaluates to
|
|
176
158
|
* <code>true</code>; then, S3 returns 304 Not Modified response code.</p>
|
|
177
|
-
*
|
|
178
159
|
* <p>For more information about conditional requests, see <a href="https://tools.ietf.org/html/rfc7232">RFC 7232</a>.</p>
|
|
179
|
-
*
|
|
180
160
|
* <p>The following operations are related to <code>GetObject</code>:</p>
|
|
181
161
|
* <ul>
|
|
182
162
|
* <li>
|
|
@@ -11,7 +11,6 @@ export interface GetObjectLegalHoldCommandOutput extends GetObjectLegalHoldOutpu
|
|
|
11
11
|
* <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
|
|
12
12
|
* Objects</a>.</p>
|
|
13
13
|
* <p>This action is not supported by Amazon S3 on Outposts.</p>
|
|
14
|
-
*
|
|
15
14
|
* <p>The following action is related to <code>GetObjectLegalHold</code>:</p>
|
|
16
15
|
* <ul>
|
|
17
16
|
* <li>
|
|
@@ -12,7 +12,6 @@ export interface GetObjectLockConfigurationCommandOutput extends GetObjectLockCo
|
|
|
12
12
|
* configuration will be applied by default to every new object placed in the specified
|
|
13
13
|
* bucket. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/object-lock.html">Locking
|
|
14
14
|
* Objects</a>.</p>
|
|
15
|
-
*
|
|
16
15
|
* <p>The following action is related to <code>GetObjectLockConfiguration</code>:</p>
|
|
17
16
|
* <ul>
|
|
18
17
|
* <li>
|
|
@@ -10,7 +10,6 @@ export interface GetObjectRetentionCommandOutput extends GetObjectRetentionOutpu
|
|
|
10
10
|
/**
|
|
11
11
|
* <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 Objects</a>.</p>
|
|
12
12
|
* <p>This action is not supported by Amazon S3 on Outposts.</p>
|
|
13
|
-
*
|
|
14
13
|
* <p>The following action is related to <code>GetObjectRetention</code>:</p>
|
|
15
14
|
* <ul>
|
|
16
15
|
* <li>
|
|
@@ -10,19 +10,15 @@ export interface GetObjectTaggingCommandOutput extends GetObjectTaggingOutput, _
|
|
|
10
10
|
/**
|
|
11
11
|
* <p>Returns the tag-set of an object. You send the GET request against the tagging
|
|
12
12
|
* subresource associated with the object.</p>
|
|
13
|
-
*
|
|
14
13
|
* <p>To use this operation, you must have permission to perform the
|
|
15
14
|
* <code>s3:GetObjectTagging</code> action. By default, the GET action returns
|
|
16
15
|
* information about current version of an object. For a versioned bucket, you can have
|
|
17
16
|
* multiple versions of an object in your bucket. To retrieve tags of any other version, use
|
|
18
17
|
* the versionId query parameter. You also need permission for the
|
|
19
18
|
* <code>s3:GetObjectVersionTagging</code> action.</p>
|
|
20
|
-
*
|
|
21
19
|
* <p> By default, the bucket owner has this permission and can grant this permission to
|
|
22
20
|
* others.</p>
|
|
23
|
-
*
|
|
24
21
|
* <p> For information about the Amazon S3 object tagging feature, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/object-tagging.html">Object Tagging</a>.</p>
|
|
25
|
-
*
|
|
26
22
|
* <p>The following actions are related to <code>GetObjectTagging</code>:</p>
|
|
27
23
|
* <ul>
|
|
28
24
|
* <li>
|
|
@@ -12,7 +12,6 @@ export interface GetPublicAccessBlockCommandOutput extends GetPublicAccessBlockO
|
|
|
12
12
|
* this operation, you must have the <code>s3:GetBucketPublicAccessBlock</code> permission.
|
|
13
13
|
* For more information about Amazon S3 permissions, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/using-with-s3-actions.html">Specifying Permissions in a
|
|
14
14
|
* Policy</a>.</p>
|
|
15
|
-
*
|
|
16
15
|
* <important>
|
|
17
16
|
* <p>When Amazon S3 evaluates the <code>PublicAccessBlock</code> configuration for a bucket or
|
|
18
17
|
* an object, it checks the <code>PublicAccessBlock</code> configuration for both the
|
|
@@ -21,9 +20,7 @@ export interface GetPublicAccessBlockCommandOutput extends GetPublicAccessBlockO
|
|
|
21
20
|
* account, Amazon S3 uses the most restrictive combination of the bucket-level and
|
|
22
21
|
* account-level settings.</p>
|
|
23
22
|
* </important>
|
|
24
|
-
*
|
|
25
23
|
* <p>For more information about when Amazon S3 considers a bucket or an object public, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/access-control-block-public-access.html#access-control-block-public-access-policy-status">The Meaning of "Public"</a>.</p>
|
|
26
|
-
*
|
|
27
24
|
* <p>The following operations are related to <code>GetPublicAccessBlock</code>:</p>
|
|
28
25
|
* <ul>
|
|
29
26
|
* <li>
|
|
@@ -11,18 +11,13 @@ export interface HeadBucketCommandOutput extends __MetadataBearer {
|
|
|
11
11
|
* <p>This action is useful to determine if a bucket exists and you have permission to
|
|
12
12
|
* access it. The action returns a <code>200 OK</code> if the bucket exists and you have
|
|
13
13
|
* permission to access it.</p>
|
|
14
|
-
*
|
|
15
|
-
*
|
|
16
14
|
* <p>If the bucket does not exist or you do not have permission to access it, the <code>HEAD</code> request
|
|
17
15
|
* returns a generic <code>404 Not Found</code> or <code>403 Forbidden</code> code. A message body is not
|
|
18
16
|
* included, so you cannot determine the exception beyond these error codes.</p>
|
|
19
|
-
*
|
|
20
17
|
* <p>To use this operation, you must have permissions to perform the
|
|
21
18
|
* <code>s3:ListBucket</code> action. The bucket owner has this permission by default and
|
|
22
19
|
* can grant this permission to others. For more information about permissions, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources">Permissions Related to Bucket Subresource Operations</a> and <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html">Managing Access Permissions to Your Amazon S3
|
|
23
20
|
* Resources</a>.</p>
|
|
24
|
-
*
|
|
25
|
-
*
|
|
26
21
|
* <p>To use this API against an access point, you must provide the alias of the access point in place of the bucket name or specify the access point ARN. When using the access point ARN, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using the Amazon Web Services SDKs, you provide the ARN in place of the bucket name. For more information see, <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html">Using access points</a>.</p>
|
|
27
22
|
* @example
|
|
28
23
|
* Use a bare-bones client and the command you need to make an API call.
|
|
@@ -11,13 +11,11 @@ export interface HeadObjectCommandOutput extends HeadObjectOutput, __MetadataBea
|
|
|
11
11
|
* <p>The HEAD action retrieves metadata from an object without returning the object
|
|
12
12
|
* itself. This action is useful if you're only interested in an object's metadata. To use
|
|
13
13
|
* HEAD, you must have READ access to the object.</p>
|
|
14
|
-
*
|
|
15
14
|
* <p>A <code>HEAD</code> request has the same options as a <code>GET</code> action on an
|
|
16
15
|
* object. The response is identical to the <code>GET</code> response except that there is no
|
|
17
16
|
* response body. Because of this, if the <code>HEAD</code> request generates an error, it
|
|
18
17
|
* returns a generic <code>404 Not Found</code> or <code>403 Forbidden</code> code. It is not
|
|
19
18
|
* possible to retrieve the exact exception beyond these error codes.</p>
|
|
20
|
-
*
|
|
21
19
|
* <p>If you encrypt an object by using server-side encryption with customer-provided
|
|
22
20
|
* encryption keys (SSE-C) when you store the object in Amazon S3, then when you retrieve the
|
|
23
21
|
* metadata from the object, you must use the following headers:</p>
|
|
@@ -49,8 +47,6 @@ export interface HeadObjectCommandOutput extends HeadObjectOutput, __MetadataBea
|
|
|
49
47
|
* </li>
|
|
50
48
|
* </ul>
|
|
51
49
|
* </note>
|
|
52
|
-
*
|
|
53
|
-
*
|
|
54
50
|
* <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 Request
|
|
55
51
|
* Headers</a>.</p>
|
|
56
52
|
* <p>Consider the following when using request headers:</p>
|
|
@@ -91,9 +87,7 @@ export interface HeadObjectCommandOutput extends HeadObjectOutput, __MetadataBea
|
|
|
91
87
|
* <p>Then Amazon S3 returns the <code>304 Not Modified</code> response code.</p>
|
|
92
88
|
* </li>
|
|
93
89
|
* </ul>
|
|
94
|
-
*
|
|
95
90
|
* <p>For more information about conditional requests, see <a href="https://tools.ietf.org/html/rfc7232">RFC 7232</a>.</p>
|
|
96
|
-
*
|
|
97
91
|
* <p>
|
|
98
92
|
* <b>Permissions</b>
|
|
99
93
|
* </p>
|
|
@@ -111,7 +105,6 @@ export interface HeadObjectCommandOutput extends HeadObjectOutput, __MetadataBea
|
|
|
111
105
|
* status code 403 ("access denied") error.</p>
|
|
112
106
|
* </li>
|
|
113
107
|
* </ul>
|
|
114
|
-
*
|
|
115
108
|
* <p>The following actions are related to <code>HeadObject</code>:</p>
|
|
116
109
|
* <ul>
|
|
117
110
|
* <li>
|
|
@@ -10,7 +10,6 @@ export interface ListBucketAnalyticsConfigurationsCommandOutput extends ListBuck
|
|
|
10
10
|
/**
|
|
11
11
|
* <p>Lists the analytics configurations for the bucket. You can have up to 1,000 analytics
|
|
12
12
|
* configurations per bucket.</p>
|
|
13
|
-
*
|
|
14
13
|
* <p>This action supports list pagination and does not return more than 100 configurations
|
|
15
14
|
* at a time. You should always check the <code>IsTruncated</code> element in the response. If
|
|
16
15
|
* there are no more configurations to list, <code>IsTruncated</code> is set to false. If
|
|
@@ -19,16 +18,13 @@ export interface ListBucketAnalyticsConfigurationsCommandOutput extends ListBuck
|
|
|
19
18
|
* <code>NextContinuationToken</code> value to continue the pagination of the list by
|
|
20
19
|
* passing the value in continuation-token in the request to <code>GET</code> the next
|
|
21
20
|
* page.</p>
|
|
22
|
-
*
|
|
23
21
|
* <p>To use this operation, you must have permissions to perform the
|
|
24
22
|
* <code>s3:GetAnalyticsConfiguration</code> action. The bucket owner has this permission
|
|
25
23
|
* by default. The bucket owner can grant this permission to others. For more information
|
|
26
24
|
* 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
|
|
27
25
|
* Resources</a>.</p>
|
|
28
|
-
*
|
|
29
26
|
* <p>For information about Amazon S3 analytics feature, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/analytics-storage-class.html">Amazon S3 Analytics – Storage Class
|
|
30
27
|
* Analysis</a>. </p>
|
|
31
|
-
*
|
|
32
28
|
* <p>The following operations are related to
|
|
33
29
|
* <code>ListBucketAnalyticsConfigurations</code>:</p>
|
|
34
30
|
* <ul>
|
|
@@ -10,7 +10,6 @@ export interface ListBucketInventoryConfigurationsCommandOutput extends ListBuck
|
|
|
10
10
|
/**
|
|
11
11
|
* <p>Returns a list of inventory configurations for the bucket. You can have up to 1,000
|
|
12
12
|
* analytics configurations per bucket.</p>
|
|
13
|
-
*
|
|
14
13
|
* <p>This action supports list pagination and does not return more than 100 configurations
|
|
15
14
|
* at a time. Always check the <code>IsTruncated</code> element in the response. If there are
|
|
16
15
|
* no more configurations to list, <code>IsTruncated</code> is set to false. If there are more
|
|
@@ -18,16 +17,13 @@ export interface ListBucketInventoryConfigurationsCommandOutput extends ListBuck
|
|
|
18
17
|
* <code>NextContinuationToken</code>. You use the <code>NextContinuationToken</code> value
|
|
19
18
|
* to continue the pagination of the list by passing the value in continuation-token in the
|
|
20
19
|
* request to <code>GET</code> the next page.</p>
|
|
21
|
-
*
|
|
22
20
|
* <p> To use this operation, you must have permissions to perform the
|
|
23
21
|
* <code>s3:GetInventoryConfiguration</code> action. The bucket owner has this permission
|
|
24
22
|
* by default. The bucket owner can grant this permission to others. For more information
|
|
25
23
|
* 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
|
|
26
24
|
* Resources</a>.</p>
|
|
27
|
-
*
|
|
28
25
|
* <p>For information about the Amazon S3 inventory feature, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/storage-inventory.html">Amazon S3 Inventory</a>
|
|
29
26
|
* </p>
|
|
30
|
-
*
|
|
31
27
|
* <p>The following operations are related to
|
|
32
28
|
* <code>ListBucketInventoryConfigurations</code>:</p>
|
|
33
29
|
* <ul>
|
|
@@ -11,7 +11,6 @@ export interface ListBucketMetricsConfigurationsCommandOutput extends ListBucket
|
|
|
11
11
|
* <p>Lists the metrics configurations for the bucket. The metrics configurations are only for
|
|
12
12
|
* the request metrics of the bucket and do not provide information on daily storage metrics.
|
|
13
13
|
* You can have up to 1,000 configurations per bucket.</p>
|
|
14
|
-
*
|
|
15
14
|
* <p>This action supports list pagination and does not return more than 100 configurations
|
|
16
15
|
* at a time. Always check the <code>IsTruncated</code> element in the response. If there are
|
|
17
16
|
* no more configurations to list, <code>IsTruncated</code> is set to false. If there are more
|
|
@@ -19,17 +18,14 @@ export interface ListBucketMetricsConfigurationsCommandOutput extends ListBucket
|
|
|
19
18
|
* <code>NextContinuationToken</code>. You use the <code>NextContinuationToken</code> value
|
|
20
19
|
* to continue the pagination of the list by passing the value in
|
|
21
20
|
* <code>continuation-token</code> in the request to <code>GET</code> the next page.</p>
|
|
22
|
-
*
|
|
23
21
|
* <p>To use this operation, you must have permissions to perform the
|
|
24
22
|
* <code>s3:GetMetricsConfiguration</code> action. The bucket owner has this permission by
|
|
25
23
|
* default. The bucket owner can grant this permission to others. For more information about
|
|
26
24
|
* 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
|
|
27
25
|
* Resources</a>.</p>
|
|
28
|
-
*
|
|
29
26
|
* <p>For more information about metrics configurations and CloudWatch request metrics, see
|
|
30
27
|
* <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/cloudwatch-monitoring.html">Monitoring Metrics with Amazon
|
|
31
28
|
* CloudWatch</a>.</p>
|
|
32
|
-
*
|
|
33
29
|
* <p>The following operations are related to
|
|
34
30
|
* <code>ListBucketMetricsConfigurations</code>:</p>
|
|
35
31
|
* <ul>
|
|
@@ -11,7 +11,6 @@ export interface ListMultipartUploadsCommandOutput extends ListMultipartUploadsO
|
|
|
11
11
|
* <p>This action lists in-progress multipart uploads. An in-progress multipart upload is a
|
|
12
12
|
* multipart upload that has been initiated using the Initiate Multipart Upload request, but
|
|
13
13
|
* has not yet been completed or aborted.</p>
|
|
14
|
-
*
|
|
15
14
|
* <p>This action returns at most 1,000 multipart uploads in the response. 1,000 multipart
|
|
16
15
|
* uploads is the maximum number of uploads a response can include, which is also the default
|
|
17
16
|
* value. You can further limit the number of uploads in a response by specifying the
|
|
@@ -19,18 +18,14 @@ export interface ListMultipartUploadsCommandOutput extends ListMultipartUploadsO
|
|
|
19
18
|
* satisfy the list criteria, the response will contain an <code>IsTruncated</code> element
|
|
20
19
|
* with the value true. To list the additional multipart uploads, use the
|
|
21
20
|
* <code>key-marker</code> and <code>upload-id-marker</code> request parameters.</p>
|
|
22
|
-
*
|
|
23
21
|
* <p>In the response, the uploads are sorted by key. If your application has initiated more
|
|
24
22
|
* than one multipart upload using the same object key, then uploads in the response are first
|
|
25
23
|
* sorted by key. Additionally, uploads are sorted in ascending order within each key by the
|
|
26
24
|
* upload initiation time.</p>
|
|
27
|
-
*
|
|
28
25
|
* <p>For more information on multipart uploads, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/uploadobjusingmpu.html">Uploading Objects Using Multipart
|
|
29
26
|
* Upload</a>.</p>
|
|
30
|
-
*
|
|
31
27
|
* <p>For information on permissions required to use the multipart upload API, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/mpuAndPermissions.html">Multipart Upload and
|
|
32
28
|
* Permissions</a>.</p>
|
|
33
|
-
*
|
|
34
29
|
* <p>The following operations are related to <code>ListMultipartUploads</code>:</p>
|
|
35
30
|
* <ul>
|
|
36
31
|
* <li>
|
|
@@ -16,8 +16,6 @@ export interface ListObjectsCommandOutput extends ListObjectsOutput, __MetadataB
|
|
|
16
16
|
* <p>This action has been revised. We recommend that you use the newer version, <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListObjectsV2.html">ListObjectsV2</a>, when developing applications. For backward compatibility,
|
|
17
17
|
* Amazon S3 continues to support <code>ListObjects</code>.</p>
|
|
18
18
|
* </important>
|
|
19
|
-
*
|
|
20
|
-
*
|
|
21
19
|
* <p>The following operations are related to <code>ListObjects</code>:</p>
|
|
22
20
|
* <ul>
|
|
23
21
|
* <li>
|
|
@@ -16,9 +16,7 @@ export interface ListObjectsV2CommandOutput extends ListObjectsV2Output, __Metad
|
|
|
16
16
|
* For more information about listing objects, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/ListingKeysUsingAPIs.html">Listing object keys
|
|
17
17
|
* programmatically</a>
|
|
18
18
|
* </p>
|
|
19
|
-
*
|
|
20
19
|
* <p>To use this operation, you must have READ access to the bucket.</p>
|
|
21
|
-
*
|
|
22
20
|
* <p>To use this action in an Identity and Access Management (IAM) policy, you must
|
|
23
21
|
* have permissions to perform the <code>s3:ListBucket</code> action. The bucket owner has
|
|
24
22
|
* this permission by default and can grant this permission to others. For more information
|
|
@@ -29,9 +27,7 @@ export interface ListObjectsV2CommandOutput extends ListObjectsV2Output, __Metad
|
|
|
29
27
|
* revised API for application development. For backward compatibility, Amazon S3 continues to
|
|
30
28
|
* support the prior version of this API, <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListObjects.html">ListObjects</a>.</p>
|
|
31
29
|
* </important>
|
|
32
|
-
*
|
|
33
30
|
* <p>To get a list of your buckets, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListBuckets.html">ListBuckets</a>.</p>
|
|
34
|
-
*
|
|
35
31
|
* <p>The following operations are related to <code>ListObjectsV2</code>:</p>
|
|
36
32
|
* <ul>
|
|
37
33
|
* <li>
|
|
@@ -21,13 +21,10 @@ export interface ListPartsCommandOutput extends ListPartsOutput, __MetadataBeare
|
|
|
21
21
|
* <p>If the upload was created using a checksum algorithm, you will need to have permission
|
|
22
22
|
* to the <code>kms:Decrypt</code> action for the request to succeed.
|
|
23
23
|
* </p>
|
|
24
|
-
*
|
|
25
24
|
* <p>For more information on multipart uploads, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/uploadobjusingmpu.html">Uploading Objects Using Multipart
|
|
26
25
|
* Upload</a>.</p>
|
|
27
|
-
*
|
|
28
26
|
* <p>For information on permissions required to use the multipart upload API, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/mpuAndPermissions.html">Multipart Upload and
|
|
29
27
|
* Permissions</a>.</p>
|
|
30
|
-
*
|
|
31
28
|
* <p>The following operations are related to <code>ListParts</code>:</p>
|
|
32
29
|
* <ul>
|
|
33
30
|
* <li>
|
|
@@ -10,13 +10,11 @@ export interface PutBucketAccelerateConfigurationCommandOutput extends __Metadat
|
|
|
10
10
|
/**
|
|
11
11
|
* <p>Sets the accelerate configuration of an existing bucket. Amazon S3 Transfer Acceleration is a
|
|
12
12
|
* bucket-level feature that enables you to perform faster data transfers to Amazon S3.</p>
|
|
13
|
-
*
|
|
14
13
|
* <p> To use this operation, you must have permission to perform the
|
|
15
14
|
* <code>s3:PutAccelerateConfiguration</code> action. The bucket owner has this permission
|
|
16
15
|
* by default. The bucket owner can grant this permission to others. For more information
|
|
17
16
|
* 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
|
|
18
17
|
* Access Permissions to Your Amazon S3 Resources</a>.</p>
|
|
19
|
-
*
|
|
20
18
|
* <p> The Transfer Acceleration state of a bucket can be set to one of the following two
|
|
21
19
|
* values:</p>
|
|
22
20
|
* <ul>
|
|
@@ -27,19 +25,13 @@ export interface PutBucketAccelerateConfigurationCommandOutput extends __Metadat
|
|
|
27
25
|
* <p> Suspended – Disables accelerated data transfers to the bucket.</p>
|
|
28
26
|
* </li>
|
|
29
27
|
* </ul>
|
|
30
|
-
*
|
|
31
|
-
*
|
|
32
28
|
* <p>The <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketAccelerateConfiguration.html">GetBucketAccelerateConfiguration</a> action returns the transfer acceleration
|
|
33
29
|
* state of a bucket.</p>
|
|
34
|
-
*
|
|
35
30
|
* <p>After setting the Transfer Acceleration state of a bucket to Enabled, it might take up
|
|
36
31
|
* to thirty minutes before the data transfer rates to the bucket increase.</p>
|
|
37
|
-
*
|
|
38
32
|
* <p> The name of the bucket used for Transfer Acceleration must be DNS-compliant and must
|
|
39
33
|
* not contain periods (".").</p>
|
|
40
|
-
*
|
|
41
34
|
* <p> For more information about transfer acceleration, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/transfer-acceleration.html">Transfer Acceleration</a>.</p>
|
|
42
|
-
*
|
|
43
35
|
* <p>The following operations are related to
|
|
44
36
|
* <code>PutBucketAccelerateConfiguration</code>:</p>
|
|
45
37
|
* <ul>
|