@aws-sdk/client-s3outposts 3.379.1 → 3.385.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.
@@ -43,19 +43,23 @@ export type EndpointAccessType = (typeof EndpointAccessType)[keyof typeof Endpoi
43
43
  */
44
44
  export interface CreateEndpointRequest {
45
45
  /**
46
+ * @public
46
47
  * <p>The ID of the Outposts. </p>
47
48
  */
48
49
  OutpostId: string | undefined;
49
50
  /**
51
+ * @public
50
52
  * <p>The ID of the subnet in the selected VPC. The endpoint subnet must belong to the Outpost
51
53
  * that has Amazon S3 on Outposts provisioned.</p>
52
54
  */
53
55
  SubnetId: string | undefined;
54
56
  /**
57
+ * @public
55
58
  * <p>The ID of the security group to use with the endpoint.</p>
56
59
  */
57
60
  SecurityGroupId: string | undefined;
58
61
  /**
62
+ * @public
59
63
  * <p>The type of access for the network connectivity for the Amazon S3 on Outposts endpoint. To use
60
64
  * the Amazon Web Services VPC, choose <code>Private</code>. To use the endpoint with an on-premises
61
65
  * network, choose <code>CustomerOwnedIp</code>. If you choose
@@ -68,6 +72,7 @@ export interface CreateEndpointRequest {
68
72
  */
69
73
  AccessType?: EndpointAccessType | string;
70
74
  /**
75
+ * @public
71
76
  * <p>The ID of the customer-owned IPv4 address pool (CoIP pool) for the endpoint. IP addresses
72
77
  * are allocated from this pool for the endpoint.</p>
73
78
  */
@@ -78,6 +83,7 @@ export interface CreateEndpointRequest {
78
83
  */
79
84
  export interface CreateEndpointResult {
80
85
  /**
86
+ * @public
81
87
  * <p>The Amazon Resource Name (ARN) of the endpoint.</p>
82
88
  */
83
89
  EndpointArn?: string;
@@ -152,10 +158,12 @@ export declare class ValidationException extends __BaseException {
152
158
  */
153
159
  export interface DeleteEndpointRequest {
154
160
  /**
161
+ * @public
155
162
  * <p>The ID of the endpoint.</p>
156
163
  */
157
164
  EndpointId: string | undefined;
158
165
  /**
166
+ * @public
159
167
  * <p>The ID of the Outposts. </p>
160
168
  */
161
169
  OutpostId: string | undefined;
@@ -166,10 +174,12 @@ export interface DeleteEndpointRequest {
166
174
  */
167
175
  export interface FailedReason {
168
176
  /**
177
+ * @public
169
178
  * <p>The failure code, if any, for a create or delete endpoint operation.</p>
170
179
  */
171
180
  ErrorCode?: string;
172
181
  /**
182
+ * @public
173
183
  * <p>Additional error details describing the endpoint failure and recommended action.</p>
174
184
  */
175
185
  Message?: string;
@@ -180,6 +190,7 @@ export interface FailedReason {
180
190
  */
181
191
  export interface NetworkInterface {
182
192
  /**
193
+ * @public
183
194
  * <p>The ID for the network interface.</p>
184
195
  */
185
196
  NetworkInterfaceId?: string;
@@ -208,50 +219,62 @@ export type EndpointStatus = (typeof EndpointStatus)[keyof typeof EndpointStatus
208
219
  */
209
220
  export interface Endpoint {
210
221
  /**
222
+ * @public
211
223
  * <p>The Amazon Resource Name (ARN) of the endpoint.</p>
212
224
  */
213
225
  EndpointArn?: string;
214
226
  /**
227
+ * @public
215
228
  * <p>The ID of the Outposts.</p>
216
229
  */
217
230
  OutpostsId?: string;
218
231
  /**
232
+ * @public
219
233
  * <p>The VPC CIDR committed by this endpoint.</p>
220
234
  */
221
235
  CidrBlock?: string;
222
236
  /**
237
+ * @public
223
238
  * <p>The status of the endpoint.</p>
224
239
  */
225
240
  Status?: EndpointStatus | string;
226
241
  /**
242
+ * @public
227
243
  * <p>The time the endpoint was created.</p>
228
244
  */
229
245
  CreationTime?: Date;
230
246
  /**
247
+ * @public
231
248
  * <p>The network interface of the endpoint.</p>
232
249
  */
233
250
  NetworkInterfaces?: NetworkInterface[];
234
251
  /**
252
+ * @public
235
253
  * <p>The ID of the VPC used for the endpoint.</p>
236
254
  */
237
255
  VpcId?: string;
238
256
  /**
257
+ * @public
239
258
  * <p>The ID of the subnet used for the endpoint.</p>
240
259
  */
241
260
  SubnetId?: string;
242
261
  /**
262
+ * @public
243
263
  * <p>The ID of the security group used for the endpoint.</p>
244
264
  */
245
265
  SecurityGroupId?: string;
246
266
  /**
267
+ * @public
247
268
  * <p>The type of connectivity used to access the Amazon S3 on Outposts endpoint.</p>
248
269
  */
249
270
  AccessType?: EndpointAccessType | string;
250
271
  /**
272
+ * @public
251
273
  * <p>The ID of the customer-owned IPv4 address pool used for the endpoint.</p>
252
274
  */
253
275
  CustomerOwnedIpv4Pool?: string;
254
276
  /**
277
+ * @public
255
278
  * <p>The failure reason, if any, for a create or delete endpoint operation.</p>
256
279
  */
257
280
  FailedReason?: FailedReason;
@@ -261,11 +284,13 @@ export interface Endpoint {
261
284
  */
262
285
  export interface ListEndpointsRequest {
263
286
  /**
287
+ * @public
264
288
  * <p>If a previous response from this operation included a <code>NextToken</code> value,
265
289
  * provide that value here to retrieve the next page of results.</p>
266
290
  */
267
291
  NextToken?: string;
268
292
  /**
293
+ * @public
269
294
  * <p>The maximum number of endpoints that will be returned in the response.</p>
270
295
  */
271
296
  MaxResults?: number;
@@ -275,10 +300,12 @@ export interface ListEndpointsRequest {
275
300
  */
276
301
  export interface ListEndpointsResult {
277
302
  /**
303
+ * @public
278
304
  * <p>The list of endpoints associated with the specified Outpost.</p>
279
305
  */
280
306
  Endpoints?: Endpoint[];
281
307
  /**
308
+ * @public
282
309
  * <p>If the number of endpoints associated with the specified Outpost exceeds <code>MaxResults</code>,
283
310
  * you can include this value in subsequent calls to this operation to retrieve more results.</p>
284
311
  */
@@ -289,6 +316,7 @@ export interface ListEndpointsResult {
289
316
  */
290
317
  export interface ListOutpostsWithS3Request {
291
318
  /**
319
+ * @public
292
320
  * <p>When you can get additional results from the <code>ListOutpostsWithS3</code> call, a
293
321
  * <code>NextToken</code> parameter is returned in the output. You can then pass in a
294
322
  * subsequent command to the <code>NextToken</code> parameter to continue listing
@@ -296,6 +324,7 @@ export interface ListOutpostsWithS3Request {
296
324
  */
297
325
  NextToken?: string;
298
326
  /**
327
+ * @public
299
328
  * <p>The maximum number of Outposts to return. The limit is 100.</p>
300
329
  */
301
330
  MaxResults?: number;
@@ -306,18 +335,22 @@ export interface ListOutpostsWithS3Request {
306
335
  */
307
336
  export interface Outpost {
308
337
  /**
338
+ * @public
309
339
  * <p>Specifies the unique Amazon Resource Name (ARN) for the outpost.</p>
310
340
  */
311
341
  OutpostArn?: string;
312
342
  /**
343
+ * @public
313
344
  * <p>Specifies the unique identifier for the outpost.</p>
314
345
  */
315
346
  OutpostId?: string;
316
347
  /**
348
+ * @public
317
349
  * <p>Returns the Amazon Web Services account ID of the outpost owner. Useful for comparing owned versus shared outposts.</p>
318
350
  */
319
351
  OwnerId?: string;
320
352
  /**
353
+ * @public
321
354
  * <p>The Amazon S3 capacity of the outpost in bytes.</p>
322
355
  */
323
356
  CapacityInBytes?: number;
@@ -327,6 +360,7 @@ export interface Outpost {
327
360
  */
328
361
  export interface ListOutpostsWithS3Result {
329
362
  /**
363
+ * @public
330
364
  * <p>Returns the list of Outposts that have the following characteristics:</p>
331
365
  * <ul>
332
366
  * <li>
@@ -342,6 +376,7 @@ export interface ListOutpostsWithS3Result {
342
376
  */
343
377
  Outposts?: Outpost[];
344
378
  /**
379
+ * @public
345
380
  * <p>Returns a token that you can use to call <code>ListOutpostsWithS3</code> again and receive additional results, if there are any.</p>
346
381
  */
347
382
  NextToken?: string;
@@ -351,15 +386,18 @@ export interface ListOutpostsWithS3Result {
351
386
  */
352
387
  export interface ListSharedEndpointsRequest {
353
388
  /**
389
+ * @public
354
390
  * <p>If a previous response from this operation included a <code>NextToken</code> value, you
355
391
  * can provide that value here to retrieve the next page of results.</p>
356
392
  */
357
393
  NextToken?: string;
358
394
  /**
395
+ * @public
359
396
  * <p>The maximum number of endpoints that will be returned in the response.</p>
360
397
  */
361
398
  MaxResults?: number;
362
399
  /**
400
+ * @public
363
401
  * <p>The ID of the Amazon Web Services Outpost.</p>
364
402
  */
365
403
  OutpostId: string | undefined;
@@ -369,10 +407,12 @@ export interface ListSharedEndpointsRequest {
369
407
  */
370
408
  export interface ListSharedEndpointsResult {
371
409
  /**
410
+ * @public
372
411
  * <p>The list of endpoints associated with the specified Outpost that have been shared by Amazon Web Services Resource Access Manager (RAM).</p>
373
412
  */
374
413
  Endpoints?: Endpoint[];
375
414
  /**
415
+ * @public
376
416
  * <p>If the number of endpoints associated with the specified Outpost exceeds <code>MaxResults</code>,
377
417
  * you can include this value in subsequent calls to this operation to retrieve more results.</p>
378
418
  */
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@aws-sdk/client-s3outposts",
3
3
  "description": "AWS SDK for JavaScript S3outposts Client for Node.js, Browser and React Native",
4
- "version": "3.379.1",
4
+ "version": "3.385.0",
5
5
  "scripts": {
6
6
  "build": "concurrently 'yarn:build:cjs' 'yarn:build:es' 'yarn:build:types'",
7
7
  "build:cjs": "tsc -p tsconfig.cjs.json",
@@ -21,15 +21,15 @@
21
21
  "dependencies": {
22
22
  "@aws-crypto/sha256-browser": "3.0.0",
23
23
  "@aws-crypto/sha256-js": "3.0.0",
24
- "@aws-sdk/client-sts": "3.379.1",
25
- "@aws-sdk/credential-provider-node": "3.379.1",
24
+ "@aws-sdk/client-sts": "3.385.0",
25
+ "@aws-sdk/credential-provider-node": "3.385.0",
26
26
  "@aws-sdk/middleware-host-header": "3.379.1",
27
27
  "@aws-sdk/middleware-logger": "3.378.0",
28
28
  "@aws-sdk/middleware-recursion-detection": "3.378.0",
29
29
  "@aws-sdk/middleware-signing": "3.379.1",
30
- "@aws-sdk/middleware-user-agent": "3.379.1",
30
+ "@aws-sdk/middleware-user-agent": "3.382.0",
31
31
  "@aws-sdk/types": "3.378.0",
32
- "@aws-sdk/util-endpoints": "3.378.0",
32
+ "@aws-sdk/util-endpoints": "3.382.0",
33
33
  "@aws-sdk/util-user-agent-browser": "3.378.0",
34
34
  "@aws-sdk/util-user-agent-node": "3.378.0",
35
35
  "@smithy/config-resolver": "^2.0.1",