@aws-sdk/client-ivs 3.281.0 → 3.285.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 (4) hide show
  1. package/dist-types/Ivs.d.ts +2 -3
  2. package/dist-types/commands/DeleteChannelCommand.d.ts +2 -3
  3. package/dist-types/models/models_0.d.ts +37 -34
  4. package/package.json +17 -17
package/dist-types/Ivs.d.ts CHANGED
@@ -402,9 +402,8 @@ export declare class Ivs extends IvsClient {
402
402
  * <p>Deletes the specified channel and its associated stream keys.</p>
403
403
  * <p>If you try to delete a live channel, you will get an error (409 ConflictException). To
404
404
  * delete a channel that is live, call <a>StopStream</a>, wait for the Amazon
405
- * EventBridge "Stream End" event (to verify that the stream's state was changed from Live to
406
- * Offline), then call DeleteChannel. (See <a href="https://docs.aws.amazon.com/ivs/latest/userguide/eventbridge.html"> Using EventBridge with Amazon IVS</a>.)
407
- * </p>
405
+ * EventBridge "Stream End" event (to verify that the stream's state is no longer Live), then
406
+ * call DeleteChannel. (See <a href="https://docs.aws.amazon.com/ivs/latest/userguide/eventbridge.html"> Using EventBridge with Amazon IVS</a>.) </p>
408
407
  */
409
408
  deleteChannel(args: DeleteChannelCommandInput, options?: __HttpHandlerOptions): Promise<DeleteChannelCommandOutput>;
410
409
  deleteChannel(args: DeleteChannelCommandInput, cb: (err: any, data?: DeleteChannelCommandOutput) => void): void;
package/dist-types/commands/DeleteChannelCommand.d.ts CHANGED
@@ -17,9 +17,8 @@ export interface DeleteChannelCommandOutput extends __MetadataBearer {
17
17
  * <p>Deletes the specified channel and its associated stream keys.</p>
18
18
  * <p>If you try to delete a live channel, you will get an error (409 ConflictException). To
19
19
  * delete a channel that is live, call <a>StopStream</a>, wait for the Amazon
20
- * EventBridge "Stream End" event (to verify that the stream's state was changed from Live to
21
- * Offline), then call DeleteChannel. (See <a href="https://docs.aws.amazon.com/ivs/latest/userguide/eventbridge.html"> Using EventBridge with Amazon IVS</a>.)
22
- * </p>
20
+ * EventBridge "Stream End" event (to verify that the stream's state is no longer Live), then
21
+ * call DeleteChannel. (See <a href="https://docs.aws.amazon.com/ivs/latest/userguide/eventbridge.html"> Using EventBridge with Amazon IVS</a>.) </p>
23
22
  * @example
24
23
  * Use a bare-bones client and the command you need to make an API call.
25
24
  * ```javascript
package/dist-types/models/models_0.d.ts CHANGED
@@ -92,10 +92,10 @@ export interface Channel {
92
92
  */
93
93
  authorized?: boolean;
94
94
  /**
95
- * <p>Tags attached to the resource. Array of 1-50 maps, each of the form <code>string:string (key:value)</code>. See <a href="https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html">Tagging Amazon Web Services Resources</a> for
96
- * more information, including restrictions that apply to tags and "Tag naming limits and
97
- * requirements"; Amazon IVS has no service-specific constraints beyond what is documented
98
- * there.</p>
95
+ * <p>Tags attached to the resource. Array of 1-50 maps, each of the form <code>string:string
96
+ * (key:value)</code>. See <a href="https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html">Tagging Amazon Web Services Resources</a> for more information, including restrictions
97
+ * that apply to tags and "Tag naming limits and requirements"; Amazon IVS has no
98
+ * service-specific constraints beyond what is documented there.</p>
99
99
  */
100
100
  tags?: Record<string, string>;
101
101
  }
@@ -149,10 +149,10 @@ export interface StreamKey {
149
149
  */
150
150
  channelArn?: string;
151
151
  /**
152
- * <p>Tags attached to the resource. Array of 1-50 maps, each of the form <code>string:string (key:value)</code>. See <a href="https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html">Tagging Amazon Web Services Resources</a> for
153
- * more information, including restrictions that apply to tags and "Tag naming limits and
154
- * requirements"; Amazon IVS has no service-specific constraints beyond what is documented
155
- * there.</p>
152
+ * <p>Tags attached to the resource. Array of 1-50 maps, each of the form <code>string:string
153
+ * (key:value)</code>. See <a href="https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html">Tagging Amazon Web Services Resources</a> for more information, including restrictions
154
+ * that apply to tags and "Tag naming limits and requirements"; Amazon IVS has no
155
+ * service-specific constraints beyond what is documented there.</p>
156
156
  */
157
157
  tags?: Record<string, string>;
158
158
  }
@@ -405,10 +405,10 @@ export interface RecordingConfiguration {
405
405
  */
406
406
  state: RecordingConfigurationState | string | undefined;
407
407
  /**
408
- * <p>Tags attached to the resource. Array of 1-50 maps, each of the form <code>string:string (key:value)</code>. See <a href="https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html">Tagging Amazon Web Services Resources</a> for
409
- * more information, including restrictions that apply to tags and "Tag naming limits and
410
- * requirements"; Amazon IVS has no service-specific constraints beyond what is documented
411
- * there.</p>
408
+ * <p>Tags attached to the resource. Array of 1-50 maps, each of the form <code>string:string
409
+ * (key:value)</code>. See <a href="https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html">Tagging Amazon Web Services Resources</a> for more information, including restrictions
410
+ * that apply to tags and "Tag naming limits and requirements"; Amazon IVS has no
411
+ * service-specific constraints beyond what is documented there.</p>
412
412
  */
413
413
  tags?: Record<string, string>;
414
414
  /**
@@ -523,10 +523,10 @@ export interface PlaybackKeyPair {
523
523
  */
524
524
  fingerprint?: string;
525
525
  /**
526
- * <p>Tags attached to the resource. Array of 1-50 maps, each of the form <code>string:string (key:value)</code>. See <a href="https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html">Tagging Amazon Web Services Resources</a> for
527
- * more information, including restrictions that apply to tags and "Tag naming limits and
528
- * requirements"; Amazon IVS has no service-specific constraints beyond what is documented
529
- * there.</p>
526
+ * <p>Tags attached to the resource. Array of 1-50 maps, each of the form <code>string:string
527
+ * (key:value)</code>. See <a href="https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html">Tagging Amazon Web Services Resources</a> for more information, including restrictions
528
+ * that apply to tags and "Tag naming limits and requirements"; Amazon IVS has no
529
+ * service-specific constraints beyond what is documented there.</p>
530
530
  */
531
531
  tags?: Record<string, string>;
532
532
  }
@@ -600,7 +600,9 @@ export interface _Stream {
600
600
  */
601
601
  startTime?: Date;
602
602
  /**
603
- * <p>The stream’s state.</p>
603
+ * <p>The stream’s state. Do not rely on the <code>OFFLINE</code> state, as the API may not
604
+ * return it; instead, a "NotBroadcasting" error will indicate that the stream is not
605
+ * live.</p>
604
606
  */
605
607
  state?: StreamState | string;
606
608
  /**
@@ -859,10 +861,10 @@ export interface ChannelSummary {
859
861
  */
860
862
  recordingConfigurationArn?: string;
861
863
  /**
862
- * <p>Tags attached to the resource. Array of 1-50 maps, each of the form <code>string:string (key:value)</code>. See <a href="https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html">Tagging Amazon Web Services Resources</a> for
863
- * more information, including restrictions that apply to tags and "Tag naming limits and
864
- * requirements"; Amazon IVS has no service-specific constraints beyond what is documented
865
- * there.</p>
864
+ * <p>Tags attached to the resource. Array of 1-50 maps, each of the form <code>string:string
865
+ * (key:value)</code>. See <a href="https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html">Tagging Amazon Web Services Resources</a> for more information, including restrictions
866
+ * that apply to tags and "Tag naming limits and requirements"; Amazon IVS has no
867
+ * service-specific constraints beyond what is documented there.</p>
866
868
  */
867
869
  tags?: Record<string, string>;
868
870
  }
@@ -902,10 +904,10 @@ export interface PlaybackKeyPairSummary {
902
904
  */
903
905
  name?: string;
904
906
  /**
905
- * <p>Tags attached to the resource. Array of 1-50 maps, each of the form <code>string:string (key:value)</code>. See <a href="https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html">Tagging Amazon Web Services Resources</a> for
906
- * more information, including restrictions that apply to tags and "Tag naming limits and
907
- * requirements"; Amazon IVS has no service-specific constraints beyond what is documented
908
- * there.</p>
907
+ * <p>Tags attached to the resource. Array of 1-50 maps, each of the form <code>string:string
908
+ * (key:value)</code>. See <a href="https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html">Tagging Amazon Web Services Resources</a> for more information, including restrictions
909
+ * that apply to tags and "Tag naming limits and requirements"; Amazon IVS has no
910
+ * service-specific constraints beyond what is documented there.</p>
909
911
  */
910
912
  tags?: Record<string, string>;
911
913
  }
@@ -954,10 +956,10 @@ export interface RecordingConfigurationSummary {
954
956
  */
955
957
  state: RecordingConfigurationState | string | undefined;
956
958
  /**
957
- * <p>Tags attached to the resource. Array of 1-50 maps, each of the form <code>string:string (key:value)</code>. See <a href="https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html">Tagging Amazon Web Services Resources</a> for
958
- * more information, including restrictions that apply to tags and "Tag naming limits and
959
- * requirements"; Amazon IVS has no service-specific constraints beyond what is documented
960
- * there.</p>
959
+ * <p>Tags attached to the resource. Array of 1-50 maps, each of the form <code>string:string
960
+ * (key:value)</code>. See <a href="https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html">Tagging Amazon Web Services Resources</a> for more information, including restrictions
961
+ * that apply to tags and "Tag naming limits and requirements"; Amazon IVS has no
962
+ * service-specific constraints beyond what is documented there.</p>
961
963
  */
962
964
  tags?: Record<string, string>;
963
965
  }
@@ -1000,10 +1002,10 @@ export interface StreamKeySummary {
1000
1002
  */
1001
1003
  channelArn?: string;
1002
1004
  /**
1003
- * <p>Tags attached to the resource. Array of 1-50 maps, each of the form <code>string:string (key:value)</code>. See <a href="https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html">Tagging Amazon Web Services Resources</a> for
1004
- * more information, including restrictions that apply to tags and "Tag naming limits and
1005
- * requirements"; Amazon IVS has no service-specific constraints beyond what is documented
1006
- * there.</p>
1005
+ * <p>Tags attached to the resource. Array of 1-50 maps, each of the form <code>string:string
1006
+ * (key:value)</code>. See <a href="https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html">Tagging Amazon Web Services Resources</a> for more information, including restrictions
1007
+ * that apply to tags and "Tag naming limits and requirements"; Amazon IVS has no
1008
+ * service-specific constraints beyond what is documented there.</p>
1007
1009
  */
1008
1010
  tags?: Record<string, string>;
1009
1011
  }
@@ -1055,7 +1057,8 @@ export interface StreamSummary {
1055
1057
  */
1056
1058
  streamId?: string;
1057
1059
  /**
1058
- * <p>The stream’s state.</p>
1060
+ * <p>The stream’s state. Do not rely on the <code>OFFLINE</code> state, as the API may not return it;
1061
+ * instead, a "NotBroadcasting" error will indicate that the stream is not live.</p>
1059
1062
  */
1060
1063
  state?: StreamState | string;
1061
1064
  /**
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@aws-sdk/client-ivs",
3
3
  "description": "AWS SDK for JavaScript Ivs Client for Node.js, Browser and React Native",
4
- "version": "3.281.0",
4
+ "version": "3.285.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,25 +20,25 @@
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.281.0",
24
- "@aws-sdk/config-resolver": "3.272.0",
25
- "@aws-sdk/credential-provider-node": "3.281.0",
26
- "@aws-sdk/fetch-http-handler": "3.272.0",
23
+ "@aws-sdk/client-sts": "3.282.0",
24
+ "@aws-sdk/config-resolver": "3.282.0",
25
+ "@aws-sdk/credential-provider-node": "3.282.0",
26
+ "@aws-sdk/fetch-http-handler": "3.282.0",
27
27
  "@aws-sdk/hash-node": "3.272.0",
28
28
  "@aws-sdk/invalid-dependency": "3.272.0",
29
- "@aws-sdk/middleware-content-length": "3.272.0",
30
- "@aws-sdk/middleware-endpoint": "3.272.0",
31
- "@aws-sdk/middleware-host-header": "3.278.0",
29
+ "@aws-sdk/middleware-content-length": "3.282.0",
30
+ "@aws-sdk/middleware-endpoint": "3.282.0",
31
+ "@aws-sdk/middleware-host-header": "3.282.0",
32
32
  "@aws-sdk/middleware-logger": "3.272.0",
33
- "@aws-sdk/middleware-recursion-detection": "3.272.0",
34
- "@aws-sdk/middleware-retry": "3.272.0",
33
+ "@aws-sdk/middleware-recursion-detection": "3.282.0",
34
+ "@aws-sdk/middleware-retry": "3.282.0",
35
35
  "@aws-sdk/middleware-serde": "3.272.0",
36
- "@aws-sdk/middleware-signing": "3.272.0",
36
+ "@aws-sdk/middleware-signing": "3.282.0",
37
37
  "@aws-sdk/middleware-stack": "3.272.0",
38
- "@aws-sdk/middleware-user-agent": "3.272.0",
38
+ "@aws-sdk/middleware-user-agent": "3.282.0",
39
39
  "@aws-sdk/node-config-provider": "3.272.0",
40
- "@aws-sdk/node-http-handler": "3.272.0",
41
- "@aws-sdk/protocol-http": "3.272.0",
40
+ "@aws-sdk/node-http-handler": "3.282.0",
41
+ "@aws-sdk/protocol-http": "3.282.0",
42
42
  "@aws-sdk/smithy-client": "3.279.0",
43
43
  "@aws-sdk/types": "3.272.0",
44
44
  "@aws-sdk/url-parser": "3.272.0",
@@ -46,11 +46,11 @@
46
46
  "@aws-sdk/util-body-length-browser": "3.188.0",
47
47
  "@aws-sdk/util-body-length-node": "3.208.0",
48
48
  "@aws-sdk/util-defaults-mode-browser": "3.279.0",
49
- "@aws-sdk/util-defaults-mode-node": "3.279.0",
49
+ "@aws-sdk/util-defaults-mode-node": "3.282.0",
50
50
  "@aws-sdk/util-endpoints": "3.272.0",
51
51
  "@aws-sdk/util-retry": "3.272.0",
52
- "@aws-sdk/util-user-agent-browser": "3.272.0",
53
- "@aws-sdk/util-user-agent-node": "3.272.0",
52
+ "@aws-sdk/util-user-agent-browser": "3.282.0",
53
+ "@aws-sdk/util-user-agent-node": "3.282.0",
54
54
  "@aws-sdk/util-utf8": "3.254.0",
55
55
  "tslib": "^2.3.1"
56
56
  },