Crate aws_sdk_ivsrealtime

source ·
Expand description

Introduction

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.

Terminology:

  • A stage is a virtual space where participants can exchange video in real time.
  • A participant token is a token that authenticates a participant when they join a stage.
  • A 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.
  • Server-side composition: The composition process composites participants of a stage into a single video and forwards it to a set of outputs (e.g., IVS channels). Composition endpoints support this process.
  • Server-side composition: A composition controls the look of the outputs, including how participants are positioned in the video.

Resources

The following resources contain information about your IVS live stream (see Getting Started with Amazon IVS Real-Time Streaming):

  • Stage — A stage is a virtual space where participants can exchange video in real time.

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 Tagging AWS Resources for more information, 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 endpoints: TagResource, UntagResource, and ListTagsForResource. The following resource supports tagging: Stage.

At most 50 tags can be applied to a resource.

Stages Endpoints

  • CreateParticipantToken — Creates an additional token for a specified stage. This can be done after stage creation or when tokens expire.
  • CreateStage — Creates a new stage (and optionally participant tokens).
  • DeleteStage — Shuts down and deletes the specified stage (disconnecting all participants).
  • DisconnectParticipant — Disconnects a specified participant and revokes the participant permanently from a specified stage.
  • GetParticipant — Gets information about the specified participant token.
  • GetStage — Gets information for the specified stage.
  • GetStageSession — Gets information for the specified stage session.
  • ListParticipantEvents — Lists events for a specified participant that occurred during a specified stage session.
  • ListParticipants — Lists all participants in a specified stage session.
  • ListStages — Gets summary information about all stages in your account, in the AWS region where the API request is processed.
  • ListStageSessions — Gets all sessions for a specified stage.
  • UpdateStage — Updates a stage’s configuration.

Composition Endpoints

  • GetComposition — Gets information about the specified Composition resource.
  • ListCompositions — Gets summary information about all Compositions in your account, in the AWS region where the API request is processed.
  • StartComposition — Starts a Composition from a stage based on the configuration provided in the request.
  • StopComposition — Stops and deletes a Composition resource. Any broadcast from the Composition resource is stopped.

EncoderConfiguration Endpoints

  • CreateEncoderConfiguration — Creates an EncoderConfiguration object.
  • DeleteEncoderConfiguration — Deletes an EncoderConfiguration resource. Ensures that no Compositions are using this template; otherwise, returns an error.
  • GetEncoderConfiguration — Gets information about the specified EncoderConfiguration resource.
  • ListEncoderConfigurations — Gets summary information about all EncoderConfigurations in your account, in the AWS region where the API request is processed.

StorageConfiguration Endpoints

  • CreateStorageConfiguration — Creates a new storage configuration, used to enable recording to Amazon S3.
  • DeleteStorageConfiguration — Deletes the storage configuration for the specified ARN.
  • GetStorageConfiguration — Gets the storage configuration for the specified ARN.
  • ListStorageConfigurations — Gets summary information about all storage configurations in your account, in the AWS region where the API request is processed.

Tags Endpoints

  • ListTagsForResource — Gets information about AWS tags for the specified ARN.
  • TagResource — Adds or updates tags for the AWS resource with the specified ARN.
  • UntagResource — Removes tags from the resource with the specified ARN.

§Getting Started

Examples are available for many services and operations, check out the examples folder in GitHub.

The SDK provides one crate per AWS service. You must add Tokio as a dependency within your Rust project to execute asynchronous code. To add aws-sdk-ivsrealtime to your project, add the following to your Cargo.toml file:

[dependencies]
aws-config = { version = "1.1.7", features = ["behavior-version-latest"] }
aws-sdk-ivsrealtime = "1.34.0"
tokio = { version = "1", features = ["full"] }

Then in code, a client can be created with the following:

use aws_sdk_ivsrealtime as ivsrealtime;

#[::tokio::main]
async fn main() -> Result<(), ivsrealtime::Error> {
    let config = aws_config::load_from_env().await;
    let client = aws_sdk_ivsrealtime::Client::new(&config);

    // ... make some calls with the client

    Ok(())
}

See the client documentation for information on what calls can be made, and the inputs and outputs for each of those calls.

§Using the SDK

Until the SDK is released, we will be adding information about using the SDK to the Developer Guide. Feel free to suggest additional sections for the guide by opening an issue and describing what you are trying to do.

§Getting Help

§Crate Organization

The entry point for most customers will be Client, which exposes one method for each API offered by Amazon Interactive Video Service RealTime. The return value of each of these methods is a “fluent builder”, where the different inputs for that API are added by builder-style function call chaining, followed by calling send() to get a Future that will result in either a successful output or a SdkError.

Some of these API inputs may be structs or enums to provide more complex structured information. These structs and enums live in types. There are some simpler types for representing data such as date times or binary blobs that live in primitives.

All types required to configure a client via the Config struct live in config.

The operation module has a submodule for every API, and in each submodule is the input, output, and error type for that API, as well as builders to construct each of those.

There is a top-level Error type that encompasses all the errors that the client can return. Any other error type can be converted to this Error type via the From trait.

The other modules within this crate are not required for normal usage.

Modules§

  • client
    Client for calling Amazon Interactive Video Service RealTime.
  • config
    Configuration for Amazon Interactive Video Service RealTime.
  • error
    Common errors and error handling utilities.
  • meta
    Information about this crate.
  • operation
    All operations that this crate can perform.
  • primitives
    Primitives such as Blob or DateTime used by other types.
  • types
    Data structures used by operation inputs/outputs.

Structs§

  • Client
    Client for Amazon Interactive Video Service RealTime
  • Config
    Configuration for a aws_sdk_ivsrealtime service client.

Enums§

  • Error
    All possible error types for this service.