Amazon Web Services, Inc.

Amazon Interactive Video Service RealTime

The Amazon Interactive Video Service (IVS) real-time API is REST compatible, using a standard HTTP API and an AWS EventBridge event stream for responses. JSON…

Media & content#openapi

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

The Amazon Interactive Video Service (IVS) real-time API is REST compatible, using a standard HTTP API and an AWS EventBridge event stream for responses. JSON is used for both requests and responses, including errors. Key Concepts Stage — A virtual space where participants can exchange video in real time. Participant token — A token that authenticates a participant when they join a stage. Participant object — Represents participants (people) in the stage and contains information about them. When a token is created, it includes a participant ID; when a participant uses that token to join a stage, the participant is associated with that participant ID. There is a 1:1 mapping between participant tokens and participants. For server-side composition: Composition process — Composites participants of a stage into a single video and forwards it to a set of outputs (e.g., IVS channels). Composition operations support this process. Composition — Controls the look of the outputs, including how participants are positioned in the video. For participant replication: Source stage — The stage where the participant originally joined, which is used as the source for replication. Destination stage — The stage to which the participant is replicated. Replicated participant — A participant in a stage that is replicated to one or more destination stages. Replica participant — A participant in a destination stage that is replicated from another stage (the source stage). For more information about your IVS live stream, also see Getting Started with Amazon IVS Real-Time Streaming . Tagging A tag is a metadata label that you assign to an AWS 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 AWS Resources and Tag Editor for details, including restrictions that apply to tags and "Tag naming limits and requirements"; Amazon IVS stages has no service-specific constraints beyond what is documented there. Tags can help you identify and organize your AWS 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 real-time API has these tag-related operations: TagResource , UntagResource , and ListTagsForResource . The following resource supports tagging: Stage. At most 50 tags can be applied to a resource.

