aws-elixir

View Source AWS.IVSRealTime (aws-elixir v1.0.4)

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

 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 more information about your IVS live stream, also see Getting Started with Amazon IVS Real-Time Streaming.

tagging

 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.

Link to this section Summary

Functions

create_encoder_configuration(client, input, options \\ [])

Creates an EncoderConfiguration object.

create_ingest_configuration(client, input, options \\ [])

Creates a new IngestConfiguration resource, used to specify the ingest protocol for a stage.

create_participant_token(client, input, options \\ [])

Creates an additional token for a specified stage.

create_stage(client, input, options \\ [])

Creates a new stage (and optionally participant tokens).

create_storage_configuration(client, input, options \\ [])

Creates a new storage configuration, used to enable recording to Amazon S3.

delete_encoder_configuration(client, input, options \\ [])

Deletes an EncoderConfiguration resource.

delete_ingest_configuration(client, input, options \\ [])

Deletes a specified IngestConfiguration, so it can no longer be used to broadcast.

delete_public_key(client, input, options \\ [])

Deletes the specified public key used to sign stage participant tokens.

delete_stage(client, input, options \\ [])

Shuts down and deletes the specified stage (disconnecting all participants).

delete_storage_configuration(client, input, options \\ [])

Deletes the storage configuration for the specified ARN.

disconnect_participant(client, input, options \\ [])

Disconnects a specified participant from a specified stage.

get_composition(client, input, options \\ [])

Get information about the specified Composition resource.

get_encoder_configuration(client, input, options \\ [])

Gets information about the specified EncoderConfiguration resource.

get_ingest_configuration(client, input, options \\ [])

Gets information about the specified IngestConfiguration.

get_participant(client, input, options \\ [])

Gets information about the specified participant token.

get_public_key(client, input, options \\ [])

Gets information for the specified public key.

get_stage(client, input, options \\ [])

Gets information for the specified stage.

get_stage_session(client, input, options \\ [])

Gets information for the specified stage session.

get_storage_configuration(client, input, options \\ [])

Gets the storage configuration for the specified ARN.

import_public_key(client, input, options \\ [])

Import a public key to be used for signing stage participant tokens.

list_compositions(client, input, options \\ [])

Gets summary information about all Compositions in your account, in the AWS region where the API request is processed.

list_encoder_configurations(client, input, options \\ [])

Gets summary information about all EncoderConfigurations in your account, in the AWS region where the API request is processed.

list_ingest_configurations(client, input, options \\ [])

Lists all IngestConfigurations in your account, in the AWS region where the API request is processed.

list_participant_events(client, input, options \\ [])

Lists events for a specified participant that occurred during a specified stage session.

list_participants(client, input, options \\ [])

Lists all participants in a specified stage session.

list_public_keys(client, input, options \\ [])

Gets summary information about all public keys in your account, in the AWS region where the API request is processed.

list_stage_sessions(client, input, options \\ [])

Gets all sessions for a specified stage.

list_stages(client, input, options \\ [])

Gets summary information about all stages in your account, in the AWS region where the API request is processed.

list_storage_configurations(client, input, options \\ [])

Gets summary information about all storage configurations in your account, in the AWS region where the API request is processed.

list_tags_for_resource(client, resource_arn, options \\ [])

Gets information about AWS tags for the specified ARN.

metadata()
start_composition(client, input, options \\ [])

Starts a Composition from a stage based on the configuration provided in the request.

stop_composition(client, input, options \\ [])

Stops and deletes a Composition resource.

tag_resource(client, resource_arn, input, options \\ [])

Adds or updates tags for the AWS resource with the specified ARN.

untag_resource(client, resource_arn, input, options \\ [])

Removes tags from the resource with the specified ARN.

update_ingest_configuration(client, input, options \\ [])

Updates a specified IngestConfiguration.

update_stage(client, input, options \\ [])

Updates a stage’s configuration.

Link to this section Functions

Link to this function

create_encoder_configuration(client, input, options \\ [])

View Source

Creates an EncoderConfiguration object.

Link to this function

create_ingest_configuration(client, input, options \\ [])

View Source

Creates a new IngestConfiguration resource, used to specify the ingest protocol for a stage.

Link to this function

create_participant_token(client, input, options \\ [])

View Source

Creates 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 which they are created.

Encryption keys are owned by Amazon IVS and never used directly by your application.

Link to this function

create_stage(client, input, options \\ [])

View Source

Creates a new stage (and optionally participant tokens).

Link to this function

create_storage_configuration(client, input, options \\ [])

View Source

Creates a new storage configuration, used to enable recording to Amazon S3.

When a StorageConfiguration is created, IVS will modify the S3 bucketPolicy of the provided bucket. This will ensure that IVS has sufficient permissions to write content to the provided bucket.

Link to this function

delete_encoder_configuration(client, input, options \\ [])

View Source

Deletes an EncoderConfiguration resource.

Ensures that no Compositions are using this template; otherwise, returns an error.

