@aws-sdk/client-mediastore 3.295.0 → 3.297.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.
Files changed (28) hide show
  1. package/dist-types/MediaStore.d.ts +22 -0
  2. package/dist-types/MediaStoreClient.d.ts +24 -4
  3. package/dist-types/commands/CreateContainerCommand.d.ts +16 -0
  4. package/dist-types/commands/DeleteContainerCommand.d.ts +16 -0
  5. package/dist-types/commands/DeleteContainerPolicyCommand.d.ts +16 -0
  6. package/dist-types/commands/DeleteCorsPolicyCommand.d.ts +16 -0
  7. package/dist-types/commands/DeleteLifecyclePolicyCommand.d.ts +16 -0
  8. package/dist-types/commands/DeleteMetricPolicyCommand.d.ts +16 -0
  9. package/dist-types/commands/DescribeContainerCommand.d.ts +16 -0
  10. package/dist-types/commands/GetContainerPolicyCommand.d.ts +16 -0
  11. package/dist-types/commands/GetCorsPolicyCommand.d.ts +16 -0
  12. package/dist-types/commands/GetLifecyclePolicyCommand.d.ts +16 -0
  13. package/dist-types/commands/GetMetricPolicyCommand.d.ts +16 -0
  14. package/dist-types/commands/ListContainersCommand.d.ts +16 -0
  15. package/dist-types/commands/ListTagsForResourceCommand.d.ts +16 -0
  16. package/dist-types/commands/PutContainerPolicyCommand.d.ts +16 -0
  17. package/dist-types/commands/PutCorsPolicyCommand.d.ts +16 -0
  18. package/dist-types/commands/PutLifecyclePolicyCommand.d.ts +16 -0
  19. package/dist-types/commands/PutMetricPolicyCommand.d.ts +16 -0
  20. package/dist-types/commands/StartAccessLoggingCommand.d.ts +16 -0
  21. package/dist-types/commands/StopAccessLoggingCommand.d.ts +16 -0
  22. package/dist-types/commands/TagResourceCommand.d.ts +16 -0
  23. package/dist-types/commands/UntagResourceCommand.d.ts +16 -0
  24. package/dist-types/models/MediaStoreServiceException.d.ts +2 -0
  25. package/dist-types/models/models_0.d.ts +146 -0
  26. package/dist-types/pagination/Interfaces.d.ts +3 -0
  27. package/dist-types/pagination/ListContainersPaginator.d.ts +3 -0
  28. package/package.json +29 -29
@@ -1,5 +1,7 @@
1
1
  import { ServiceException as __ServiceException, ServiceExceptionOptions as __ServiceExceptionOptions } from "@aws-sdk/smithy-client";
2
2
  /**
3
+ * @public
4
+ *
3
5
  * Base exception class for all service exceptions from MediaStore service.
4
6
  */