Endpoints 40

  • POSTCreate encoder configuration/CreateEncoderConfigurationCreates an EncoderConfiguration object.
  • POSTCreate ingest configuration/CreateIngestConfigurationCreates a new IngestConfiguration resource, used to specify the ingest protocol for a stage.
  • POSTCreate participant token/CreateParticipantTokenCreates an additional token for a specified stage. This can be done after stage creation or when tokens expire. Tokens always are scoped to the stage for…
  • POSTCreate stage/CreateStageCreates a new stage (and optionally participant tokens).
  • POSTCreate storage configuration/CreateStorageConfigurationCreates a new storage configuration, used to enable recording to Amazon S3. When a StorageConfiguration is created, IVS will modify the S3 bucketPolicy of the…
  • POSTDelete encoder configuration/DeleteEncoderConfigurationDeletes an EncoderConfiguration resource. Ensures that no Compositions are using this template; otherwise, returns an error.
  • POSTDelete ingest configuration/DeleteIngestConfigurationDeletes a specified IngestConfiguration, so it can no longer be used to broadcast. An IngestConfiguration cannot be deleted if the publisher is actively…
  • POSTDelete public key/DeletePublicKeyDeletes the specified public key used to sign stage participant tokens. This invalidates future participant tokens generated using the key pair’s private key.
  • POSTDelete stage/DeleteStageShuts down and deletes the specified stage (disconnecting all participants). This operation also removes the stageArn from the associated IngestConfiguration…
  • POSTDelete storage configuration/DeleteStorageConfigurationDeletes the storage configuration for the specified ARN. If you try to delete a storage configuration that is used by a Composition, you will get an error…
  • POSTDisconnect participant/DisconnectParticipantDisconnects a specified participant from a specified stage. If the participant is publishing using an IngestConfiguration , DisconnectParticipant also updates…
  • POSTGet composition/GetCompositionGet information about the specified Composition resource.
  • POSTGet encoder configuration/GetEncoderConfigurationGets information about the specified EncoderConfiguration resource.
  • POSTGet ingest configuration/GetIngestConfigurationGets information about the specified IngestConfiguration.
  • POSTGet participant/GetParticipantGets information about the specified participant token.
  • POSTGet public key/GetPublicKeyGets information for the specified public key.
  • POSTGet stage/GetStageGets information for the specified stage.
  • POSTGet stage session/GetStageSessionGets information for the specified stage session.
  • POSTGet storage configuration/GetStorageConfigurationGets the storage configuration for the specified ARN.
  • POSTImport public key/ImportPublicKeyImport a public key to be used for signing stage participant tokens.
  • POSTList compositions/ListCompositionsGets summary information about all Compositions in your account, in the AWS region where the API request is processed.
  • POSTList encoder configurations/ListEncoderConfigurationsGets summary information about all EncoderConfigurations in your account, in the AWS region where the API request is processed.
  • POSTList ingest configurations/ListIngestConfigurationsLists all IngestConfigurations in your account, in the AWS region where the API request is processed.
  • POSTList participant events/ListParticipantEventsLists events for a specified participant that occurred during a specified stage session.
  • POSTList participant replicas/ListParticipantReplicasLists all the replicas for a participant from a source stage.
  • POSTList participants/ListParticipantsLists all participants in a specified stage session.
  • POSTList public keys/ListPublicKeysGets summary information about all public keys in your account, in the AWS region where the API request is processed.
  • POSTList stage sessions/ListStageSessionsGets all sessions for a specified stage.
  • POSTList stages/ListStagesGets summary information about all stages in your account, in the AWS region where the API request is processed.
  • POSTList storage configurations/ListStorageConfigurationsGets summary information about all storage configurations in your account, in the AWS region where the API request is processed.
  • GETList tags for resource/tags/:resourceArnGets information about AWS tags for the specified ARN.
  • POSTTag resource/tags/:resourceArnAdds or updates tags for the AWS resource with the specified ARN.
  • DELETEUntag resource/tags/:resourceArn?tagKeys=Removes tags from the resource with the specified ARN.
  • POSTRevoke connection token/RevokeConnectionTokenRevokes the specified connection token so that it can no longer connect to a stage. This operation disconnects any participant currently connected with the…
  • POSTStart composition/StartCompositionStarts a Composition from a stage based on the configuration provided in the request. A Composition is an ephemeral resource that exists after this operation…
  • POSTStart participant replication/StartParticipantReplicationStarts replicating a publishing participant from a source stage to a destination stage.
  • POSTStop composition/StopCompositionStops and deletes a Composition resource. Any broadcast from the Composition resource is stopped.
  • POSTStop participant replication/StopParticipantReplicationStops a replicated participant session.
  • POSTUpdate ingest configuration/UpdateIngestConfigurationUpdates a specified IngestConfiguration. Only the stage ARN attached to the IngestConfiguration can be updated. An IngestConfiguration that is active cannot…
  • POSTUpdate stage/UpdateStageUpdates a stage’s configuration.

API details

Base URL
https://ivsrealtime.{region}.amazonaws.com
Authentication
AWS Signature Version 4 (requests signed with your AWS access key)
Operations
40 operations on 38 pathsPOST 38GET 1DELETE 1
Description format
AWS Smithy model, API version 2020-07-14

How to test the Amazon Interactive Video Service RealTime in Swastik Codes

  1. Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
  2. Fork it into your workspaceChoose a workspace. You get your own copy of the Amazon Interactive Video Service RealTime collection, without the publisher's secrets.
  3. 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.
  4. Send a requestPick an endpoint, for example “Create encoder configuration” (POST /CreateEncoderConfiguration), 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 RealTime?

The Amazon Interactive Video Service (IVS) real-time API is REST compatible, using a standard HTTP API and an AWS EventBridge event stream for responses. JSON… It is listed under Media & content and has 40 endpoints.

Who publishes the Amazon Interactive Video Service RealTime?

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 RealTime?

Requests go to https://ivsrealtime.{region}.amazonaws.com. Endpoint paths are added to this base URL.

How do I authenticate with the Amazon Interactive Video Service RealTime?

With AWS Signature Version 4 (requests signed with your AWS access key).

How many endpoints does the Amazon Interactive Video Service RealTime have?

40 operations on 38 paths (38 POST, 1 GET, 1 DELETE).

Is forking the Amazon Interactive Video Service RealTime free?

Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.

Suggest an API

Tell us which public API is missing. We check it, then add it here with its endpoints when it has an OpenAPI (Swagger) description.