@aws-sdk/client-ivs-realtime 3.1135.0 → 3.1136.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/README.md +1 -78
- package/dist-cjs/index.js +5 -5
- package/dist-es/schemas/schemas_0.js +4 -4
- package/dist-types/IVSRealTime.d.ts +1 -78
- package/dist-types/IVSRealTimeClient.d.ts +1 -78
- package/dist-types/commands/CreateEncoderConfigurationCommand.d.ts +7 -7
- package/dist-types/commands/CreateIngestConfigurationCommand.d.ts +11 -4
- package/dist-types/commands/CreateParticipantTokenCommand.d.ts +6 -10
- package/dist-types/commands/CreateStageCommand.d.ts +4 -4
- package/dist-types/commands/CreateStorageConfigurationCommand.d.ts +8 -10
- package/dist-types/commands/DeleteEncoderConfigurationCommand.d.ts +7 -8
- package/dist-types/commands/DeleteIngestConfigurationCommand.d.ts +5 -5
- package/dist-types/commands/DeletePublicKeyCommand.d.ts +6 -8
- package/dist-types/commands/DeleteStageCommand.d.ts +6 -8
- package/dist-types/commands/DeleteStorageConfigurationCommand.d.ts +7 -10
- package/dist-types/commands/DisconnectParticipantCommand.d.ts +5 -7
- package/dist-types/commands/GetCompositionCommand.d.ts +6 -6
- package/dist-types/commands/GetEncoderConfigurationCommand.d.ts +6 -6
- package/dist-types/commands/GetIngestConfigurationCommand.d.ts +3 -3
- package/dist-types/commands/GetParticipantCommand.d.ts +3 -3
- package/dist-types/commands/GetPublicKeyCommand.d.ts +3 -3
- package/dist-types/commands/GetStageCommand.d.ts +3 -3
- package/dist-types/commands/GetStageSessionCommand.d.ts +3 -3
- package/dist-types/commands/GetStorageConfigurationCommand.d.ts +6 -6
- package/dist-types/commands/ImportPublicKeyCommand.d.ts +5 -5
- package/dist-types/commands/ListCompositionsCommand.d.ts +6 -7
- package/dist-types/commands/ListEncoderConfigurationsCommand.d.ts +6 -7
- package/dist-types/commands/ListIngestConfigurationsCommand.d.ts +2 -2
- package/dist-types/commands/ListParticipantEventsCommand.d.ts +3 -4
- package/dist-types/commands/ListParticipantReplicasCommand.d.ts +2 -2
- package/dist-types/commands/ListParticipantsCommand.d.ts +2 -2
- package/dist-types/commands/ListPublicKeysCommand.d.ts +2 -2
- package/dist-types/commands/ListStageSessionsCommand.d.ts +2 -2
- package/dist-types/commands/ListStagesCommand.d.ts +4 -5
- package/dist-types/commands/ListStorageConfigurationsCommand.d.ts +6 -7
- package/dist-types/commands/ListTagsForResourceCommand.d.ts +3 -3
- package/dist-types/commands/StartCompositionCommand.d.ts +8 -31
- package/dist-types/commands/StartParticipantReplicationCommand.d.ts +7 -7
- package/dist-types/commands/StopCompositionCommand.d.ts +7 -8
- package/dist-types/commands/StopParticipantReplicationCommand.d.ts +4 -4
- package/dist-types/commands/TagResourceCommand.d.ts +3 -3
- package/dist-types/commands/UntagResourceCommand.d.ts +3 -3
- package/dist-types/commands/UpdateIngestConfigurationCommand.d.ts +12 -5
- package/dist-types/commands/UpdateStageCommand.d.ts +6 -6
- package/dist-types/index.d.ts +1 -78
- package/dist-types/models/errors.d.ts +7 -7
- package/dist-types/models/models_0.d.ts +210 -533
- package/dist-types/ts3.4/models/models_0.d.ts +14 -0
- package/package.json +1 -1
|
@@ -24,9 +24,7 @@ declare const DeleteStageCommand_base: {
|
|
|
24
24
|
getEndpointParameterInstructions(): import("@smithy/types").EndpointParameterInstructions;
|
|
25
25
|
};
|
|
26
26
|
/**
|
|
27
|
-
* <p>Shuts down and deletes the specified stage (disconnecting all participants). This operation also
|
|
28
|
-
* removes the <code>stageArn</code> from the associated <a>IngestConfiguration</a>, if there are participants
|
|
29
|
-
* using the IngestConfiguration to publish to the stage.</p>
|
|
27
|
+
* <p>Shuts down and deletes the specified stage (disconnecting all participants). This operation also removes the <code>stageArn</code> from the associated <a>IngestConfiguration</a>, if there are participants using the IngestConfiguration to publish to the stage.</p>
|
|
30
28
|
* @example
|
|
31
29
|
* Use a bare-bones client and the command you need to make an API call.
|
|
32
30
|
* ```javascript
|
|
@@ -51,19 +49,19 @@ declare const DeleteStageCommand_base: {
|
|
|
51
49
|
* @see {@link IVSRealTimeClientResolvedConfig | config} for IVSRealTimeClient's `config` shape.
|
|
52
50
|
*
|
|
53
51
|
* @throws {@link AccessDeniedException} (client fault)
|
|
54
|
-
* <p
|
|
52
|
+
* <p>User does not have sufficient access to perform this action.</p>
|
|
55
53
|
*
|
|
56
54
|
* @throws {@link ConflictException} (client fault)
|
|
57
|
-
* <p
|
|
55
|
+
* <p>Updating or deleting a resource can cause an inconsistent state.</p>
|
|
58
56
|
*
|
|
59
57
|
* @throws {@link PendingVerification} (client fault)
|
|
60
|
-
* <p
|
|
58
|
+
* <p>Your account is pending verification.</p>
|
|
61
59
|
*
|
|
62
60
|
* @throws {@link ResourceNotFoundException} (client fault)
|
|
63
|
-
* <p
|
|
61
|
+
* <p>Request references a resource which does not exist.</p>
|
|
64
62
|
*
|
|
65
63
|
* @throws {@link ValidationException} (client fault)
|
|
66
|
-
* <p
|
|
64
|
+
* <p>The input fails to satisfy the constraints specified by an Amazon Web Services service.</p>
|
|
67
65
|
*
|
|
68
66
|
* @throws {@link IVSRealTimeServiceException}
|
|
69
67
|
* <p>Base exception class for all service exceptions from IVSRealTime service.</p>
|
|
@@ -24,10 +24,7 @@ declare const DeleteStorageConfigurationCommand_base: {
|
|
|
24
24
|
getEndpointParameterInstructions(): import("@smithy/types").EndpointParameterInstructions;
|
|
25
25
|
};
|
|
26
26
|
/**
|
|
27
|
-
* <p>Deletes the storage configuration for the specified ARN.</p>
|
|
28
|
-
* <p>If you try to delete a storage configuration that is used by a Composition, you will get an error (409 ConflictException).
|
|
29
|
-
* To avoid this, for all Compositions that reference the storage configuration, first use <a>StopComposition</a> and wait for it to complete,
|
|
30
|
-
* then use DeleteStorageConfiguration.</p>
|
|
27
|
+
* <p>Deletes the storage configuration for the specified ARN.</p> <p>If you try to delete a storage configuration that is used by a Composition, you will get an error (409 ConflictException). To avoid this, for all Compositions that reference the storage configuration, first use <a>StopComposition</a> and wait for it to complete, then use DeleteStorageConfiguration.</p>
|
|
31
28
|
* @example
|
|
32
29
|
* Use a bare-bones client and the command you need to make an API call.
|
|
33
30
|
* ```javascript
|
|
@@ -52,22 +49,22 @@ declare const DeleteStorageConfigurationCommand_base: {
|
|
|
52
49
|
* @see {@link IVSRealTimeClientResolvedConfig | config} for IVSRealTimeClient's `config` shape.
|
|
53
50
|
*
|
|
54
51
|
* @throws {@link AccessDeniedException} (client fault)
|
|
55
|
-
* <p
|
|
52
|
+
* <p>User does not have sufficient access to perform this action.</p>
|
|
56
53
|
*
|
|
57
54
|
* @throws {@link ConflictException} (client fault)
|
|
58
|
-
* <p
|
|
55
|
+
* <p>Updating or deleting a resource can cause an inconsistent state.</p>
|
|
59
56
|
*
|
|
60
57
|
* @throws {@link InternalServerException} (server fault)
|
|
61
|
-
* <p
|
|
58
|
+
* <p>Unexpected error during processing of request.</p>
|
|
62
59
|
*
|
|
63
60
|
* @throws {@link ResourceNotFoundException} (client fault)
|
|
64
|
-
* <p
|
|
61
|
+
* <p>Request references a resource which does not exist.</p>
|
|
65
62
|
*
|
|
66
63
|
* @throws {@link ServiceQuotaExceededException} (client fault)
|
|
67
|
-
* <p
|
|
64
|
+
* <p>Request would cause a service quota to be exceeded.</p>
|
|
68
65
|
*
|
|
69
66
|
* @throws {@link ValidationException} (client fault)
|
|
70
|
-
* <p
|
|
67
|
+
* <p>The input fails to satisfy the constraints specified by an Amazon Web Services service.</p>
|
|
71
68
|
*
|
|
72
69
|
* @throws {@link IVSRealTimeServiceException}
|
|
73
70
|
* <p>Base exception class for all service exceptions from IVSRealTime service.</p>
|
|
@@ -24,9 +24,7 @@ declare const DisconnectParticipantCommand_base: {
|
|
|
24
24
|
getEndpointParameterInstructions(): import("@smithy/types").EndpointParameterInstructions;
|
|
25
25
|
};
|
|
26
26
|
/**
|
|
27
|
-
* <p>Disconnects a specified participant from a specified stage. If the participant is publishing using
|
|
28
|
-
* an <a>IngestConfiguration</a>, DisconnectParticipant also updates the <code>stageArn</code>
|
|
29
|
-
* in the IngestConfiguration to be an empty string.</p>
|
|
27
|
+
* <p>Disconnects a specified participant from a specified stage. If the participant is publishing using an <a>IngestConfiguration</a>, DisconnectParticipant also updates the <code>stageArn</code> in the IngestConfiguration to be an empty string.</p>
|
|
30
28
|
* @example
|
|
31
29
|
* Use a bare-bones client and the command you need to make an API call.
|
|
32
30
|
* ```javascript
|
|
@@ -53,16 +51,16 @@ declare const DisconnectParticipantCommand_base: {
|
|
|
53
51
|
* @see {@link IVSRealTimeClientResolvedConfig | config} for IVSRealTimeClient's `config` shape.
|
|
54
52
|
*
|
|
55
53
|
* @throws {@link AccessDeniedException} (client fault)
|
|
56
|
-
* <p
|
|
54
|
+
* <p>User does not have sufficient access to perform this action.</p>
|
|
57
55
|
*
|
|
58
56
|
* @throws {@link PendingVerification} (client fault)
|
|
59
|
-
* <p
|
|
57
|
+
* <p>Your account is pending verification.</p>
|
|
60
58
|
*
|
|
61
59
|
* @throws {@link ResourceNotFoundException} (client fault)
|
|
62
|
-
* <p
|
|
60
|
+
* <p>Request references a resource which does not exist.</p>
|
|
63
61
|
*
|
|
64
62
|
* @throws {@link ValidationException} (client fault)
|
|
65
|
-
* <p
|
|
63
|
+
* <p>The input fails to satisfy the constraints specified by an Amazon Web Services service.</p>
|
|
66
64
|
*
|
|
67
65
|
* @throws {@link IVSRealTimeServiceException}
|
|
68
66
|
* <p>Base exception class for all service exceptions from IVSRealTime service.</p>
|
|
@@ -123,22 +123,22 @@ declare const GetCompositionCommand_base: {
|
|
|
123
123
|
* @see {@link IVSRealTimeClientResolvedConfig | config} for IVSRealTimeClient's `config` shape.
|
|
124
124
|
*
|
|
125
125
|
* @throws {@link AccessDeniedException} (client fault)
|
|
126
|
-
* <p
|
|
126
|
+
* <p>User does not have sufficient access to perform this action.</p>
|
|
127
127
|
*
|
|
128
128
|
* @throws {@link ConflictException} (client fault)
|
|
129
|
-
* <p
|
|
129
|
+
* <p>Updating or deleting a resource can cause an inconsistent state.</p>
|
|
130
130
|
*
|
|
131
131
|
* @throws {@link InternalServerException} (server fault)
|
|
132
|
-
* <p
|
|
132
|
+
* <p>Unexpected error during processing of request.</p>
|
|
133
133
|
*
|
|
134
134
|
* @throws {@link ResourceNotFoundException} (client fault)
|
|
135
|
-
* <p
|
|
135
|
+
* <p>Request references a resource which does not exist.</p>
|
|
136
136
|
*
|
|
137
137
|
* @throws {@link ServiceQuotaExceededException} (client fault)
|
|
138
|
-
* <p
|
|
138
|
+
* <p>Request would cause a service quota to be exceeded.</p>
|
|
139
139
|
*
|
|
140
140
|
* @throws {@link ValidationException} (client fault)
|
|
141
|
-
* <p
|
|
141
|
+
* <p>The input fails to satisfy the constraints specified by an Amazon Web Services service.</p>
|
|
142
142
|
*
|
|
143
143
|
* @throws {@link IVSRealTimeServiceException}
|
|
144
144
|
* <p>Base exception class for all service exceptions from IVSRealTime service.</p>
|
|
@@ -63,22 +63,22 @@ declare const GetEncoderConfigurationCommand_base: {
|
|
|
63
63
|
* @see {@link IVSRealTimeClientResolvedConfig | config} for IVSRealTimeClient's `config` shape.
|
|
64
64
|
*
|
|
65
65
|
* @throws {@link AccessDeniedException} (client fault)
|
|
66
|
-
* <p
|
|
66
|
+
* <p>User does not have sufficient access to perform this action.</p>
|
|
67
67
|
*
|
|
68
68
|
* @throws {@link ConflictException} (client fault)
|
|
69
|
-
* <p
|
|
69
|
+
* <p>Updating or deleting a resource can cause an inconsistent state.</p>
|
|
70
70
|
*
|
|
71
71
|
* @throws {@link InternalServerException} (server fault)
|
|
72
|
-
* <p
|
|
72
|
+
* <p>Unexpected error during processing of request.</p>
|
|
73
73
|
*
|
|
74
74
|
* @throws {@link ResourceNotFoundException} (client fault)
|
|
75
|
-
* <p
|
|
75
|
+
* <p>Request references a resource which does not exist.</p>
|
|
76
76
|
*
|
|
77
77
|
* @throws {@link ServiceQuotaExceededException} (client fault)
|
|
78
|
-
* <p
|
|
78
|
+
* <p>Request would cause a service quota to be exceeded.</p>
|
|
79
79
|
*
|
|
80
80
|
* @throws {@link ValidationException} (client fault)
|
|
81
|
-
* <p
|
|
81
|
+
* <p>The input fails to satisfy the constraints specified by an Amazon Web Services service.</p>
|
|
82
82
|
*
|
|
83
83
|
* @throws {@link IVSRealTimeServiceException}
|
|
84
84
|
* <p>Base exception class for all service exceptions from IVSRealTime service.</p>
|
|
@@ -73,13 +73,13 @@ declare const GetIngestConfigurationCommand_base: {
|
|
|
73
73
|
* @see {@link IVSRealTimeClientResolvedConfig | config} for IVSRealTimeClient's `config` shape.
|
|
74
74
|
*
|
|
75
75
|
* @throws {@link AccessDeniedException} (client fault)
|
|
76
|
-
* <p
|
|
76
|
+
* <p>User does not have sufficient access to perform this action.</p>
|
|
77
77
|
*
|
|
78
78
|
* @throws {@link ResourceNotFoundException} (client fault)
|
|
79
|
-
* <p
|
|
79
|
+
* <p>Request references a resource which does not exist.</p>
|
|
80
80
|
*
|
|
81
81
|
* @throws {@link ValidationException} (client fault)
|
|
82
|
-
* <p
|
|
82
|
+
* <p>The input fails to satisfy the constraints specified by an Amazon Web Services service.</p>
|
|
83
83
|
*
|
|
84
84
|
* @throws {@link IVSRealTimeServiceException}
|
|
85
85
|
* <p>Base exception class for all service exceptions from IVSRealTime service.</p>
|
|
@@ -78,13 +78,13 @@ declare const GetParticipantCommand_base: {
|
|
|
78
78
|
* @see {@link IVSRealTimeClientResolvedConfig | config} for IVSRealTimeClient's `config` shape.
|
|
79
79
|
*
|
|
80
80
|
* @throws {@link AccessDeniedException} (client fault)
|
|
81
|
-
* <p
|
|
81
|
+
* <p>User does not have sufficient access to perform this action.</p>
|
|
82
82
|
*
|
|
83
83
|
* @throws {@link ResourceNotFoundException} (client fault)
|
|
84
|
-
* <p
|
|
84
|
+
* <p>Request references a resource which does not exist.</p>
|
|
85
85
|
*
|
|
86
86
|
* @throws {@link ValidationException} (client fault)
|
|
87
|
-
* <p
|
|
87
|
+
* <p>The input fails to satisfy the constraints specified by an Amazon Web Services service.</p>
|
|
88
88
|
*
|
|
89
89
|
* @throws {@link IVSRealTimeServiceException}
|
|
90
90
|
* <p>Base exception class for all service exceptions from IVSRealTime service.</p>
|
|
@@ -59,13 +59,13 @@ declare const GetPublicKeyCommand_base: {
|
|
|
59
59
|
* @see {@link IVSRealTimeClientResolvedConfig | config} for IVSRealTimeClient's `config` shape.
|
|
60
60
|
*
|
|
61
61
|
* @throws {@link AccessDeniedException} (client fault)
|
|
62
|
-
* <p
|
|
62
|
+
* <p>User does not have sufficient access to perform this action.</p>
|
|
63
63
|
*
|
|
64
64
|
* @throws {@link ResourceNotFoundException} (client fault)
|
|
65
|
-
* <p
|
|
65
|
+
* <p>Request references a resource which does not exist.</p>
|
|
66
66
|
*
|
|
67
67
|
* @throws {@link ValidationException} (client fault)
|
|
68
|
-
* <p
|
|
68
|
+
* <p>The input fails to satisfy the constraints specified by an Amazon Web Services service.</p>
|
|
69
69
|
*
|
|
70
70
|
* @throws {@link IVSRealTimeServiceException}
|
|
71
71
|
* <p>Base exception class for all service exceptions from IVSRealTime service.</p>
|
|
@@ -82,13 +82,13 @@ declare const GetStageCommand_base: {
|
|
|
82
82
|
* @see {@link IVSRealTimeClientResolvedConfig | config} for IVSRealTimeClient's `config` shape.
|
|
83
83
|
*
|
|
84
84
|
* @throws {@link AccessDeniedException} (client fault)
|
|
85
|
-
* <p
|
|
85
|
+
* <p>User does not have sufficient access to perform this action.</p>
|
|
86
86
|
*
|
|
87
87
|
* @throws {@link ResourceNotFoundException} (client fault)
|
|
88
|
-
* <p
|
|
88
|
+
* <p>Request references a resource which does not exist.</p>
|
|
89
89
|
*
|
|
90
90
|
* @throws {@link ValidationException} (client fault)
|
|
91
|
-
* <p
|
|
91
|
+
* <p>The input fails to satisfy the constraints specified by an Amazon Web Services service.</p>
|
|
92
92
|
*
|
|
93
93
|
* @throws {@link IVSRealTimeServiceException}
|
|
94
94
|
* <p>Base exception class for all service exceptions from IVSRealTime service.</p>
|
|
@@ -56,13 +56,13 @@ declare const GetStageSessionCommand_base: {
|
|
|
56
56
|
* @see {@link IVSRealTimeClientResolvedConfig | config} for IVSRealTimeClient's `config` shape.
|
|
57
57
|
*
|
|
58
58
|
* @throws {@link AccessDeniedException} (client fault)
|
|
59
|
-
* <p
|
|
59
|
+
* <p>User does not have sufficient access to perform this action.</p>
|
|
60
60
|
*
|
|
61
61
|
* @throws {@link ResourceNotFoundException} (client fault)
|
|
62
|
-
* <p
|
|
62
|
+
* <p>Request references a resource which does not exist.</p>
|
|
63
63
|
*
|
|
64
64
|
* @throws {@link ValidationException} (client fault)
|
|
65
|
-
* <p
|
|
65
|
+
* <p>The input fails to satisfy the constraints specified by an Amazon Web Services service.</p>
|
|
66
66
|
*
|
|
67
67
|
* @throws {@link IVSRealTimeServiceException}
|
|
68
68
|
* <p>Base exception class for all service exceptions from IVSRealTime service.</p>
|
|
@@ -60,22 +60,22 @@ declare const GetStorageConfigurationCommand_base: {
|
|
|
60
60
|
* @see {@link IVSRealTimeClientResolvedConfig | config} for IVSRealTimeClient's `config` shape.
|
|
61
61
|
*
|
|
62
62
|
* @throws {@link AccessDeniedException} (client fault)
|
|
63
|
-
* <p
|
|
63
|
+
* <p>User does not have sufficient access to perform this action.</p>
|
|
64
64
|
*
|
|
65
65
|
* @throws {@link ConflictException} (client fault)
|
|
66
|
-
* <p
|
|
66
|
+
* <p>Updating or deleting a resource can cause an inconsistent state.</p>
|
|
67
67
|
*
|
|
68
68
|
* @throws {@link InternalServerException} (server fault)
|
|
69
|
-
* <p
|
|
69
|
+
* <p>Unexpected error during processing of request.</p>
|
|
70
70
|
*
|
|
71
71
|
* @throws {@link ResourceNotFoundException} (client fault)
|
|
72
|
-
* <p
|
|
72
|
+
* <p>Request references a resource which does not exist.</p>
|
|
73
73
|
*
|
|
74
74
|
* @throws {@link ServiceQuotaExceededException} (client fault)
|
|
75
|
-
* <p
|
|
75
|
+
* <p>Request would cause a service quota to be exceeded.</p>
|
|
76
76
|
*
|
|
77
77
|
* @throws {@link ValidationException} (client fault)
|
|
78
|
-
* <p
|
|
78
|
+
* <p>The input fails to satisfy the constraints specified by an Amazon Web Services service.</p>
|
|
79
79
|
*
|
|
80
80
|
* @throws {@link IVSRealTimeServiceException}
|
|
81
81
|
* <p>Base exception class for all service exceptions from IVSRealTime service.</p>
|
|
@@ -63,19 +63,19 @@ declare const ImportPublicKeyCommand_base: {
|
|
|
63
63
|
* @see {@link IVSRealTimeClientResolvedConfig | config} for IVSRealTimeClient's `config` shape.
|
|
64
64
|
*
|
|
65
65
|
* @throws {@link AccessDeniedException} (client fault)
|
|
66
|
-
* <p
|
|
66
|
+
* <p>User does not have sufficient access to perform this action.</p>
|
|
67
67
|
*
|
|
68
68
|
* @throws {@link ConflictException} (client fault)
|
|
69
|
-
* <p
|
|
69
|
+
* <p>Updating or deleting a resource can cause an inconsistent state.</p>
|
|
70
70
|
*
|
|
71
71
|
* @throws {@link PendingVerification} (client fault)
|
|
72
|
-
* <p
|
|
72
|
+
* <p>Your account is pending verification.</p>
|
|
73
73
|
*
|
|
74
74
|
* @throws {@link ServiceQuotaExceededException} (client fault)
|
|
75
|
-
* <p
|
|
75
|
+
* <p>Request would cause a service quota to be exceeded.</p>
|
|
76
76
|
*
|
|
77
77
|
* @throws {@link ValidationException} (client fault)
|
|
78
|
-
* <p
|
|
78
|
+
* <p>The input fails to satisfy the constraints specified by an Amazon Web Services service.</p>
|
|
79
79
|
*
|
|
80
80
|
* @throws {@link IVSRealTimeServiceException}
|
|
81
81
|
* <p>Base exception class for all service exceptions from IVSRealTime service.</p>
|
|
@@ -24,8 +24,7 @@ declare const ListCompositionsCommand_base: {
|
|
|
24
24
|
getEndpointParameterInstructions(): import("@smithy/types").EndpointParameterInstructions;
|
|
25
25
|
};
|
|
26
26
|
/**
|
|
27
|
-
* <p>Gets summary information about all Compositions in your account, in the AWS region
|
|
28
|
-
* where the API request is processed. </p>
|
|
27
|
+
* <p>Gets summary information about all Compositions in your account, in the AWS region where the API request is processed. </p>
|
|
29
28
|
* @example
|
|
30
29
|
* Use a bare-bones client and the command you need to make an API call.
|
|
31
30
|
* ```javascript
|
|
@@ -75,19 +74,19 @@ declare const ListCompositionsCommand_base: {
|
|
|
75
74
|
* @see {@link IVSRealTimeClientResolvedConfig | config} for IVSRealTimeClient's `config` shape.
|
|
76
75
|
*
|
|
77
76
|
* @throws {@link AccessDeniedException} (client fault)
|
|
78
|
-
* <p
|
|
77
|
+
* <p>User does not have sufficient access to perform this action.</p>
|
|
79
78
|
*
|
|
80
79
|
* @throws {@link ConflictException} (client fault)
|
|
81
|
-
* <p
|
|
80
|
+
* <p>Updating or deleting a resource can cause an inconsistent state.</p>
|
|
82
81
|
*
|
|
83
82
|
* @throws {@link InternalServerException} (server fault)
|
|
84
|
-
* <p
|
|
83
|
+
* <p>Unexpected error during processing of request.</p>
|
|
85
84
|
*
|
|
86
85
|
* @throws {@link ServiceQuotaExceededException} (client fault)
|
|
87
|
-
* <p
|
|
86
|
+
* <p>Request would cause a service quota to be exceeded.</p>
|
|
88
87
|
*
|
|
89
88
|
* @throws {@link ValidationException} (client fault)
|
|
90
|
-
* <p
|
|
89
|
+
* <p>The input fails to satisfy the constraints specified by an Amazon Web Services service.</p>
|
|
91
90
|
*
|
|
92
91
|
* @throws {@link IVSRealTimeServiceException}
|
|
93
92
|
* <p>Base exception class for all service exceptions from IVSRealTime service.</p>
|
|
@@ -24,8 +24,7 @@ declare const ListEncoderConfigurationsCommand_base: {
|
|
|
24
24
|
getEndpointParameterInstructions(): import("@smithy/types").EndpointParameterInstructions;
|
|
25
25
|
};
|
|
26
26
|
/**
|
|
27
|
-
* <p>Gets summary information about all EncoderConfigurations in your account, in the AWS
|
|
28
|
-
* region where the API request is processed.</p>
|
|
27
|
+
* <p>Gets summary information about all EncoderConfigurations in your account, in the AWS region where the API request is processed.</p>
|
|
29
28
|
* @example
|
|
30
29
|
* Use a bare-bones client and the command you need to make an API call.
|
|
31
30
|
* ```javascript
|
|
@@ -62,19 +61,19 @@ declare const ListEncoderConfigurationsCommand_base: {
|
|
|
62
61
|
* @see {@link IVSRealTimeClientResolvedConfig | config} for IVSRealTimeClient's `config` shape.
|
|
63
62
|
*
|
|
64
63
|
* @throws {@link AccessDeniedException} (client fault)
|
|
65
|
-
* <p
|
|
64
|
+
* <p>User does not have sufficient access to perform this action.</p>
|
|
66
65
|
*
|
|
67
66
|
* @throws {@link ConflictException} (client fault)
|
|
68
|
-
* <p
|
|
67
|
+
* <p>Updating or deleting a resource can cause an inconsistent state.</p>
|
|
69
68
|
*
|
|
70
69
|
* @throws {@link InternalServerException} (server fault)
|
|
71
|
-
* <p
|
|
70
|
+
* <p>Unexpected error during processing of request.</p>
|
|
72
71
|
*
|
|
73
72
|
* @throws {@link ServiceQuotaExceededException} (client fault)
|
|
74
|
-
* <p
|
|
73
|
+
* <p>Request would cause a service quota to be exceeded.</p>
|
|
75
74
|
*
|
|
76
75
|
* @throws {@link ValidationException} (client fault)
|
|
77
|
-
* <p
|
|
76
|
+
* <p>The input fails to satisfy the constraints specified by an Amazon Web Services service.</p>
|
|
78
77
|
*
|
|
79
78
|
* @throws {@link IVSRealTimeServiceException}
|
|
80
79
|
* <p>Base exception class for all service exceptions from IVSRealTime service.</p>
|
|
@@ -66,10 +66,10 @@ declare const ListIngestConfigurationsCommand_base: {
|
|
|
66
66
|
* @see {@link IVSRealTimeClientResolvedConfig | config} for IVSRealTimeClient's `config` shape.
|
|
67
67
|
*
|
|
68
68
|
* @throws {@link AccessDeniedException} (client fault)
|
|
69
|
-
* <p
|
|
69
|
+
* <p>User does not have sufficient access to perform this action.</p>
|
|
70
70
|
*
|
|
71
71
|
* @throws {@link ValidationException} (client fault)
|
|
72
|
-
* <p
|
|
72
|
+
* <p>The input fails to satisfy the constraints specified by an Amazon Web Services service.</p>
|
|
73
73
|
*
|
|
74
74
|
* @throws {@link IVSRealTimeServiceException}
|
|
75
75
|
* <p>Base exception class for all service exceptions from IVSRealTime service.</p>
|
|
@@ -24,8 +24,7 @@ declare const ListParticipantEventsCommand_base: {
|
|
|
24
24
|
getEndpointParameterInstructions(): import("@smithy/types").EndpointParameterInstructions;
|
|
25
25
|
};
|
|
26
26
|
/**
|
|
27
|
-
* <p>Lists events for a specified participant that occurred during a specified stage
|
|
28
|
-
* session.</p>
|
|
27
|
+
* <p>Lists events for a specified participant that occurred during a specified stage session.</p>
|
|
29
28
|
* @example
|
|
30
29
|
* Use a bare-bones client and the command you need to make an API call.
|
|
31
30
|
* ```javascript
|
|
@@ -88,10 +87,10 @@ declare const ListParticipantEventsCommand_base: {
|
|
|
88
87
|
* @see {@link IVSRealTimeClientResolvedConfig | config} for IVSRealTimeClient's `config` shape.
|
|
89
88
|
*
|
|
90
89
|
* @throws {@link AccessDeniedException} (client fault)
|
|
91
|
-
* <p
|
|
90
|
+
* <p>User does not have sufficient access to perform this action.</p>
|
|
92
91
|
*
|
|
93
92
|
* @throws {@link ValidationException} (client fault)
|
|
94
|
-
* <p
|
|
93
|
+
* <p>The input fails to satisfy the constraints specified by an Amazon Web Services service.</p>
|
|
95
94
|
*
|
|
96
95
|
* @throws {@link IVSRealTimeServiceException}
|
|
97
96
|
* <p>Base exception class for all service exceptions from IVSRealTime service.</p>
|
|
@@ -64,10 +64,10 @@ declare const ListParticipantReplicasCommand_base: {
|
|
|
64
64
|
* @see {@link IVSRealTimeClientResolvedConfig | config} for IVSRealTimeClient's `config` shape.
|
|
65
65
|
*
|
|
66
66
|
* @throws {@link AccessDeniedException} (client fault)
|
|
67
|
-
* <p
|
|
67
|
+
* <p>User does not have sufficient access to perform this action.</p>
|
|
68
68
|
*
|
|
69
69
|
* @throws {@link ValidationException} (client fault)
|
|
70
|
-
* <p
|
|
70
|
+
* <p>The input fails to satisfy the constraints specified by an Amazon Web Services service.</p>
|
|
71
71
|
*
|
|
72
72
|
* @throws {@link IVSRealTimeServiceException}
|
|
73
73
|
* <p>Base exception class for all service exceptions from IVSRealTime service.</p>
|
|
@@ -74,10 +74,10 @@ declare const ListParticipantsCommand_base: {
|
|
|
74
74
|
* @see {@link IVSRealTimeClientResolvedConfig | config} for IVSRealTimeClient's `config` shape.
|
|
75
75
|
*
|
|
76
76
|
* @throws {@link AccessDeniedException} (client fault)
|
|
77
|
-
* <p
|
|
77
|
+
* <p>User does not have sufficient access to perform this action.</p>
|
|
78
78
|
*
|
|
79
79
|
* @throws {@link ValidationException} (client fault)
|
|
80
|
-
* <p
|
|
80
|
+
* <p>The input fails to satisfy the constraints specified by an Amazon Web Services service.</p>
|
|
81
81
|
*
|
|
82
82
|
* @throws {@link IVSRealTimeServiceException}
|
|
83
83
|
* <p>Base exception class for all service exceptions from IVSRealTime service.</p>
|
|
@@ -61,10 +61,10 @@ declare const ListPublicKeysCommand_base: {
|
|
|
61
61
|
* @see {@link IVSRealTimeClientResolvedConfig | config} for IVSRealTimeClient's `config` shape.
|
|
62
62
|
*
|
|
63
63
|
* @throws {@link AccessDeniedException} (client fault)
|
|
64
|
-
* <p
|
|
64
|
+
* <p>User does not have sufficient access to perform this action.</p>
|
|
65
65
|
*
|
|
66
66
|
* @throws {@link ValidationException} (client fault)
|
|
67
|
-
* <p
|
|
67
|
+
* <p>The input fails to satisfy the constraints specified by an Amazon Web Services service.</p>
|
|
68
68
|
*
|
|
69
69
|
* @throws {@link IVSRealTimeServiceException}
|
|
70
70
|
* <p>Base exception class for all service exceptions from IVSRealTime service.</p>
|
|
@@ -60,10 +60,10 @@ declare const ListStageSessionsCommand_base: {
|
|
|
60
60
|
* @see {@link IVSRealTimeClientResolvedConfig | config} for IVSRealTimeClient's `config` shape.
|
|
61
61
|
*
|
|
62
62
|
* @throws {@link AccessDeniedException} (client fault)
|
|
63
|
-
* <p
|
|
63
|
+
* <p>User does not have sufficient access to perform this action.</p>
|
|
64
64
|
*
|
|
65
65
|
* @throws {@link ValidationException} (client fault)
|
|
66
|
-
* <p
|
|
66
|
+
* <p>The input fails to satisfy the constraints specified by an Amazon Web Services service.</p>
|
|
67
67
|
*
|
|
68
68
|
* @throws {@link IVSRealTimeServiceException}
|
|
69
69
|
* <p>Base exception class for all service exceptions from IVSRealTime service.</p>
|
|
@@ -24,8 +24,7 @@ declare const ListStagesCommand_base: {
|
|
|
24
24
|
getEndpointParameterInstructions(): import("@smithy/types").EndpointParameterInstructions;
|
|
25
25
|
};
|
|
26
26
|
/**
|
|
27
|
-
* <p>Gets summary information about all stages in your account, in the AWS region where the
|
|
28
|
-
* API request is processed.</p>
|
|
27
|
+
* <p>Gets summary information about all stages in your account, in the AWS region where the API request is processed.</p>
|
|
29
28
|
* @example
|
|
30
29
|
* Use a bare-bones client and the command you need to make an API call.
|
|
31
30
|
* ```javascript
|
|
@@ -63,13 +62,13 @@ declare const ListStagesCommand_base: {
|
|
|
63
62
|
* @see {@link IVSRealTimeClientResolvedConfig | config} for IVSRealTimeClient's `config` shape.
|
|
64
63
|
*
|
|
65
64
|
* @throws {@link AccessDeniedException} (client fault)
|
|
66
|
-
* <p
|
|
65
|
+
* <p>User does not have sufficient access to perform this action.</p>
|
|
67
66
|
*
|
|
68
67
|
* @throws {@link ConflictException} (client fault)
|
|
69
|
-
* <p
|
|
68
|
+
* <p>Updating or deleting a resource can cause an inconsistent state.</p>
|
|
70
69
|
*
|
|
71
70
|
* @throws {@link ValidationException} (client fault)
|
|
72
|
-
* <p
|
|
71
|
+
* <p>The input fails to satisfy the constraints specified by an Amazon Web Services service.</p>
|
|
73
72
|
*
|
|
74
73
|
* @throws {@link IVSRealTimeServiceException}
|
|
75
74
|
* <p>Base exception class for all service exceptions from IVSRealTime service.</p>
|
|
@@ -24,8 +24,7 @@ declare const ListStorageConfigurationsCommand_base: {
|
|
|
24
24
|
getEndpointParameterInstructions(): import("@smithy/types").EndpointParameterInstructions;
|
|
25
25
|
};
|
|
26
26
|
/**
|
|
27
|
-
* <p>Gets summary information about all storage configurations in your account,
|
|
28
|
-
* in the AWS region where the API request is processed.</p>
|
|
27
|
+
* <p>Gets summary information about all storage configurations in your account, in the AWS region where the API request is processed.</p>
|
|
29
28
|
* @example
|
|
30
29
|
* Use a bare-bones client and the command you need to make an API call.
|
|
31
30
|
* ```javascript
|
|
@@ -65,19 +64,19 @@ declare const ListStorageConfigurationsCommand_base: {
|
|
|
65
64
|
* @see {@link IVSRealTimeClientResolvedConfig | config} for IVSRealTimeClient's `config` shape.
|
|
66
65
|
*
|
|
67
66
|
* @throws {@link AccessDeniedException} (client fault)
|
|
68
|
-
* <p
|
|
67
|
+
* <p>User does not have sufficient access to perform this action.</p>
|
|
69
68
|
*
|
|
70
69
|
* @throws {@link ConflictException} (client fault)
|
|
71
|
-
* <p
|
|
70
|
+
* <p>Updating or deleting a resource can cause an inconsistent state.</p>
|
|
72
71
|
*
|
|
73
72
|
* @throws {@link InternalServerException} (server fault)
|
|
74
|
-
* <p
|
|
73
|
+
* <p>Unexpected error during processing of request.</p>
|
|
75
74
|
*
|
|
76
75
|
* @throws {@link ServiceQuotaExceededException} (client fault)
|
|
77
|
-
* <p
|
|
76
|
+
* <p>Request would cause a service quota to be exceeded.</p>
|
|
78
77
|
*
|
|
79
78
|
* @throws {@link ValidationException} (client fault)
|
|
80
|
-
* <p
|
|
79
|
+
* <p>The input fails to satisfy the constraints specified by an Amazon Web Services service.</p>
|
|
81
80
|
*
|
|
82
81
|
* @throws {@link IVSRealTimeServiceException}
|
|
83
82
|
* <p>Base exception class for all service exceptions from IVSRealTime service.</p>
|
|
@@ -53,13 +53,13 @@ declare const ListTagsForResourceCommand_base: {
|
|
|
53
53
|
* @see {@link IVSRealTimeClientResolvedConfig | config} for IVSRealTimeClient's `config` shape.
|
|
54
54
|
*
|
|
55
55
|
* @throws {@link InternalServerException} (server fault)
|
|
56
|
-
* <p
|
|
56
|
+
* <p>Unexpected error during processing of request.</p>
|
|
57
57
|
*
|
|
58
58
|
* @throws {@link ResourceNotFoundException} (client fault)
|
|
59
|
-
* <p
|
|
59
|
+
* <p>Request references a resource which does not exist.</p>
|
|
60
60
|
*
|
|
61
61
|
* @throws {@link ValidationException} (client fault)
|
|
62
|
-
* <p
|
|
62
|
+
* <p>The input fails to satisfy the constraints specified by an Amazon Web Services service.</p>
|
|
63
63
|
*
|
|
64
64
|
* @throws {@link IVSRealTimeServiceException}
|
|
65
65
|
* <p>Base exception class for all service exceptions from IVSRealTime service.</p>
|
|
@@ -24,30 +24,7 @@ declare const StartCompositionCommand_base: {
|
|
|
24
24
|
getEndpointParameterInstructions(): import("@smithy/types").EndpointParameterInstructions;
|
|
25
25
|
};
|
|
26
26
|
/**
|
|
27
|
-
* <p>Starts a Composition from a stage based on the configuration provided in the
|
|
28
|
-
* request.</p>
|
|
29
|
-
* <p>A Composition is an ephemeral resource that exists after this operation returns
|
|
30
|
-
* successfully. Composition stops and the resource is deleted:</p>
|
|
31
|
-
* <ul>
|
|
32
|
-
* <li>
|
|
33
|
-
* <p>When <a>StopComposition</a> is called.</p>
|
|
34
|
-
* </li>
|
|
35
|
-
* <li>
|
|
36
|
-
* <p>After a 1-minute timeout, when all participants are disconnected from the
|
|
37
|
-
* stage.</p>
|
|
38
|
-
* </li>
|
|
39
|
-
* <li>
|
|
40
|
-
* <p>After a 1-minute timeout, if there are no participants in the stage when
|
|
41
|
-
* StartComposition is called.</p>
|
|
42
|
-
* </li>
|
|
43
|
-
* <li>
|
|
44
|
-
* <p>When broadcasting to the IVS channel fails and all retries are exhausted.</p>
|
|
45
|
-
* </li>
|
|
46
|
-
* <li>
|
|
47
|
-
* <p>When broadcasting is disconnected and all attempts to reconnect are
|
|
48
|
-
* exhausted.</p>
|
|
49
|
-
* </li>
|
|
50
|
-
* </ul>
|
|
27
|
+
* <p>Starts a Composition from a stage based on the configuration provided in the request.</p> <p>A Composition is an ephemeral resource that exists after this operation returns successfully. Composition stops and the resource is deleted:</p> <ul> <li> <p>When <a>StopComposition</a> is called.</p> </li> <li> <p>After a 1-minute timeout, when all participants are disconnected from the stage.</p> </li> <li> <p>After a 1-minute timeout, if there are no participants in the stage when StartComposition is called.</p> </li> <li> <p>When broadcasting to the IVS channel fails and all retries are exhausted.</p> </li> <li> <p>When broadcasting is disconnected and all attempts to reconnect are exhausted.</p> </li> </ul>
|
|
51
28
|
* @example
|
|
52
29
|
* Use a bare-bones client and the command you need to make an API call.
|
|
53
30
|
* ```javascript
|
|
@@ -202,25 +179,25 @@ declare const StartCompositionCommand_base: {
|
|
|
202
179
|
* @see {@link IVSRealTimeClientResolvedConfig | config} for IVSRealTimeClient's `config` shape.
|
|
203
180
|
*
|
|
204
181
|
* @throws {@link AccessDeniedException} (client fault)
|
|
205
|
-
* <p
|
|
182
|
+
* <p>User does not have sufficient access to perform this action.</p>
|
|
206
183
|
*
|
|
207
184
|
* @throws {@link ConflictException} (client fault)
|
|
208
|
-
* <p
|
|
185
|
+
* <p>Updating or deleting a resource can cause an inconsistent state.</p>
|
|
209
186
|
*
|
|
210
187
|
* @throws {@link InternalServerException} (server fault)
|
|
211
|
-
* <p
|
|
188
|
+
* <p>Unexpected error during processing of request.</p>
|
|
212
189
|
*
|
|
213
190
|
* @throws {@link PendingVerification} (client fault)
|
|
214
|
-
* <p
|
|
191
|
+
* <p>Your account is pending verification.</p>
|
|
215
192
|
*
|
|
216
193
|
* @throws {@link ResourceNotFoundException} (client fault)
|
|
217
|
-
* <p
|
|
194
|
+
* <p>Request references a resource which does not exist.</p>
|
|
218
195
|
*
|
|
219
196
|
* @throws {@link ServiceQuotaExceededException} (client fault)
|
|
220
|
-
* <p
|
|
197
|
+
* <p>Request would cause a service quota to be exceeded.</p>
|
|
221
198
|
*
|
|
222
199
|
* @throws {@link ValidationException} (client fault)
|
|
223
|
-
* <p
|
|
200
|
+
* <p>The input fails to satisfy the constraints specified by an Amazon Web Services service.</p>
|
|
224
201
|
*
|
|
225
202
|
* @throws {@link IVSRealTimeServiceException}
|
|
226
203
|
* <p>Base exception class for all service exceptions from IVSRealTime service.</p>
|