5
7
  export declare class MediaStoreServiceException extends __ServiceException {
@@ -1,17 +1,24 @@
1
1
  import { ExceptionOptionType as __ExceptionOptionType } from "@aws-sdk/smithy-client";
2
2
  import { MediaStoreServiceException as __BaseException } from "./MediaStoreServiceException";
3
+ /**
4
+ * @public
5
+ */
3
6
  export declare enum MethodName {
4
7
  DELETE = "DELETE",
5
8
  GET = "GET",
6
9
  HEAD = "HEAD",
7
10
  PUT = "PUT"
8
11
  }
12
+ /**
13
+ * @public
14
+ */
9
15
  export declare enum ContainerStatus {
10
16
  ACTIVE = "ACTIVE",
11
17
  CREATING = "CREATING",
12
18
  DELETING = "DELETING"
13
19
  }
14
20
  /**
21
+ * @public
15
22
  * <p>This section describes operations that you can perform on an AWS Elemental MediaStore
16
23
  * container.</p>
17
24
  */
@@ -51,6 +58,7 @@ export interface Container {
51
58
  AccessLoggingEnabled?: boolean;
52
59
  }
53
60
  /**
61
+ * @public
54
62
  * <p>The container that you specified in the request already exists or is being
55
63
  * updated.</p>
56
64
  */
@@ -63,11 +71,15 @@ export declare class ContainerInUseException extends __BaseException {
63
71
  */
64
72
  constructor(opts: __ExceptionOptionType<ContainerInUseException, __BaseException>);
65
73
  }
74
+ /**
75
+ * @public
76
+ */
66
77
  export declare enum ContainerLevelMetrics {
67
78
  DISABLED = "DISABLED",
68
79
  ENABLED = "ENABLED"
69
80
  }
70
81
  /**
82
+ * @public
71
83
  * <p>The container that you specified in the request does not exist.</p>
72
84
  */
73
85
  export declare class ContainerNotFoundException extends __BaseException {
@@ -80,6 +92,7 @@ export declare class ContainerNotFoundException extends __BaseException {
80
92
  constructor(opts: __ExceptionOptionType<ContainerNotFoundException, __BaseException>);
81
93
  }
82
94
  /**
95
+ * @public
83
96
  * <p>A rule for a CORS policy. You can add up to 100 rules to a CORS policy. If more than
84
97
  * one rule applies, the service uses the first applicable rule listed.</p>
85
98
  */
@@ -123,6 +136,7 @@ export interface CorsRule {
123
136
  ExposeHeaders?: string[];
124
137
  }
125
138
  /**
139
+ * @public
126
140
  * <p>The CORS policy that you specified in the request does not exist.</p>
127
141
  */
128
142
  export declare class CorsPolicyNotFoundException extends __BaseException {
@@ -135,6 +149,7 @@ export declare class CorsPolicyNotFoundException extends __BaseException {
135
149
  constructor(opts: __ExceptionOptionType<CorsPolicyNotFoundException, __BaseException>);
136
150
  }
137
151
  /**
152
+ * @public
138
153
  * <p>A collection of tags associated with a container. Each tag consists of a key:value pair, which can be anything you define. Typically, the tag key
139
154
  * represents a category (such as "environment") and the tag value represents a specific value within that category (such as "test," "development," or
140
155
  * "production"). You can add up to 50
@@ -152,6 +167,9 @@ export interface Tag {
152
167
  */
153
168
  Value?: string;
154
169
  }
170
+ /**
171
+ * @public
172
+ */
155
173
  export interface CreateContainerInput {
156
174
  /**
157
175
  * <p>The name for the container. The name must be from 1 to 255 characters. Container
@@ -167,6 +185,9 @@ export interface CreateContainerInput {
167
185
  */
168
186
  Tags?: Tag[];
169
187
  }
188
+ /**
189
+ * @public
190
+ */
170
191
  export interface CreateContainerOutput {
171
192
  /**
172
193
  * <p>ContainerARN: The Amazon Resource Name (ARN) of the newly created container. The ARN
@@ -185,6 +206,7 @@ export interface CreateContainerOutput {
185
206
  Container: Container | undefined;
186
207
  }
187
208
  /**
209
+ * @public
188
210
  * <p>The service is temporarily unavailable.</p>
189
211
  */
190
212
  export declare class InternalServerError extends __BaseException {
@@ -197,6 +219,7 @@ export declare class InternalServerError extends __BaseException {
197
219
  constructor(opts: __ExceptionOptionType<InternalServerError, __BaseException>);
198
220
  }
199
221
  /**
222
+ * @public
200
223
  * <p>A service limit has been exceeded.</p>
201
224
  */
202
225
  export declare class LimitExceededException extends __BaseException {
@@ -208,23 +231,36 @@ export declare class LimitExceededException extends __BaseException {
208
231
  */
209
232
  constructor(opts: __ExceptionOptionType<LimitExceededException, __BaseException>);
210
233
  }
234
+ /**
235
+ * @public
236
+ */
211
237
  export interface DeleteContainerInput {
212
238
  /**
213
239
  * <p>The name of the container to delete. </p>
214
240
  */
215
241
  ContainerName: string | undefined;
216
242
  }
243
+ /**
244
+ * @public
245
+ */
217
246
  export interface DeleteContainerOutput {
218
247
  }
248
+ /**
249
+ * @public
250
+ */
219
251
  export interface DeleteContainerPolicyInput {
220
252
  /**
221
253
  * <p>The name of the container that holds the policy.</p>
222
254
  */
223
255
  ContainerName: string | undefined;
224
256
  }
257
+ /**
258
+ * @public
259
+ */
225
260
  export interface DeleteContainerPolicyOutput {
226
261
  }
227
262
  /**
263
+ * @public
228
264
  * <p>The policy that you specified in the request does not exist.</p>
229
265
  */
230
266
  export declare class PolicyNotFoundException extends __BaseException {
@@ -236,78 +272,123 @@ export declare class PolicyNotFoundException extends __BaseException {
236
272
  */
237
273
  constructor(opts: __ExceptionOptionType<PolicyNotFoundException, __BaseException>);
238
274
  }
275
+ /**
276
+ * @public
277
+ */
239
278
  export interface DeleteCorsPolicyInput {
240
279
  /**
241
280
  * <p>The name of the container to remove the policy from.</p>
242
281
  */
243
282
  ContainerName: string | undefined;
244
283
  }
284
+ /**
285
+ * @public
286
+ */
245
287
  export interface DeleteCorsPolicyOutput {
246
288
  }
289
+ /**
290
+ * @public
291
+ */
247
292
  export interface DeleteLifecyclePolicyInput {
248
293
  /**
249
294
  * <p>The name of the container that holds the object lifecycle policy.</p>
250
295
  */
251
296
  ContainerName: string | undefined;
252
297
  }
298
+ /**
299
+ * @public
300
+ */
253
301
  export interface DeleteLifecyclePolicyOutput {
254
302
  }
303
+ /**
304
+ * @public
305
+ */
255
306
  export interface DeleteMetricPolicyInput {
256
307
  /**
257
308
  * <p>The name of the container that is associated with the metric policy that you want to delete.</p>
258
309
  */
259
310
  ContainerName: string | undefined;
260
311
  }
312
+ /**
313
+ * @public
314
+ */
261
315
  export interface DeleteMetricPolicyOutput {
262
316
  }
317
+ /**
318
+ * @public
319
+ */
263
320
  export interface DescribeContainerInput {
264
321
  /**
265
322
  * <p>The name of the container to query.</p>
266
323
  */
267
324
  ContainerName?: string;
268
325
  }
326
+ /**
327
+ * @public
328
+ */
269
329
  export interface DescribeContainerOutput {
270
330
  /**
271
331
  * <p>The name of the queried container.</p>
272
332
  */
273
333
  Container?: Container;
274
334
  }
335
+ /**
336
+ * @public
337
+ */
275
338
  export interface GetContainerPolicyInput {
276
339
  /**
277
340
  * <p>The name of the container. </p>
278
341
  */
279
342
  ContainerName: string | undefined;
280
343
  }
344
+ /**
345
+ * @public
346
+ */
281
347
  export interface GetContainerPolicyOutput {
282
348
  /**
283
349
  * <p>The contents of the access policy.</p>
284
350
  */
285
351
  Policy: string | undefined;
286
352
  }
353
+ /**
354
+ * @public
355
+ */
287
356
  export interface GetCorsPolicyInput {
288
357
  /**
289
358
  * <p>The name of the container that the policy is assigned to.</p>
290
359
  */
291
360
  ContainerName: string | undefined;
292
361
  }
362
+ /**
363
+ * @public
364
+ */
293
365
  export interface GetCorsPolicyOutput {
294
366
  /**
295
367
  * <p>The CORS policy assigned to the container.</p>
296
368
  */
297
369
  CorsPolicy: CorsRule[] | undefined;
298
370
  }
371
+ /**
372
+ * @public
373
+ */
299
374
  export interface GetLifecyclePolicyInput {
300
375
  /**
301
376
  * <p>The name of the container that the object lifecycle policy is assigned to.</p>
302
377
  */
303
378
  ContainerName: string | undefined;
304
379
  }
380
+ /**
381
+ * @public
382
+ */
305
383
  export interface GetLifecyclePolicyOutput {
306
384
  /**
307
385
  * <p>The object lifecycle policy that is assigned to the container.</p>
308
386
  */
309
387
  LifecyclePolicy: string | undefined;
310
388
  }
389
+ /**
390
+ * @public
391
+ */
311
392
  export interface GetMetricPolicyInput {
312
393
  /**
313
394
  * <p>The name of the container that is associated with the metric policy.</p>
@@ -315,6 +396,7 @@ export interface GetMetricPolicyInput {
315
396
  ContainerName: string | undefined;
316
397
  }
317
398
  /**
399
+ * @public
318
400
  * <p>A setting that enables metrics at the object level. Each rule contains an object group and an object group name. If the policy includes the MetricPolicyRules parameter, you must include at least one rule. Each metric policy can include up to five rules by default. You can also <a href="https://console.aws.amazon.com/servicequotas/home?region=us-east-1#!/services/mediastore/quotas">request a quota increase</a> to allow up to 300 rules per policy.</p>
319
401
  */
320
402
  export interface MetricPolicyRule {
@@ -328,6 +410,7 @@ export interface MetricPolicyRule {
328
410
  ObjectGroupName: string | undefined;
329
411
  }
330
412
  /**
413
+ * @public
331
414
  * <p>The metric policy that is associated with the container. A metric policy allows AWS Elemental MediaStore to send metrics to Amazon CloudWatch. In the policy, you must indicate whether you want MediaStore to send container-level metrics. You can also include rules to define groups of objects that you want MediaStore to send object-level metrics for.</p>
332
415
  * <p>To view examples of how to construct a metric policy for your use case, see <a href="https://docs.aws.amazon.com/mediastore/latest/ug/policies-metric-examples.html">Example Metric Policies</a>.</p>
333
416
  */
@@ -341,12 +424,18 @@ export interface MetricPolicy {
341
424
  */
342
425
  MetricPolicyRules?: MetricPolicyRule[];
343
426
  }
427
+ /**
428
+ * @public
429
+ */
344
430
  export interface GetMetricPolicyOutput {
345
431
  /**
346
432
  * <p>The metric policy that is associated with the specific container.</p>
347
433
  */
348
434
  MetricPolicy: MetricPolicy | undefined;
349
435
  }
436
+ /**
437
+ * @public
438
+ */
350
439
  export interface ListContainersInput {
351
440
  /**
352
441
  * <p>Only if you used <code>MaxResults</code> in the first command, enter the token (which
@@ -360,6 +449,9 @@ export interface ListContainersInput {
360
449
  */
361
450
  MaxResults?: number;
362
451
  }
452
+ /**
453
+ * @public
454
+ */
363
455
  export interface ListContainersOutput {
364
456
  /**
365
457
  * <p>The names of the containers.</p>
@@ -373,18 +465,27 @@ export interface ListContainersOutput {
373
465
  */
374
466
  NextToken?: string;
375
467
  }
468
+ /**
469
+ * @public
470
+ */
376
471
  export interface ListTagsForResourceInput {
377
472
  /**
378
473
  * <p>The Amazon Resource Name (ARN) for the container.</p>
379
474
  */
380
475
  Resource: string | undefined;
381
476
  }
477
+ /**
478
+ * @public
479
+ */
382
480
  export interface ListTagsForResourceOutput {
383
481
  /**
384
482
  * <p>An array of key:value pairs that are assigned to the container.</p>
385
483
  */
386
484
  Tags?: Tag[];
387
485
  }
486
+ /**
487
+ * @public
488
+ */
388
489
  export interface PutContainerPolicyInput {
389
490
  /**
390
491
  * <p>The name of the container.</p>
@@ -404,8 +505,14 @@ export interface PutContainerPolicyInput {
404
505
  */
405
506
  Policy: string | undefined;
406
507
  }
508
+ /**
509
+ * @public
510
+ */
407
511
  export interface PutContainerPolicyOutput {
408
512
  }
513
+ /**
514
+ * @public
515
+ */
409
516
  export interface PutCorsPolicyInput {
410
517
  /**
411
518
  * <p>The name of the container that you want to assign the CORS policy to.</p>
@@ -416,8 +523,14 @@ export interface PutCorsPolicyInput {
416
523
  */
417
524
  CorsPolicy: CorsRule[] | undefined;
418
525
  }
526
+ /**
527
+ * @public
528
+ */
419
529
  export interface PutCorsPolicyOutput {
420
530
  }
531
+ /**
532
+ * @public
533
+ */
421
534
  export interface PutLifecyclePolicyInput {
422
535
  /**
423
536
  * <p>The name of the container that you want to assign the object lifecycle policy to.</p>
@@ -428,8 +541,14 @@ export interface PutLifecyclePolicyInput {
428
541
  */
429
542
  LifecyclePolicy: string | undefined;
430
543
  }
544
+ /**
545
+ * @public
546
+ */
431
547
  export interface PutLifecyclePolicyOutput {
432
548
  }
549
+ /**
550
+ * @public
551
+ */
433
552
  export interface PutMetricPolicyInput {
434
553
  /**
435
554
  * <p>The name of the container that you want to add the metric policy to.</p>
@@ -448,24 +567,42 @@ export interface PutMetricPolicyInput {
448
567
  */
449
568
  MetricPolicy: MetricPolicy | undefined;
450
569
  }
570
+ /**
571
+ * @public
572
+ */
451
573
  export interface PutMetricPolicyOutput {
452
574
  }
575
+ /**
576
+ * @public
577
+ */
453
578
  export interface StartAccessLoggingInput {
454
579
  /**
455
580
  * <p>The name of the container that you want to start access logging on.</p>
456
581
  */
457
582
  ContainerName: string | undefined;
458
583
  }
584
+ /**
585
+ * @public
586
+ */
459
587
  export interface StartAccessLoggingOutput {
460
588
  }
589
+ /**
590
+ * @public
591
+ */
461
592
  export interface StopAccessLoggingInput {
462
593
  /**
463
594
  * <p>The name of the container that you want to stop access logging on.</p>
464
595
  */
465
596
  ContainerName: string | undefined;
466
597
  }
598
+ /**
599
+ * @public
600
+ */
467
601
  export interface StopAccessLoggingOutput {
468
602
  }
603
+ /**
604
+ * @public
605
+ */
469
606
  export interface TagResourceInput {
470
607
  /**
471
608
  * <p>The Amazon Resource Name (ARN) for the container. </p>
@@ -479,8 +616,14 @@ export interface TagResourceInput {
479
616
  */
480
617
  Tags: Tag[] | undefined;
481
618
  }
619
+ /**
620
+ * @public
621
+ */
482
622
  export interface TagResourceOutput {
483
623
  }
624
+ /**
625
+ * @public
626
+ */
484
627
  export interface UntagResourceInput {
485
628
  /**
486
629
  * <p>The Amazon Resource Name (ARN) for the container.</p>
@@ -493,6 +636,9 @@ export interface UntagResourceInput {
493
636
  */
494
637
  TagKeys: string[] | undefined;
495
638
  }
639
+ /**
640
+ * @public
641
+ */
496
642
  export interface UntagResourceOutput {
497
643
  }
498
644
  /**
@@ -1,5 +1,8 @@
1
1
  import { PaginationConfiguration } from "@aws-sdk/types";
2
2
  import { MediaStoreClient } from "../MediaStoreClient";
3
+ /**
4
+ * @public
5
+ */
3
6
  export interface MediaStorePaginationConfiguration extends PaginationConfiguration {
4
7
  client: MediaStoreClient;
5
8
  }
@@ -1,4 +1,7 @@
1
1
  import { Paginator } from "@aws-sdk/types";
2
2
  import { ListContainersCommandInput, ListContainersCommandOutput } from "../commands/ListContainersCommand";
3
3
  import { MediaStorePaginationConfiguration } from "./Interfaces";
4
+ /**
5
+ * @public
6
+ */
4
7
  export declare function paginateListContainers(config: MediaStorePaginationConfiguration, input: ListContainersCommandInput, ...additionalArguments: any): Paginator<ListContainersCommandOutput>;
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@aws-sdk/client-mediastore",
3
3
  "description": "AWS SDK for JavaScript Mediastore Client for Node.js, Browser and React Native",
4
- "version": "3.295.0",
4
+ "version": "3.297.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",
@@ -20,37 +20,37 @@
20
20
  "dependencies": {
21
21
  "@aws-crypto/sha256-browser": "3.0.0",
22
22
  "@aws-crypto/sha256-js": "3.0.0",
23
- "@aws-sdk/client-sts": "3.295.0",
24
- "@aws-sdk/config-resolver": "3.295.0",
25
- "@aws-sdk/credential-provider-node": "3.295.0",
26
- "@aws-sdk/fetch-http-handler": "3.295.0",
27
- "@aws-sdk/hash-node": "3.295.0",
28
- "@aws-sdk/invalid-dependency": "3.295.0",
29
- "@aws-sdk/middleware-content-length": "3.295.0",
30
- "@aws-sdk/middleware-endpoint": "3.295.0",
31
- "@aws-sdk/middleware-host-header": "3.295.0",
32
- "@aws-sdk/middleware-logger": "3.295.0",
33
- "@aws-sdk/middleware-recursion-detection": "3.295.0",
34
- "@aws-sdk/middleware-retry": "3.295.0",
35
- "@aws-sdk/middleware-serde": "3.295.0",
36
- "@aws-sdk/middleware-signing": "3.295.0",
37
- "@aws-sdk/middleware-stack": "3.295.0",
38
- "@aws-sdk/middleware-user-agent": "3.295.0",
39
- "@aws-sdk/node-config-provider": "3.295.0",
40
- "@aws-sdk/node-http-handler": "3.295.0",
41
- "@aws-sdk/protocol-http": "3.295.0",
42
- "@aws-sdk/smithy-client": "3.295.0",
43
- "@aws-sdk/types": "3.295.0",
44
- "@aws-sdk/url-parser": "3.295.0",
23
+ "@aws-sdk/client-sts": "3.297.0",
24
+ "@aws-sdk/config-resolver": "3.296.0",
25
+ "@aws-sdk/credential-provider-node": "3.297.0",
26
+ "@aws-sdk/fetch-http-handler": "3.296.0",
27
+ "@aws-sdk/hash-node": "3.296.0",
28
+ "@aws-sdk/invalid-dependency": "3.296.0",
29
+ "@aws-sdk/middleware-content-length": "3.296.0",
30
+ "@aws-sdk/middleware-endpoint": "3.296.0",
31
+ "@aws-sdk/middleware-host-header": "3.296.0",
32
+ "@aws-sdk/middleware-logger": "3.296.0",
33
+ "@aws-sdk/middleware-recursion-detection": "3.296.0",
34
+ "@aws-sdk/middleware-retry": "3.296.0",
35
+ "@aws-sdk/middleware-serde": "3.296.0",
36
+ "@aws-sdk/middleware-signing": "3.296.0",
37
+ "@aws-sdk/middleware-stack": "3.296.0",
38
+ "@aws-sdk/middleware-user-agent": "3.296.0",
39
+ "@aws-sdk/node-config-provider": "3.296.0",
40
+ "@aws-sdk/node-http-handler": "3.296.0",
41
+ "@aws-sdk/protocol-http": "3.296.0",
42
+ "@aws-sdk/smithy-client": "3.296.0",
43
+ "@aws-sdk/types": "3.296.0",
44
+ "@aws-sdk/url-parser": "3.296.0",
45
45
  "@aws-sdk/util-base64": "3.295.0",
46
46
  "@aws-sdk/util-body-length-browser": "3.295.0",
47
47
  "@aws-sdk/util-body-length-node": "3.295.0",
48
- "@aws-sdk/util-defaults-mode-browser": "3.295.0",
49
- "@aws-sdk/util-defaults-mode-node": "3.295.0",
50
- "@aws-sdk/util-endpoints": "3.295.0",
51
- "@aws-sdk/util-retry": "3.295.0",
52
- "@aws-sdk/util-user-agent-browser": "3.295.0",
53
- "@aws-sdk/util-user-agent-node": "3.295.0",
48
+ "@aws-sdk/util-defaults-mode-browser": "3.296.0",
49
+ "@aws-sdk/util-defaults-mode-node": "3.296.0",
50
+ "@aws-sdk/util-endpoints": "3.296.0",
51
+ "@aws-sdk/util-retry": "3.296.0",
52
+ "@aws-sdk/util-user-agent-browser": "3.296.0",
53
+ "@aws-sdk/util-user-agent-node": "3.296.0",
54
54
  "@aws-sdk/util-utf8": "3.295.0",
55
55
  "tslib": "^2.5.0"
56
56
  },