Amazon Interactive Video Service
Introduction The Amazon Interactive Video Service (IVS) API is REST compatible, using a standard HTTP API and an Amazon Web Services EventBridge event stream…
Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.
Overview
Introduction The Amazon Interactive Video Service (IVS) API is REST compatible, using a standard HTTP API and an Amazon Web Services EventBridge event stream for responses. JSON is used for both requests and responses, including errors. The API is an Amazon Web Services regional service. For a list of supported regions and Amazon IVS HTTPS service endpoints, see the Amazon IVS page in the Amazon Web Services General Reference . All API request parameters and URLs are case sensitive. For a summary of notable documentation changes in each release, see Document History . Allowed Header Values Accept: application/json Accept-Encoding: gzip, deflate Content-Type: application/json Key Concepts Channel — Stores configuration data related to your live stream. You first create a channel and then use the channel’s stream key to start your live stream. Stream key — An identifier assigned by Amazon IVS when you create a channel, which is then used to authorize streaming. Treat the stream key like a secret, since it allows anyone to stream to the channel. Playback key pair — Video playback may be restricted using playback-authorization tokens, which use public-key encryption. A playback key pair is the public-private pair of keys used to sign and validate the playback-authorization token. Recording configuration — Stores configuration related to recording a live stream and where to store the recorded content. Multiple channels can reference the same recording configuration. Playback restriction policy — Restricts playback by countries and/or origin sites. For more information about your IVS live stream, also see Getting Started with IVS Low-Latency Streaming . Tagging A tag is a metadata label that you assign to an Amazon Web Services resource. A tag comprises a key and a value , both set by you. For example, you might set a tag as topic:nature to label a particular video category. See Best practices and strategies in Tagging Amazon Web Services Resources and Tag Editor for details, including restrictions that apply to tags and "Tag naming limits and requirements"; Amazon IVS has no service-specific constraints beyond what is documented there. Tags can help you identify and organize your Amazon Web Services resources. For example, you can use the same tag for different resources to indicate that they are related. You can also use tags to manage access (see Access Tags ). The Amazon IVS API has these tag-related operations: TagResource , UntagResource , and ListTagsForResource . The following resources support tagging: Channels, Stream Keys, Playback Key Pairs, and Recording Configurations. At most 50 tags can be applied to a resource. Authentication versus Authorization Note the differences between these concepts: Authentication is about verifying identity. You need to be authenticated to sign Amazon IVS API requests. Authorization is about granting permissions. Your IAM roles need to have permissions for Amazon IVS API requests. In addition, authorization is needed to view Amazon IVS private channels . (Private channels are channels that are enabled for "playback authorization.") Authentication All Amazon IVS API requests must be authenticated with a signature. The Amazon Web Services Command-Line Interface (CLI) and Amazon IVS Player SDKs take care of signing the underlying API calls for you. However, if your application calls the Amazon IVS API directly, it’s your responsibility to sign the requests. You generate a signature using valid Amazon Web Services credentials that have permission to perform the requested action. For example, you must sign PutMetadata requests with a signature generated from a user account that has the ivs:PutMetadata permission. For more information: Authentication and generating signatures — See Authenticating Requests (Amazon Web Services Signature Version 4) in the Amazon Web Services General Reference . Managing Amazon IVS permissions — See Identity and Access Management on the Security page of the Amazon IVS User Guide . Amazon Resource Names (ARNs) ARNs uniquely identify AWS resources. An ARN is required when you need to specify a resource unambiguously across all of AWS, such as in IAM policies and API calls. For more information, see Amazon Resource Names in the AWS General Reference .
Endpoints 46
- POSTBatch get channel
/BatchGetChannelPerforms GetChannel on multiple ARNs simultaneously. - POSTBatch get stream key
/BatchGetStreamKeyPerforms GetStreamKey on multiple ARNs simultaneously. - POSTBatch start viewer session revocation
/BatchStartViewerSessionRevocationPerforms StartViewerSessionRevocation on multiple channel ARN and viewer ID pairs simultaneously. - POSTCreate ad configuration
/CreateAdConfigurationCreates a new ad configuration to be used for server-side ad insertion. - POSTCreate channel
/CreateChannelCreates a new channel and an associated stream key to start streaming. - POSTCreate failover slate configuration
/CreateFailoverSlateConfigurationCreates a new failover slate configuration. - POSTCreate playback restriction policy
/CreatePlaybackRestrictionPolicyCreates a new playback restriction policy, for constraining playback by countries and/or origins. - POSTCreate recording configuration
/CreateRecordingConfigurationCreates 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… - POSTCreate stream key
/CreateStreamKeyCreates a stream key, used to initiate a stream, for the specified channel ARN. Note that CreateChannel creates a stream key. If you subsequently use… - POSTDelete ad configuration
/DeleteAdConfigurationDeletes the specified ad configuration. - POSTDelete channel
/DeleteChannelDeletes 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… - POSTDelete failover slate configuration
/DeleteFailoverSlateConfigurationDeletes the specified failover slate configuration. - POSTDelete playback key pair
/DeletePlaybackKeyPairDeletes a specified authorization key pair. This invalidates future viewer tokens generated using the key pair’s privateKey . For more information, see… - POSTDelete playback restriction policy
/DeletePlaybackRestrictionPolicyDeletes the specified playback restriction policy. - POSTDelete recording configuration
/DeleteRecordingConfigurationDeletes 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… - POSTDelete stream key
/DeleteStreamKeyDeletes the stream key for the specified ARN, so it can no longer be used to stream. - POSTGet ad configuration
/GetAdConfigurationGets the ad configuration represented by the specified ARN. - POSTGet channel
/GetChannelGets the channel configuration for the specified channel ARN. See also BatchGetChannel . - POSTGet failover slate configuration
/GetFailoverSlateConfigurationGets the failover slate configuration for the specified ARN. - POSTGet playback key pair
/GetPlaybackKeyPairGets a specified playback authorization key pair and returns the arn and fingerprint . The privateKey held by the caller can be used to generate viewer… - POSTGet playback restriction policy
/GetPlaybackRestrictionPolicyGets the specified playback restriction policy. - POSTGet recording configuration
/GetRecordingConfigurationGets the recording configuration for the specified ARN. - POSTGet stream
/GetStreamGets information about the active (live) stream on a specified channel. - POSTGet stream key
/GetStreamKeyGets stream-key information for a specified ARN. - POSTGet stream session
/GetStreamSessionGets metadata on a specified stream. - POSTImport playback key pair
/ImportPlaybackKeyPairImports 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… - POSTInsert ad break
/InsertAdBreakInserts an ad marker in the playlist for the specified channel and duration using the ad configuration associated with the channel. Note: AWS Elemental… - POSTList ad configurations
/ListAdConfigurationsGets summary information about all ad configurations in your account, in the AWS region where the API request is processed. - POSTList channels
/ListChannelsGets 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… - POSTList failover slate configurations
/ListFailoverSlateConfigurationsGets summary information about all failover slate configurations in your account, in the Amazon Web Services region where the API request is processed. - POSTList playback key pairs
/ListPlaybackKeyPairsGets summary information about playback key pairs. For more information, see Setting Up Private Channels in the Amazon IVS User Guide . - POSTList playback restriction policies
/ListPlaybackRestrictionPoliciesGets summary information about playback restriction policies. - POSTList recording configurations
/ListRecordingConfigurationsGets summary information about all recording configurations in your account, in the Amazon Web Services region where the API request is processed. - POSTList stream keys
/ListStreamKeysGets summary information about stream keys for the specified channel. - POSTList stream sessions
/ListStreamSessionsGets a summary of current and previous streams for a specified channel in your account, in the AWS region where the API request is processed. - POSTList streams
/ListStreamsGets summary information about live streams in your account, in the Amazon Web Services region where the API request is processed. - GETList tags for resource
/tags/:resourceArnGets information about Amazon Web Services tags for the specified ARN. - POSTTag resource
/tags/:resourceArnAdds or updates tags for the Amazon Web Services resource with the specified ARN. - DELETEUntag resource
/tags/:resourceArn?tagKeys=Removes tags from the resource with the specified ARN. - POSTPut metadata
/PutMetadataInserts 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… - POSTStart viewer session revocation
/StartViewerSessionRevocationStarts the process of revoking the viewer session associated with a specified channel ARN and viewer ID. Optionally, you can provide a version to revoke… - POSTStop stream
/StopStreamDisconnects the incoming RTMPS stream for the specified channel. Can be used in conjunction with DeleteStreamKey to prevent further streaming to a channel.… - POSTUpdate ad configuration
/UpdateAdConfigurationUpdates a specified ad configuration. - POSTUpdate channel
/UpdateChannelUpdates a channel's configuration. Live channels cannot be updated. You must stop the ongoing stream, update the channel, and restart the stream for the… - POSTUpdate failover slate configuration
/UpdateFailoverSlateConfigurationUpdates a specified failover slate configuration. - POSTUpdate playback restriction policy
/UpdatePlaybackRestrictionPolicyUpdates a specified playback restriction policy.
API details
- Base URL
https://ivs.{region}.amazonaws.com- Authentication
- AWS Signature Version 4 (requests signed with your AWS access key)
- Operations
- 46 operations on 44 pathsPOST 44GET 1DELETE 1
- Description format
- AWS Smithy model, API version
2020-07-14 - Links
- Documentation · OpenAPI document
- Listed from
- AWS Smithy API model (aws/api-models-aws) (Apache-2.0)
How to test the Amazon Interactive Video Service in Swastik Codes
- Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
- Fork it into your workspaceChoose a workspace. You get your own copy of the Amazon Interactive Video Service collection, without the publisher's secrets.
- Add your credentialsThis API uses AWS Signature Version 4 (requests signed with your AWS access key). Add yours in the collection's variables or an environment; the requests already reference it.
- Send a requestPick an endpoint, for example “Batch get channel” (POST /BatchGetChannel), and press Send. Check the response, add tests and run the whole collection with the runner.
Frequently asked questions
What is the Amazon Interactive Video Service?
Introduction The Amazon Interactive Video Service (IVS) API is REST compatible, using a standard HTTP API and an Amazon Web Services EventBridge event stream… It is listed under Media & content and has 46 endpoints.
Who publishes the Amazon Interactive Video Service?
It is listed from Amazon Web Services, Inc.'s public API description (an OpenAPI document), not published by Amazon Web Services, Inc. on Swastik Codes. Anyone who controls amazonaws.com can claim the profile by adding a DNS TXT record.
What is the base URL of the Amazon Interactive Video Service?
Requests go to https://ivs.{region}.amazonaws.com. Endpoint paths are added to this base URL.
How do I authenticate with the Amazon Interactive Video Service?
With AWS Signature Version 4 (requests signed with your AWS access key).
How many endpoints does the Amazon Interactive Video Service have?
46 operations on 44 paths (44 POST, 1 GET, 1 DELETE).
Is forking the Amazon Interactive Video Service free?
Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.