Package ivs provides the API client, operations, and parameter types for Amazon
Interactive Video Service.
Introduction The Amazon Interactive Video Service (IVS) API is REST compatible,
using a standard HTTP API and an Amazon Web Services EventBridge event stream
for responses. JSON is used for both requests and responses, including errors.
The API is an Amazon Web Services regional service. For a list of supported
regions and Amazon IVS HTTPS service endpoints, see the Amazon IVS page (https://docs.aws.amazon.com/general/latest/gr/ivs.html)
in the Amazon Web Services General Reference. All API request parameters and
URLs are case sensitive. For a summary of notable documentation changes in each
release, see Document History (https://docs.aws.amazon.com/ivs/latest/userguide/doc-history.html)
. Allowed Header Values
Key Concepts
For more information about your IVS live stream, also see Getting Started with
IVS Low-Latency Streaming (https://docs.aws.amazon.com/ivs/latest/LowLatencyUserGuide/getting-started.html)
. Tagging A tag is a metadata label that you assign to an Amazon Web Services
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 Amazon Web Services Resources (https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html)
for more information, including restrictions that apply to tags and "Tag naming
limits and requirements"; Amazon IVS has no service-specific constraints beyond
what is documented there. Tags can help you identify and organize your Amazon
Web Services 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 (https://docs.aws.amazon.com/IAM/latest/UserGuide/access_tags.html)
). The Amazon IVS API has these tag-related endpoints: TagResource ,
UntagResource , and ListTagsForResource . The following resources support
tagging: Channels, Stream Keys, Playback Key Pairs, and Recording
Configurations. At most 50 tags can be applied to a resource. Authentication
versus Authorization Note the differences between these concepts:
Authentication All Amazon IVS API requests must be authenticated with a
signature. The Amazon Web Services Command-Line Interface (CLI) and Amazon IVS
Player SDKs take care of signing the underlying API calls for you. However, if
your application calls the Amazon IVS API directly, it’s your responsibility to
sign the requests. You generate a signature using valid Amazon Web Services
credentials that have permission to perform the requested action. For example,
you must sign PutMetadata requests with a signature generated from a user
account that has the ivs:PutMetadata permission. For more information:
Amazon Resource Names (ARNs) ARNs uniquely identify AWS resources. An ARN is
required when you need to specify a resource unambiguously across all of AWS,
such as in IAM policies and API calls. For more information, see Amazon
Resource Names (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html)
in the AWS General Reference. Channel Endpoints
Playback Restriction Policy Endpoints
Private Channel Endpoints For more information, see Setting Up Private Channels (https://docs.aws.amazon.com/ivs/latest/userguide/private-channels.html)
in the Amazon IVS User Guide.
Recording Configuration Endpoints
Stream Endpoints
Stream Key Endpoints
Amazon Web Services Tags Endpoints