canonical: https://jentic.com/apis/amazonaws.com/ivs

# AWS Amazon Interactive Video Service

Jentic publishes the only available OpenAPI specification for Amazon Interactive Video Service, keeping it validated and agent-ready. Amazon IVS is a managed live streaming service that ingests RTMPS broadcasts and delivers low-latency HLS playback to viewers worldwide. The 28-endpoint API covers channel creation, stream key rotation, recording configurations that archive sessions to S3, playback authorization keys for private streams, and EventBridge integration for real-time stream lifecycle signals. It is built for interactive applications such as live shopping, esports, and audience-driven shows where sub-five-second glass-to-glass latency matters.

## For AI agents

Provision live streaming channels, manage stream keys and recordings, and authorise playback for low-latency interactive video applications.

## Scope

Does not handle video-on-demand transcoding, ad insertion, or chat - use for low-latency live streaming channel and recording management only.

## Capabilities

- Provision low-latency live streaming channels via /CreateChannel
- Generate and rotate broadcast stream keys with /CreateStreamKey
- Configure session recording to S3 through /CreateRecordingConfiguration
- Authorise private playback via signed JWT with playback key pairs
- List active live streams in a region using /ListStreams
- Stop in-progress streams server-side with /StopStream
- Tag channels and resources for billing and inventory tracking

## Use cases

### Live Shopping Streams

Power live shopping experiences where presenters demo products and viewers buy in real time. Amazon IVS provides sub-five-second latency, channel-per-creator provisioning, and EventBridge signals when streams start or stop so the storefront can flip product availability immediately. The /CreateChannel and /CreateStreamKey endpoints let teams onboard a new presenter in seconds rather than minutes.

Example prompt: Create a new IVS channel named 'spring-collection-live' with STANDARD type, generate a stream key, and return the ingest endpoint and playback URL

### Creator Platform Channel Lifecycle

Run a creator economy platform where each user gets their own channel and stream key. The IVS API supports per-creator resource provisioning, stream key rotation when creators are compromised, and tag-based filtering so platform analytics can group streams by tier or vertical. Recording configurations let creators automatically archive every broadcast to S3 for VOD playback later.

Example prompt: Create a recording configuration that writes to bucket 'creator-archives' with thumbnail interval 60 and attach it to channel arn:aws:ivs:us-east-1:123:channel/abc

### Private and Token-Gated Playback

Restrict live streams to authenticated viewers using IVS playback authorization. The /ImportPlaybackKeyPair endpoint imports an ECDSA public key, and the application backend signs short-lived JWTs that the player exchanges for stream access. This pattern fits paid events, internal town halls, and any context where playback URLs cannot be public.

Example prompt: Import a playback key pair named 'paid-event-key' with the supplied PEM public key for use signing playback JWTs

### AI Agent Live Stream Operations

AI agents call Amazon IVS through Jentic to provision channels on demand, rotate compromised stream keys, and stop streams that violate policy. The agent searches Jentic for the right operation, loads the input schema, and executes with credentials kept in your Jentic One instance. This is faster than embedding SigV4 signing into every agent runtime and keeps AWS keys out of the LLM context.

Example prompt: Search Jentic for 'stop a live stream', load the StopStream schema, and execute against channel arn:aws:ivs:us-east-1:123:channel/abc

## Key endpoints

| Method | Path | Description |
| --- | --- | --- |
| POST | /CreateChannel | Create a live streaming channel |
| POST | /CreateStreamKey | Generate a broadcast stream key |
| POST | /CreateRecordingConfiguration | Configure S3 recording for a channel |
| POST | /ListStreams | List active live streams |
| POST | /StopStream | Stop an in-progress live stream |
| POST | /GetStream | Get details of a live stream session |
| POST | /BatchGetChannel | Batch fetch channel metadata |

## Key resources

- **Channels** — Create, list, update, and delete live streaming channels
- **Stream Keys** — Generate and rotate the secret used to broadcast to a channel
- **Streams** — List, inspect, and stop live streams in flight
- **Recording Configurations** — Configure S3 archiving of broadcast sessions
- **Playback Key Pairs** — Manage ECDSA keys for private playback authorization

