lib/aws-sdk-kinesisvideoarchivedmedia/client.rb in aws-sdk-kinesisvideoarchivedmedia-1.31.0 vs lib/aws-sdk-kinesisvideoarchivedmedia/client.rb in aws-sdk-kinesisvideoarchivedmedia-1.32.0
- old
+ new
@@ -445,14 +445,14 @@
# protocol. `GetDASHStreamingSessionURL` returns an authenticated
# URL (that includes an encrypted session token) for the session's
# MPEG-DASH *manifest* (the root resource needed for streaming with
# MPEG-DASH).
#
- # <note markdown="1"> Don't share or store this token where an unauthorized entity
- # could access it. The token provides access to the content of the
- # stream. Safeguard the token with the same measures that you would
- # use with your AWS credentials.
+ # <note markdown="1"> Don't share or store this token where an unauthorized entity can
+ # access it. The token provides access to the content of the stream.
+ # Safeguard the token with the same measures that you use with your
+ # AWS credentials.
#
# </note>
#
# The media that is made available through the manifest consists
# only of the requested stream, time range, and format. No other
@@ -502,30 +502,13 @@
# </note>
#
# Data retrieved with this action is billable. See [Pricing][6]
# for details.
#
- # <note markdown="1"> The following restrictions apply to MPEG-DASH sessions:
+ # <note markdown="1"> For restrictions that apply to MPEG-DASH sessions, see [Kinesis Video
+ # Streams Limits][7].
#
- # * A streaming session URL should not be shared between players. The
- # service might throttle a session if multiple media players are
- # sharing it. For connection limits, see [Kinesis Video Streams
- # Limits][7].
- #
- # * A Kinesis video stream can have a maximum of ten active MPEG-DASH
- # streaming sessions. If a new session is created when the maximum
- # number of sessions is already active, the oldest (earliest created)
- # session is closed. The number of active `GetMedia` connections on a
- # Kinesis video stream does not count against this limit, and the
- # number of active MPEG-DASH sessions does not count against the
- # active `GetMedia` connection limit.
- #
- # <note markdown="1"> The maximum limits for active HLS and MPEG-DASH streaming sessions
- # are independent of each other.
- #
- # </note>
- #
# </note>
#
# You can monitor the amount of data that the media player consumes by
# monitoring the `GetMP4MediaFragment.OutgoingBytes` Amazon CloudWatch
# metric. For information about using CloudWatch to monitor Kinesis
@@ -622,12 +605,12 @@
# is also useful to stream previously archived media without being
# limited by the 1,000 fragment limit in the `ON_DEMAND` mode.
#
# * <b> <code>ON_DEMAND</code> </b>\: For sessions of this type, the
# MPEG-DASH manifest contains all the fragments for the session, up to
- # the number that is specified in `MaxMediaPlaylistFragmentResults`.
- # The manifest must be retrieved only once for each session. When this
+ # the number that is specified in `MaxManifestFragmentResults`. The
+ # manifest must be retrieved only once for each session. When this
# type of session is played in a media player, the user interface
# typically displays a scrubber control for choosing the position in
# the playback window to display.
#
# In all playback modes, if `FragmentSelectorType` is
@@ -880,32 +863,14 @@
# </note>
#
# Data retrieved with this action is billable. For more
# information, see [Kinesis Video Streams pricing][6].
#
- # <note markdown="1"> The following restrictions apply to HLS sessions:
+ # A streaming session URL must not be shared between players. The
+ # service might throttle a session if multiple media players are sharing
+ # it. For connection limits, see [Kinesis Video Streams Limits][7].
#
- # * A streaming session URL should not be shared between players. The
- # service might throttle a session if multiple media players are
- # sharing it. For connection limits, see [Kinesis Video Streams
- # Limits][7].
- #
- # * A Kinesis video stream can have a maximum of ten active HLS
- # streaming sessions. If a new session is created when the maximum
- # number of sessions is already active, the oldest (earliest created)
- # session is closed. The number of active `GetMedia` connections on a
- # Kinesis video stream does not count against this limit, and the
- # number of active HLS sessions does not count against the active
- # `GetMedia` connection limit.
- #
- # <note markdown="1"> The maximum limits for active HLS and MPEG-DASH streaming sessions
- # are independent of each other.
- #
- # </note>
- #
- # </note>
- #
# You can monitor the amount of data that the media player consumes by
# monitoring the `GetMP4MediaFragment.OutgoingBytes` Amazon CloudWatch
# metric. For information about using CloudWatch to monitor Kinesis
# Video Streams, see [Monitoring Kinesis Video Streams][8]. For pricing
# information, see [Amazon Kinesis Video Streams Pricing][6] and [AWS
@@ -1009,16 +974,16 @@
# typically displays a scrubber control for choosing the position in
# the playback window to display.
#
# In all playback modes, if `FragmentSelectorType` is
# `PRODUCER_TIMESTAMP`, and if there are multiple fragments with the
- # same start timestamp, the fragment that has the larger fragment number
- # (that is, the newer fragment) is included in the HLS media playlist.
- # The other fragments are not included. Fragments that have different
- # timestamps but have overlapping durations are still included in the
- # HLS media playlist. This can lead to unexpected behavior in the media
- # player.
+ # same start timestamp, the fragment that has the largest fragment
+ # number (that is, the newest fragment) is included in the HLS media
+ # playlist. The other fragments are not included. Fragments that have
+ # different timestamps but have overlapping durations are still included
+ # in the HLS media playlist. This can lead to unexpected behavior in the
+ # media player.
#
# The default is `LIVE`.
#
# @option params [Types::HLSFragmentSelector] :hls_fragment_selector
# The time range of the requested fragment and the source of the
@@ -1123,13 +1088,13 @@
# of 3 fragments and a maximum of 10 fragments.
#
# The default is 5 fragments if `PlaybackMode` is `LIVE` or
# `LIVE_REPLAY`, and 1,000 if `PlaybackMode` is `ON_DEMAND`.
#
- # The maximum value of 1,000 fragments corresponds to more than 16
- # minutes of video on streams with 1-second fragments, and more than 2
- # 1/2 hours of video on streams with 10-second fragments.
+ # The maximum value of 5,000 fragments corresponds to more than 80
+ # minutes of video on streams with 1-second fragments, and more than 13
+ # hours of video on streams with 10-second fragments.
#
# @return [Types::GetHLSStreamingSessionURLOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
#
# * {Types::GetHLSStreamingSessionURLOutput#hls_streaming_session_url #hls_streaming_session_url} => String
#
@@ -1173,20 +1138,12 @@
# send the `GetMediaForFragmentList` requests to this endpoint using the
# [--endpoint-url parameter][1].
#
# </note>
#
- # The following limits apply when using the `GetMediaForFragmentList`
- # API:
+ # For limits, see [Kinesis Video Streams Limits][2].
#
- # * A client can call `GetMediaForFragmentList` up to five times per
- # second per stream.
- #
- # * Kinesis Video Streams sends media data at a rate of up to 25
- # megabytes per second (or 200 megabits per second) during a
- # `GetMediaForFragmentList` session.
- #
# If an error is thrown after invoking a Kinesis Video Streams archived
# media API, in addition to the HTTP status code and the response body,
# it includes the following pieces of information:
#
# * `x-amz-ErrorType` HTTP header – contains a more specific error type
@@ -1202,16 +1159,17 @@
# the client programmer might need to take in order to successfully try
# again.
#
# For more information, see the **Errors** section at the bottom of
# this
- # topic, as well as [Common Errors][2].
+ # topic, as well as [Common Errors][3].
#
#
#
# [1]: https://docs.aws.amazon.com/cli/latest/reference/
- # [2]: https://docs.aws.amazon.com/kinesisvideostreams/latest/dg/CommonErrors.html
+ # [2]: http://docs.aws.amazon.com/kinesisvideostreams/latest/dg/limits.html
+ # [3]: https://docs.aws.amazon.com/kinesisvideostreams/latest/dg/CommonErrors.html
#
# @option params [String] :stream_name
# The name of the stream from which to retrieve fragment media. Specify
# either this parameter or the `StreamARN` parameter.
#
@@ -1368,10 +1326,10 @@
operation: config.api.operation(operation_name),
client: self,
params: params,
config: config)
context[:gem_name] = 'aws-sdk-kinesisvideoarchivedmedia'
- context[:gem_version] = '1.31.0'
+ context[:gem_version] = '1.32.0'
Seahorse::Client::Request.new(handlers, context)
end
# @api private
# @deprecated