@aws-sdk/client-s3-control 3.315.0 → 3.316.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/S3Control.js +68 -896
- package/dist-cjs/endpoint/ruleset.js +3 -3
- package/dist-es/S3Control.js +68 -896
- package/dist-es/endpoint/ruleset.js +3 -3
- package/dist-types/S3Control.d.ts +72 -1749
- package/dist-types/ts3.4/S3Control.d.ts +2 -1
- package/package.json +6 -6
|
@@ -64,2072 +64,395 @@ import { SubmitMultiRegionAccessPointRoutesCommandInput, SubmitMultiRegionAccess
|
|
|
64
64
|
import { UpdateJobPriorityCommandInput, UpdateJobPriorityCommandOutput } from "./commands/UpdateJobPriorityCommand";
|
|
65
65
|
import { UpdateJobStatusCommandInput, UpdateJobStatusCommandOutput } from "./commands/UpdateJobStatusCommand";
|
|
66
66
|
import { S3ControlClient } from "./S3ControlClient";
|
|
67
|
-
|
|
68
|
-
|
|
69
|
-
|
|
70
|
-
*/
|
|
71
|
-
export declare class S3Control extends S3ControlClient {
|
|
72
|
-
/**
|
|
73
|
-
* @public
|
|
74
|
-
* <p>Creates an access point and associates it with the specified bucket. For more information, see
|
|
75
|
-
* <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/access-points.html">Managing
|
|
76
|
-
* Data Access with Amazon S3 Access Points</a> in the
|
|
77
|
-
* <i>Amazon S3 User Guide</i>.</p>
|
|
78
|
-
* <p></p>
|
|
79
|
-
* <note>
|
|
80
|
-
* <p>S3 on Outposts only supports VPC-style access points. </p>
|
|
81
|
-
* <p>For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html"> Accessing Amazon S3 on Outposts using
|
|
82
|
-
* virtual private cloud (VPC) only access points</a> in the
|
|
83
|
-
* <i>Amazon S3 User Guide</i>.</p>
|
|
84
|
-
* </note>
|
|
85
|
-
* <p>All Amazon S3 on Outposts REST API requests for this action require an additional parameter of <code>x-amz-outpost-id</code> to be passed with the request. In addition, you must use an S3 on Outposts endpoint hostname prefix instead of <code>s3-control</code>. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and the <code>x-amz-outpost-id</code> derived by using the access point ARN, see the <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_CreateAccessPoint.html#API_control_CreateAccessPoint_Examples">Examples</a> section.</p>
|
|
86
|
-
* <p></p>
|
|
87
|
-
* <p>The following actions are related to <code>CreateAccessPoint</code>:</p>
|
|
88
|
-
* <ul>
|
|
89
|
-
* <li>
|
|
90
|
-
* <p>
|
|
91
|
-
* <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_GetAccessPoint.html">GetAccessPoint</a>
|
|
92
|
-
* </p>
|
|
93
|
-
* </li>
|
|
94
|
-
* <li>
|
|
95
|
-
* <p>
|
|
96
|
-
* <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_DeleteAccessPoint.html">DeleteAccessPoint</a>
|
|
97
|
-
* </p>
|
|
98
|
-
* </li>
|
|
99
|
-
* <li>
|
|
100
|
-
* <p>
|
|
101
|
-
* <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_ListAccessPoints.html">ListAccessPoints</a>
|
|
102
|
-
* </p>
|
|
103
|
-
* </li>
|
|
104
|
-
* </ul>
|
|
67
|
+
export interface S3Control {
|
|
68
|
+
/**
|
|
69
|
+
* @see {@link CreateAccessPointCommand}
|
|
105
70
|
*/
|
|
106
71
|
createAccessPoint(args: CreateAccessPointCommandInput, options?: __HttpHandlerOptions): Promise<CreateAccessPointCommandOutput>;
|
|
107
72
|
createAccessPoint(args: CreateAccessPointCommandInput, cb: (err: any, data?: CreateAccessPointCommandOutput) => void): void;
|
|
108
73
|
createAccessPoint(args: CreateAccessPointCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateAccessPointCommandOutput) => void): void;
|
|
109
74
|
/**
|
|
110
|
-
* @
|
|
111
|
-
* <p>Creates an Object Lambda Access Point. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/transforming-objects.html">Transforming objects with
|
|
112
|
-
* Object Lambda Access Points</a> in the <i>Amazon S3 User Guide</i>.</p>
|
|
113
|
-
* <p>The following actions are related to
|
|
114
|
-
* <code>CreateAccessPointForObjectLambda</code>:</p>
|
|
115
|
-
* <ul>
|
|
116
|
-
* <li>
|
|
117
|
-
* <p>
|
|
118
|
-
* <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_DeleteAccessPointForObjectLambda.html">DeleteAccessPointForObjectLambda</a>
|
|
119
|
-
* </p>
|
|
120
|
-
* </li>
|
|
121
|
-
* <li>
|
|
122
|
-
* <p>
|
|
123
|
-
* <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_GetAccessPointForObjectLambda.html">GetAccessPointForObjectLambda</a>
|
|
124
|
-
* </p>
|
|
125
|
-
* </li>
|
|
126
|
-
* <li>
|
|
127
|
-
* <p>
|
|
128
|
-
* <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_ListAccessPointsForObjectLambda.html">ListAccessPointsForObjectLambda</a>
|
|
129
|
-
* </p>
|
|
130
|
-
* </li>
|
|
131
|
-
* </ul>
|
|
75
|
+
* @see {@link CreateAccessPointForObjectLambdaCommand}
|
|
132
76
|
*/
|
|
133
77
|
createAccessPointForObjectLambda(args: CreateAccessPointForObjectLambdaCommandInput, options?: __HttpHandlerOptions): Promise<CreateAccessPointForObjectLambdaCommandOutput>;
|
|
134
78
|
createAccessPointForObjectLambda(args: CreateAccessPointForObjectLambdaCommandInput, cb: (err: any, data?: CreateAccessPointForObjectLambdaCommandOutput) => void): void;
|
|
135
79
|
createAccessPointForObjectLambda(args: CreateAccessPointForObjectLambdaCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateAccessPointForObjectLambdaCommandOutput) => void): void;
|
|
136
80
|
/**
|
|
137
|
-
* @
|
|
138
|
-
* <note>
|
|
139
|
-
* <p>This action creates an Amazon S3 on Outposts bucket. To create an S3 bucket, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateBucket.html">Create
|
|
140
|
-
* Bucket</a> in the <i>Amazon S3 API Reference</i>. </p>
|
|
141
|
-
* </note>
|
|
142
|
-
* <p>Creates a new Outposts bucket. By creating the bucket, you become the bucket owner. To
|
|
143
|
-
* create an Outposts bucket, you must have S3 on Outposts. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html">Using
|
|
144
|
-
* Amazon S3 on Outposts</a> in <i>Amazon S3 User Guide</i>.</p>
|
|
145
|
-
* <p>Not every string is an acceptable bucket name. For information on bucket naming
|
|
146
|
-
* restrictions, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/BucketRestrictions.html#bucketnamingrules">Working with
|
|
147
|
-
* Amazon S3 Buckets</a>.</p>
|
|
148
|
-
* <p>S3 on Outposts buckets support:</p>
|
|
149
|
-
* <ul>
|
|
150
|
-
* <li>
|
|
151
|
-
* <p>Tags</p>
|
|
152
|
-
* </li>
|
|
153
|
-
* <li>
|
|
154
|
-
* <p>LifecycleConfigurations for deleting expired objects</p>
|
|
155
|
-
* </li>
|
|
156
|
-
* </ul>
|
|
157
|
-
* <p>For a complete list of restrictions and Amazon S3 feature limitations on S3 on Outposts, see
|
|
158
|
-
* <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3OnOutpostsRestrictionsLimitations.html">
|
|
159
|
-
* Amazon S3 on Outposts Restrictions and Limitations</a>.</p>
|
|
160
|
-
* <p>For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts
|
|
161
|
-
* endpoint hostname prefix and <code>x-amz-outpost-id</code> in your API request, see the
|
|
162
|
-
* <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_CreateBucket.html#API_control_CreateBucket_Examples">Examples</a> section.</p>
|
|
163
|
-
* <p>The following actions are related to <code>CreateBucket</code> for
|
|
164
|
-
* Amazon S3 on Outposts:</p>
|
|
165
|
-
* <ul>
|
|
166
|
-
* <li>
|
|
167
|
-
* <p>
|
|
168
|
-
* <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutObject.html">PutObject</a>
|
|
169
|
-
* </p>
|
|
170
|
-
* </li>
|
|
171
|
-
* <li>
|
|
172
|
-
* <p>
|
|
173
|
-
* <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_GetBucket.html">GetBucket</a>
|
|
174
|
-
* </p>
|
|
175
|
-
* </li>
|
|
176
|
-
* <li>
|
|
177
|
-
* <p>
|
|
178
|
-
* <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_DeleteBucket.html">DeleteBucket</a>
|
|
179
|
-
* </p>
|
|
180
|
-
* </li>
|
|
181
|
-
* <li>
|
|
182
|
-
* <p>
|
|
183
|
-
* <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_CreateAccessPoint.html">CreateAccessPoint</a>
|
|
184
|
-
* </p>
|
|
185
|
-
* </li>
|
|
186
|
-
* <li>
|
|
187
|
-
* <p>
|
|
188
|
-
* <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_PutAccessPointPolicy.html">PutAccessPointPolicy</a>
|
|
189
|
-
* </p>
|
|
190
|
-
* </li>
|
|
191
|
-
* </ul>
|
|
81
|
+
* @see {@link CreateBucketCommand}
|
|
192
82
|
*/
|
|
193
83
|
createBucket(args: CreateBucketCommandInput, options?: __HttpHandlerOptions): Promise<CreateBucketCommandOutput>;
|
|
194
84
|
createBucket(args: CreateBucketCommandInput, cb: (err: any, data?: CreateBucketCommandOutput) => void): void;
|
|
195
85
|
createBucket(args: CreateBucketCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateBucketCommandOutput) => void): void;
|
|
196
86
|
/**
|
|
197
|
-
* @
|
|
198
|
-
* <p>You can use S3 Batch Operations to perform large-scale batch actions on Amazon S3 objects.
|
|
199
|
-
* Batch Operations can run a single action on lists of Amazon S3 objects that you specify. For more
|
|
200
|
-
* information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/batch-ops.html">S3 Batch Operations</a> in the <i>Amazon S3 User Guide</i>.</p>
|
|
201
|
-
* <p>This action creates a S3 Batch Operations job.</p>
|
|
202
|
-
* <p></p>
|
|
203
|
-
* <p>Related actions include:</p>
|
|
204
|
-
* <ul>
|
|
205
|
-
* <li>
|
|
206
|
-
* <p>
|
|
207
|
-
* <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_DescribeJob.html">DescribeJob</a>
|
|
208
|
-
* </p>
|
|
209
|
-
* </li>
|
|
210
|
-
* <li>
|
|
211
|
-
* <p>
|
|
212
|
-
* <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_ListJobs.html">ListJobs</a>
|
|
213
|
-
* </p>
|
|
214
|
-
* </li>
|
|
215
|
-
* <li>
|
|
216
|
-
* <p>
|
|
217
|
-
* <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_UpdateJobPriority.html">UpdateJobPriority</a>
|
|
218
|
-
* </p>
|
|
219
|
-
* </li>
|
|
220
|
-
* <li>
|
|
221
|
-
* <p>
|
|
222
|
-
* <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_UpdateJobStatus.html">UpdateJobStatus</a>
|
|
223
|
-
* </p>
|
|
224
|
-
* </li>
|
|
225
|
-
* <li>
|
|
226
|
-
* <p>
|
|
227
|
-
* <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_JobOperation.html">JobOperation</a>
|
|
228
|
-
* </p>
|
|
229
|
-
* </li>
|
|
230
|
-
* </ul>
|
|
87
|
+
* @see {@link CreateJobCommand}
|
|
231
88
|
*/
|
|
232
89
|
createJob(args: CreateJobCommandInput, options?: __HttpHandlerOptions): Promise<CreateJobCommandOutput>;
|
|
233
90
|
createJob(args: CreateJobCommandInput, cb: (err: any, data?: CreateJobCommandOutput) => void): void;
|
|
234
91
|
createJob(args: CreateJobCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateJobCommandOutput) => void): void;
|
|
235
92
|
/**
|
|
236
|
-
* @
|
|
237
|
-
* <p>Creates a Multi-Region Access Point and associates it with the specified buckets. For more information
|
|
238
|
-
* about creating Multi-Region Access Points, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/CreatingMultiRegionAccessPoints.html">Creating
|
|
239
|
-
* Multi-Region Access Points</a> in the <i>Amazon S3 User Guide</i>.</p>
|
|
240
|
-
* <p>This action will always be routed to the US West (Oregon) Region. For more information
|
|
241
|
-
* about the restrictions around managing Multi-Region Access Points, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/ManagingMultiRegionAccessPoints.html">Managing
|
|
242
|
-
* Multi-Region Access Points</a> in the <i>Amazon S3 User Guide</i>.</p>
|
|
243
|
-
* <p>This request is asynchronous, meaning that you might receive a response before the
|
|
244
|
-
* command has completed. When this request provides a response, it provides a token that you
|
|
245
|
-
* can use to monitor the status of the request with
|
|
246
|
-
* <code>DescribeMultiRegionAccessPointOperation</code>.</p>
|
|
247
|
-
* <p>The following actions are related to <code>CreateMultiRegionAccessPoint</code>:</p>
|
|
248
|
-
* <ul>
|
|
249
|
-
* <li>
|
|
250
|
-
* <p>
|
|
251
|
-
* <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_DeleteMultiRegionAccessPoint.html">DeleteMultiRegionAccessPoint</a>
|
|
252
|
-
* </p>
|
|
253
|
-
* </li>
|
|
254
|
-
* <li>
|
|
255
|
-
* <p>
|
|
256
|
-
* <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_DescribeMultiRegionAccessPointOperation.html">DescribeMultiRegionAccessPointOperation</a>
|
|
257
|
-
* </p>
|
|
258
|
-
* </li>
|
|
259
|
-
* <li>
|
|
260
|
-
* <p>
|
|
261
|
-
* <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_GetMultiRegionAccessPoint.html">GetMultiRegionAccessPoint</a>
|
|
262
|
-
* </p>
|
|
263
|
-
* </li>
|
|
264
|
-
* <li>
|
|
265
|
-
* <p>
|
|
266
|
-
* <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_ListMultiRegionAccessPoints.html">ListMultiRegionAccessPoints</a>
|
|
267
|
-
* </p>
|
|
268
|
-
* </li>
|
|
269
|
-
* </ul>
|
|
93
|
+
* @see {@link CreateMultiRegionAccessPointCommand}
|
|
270
94
|
*/
|
|
271
95
|
createMultiRegionAccessPoint(args: CreateMultiRegionAccessPointCommandInput, options?: __HttpHandlerOptions): Promise<CreateMultiRegionAccessPointCommandOutput>;
|
|
272
96
|
createMultiRegionAccessPoint(args: CreateMultiRegionAccessPointCommandInput, cb: (err: any, data?: CreateMultiRegionAccessPointCommandOutput) => void): void;
|
|
273
97
|
createMultiRegionAccessPoint(args: CreateMultiRegionAccessPointCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateMultiRegionAccessPointCommandOutput) => void): void;
|
|
274
98
|
/**
|
|
275
|
-
* @
|
|
276
|
-
* <p>Deletes the specified access point.</p>
|
|
277
|
-
* <p>All Amazon S3 on Outposts REST API requests for this action require an additional parameter of <code>x-amz-outpost-id</code> to be passed with the request. In addition, you must use an S3 on Outposts endpoint hostname prefix instead of <code>s3-control</code>. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and the <code>x-amz-outpost-id</code> derived by using the access point ARN, see the <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_DeleteAccessPoint.html#API_control_DeleteAccessPoint_Examples">Examples</a> section.</p>
|
|
278
|
-
* <p>The following actions are related to <code>DeleteAccessPoint</code>:</p>
|
|
279
|
-
* <ul>
|
|
280
|
-
* <li>
|
|
281
|
-
* <p>
|
|
282
|
-
* <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_CreateAccessPoint.html">CreateAccessPoint</a>
|
|
283
|
-
* </p>
|
|
284
|
-
* </li>
|
|
285
|
-
* <li>
|
|
286
|
-
* <p>
|
|
287
|
-
* <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_GetAccessPoint.html">GetAccessPoint</a>
|
|
288
|
-
* </p>
|
|
289
|
-
* </li>
|
|
290
|
-
* <li>
|
|
291
|
-
* <p>
|
|
292
|
-
* <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_ListAccessPoints.html">ListAccessPoints</a>
|
|
293
|
-
* </p>
|
|
294
|
-
* </li>
|
|
295
|
-
* </ul>
|
|
99
|
+
* @see {@link DeleteAccessPointCommand}
|
|
296
100
|
*/
|
|
297
101
|
deleteAccessPoint(args: DeleteAccessPointCommandInput, options?: __HttpHandlerOptions): Promise<DeleteAccessPointCommandOutput>;
|
|
298
102
|
deleteAccessPoint(args: DeleteAccessPointCommandInput, cb: (err: any, data?: DeleteAccessPointCommandOutput) => void): void;
|
|
299
103
|
deleteAccessPoint(args: DeleteAccessPointCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteAccessPointCommandOutput) => void): void;
|
|
300
104
|
/**
|
|
301
|
-
* @
|
|
302
|
-
* <p>Deletes the specified Object Lambda Access Point.</p>
|
|
303
|
-
* <p>The following actions are related to
|
|
304
|
-
* <code>DeleteAccessPointForObjectLambda</code>:</p>
|
|
305
|
-
* <ul>
|
|
306
|
-
* <li>
|
|
307
|
-
* <p>
|
|
308
|
-
* <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_CreateAccessPointForObjectLambda.html">CreateAccessPointForObjectLambda</a>
|
|
309
|
-
* </p>
|
|
310
|
-
* </li>
|
|
311
|
-
* <li>
|
|
312
|
-
* <p>
|
|
313
|
-
* <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_GetAccessPointForObjectLambda.html">GetAccessPointForObjectLambda</a>
|
|
314
|
-
* </p>
|
|
315
|
-
* </li>
|
|
316
|
-
* <li>
|
|
317
|
-
* <p>
|
|
318
|
-
* <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_ListAccessPointsForObjectLambda.html">ListAccessPointsForObjectLambda</a>
|
|
319
|
-
* </p>
|
|
320
|
-
* </li>
|
|
321
|
-
* </ul>
|
|
105
|
+
* @see {@link DeleteAccessPointForObjectLambdaCommand}
|
|
322
106
|
*/
|
|
323
107
|
deleteAccessPointForObjectLambda(args: DeleteAccessPointForObjectLambdaCommandInput, options?: __HttpHandlerOptions): Promise<DeleteAccessPointForObjectLambdaCommandOutput>;
|
|
324
108
|
deleteAccessPointForObjectLambda(args: DeleteAccessPointForObjectLambdaCommandInput, cb: (err: any, data?: DeleteAccessPointForObjectLambdaCommandOutput) => void): void;
|
|
325
109
|
deleteAccessPointForObjectLambda(args: DeleteAccessPointForObjectLambdaCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteAccessPointForObjectLambdaCommandOutput) => void): void;
|
|
326
110
|
/**
|
|
327
|
-
* @
|
|
328
|
-
* <p>Deletes the access point policy for the specified access point.</p>
|
|
329
|
-
* <p></p>
|
|
330
|
-
* <p>All Amazon S3 on Outposts REST API requests for this action require an additional parameter of <code>x-amz-outpost-id</code> to be passed with the request. In addition, you must use an S3 on Outposts endpoint hostname prefix instead of <code>s3-control</code>. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and the <code>x-amz-outpost-id</code> derived by using the access point ARN, see the <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_DeleteAccessPointPolicy.html#API_control_DeleteAccessPointPolicy_Examples">Examples</a> section.</p>
|
|
331
|
-
* <p>The following actions are related to <code>DeleteAccessPointPolicy</code>:</p>
|
|
332
|
-
* <ul>
|
|
333
|
-
* <li>
|
|
334
|
-
* <p>
|
|
335
|
-
* <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_PutAccessPointPolicy.html">PutAccessPointPolicy</a>
|
|
336
|
-
* </p>
|
|
337
|
-
* </li>
|
|
338
|
-
* <li>
|
|
339
|
-
* <p>
|
|
340
|
-
* <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_GetAccessPointPolicy.html">GetAccessPointPolicy</a>
|
|
341
|
-
* </p>
|
|
342
|
-
* </li>
|
|
343
|
-
* </ul>
|
|
111
|
+
* @see {@link DeleteAccessPointPolicyCommand}
|
|
344
112
|
*/
|
|
345
113
|
deleteAccessPointPolicy(args: DeleteAccessPointPolicyCommandInput, options?: __HttpHandlerOptions): Promise<DeleteAccessPointPolicyCommandOutput>;
|
|
346
114
|
deleteAccessPointPolicy(args: DeleteAccessPointPolicyCommandInput, cb: (err: any, data?: DeleteAccessPointPolicyCommandOutput) => void): void;
|
|
347
115
|
deleteAccessPointPolicy(args: DeleteAccessPointPolicyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteAccessPointPolicyCommandOutput) => void): void;
|
|
348
116
|
/**
|
|
349
|
-
* @
|
|
350
|
-
* <p>Removes the resource policy for an Object Lambda Access Point.</p>
|
|
351
|
-
* <p>The following actions are related to
|
|
352
|
-
* <code>DeleteAccessPointPolicyForObjectLambda</code>:</p>
|
|
353
|
-
* <ul>
|
|
354
|
-
* <li>
|
|
355
|
-
* <p>
|
|
356
|
-
* <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_GetAccessPointPolicyForObjectLambda.html">GetAccessPointPolicyForObjectLambda</a>
|
|
357
|
-
* </p>
|
|
358
|
-
* </li>
|
|
359
|
-
* <li>
|
|
360
|
-
* <p>
|
|
361
|
-
* <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_PutAccessPointPolicyForObjectLambda.html">PutAccessPointPolicyForObjectLambda</a>
|
|
362
|
-
* </p>
|
|
363
|
-
* </li>
|
|
364
|
-
* </ul>
|
|
117
|
+
* @see {@link DeleteAccessPointPolicyForObjectLambdaCommand}
|
|
365
118
|
*/
|
|
366
119
|
deleteAccessPointPolicyForObjectLambda(args: DeleteAccessPointPolicyForObjectLambdaCommandInput, options?: __HttpHandlerOptions): Promise<DeleteAccessPointPolicyForObjectLambdaCommandOutput>;
|
|
367
120
|
deleteAccessPointPolicyForObjectLambda(args: DeleteAccessPointPolicyForObjectLambdaCommandInput, cb: (err: any, data?: DeleteAccessPointPolicyForObjectLambdaCommandOutput) => void): void;
|
|
368
121
|
deleteAccessPointPolicyForObjectLambda(args: DeleteAccessPointPolicyForObjectLambdaCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteAccessPointPolicyForObjectLambdaCommandOutput) => void): void;
|
|
369
122
|
/**
|
|
370
|
-
* @
|
|
371
|
-
* <note>
|
|
372
|
-
* <p>This action deletes an Amazon S3 on Outposts bucket. To delete an S3 bucket, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucket.html">DeleteBucket</a> in the <i>Amazon S3 API Reference</i>. </p>
|
|
373
|
-
* </note>
|
|
374
|
-
* <p>Deletes the Amazon S3 on Outposts bucket. All objects (including all object versions and
|
|
375
|
-
* delete markers) in the bucket must be deleted before the bucket itself can be deleted. For
|
|
376
|
-
* more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html">Using Amazon S3 on Outposts</a> in
|
|
377
|
-
* <i>Amazon S3 User Guide</i>.</p>
|
|
378
|
-
* <p>All Amazon S3 on Outposts REST API requests for this action require an additional parameter of <code>x-amz-outpost-id</code> to be passed with the request. In addition, you must use an S3 on Outposts endpoint hostname prefix instead of <code>s3-control</code>. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and the <code>x-amz-outpost-id</code> derived by using the access point ARN, see the <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_DeleteBucket.html#API_control_DeleteBucket_Examples">Examples</a> section.</p>
|
|
379
|
-
* <p class="title">
|
|
380
|
-
* <b>Related Resources</b>
|
|
381
|
-
* </p>
|
|
382
|
-
* <ul>
|
|
383
|
-
* <li>
|
|
384
|
-
* <p>
|
|
385
|
-
* <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_CreateBucket.html">CreateBucket</a>
|
|
386
|
-
* </p>
|
|
387
|
-
* </li>
|
|
388
|
-
* <li>
|
|
389
|
-
* <p>
|
|
390
|
-
* <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_GetBucket.html">GetBucket</a>
|
|
391
|
-
* </p>
|
|
392
|
-
* </li>
|
|
393
|
-
* <li>
|
|
394
|
-
* <p>
|
|
395
|
-
* <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteObject.html">DeleteObject</a>
|
|
396
|
-
* </p>
|
|
397
|
-
* </li>
|
|
398
|
-
* </ul>
|
|
123
|
+
* @see {@link DeleteBucketCommand}
|
|
399
124
|
*/
|
|
400
125
|
deleteBucket(args: DeleteBucketCommandInput, options?: __HttpHandlerOptions): Promise<DeleteBucketCommandOutput>;
|
|
401
126
|
deleteBucket(args: DeleteBucketCommandInput, cb: (err: any, data?: DeleteBucketCommandOutput) => void): void;
|
|
402
127
|
deleteBucket(args: DeleteBucketCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteBucketCommandOutput) => void): void;
|
|
403
128
|
/**
|
|
404
|
-
* @
|
|
405
|
-
* <note>
|
|
406
|
-
* <p>This action deletes an Amazon S3 on Outposts bucket's lifecycle configuration. To delete
|
|
407
|
-
* an S3 bucket's lifecycle configuration, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucketLifecycle.html">DeleteBucketLifecycle</a> in the <i>Amazon S3 API Reference</i>. </p>
|
|
408
|
-
* </note>
|
|
409
|
-
* <p>Deletes the lifecycle configuration from the specified Outposts bucket.
|
|
410
|
-
* Amazon S3 on Outposts removes all the lifecycle configuration rules in the lifecycle subresource
|
|
411
|
-
* associated with the bucket. Your objects never expire, and Amazon S3 on Outposts no longer
|
|
412
|
-
* automatically deletes any objects on the basis of rules contained in the deleted lifecycle
|
|
413
|
-
* configuration. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html">Using Amazon S3 on Outposts</a> in
|
|
414
|
-
* <i>Amazon S3 User Guide</i>.</p>
|
|
415
|
-
* <p>To use this action, you must have permission to perform the
|
|
416
|
-
* <code>s3-outposts:DeleteLifecycleConfiguration</code> action. By default, the bucket
|
|
417
|
-
* owner has this permission and the Outposts bucket owner can grant this permission to
|
|
418
|
-
* others.</p>
|
|
419
|
-
* <p>All Amazon S3 on Outposts REST API requests for this action require an additional parameter of <code>x-amz-outpost-id</code> to be passed with the request. In addition, you must use an S3 on Outposts endpoint hostname prefix instead of <code>s3-control</code>. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and the <code>x-amz-outpost-id</code> derived by using the access point ARN, see the <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_DeleteBucketLifecycleConfiguration.html#API_control_DeleteBucketLifecycleConfiguration_Examples">Examples</a> section.</p>
|
|
420
|
-
* <p>For more information about object expiration, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/intro-lifecycle-rules.html#intro-lifecycle-rules-actions">Elements to Describe Lifecycle Actions</a>.</p>
|
|
421
|
-
* <p>Related actions include:</p>
|
|
422
|
-
* <ul>
|
|
423
|
-
* <li>
|
|
424
|
-
* <p>
|
|
425
|
-
* <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_PutBucketLifecycleConfiguration.html">PutBucketLifecycleConfiguration</a>
|
|
426
|
-
* </p>
|
|
427
|
-
* </li>
|
|
428
|
-
* <li>
|
|
429
|
-
* <p>
|
|
430
|
-
* <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_GetBucketLifecycleConfiguration.html">GetBucketLifecycleConfiguration</a>
|
|
431
|
-
* </p>
|
|
432
|
-
* </li>
|
|
433
|
-
* </ul>
|
|
129
|
+
* @see {@link DeleteBucketLifecycleConfigurationCommand}
|
|
434
130
|
*/
|
|
435
131
|
deleteBucketLifecycleConfiguration(args: DeleteBucketLifecycleConfigurationCommandInput, options?: __HttpHandlerOptions): Promise<DeleteBucketLifecycleConfigurationCommandOutput>;
|
|
436
132
|
deleteBucketLifecycleConfiguration(args: DeleteBucketLifecycleConfigurationCommandInput, cb: (err: any, data?: DeleteBucketLifecycleConfigurationCommandOutput) => void): void;
|
|
437
133
|
deleteBucketLifecycleConfiguration(args: DeleteBucketLifecycleConfigurationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteBucketLifecycleConfigurationCommandOutput) => void): void;
|
|
438
134
|
/**
|
|
439
|
-
* @
|
|
440
|
-
* <note>
|
|
441
|
-
* <p>This action deletes an Amazon S3 on Outposts bucket policy. To delete an S3 bucket policy,
|
|
442
|
-
* see <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucketPolicy.html">DeleteBucketPolicy</a> in the <i>Amazon S3 API Reference</i>. </p>
|
|
443
|
-
* </note>
|
|
444
|
-
* <p>This implementation of the DELETE action uses the policy subresource to delete the
|
|
445
|
-
* policy of a specified Amazon S3 on Outposts bucket. If you are using an identity other than the
|
|
446
|
-
* root user of the Amazon Web Services account that owns the bucket, the calling identity must have the
|
|
447
|
-
* <code>s3-outposts:DeleteBucketPolicy</code> permissions on the specified Outposts bucket
|
|
448
|
-
* and belong to the bucket owner's account to use this action. For more information, see
|
|
449
|
-
* <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html">Using
|
|
450
|
-
* Amazon S3 on Outposts</a> in <i>Amazon S3 User Guide</i>.</p>
|
|
451
|
-
* <p>If you don't have <code>DeleteBucketPolicy</code> permissions, Amazon S3 returns a <code>403
|
|
452
|
-
* Access Denied</code> error. If you have the correct permissions, but you're not using an
|
|
453
|
-
* identity that belongs to the bucket owner's account, Amazon S3 returns a <code>405 Method Not
|
|
454
|
-
* Allowed</code> error. </p>
|
|
455
|
-
* <important>
|
|
456
|
-
* <p>As a security precaution, the root user of the Amazon Web Services account that owns a bucket can
|
|
457
|
-
* always use this action, even if the policy explicitly denies the root user the ability
|
|
458
|
-
* to perform this action.</p>
|
|
459
|
-
* </important>
|
|
460
|
-
* <p>For more information about bucket policies, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/using-iam-policies.html">Using Bucket Policies and User
|
|
461
|
-
* Policies</a>. </p>
|
|
462
|
-
* <p>All Amazon S3 on Outposts REST API requests for this action require an additional parameter of <code>x-amz-outpost-id</code> to be passed with the request. In addition, you must use an S3 on Outposts endpoint hostname prefix instead of <code>s3-control</code>. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and the <code>x-amz-outpost-id</code> derived by using the access point ARN, see the <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_DeleteBucketPolicy.html#API_control_DeleteBucketPolicy_Examples">Examples</a> section.</p>
|
|
463
|
-
* <p>The following actions are related to <code>DeleteBucketPolicy</code>:</p>
|
|
464
|
-
* <ul>
|
|
465
|
-
* <li>
|
|
466
|
-
* <p>
|
|
467
|
-
* <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_GetBucketPolicy.html">GetBucketPolicy</a>
|
|
468
|
-
* </p>
|
|
469
|
-
* </li>
|
|
470
|
-
* <li>
|
|
471
|
-
* <p>
|
|
472
|
-
* <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_PutBucketPolicy.html">PutBucketPolicy</a>
|
|
473
|
-
* </p>
|
|
474
|
-
* </li>
|
|
475
|
-
* </ul>
|
|
135
|
+
* @see {@link DeleteBucketPolicyCommand}
|
|
476
136
|
*/
|
|
477
137
|
deleteBucketPolicy(args: DeleteBucketPolicyCommandInput, options?: __HttpHandlerOptions): Promise<DeleteBucketPolicyCommandOutput>;
|
|
478
138
|
deleteBucketPolicy(args: DeleteBucketPolicyCommandInput, cb: (err: any, data?: DeleteBucketPolicyCommandOutput) => void): void;
|
|
479
139
|
deleteBucketPolicy(args: DeleteBucketPolicyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteBucketPolicyCommandOutput) => void): void;
|
|
480
140
|
/**
|
|
481
|
-
* @
|
|
482
|
-
* <note>
|
|
483
|
-
* <p>This operation deletes an Amazon S3 on Outposts bucket's replication configuration. To
|
|
484
|
-
* delete an S3 bucket's replication configuration, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucketReplication.html">DeleteBucketReplication</a> in the <i>Amazon S3 API Reference</i>. </p>
|
|
485
|
-
* </note>
|
|
486
|
-
* <p>Deletes the replication configuration from the specified S3 on Outposts bucket.</p>
|
|
487
|
-
* <p>To use this operation, you must have permissions to perform the
|
|
488
|
-
* <code>s3-outposts:PutReplicationConfiguration</code> action. The Outposts bucket owner
|
|
489
|
-
* has this permission by default and can grant it to others. For more information about
|
|
490
|
-
* permissions, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3OutpostsIAM.html">Setting up IAM with
|
|
491
|
-
* S3 on Outposts</a> and <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3OutpostsBucketPolicy.html">Managing access to
|
|
492
|
-
* S3 on Outposts buckets</a> in the <i>Amazon S3 User Guide</i>.</p>
|
|
493
|
-
* <note>
|
|
494
|
-
* <p>It can take a while to propagate <code>PUT</code> or <code>DELETE</code> requests for
|
|
495
|
-
* a replication configuration to all S3 on Outposts systems. Therefore, the replication
|
|
496
|
-
* configuration that's returned by a <code>GET</code> request soon after a
|
|
497
|
-
* <code>PUT</code> or <code>DELETE</code> request might return a more recent result
|
|
498
|
-
* than what's on the Outpost. If an Outpost is offline, the delay in updating the
|
|
499
|
-
* replication configuration on that Outpost can be significant.</p>
|
|
500
|
-
* </note>
|
|
501
|
-
* <p>All Amazon S3 on Outposts REST API requests for this action require an additional parameter of <code>x-amz-outpost-id</code> to be passed with the request. In addition, you must use an S3 on Outposts endpoint hostname prefix instead of <code>s3-control</code>. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and the <code>x-amz-outpost-id</code> derived by using the access point ARN, see the <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_DeleteBucketReplication.html#API_control_DeleteBucketReplication_Examples">Examples</a> section.</p>
|
|
502
|
-
* <p>For information about S3 replication on Outposts configuration, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3OutpostsReplication.html">Replicating objects for S3 on Outposts</a> in the
|
|
503
|
-
* <i>Amazon S3 User Guide</i>.</p>
|
|
504
|
-
* <p>The following operations are related to <code>DeleteBucketReplication</code>:</p>
|
|
505
|
-
* <ul>
|
|
506
|
-
* <li>
|
|
507
|
-
* <p>
|
|
508
|
-
* <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_PutBucketReplication.html">PutBucketReplication</a>
|
|
509
|
-
* </p>
|
|
510
|
-
* </li>
|
|
511
|
-
* <li>
|
|
512
|
-
* <p>
|
|
513
|
-
* <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_GetBucketReplication.html">GetBucketReplication</a>
|
|
514
|
-
* </p>
|
|
515
|
-
* </li>
|
|
516
|
-
* </ul>
|
|
141
|
+
* @see {@link DeleteBucketReplicationCommand}
|
|
517
142
|
*/
|
|
518
143
|
deleteBucketReplication(args: DeleteBucketReplicationCommandInput, options?: __HttpHandlerOptions): Promise<DeleteBucketReplicationCommandOutput>;
|
|
519
144
|
deleteBucketReplication(args: DeleteBucketReplicationCommandInput, cb: (err: any, data?: DeleteBucketReplicationCommandOutput) => void): void;
|
|
520
145
|
deleteBucketReplication(args: DeleteBucketReplicationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteBucketReplicationCommandOutput) => void): void;
|
|
521
146
|
/**
|
|
522
|
-
* @
|
|
523
|
-
* <note>
|
|
524
|
-
* <p>This action deletes an Amazon S3 on Outposts bucket's tags. To delete an S3 bucket tags,
|
|
525
|
-
* see <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucketTagging.html">DeleteBucketTagging</a> in the <i>Amazon S3 API Reference</i>. </p>
|
|
526
|
-
* </note>
|
|
527
|
-
* <p>Deletes the tags from the Outposts bucket. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html">Using
|
|
528
|
-
* Amazon S3 on Outposts</a> in <i>Amazon S3 User Guide</i>.</p>
|
|
529
|
-
* <p>To use this action, you must have permission to perform the
|
|
530
|
-
* <code>PutBucketTagging</code> action. By default, the bucket owner has this permission
|
|
531
|
-
* and can grant this permission to others. </p>
|
|
532
|
-
* <p>All Amazon S3 on Outposts REST API requests for this action require an additional parameter of <code>x-amz-outpost-id</code> to be passed with the request. In addition, you must use an S3 on Outposts endpoint hostname prefix instead of <code>s3-control</code>. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and the <code>x-amz-outpost-id</code> derived by using the access point ARN, see the <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_DeleteBucketTagging.html#API_control_DeleteBucketTagging_Examples">Examples</a> section.</p>
|
|
533
|
-
* <p>The following actions are related to <code>DeleteBucketTagging</code>:</p>
|
|
534
|
-
* <ul>
|
|
535
|
-
* <li>
|
|
536
|
-
* <p>
|
|
537
|
-
* <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_GetBucketTagging.html">GetBucketTagging</a>
|
|
538
|
-
* </p>
|
|
539
|
-
* </li>
|
|
540
|
-
* <li>
|
|
541
|
-
* <p>
|
|
542
|
-
* <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_PutBucketTagging.html">PutBucketTagging</a>
|
|
543
|
-
* </p>
|
|
544
|
-
* </li>
|
|
545
|
-
* </ul>
|
|
147
|
+
* @see {@link DeleteBucketTaggingCommand}
|
|
546
148
|
*/
|
|
547
149
|
deleteBucketTagging(args: DeleteBucketTaggingCommandInput, options?: __HttpHandlerOptions): Promise<DeleteBucketTaggingCommandOutput>;
|
|
548
150
|
deleteBucketTagging(args: DeleteBucketTaggingCommandInput, cb: (err: any, data?: DeleteBucketTaggingCommandOutput) => void): void;
|
|
549
151
|
deleteBucketTagging(args: DeleteBucketTaggingCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteBucketTaggingCommandOutput) => void): void;
|
|
550
152
|
/**
|
|
551
|
-
* @
|
|
552
|
-
* <p>Removes the entire tag set from the specified S3 Batch Operations job. To use
|
|
553
|
-
* the
|
|
554
|
-
* <code>DeleteJobTagging</code> operation, you must have permission to
|
|
555
|
-
* perform the <code>s3:DeleteJobTagging</code> action. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/batch-ops-managing-jobs.html#batch-ops-job-tags">Controlling
|
|
556
|
-
* access and labeling jobs using tags</a> in the
|
|
557
|
-
* <i>Amazon S3 User Guide</i>.</p>
|
|
558
|
-
* <p></p>
|
|
559
|
-
* <p>Related actions include:</p>
|
|
560
|
-
* <ul>
|
|
561
|
-
* <li>
|
|
562
|
-
* <p>
|
|
563
|
-
* <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_CreateJob.html">CreateJob</a>
|
|
564
|
-
* </p>
|
|
565
|
-
* </li>
|
|
566
|
-
* <li>
|
|
567
|
-
* <p>
|
|
568
|
-
* <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_GetJobTagging.html">GetJobTagging</a>
|
|
569
|
-
* </p>
|
|
570
|
-
* </li>
|
|
571
|
-
* <li>
|
|
572
|
-
* <p>
|
|
573
|
-
* <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_PutJobTagging.html">PutJobTagging</a>
|
|
574
|
-
* </p>
|
|
575
|
-
* </li>
|
|
576
|
-
* </ul>
|
|
153
|
+
* @see {@link DeleteJobTaggingCommand}
|
|
577
154
|
*/
|
|
578
155
|
deleteJobTagging(args: DeleteJobTaggingCommandInput, options?: __HttpHandlerOptions): Promise<DeleteJobTaggingCommandOutput>;
|
|
579
156
|
deleteJobTagging(args: DeleteJobTaggingCommandInput, cb: (err: any, data?: DeleteJobTaggingCommandOutput) => void): void;
|
|
580
157
|
deleteJobTagging(args: DeleteJobTaggingCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteJobTaggingCommandOutput) => void): void;
|
|
581
158
|
/**
|
|
582
|
-
* @
|
|
583
|
-
* <p>Deletes a Multi-Region Access Point. This action does not delete the buckets associated with the Multi-Region Access Point,
|
|
584
|
-
* only the Multi-Region Access Point itself.</p>
|
|
585
|
-
* <p>This action will always be routed to the US West (Oregon) Region. For more information
|
|
586
|
-
* about the restrictions around managing Multi-Region Access Points, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/ManagingMultiRegionAccessPoints.html">Managing
|
|
587
|
-
* Multi-Region Access Points</a> in the <i>Amazon S3 User Guide</i>.</p>
|
|
588
|
-
* <p>This request is asynchronous, meaning that you might receive a response before the
|
|
589
|
-
* command has completed. When this request provides a response, it provides a token that you
|
|
590
|
-
* can use to monitor the status of the request with
|
|
591
|
-
* <code>DescribeMultiRegionAccessPointOperation</code>.</p>
|
|
592
|
-
* <p>The following actions are related to <code>DeleteMultiRegionAccessPoint</code>:</p>
|
|
593
|
-
* <ul>
|
|
594
|
-
* <li>
|
|
595
|
-
* <p>
|
|
596
|
-
* <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_CreateMultiRegionAccessPoint.html">CreateMultiRegionAccessPoint</a>
|
|
597
|
-
* </p>
|
|
598
|
-
* </li>
|
|
599
|
-
* <li>
|
|
600
|
-
* <p>
|
|
601
|
-
* <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_DescribeMultiRegionAccessPointOperation.html">DescribeMultiRegionAccessPointOperation</a>
|
|
602
|
-
* </p>
|
|
603
|
-
* </li>
|
|
604
|
-
* <li>
|
|
605
|
-
* <p>
|
|
606
|
-
* <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_GetMultiRegionAccessPoint.html">GetMultiRegionAccessPoint</a>
|
|
607
|
-
* </p>
|
|
608
|
-
* </li>
|
|
609
|
-
* <li>
|
|
610
|
-
* <p>
|
|
611
|
-
* <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_ListMultiRegionAccessPoints.html">ListMultiRegionAccessPoints</a>
|
|
612
|
-
* </p>
|
|
613
|
-
* </li>
|
|
614
|
-
* </ul>
|
|
159
|
+
* @see {@link DeleteMultiRegionAccessPointCommand}
|
|
615
160
|
*/
|
|
616
161
|
deleteMultiRegionAccessPoint(args: DeleteMultiRegionAccessPointCommandInput, options?: __HttpHandlerOptions): Promise<DeleteMultiRegionAccessPointCommandOutput>;
|
|
617
162
|
deleteMultiRegionAccessPoint(args: DeleteMultiRegionAccessPointCommandInput, cb: (err: any, data?: DeleteMultiRegionAccessPointCommandOutput) => void): void;
|
|
618
163
|
deleteMultiRegionAccessPoint(args: DeleteMultiRegionAccessPointCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteMultiRegionAccessPointCommandOutput) => void): void;
|
|
619
164
|
/**
|
|
620
|
-
* @
|
|
621
|
-
* <p>Removes the <code>PublicAccessBlock</code> configuration for an Amazon Web Services account. For more
|
|
622
|
-
* information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/access-control-block-public-access.html"> Using Amazon S3 block
|
|
623
|
-
* public access</a>.</p>
|
|
624
|
-
* <p>Related actions include:</p>
|
|
625
|
-
* <ul>
|
|
626
|
-
* <li>
|
|
627
|
-
* <p>
|
|
628
|
-
* <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_GetPublicAccessBlock.html">GetPublicAccessBlock</a>
|
|
629
|
-
* </p>
|
|
630
|
-
* </li>
|
|
631
|
-
* <li>
|
|
632
|
-
* <p>
|
|
633
|
-
* <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_PutPublicAccessBlock.html">PutPublicAccessBlock</a>
|
|
634
|
-
* </p>
|
|
635
|
-
* </li>
|
|
636
|
-
* </ul>
|
|
165
|
+
* @see {@link DeletePublicAccessBlockCommand}
|
|
637
166
|
*/
|
|
638
167
|
deletePublicAccessBlock(args: DeletePublicAccessBlockCommandInput, options?: __HttpHandlerOptions): Promise<DeletePublicAccessBlockCommandOutput>;
|
|
639
168
|
deletePublicAccessBlock(args: DeletePublicAccessBlockCommandInput, cb: (err: any, data?: DeletePublicAccessBlockCommandOutput) => void): void;
|
|
640
169
|
deletePublicAccessBlock(args: DeletePublicAccessBlockCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeletePublicAccessBlockCommandOutput) => void): void;
|
|
641
170
|
/**
|
|
642
|
-
* @
|
|
643
|
-
* <p>Deletes the Amazon S3 Storage Lens configuration. For more information about S3 Storage Lens, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/storage_lens.html">Assessing your storage
|
|
644
|
-
* activity and usage with Amazon S3 Storage Lens </a> in the
|
|
645
|
-
* <i>Amazon S3 User Guide</i>.</p>
|
|
646
|
-
* <note>
|
|
647
|
-
* <p>To use this action, you must have permission to perform the
|
|
648
|
-
* <code>s3:DeleteStorageLensConfiguration</code> action. For more information, see
|
|
649
|
-
* <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/storage_lens_iam_permissions.html">Setting permissions to
|
|
650
|
-
* use Amazon S3 Storage Lens</a> in the <i>Amazon S3 User Guide</i>.</p>
|
|
651
|
-
* </note>
|
|
171
|
+
* @see {@link DeleteStorageLensConfigurationCommand}
|
|
652
172
|
*/
|
|
653
173
|
deleteStorageLensConfiguration(args: DeleteStorageLensConfigurationCommandInput, options?: __HttpHandlerOptions): Promise<DeleteStorageLensConfigurationCommandOutput>;
|
|
654
174
|
deleteStorageLensConfiguration(args: DeleteStorageLensConfigurationCommandInput, cb: (err: any, data?: DeleteStorageLensConfigurationCommandOutput) => void): void;
|
|
655
175
|
deleteStorageLensConfiguration(args: DeleteStorageLensConfigurationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteStorageLensConfigurationCommandOutput) => void): void;
|
|
656
176
|
/**
|
|
657
|
-
* @
|
|
658
|
-
* <p>Deletes the Amazon S3 Storage Lens configuration tags. For more information about S3 Storage Lens, see
|
|
659
|
-
* <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/storage_lens.html">Assessing your
|
|
660
|
-
* storage activity and usage with Amazon S3 Storage Lens </a> in the
|
|
661
|
-
* <i>Amazon S3 User Guide</i>.</p>
|
|
662
|
-
* <note>
|
|
663
|
-
* <p>To use this action, you must have permission to perform the
|
|
664
|
-
* <code>s3:DeleteStorageLensConfigurationTagging</code> action. For more information,
|
|
665
|
-
* see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/storage_lens_iam_permissions.html">Setting permissions to
|
|
666
|
-
* use Amazon S3 Storage Lens</a> in the <i>Amazon S3 User Guide</i>.</p>
|
|
667
|
-
* </note>
|
|
177
|
+
* @see {@link DeleteStorageLensConfigurationTaggingCommand}
|
|
668
178
|
*/
|
|
669
179
|
deleteStorageLensConfigurationTagging(args: DeleteStorageLensConfigurationTaggingCommandInput, options?: __HttpHandlerOptions): Promise<DeleteStorageLensConfigurationTaggingCommandOutput>;
|
|
670
180
|
deleteStorageLensConfigurationTagging(args: DeleteStorageLensConfigurationTaggingCommandInput, cb: (err: any, data?: DeleteStorageLensConfigurationTaggingCommandOutput) => void): void;
|
|
671
181
|
deleteStorageLensConfigurationTagging(args: DeleteStorageLensConfigurationTaggingCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteStorageLensConfigurationTaggingCommandOutput) => void): void;
|
|
672
182
|
/**
|
|
673
|
-
* @
|
|
674
|
-
* <p>Retrieves the configuration parameters and status for a Batch Operations job. For more
|
|
675
|
-
* information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/batch-ops.html">S3 Batch Operations</a> in the <i>Amazon S3 User Guide</i>.</p>
|
|
676
|
-
* <p></p>
|
|
677
|
-
* <p>Related actions include:</p>
|
|
678
|
-
* <ul>
|
|
679
|
-
* <li>
|
|
680
|
-
* <p>
|
|
681
|
-
* <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_CreateJob.html">CreateJob</a>
|
|
682
|
-
* </p>
|
|
683
|
-
* </li>
|
|
684
|
-
* <li>
|
|
685
|
-
* <p>
|
|
686
|
-
* <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_ListJobs.html">ListJobs</a>
|
|
687
|
-
* </p>
|
|
688
|
-
* </li>
|
|
689
|
-
* <li>
|
|
690
|
-
* <p>
|
|
691
|
-
* <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_UpdateJobPriority.html">UpdateJobPriority</a>
|
|
692
|
-
* </p>
|
|
693
|
-
* </li>
|
|
694
|
-
* <li>
|
|
695
|
-
* <p>
|
|
696
|
-
* <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_UpdateJobStatus.html">UpdateJobStatus</a>
|
|
697
|
-
* </p>
|
|
698
|
-
* </li>
|
|
699
|
-
* </ul>
|
|
183
|
+
* @see {@link DescribeJobCommand}
|
|
700
184
|
*/
|
|
701
185
|
describeJob(args: DescribeJobCommandInput, options?: __HttpHandlerOptions): Promise<DescribeJobCommandOutput>;
|
|
702
186
|
describeJob(args: DescribeJobCommandInput, cb: (err: any, data?: DescribeJobCommandOutput) => void): void;
|
|
703
187
|
describeJob(args: DescribeJobCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeJobCommandOutput) => void): void;
|
|
704
188
|
/**
|
|
705
|
-
* @
|
|
706
|
-
* <p>Retrieves the status of an asynchronous request to manage a Multi-Region Access Point. For more information
|
|
707
|
-
* about managing Multi-Region Access Points and how asynchronous requests work, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/ManagingMultiRegionAccessPoints.html">Managing
|
|
708
|
-
* Multi-Region Access Points</a> in the <i>Amazon S3 User Guide</i>.</p>
|
|
709
|
-
* <p>The following actions are related to <code>GetMultiRegionAccessPoint</code>:</p>
|
|
710
|
-
* <ul>
|
|
711
|
-
* <li>
|
|
712
|
-
* <p>
|
|
713
|
-
* <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_CreateMultiRegionAccessPoint.html">CreateMultiRegionAccessPoint</a>
|
|
714
|
-
* </p>
|
|
715
|
-
* </li>
|
|
716
|
-
* <li>
|
|
717
|
-
* <p>
|
|
718
|
-
* <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_DeleteMultiRegionAccessPoint.html">DeleteMultiRegionAccessPoint</a>
|
|
719
|
-
* </p>
|
|
720
|
-
* </li>
|
|
721
|
-
* <li>
|
|
722
|
-
* <p>
|
|
723
|
-
* <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_GetMultiRegionAccessPoint.html">GetMultiRegionAccessPoint</a>
|
|
724
|
-
* </p>
|
|
725
|
-
* </li>
|
|
726
|
-
* <li>
|
|
727
|
-
* <p>
|
|
728
|
-
* <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_ListMultiRegionAccessPoints.html">ListMultiRegionAccessPoints</a>
|
|
729
|
-
* </p>
|
|
730
|
-
* </li>
|
|
731
|
-
* </ul>
|
|
189
|
+
* @see {@link DescribeMultiRegionAccessPointOperationCommand}
|
|
732
190
|
*/
|
|
733
191
|
describeMultiRegionAccessPointOperation(args: DescribeMultiRegionAccessPointOperationCommandInput, options?: __HttpHandlerOptions): Promise<DescribeMultiRegionAccessPointOperationCommandOutput>;
|
|
734
192
|
describeMultiRegionAccessPointOperation(args: DescribeMultiRegionAccessPointOperationCommandInput, cb: (err: any, data?: DescribeMultiRegionAccessPointOperationCommandOutput) => void): void;
|
|
735
193
|
describeMultiRegionAccessPointOperation(args: DescribeMultiRegionAccessPointOperationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeMultiRegionAccessPointOperationCommandOutput) => void): void;
|
|
736
194
|
/**
|
|
737
|
-
* @
|
|
738
|
-
* <p>Returns configuration information about the specified access point.</p>
|
|
739
|
-
* <p></p>
|
|
740
|
-
* <p>All Amazon S3 on Outposts REST API requests for this action require an additional parameter of <code>x-amz-outpost-id</code> to be passed with the request. In addition, you must use an S3 on Outposts endpoint hostname prefix instead of <code>s3-control</code>. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and the <code>x-amz-outpost-id</code> derived by using the access point ARN, see the <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_GetAccessPoint.html#API_control_GetAccessPoint_Examples">Examples</a> section.</p>
|
|
741
|
-
* <p>The following actions are related to <code>GetAccessPoint</code>:</p>
|
|
742
|
-
* <ul>
|
|
743
|
-
* <li>
|
|
744
|
-
* <p>
|
|
745
|
-
* <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_CreateAccessPoint.html">CreateAccessPoint</a>
|
|
746
|
-
* </p>
|
|
747
|
-
* </li>
|
|
748
|
-
* <li>
|
|
749
|
-
* <p>
|
|
750
|
-
* <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_DeleteAccessPoint.html">DeleteAccessPoint</a>
|
|
751
|
-
* </p>
|
|
752
|
-
* </li>
|
|
753
|
-
* <li>
|
|
754
|
-
* <p>
|
|
755
|
-
* <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_ListAccessPoints.html">ListAccessPoints</a>
|
|
756
|
-
* </p>
|
|
757
|
-
* </li>
|
|
758
|
-
* </ul>
|
|
195
|
+
* @see {@link GetAccessPointCommand}
|
|
759
196
|
*/
|
|
760
197
|
getAccessPoint(args: GetAccessPointCommandInput, options?: __HttpHandlerOptions): Promise<GetAccessPointCommandOutput>;
|
|
761
198
|
getAccessPoint(args: GetAccessPointCommandInput, cb: (err: any, data?: GetAccessPointCommandOutput) => void): void;
|
|
762
199
|
getAccessPoint(args: GetAccessPointCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetAccessPointCommandOutput) => void): void;
|
|
763
200
|
/**
|
|
764
|
-
* @
|
|
765
|
-
* <p>Returns configuration for an Object Lambda Access Point.</p>
|
|
766
|
-
* <p>The following actions are related to
|
|
767
|
-
* <code>GetAccessPointConfigurationForObjectLambda</code>:</p>
|
|
768
|
-
* <ul>
|
|
769
|
-
* <li>
|
|
770
|
-
* <p>
|
|
771
|
-
* <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_PutAccessPointConfigurationForObjectLambda.html">PutAccessPointConfigurationForObjectLambda</a>
|
|
772
|
-
* </p>
|
|
773
|
-
* </li>
|
|
774
|
-
* </ul>
|
|
201
|
+
* @see {@link GetAccessPointConfigurationForObjectLambdaCommand}
|
|
775
202
|
*/
|
|
776
203
|
getAccessPointConfigurationForObjectLambda(args: GetAccessPointConfigurationForObjectLambdaCommandInput, options?: __HttpHandlerOptions): Promise<GetAccessPointConfigurationForObjectLambdaCommandOutput>;
|
|
777
204
|
getAccessPointConfigurationForObjectLambda(args: GetAccessPointConfigurationForObjectLambdaCommandInput, cb: (err: any, data?: GetAccessPointConfigurationForObjectLambdaCommandOutput) => void): void;
|
|
778
205
|
getAccessPointConfigurationForObjectLambda(args: GetAccessPointConfigurationForObjectLambdaCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetAccessPointConfigurationForObjectLambdaCommandOutput) => void): void;
|
|
779
206
|
/**
|
|
780
|
-
* @
|
|
781
|
-
* <p>Returns configuration information about the specified Object Lambda Access Point</p>
|
|
782
|
-
* <p>The following actions are related to <code>GetAccessPointForObjectLambda</code>:</p>
|
|
783
|
-
* <ul>
|
|
784
|
-
* <li>
|
|
785
|
-
* <p>
|
|
786
|
-
* <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_CreateAccessPointForObjectLambda.html">CreateAccessPointForObjectLambda</a>
|
|
787
|
-
* </p>
|
|
788
|
-
* </li>
|
|
789
|
-
* <li>
|
|
790
|
-
* <p>
|
|
791
|
-
* <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_DeleteAccessPointForObjectLambda.html">DeleteAccessPointForObjectLambda</a>
|
|
792
|
-
* </p>
|
|
793
|
-
* </li>
|
|
794
|
-
* <li>
|
|
795
|
-
* <p>
|
|
796
|
-
* <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_ListAccessPointsForObjectLambda.html">ListAccessPointsForObjectLambda</a>
|
|
797
|
-
* </p>
|
|
798
|
-
* </li>
|
|
799
|
-
* </ul>
|
|
207
|
+
* @see {@link GetAccessPointForObjectLambdaCommand}
|
|
800
208
|
*/
|
|
801
209
|
getAccessPointForObjectLambda(args: GetAccessPointForObjectLambdaCommandInput, options?: __HttpHandlerOptions): Promise<GetAccessPointForObjectLambdaCommandOutput>;
|
|
802
210
|
getAccessPointForObjectLambda(args: GetAccessPointForObjectLambdaCommandInput, cb: (err: any, data?: GetAccessPointForObjectLambdaCommandOutput) => void): void;
|
|
803
211
|
getAccessPointForObjectLambda(args: GetAccessPointForObjectLambdaCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetAccessPointForObjectLambdaCommandOutput) => void): void;
|
|
804
212
|
/**
|
|
805
|
-
* @
|
|
806
|
-
* <p>Returns the access point policy associated with the specified access point.</p>
|
|
807
|
-
* <p>The following actions are related to <code>GetAccessPointPolicy</code>:</p>
|
|
808
|
-
* <ul>
|
|
809
|
-
* <li>
|
|
810
|
-
* <p>
|
|
811
|
-
* <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_PutAccessPointPolicy.html">PutAccessPointPolicy</a>
|
|
812
|
-
* </p>
|
|
813
|
-
* </li>
|
|
814
|
-
* <li>
|
|
815
|
-
* <p>
|
|
816
|
-
* <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_DeleteAccessPointPolicy.html">DeleteAccessPointPolicy</a>
|
|
817
|
-
* </p>
|
|
818
|
-
* </li>
|
|
819
|
-
* </ul>
|
|
213
|
+
* @see {@link GetAccessPointPolicyCommand}
|
|
820
214
|
*/
|
|
821
215
|
getAccessPointPolicy(args: GetAccessPointPolicyCommandInput, options?: __HttpHandlerOptions): Promise<GetAccessPointPolicyCommandOutput>;
|
|
822
216
|
getAccessPointPolicy(args: GetAccessPointPolicyCommandInput, cb: (err: any, data?: GetAccessPointPolicyCommandOutput) => void): void;
|
|
823
217
|
getAccessPointPolicy(args: GetAccessPointPolicyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetAccessPointPolicyCommandOutput) => void): void;
|
|
824
218
|
/**
|
|
825
|
-
* @
|
|
826
|
-
* <p>Returns the resource policy for an Object Lambda Access Point.</p>
|
|
827
|
-
* <p>The following actions are related to
|
|
828
|
-
* <code>GetAccessPointPolicyForObjectLambda</code>:</p>
|
|
829
|
-
* <ul>
|
|
830
|
-
* <li>
|
|
831
|
-
* <p>
|
|
832
|
-
* <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_DeleteAccessPointPolicyForObjectLambda.html">DeleteAccessPointPolicyForObjectLambda</a>
|
|
833
|
-
* </p>
|
|
834
|
-
* </li>
|
|
835
|
-
* <li>
|
|
836
|
-
* <p>
|
|
837
|
-
* <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_PutAccessPointPolicyForObjectLambda.html">PutAccessPointPolicyForObjectLambda</a>
|
|
838
|
-
* </p>
|
|
839
|
-
* </li>
|
|
840
|
-
* </ul>
|
|
219
|
+
* @see {@link GetAccessPointPolicyForObjectLambdaCommand}
|
|
841
220
|
*/
|
|
842
221
|
getAccessPointPolicyForObjectLambda(args: GetAccessPointPolicyForObjectLambdaCommandInput, options?: __HttpHandlerOptions): Promise<GetAccessPointPolicyForObjectLambdaCommandOutput>;
|
|
843
222
|
getAccessPointPolicyForObjectLambda(args: GetAccessPointPolicyForObjectLambdaCommandInput, cb: (err: any, data?: GetAccessPointPolicyForObjectLambdaCommandOutput) => void): void;
|
|
844
223
|
getAccessPointPolicyForObjectLambda(args: GetAccessPointPolicyForObjectLambdaCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetAccessPointPolicyForObjectLambdaCommandOutput) => void): void;
|
|
845
224
|
/**
|
|
846
|
-
* @
|
|
847
|
-
* <p>Indicates whether the specified access point currently has a policy that allows public access.
|
|
848
|
-
* For more information about public access through access points, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/access-points.html">Managing Data Access with Amazon S3
|
|
849
|
-
* access points</a> in the <i>Amazon S3 User Guide</i>.</p>
|
|
225
|
+
* @see {@link GetAccessPointPolicyStatusCommand}
|
|
850
226
|
*/
|
|
851
227
|
getAccessPointPolicyStatus(args: GetAccessPointPolicyStatusCommandInput, options?: __HttpHandlerOptions): Promise<GetAccessPointPolicyStatusCommandOutput>;
|
|
852
228
|
getAccessPointPolicyStatus(args: GetAccessPointPolicyStatusCommandInput, cb: (err: any, data?: GetAccessPointPolicyStatusCommandOutput) => void): void;
|
|
853
229
|
getAccessPointPolicyStatus(args: GetAccessPointPolicyStatusCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetAccessPointPolicyStatusCommandOutput) => void): void;
|
|
854
230
|
/**
|
|
855
|
-
* @
|
|
856
|
-
* <p>Returns the status of the resource policy associated with an Object Lambda Access Point.</p>
|
|
231
|
+
* @see {@link GetAccessPointPolicyStatusForObjectLambdaCommand}
|
|
857
232
|
*/
|
|
858
233
|
getAccessPointPolicyStatusForObjectLambda(args: GetAccessPointPolicyStatusForObjectLambdaCommandInput, options?: __HttpHandlerOptions): Promise<GetAccessPointPolicyStatusForObjectLambdaCommandOutput>;
|
|
859
234
|
getAccessPointPolicyStatusForObjectLambda(args: GetAccessPointPolicyStatusForObjectLambdaCommandInput, cb: (err: any, data?: GetAccessPointPolicyStatusForObjectLambdaCommandOutput) => void): void;
|
|
860
235
|
getAccessPointPolicyStatusForObjectLambda(args: GetAccessPointPolicyStatusForObjectLambdaCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetAccessPointPolicyStatusForObjectLambdaCommandOutput) => void): void;
|
|
861
236
|
/**
|
|
862
|
-
* @
|
|
863
|
-
* <p>Gets an Amazon S3 on Outposts bucket. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html"> Using Amazon S3 on Outposts</a> in the
|
|
864
|
-
* <i>Amazon S3 User Guide</i>.</p>
|
|
865
|
-
* <p>If you are using an identity other than the root user of the Amazon Web Services account that owns the
|
|
866
|
-
* Outposts bucket, the calling identity must have the <code>s3-outposts:GetBucket</code>
|
|
867
|
-
* permissions on the specified Outposts bucket and belong to the Outposts bucket owner's
|
|
868
|
-
* account in order to use this action. Only users from Outposts bucket owner account with
|
|
869
|
-
* the right permissions can perform actions on an Outposts bucket. </p>
|
|
870
|
-
* <p> If you don't have <code>s3-outposts:GetBucket</code> permissions or you're not using an
|
|
871
|
-
* identity that belongs to the bucket owner's account, Amazon S3 returns a <code>403 Access
|
|
872
|
-
* Denied</code> error.</p>
|
|
873
|
-
* <p>The following actions are related to <code>GetBucket</code> for Amazon S3 on Outposts:</p>
|
|
874
|
-
* <p>All Amazon S3 on Outposts REST API requests for this action require an additional parameter of <code>x-amz-outpost-id</code> to be passed with the request. In addition, you must use an S3 on Outposts endpoint hostname prefix instead of <code>s3-control</code>. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and the <code>x-amz-outpost-id</code> derived by using the access point ARN, see the <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_GetBucket.html#API_control_GetBucket_Examples">Examples</a> section.</p>
|
|
875
|
-
* <ul>
|
|
876
|
-
* <li>
|
|
877
|
-
* <p>
|
|
878
|
-
* <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutObject.html">PutObject</a>
|
|
879
|
-
* </p>
|
|
880
|
-
* </li>
|
|
881
|
-
* <li>
|
|
882
|
-
* <p>
|
|
883
|
-
* <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_CreateBucket.html">CreateBucket</a>
|
|
884
|
-
* </p>
|
|
885
|
-
* </li>
|
|
886
|
-
* <li>
|
|
887
|
-
* <p>
|
|
888
|
-
* <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_DeleteBucket.html">DeleteBucket</a>
|
|
889
|
-
* </p>
|
|
890
|
-
* </li>
|
|
891
|
-
* </ul>
|
|
237
|
+
* @see {@link GetBucketCommand}
|
|
892
238
|
*/
|
|
893
239
|
getBucket(args: GetBucketCommandInput, options?: __HttpHandlerOptions): Promise<GetBucketCommandOutput>;
|
|
894
240
|
getBucket(args: GetBucketCommandInput, cb: (err: any, data?: GetBucketCommandOutput) => void): void;
|
|
895
241
|
getBucket(args: GetBucketCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetBucketCommandOutput) => void): void;
|
|
896
242
|
/**
|
|
897
|
-
* @
|
|
898
|
-
* <note>
|
|
899
|
-
* <p>This action gets an Amazon S3 on Outposts bucket's lifecycle configuration. To get an S3
|
|
900
|
-
* bucket's lifecycle configuration, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketLifecycleConfiguration.html">GetBucketLifecycleConfiguration</a> in the <i>Amazon S3 API Reference</i>.
|
|
901
|
-
* </p>
|
|
902
|
-
* </note>
|
|
903
|
-
* <p>Returns the lifecycle configuration information set on the Outposts bucket. For more
|
|
904
|
-
* information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html">Using Amazon S3 on Outposts</a> and for
|
|
905
|
-
* information about lifecycle configuration, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/object-lifecycle-mgmt.html"> Object Lifecycle
|
|
906
|
-
* Management</a> in <i>Amazon S3 User Guide</i>.</p>
|
|
907
|
-
* <p>To use this action, you must have permission to perform the
|
|
908
|
-
* <code>s3-outposts:GetLifecycleConfiguration</code> action. The Outposts bucket owner
|
|
909
|
-
* has this permission, by default. The bucket owner can grant this permission to others. For
|
|
910
|
-
* 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
|
|
911
|
-
* Access Permissions to Your Amazon S3 Resources</a>.</p>
|
|
912
|
-
* <p>All Amazon S3 on Outposts REST API requests for this action require an additional parameter of <code>x-amz-outpost-id</code> to be passed with the request. In addition, you must use an S3 on Outposts endpoint hostname prefix instead of <code>s3-control</code>. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and the <code>x-amz-outpost-id</code> derived by using the access point ARN, see the <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_GetBucketLifecycleConfiguration.html#API_control_GetBucketLifecycleConfiguration_Examples">Examples</a> section.</p>
|
|
913
|
-
* <p>
|
|
914
|
-
* <code>GetBucketLifecycleConfiguration</code> has the following special error:</p>
|
|
915
|
-
* <ul>
|
|
916
|
-
* <li>
|
|
917
|
-
* <p>Error code: <code>NoSuchLifecycleConfiguration</code>
|
|
918
|
-
* </p>
|
|
919
|
-
* <ul>
|
|
920
|
-
* <li>
|
|
921
|
-
* <p>Description: The lifecycle configuration does not exist.</p>
|
|
922
|
-
* </li>
|
|
923
|
-
* <li>
|
|
924
|
-
* <p>HTTP Status Code: 404 Not Found</p>
|
|
925
|
-
* </li>
|
|
926
|
-
* <li>
|
|
927
|
-
* <p>SOAP Fault Code Prefix: Client</p>
|
|
928
|
-
* </li>
|
|
929
|
-
* </ul>
|
|
930
|
-
* </li>
|
|
931
|
-
* </ul>
|
|
932
|
-
* <p>The following actions are related to
|
|
933
|
-
* <code>GetBucketLifecycleConfiguration</code>:</p>
|
|
934
|
-
* <ul>
|
|
935
|
-
* <li>
|
|
936
|
-
* <p>
|
|
937
|
-
* <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_PutBucketLifecycleConfiguration.html">PutBucketLifecycleConfiguration</a>
|
|
938
|
-
* </p>
|
|
939
|
-
* </li>
|
|
940
|
-
* <li>
|
|
941
|
-
* <p>
|
|
942
|
-
* <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_DeleteBucketLifecycleConfiguration.html">DeleteBucketLifecycleConfiguration</a>
|
|
943
|
-
* </p>
|
|
944
|
-
* </li>
|
|
945
|
-
* </ul>
|
|
243
|
+
* @see {@link GetBucketLifecycleConfigurationCommand}
|
|
946
244
|
*/
|
|
947
245
|
getBucketLifecycleConfiguration(args: GetBucketLifecycleConfigurationCommandInput, options?: __HttpHandlerOptions): Promise<GetBucketLifecycleConfigurationCommandOutput>;
|
|
948
246
|
getBucketLifecycleConfiguration(args: GetBucketLifecycleConfigurationCommandInput, cb: (err: any, data?: GetBucketLifecycleConfigurationCommandOutput) => void): void;
|
|
949
247
|
getBucketLifecycleConfiguration(args: GetBucketLifecycleConfigurationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetBucketLifecycleConfigurationCommandOutput) => void): void;
|
|
950
248
|
/**
|
|
951
|
-
* @
|
|
952
|
-
* <note>
|
|
953
|
-
* <p>This action gets a bucket policy for an Amazon S3 on Outposts bucket. To get a policy for
|
|
954
|
-
* an S3 bucket, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketPolicy.html">GetBucketPolicy</a> in the
|
|
955
|
-
* <i>Amazon S3 API Reference</i>. </p>
|
|
956
|
-
* </note>
|
|
957
|
-
* <p>Returns the policy of a specified Outposts bucket. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html">Using
|
|
958
|
-
* Amazon S3 on Outposts</a> in the <i>Amazon S3 User Guide</i>.</p>
|
|
959
|
-
* <p>If you are using an identity other than the root user of the Amazon Web Services account that owns the
|
|
960
|
-
* bucket, the calling identity must have the <code>GetBucketPolicy</code> permissions on the
|
|
961
|
-
* specified bucket and belong to the bucket owner's account in order to use this
|
|
962
|
-
* action.</p>
|
|
963
|
-
* <p>Only users from Outposts bucket owner account with the right permissions can perform
|
|
964
|
-
* actions on an Outposts bucket. If you don't have <code>s3-outposts:GetBucketPolicy</code>
|
|
965
|
-
* permissions or you're not using an identity that belongs to the bucket owner's account,
|
|
966
|
-
* Amazon S3 returns a <code>403 Access Denied</code> error.</p>
|
|
967
|
-
* <important>
|
|
968
|
-
* <p>As a security precaution, the root user of the Amazon Web Services account that owns a bucket can
|
|
969
|
-
* always use this action, even if the policy explicitly denies the root user the ability
|
|
970
|
-
* to perform this action.</p>
|
|
971
|
-
* </important>
|
|
972
|
-
* <p>For more information about bucket policies, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/using-iam-policies.html">Using Bucket Policies and User
|
|
973
|
-
* Policies</a>.</p>
|
|
974
|
-
* <p>All Amazon S3 on Outposts REST API requests for this action require an additional parameter of <code>x-amz-outpost-id</code> to be passed with the request. In addition, you must use an S3 on Outposts endpoint hostname prefix instead of <code>s3-control</code>. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and the <code>x-amz-outpost-id</code> derived by using the access point ARN, see the <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_GetBucketPolicy.html#API_control_GetBucketPolicy_Examples">Examples</a> section.</p>
|
|
975
|
-
* <p>The following actions are related to <code>GetBucketPolicy</code>:</p>
|
|
976
|
-
* <ul>
|
|
977
|
-
* <li>
|
|
978
|
-
* <p>
|
|
979
|
-
* <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObject.html">GetObject</a>
|
|
980
|
-
* </p>
|
|
981
|
-
* </li>
|
|
982
|
-
* <li>
|
|
983
|
-
* <p>
|
|
984
|
-
* <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_PutBucketPolicy.html">PutBucketPolicy</a>
|
|
985
|
-
* </p>
|
|
986
|
-
* </li>
|
|
987
|
-
* <li>
|
|
988
|
-
* <p>
|
|
989
|
-
* <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_DeleteBucketPolicy.html">DeleteBucketPolicy</a>
|
|
990
|
-
* </p>
|
|
991
|
-
* </li>
|
|
992
|
-
* </ul>
|
|
249
|
+
* @see {@link GetBucketPolicyCommand}
|
|
993
250
|
*/
|
|
994
251
|
getBucketPolicy(args: GetBucketPolicyCommandInput, options?: __HttpHandlerOptions): Promise<GetBucketPolicyCommandOutput>;
|
|
995
252
|
getBucketPolicy(args: GetBucketPolicyCommandInput, cb: (err: any, data?: GetBucketPolicyCommandOutput) => void): void;
|
|
996
253
|
getBucketPolicy(args: GetBucketPolicyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetBucketPolicyCommandOutput) => void): void;
|
|
997
254
|
/**
|
|
998
|
-
* @
|
|
999
|
-
* <note>
|
|
1000
|
-
* <p>This operation gets an Amazon S3 on Outposts bucket's replication configuration. To get an
|
|
1001
|
-
* S3 bucket's replication configuration, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketReplication.html">GetBucketReplication</a>
|
|
1002
|
-
* in the <i>Amazon S3 API Reference</i>. </p>
|
|
1003
|
-
* </note>
|
|
1004
|
-
* <p>Returns the replication configuration of an S3 on Outposts bucket. For more information
|
|
1005
|
-
* about S3 on Outposts, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html">Using Amazon S3 on Outposts</a> in the
|
|
1006
|
-
* <i>Amazon S3 User Guide</i>. For information about S3 replication on Outposts
|
|
1007
|
-
* configuration, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3OutpostsReplication.html">Replicating objects for S3 on Outposts</a> in the <i>Amazon S3 User Guide</i>.</p>
|
|
1008
|
-
* <note>
|
|
1009
|
-
* <p>It can take a while to propagate <code>PUT</code> or <code>DELETE</code> requests for
|
|
1010
|
-
* a replication configuration to all S3 on Outposts systems. Therefore, the replication
|
|
1011
|
-
* configuration that's returned by a <code>GET</code> request soon after a
|
|
1012
|
-
* <code>PUT</code> or <code>DELETE</code> request might return a more recent result
|
|
1013
|
-
* than what's on the Outpost. If an Outpost is offline, the delay in updating the
|
|
1014
|
-
* replication configuration on that Outpost can be significant.</p>
|
|
1015
|
-
* </note>
|
|
1016
|
-
* <p>This action requires permissions for the
|
|
1017
|
-
* <code>s3-outposts:GetReplicationConfiguration</code> action. The Outposts bucket owner
|
|
1018
|
-
* has this permission by default and can grant it to others. For more information about
|
|
1019
|
-
* permissions, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3OutpostsIAM.html">Setting up IAM with
|
|
1020
|
-
* S3 on Outposts</a> and <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3OutpostsBucketPolicy.html">Managing access to
|
|
1021
|
-
* S3 on Outposts bucket</a> in the <i>Amazon S3 User Guide</i>.</p>
|
|
1022
|
-
* <p>All Amazon S3 on Outposts REST API requests for this action require an additional parameter of <code>x-amz-outpost-id</code> to be passed with the request. In addition, you must use an S3 on Outposts endpoint hostname prefix instead of <code>s3-control</code>. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and the <code>x-amz-outpost-id</code> derived by using the access point ARN, see the <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_GetBucketReplication.html#API_control_GetBucketReplication_Examples">Examples</a> section.</p>
|
|
1023
|
-
* <p>If you include the <code>Filter</code> element in a replication configuration, you must
|
|
1024
|
-
* also include the <code>DeleteMarkerReplication</code>, <code>Status</code>, and
|
|
1025
|
-
* <code>Priority</code> elements. The response also returns those elements.</p>
|
|
1026
|
-
* <p>For information about S3 on Outposts replication failure reasons, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/outposts-replication-eventbridge.html#outposts-replication-failure-codes">Replication failure reasons</a> in the <i>Amazon S3 User Guide</i>.</p>
|
|
1027
|
-
* <p>The following operations are related to <code>GetBucketReplication</code>:</p>
|
|
1028
|
-
* <ul>
|
|
1029
|
-
* <li>
|
|
1030
|
-
* <p>
|
|
1031
|
-
* <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_PutBucketReplication.html">PutBucketReplication</a>
|
|
1032
|
-
* </p>
|
|
1033
|
-
* </li>
|
|
1034
|
-
* <li>
|
|
1035
|
-
* <p>
|
|
1036
|
-
* <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_DeleteBucketReplication.html">DeleteBucketReplication</a>
|
|
1037
|
-
* </p>
|
|
1038
|
-
* </li>
|
|
1039
|
-
* </ul>
|
|
255
|
+
* @see {@link GetBucketReplicationCommand}
|
|
1040
256
|
*/
|
|
1041
257
|
getBucketReplication(args: GetBucketReplicationCommandInput, options?: __HttpHandlerOptions): Promise<GetBucketReplicationCommandOutput>;
|
|
1042
258
|
getBucketReplication(args: GetBucketReplicationCommandInput, cb: (err: any, data?: GetBucketReplicationCommandOutput) => void): void;
|
|
1043
259
|
getBucketReplication(args: GetBucketReplicationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetBucketReplicationCommandOutput) => void): void;
|
|
1044
260
|
/**
|
|
1045
|
-
* @
|
|
1046
|
-
* <note>
|
|
1047
|
-
* <p>This action gets an Amazon S3 on Outposts bucket's tags. To get an S3 bucket tags, see
|
|
1048
|
-
* <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketTagging.html">GetBucketTagging</a> in the <i>Amazon S3 API Reference</i>. </p>
|
|
1049
|
-
* </note>
|
|
1050
|
-
* <p>Returns the tag set associated with the Outposts bucket. For more information, see
|
|
1051
|
-
* <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html">Using
|
|
1052
|
-
* Amazon S3 on Outposts</a> in the <i>Amazon S3 User Guide</i>.</p>
|
|
1053
|
-
* <p>To use this action, you must have permission to perform the
|
|
1054
|
-
* <code>GetBucketTagging</code> action. By default, the bucket owner has this permission
|
|
1055
|
-
* and can grant this permission to others.</p>
|
|
1056
|
-
* <p>
|
|
1057
|
-
* <code>GetBucketTagging</code> has the following special error:</p>
|
|
1058
|
-
* <ul>
|
|
1059
|
-
* <li>
|
|
1060
|
-
* <p>Error code: <code>NoSuchTagSetError</code>
|
|
1061
|
-
* </p>
|
|
1062
|
-
* <ul>
|
|
1063
|
-
* <li>
|
|
1064
|
-
* <p>Description: There is no tag set associated with the bucket.</p>
|
|
1065
|
-
* </li>
|
|
1066
|
-
* </ul>
|
|
1067
|
-
* </li>
|
|
1068
|
-
* </ul>
|
|
1069
|
-
* <p>All Amazon S3 on Outposts REST API requests for this action require an additional parameter of <code>x-amz-outpost-id</code> to be passed with the request. In addition, you must use an S3 on Outposts endpoint hostname prefix instead of <code>s3-control</code>. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and the <code>x-amz-outpost-id</code> derived by using the access point ARN, see the <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_GetBucketTagging.html#API_control_GetBucketTagging_Examples">Examples</a> section.</p>
|
|
1070
|
-
* <p>The following actions are related to <code>GetBucketTagging</code>:</p>
|
|
1071
|
-
* <ul>
|
|
1072
|
-
* <li>
|
|
1073
|
-
* <p>
|
|
1074
|
-
* <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_PutBucketTagging.html">PutBucketTagging</a>
|
|
1075
|
-
* </p>
|
|
1076
|
-
* </li>
|
|
1077
|
-
* <li>
|
|
1078
|
-
* <p>
|
|
1079
|
-
* <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_DeleteBucketTagging.html">DeleteBucketTagging</a>
|
|
1080
|
-
* </p>
|
|
1081
|
-
* </li>
|
|
1082
|
-
* </ul>
|
|
261
|
+
* @see {@link GetBucketTaggingCommand}
|
|
1083
262
|
*/
|
|
1084
263
|
getBucketTagging(args: GetBucketTaggingCommandInput, options?: __HttpHandlerOptions): Promise<GetBucketTaggingCommandOutput>;
|
|
1085
264
|
getBucketTagging(args: GetBucketTaggingCommandInput, cb: (err: any, data?: GetBucketTaggingCommandOutput) => void): void;
|
|
1086
265
|
getBucketTagging(args: GetBucketTaggingCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetBucketTaggingCommandOutput) => void): void;
|
|
1087
266
|
/**
|
|
1088
|
-
* @
|
|
1089
|
-
* <note>
|
|
1090
|
-
* <p>This operation returns the versioning state
|
|
1091
|
-
* for
|
|
1092
|
-
* S3 on Outposts
|
|
1093
|
-
* buckets
|
|
1094
|
-
* only. To return the versioning state for an S3 bucket, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketVersioning.html">GetBucketVersioning</a> in the <i>Amazon S3 API Reference</i>. </p>
|
|
1095
|
-
* </note>
|
|
1096
|
-
* <p>Returns the versioning state for an S3 on Outposts bucket. With
|
|
1097
|
-
* S3
|
|
1098
|
-
* Versioning,
|
|
1099
|
-
* you can save multiple distinct copies of your
|
|
1100
|
-
* objects
|
|
1101
|
-
* and recover from unintended user actions and application failures.</p>
|
|
1102
|
-
* <p>If you've never set versioning on your bucket, it has no versioning state. In that case,
|
|
1103
|
-
* the <code>GetBucketVersioning</code> request does not return a versioning state
|
|
1104
|
-
* value.</p>
|
|
1105
|
-
* <p>For more information about versioning, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/Versioning.html">Versioning</a> in the <i>Amazon S3
|
|
1106
|
-
* User Guide</i>.</p>
|
|
1107
|
-
* <p>All Amazon S3 on Outposts REST API requests for this action require an additional parameter of <code>x-amz-outpost-id</code> to be passed with the request. In addition, you must use an S3 on Outposts endpoint hostname prefix instead of <code>s3-control</code>. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and the <code>x-amz-outpost-id</code> derived by using the access point ARN, see the <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_GetBucketVersioning.html#API_control_GetBucketVersioning_Examples">Examples</a> section.</p>
|
|
1108
|
-
* <p>The following operations are related to <code>GetBucketVersioning</code> for
|
|
1109
|
-
* S3 on Outposts.</p>
|
|
1110
|
-
* <ul>
|
|
1111
|
-
* <li>
|
|
1112
|
-
* <p>
|
|
1113
|
-
* <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_PutBucketVersioning.html">PutBucketVersioning</a>
|
|
1114
|
-
* </p>
|
|
1115
|
-
* </li>
|
|
1116
|
-
* <li>
|
|
1117
|
-
* <p>
|
|
1118
|
-
* <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_PutBucketLifecycleConfiguration.html">PutBucketLifecycleConfiguration</a>
|
|
1119
|
-
* </p>
|
|
1120
|
-
* </li>
|
|
1121
|
-
* <li>
|
|
1122
|
-
* <p>
|
|
1123
|
-
* <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_GetBucketLifecycleConfiguration.html">GetBucketLifecycleConfiguration</a>
|
|
1124
|
-
* </p>
|
|
1125
|
-
* </li>
|
|
1126
|
-
* </ul>
|
|
267
|
+
* @see {@link GetBucketVersioningCommand}
|
|
1127
268
|
*/
|
|
1128
269
|
getBucketVersioning(args: GetBucketVersioningCommandInput, options?: __HttpHandlerOptions): Promise<GetBucketVersioningCommandOutput>;
|
|
1129
270
|
getBucketVersioning(args: GetBucketVersioningCommandInput, cb: (err: any, data?: GetBucketVersioningCommandOutput) => void): void;
|
|
1130
271
|
getBucketVersioning(args: GetBucketVersioningCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetBucketVersioningCommandOutput) => void): void;
|
|
1131
272
|
/**
|
|
1132
|
-
* @
|
|
1133
|
-
* <p>Returns the tags on an S3 Batch Operations job. To use
|
|
1134
|
-
* the
|
|
1135
|
-
* <code>GetJobTagging</code> operation, you must have permission to
|
|
1136
|
-
* perform the <code>s3:GetJobTagging</code> action. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/batch-ops-managing-jobs.html#batch-ops-job-tags">Controlling
|
|
1137
|
-
* access and labeling jobs using tags</a> in the
|
|
1138
|
-
* <i>Amazon S3 User Guide</i>.</p>
|
|
1139
|
-
* <p></p>
|
|
1140
|
-
* <p>Related actions include:</p>
|
|
1141
|
-
* <ul>
|
|
1142
|
-
* <li>
|
|
1143
|
-
* <p>
|
|
1144
|
-
* <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_CreateJob.html">CreateJob</a>
|
|
1145
|
-
* </p>
|
|
1146
|
-
* </li>
|
|
1147
|
-
* <li>
|
|
1148
|
-
* <p>
|
|
1149
|
-
* <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_PutJobTagging.html">PutJobTagging</a>
|
|
1150
|
-
* </p>
|
|
1151
|
-
* </li>
|
|
1152
|
-
* <li>
|
|
1153
|
-
* <p>
|
|
1154
|
-
* <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_DeleteJobTagging.html">DeleteJobTagging</a>
|
|
1155
|
-
* </p>
|
|
1156
|
-
* </li>
|
|
1157
|
-
* </ul>
|
|
273
|
+
* @see {@link GetJobTaggingCommand}
|
|
1158
274
|
*/
|
|
1159
275
|
getJobTagging(args: GetJobTaggingCommandInput, options?: __HttpHandlerOptions): Promise<GetJobTaggingCommandOutput>;
|
|
1160
276
|
getJobTagging(args: GetJobTaggingCommandInput, cb: (err: any, data?: GetJobTaggingCommandOutput) => void): void;
|
|
1161
277
|
getJobTagging(args: GetJobTaggingCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetJobTaggingCommandOutput) => void): void;
|
|
1162
278
|
/**
|
|
1163
|
-
* @
|
|
1164
|
-
* <p>Returns configuration information about the specified Multi-Region Access Point.</p>
|
|
1165
|
-
* <p>This action will always be routed to the US West (Oregon) Region. For more information
|
|
1166
|
-
* about the restrictions around managing Multi-Region Access Points, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/ManagingMultiRegionAccessPoints.html">Managing
|
|
1167
|
-
* Multi-Region Access Points</a> in the <i>Amazon S3 User Guide</i>.</p>
|
|
1168
|
-
* <p>The following actions are related to <code>GetMultiRegionAccessPoint</code>:</p>
|
|
1169
|
-
* <ul>
|
|
1170
|
-
* <li>
|
|
1171
|
-
* <p>
|
|
1172
|
-
* <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_CreateMultiRegionAccessPoint.html">CreateMultiRegionAccessPoint</a>
|
|
1173
|
-
* </p>
|
|
1174
|
-
* </li>
|
|
1175
|
-
* <li>
|
|
1176
|
-
* <p>
|
|
1177
|
-
* <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_DeleteMultiRegionAccessPoint.html">DeleteMultiRegionAccessPoint</a>
|
|
1178
|
-
* </p>
|
|
1179
|
-
* </li>
|
|
1180
|
-
* <li>
|
|
1181
|
-
* <p>
|
|
1182
|
-
* <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_DescribeMultiRegionAccessPointOperation.html">DescribeMultiRegionAccessPointOperation</a>
|
|
1183
|
-
* </p>
|
|
1184
|
-
* </li>
|
|
1185
|
-
* <li>
|
|
1186
|
-
* <p>
|
|
1187
|
-
* <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_ListMultiRegionAccessPoints.html">ListMultiRegionAccessPoints</a>
|
|
1188
|
-
* </p>
|
|
1189
|
-
* </li>
|
|
1190
|
-
* </ul>
|
|
279
|
+
* @see {@link GetMultiRegionAccessPointCommand}
|
|
1191
280
|
*/
|
|
1192
281
|
getMultiRegionAccessPoint(args: GetMultiRegionAccessPointCommandInput, options?: __HttpHandlerOptions): Promise<GetMultiRegionAccessPointCommandOutput>;
|
|
1193
282
|
getMultiRegionAccessPoint(args: GetMultiRegionAccessPointCommandInput, cb: (err: any, data?: GetMultiRegionAccessPointCommandOutput) => void): void;
|
|
1194
283
|
getMultiRegionAccessPoint(args: GetMultiRegionAccessPointCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetMultiRegionAccessPointCommandOutput) => void): void;
|
|
1195
284
|
/**
|
|
1196
|
-
* @
|
|
1197
|
-
* <p>Returns the access control policy of the specified Multi-Region Access Point.</p>
|
|
1198
|
-
* <p>This action will always be routed to the US West (Oregon) Region. For more information
|
|
1199
|
-
* about the restrictions around managing Multi-Region Access Points, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/ManagingMultiRegionAccessPoints.html">Managing
|
|
1200
|
-
* Multi-Region Access Points</a> in the <i>Amazon S3 User Guide</i>.</p>
|
|
1201
|
-
* <p>The following actions are related to
|
|
1202
|
-
* <code>GetMultiRegionAccessPointPolicy</code>:</p>
|
|
1203
|
-
* <ul>
|
|
1204
|
-
* <li>
|
|
1205
|
-
* <p>
|
|
1206
|
-
* <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_GetMultiRegionAccessPointPolicyStatus.html">GetMultiRegionAccessPointPolicyStatus</a>
|
|
1207
|
-
* </p>
|
|
1208
|
-
* </li>
|
|
1209
|
-
* <li>
|
|
1210
|
-
* <p>
|
|
1211
|
-
* <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_PutMultiRegionAccessPointPolicy.html">PutMultiRegionAccessPointPolicy</a>
|
|
1212
|
-
* </p>
|
|
1213
|
-
* </li>
|
|
1214
|
-
* </ul>
|
|
285
|
+
* @see {@link GetMultiRegionAccessPointPolicyCommand}
|
|
1215
286
|
*/
|
|
1216
287
|
getMultiRegionAccessPointPolicy(args: GetMultiRegionAccessPointPolicyCommandInput, options?: __HttpHandlerOptions): Promise<GetMultiRegionAccessPointPolicyCommandOutput>;
|
|
1217
288
|
getMultiRegionAccessPointPolicy(args: GetMultiRegionAccessPointPolicyCommandInput, cb: (err: any, data?: GetMultiRegionAccessPointPolicyCommandOutput) => void): void;
|
|
1218
289
|
getMultiRegionAccessPointPolicy(args: GetMultiRegionAccessPointPolicyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetMultiRegionAccessPointPolicyCommandOutput) => void): void;
|
|
1219
290
|
/**
|
|
1220
|
-
* @
|
|
1221
|
-
* <p>Indicates whether the specified Multi-Region Access Point has an access control policy that allows public
|
|
1222
|
-
* access.</p>
|
|
1223
|
-
* <p>This action will always be routed to the US West (Oregon) Region. For more information
|
|
1224
|
-
* about the restrictions around managing Multi-Region Access Points, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/ManagingMultiRegionAccessPoints.html">Managing
|
|
1225
|
-
* Multi-Region Access Points</a> in the <i>Amazon S3 User Guide</i>.</p>
|
|
1226
|
-
* <p>The following actions are related to
|
|
1227
|
-
* <code>GetMultiRegionAccessPointPolicyStatus</code>:</p>
|
|
1228
|
-
* <ul>
|
|
1229
|
-
* <li>
|
|
1230
|
-
* <p>
|
|
1231
|
-
* <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_GetMultiRegionAccessPointPolicy.html">GetMultiRegionAccessPointPolicy</a>
|
|
1232
|
-
* </p>
|
|
1233
|
-
* </li>
|
|
1234
|
-
* <li>
|
|
1235
|
-
* <p>
|
|
1236
|
-
* <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_PutMultiRegionAccessPointPolicy.html">PutMultiRegionAccessPointPolicy</a>
|
|
1237
|
-
* </p>
|
|
1238
|
-
* </li>
|
|
1239
|
-
* </ul>
|
|
291
|
+
* @see {@link GetMultiRegionAccessPointPolicyStatusCommand}
|
|
1240
292
|
*/
|
|
1241
293
|
getMultiRegionAccessPointPolicyStatus(args: GetMultiRegionAccessPointPolicyStatusCommandInput, options?: __HttpHandlerOptions): Promise<GetMultiRegionAccessPointPolicyStatusCommandOutput>;
|
|
1242
294
|
getMultiRegionAccessPointPolicyStatus(args: GetMultiRegionAccessPointPolicyStatusCommandInput, cb: (err: any, data?: GetMultiRegionAccessPointPolicyStatusCommandOutput) => void): void;
|
|
1243
295
|
getMultiRegionAccessPointPolicyStatus(args: GetMultiRegionAccessPointPolicyStatusCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetMultiRegionAccessPointPolicyStatusCommandOutput) => void): void;
|
|
1244
296
|
/**
|
|
1245
|
-
* @
|
|
1246
|
-
* <p>Returns the routing configuration for a Multi-Region Access Point, indicating which Regions are active or
|
|
1247
|
-
* passive.</p>
|
|
1248
|
-
* <p>To obtain routing control changes and failover requests, use the Amazon S3 failover control
|
|
1249
|
-
* infrastructure endpoints in these five Amazon Web Services Regions:</p>
|
|
1250
|
-
* <ul>
|
|
1251
|
-
* <li>
|
|
1252
|
-
* <p>
|
|
1253
|
-
* <code>us-east-1</code>
|
|
1254
|
-
* </p>
|
|
1255
|
-
* </li>
|
|
1256
|
-
* <li>
|
|
1257
|
-
* <p>
|
|
1258
|
-
* <code>us-west-2</code>
|
|
1259
|
-
* </p>
|
|
1260
|
-
* </li>
|
|
1261
|
-
* <li>
|
|
1262
|
-
* <p>
|
|
1263
|
-
* <code>ap-southeast-2</code>
|
|
1264
|
-
* </p>
|
|
1265
|
-
* </li>
|
|
1266
|
-
* <li>
|
|
1267
|
-
* <p>
|
|
1268
|
-
* <code>ap-northeast-1</code>
|
|
1269
|
-
* </p>
|
|
1270
|
-
* </li>
|
|
1271
|
-
* <li>
|
|
1272
|
-
* <p>
|
|
1273
|
-
* <code>eu-west-1</code>
|
|
1274
|
-
* </p>
|
|
1275
|
-
* </li>
|
|
1276
|
-
* </ul>
|
|
1277
|
-
* <note>
|
|
1278
|
-
* <p>Your Amazon S3 bucket does not need to be in these five Regions.</p>
|
|
1279
|
-
* </note>
|
|
297
|
+
* @see {@link GetMultiRegionAccessPointRoutesCommand}
|
|
1280
298
|
*/
|
|
1281
299
|
getMultiRegionAccessPointRoutes(args: GetMultiRegionAccessPointRoutesCommandInput, options?: __HttpHandlerOptions): Promise<GetMultiRegionAccessPointRoutesCommandOutput>;
|
|
1282
300
|
getMultiRegionAccessPointRoutes(args: GetMultiRegionAccessPointRoutesCommandInput, cb: (err: any, data?: GetMultiRegionAccessPointRoutesCommandOutput) => void): void;
|
|
1283
301
|
getMultiRegionAccessPointRoutes(args: GetMultiRegionAccessPointRoutesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetMultiRegionAccessPointRoutesCommandOutput) => void): void;
|
|
1284
302
|
/**
|
|
1285
|
-
* @
|
|
1286
|
-
* <p>Retrieves the <code>PublicAccessBlock</code> configuration for an Amazon Web Services account. For
|
|
1287
|
-
* more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/access-control-block-public-access.html"> Using Amazon S3 block
|
|
1288
|
-
* public access</a>.</p>
|
|
1289
|
-
* <p>Related actions include:</p>
|
|
1290
|
-
* <ul>
|
|
1291
|
-
* <li>
|
|
1292
|
-
* <p>
|
|
1293
|
-
* <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_DeletePublicAccessBlock.html">DeletePublicAccessBlock</a>
|
|
1294
|
-
* </p>
|
|
1295
|
-
* </li>
|
|
1296
|
-
* <li>
|
|
1297
|
-
* <p>
|
|
1298
|
-
* <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_PutPublicAccessBlock.html">PutPublicAccessBlock</a>
|
|
1299
|
-
* </p>
|
|
1300
|
-
* </li>
|
|
1301
|
-
* </ul>
|
|
303
|
+
* @see {@link GetPublicAccessBlockCommand}
|
|
1302
304
|
*/
|
|
1303
305
|
getPublicAccessBlock(args: GetPublicAccessBlockCommandInput, options?: __HttpHandlerOptions): Promise<GetPublicAccessBlockCommandOutput>;
|
|
1304
306
|
getPublicAccessBlock(args: GetPublicAccessBlockCommandInput, cb: (err: any, data?: GetPublicAccessBlockCommandOutput) => void): void;
|
|
1305
307
|
getPublicAccessBlock(args: GetPublicAccessBlockCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetPublicAccessBlockCommandOutput) => void): void;
|
|
1306
308
|
/**
|
|
1307
|
-
* @
|
|
1308
|
-
* <p>Gets the Amazon S3 Storage Lens configuration. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/storage_lens.html">Assessing your storage
|
|
1309
|
-
* activity and usage with Amazon S3 Storage Lens </a> in the
|
|
1310
|
-
* <i>Amazon S3 User Guide</i>. For a complete list of S3 Storage Lens metrics, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/storage_lens_metrics_glossary.html">S3 Storage Lens metrics glossary</a> in the <i>Amazon S3 User Guide</i>.</p>
|
|
1311
|
-
* <note>
|
|
1312
|
-
* <p>To use this action, you must have permission to perform the
|
|
1313
|
-
* <code>s3:GetStorageLensConfiguration</code> action. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/storage_lens_iam_permissions.html">Setting permissions to use Amazon S3 Storage Lens</a> in the
|
|
1314
|
-
* <i>Amazon S3 User Guide</i>.</p>
|
|
1315
|
-
* </note>
|
|
309
|
+
* @see {@link GetStorageLensConfigurationCommand}
|
|
1316
310
|
*/
|
|
1317
311
|
getStorageLensConfiguration(args: GetStorageLensConfigurationCommandInput, options?: __HttpHandlerOptions): Promise<GetStorageLensConfigurationCommandOutput>;
|
|
1318
312
|
getStorageLensConfiguration(args: GetStorageLensConfigurationCommandInput, cb: (err: any, data?: GetStorageLensConfigurationCommandOutput) => void): void;
|
|
1319
313
|
getStorageLensConfiguration(args: GetStorageLensConfigurationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetStorageLensConfigurationCommandOutput) => void): void;
|
|
1320
314
|
/**
|
|
1321
|
-
* @
|
|
1322
|
-
* <p>Gets the tags of Amazon S3 Storage Lens configuration. For more information about S3 Storage Lens, see
|
|
1323
|
-
* <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/storage_lens.html">Assessing your
|
|
1324
|
-
* storage activity and usage with Amazon S3 Storage Lens </a> in the
|
|
1325
|
-
* <i>Amazon S3 User Guide</i>.</p>
|
|
1326
|
-
* <note>
|
|
1327
|
-
* <p>To use this action, you must have permission to perform the
|
|
1328
|
-
* <code>s3:GetStorageLensConfigurationTagging</code> action. For more information, see
|
|
1329
|
-
* <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/storage_lens_iam_permissions.html">Setting permissions to
|
|
1330
|
-
* use Amazon S3 Storage Lens</a> in the <i>Amazon S3 User Guide</i>.</p>
|
|
1331
|
-
* </note>
|
|
315
|
+
* @see {@link GetStorageLensConfigurationTaggingCommand}
|
|
1332
316
|
*/
|
|
1333
317
|
getStorageLensConfigurationTagging(args: GetStorageLensConfigurationTaggingCommandInput, options?: __HttpHandlerOptions): Promise<GetStorageLensConfigurationTaggingCommandOutput>;
|
|
1334
318
|
getStorageLensConfigurationTagging(args: GetStorageLensConfigurationTaggingCommandInput, cb: (err: any, data?: GetStorageLensConfigurationTaggingCommandOutput) => void): void;
|
|
1335
319
|
getStorageLensConfigurationTagging(args: GetStorageLensConfigurationTaggingCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetStorageLensConfigurationTaggingCommandOutput) => void): void;
|
|
1336
320
|
/**
|
|
1337
|
-
* @
|
|
1338
|
-
* <p>Returns a list of the access points
|
|
1339
|
-
* that are
|
|
1340
|
-
* owned by the current account
|
|
1341
|
-
* that's
|
|
1342
|
-
* associated with the specified bucket. You can retrieve up to 1000 access points
|
|
1343
|
-
* per call. If the specified bucket has more than 1,000 access points (or the number specified in
|
|
1344
|
-
* <code>maxResults</code>, whichever is less), the response will include a continuation
|
|
1345
|
-
* token that you can use to list the additional access points.</p>
|
|
1346
|
-
* <p></p>
|
|
1347
|
-
* <p>All Amazon S3 on Outposts REST API requests for this action require an additional parameter of <code>x-amz-outpost-id</code> to be passed with the request. In addition, you must use an S3 on Outposts endpoint hostname prefix instead of <code>s3-control</code>. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and the <code>x-amz-outpost-id</code> derived by using the access point ARN, see the <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_GetAccessPoint.html#API_control_GetAccessPoint_Examples">Examples</a> section.</p>
|
|
1348
|
-
* <p>The following actions are related to <code>ListAccessPoints</code>:</p>
|
|
1349
|
-
* <ul>
|
|
1350
|
-
* <li>
|
|
1351
|
-
* <p>
|
|
1352
|
-
* <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_CreateAccessPoint.html">CreateAccessPoint</a>
|
|
1353
|
-
* </p>
|
|
1354
|
-
* </li>
|
|
1355
|
-
* <li>
|
|
1356
|
-
* <p>
|
|
1357
|
-
* <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_DeleteAccessPoint.html">DeleteAccessPoint</a>
|
|
1358
|
-
* </p>
|
|
1359
|
-
* </li>
|
|
1360
|
-
* <li>
|
|
1361
|
-
* <p>
|
|
1362
|
-
* <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_GetAccessPoint.html">GetAccessPoint</a>
|
|
1363
|
-
* </p>
|
|
1364
|
-
* </li>
|
|
1365
|
-
* </ul>
|
|
321
|
+
* @see {@link ListAccessPointsCommand}
|
|
1366
322
|
*/
|
|
1367
323
|
listAccessPoints(args: ListAccessPointsCommandInput, options?: __HttpHandlerOptions): Promise<ListAccessPointsCommandOutput>;
|
|
1368
324
|
listAccessPoints(args: ListAccessPointsCommandInput, cb: (err: any, data?: ListAccessPointsCommandOutput) => void): void;
|
|
1369
325
|
listAccessPoints(args: ListAccessPointsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListAccessPointsCommandOutput) => void): void;
|
|
1370
326
|
/**
|
|
1371
|
-
* @
|
|
1372
|
-
* <p>Returns some or all (up to 1,000) access points associated with the Object Lambda Access Point per call. If there
|
|
1373
|
-
* are more access points than what can be returned in one call, the response will include a
|
|
1374
|
-
* continuation token that you can use to list the additional access points.</p>
|
|
1375
|
-
* <p>The following actions are related to
|
|
1376
|
-
* <code>ListAccessPointsForObjectLambda</code>:</p>
|
|
1377
|
-
* <ul>
|
|
1378
|
-
* <li>
|
|
1379
|
-
* <p>
|
|
1380
|
-
* <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_CreateAccessPointForObjectLambda.html">CreateAccessPointForObjectLambda</a>
|
|
1381
|
-
* </p>
|
|
1382
|
-
* </li>
|
|
1383
|
-
* <li>
|
|
1384
|
-
* <p>
|
|
1385
|
-
* <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_DeleteAccessPointForObjectLambda.html">DeleteAccessPointForObjectLambda</a>
|
|
1386
|
-
* </p>
|
|
1387
|
-
* </li>
|
|
1388
|
-
* <li>
|
|
1389
|
-
* <p>
|
|
1390
|
-
* <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_GetAccessPointForObjectLambda.html">GetAccessPointForObjectLambda</a>
|
|
1391
|
-
* </p>
|
|
1392
|
-
* </li>
|
|
1393
|
-
* </ul>
|
|
327
|
+
* @see {@link ListAccessPointsForObjectLambdaCommand}
|
|
1394
328
|
*/
|
|
1395
329
|
listAccessPointsForObjectLambda(args: ListAccessPointsForObjectLambdaCommandInput, options?: __HttpHandlerOptions): Promise<ListAccessPointsForObjectLambdaCommandOutput>;
|
|
1396
330
|
listAccessPointsForObjectLambda(args: ListAccessPointsForObjectLambdaCommandInput, cb: (err: any, data?: ListAccessPointsForObjectLambdaCommandOutput) => void): void;
|
|
1397
331
|
listAccessPointsForObjectLambda(args: ListAccessPointsForObjectLambdaCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListAccessPointsForObjectLambdaCommandOutput) => void): void;
|
|
1398
332
|
/**
|
|
1399
|
-
* @
|
|
1400
|
-
* <p>Lists current S3 Batch Operations jobs and jobs that have ended within the last 30 days for
|
|
1401
|
-
* the Amazon Web Services account making the request. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/batch-ops.html">S3 Batch Operations</a> in the
|
|
1402
|
-
* <i>Amazon S3 User Guide</i>.</p>
|
|
1403
|
-
* <p>Related actions include:</p>
|
|
1404
|
-
* <p></p>
|
|
1405
|
-
* <ul>
|
|
1406
|
-
* <li>
|
|
1407
|
-
* <p>
|
|
1408
|
-
* <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_CreateJob.html">CreateJob</a>
|
|
1409
|
-
* </p>
|
|
1410
|
-
* </li>
|
|
1411
|
-
* <li>
|
|
1412
|
-
* <p>
|
|
1413
|
-
* <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_DescribeJob.html">DescribeJob</a>
|
|
1414
|
-
* </p>
|
|
1415
|
-
* </li>
|
|
1416
|
-
* <li>
|
|
1417
|
-
* <p>
|
|
1418
|
-
* <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_UpdateJobPriority.html">UpdateJobPriority</a>
|
|
1419
|
-
* </p>
|
|
1420
|
-
* </li>
|
|
1421
|
-
* <li>
|
|
1422
|
-
* <p>
|
|
1423
|
-
* <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_UpdateJobStatus.html">UpdateJobStatus</a>
|
|
1424
|
-
* </p>
|
|
1425
|
-
* </li>
|
|
1426
|
-
* </ul>
|
|
333
|
+
* @see {@link ListJobsCommand}
|
|
1427
334
|
*/
|
|
1428
335
|
listJobs(args: ListJobsCommandInput, options?: __HttpHandlerOptions): Promise<ListJobsCommandOutput>;
|
|
1429
336
|
listJobs(args: ListJobsCommandInput, cb: (err: any, data?: ListJobsCommandOutput) => void): void;
|
|
1430
337
|
listJobs(args: ListJobsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListJobsCommandOutput) => void): void;
|
|
1431
338
|
/**
|
|
1432
|
-
* @
|
|
1433
|
-
* <p>Returns a list of the Multi-Region Access Points currently associated with the specified Amazon Web Services account.
|
|
1434
|
-
* Each call can return up to 100 Multi-Region Access Points, the maximum number of Multi-Region Access Points that can be
|
|
1435
|
-
* associated with a single account.</p>
|
|
1436
|
-
* <p>This action will always be routed to the US West (Oregon) Region. For more information
|
|
1437
|
-
* about the restrictions around managing Multi-Region Access Points, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/ManagingMultiRegionAccessPoints.html">Managing
|
|
1438
|
-
* Multi-Region Access Points</a> in the <i>Amazon S3 User Guide</i>.</p>
|
|
1439
|
-
* <p>The following actions are related to <code>ListMultiRegionAccessPoint</code>:</p>
|
|
1440
|
-
* <ul>
|
|
1441
|
-
* <li>
|
|
1442
|
-
* <p>
|
|
1443
|
-
* <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_CreateMultiRegionAccessPoint.html">CreateMultiRegionAccessPoint</a>
|
|
1444
|
-
* </p>
|
|
1445
|
-
* </li>
|
|
1446
|
-
* <li>
|
|
1447
|
-
* <p>
|
|
1448
|
-
* <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_DeleteMultiRegionAccessPoint.html">DeleteMultiRegionAccessPoint</a>
|
|
1449
|
-
* </p>
|
|
1450
|
-
* </li>
|
|
1451
|
-
* <li>
|
|
1452
|
-
* <p>
|
|
1453
|
-
* <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_DescribeMultiRegionAccessPointOperation.html">DescribeMultiRegionAccessPointOperation</a>
|
|
1454
|
-
* </p>
|
|
1455
|
-
* </li>
|
|
1456
|
-
* <li>
|
|
1457
|
-
* <p>
|
|
1458
|
-
* <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_GetMultiRegionAccessPoint.html">GetMultiRegionAccessPoint</a>
|
|
1459
|
-
* </p>
|
|
1460
|
-
* </li>
|
|
1461
|
-
* </ul>
|
|
339
|
+
* @see {@link ListMultiRegionAccessPointsCommand}
|
|
1462
340
|
*/
|
|
1463
341
|
listMultiRegionAccessPoints(args: ListMultiRegionAccessPointsCommandInput, options?: __HttpHandlerOptions): Promise<ListMultiRegionAccessPointsCommandOutput>;
|
|
1464
342
|
listMultiRegionAccessPoints(args: ListMultiRegionAccessPointsCommandInput, cb: (err: any, data?: ListMultiRegionAccessPointsCommandOutput) => void): void;
|
|
1465
343
|
listMultiRegionAccessPoints(args: ListMultiRegionAccessPointsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListMultiRegionAccessPointsCommandOutput) => void): void;
|
|
1466
344
|
/**
|
|
1467
|
-
* @
|
|
1468
|
-
* <p>Returns a list of all Outposts buckets in an Outpost that are owned by the authenticated
|
|
1469
|
-
* sender of the request. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html">Using Amazon S3 on Outposts</a> in the
|
|
1470
|
-
* <i>Amazon S3 User Guide</i>.</p>
|
|
1471
|
-
* <p>For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts
|
|
1472
|
-
* endpoint hostname prefix and <code>x-amz-outpost-id</code> in your request, see the <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_ListRegionalBuckets.html#API_control_ListRegionalBuckets_Examples">Examples</a> section.</p>
|
|
345
|
+
* @see {@link ListRegionalBucketsCommand}
|
|
1473
346
|
*/
|
|
1474
347
|
listRegionalBuckets(args: ListRegionalBucketsCommandInput, options?: __HttpHandlerOptions): Promise<ListRegionalBucketsCommandOutput>;
|
|
1475
348
|
listRegionalBuckets(args: ListRegionalBucketsCommandInput, cb: (err: any, data?: ListRegionalBucketsCommandOutput) => void): void;
|
|
1476
349
|
listRegionalBuckets(args: ListRegionalBucketsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListRegionalBucketsCommandOutput) => void): void;
|
|
1477
350
|
/**
|
|
1478
|
-
* @
|
|
1479
|
-
* <p>Gets a list of Amazon S3 Storage Lens configurations. For more information about S3 Storage Lens, see
|
|
1480
|
-
* <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/storage_lens.html">Assessing your
|
|
1481
|
-
* storage activity and usage with Amazon S3 Storage Lens </a> in the
|
|
1482
|
-
* <i>Amazon S3 User Guide</i>.</p>
|
|
1483
|
-
* <note>
|
|
1484
|
-
* <p>To use this action, you must have permission to perform the
|
|
1485
|
-
* <code>s3:ListStorageLensConfigurations</code> action. For more information, see
|
|
1486
|
-
* <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/storage_lens_iam_permissions.html">Setting permissions to
|
|
1487
|
-
* use Amazon S3 Storage Lens</a> in the <i>Amazon S3 User Guide</i>.</p>
|
|
1488
|
-
* </note>
|
|
351
|
+
* @see {@link ListStorageLensConfigurationsCommand}
|
|
1489
352
|
*/
|
|
1490
353
|
listStorageLensConfigurations(args: ListStorageLensConfigurationsCommandInput, options?: __HttpHandlerOptions): Promise<ListStorageLensConfigurationsCommandOutput>;
|
|
1491
354
|
listStorageLensConfigurations(args: ListStorageLensConfigurationsCommandInput, cb: (err: any, data?: ListStorageLensConfigurationsCommandOutput) => void): void;
|
|
1492
355
|
listStorageLensConfigurations(args: ListStorageLensConfigurationsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListStorageLensConfigurationsCommandOutput) => void): void;
|
|
1493
356
|
/**
|
|
1494
|
-
* @
|
|
1495
|
-
* <p>Replaces configuration for an Object Lambda Access Point.</p>
|
|
1496
|
-
* <p>The following actions are related to
|
|
1497
|
-
* <code>PutAccessPointConfigurationForObjectLambda</code>:</p>
|
|
1498
|
-
* <ul>
|
|
1499
|
-
* <li>
|
|
1500
|
-
* <p>
|
|
1501
|
-
* <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_GetAccessPointConfigurationForObjectLambda.html">GetAccessPointConfigurationForObjectLambda</a>
|
|
1502
|
-
* </p>
|
|
1503
|
-
* </li>
|
|
1504
|
-
* </ul>
|
|
357
|
+
* @see {@link PutAccessPointConfigurationForObjectLambdaCommand}
|
|
1505
358
|
*/
|
|
1506
359
|
putAccessPointConfigurationForObjectLambda(args: PutAccessPointConfigurationForObjectLambdaCommandInput, options?: __HttpHandlerOptions): Promise<PutAccessPointConfigurationForObjectLambdaCommandOutput>;
|
|
1507
360
|
putAccessPointConfigurationForObjectLambda(args: PutAccessPointConfigurationForObjectLambdaCommandInput, cb: (err: any, data?: PutAccessPointConfigurationForObjectLambdaCommandOutput) => void): void;
|
|
1508
361
|
putAccessPointConfigurationForObjectLambda(args: PutAccessPointConfigurationForObjectLambdaCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutAccessPointConfigurationForObjectLambdaCommandOutput) => void): void;
|
|
1509
362
|
/**
|
|
1510
|
-
* @
|
|
1511
|
-
* <p>Associates an access policy with the specified access point. Each access point can have only one policy,
|
|
1512
|
-
* so a request made to this API replaces any existing policy associated with the specified
|
|
1513
|
-
* access point.</p>
|
|
1514
|
-
* <p></p>
|
|
1515
|
-
* <p>All Amazon S3 on Outposts REST API requests for this action require an additional parameter of <code>x-amz-outpost-id</code> to be passed with the request. In addition, you must use an S3 on Outposts endpoint hostname prefix instead of <code>s3-control</code>. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and the <code>x-amz-outpost-id</code> derived by using the access point ARN, see the <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_PutAccessPointPolicy.html#API_control_PutAccessPointPolicy_Examples">Examples</a> section.</p>
|
|
1516
|
-
* <p>The following actions are related to <code>PutAccessPointPolicy</code>:</p>
|
|
1517
|
-
* <ul>
|
|
1518
|
-
* <li>
|
|
1519
|
-
* <p>
|
|
1520
|
-
* <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_GetAccessPointPolicy.html">GetAccessPointPolicy</a>
|
|
1521
|
-
* </p>
|
|
1522
|
-
* </li>
|
|
1523
|
-
* <li>
|
|
1524
|
-
* <p>
|
|
1525
|
-
* <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_DeleteAccessPointPolicy.html">DeleteAccessPointPolicy</a>
|
|
1526
|
-
* </p>
|
|
1527
|
-
* </li>
|
|
1528
|
-
* </ul>
|
|
363
|
+
* @see {@link PutAccessPointPolicyCommand}
|
|
1529
364
|
*/
|
|
1530
365
|
putAccessPointPolicy(args: PutAccessPointPolicyCommandInput, options?: __HttpHandlerOptions): Promise<PutAccessPointPolicyCommandOutput>;
|
|
1531
366
|
putAccessPointPolicy(args: PutAccessPointPolicyCommandInput, cb: (err: any, data?: PutAccessPointPolicyCommandOutput) => void): void;
|
|
1532
367
|
putAccessPointPolicy(args: PutAccessPointPolicyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutAccessPointPolicyCommandOutput) => void): void;
|
|
1533
368
|
/**
|
|
1534
|
-
* @
|
|
1535
|
-
* <p>Creates or replaces resource policy for an Object Lambda Access Point. For an example policy, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/olap-create.html#olap-create-cli">Creating Object Lambda Access Points</a> in the <i>Amazon S3 User Guide</i>.</p>
|
|
1536
|
-
* <p>The following actions are related to
|
|
1537
|
-
* <code>PutAccessPointPolicyForObjectLambda</code>:</p>
|
|
1538
|
-
* <ul>
|
|
1539
|
-
* <li>
|
|
1540
|
-
* <p>
|
|
1541
|
-
* <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_DeleteAccessPointPolicyForObjectLambda.html">DeleteAccessPointPolicyForObjectLambda</a>
|
|
1542
|
-
* </p>
|
|
1543
|
-
* </li>
|
|
1544
|
-
* <li>
|
|
1545
|
-
* <p>
|
|
1546
|
-
* <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_GetAccessPointPolicyForObjectLambda.html">GetAccessPointPolicyForObjectLambda</a>
|
|
1547
|
-
* </p>
|
|
1548
|
-
* </li>
|
|
1549
|
-
* </ul>
|
|
369
|
+
* @see {@link PutAccessPointPolicyForObjectLambdaCommand}
|
|
1550
370
|
*/
|
|
1551
371
|
putAccessPointPolicyForObjectLambda(args: PutAccessPointPolicyForObjectLambdaCommandInput, options?: __HttpHandlerOptions): Promise<PutAccessPointPolicyForObjectLambdaCommandOutput>;
|
|
1552
372
|
putAccessPointPolicyForObjectLambda(args: PutAccessPointPolicyForObjectLambdaCommandInput, cb: (err: any, data?: PutAccessPointPolicyForObjectLambdaCommandOutput) => void): void;
|
|
1553
373
|
putAccessPointPolicyForObjectLambda(args: PutAccessPointPolicyForObjectLambdaCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutAccessPointPolicyForObjectLambdaCommandOutput) => void): void;
|
|
1554
374
|
/**
|
|
1555
|
-
* @
|
|
1556
|
-
* <note>
|
|
1557
|
-
* <p>This action puts a lifecycle configuration to an Amazon S3 on Outposts bucket. To put a
|
|
1558
|
-
* lifecycle configuration to an S3 bucket, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketLifecycleConfiguration.html">PutBucketLifecycleConfiguration</a> in the <i>Amazon S3 API Reference</i>.
|
|
1559
|
-
* </p>
|
|
1560
|
-
* </note>
|
|
1561
|
-
* <p>Creates a new lifecycle configuration for the S3 on Outposts bucket or replaces an
|
|
1562
|
-
* existing lifecycle configuration. Outposts buckets only support lifecycle configurations
|
|
1563
|
-
* that delete/expire objects after a certain period of time and abort incomplete multipart
|
|
1564
|
-
* uploads.</p>
|
|
1565
|
-
* <p></p>
|
|
1566
|
-
* <p>All Amazon S3 on Outposts REST API requests for this action require an additional parameter of <code>x-amz-outpost-id</code> to be passed with the request. In addition, you must use an S3 on Outposts endpoint hostname prefix instead of <code>s3-control</code>. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and the <code>x-amz-outpost-id</code> derived by using the access point ARN, see the <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_PutBucketLifecycleConfiguration.html#API_control_PutBucketLifecycleConfiguration_Examples">Examples</a> section.</p>
|
|
1567
|
-
* <p>The following actions are related to
|
|
1568
|
-
* <code>PutBucketLifecycleConfiguration</code>:</p>
|
|
1569
|
-
* <ul>
|
|
1570
|
-
* <li>
|
|
1571
|
-
* <p>
|
|
1572
|
-
* <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_GetBucketLifecycleConfiguration.html">GetBucketLifecycleConfiguration</a>
|
|
1573
|
-
* </p>
|
|
1574
|
-
* </li>
|
|
1575
|
-
* <li>
|
|
1576
|
-
* <p>
|
|
1577
|
-
* <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_DeleteBucketLifecycleConfiguration.html">DeleteBucketLifecycleConfiguration</a>
|
|
1578
|
-
* </p>
|
|
1579
|
-
* </li>
|
|
1580
|
-
* </ul>
|
|
375
|
+
* @see {@link PutBucketLifecycleConfigurationCommand}
|
|
1581
376
|
*/
|
|
1582
377
|
putBucketLifecycleConfiguration(args: PutBucketLifecycleConfigurationCommandInput, options?: __HttpHandlerOptions): Promise<PutBucketLifecycleConfigurationCommandOutput>;
|
|
1583
378
|
putBucketLifecycleConfiguration(args: PutBucketLifecycleConfigurationCommandInput, cb: (err: any, data?: PutBucketLifecycleConfigurationCommandOutput) => void): void;
|
|
1584
379
|
putBucketLifecycleConfiguration(args: PutBucketLifecycleConfigurationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutBucketLifecycleConfigurationCommandOutput) => void): void;
|
|
1585
380
|
/**
|
|
1586
|
-
* @
|
|
1587
|
-
* <note>
|
|
1588
|
-
* <p>This action puts a bucket policy to an Amazon S3 on Outposts bucket. To put a policy on an
|
|
1589
|
-
* S3 bucket, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketPolicy.html">PutBucketPolicy</a> in the
|
|
1590
|
-
* <i>Amazon S3 API Reference</i>. </p>
|
|
1591
|
-
* </note>
|
|
1592
|
-
* <p>Applies an Amazon S3 bucket policy to an Outposts bucket. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html">Using
|
|
1593
|
-
* Amazon S3 on Outposts</a> in the <i>Amazon S3 User Guide</i>.</p>
|
|
1594
|
-
* <p>If you are using an identity other than the root user of the Amazon Web Services account that owns the
|
|
1595
|
-
* Outposts bucket, the calling identity must have the <code>PutBucketPolicy</code>
|
|
1596
|
-
* permissions on the specified Outposts bucket and belong to the bucket owner's account in
|
|
1597
|
-
* order to use this action.</p>
|
|
1598
|
-
* <p>If you don't have <code>PutBucketPolicy</code> permissions, Amazon S3 returns a <code>403
|
|
1599
|
-
* Access Denied</code> error. If you have the correct permissions, but you're not using an
|
|
1600
|
-
* identity that belongs to the bucket owner's account, Amazon S3 returns a <code>405 Method Not
|
|
1601
|
-
* Allowed</code> error.</p>
|
|
1602
|
-
* <important>
|
|
1603
|
-
* <p> As a security precaution, the root user of the Amazon Web Services account that owns a bucket can
|
|
1604
|
-
* always use this action, even if the policy explicitly denies the root user the ability
|
|
1605
|
-
* to perform this action. </p>
|
|
1606
|
-
* </important>
|
|
1607
|
-
* <p>For more information about bucket policies, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/using-iam-policies.html">Using Bucket Policies and User
|
|
1608
|
-
* Policies</a>.</p>
|
|
1609
|
-
* <p>All Amazon S3 on Outposts REST API requests for this action require an additional parameter of <code>x-amz-outpost-id</code> to be passed with the request. In addition, you must use an S3 on Outposts endpoint hostname prefix instead of <code>s3-control</code>. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and the <code>x-amz-outpost-id</code> derived by using the access point ARN, see the <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_PutBucketPolicy.html#API_control_PutBucketPolicy_Examples">Examples</a> section.</p>
|
|
1610
|
-
* <p>The following actions are related to <code>PutBucketPolicy</code>:</p>
|
|
1611
|
-
* <ul>
|
|
1612
|
-
* <li>
|
|
1613
|
-
* <p>
|
|
1614
|
-
* <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_GetBucketPolicy.html">GetBucketPolicy</a>
|
|
1615
|
-
* </p>
|
|
1616
|
-
* </li>
|
|
1617
|
-
* <li>
|
|
1618
|
-
* <p>
|
|
1619
|
-
* <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_DeleteBucketPolicy.html">DeleteBucketPolicy</a>
|
|
1620
|
-
* </p>
|
|
1621
|
-
* </li>
|
|
1622
|
-
* </ul>
|
|
381
|
+
* @see {@link PutBucketPolicyCommand}
|
|
1623
382
|
*/
|
|
1624
383
|
putBucketPolicy(args: PutBucketPolicyCommandInput, options?: __HttpHandlerOptions): Promise<PutBucketPolicyCommandOutput>;
|
|
1625
384
|
putBucketPolicy(args: PutBucketPolicyCommandInput, cb: (err: any, data?: PutBucketPolicyCommandOutput) => void): void;
|
|
1626
385
|
putBucketPolicy(args: PutBucketPolicyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutBucketPolicyCommandOutput) => void): void;
|
|
1627
386
|
/**
|
|
1628
|
-
* @
|
|
1629
|
-
* <note>
|
|
1630
|
-
* <p>This action creates an Amazon S3 on Outposts bucket's replication configuration. To create
|
|
1631
|
-
* an S3 bucket's replication configuration, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketReplication.html">PutBucketReplication</a>
|
|
1632
|
-
* in the <i>Amazon S3 API Reference</i>. </p>
|
|
1633
|
-
* </note>
|
|
1634
|
-
* <p>Creates a replication configuration or replaces an existing one. For information about
|
|
1635
|
-
* S3 replication on Outposts configuration, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3OutpostsReplication.html">Replicating objects for S3 on Outposts</a> in the
|
|
1636
|
-
* <i>Amazon S3 User Guide</i>.</p>
|
|
1637
|
-
* <note>
|
|
1638
|
-
* <p>It can take a while to propagate <code>PUT</code> or <code>DELETE</code> requests for
|
|
1639
|
-
* a replication configuration to all S3 on Outposts systems. Therefore, the replication
|
|
1640
|
-
* configuration that's returned by a <code>GET</code> request soon after a
|
|
1641
|
-
* <code>PUT</code> or <code>DELETE</code> request might return a more recent result
|
|
1642
|
-
* than what's on the Outpost. If an Outpost is offline, the delay in updating the
|
|
1643
|
-
* replication configuration on that Outpost can be significant.</p>
|
|
1644
|
-
* </note>
|
|
1645
|
-
* <p>Specify the replication configuration in the request body. In the replication
|
|
1646
|
-
* configuration, you provide the following information:</p>
|
|
1647
|
-
* <ul>
|
|
1648
|
-
* <li>
|
|
1649
|
-
* <p>The name of the destination bucket or buckets where you want S3 on Outposts to
|
|
1650
|
-
* replicate objects</p>
|
|
1651
|
-
* </li>
|
|
1652
|
-
* <li>
|
|
1653
|
-
* <p>The Identity and Access Management (IAM) role that S3 on Outposts can assume to replicate objects on
|
|
1654
|
-
* your behalf</p>
|
|
1655
|
-
* </li>
|
|
1656
|
-
* <li>
|
|
1657
|
-
* <p>Other relevant information, such as replication rules</p>
|
|
1658
|
-
* </li>
|
|
1659
|
-
* </ul>
|
|
1660
|
-
* <p>A replication configuration must include at least one rule and can contain a maximum of
|
|
1661
|
-
* 100. Each rule identifies a subset of objects to replicate by filtering the objects in
|
|
1662
|
-
* the source Outposts bucket. To choose additional subsets of objects to replicate, add a
|
|
1663
|
-
* rule for each subset.</p>
|
|
1664
|
-
* <p>To specify a subset of the objects in the source Outposts bucket to apply a replication
|
|
1665
|
-
* rule to, add the <code>Filter</code> element as a child of the <code>Rule</code> element.
|
|
1666
|
-
* You can filter objects based on an object key prefix, one or more object tags, or both.
|
|
1667
|
-
* When you add the <code>Filter</code> element in the configuration, you must also add the
|
|
1668
|
-
* following elements: <code>DeleteMarkerReplication</code>, <code>Status</code>, and
|
|
1669
|
-
* <code>Priority</code>.</p>
|
|
1670
|
-
* <p>Using <code>PutBucketReplication</code> on Outposts requires that both the source and
|
|
1671
|
-
* destination buckets must have versioning enabled. For information about enabling versioning
|
|
1672
|
-
* on a bucket, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3OutpostsManagingVersioning.html">Managing S3 Versioning
|
|
1673
|
-
* for your S3 on Outposts bucket</a>.</p>
|
|
1674
|
-
* <p>For information about S3 on Outposts replication failure reasons, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/outposts-replication-eventbridge.html#outposts-replication-failure-codes">Replication failure reasons</a> in the <i>Amazon S3 User Guide</i>.</p>
|
|
1675
|
-
* <p>
|
|
1676
|
-
* <b>Handling Replication of Encrypted Objects</b>
|
|
1677
|
-
* </p>
|
|
1678
|
-
* <p>Outposts buckets are encrypted at all times. All the objects in the source Outposts
|
|
1679
|
-
* bucket are encrypted and can be replicated. Also, all the replicas in the destination
|
|
1680
|
-
* Outposts bucket are encrypted with the same encryption key as the objects in the source
|
|
1681
|
-
* Outposts bucket.</p>
|
|
1682
|
-
* <p>
|
|
1683
|
-
* <b>Permissions</b>
|
|
1684
|
-
* </p>
|
|
1685
|
-
* <p>To create a <code>PutBucketReplication</code> request, you must have
|
|
1686
|
-
* <code>s3-outposts:PutReplicationConfiguration</code> permissions for the bucket. The
|
|
1687
|
-
* Outposts bucket owner has this permission by default and can grant it to others. For more
|
|
1688
|
-
* information about permissions, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3OutpostsIAM.html">Setting up IAM with
|
|
1689
|
-
* S3 on Outposts</a> and <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3OutpostsBucketPolicy.html">Managing access to
|
|
1690
|
-
* S3 on Outposts buckets</a>. </p>
|
|
1691
|
-
* <note>
|
|
1692
|
-
* <p>To perform this operation, the user or role must also have the <code>iam:CreateRole</code> and <code>iam:PassRole</code> permissions.
|
|
1693
|
-
* For more information, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_use_passrole.html">Granting a user
|
|
1694
|
-
* permissions to pass a role to an Amazon Web Services service</a>.</p>
|
|
1695
|
-
* </note>
|
|
1696
|
-
* <p>All Amazon S3 on Outposts REST API requests for this action require an additional parameter of <code>x-amz-outpost-id</code> to be passed with the request. In addition, you must use an S3 on Outposts endpoint hostname prefix instead of <code>s3-control</code>. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and the <code>x-amz-outpost-id</code> derived by using the access point ARN, see the <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_PutBucketReplication.html#API_control_PutBucketReplication_Examples">Examples</a> section.</p>
|
|
1697
|
-
* <p>The following operations are related to <code>PutBucketReplication</code>:</p>
|
|
1698
|
-
* <ul>
|
|
1699
|
-
* <li>
|
|
1700
|
-
* <p>
|
|
1701
|
-
* <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_GetBucketReplication.html">GetBucketReplication</a>
|
|
1702
|
-
* </p>
|
|
1703
|
-
* </li>
|
|
1704
|
-
* <li>
|
|
1705
|
-
* <p>
|
|
1706
|
-
* <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_DeleteBucketReplication.html">DeleteBucketReplication</a>
|
|
1707
|
-
* </p>
|
|
1708
|
-
* </li>
|
|
1709
|
-
* </ul>
|
|
387
|
+
* @see {@link PutBucketReplicationCommand}
|
|
1710
388
|
*/
|
|
1711
389
|
putBucketReplication(args: PutBucketReplicationCommandInput, options?: __HttpHandlerOptions): Promise<PutBucketReplicationCommandOutput>;
|
|
1712
390
|
putBucketReplication(args: PutBucketReplicationCommandInput, cb: (err: any, data?: PutBucketReplicationCommandOutput) => void): void;
|
|
1713
391
|
putBucketReplication(args: PutBucketReplicationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutBucketReplicationCommandOutput) => void): void;
|
|
1714
392
|
/**
|
|
1715
|
-
* @
|
|
1716
|
-
* <note>
|
|
1717
|
-
* <p>This action puts tags on an Amazon S3 on Outposts bucket. To put tags on an S3 bucket, see
|
|
1718
|
-
* <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketTagging.html">PutBucketTagging</a> in the <i>Amazon S3 API Reference</i>. </p>
|
|
1719
|
-
* </note>
|
|
1720
|
-
* <p>Sets the tags for an S3 on Outposts bucket. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html">Using
|
|
1721
|
-
* Amazon S3 on Outposts</a> in the <i>Amazon S3 User Guide</i>.</p>
|
|
1722
|
-
* <p>Use tags to organize your Amazon Web Services bill to reflect your own cost structure. To do this,
|
|
1723
|
-
* sign up to get your Amazon Web Services account bill with tag key values included. Then, to see the cost
|
|
1724
|
-
* of combined resources, organize your billing information according to resources with the
|
|
1725
|
-
* same tag key values. For example, you can tag several resources with a specific application
|
|
1726
|
-
* name, and then organize your billing information to see the total cost of that application
|
|
1727
|
-
* across several services. For more information, see <a href="https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/cost-alloc-tags.html">Cost allocation and
|
|
1728
|
-
* tagging</a>.</p>
|
|
1729
|
-
* <note>
|
|
1730
|
-
* <p>Within a bucket, if you add a tag that has the same key as an existing tag, the new
|
|
1731
|
-
* value overwrites the old value. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/CostAllocTagging.html"> Using cost allocation in Amazon S3
|
|
1732
|
-
* bucket tags</a>.</p>
|
|
1733
|
-
* </note>
|
|
1734
|
-
* <p>To use this action, you must have permissions to perform the
|
|
1735
|
-
* <code>s3-outposts:PutBucketTagging</code> action. The Outposts bucket owner has this
|
|
1736
|
-
* permission by default and can grant this permission to others. For more information about
|
|
1737
|
-
* 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
|
|
1738
|
-
* access permissions to your Amazon S3 resources</a>.</p>
|
|
1739
|
-
* <p>
|
|
1740
|
-
* <code>PutBucketTagging</code> has the following special errors:</p>
|
|
1741
|
-
* <ul>
|
|
1742
|
-
* <li>
|
|
1743
|
-
* <p>Error code: <code>InvalidTagError</code>
|
|
1744
|
-
* </p>
|
|
1745
|
-
* <ul>
|
|
1746
|
-
* <li>
|
|
1747
|
-
* <p>Description: The tag provided was not a valid tag. This error can occur if
|
|
1748
|
-
* the tag did not pass input validation. For information about tag restrictions,
|
|
1749
|
-
* see <a href="https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/allocation-tag-restrictions.html">
|
|
1750
|
-
* User-Defined Tag Restrictions</a> and <a href="https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/aws-tag-restrictions.html">
|
|
1751
|
-
* Amazon Web Services-Generated Cost Allocation Tag Restrictions</a>.</p>
|
|
1752
|
-
* </li>
|
|
1753
|
-
* </ul>
|
|
1754
|
-
* </li>
|
|
1755
|
-
* <li>
|
|
1756
|
-
* <p>Error code: <code>MalformedXMLError</code>
|
|
1757
|
-
* </p>
|
|
1758
|
-
* <ul>
|
|
1759
|
-
* <li>
|
|
1760
|
-
* <p>Description: The XML provided does not match the schema.</p>
|
|
1761
|
-
* </li>
|
|
1762
|
-
* </ul>
|
|
1763
|
-
* </li>
|
|
1764
|
-
* <li>
|
|
1765
|
-
* <p>Error code: <code>OperationAbortedError </code>
|
|
1766
|
-
* </p>
|
|
1767
|
-
* <ul>
|
|
1768
|
-
* <li>
|
|
1769
|
-
* <p>Description: A conflicting conditional action is currently in progress
|
|
1770
|
-
* against this resource. Try again.</p>
|
|
1771
|
-
* </li>
|
|
1772
|
-
* </ul>
|
|
1773
|
-
* </li>
|
|
1774
|
-
* <li>
|
|
1775
|
-
* <p>Error code: <code>InternalError</code>
|
|
1776
|
-
* </p>
|
|
1777
|
-
* <ul>
|
|
1778
|
-
* <li>
|
|
1779
|
-
* <p>Description: The service was unable to apply the provided tag to the
|
|
1780
|
-
* bucket.</p>
|
|
1781
|
-
* </li>
|
|
1782
|
-
* </ul>
|
|
1783
|
-
* </li>
|
|
1784
|
-
* </ul>
|
|
1785
|
-
* <p>All Amazon S3 on Outposts REST API requests for this action require an additional parameter of <code>x-amz-outpost-id</code> to be passed with the request. In addition, you must use an S3 on Outposts endpoint hostname prefix instead of <code>s3-control</code>. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and the <code>x-amz-outpost-id</code> derived by using the access point ARN, see the <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_PutBucketTagging.html#API_control_PutBucketTagging_Examples">Examples</a> section.</p>
|
|
1786
|
-
* <p>The following actions are related to <code>PutBucketTagging</code>:</p>
|
|
1787
|
-
* <ul>
|
|
1788
|
-
* <li>
|
|
1789
|
-
* <p>
|
|
1790
|
-
* <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_GetBucketTagging.html">GetBucketTagging</a>
|
|
1791
|
-
* </p>
|
|
1792
|
-
* </li>
|
|
1793
|
-
* <li>
|
|
1794
|
-
* <p>
|
|
1795
|
-
* <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_DeleteBucketTagging.html">DeleteBucketTagging</a>
|
|
1796
|
-
* </p>
|
|
1797
|
-
* </li>
|
|
1798
|
-
* </ul>
|
|
393
|
+
* @see {@link PutBucketTaggingCommand}
|
|
1799
394
|
*/
|
|
1800
395
|
putBucketTagging(args: PutBucketTaggingCommandInput, options?: __HttpHandlerOptions): Promise<PutBucketTaggingCommandOutput>;
|
|
1801
396
|
putBucketTagging(args: PutBucketTaggingCommandInput, cb: (err: any, data?: PutBucketTaggingCommandOutput) => void): void;
|
|
1802
397
|
putBucketTagging(args: PutBucketTaggingCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutBucketTaggingCommandOutput) => void): void;
|
|
1803
398
|
/**
|
|
1804
|
-
* @
|
|
1805
|
-
* <note>
|
|
1806
|
-
* <p>This operation sets the versioning state
|
|
1807
|
-
* for
|
|
1808
|
-
* S3 on Outposts
|
|
1809
|
-
* buckets
|
|
1810
|
-
* only. To set the versioning state for an S3 bucket, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketVersioning.html">PutBucketVersioning</a> in the <i>Amazon S3 API Reference</i>. </p>
|
|
1811
|
-
* </note>
|
|
1812
|
-
* <p>Sets the versioning state for an S3 on Outposts bucket. With
|
|
1813
|
-
* S3
|
|
1814
|
-
* Versioning,
|
|
1815
|
-
* you can save multiple distinct copies of your
|
|
1816
|
-
* objects
|
|
1817
|
-
* and recover from unintended user actions and application failures.</p>
|
|
1818
|
-
* <p>You can set the versioning state to one of the following:</p>
|
|
1819
|
-
* <ul>
|
|
1820
|
-
* <li>
|
|
1821
|
-
* <p>
|
|
1822
|
-
* <b>Enabled</b> - Enables versioning for the objects in
|
|
1823
|
-
* the bucket. All objects added to the bucket receive a unique version ID.</p>
|
|
1824
|
-
* </li>
|
|
1825
|
-
* <li>
|
|
1826
|
-
* <p>
|
|
1827
|
-
* <b>Suspended</b> - Suspends versioning for the objects
|
|
1828
|
-
* in the bucket. All objects added to the bucket receive the version ID
|
|
1829
|
-
* <code>null</code>.</p>
|
|
1830
|
-
* </li>
|
|
1831
|
-
* </ul>
|
|
1832
|
-
* <p>If you've never set versioning on your bucket, it has no versioning state. In that case,
|
|
1833
|
-
* a <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_GetBucketVersioning.html">
|
|
1834
|
-
* GetBucketVersioning</a> request does not return a versioning state value.</p>
|
|
1835
|
-
* <p>When you enable S3 Versioning, for each object in your bucket, you have a current
|
|
1836
|
-
* version and zero or more noncurrent versions. You can configure your bucket S3 Lifecycle
|
|
1837
|
-
* rules to expire noncurrent versions after a specified time period. For more information,
|
|
1838
|
-
* see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3OutpostsLifecycleManaging.html"> Creating and managing
|
|
1839
|
-
* a lifecycle configuration for your S3 on Outposts bucket</a> in the <i>Amazon S3
|
|
1840
|
-
* User Guide</i>.</p>
|
|
1841
|
-
* <p>If you have an object expiration lifecycle configuration in your non-versioned bucket and you
|
|
1842
|
-
* want to maintain the same permanent delete behavior when you enable versioning, you must
|
|
1843
|
-
* add a noncurrent expiration policy. The noncurrent expiration lifecycle configuration will manage
|
|
1844
|
-
* the deletes of the noncurrent object versions in the version-enabled bucket. For more
|
|
1845
|
-
* information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/Versioning.html">Versioning</a> in the <i>Amazon S3
|
|
1846
|
-
* User Guide</i>.</p>
|
|
1847
|
-
* <p>All Amazon S3 on Outposts REST API requests for this action require an additional parameter of <code>x-amz-outpost-id</code> to be passed with the request. In addition, you must use an S3 on Outposts endpoint hostname prefix instead of <code>s3-control</code>. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and the <code>x-amz-outpost-id</code> derived by using the access point ARN, see the <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_PutBucketVersioning.html#API_control_PutBucketVersioning_Examples">Examples</a> section.</p>
|
|
1848
|
-
* <p>The following operations are related to <code>PutBucketVersioning</code> for
|
|
1849
|
-
* S3 on Outposts.</p>
|
|
1850
|
-
* <ul>
|
|
1851
|
-
* <li>
|
|
1852
|
-
* <p>
|
|
1853
|
-
* <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_GetBucketVersioning.html">GetBucketVersioning</a>
|
|
1854
|
-
* </p>
|
|
1855
|
-
* </li>
|
|
1856
|
-
* <li>
|
|
1857
|
-
* <p>
|
|
1858
|
-
* <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_PutBucketLifecycleConfiguration.html">PutBucketLifecycleConfiguration</a>
|
|
1859
|
-
* </p>
|
|
1860
|
-
* </li>
|
|
1861
|
-
* <li>
|
|
1862
|
-
* <p>
|
|
1863
|
-
* <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_GetBucketLifecycleConfiguration.html">GetBucketLifecycleConfiguration</a>
|
|
1864
|
-
* </p>
|
|
1865
|
-
* </li>
|
|
1866
|
-
* </ul>
|
|
399
|
+
* @see {@link PutBucketVersioningCommand}
|
|
1867
400
|
*/
|
|
1868
401
|
putBucketVersioning(args: PutBucketVersioningCommandInput, options?: __HttpHandlerOptions): Promise<PutBucketVersioningCommandOutput>;
|
|
1869
402
|
putBucketVersioning(args: PutBucketVersioningCommandInput, cb: (err: any, data?: PutBucketVersioningCommandOutput) => void): void;
|
|
1870
403
|
putBucketVersioning(args: PutBucketVersioningCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutBucketVersioningCommandOutput) => void): void;
|
|
1871
404
|
/**
|
|
1872
|
-
* @
|
|
1873
|
-
* <p>Sets the supplied tag-set on an S3 Batch Operations job.</p>
|
|
1874
|
-
* <p>A tag is a key-value pair. You can associate S3 Batch Operations tags with any job by sending
|
|
1875
|
-
* a PUT request against the tagging subresource that is associated with the job. To modify
|
|
1876
|
-
* the existing tag set, you can either replace the existing tag set entirely, or make changes
|
|
1877
|
-
* within the existing tag set by retrieving the existing tag set using <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_GetJobTagging.html">GetJobTagging</a>, modify that tag set, and use this action to replace the tag set
|
|
1878
|
-
* with the one you modified. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/batch-ops-managing-jobs.html#batch-ops-job-tags">Controlling
|
|
1879
|
-
* access and labeling jobs using tags</a> in the <i>Amazon S3 User Guide</i>. </p>
|
|
1880
|
-
* <p></p>
|
|
1881
|
-
* <note>
|
|
1882
|
-
* <ul>
|
|
1883
|
-
* <li>
|
|
1884
|
-
* <p>If you send this request with an empty tag set, Amazon S3 deletes the existing
|
|
1885
|
-
* tag set on the Batch Operations job. If you use this method, you are charged for a Tier
|
|
1886
|
-
* 1 Request (PUT). For more information, see <a href="http://aws.amazon.com/s3/pricing/">Amazon S3 pricing</a>.</p>
|
|
1887
|
-
* </li>
|
|
1888
|
-
* <li>
|
|
1889
|
-
* <p>For deleting existing tags for your Batch Operations job, a <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_DeleteJobTagging.html">DeleteJobTagging</a> request is preferred because it achieves the same
|
|
1890
|
-
* result without incurring charges.</p>
|
|
1891
|
-
* </li>
|
|
1892
|
-
* <li>
|
|
1893
|
-
* <p>A few things to consider about using tags:</p>
|
|
1894
|
-
* <ul>
|
|
1895
|
-
* <li>
|
|
1896
|
-
* <p>Amazon S3 limits the maximum number of tags to 50 tags per job.</p>
|
|
1897
|
-
* </li>
|
|
1898
|
-
* <li>
|
|
1899
|
-
* <p>You can associate up to 50 tags with a job as long as they have unique
|
|
1900
|
-
* tag keys.</p>
|
|
1901
|
-
* </li>
|
|
1902
|
-
* <li>
|
|
1903
|
-
* <p>A tag key can be up to 128 Unicode characters in length, and tag values
|
|
1904
|
-
* can be up to 256 Unicode characters in length.</p>
|
|
1905
|
-
* </li>
|
|
1906
|
-
* <li>
|
|
1907
|
-
* <p>The key and values are case sensitive.</p>
|
|
1908
|
-
* </li>
|
|
1909
|
-
* <li>
|
|
1910
|
-
* <p>For tagging-related restrictions related to characters and encodings, see
|
|
1911
|
-
* <a href="https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/allocation-tag-restrictions.html">User-Defined Tag Restrictions</a> in the <i>Billing and Cost Management User Guide</i>.</p>
|
|
1912
|
-
* </li>
|
|
1913
|
-
* </ul>
|
|
1914
|
-
* </li>
|
|
1915
|
-
* </ul>
|
|
1916
|
-
* </note>
|
|
1917
|
-
* <p></p>
|
|
1918
|
-
* <p>To use the
|
|
1919
|
-
* <code>PutJobTagging</code>
|
|
1920
|
-
* operation,
|
|
1921
|
-
* you must have permission to perform the <code>s3:PutJobTagging</code> action.</p>
|
|
1922
|
-
* <p>Related actions include:</p>
|
|
1923
|
-
* <ul>
|
|
1924
|
-
* <li>
|
|
1925
|
-
* <p>
|
|
1926
|
-
* <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_CreateJob.html">CreateJob</a>
|
|
1927
|
-
* </p>
|
|
1928
|
-
* </li>
|
|
1929
|
-
* <li>
|
|
1930
|
-
* <p>
|
|
1931
|
-
* <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_GetJobTagging.html">GetJobTagging</a>
|
|
1932
|
-
* </p>
|
|
1933
|
-
* </li>
|
|
1934
|
-
* <li>
|
|
1935
|
-
* <p>
|
|
1936
|
-
* <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_DeleteJobTagging.html">DeleteJobTagging</a>
|
|
1937
|
-
* </p>
|
|
1938
|
-
* </li>
|
|
1939
|
-
* </ul>
|
|
405
|
+
* @see {@link PutJobTaggingCommand}
|
|
1940
406
|
*/
|
|
1941
407
|
putJobTagging(args: PutJobTaggingCommandInput, options?: __HttpHandlerOptions): Promise<PutJobTaggingCommandOutput>;
|
|
1942
408
|
putJobTagging(args: PutJobTaggingCommandInput, cb: (err: any, data?: PutJobTaggingCommandOutput) => void): void;
|
|
1943
409
|
putJobTagging(args: PutJobTaggingCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutJobTaggingCommandOutput) => void): void;
|
|
1944
410
|
/**
|
|
1945
|
-
* @
|
|
1946
|
-
* <p>Associates an access control policy with the specified Multi-Region Access Point. Each Multi-Region Access Point can have only
|
|
1947
|
-
* one policy, so a request made to this action replaces any existing policy that is
|
|
1948
|
-
* associated with the specified Multi-Region Access Point.</p>
|
|
1949
|
-
* <p>This action will always be routed to the US West (Oregon) Region. For more information
|
|
1950
|
-
* about the restrictions around managing Multi-Region Access Points, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/ManagingMultiRegionAccessPoints.html">Managing
|
|
1951
|
-
* Multi-Region Access Points</a> in the <i>Amazon S3 User Guide</i>.</p>
|
|
1952
|
-
* <p>The following actions are related to
|
|
1953
|
-
* <code>PutMultiRegionAccessPointPolicy</code>:</p>
|
|
1954
|
-
* <ul>
|
|
1955
|
-
* <li>
|
|
1956
|
-
* <p>
|
|
1957
|
-
* <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_GetMultiRegionAccessPointPolicy.html">GetMultiRegionAccessPointPolicy</a>
|
|
1958
|
-
* </p>
|
|
1959
|
-
* </li>
|
|
1960
|
-
* <li>
|
|
1961
|
-
* <p>
|
|
1962
|
-
* <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_GetMultiRegionAccessPointPolicyStatus.html">GetMultiRegionAccessPointPolicyStatus</a>
|
|
1963
|
-
* </p>
|
|
1964
|
-
* </li>
|
|
1965
|
-
* </ul>
|
|
411
|
+
* @see {@link PutMultiRegionAccessPointPolicyCommand}
|
|
1966
412
|
*/
|
|
1967
413
|
putMultiRegionAccessPointPolicy(args: PutMultiRegionAccessPointPolicyCommandInput, options?: __HttpHandlerOptions): Promise<PutMultiRegionAccessPointPolicyCommandOutput>;
|
|
1968
414
|
putMultiRegionAccessPointPolicy(args: PutMultiRegionAccessPointPolicyCommandInput, cb: (err: any, data?: PutMultiRegionAccessPointPolicyCommandOutput) => void): void;
|
|
1969
415
|
putMultiRegionAccessPointPolicy(args: PutMultiRegionAccessPointPolicyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutMultiRegionAccessPointPolicyCommandOutput) => void): void;
|
|
1970
416
|
/**
|
|
1971
|
-
* @
|
|
1972
|
-
* <p>Creates or modifies the <code>PublicAccessBlock</code> configuration for an
|
|
1973
|
-
* Amazon Web Services account. For this operation, users must have the
|
|
1974
|
-
* <code>s3:PutAccountPublicAccessBlock</code> permission. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/access-control-block-public-access.html">
|
|
1975
|
-
* Using Amazon S3 block public access</a>.</p>
|
|
1976
|
-
* <p>Related actions include:</p>
|
|
1977
|
-
* <ul>
|
|
1978
|
-
* <li>
|
|
1979
|
-
* <p>
|
|
1980
|
-
* <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_GetPublicAccessBlock.html">GetPublicAccessBlock</a>
|
|
1981
|
-
* </p>
|
|
1982
|
-
* </li>
|
|
1983
|
-
* <li>
|
|
1984
|
-
* <p>
|
|
1985
|
-
* <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_DeletePublicAccessBlock.html">DeletePublicAccessBlock</a>
|
|
1986
|
-
* </p>
|
|
1987
|
-
* </li>
|
|
1988
|
-
* </ul>
|
|
417
|
+
* @see {@link PutPublicAccessBlockCommand}
|
|
1989
418
|
*/
|
|
1990
419
|
putPublicAccessBlock(args: PutPublicAccessBlockCommandInput, options?: __HttpHandlerOptions): Promise<PutPublicAccessBlockCommandOutput>;
|
|
1991
420
|
putPublicAccessBlock(args: PutPublicAccessBlockCommandInput, cb: (err: any, data?: PutPublicAccessBlockCommandOutput) => void): void;
|
|
1992
421
|
putPublicAccessBlock(args: PutPublicAccessBlockCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutPublicAccessBlockCommandOutput) => void): void;
|
|
1993
422
|
/**
|
|
1994
|
-
* @
|
|
1995
|
-
* <p>Puts an Amazon S3 Storage Lens configuration. For more information about S3 Storage Lens, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/storage_lens.html">Working with
|
|
1996
|
-
* Amazon S3 Storage Lens</a> in the <i>Amazon S3 User Guide</i>. For a complete list of S3 Storage Lens metrics, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/storage_lens_metrics_glossary.html">S3 Storage Lens metrics glossary</a> in the <i>Amazon S3 User Guide</i>.</p>
|
|
1997
|
-
* <note>
|
|
1998
|
-
* <p>To use this action, you must have permission to perform the
|
|
1999
|
-
* <code>s3:PutStorageLensConfiguration</code> action. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/storage_lens_iam_permissions.html">Setting permissions to use Amazon S3 Storage Lens</a> in the
|
|
2000
|
-
* <i>Amazon S3 User Guide</i>.</p>
|
|
2001
|
-
* </note>
|
|
423
|
+
* @see {@link PutStorageLensConfigurationCommand}
|
|
2002
424
|
*/
|
|
2003
425
|
putStorageLensConfiguration(args: PutStorageLensConfigurationCommandInput, options?: __HttpHandlerOptions): Promise<PutStorageLensConfigurationCommandOutput>;
|
|
2004
426
|
putStorageLensConfiguration(args: PutStorageLensConfigurationCommandInput, cb: (err: any, data?: PutStorageLensConfigurationCommandOutput) => void): void;
|
|
2005
427
|
putStorageLensConfiguration(args: PutStorageLensConfigurationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutStorageLensConfigurationCommandOutput) => void): void;
|
|
2006
428
|
/**
|
|
2007
|
-
* @
|
|
2008
|
-
* <p>Put or replace tags on an existing Amazon S3 Storage Lens configuration. For more information
|
|
2009
|
-
* about S3 Storage Lens, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/storage_lens.html">Assessing your storage activity and usage with Amazon S3 Storage Lens </a> in the
|
|
2010
|
-
* <i>Amazon S3 User Guide</i>.</p>
|
|
2011
|
-
* <note>
|
|
2012
|
-
* <p>To use this action, you must have permission to perform the
|
|
2013
|
-
* <code>s3:PutStorageLensConfigurationTagging</code> action. For more information, see
|
|
2014
|
-
* <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/storage_lens_iam_permissions.html">Setting permissions to
|
|
2015
|
-
* use Amazon S3 Storage Lens</a> in the <i>Amazon S3 User Guide</i>.</p>
|
|
2016
|
-
* </note>
|
|
429
|
+
* @see {@link PutStorageLensConfigurationTaggingCommand}
|
|
2017
430
|
*/
|
|
2018
431
|
putStorageLensConfigurationTagging(args: PutStorageLensConfigurationTaggingCommandInput, options?: __HttpHandlerOptions): Promise<PutStorageLensConfigurationTaggingCommandOutput>;
|
|
2019
432
|
putStorageLensConfigurationTagging(args: PutStorageLensConfigurationTaggingCommandInput, cb: (err: any, data?: PutStorageLensConfigurationTaggingCommandOutput) => void): void;
|
|
2020
433
|
putStorageLensConfigurationTagging(args: PutStorageLensConfigurationTaggingCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutStorageLensConfigurationTaggingCommandOutput) => void): void;
|
|
2021
434
|
/**
|
|
2022
|
-
* @
|
|
2023
|
-
* <p>Submits an updated route configuration for a Multi-Region Access Point. This API operation updates the
|
|
2024
|
-
* routing status for the specified Regions from active to passive, or from passive to active.
|
|
2025
|
-
* A value of <code>0</code> indicates a passive status, which means that traffic won't be
|
|
2026
|
-
* routed to the specified Region. A value of <code>100</code> indicates an active status,
|
|
2027
|
-
* which means that traffic will be routed to the specified Region. At least one Region must be active at all times.</p>
|
|
2028
|
-
* <p>When the routing configuration is changed, any in-progress operations (uploads, copies,
|
|
2029
|
-
* deletes, and so on) to formerly active Regions will continue to run to their final
|
|
2030
|
-
* completion state (success or failure). The routing configurations of any Regions that
|
|
2031
|
-
* aren’t specified remain unchanged.</p>
|
|
2032
|
-
* <note>
|
|
2033
|
-
* <p>Updated routing configurations might not be immediately applied. It can take up to 2
|
|
2034
|
-
* minutes for your changes to take effect.</p>
|
|
2035
|
-
* </note>
|
|
2036
|
-
* <p>To submit routing control changes and failover requests, use the Amazon S3 failover control
|
|
2037
|
-
* infrastructure endpoints in these five Amazon Web Services Regions:</p>
|
|
2038
|
-
* <ul>
|
|
2039
|
-
* <li>
|
|
2040
|
-
* <p>
|
|
2041
|
-
* <code>us-east-1</code>
|
|
2042
|
-
* </p>
|
|
2043
|
-
* </li>
|
|
2044
|
-
* <li>
|
|
2045
|
-
* <p>
|
|
2046
|
-
* <code>us-west-2</code>
|
|
2047
|
-
* </p>
|
|
2048
|
-
* </li>
|
|
2049
|
-
* <li>
|
|
2050
|
-
* <p>
|
|
2051
|
-
* <code>ap-southeast-2</code>
|
|
2052
|
-
* </p>
|
|
2053
|
-
* </li>
|
|
2054
|
-
* <li>
|
|
2055
|
-
* <p>
|
|
2056
|
-
* <code>ap-northeast-1</code>
|
|
2057
|
-
* </p>
|
|
2058
|
-
* </li>
|
|
2059
|
-
* <li>
|
|
2060
|
-
* <p>
|
|
2061
|
-
* <code>eu-west-1</code>
|
|
2062
|
-
* </p>
|
|
2063
|
-
* </li>
|
|
2064
|
-
* </ul>
|
|
2065
|
-
* <note>
|
|
2066
|
-
* <p>Your Amazon S3 bucket does not need to be in these five Regions.</p>
|
|
2067
|
-
* </note>
|
|
435
|
+
* @see {@link SubmitMultiRegionAccessPointRoutesCommand}
|
|
2068
436
|
*/
|
|
2069
437
|
submitMultiRegionAccessPointRoutes(args: SubmitMultiRegionAccessPointRoutesCommandInput, options?: __HttpHandlerOptions): Promise<SubmitMultiRegionAccessPointRoutesCommandOutput>;
|
|
2070
438
|
submitMultiRegionAccessPointRoutes(args: SubmitMultiRegionAccessPointRoutesCommandInput, cb: (err: any, data?: SubmitMultiRegionAccessPointRoutesCommandOutput) => void): void;
|
|
2071
439
|
submitMultiRegionAccessPointRoutes(args: SubmitMultiRegionAccessPointRoutesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: SubmitMultiRegionAccessPointRoutesCommandOutput) => void): void;
|
|
2072
440
|
/**
|
|
2073
|
-
* @
|
|
2074
|
-
* <p>Updates an existing S3 Batch Operations job's priority. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/batch-ops.html">S3 Batch Operations</a> in the <i>Amazon S3 User Guide</i>.</p>
|
|
2075
|
-
* <p></p>
|
|
2076
|
-
* <p>Related actions include:</p>
|
|
2077
|
-
* <ul>
|
|
2078
|
-
* <li>
|
|
2079
|
-
* <p>
|
|
2080
|
-
* <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_CreateJob.html">CreateJob</a>
|
|
2081
|
-
* </p>
|
|
2082
|
-
* </li>
|
|
2083
|
-
* <li>
|
|
2084
|
-
* <p>
|
|
2085
|
-
* <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_ListJobs.html">ListJobs</a>
|
|
2086
|
-
* </p>
|
|
2087
|
-
* </li>
|
|
2088
|
-
* <li>
|
|
2089
|
-
* <p>
|
|
2090
|
-
* <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_DescribeJob.html">DescribeJob</a>
|
|
2091
|
-
* </p>
|
|
2092
|
-
* </li>
|
|
2093
|
-
* <li>
|
|
2094
|
-
* <p>
|
|
2095
|
-
* <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_UpdateJobStatus.html">UpdateJobStatus</a>
|
|
2096
|
-
* </p>
|
|
2097
|
-
* </li>
|
|
2098
|
-
* </ul>
|
|
441
|
+
* @see {@link UpdateJobPriorityCommand}
|
|
2099
442
|
*/
|
|
2100
443
|
updateJobPriority(args: UpdateJobPriorityCommandInput, options?: __HttpHandlerOptions): Promise<UpdateJobPriorityCommandOutput>;
|
|
2101
444
|
updateJobPriority(args: UpdateJobPriorityCommandInput, cb: (err: any, data?: UpdateJobPriorityCommandOutput) => void): void;
|
|
2102
445
|
updateJobPriority(args: UpdateJobPriorityCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateJobPriorityCommandOutput) => void): void;
|
|
2103
446
|
/**
|
|
2104
|
-
* @
|
|
2105
|
-
* <p>Updates the status for the specified job. Use this action to confirm that you want to
|
|
2106
|
-
* run a job or to cancel an existing job. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/batch-ops.html">S3 Batch Operations</a> in the <i>Amazon S3 User Guide</i>.</p>
|
|
2107
|
-
* <p></p>
|
|
2108
|
-
* <p>Related actions include:</p>
|
|
2109
|
-
* <ul>
|
|
2110
|
-
* <li>
|
|
2111
|
-
* <p>
|
|
2112
|
-
* <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_CreateJob.html">CreateJob</a>
|
|
2113
|
-
* </p>
|
|
2114
|
-
* </li>
|
|
2115
|
-
* <li>
|
|
2116
|
-
* <p>
|
|
2117
|
-
* <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_ListJobs.html">ListJobs</a>
|
|
2118
|
-
* </p>
|
|
2119
|
-
* </li>
|
|
2120
|
-
* <li>
|
|
2121
|
-
* <p>
|
|
2122
|
-
* <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_DescribeJob.html">DescribeJob</a>
|
|
2123
|
-
* </p>
|
|
2124
|
-
* </li>
|
|
2125
|
-
* <li>
|
|
2126
|
-
* <p>
|
|
2127
|
-
* <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_UpdateJobStatus.html">UpdateJobStatus</a>
|
|
2128
|
-
* </p>
|
|
2129
|
-
* </li>
|
|
2130
|
-
* </ul>
|
|
447
|
+
* @see {@link UpdateJobStatusCommand}
|
|
2131
448
|
*/
|
|
2132
449
|
updateJobStatus(args: UpdateJobStatusCommandInput, options?: __HttpHandlerOptions): Promise<UpdateJobStatusCommandOutput>;
|
|
2133
450
|
updateJobStatus(args: UpdateJobStatusCommandInput, cb: (err: any, data?: UpdateJobStatusCommandOutput) => void): void;
|
|
2134
451
|
updateJobStatus(args: UpdateJobStatusCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateJobStatusCommandOutput) => void): void;
|
|
2135
452
|
}
|
|
453
|
+
/**
|
|
454
|
+
* @public
|
|
455
|
+
* <p> Amazon Web Services S3 Control provides access to Amazon S3 control plane actions. </p>
|
|
456
|
+
*/
|
|
457
|
+
export declare class S3Control extends S3ControlClient implements S3Control {
|
|
458
|
+
}
|