Link to this function

delete_ingest_configuration(client, input, options \\ [])

View Source

Deletes a specified IngestConfiguration, so it can no longer be used to broadcast.

An IngestConfiguration cannot be deleted if the publisher is actively streaming to a stage, unless force is set to true.

Link to this function

delete_public_key(client, input, options \\ [])

View Source

Deletes the specified public key used to sign stage participant tokens.

This invalidates future participant tokens generated using the key pair’s private key.

Link to this function

delete_stage(client, input, options \\ [])

View Source

Shuts down and deletes the specified stage (disconnecting all participants).

This operation also removes the stageArn from the associated IngestConfiguration, if there are participants using the IngestConfiguration to publish to the stage.

Link to this function

delete_storage_configuration(client, input, options \\ [])

View Source

Deletes 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 (409 ConflictException). To avoid this, for all Compositions that reference the storage configuration, first use StopComposition and wait for it to complete, then use DeleteStorageConfiguration.

Link to this function

disconnect_participant(client, input, options \\ [])

View Source

Disconnects a specified participant from a specified stage.

If the participant is publishing using an IngestConfiguration, DisconnectParticipant also updates the stageArn in the IngestConfiguration to be an empty string.

Link to this function

get_composition(client, input, options \\ [])

View Source

Get information about the specified Composition resource.

Link to this function

get_encoder_configuration(client, input, options \\ [])

View Source

Gets information about the specified EncoderConfiguration resource.

Link to this function

get_ingest_configuration(client, input, options \\ [])

View Source

Gets information about the specified IngestConfiguration.

Link to this function

get_participant(client, input, options \\ [])

View Source

Gets information about the specified participant token.

Link to this function

get_public_key(client, input, options \\ [])

View Source

Gets information for the specified public key.

Link to this function

get_stage(client, input, options \\ [])

View Source

Gets information for the specified stage.

Link to this function

get_stage_session(client, input, options \\ [])

View Source

Gets information for the specified stage session.

Link to this function

get_storage_configuration(client, input, options \\ [])

View Source

Gets the storage configuration for the specified ARN.

Link to this function

import_public_key(client, input, options \\ [])

View Source

Import a public key to be used for signing stage participant tokens.

Link to this function

list_compositions(client, input, options \\ [])

View Source

Gets summary information about all Compositions in your account, in the AWS region where the API request is processed.

Link to this function

list_encoder_configurations(client, input, options \\ [])

View Source

Gets summary information about all EncoderConfigurations in your account, in the AWS region where the API request is processed.

Link to this function

list_ingest_configurations(client, input, options \\ [])

View Source

Lists all IngestConfigurations in your account, in the AWS region where the API request is processed.

Link to this function

list_participant_events(client, input, options \\ [])

View Source

Lists events for a specified participant that occurred during a specified stage session.

Link to this function

list_participants(client, input, options \\ [])

View Source

Lists all participants in a specified stage session.

Link to this function

list_public_keys(client, input, options \\ [])

View Source

Gets summary information about all public keys in your account, in the AWS region where the API request is processed.

Link to this function

list_stage_sessions(client, input, options \\ [])

View Source

Gets all sessions for a specified stage.

Link to this function

list_stages(client, input, options \\ [])

View Source

Gets summary information about all stages in your account, in the AWS region where the API request is processed.

Link to this function

list_storage_configurations(client, input, options \\ [])

View Source

Gets summary information about all storage configurations in your account, in the AWS region where the API request is processed.

Link to this function

list_tags_for_resource(client, resource_arn, options \\ [])

View Source

Gets information about AWS tags for the specified ARN.

Link to this function

metadata()

View Source
Link to this function

start_composition(client, input, options \\ [])

View Source

Starts a Composition from a stage based on the configuration provided in the request.

A Composition is an ephemeral resource that exists after this operation returns successfully. Composition stops and the resource is deleted:

* When StopComposition is called.

* After a 1-minute timeout, when all participants are disconnected from the stage.

* After a 1-minute timeout, if there are no participants in the stage when StartComposition is called.

* When broadcasting to the IVS channel fails and all retries are exhausted.

* When broadcasting is disconnected and all attempts to reconnect are exhausted.

Link to this function

stop_composition(client, input, options \\ [])

View Source

Stops and deletes a Composition resource.

Any broadcast from the Composition resource is stopped.

Link to this function

tag_resource(client, resource_arn, input, options \\ [])

View Source

Adds or updates tags for the AWS resource with the specified ARN.

Link to this function

untag_resource(client, resource_arn, input, options \\ [])

View Source

Removes tags from the resource with the specified ARN.

Link to this function

update_ingest_configuration(client, input, options \\ [])

View Source

Updates a specified IngestConfiguration.

Only the stage ARN attached to the IngestConfiguration can be updated. An IngestConfiguration that is active cannot be updated.

Link to this function

update_stage(client, input, options \\ [])

View Source

Updates a stage’s configuration.