## Why Jentic

- **Setup:** Wiring the Amazon IVS API by hand means building AWS Signature Version 4 signing, selecting the right regional host from ivs.{region}.amazonaws.com, wiring IAM permissions, and handling AWS throttling and retries yourself. Through Jentic you install once, import Amazon Interactive Video Service from the API Directory, store the AWS access key and secret once, and your agent calls it.
- **Permission scoping:** IVS operations are RPC-style calls such as CreateChannel and StopStream that carry the channel ARN in the request body, so limit the agent to the operations it needs, such as CreateChannel or ListStreams. You choose the operations it may call, so destructive ones like StopStream or DeleteChannel are not included unless you add them.
- **Credential handling:** Your AWS access key and secret for IVS are stored once, encrypted, by your own Jentic One instance and signed with SigV4 at execution time. They never enter the agent's prompt, logs, or context.
- **Discovery method:** Agents search Jentic by intent such as 'create a low-latency live streaming channel' or 'stop a live stream', and Jentic returns the matching IVS operation with its input schema so the agent calls the right endpoint without reading the AWS reference.

## Related APIs

- **AWS Elemental MediaPackage VOD** — Package and deliver video-on-demand assets
- **Kinesis Video Streams Archived Media** — Retrieve archived video fragments from Kinesis Video Streams
- **AWS Elemental MediaTailor** — Personalised ad insertion for video streams
- **AWS Elemental MediaStore** — Low-latency storage optimised for media workflows

## FAQ

### Why is there no official OpenAPI spec for Amazon Interactive Video Service?

AWS does not publish an OpenAPI specification. Jentic generates and maintains this spec so that AI agents and developers can call Amazon Interactive Video Service via structured tooling. It is validated against the live API and kept up to date. Get started with Jentic One, the self-hosted execution layer.

### What authentication does the Amazon IVS API use?

Amazon IVS uses AWS Signature Version 4 (SigV4) HMAC request signing. Each call must be signed with an access key, secret key, and optional session token scoped to the IVS IAM permissions. Through Jentic, these credentials sit in the encrypted vault and signing happens at execution time so the agent never sees the raw secret.

### Can I create a private live stream with the Amazon IVS API?

Yes. Import an ECDSA public key with POST /ImportPlaybackKeyPair, then sign short-lived JWTs server-side with the matching private key. Configure the channel for authorized playback so the player must present a valid JWT to start playback.

### What are the rate limits for the Amazon IVS API?

Per-region quotas apply, including limits on channels per account, concurrent live viewers, and TPS for control plane operations such as CreateChannel and CreateStreamKey. Check the IVS service quotas in the AWS console for the current limits in your account.

### How do I provision a new creator channel through Jentic?

Search Jentic for 'create live streaming channel', load the schema for POST /CreateChannel, submit the channel name and type, then call POST /CreateStreamKey for the same channel ARN. Jentic handles SigV4 signing on both calls.

### Can I record live streams to S3 using the Amazon IVS API?

Yes. POST /CreateRecordingConfiguration creates a configuration pointing at an S3 bucket with optional thumbnail intervals, and channels created or updated with that configuration ARN automatically archive every broadcast session to S3.

### Can I stop a live stream remotely with the Amazon IVS API?

Yes. POST /StopStream takes a channel ARN and ends the active broadcast session. This is useful for moderation flows where the platform needs to terminate a stream that violates terms of service without waiting for the broadcaster to disconnect.

### Can I limit what my agent is allowed to do with the Amazon IVS API?

Yes. Because you run your own self-hosted Jentic One instance, your rules decide which IVS operations and AWS credentials the agent may use. You can grant only the calls it needs, such as CreateChannel, CreateStreamKey, or ListStreams, and leave out destructive operations like StopStream and DeleteChannel unless you explicitly add them. Since each RPC-style call carries the channel ARN in its request body, you control exactly which operations the agent can invoke.