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 is used for both requests and responses, including errors.
Key Concepts
For server-side composition:
For more information about your IVS live stream, also see Getting Started with Amazon IVS Real-Time Streaming.
Tagging
A tagis 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: tag_resource, untag_resource, and list_tags_for_resource. The following resource supports tagging: Stage.
At most 50 tags can be applied to a resource.
ivsrealtime( config = list(), credentials = list(), endpoint = NULL, region = NULL )
config: Optional configuration of credentials, endpoint, and/or region.
credentials :
creds :
profile : The name of a profile to use. If not given, then the default profile is used.
anonymous : Set anonymous credentials.
endpoint : The complete URL to use for the constructed client.
region : The AWS Region used in instantiating the client.
close_connection : Immediately close all HTTP connections.
timeout : The time in seconds till a timeout exception is thrown when attempting to make a connection. The default is 60 seconds.
s3_force_path_style : Set this to true to force the request to use path-style addressing, i.e. http://s3.amazonaws.com/BUCKET/KEY.
sts_regional_endpoint : Set sts regional endpoint resolver to regional or legacy https://docs.aws.amazon.com/sdkref/latest/guide/feature-sts-regionalized-endpoints.html
credentials: Optional credentials shorthand for the config parameter
creds :
profile : The name of a profile to use. If not given, then the default profile is used.
anonymous : Set anonymous credentials.
endpoint: Optional shorthand for complete URL to use for the constructed client.
region: Optional shorthand for AWS Region used in instantiating the client.
A client for the service. You can call the service's operations using syntax like svc$operation(...), where svc is the name you've assigned to the client. The available operations are listed in the Operations section.
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
For server-side composition:
For more information about your IVS live stream, also see Getting Started with Amazon IVS Real-Time Streaming.
Tagging
A tagis 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: tag_resource, untag_resource, and list_tags_for_resource. The following resource supports tagging: Stage.
At most 50 tags can be applied to a resource.
svc <- ivsrealtime(
config = list(
credentials = list(
creds = list(
access_key_id = "string",
secret_access_key = "string",
session_token = "string"
),
profile = "string",
anonymous = "logical"
),
endpoint = "string",
region = "string",
close_connection = "logical",
timeout = "numeric",
s3_force_path_style = "logical",
sts_regional_endpoint = "string"
),
credentials = list(
creds = list(
access_key_id = "string",
secret_access_key = "string",
session_token = "string"
),
profile = "string",
anonymous = "logical"
),
endpoint = "string",
region = "string"
)
| create_encoder_configuration | Creates an EncoderConfiguration object |
| create_ingest_configuration | Creates a new IngestConfiguration resource, used to specify the ingest protocol for a stage |
| create_participant_token | Creates an additional token for a specified stage |
| create_stage | Creates a new stage (and optionally participant tokens) |
| create_storage_configuration | Creates a new storage configuration, used to enable recording to Amazon S3 |
| delete_encoder_configuration | Deletes an EncoderConfiguration resource |
| delete_ingest_configuration | Deletes a specified IngestConfiguration, so it can no longer be used to broadcast |
| delete_public_key | Deletes the specified public key used to sign stage participant tokens |
| delete_stage | Shuts down and deletes the specified stage (disconnecting all participants) |
| delete_storage_configuration | Deletes the storage configuration for the specified ARN |
| disconnect_participant | Disconnects a specified participant from a specified stage |
| get_composition | Get information about the specified Composition resource |
| get_encoder_configuration | Gets information about the specified EncoderConfiguration resource |
| get_ingest_configuration | Gets information about the specified IngestConfiguration |
| get_participant | Gets information about the specified participant token |
| get_public_key | Gets information for the specified public key |
| get_stage | Gets information for the specified stage |
| get_stage_session | Gets information for the specified stage session |
| get_storage_configuration | Gets the storage configuration for the specified ARN |
| import_public_key | Import a public key to be used for signing stage participant tokens |
| list_compositions | Gets summary information about all Compositions in your account, in the AWS region where the API request is processed |
| list_encoder_configurations | Gets summary information about all EncoderConfigurations in your account, in the AWS region where the API request is processed |
| list_ingest_configurations | Lists all IngestConfigurations in your account, in the AWS region where the API request is processed |
| list_participant_events | Lists events for a specified participant that occurred during a specified stage session |
| list_participants | Lists all participants in a specified stage session |
| list_public_keys | Gets summary information about all public keys in your account, in the AWS region where the API request is processed |
| list_stages | Gets summary information about all stages in your account, in the AWS region where the API request is processed |
| list_stage_sessions | Gets all sessions for a specified stage |
| list_storage_configurations | Gets summary information about all storage configurations in your account, in the AWS region where the API request is processed |
| list_tags_for_resource | Gets information about AWS tags for the specified ARN |
| start_composition | Starts a Composition from a stage based on the configuration provided in the request |
| stop_composition | Stops and deletes a Composition resource |
| tag_resource | Adds or updates tags for the AWS resource with the specified ARN |
| untag_resource | Removes tags from the resource with the specified ARN |
| update_ingest_configuration | Updates a specified IngestConfiguration |
| update_stage | Updates a stage’s configuration |
## Not run: svc <- ivsrealtime() svc$create_encoder_configuration( Foo = 123 ) ## End(Not run)
Useful links