1---2name: amazon-interactive-video-service3description: Amazon Interactive Video Service API skill. Use when working with Amazon Interactive Video Service for BatchGetChannel, BatchGetStreamKey, BatchStartViewerSessionRevocation. Covers 35 endpoints.4---5
6# Amazon Interactive Video Service
7API version: 2020-07-14
8
9## Auth
10AWS SigV4
11
12## Base URL
13Not specified.
14
15## Setup
161. Configure auth: AWS SigV4
172. GET /tags/{resourceArn} -- verify access
183. POST /BatchGetChannel -- create first BatchGetChannel
19
20## Endpoints
21
2235 endpoints across 33 groups. See references/api-spec.lap for full details.
23
24### BatchGetChannel
25| Method | Path | Description |
26|--------|------|-------------|
27| POST | /BatchGetChannel | Performs GetChannel on multiple ARNs simultaneously. |
28
29### BatchGetStreamKey
30| Method | Path | Description |
31|--------|------|-------------|
32| POST | /BatchGetStreamKey | Performs GetStreamKey on multiple ARNs simultaneously. |
33
34### BatchStartViewerSessionRevocation
35| Method | Path | Description |
36|--------|------|-------------|
37| POST | /BatchStartViewerSessionRevocation | Performs StartViewerSessionRevocation on multiple channel ARN and viewer ID pairs simultaneously. |
38
39### CreateChannel
40| Method | Path | Description |
41|--------|------|-------------|
42| POST | /CreateChannel | Creates a new channel and an associated stream key to start streaming. |
43
44### CreatePlaybackRestrictionPolicy
45| Method | Path | Description |
46|--------|------|-------------|
47| POST | /CreatePlaybackRestrictionPolicy | Creates a new playback restriction policy, for constraining playback by countries and/or origins. |
48
49### CreateRecordingConfiguration
50| Method | Path | Description |
51|--------|------|-------------|
52| POST | /CreateRecordingConfiguration | Creates a new recording configuration, used to enable recording to Amazon S3. Known issue: In the us-east-1 region, if you use the Amazon Web Services CLI to create a recording configuration, it returns success even if the S3 bucket is in a different region. In this case, the state of the recording configuration is CREATE_FAILED (instead of ACTIVE). (In other regions, the CLI correctly returns failure if the bucket is in a different region.) Workaround: Ensure that your S3 bucket is in the same region as the recording configuration. If you create a recording configuration in a different region as your S3 bucket, delete that recording configuration and create a new one with an S3 bucket from the correct region. |
53
54### CreateStreamKey
55| Method | Path | Description |
56|--------|------|-------------|
57| POST | /CreateStreamKey | Creates a stream key, used to initiate a stream, for the specified channel ARN. Note that CreateChannel creates a stream key. If you subsequently use CreateStreamKey on the same channel, it will fail because a stream key already exists and there is a limit of 1 stream key per channel. To reset the stream key on a channel, use DeleteStreamKey and then CreateStreamKey. |
58
59### DeleteChannel
60| Method | Path | Description |
61|--------|------|-------------|
62| POST | /DeleteChannel | Deletes the specified channel and its associated stream keys. If you try to delete a live channel, you will get an error (409 ConflictException). To delete a channel that is live, call StopStream, wait for the Amazon EventBridge "Stream End" event (to verify that the stream's state is no longer Live), then call DeleteChannel. (See Using EventBridge with Amazon IVS.) |
63
64### DeletePlaybackKeyPair
65| Method | Path | Description |
66|--------|------|-------------|
67| POST | /DeletePlaybackKeyPair | Deletes a specified authorization key pair. This invalidates future viewer tokens generated using the key pair’s privateKey. For more information, see Setting Up Private Channels in the Amazon IVS User Guide. |
68
69### DeletePlaybackRestrictionPolicy
70| Method | Path | Description |
71|--------|------|-------------|
72| POST | /DeletePlaybackRestrictionPolicy | Deletes the specified playback restriction policy. |
73
74### DeleteRecordingConfiguration
75| Method | Path | Description |
76|--------|------|-------------|
77| POST | /DeleteRecordingConfiguration | Deletes the recording configuration for the specified ARN. If you try to delete a recording configuration that is associated with a channel, you will get an error (409 ConflictException). To avoid this, for all channels that reference the recording configuration, first use UpdateChannel to set the recordingConfigurationArn field to an empty string, then use DeleteRecordingConfiguration. |
78
79### DeleteStreamKey
80| Method | Path | Description |
81|--------|------|-------------|
82| POST | /DeleteStreamKey | Deletes the stream key for the specified ARN, so it can no longer be used to stream. |
83
84### GetChannel
85| Method | Path | Description |
86|--------|------|-------------|
87| POST | /GetChannel | Gets the channel configuration for the specified channel ARN. See also BatchGetChannel. |
88
89### GetPlaybackKeyPair
90| Method | Path | Description |
91|--------|------|-------------|
92| POST | /GetPlaybackKeyPair | Gets a specified playback authorization key pair and returns the arn and fingerprint. The privateKey held by the caller can be used to generate viewer authorization tokens, to grant viewers access to private channels. For more information, see Setting Up Private Channels in the Amazon IVS User Guide. |
93
94### GetPlaybackRestrictionPolicy
95| Method | Path | Description |
96|--------|------|-------------|
97| POST | /GetPlaybackRestrictionPolicy | Gets the specified playback restriction policy. |
98
99### GetRecordingConfiguration
100| Method | Path | Description |
101|--------|------|-------------|
102| POST | /GetRecordingConfiguration | Gets the recording configuration for the specified ARN. |
103
104### GetStream
105| Method | Path | Description |
106|--------|------|-------------|
107| POST | /GetStream | Gets information about the active (live) stream on a specified channel. |
108
109### GetStreamKey
110| Method | Path | Description |
111|--------|------|-------------|
112| POST | /GetStreamKey | Gets stream-key information for a specified ARN. |
113
114### GetStreamSession
115| Method | Path | Description |
116|--------|------|-------------|
117| POST | /GetStreamSession | Gets metadata on a specified stream. |
118
119### ImportPlaybackKeyPair
120| Method | Path | Description |
121|--------|------|-------------|
122| POST | /ImportPlaybackKeyPair | Imports the public portion of a new key pair and returns its arn and fingerprint. The privateKey can then be used to generate viewer authorization tokens, to grant viewers access to private channels. For more information, see Setting Up Private Channels in the Amazon IVS User Guide. |
123
124### ListChannels
125| Method | Path | Description |
126|--------|------|-------------|
127| POST | /ListChannels | Gets summary information about all channels in your account, in the Amazon Web Services region where the API request is processed. This list can be filtered to match a specified name or recording-configuration ARN. Filters are mutually exclusive and cannot be used together. If you try to use both filters, you will get an error (409 ConflictException). |
128
129### ListPlaybackKeyPairs
130| Method | Path | Description |
131|--------|------|-------------|
132| POST | /ListPlaybackKeyPairs | Gets summary information about playback key pairs. For more information, see Setting Up Private Channels in the Amazon IVS User Guide. |
133
134### ListPlaybackRestrictionPolicies
135| Method | Path | Description |
136|--------|------|-------------|
137| POST | /ListPlaybackRestrictionPolicies | Gets summary information about playback restriction policies. |
138
139### ListRecordingConfigurations
140| Method | Path | Description |
141|--------|------|-------------|
142| POST | /ListRecordingConfigurations | Gets summary information about all recording configurations in your account, in the Amazon Web Services region where the API request is processed. |
143
144### ListStreamKeys
145| Method | Path | Description |
146|--------|------|-------------|
147| POST | /ListStreamKeys | Gets summary information about stream keys for the specified channel. |
148
149### ListStreamSessions
150| Method | Path | Description |
151|--------|------|-------------|
152| POST | /ListStreamSessions | Gets a summary of current and previous streams for a specified channel in your account, in the AWS region where the API request is processed. |
153
154### ListStreams
155| Method | Path | Description |
156|--------|------|-------------|
157| POST | /ListStreams | Gets summary information about live streams in your account, in the Amazon Web Services region where the API request is processed. |
158
159### tags
160| Method | Path | Description |
161|--------|------|-------------|
162| GET | /tags/{resourceArn} | Gets information about Amazon Web Services tags for the specified ARN. |
163| POST | /tags/{resourceArn} | Adds or updates tags for the Amazon Web Services resource with the specified ARN. |
164| DELETE | /tags/{resourceArn} | Removes tags from the resource with the specified ARN. |
165
166### PutMetadata
167| Method | Path | Description |
168|--------|------|-------------|
169| POST | /PutMetadata | Inserts metadata into the active stream of the specified channel. At most 5 requests per second per channel are allowed, each with a maximum 1 KB payload. (If 5 TPS is not sufficient for your needs, we recommend batching your data into a single PutMetadata call.) At most 155 requests per second per account are allowed. Also see Embedding Metadata within a Video Stream in the Amazon IVS User Guide. |
170
171### StartViewerSessionRevocation
172| Method | Path | Description |
173|--------|------|-------------|
174| POST | /StartViewerSessionRevocation | Starts the process of revoking the viewer session associated with a specified channel ARN and viewer ID. Optionally, you can provide a version to revoke viewer sessions less than and including that version. For instructions on associating a viewer ID with a viewer session, see Setting Up Private Channels. |
175
176### StopStream
177| Method | Path | Description |
178|--------|------|-------------|
179| POST | /StopStream | Disconnects the incoming RTMPS stream for the specified channel. Can be used in conjunction with DeleteStreamKey to prevent further streaming to a channel. Many streaming client-software libraries automatically reconnect a dropped RTMPS session, so to stop the stream permanently, you may want to first revoke the streamKey attached to the channel. |
180
181### UpdateChannel
182| Method | Path | Description |
183|--------|------|-------------|
184| POST | /UpdateChannel | Updates a channel's configuration. Live channels cannot be updated. You must stop the ongoing stream, update the channel, and restart the stream for the changes to take effect. |
185
186### UpdatePlaybackRestrictionPolicy
187| Method | Path | Description |
188|--------|------|-------------|
189| POST | /UpdatePlaybackRestrictionPolicy | Updates a specified playback restriction policy. |
190
191## Common Questions
192
193Match user requests to endpoints in references/api-spec.lap. Key patterns:
194- "Create a BatchGetChannel?" -> POST /BatchGetChannel
195- "Create a BatchGetStreamKey?" -> POST /BatchGetStreamKey
196- "Create a BatchStartViewerSessionRevocation?" -> POST /BatchStartViewerSessionRevocation
197- "Create a CreateChannel?" -> POST /CreateChannel
198- "Create a CreatePlaybackRestrictionPolicy?" -> POST /CreatePlaybackRestrictionPolicy
199- "Create a CreateRecordingConfiguration?" -> POST /CreateRecordingConfiguration
200- "Create a CreateStreamKey?" -> POST /CreateStreamKey
201- "Create a DeleteChannel?" -> POST /DeleteChannel
202- "Create a DeletePlaybackKeyPair?" -> POST /DeletePlaybackKeyPair
203- "Create a DeletePlaybackRestrictionPolicy?" -> POST /DeletePlaybackRestrictionPolicy
204- "Create a DeleteRecordingConfiguration?" -> POST /DeleteRecordingConfiguration
205- "Create a DeleteStreamKey?" -> POST /DeleteStreamKey
206- "Create a GetChannel?" -> POST /GetChannel
207- "Create a GetPlaybackKeyPair?" -> POST /GetPlaybackKeyPair
208- "Create a GetPlaybackRestrictionPolicy?" -> POST /GetPlaybackRestrictionPolicy
209- "Create a GetRecordingConfiguration?" -> POST /GetRecordingConfiguration
210- "Create a GetStream?" -> POST /GetStream
211- "Create a GetStreamKey?" -> POST /GetStreamKey
212- "Create a GetStreamSession?" -> POST /GetStreamSession
213- "Create a ImportPlaybackKeyPair?" -> POST /ImportPlaybackKeyPair
214- "Create a ListChannel?" -> POST /ListChannels
215- "Create a ListPlaybackKeyPair?" -> POST /ListPlaybackKeyPairs
216- "Create a ListPlaybackRestrictionPolicy?" -> POST /ListPlaybackRestrictionPolicies
217- "Create a ListRecordingConfiguration?" -> POST /ListRecordingConfigurations
218- "Create a ListStreamKey?" -> POST /ListStreamKeys
219- "Create a ListStreamSession?" -> POST /ListStreamSessions
220- "Create a ListStream?" -> POST /ListStreams
221- "Get tag details?" -> GET /tags/{resourceArn}
222- "Create a PutMetadata?" -> POST /PutMetadata
223- "Create a StartViewerSessionRevocation?" -> POST /StartViewerSessionRevocation
224- "Create a StopStream?" -> POST /StopStream
225- "Delete a tag?" -> DELETE /tags/{resourceArn}
226- "Create a UpdateChannel?" -> POST /UpdateChannel
227- "Create a UpdatePlaybackRestrictionPolicy?" -> POST /UpdatePlaybackRestrictionPolicy
228- "How to authenticate?" -> See Auth section
229
230## Response Tips
231- Check response schemas in references/api-spec.lap for field details
232- Create/update endpoints typically return the created/updated object
233
234## References
235- Full spec: See references/api-spec.lap for complete endpoint details, parameter tables, and response schemas
236
237> Generated from the official API spec by [LAP](https://lap.sh)