Skip to content

Commit

Permalink
feat(client-ivs): Documentation update for IVS Low Latency API Refere…
Browse files Browse the repository at this point in the history 
…nce.
  • Loading branch information
awstools committed Jul 22, 2024
1 parent c35926b commit e9a221e
Show file tree
Hide file tree
Showing 9 changed files with 62 additions and 958 deletions.
227 changes: 0 additions & 227 deletions clients/client-ivs/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -139,233 +139,6 @@ the Security page of the <i>Amazon IVS User Guide</i>.</p>
resource unambiguously across all of AWS, such as in IAM policies and API
calls. For more information, see <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">Amazon
Resource Names</a> in the <i>AWS General Reference</i>.</p>
<p>
<b>Channel Endpoints</b>
</p>
<ul>
<li>
<p>
<a>CreateChannel</a> — Creates a new channel and an associated stream
key to start streaming.</p>
</li>
<li>
<p>
<a>GetChannel</a> — Gets the channel configuration for the specified
channel ARN.</p>
</li>
<li>
<p>
<a>BatchGetChannel</a> — Performs <a>GetChannel</a> on
multiple ARNs simultaneously.</p>
</li>
<li>
<p>
<a>ListChannels</a> — Gets summary information about all channels in
your account, in the Amazon Web Services region where the API request is processed. This
list can be filtered to match a specified name or recording-configuration ARN. Filters are
mutually exclusive and cannot be used together. If you try to use both filters, you will
get an error (409 Conflict Exception).</p>
</li>
<li>
<p>
<a>UpdateChannel</a> — Updates a channel's configuration. This does
not affect an ongoing stream of this channel. You must stop and restart the stream for the
changes to take effect.</p>
</li>
<li>
<p>
<a>DeleteChannel</a> — Deletes the specified channel.</p>
</li>
</ul>
<p>
<b>Playback Restriction Policy Endpoints</b>
</p>
<ul>
<li>
<p>
<a>CreatePlaybackRestrictionPolicy</a> — Creates a new playback
restriction policy, for constraining playback by countries and/or origins.</p>
</li>
<li>
<p>
<a>DeletePlaybackRestrictionPolicy</a> — Deletes the specified
playback restriction policy</p>
</li>
<li>
<p>
<a>GetPlaybackRestrictionPolicy</a> — Gets the specified playback
restriction policy.</p>
</li>
<li>
<p>
<a>ListPlaybackRestrictionPolicies</a> — Gets summary information
about playback restriction policies.</p>
</li>
<li>
<p>
<a>UpdatePlaybackRestrictionPolicy</a> — Updates a specified playback
restriction policy.</p>
</li>
</ul>
<p>
<b>Private Channel Endpoints</b>
</p>
<p>For more information, see <a href="https://docs.aws.amazon.com/ivs/latest/userguide/private-channels.html">Setting Up Private Channels</a> in the
<i>Amazon IVS User Guide</i>.</p>
<ul>
<li>
<p>
<a>ImportPlaybackKeyPair</a> — Imports the public portion of a new
key pair and returns its <code>arn</code> and <code>fingerprint</code>. The
<code>privateKey</code> can then be used to generate viewer authorization tokens, to
grant viewers access to private channels (channels enabled for playback
authorization).</p>
</li>
<li>
<p>
<a>GetPlaybackKeyPair</a> — Gets a specified playback authorization
key pair and returns the <code>arn</code> and <code>fingerprint</code>. The
<code>privateKey</code> held by the caller can be used to generate viewer authorization
tokens, to grant viewers access to private channels.</p>
</li>
<li>
<p>
<a>ListPlaybackKeyPairs</a> — Gets summary information about playback
key pairs.</p>
</li>
<li>
<p>
<a>DeletePlaybackKeyPair</a> — Deletes a specified authorization key
pair. This invalidates future viewer tokens generated using the key pair’s
<code>privateKey</code>.</p>
</li>
<li>
<p>
<a>StartViewerSessionRevocation</a> — Starts the process of revoking
the viewer session associated with a specified channel ARN and viewer ID. Optionally, you
can provide a version to revoke viewer sessions less than and including that
version.</p>
</li>
<li>
<p>
<a>BatchStartViewerSessionRevocation</a> — Performs <a>StartViewerSessionRevocation</a> on multiple channel ARN and viewer ID pairs
simultaneously.</p>
</li>
</ul>
<p>
<b>Recording Configuration Endpoints</b>
</p>
<ul>
<li>
<p>
<a>CreateRecordingConfiguration</a> — Creates a new recording
configuration, used to enable recording to Amazon S3.</p>
</li>
<li>
<p>
<a>GetRecordingConfiguration</a> — Gets the recording-configuration
metadata for the specified ARN.</p>
</li>
<li>
<p>
<a>ListRecordingConfigurations</a> — Gets summary information about
all recording configurations in your account, in the Amazon Web Services region where the
API request is processed.</p>
</li>
<li>
<p>
<a>DeleteRecordingConfiguration</a> — Deletes the recording
configuration for the specified ARN.</p>
</li>
</ul>
<p>
<b>Stream Endpoints</b>
</p>
<ul>
<li>
<p>
<a>GetStream</a> — Gets information about the active (live) stream on
a specified channel.</p>
</li>
<li>
<p>
<a>GetStreamSession</a> — Gets metadata on a specified stream.</p>
</li>
<li>
<p>
<a>ListStreams</a> — Gets summary information about live streams in
your account, in the Amazon Web Services region where the API request is processed.</p>
</li>
<li>
<p>
<a>ListStreamSessions</a> — Gets a summary of current and previous
streams for a specified channel in your account, in the AWS region where the API request
is processed.</p>
</li>
<li>
<p>
<a>StopStream</a> — Disconnects the incoming RTMPS stream for the
specified channel. Can be used in conjunction with <a>DeleteStreamKey</a> to
prevent further streaming to a channel.</p>
</li>
<li>
<p>
<a>PutMetadata</a> — Inserts metadata into the active stream of the
specified channel. At most 5 requests per second per channel are allowed, each with a
maximum 1 KB payload. (If 5 TPS is not sufficient for your needs, we recommend batching
your data into a single PutMetadata call.) At most 155 requests per second per account are
allowed.</p>
</li>
</ul>
<p>
<b>Stream Key Endpoints</b>
</p>
<ul>
<li>
<p>
<a>CreateStreamKey</a> — Creates a stream key, used to initiate a
stream, for the specified channel ARN.</p>
</li>
<li>
<p>
<a>GetStreamKey</a> — Gets stream key information for the specified
ARN.</p>
</li>
<li>
<p>
<a>BatchGetStreamKey</a> — Performs <a>GetStreamKey</a> on
multiple ARNs simultaneously.</p>
</li>
<li>
<p>
<a>ListStreamKeys</a> — Gets summary information about stream keys
for the specified channel.</p>
</li>
<li>
<p>
<a>DeleteStreamKey</a> — Deletes the stream key for the specified
ARN, so it can no longer be used to stream.</p>
</li>
</ul>
<p>
<b>Amazon Web Services Tags Endpoints</b>
</p>
<ul>
<li>
<p>
<a>TagResource</a> — Adds or updates tags for the Amazon Web Services
resource with the specified ARN.</p>
</li>
<li>
<p>
<a>UntagResource</a> — Removes tags from the resource with the
specified ARN.</p>
</li>
<li>
<p>
<a>ListTagsForResource</a> — Gets information about Amazon Web Services tags for the specified ARN.</p>
</li>
</ul>

## Installing

Expand Down
Loading

0 comments on commit e9a221e

Please sign in to comment.