aws-sdk-kinesisvideoarchivedmedia 1.43.0 → 1.44.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f121fa600be29aecc5161bbc80cd337fb337856d930ddb7661eec73b95ff82b6
-  data.tar.gz: 2615f9b8eb28ae29117f37ca6f3cda93ffff15d57775917d611ad75d86afceda
+  metadata.gz: a4bb3b405b3992492f228b38dbc2fb69ab1b3439f8e778f7071f9b85afd89b34
+  data.tar.gz: 766738022d303884128e501c15e6a2d08bdc3ab4c794cdf4a160f11a94c4e141
 SHA512:
-  metadata.gz: 6abe37832e18638f1d8e464e929e90c0ac09756e484ec1066c507a4127fb755acd197269cfc8ad3ef389c73a29dd959655bc3553d9da2aad023d79277cca9663
-  data.tar.gz: 6e45e26ea82915c8aab4cfa65715b432b71f3affa398eea73d67afc13deb037314a2024857f72eb4576f9e71752138aa333845ef5a065c57d99e815e96ed23f2
+  metadata.gz: 6f90d2c66a7de9420424e18b6e95d89dcb44b3eacacb57425bffa6b79c77fb3c05cde5fa8e88e0f98ebbc2c60d126f5e742f1425791acdb561ef907a4ea95169
+  data.tar.gz: d49e2d0e5cbd55f61e81f7ed008fff9ce0e76c9a735f38aac1c91bdc333d47c205cab3d8a9abf80915391f92d54f76366504da343aad5c691d28a4fb9c8110df

data/CHANGELOG.md

@@ -1,6 +1,11 @@
 Unreleased Changes
 ------------------
 
+1.44.0 (2022-05-03)
+------------------
+
+* Feature - Add support for GetImages API  for retrieving images from a video stream
+
 1.43.0 (2022-02-24)
 ------------------
 

data/VERSION

@@ -1 +1 @@
-1.43.0
+1.44.0

data/lib/aws-sdk-kinesisvideoarchivedmedia/client.rb

@@ -1155,6 +1155,129 @@ module Aws::KinesisVideoArchivedMedia
       req.send_request(options)
     end
 
+    # Retrieves a list of Images corresponding to each timestamp for a given
+    # time range, sampling interval, and image format configuration.
+    #
+    # @option params [String] :stream_name
+    #   The name of the stream from which to retrieve the images. You must
+    #   specify either the `StreamName` or the `StreamARN`.
+    #
+    # @option params [String] :stream_arn
+    #   The Amazon Resource Name (ARN) of the stream from which to retrieve
+    #   the images. You must specify either the `StreamName` or the
+    #   `StreamARN`.
+    #
+    # @option params [required, String] :image_selector_type
+    #   The origin of the Server or Producer timestamps to use to generate the
+    #   images.
+    #
+    # @option params [required, Time,DateTime,Date,Integer,String] :start_timestamp
+    #   The starting point from which the images should be generated. This
+    #   `StartTimestamp` must be within an inclusive range of timestamps for
+    #   an image to be returned.
+    #
+    # @option params [required, Time,DateTime,Date,Integer,String] :end_timestamp
+    #   The end timestamp for the range of images to be generated.
+    #
+    # @option params [required, Integer] :sampling_interval
+    #   The time interval in milliseconds (ms) at which the images need to be
+    #   generated from the stream. The minimum value that can be provided is
+    #   3000 ms. If the timestamp range is less than the sampling interval,
+    #   the Image from the `startTimestamp` will be returned if available.
+    #
+    #   <note markdown="1"> The minimum value of 3000 ms is a soft limit. If needed, a lower
+    #   sampling frequency can be requested.
+    #
+    #    </note>
+    #
+    # @option params [required, String] :format
+    #   The format that will be used to encode the image.
+    #
+    # @option params [Hash<String,String>] :format_config
+    #   The list of a key-value pair structure that contains extra parameters
+    #   that can be applied when the image is generated. The `FormatConfig`
+    #   key is the `JPEGQuality`, which indicates the JPEG quality key to be
+    #   used to generate the image. The `FormatConfig` value accepts ints from
+    #   1 to 100. If the value is 1, the image will be generated with less
+    #   quality and the best compression. If the value is 100, the image will
+    #   be generated with the best quality and less compression. If no value
+    #   is provided, the default value of the `JPEGQuality` key will be set to
+    #   80.
+    #
+    # @option params [Integer] :width_pixels
+    #   The width of the output image that is used in conjunction with the
+    #   `HeightPixels` parameter. When both `WidthPixels` and `HeightPixels`
+    #   parameters are provided, the image will be stretched to fit the
+    #   specified aspect ratio. If only the `WidthPixels` parameter is
+    #   provided or if only the `HeightPixels` is provided, a
+    #   `ValidationException` will be thrown. If neither parameter is
+    #   provided, the original image size from the stream will be returned.
+    #
+    # @option params [Integer] :height_pixels
+    #   The height of the output image that is used in conjunction with the
+    #   `WidthPixels` parameter. When both `HeightPixels` and `WidthPixels`
+    #   parameters are provided, the image will be stretched to fit the
+    #   specified aspect ratio. If only the `HeightPixels` parameter is
+    #   provided, its original aspect ratio will be used to calculate the
+    #   `WidthPixels` ratio. If neither parameter is provided, the original
+    #   image size will be returned.
+    #
+    # @option params [Integer] :max_results
+    #   The maximum number of images to be returned by the API.
+    #
+    #   <note markdown="1"> The default limit is 100 images per API response. The additional
+    #   results will be paginated.
+    #
+    #    </note>
+    #
+    # @option params [String] :next_token
+    #   A token that specifies where to start paginating the next set of
+    #   Images. This is the `GetImages:NextToken` from a previously truncated
+    #   response.
+    #
+    # @return [Types::GetImagesOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
+    #
+    #   * {Types::GetImagesOutput#images #images} => Array&lt;Types::Image&gt;
+    #   * {Types::GetImagesOutput#next_token #next_token} => String
+    #
+    # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
+    #
+    # @example Request syntax with placeholder values
+    #
+    #   resp = client.get_images({
+    #     stream_name: "StreamName",
+    #     stream_arn: "ResourceARN",
+    #     image_selector_type: "PRODUCER_TIMESTAMP", # required, accepts PRODUCER_TIMESTAMP, SERVER_TIMESTAMP
+    #     start_timestamp: Time.now, # required
+    #     end_timestamp: Time.now, # required
+    #     sampling_interval: 1, # required
+    #     format: "JPEG", # required, accepts JPEG, PNG
+    #     format_config: {
+    #       "JPEGQuality" => "FormatConfigValue",
+    #     },
+    #     width_pixels: 1,
+    #     height_pixels: 1,
+    #     max_results: 1,
+    #     next_token: "NextToken",
+    #   })
+    #
+    # @example Response structure
+    #
+    #   resp.images #=> Array
+    #   resp.images[0].time_stamp #=> Time
+    #   resp.images[0].error #=> String, one of "NO_MEDIA", "MEDIA_ERROR"
+    #   resp.images[0].image_content #=> String
+    #   resp.next_token #=> String
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/kinesis-video-archived-media-2017-09-30/GetImages AWS API Documentation
+    #
+    # @overload get_images(params = {})
+    # @param [Hash] params ({})
+    def get_images(params = {}, options = {})
+      req = build_request(:get_images, params)
+      req.send_request(options)
+    end
+
     # Gets media for a list of fragments (specified by fragment number) from
     # the archived data in an Amazon Kinesis video stream.
     #
@@ -1352,7 +1475,7 @@ module Aws::KinesisVideoArchivedMedia
         params: params,
         config: config)
       context[:gem_name] = 'aws-sdk-kinesisvideoarchivedmedia'
-      context[:gem_version] = '1.43.0'
+      context[:gem_version] = '1.44.0'
       Seahorse::Client::Request.new(handlers, context)
     end
 

data/lib/aws-sdk-kinesisvideoarchivedmedia/client_api.rb

@@ -29,6 +29,10 @@ module Aws::KinesisVideoArchivedMedia
     DASHTimestampRange = Shapes::StructureShape.new(name: 'DASHTimestampRange')
     ErrorMessage = Shapes::StringShape.new(name: 'ErrorMessage')
     Expires = Shapes::IntegerShape.new(name: 'Expires')
+    Format = Shapes::StringShape.new(name: 'Format')
+    FormatConfig = Shapes::MapShape.new(name: 'FormatConfig')
+    FormatConfigKey = Shapes::StringShape.new(name: 'FormatConfigKey')
+    FormatConfigValue = Shapes::StringShape.new(name: 'FormatConfigValue')
     Fragment = Shapes::StructureShape.new(name: 'Fragment')
     FragmentList = Shapes::ListShape.new(name: 'FragmentList')
     FragmentNumberList = Shapes::ListShape.new(name: 'FragmentNumberList')
@@ -41,6 +45,9 @@ module Aws::KinesisVideoArchivedMedia
     GetDASHStreamingSessionURLOutput = Shapes::StructureShape.new(name: 'GetDASHStreamingSessionURLOutput')
     GetHLSStreamingSessionURLInput = Shapes::StructureShape.new(name: 'GetHLSStreamingSessionURLInput')
     GetHLSStreamingSessionURLOutput = Shapes::StructureShape.new(name: 'GetHLSStreamingSessionURLOutput')
+    GetImagesInput = Shapes::StructureShape.new(name: 'GetImagesInput')
+    GetImagesMaxResults = Shapes::IntegerShape.new(name: 'GetImagesMaxResults')
+    GetImagesOutput = Shapes::StructureShape.new(name: 'GetImagesOutput')
     GetMediaForFragmentListInput = Shapes::StructureShape.new(name: 'GetMediaForFragmentListInput')
     GetMediaForFragmentListOutput = Shapes::StructureShape.new(name: 'GetMediaForFragmentListOutput')
     HLSDiscontinuityMode = Shapes::StringShape.new(name: 'HLSDiscontinuityMode')
@@ -51,6 +58,12 @@ module Aws::KinesisVideoArchivedMedia
     HLSPlaybackMode = Shapes::StringShape.new(name: 'HLSPlaybackMode')
     HLSStreamingSessionURL = Shapes::StringShape.new(name: 'HLSStreamingSessionURL')
     HLSTimestampRange = Shapes::StructureShape.new(name: 'HLSTimestampRange')
+    HeightPixels = Shapes::IntegerShape.new(name: 'HeightPixels')
+    Image = Shapes::StructureShape.new(name: 'Image')
+    ImageContent = Shapes::StringShape.new(name: 'ImageContent')
+    ImageError = Shapes::StringShape.new(name: 'ImageError')
+    ImageSelectorType = Shapes::StringShape.new(name: 'ImageSelectorType')
+    Images = Shapes::ListShape.new(name: 'Images')
     InvalidArgumentException = Shapes::StructureShape.new(name: 'InvalidArgumentException')
     InvalidCodecPrivateDataException = Shapes::StructureShape.new(name: 'InvalidCodecPrivateDataException')
     InvalidMediaFrameException = Shapes::StructureShape.new(name: 'InvalidMediaFrameException')
@@ -65,10 +78,12 @@ module Aws::KinesisVideoArchivedMedia
     Payload = Shapes::BlobShape.new(name: 'Payload', streaming: true)
     ResourceARN = Shapes::StringShape.new(name: 'ResourceARN')
     ResourceNotFoundException = Shapes::StructureShape.new(name: 'ResourceNotFoundException')
+    SamplingInterval = Shapes::IntegerShape.new(name: 'SamplingInterval')
     StreamName = Shapes::StringShape.new(name: 'StreamName')
     Timestamp = Shapes::TimestampShape.new(name: 'Timestamp')
     TimestampRange = Shapes::StructureShape.new(name: 'TimestampRange')
     UnsupportedStreamMediaTypeException = Shapes::StructureShape.new(name: 'UnsupportedStreamMediaTypeException')
+    WidthPixels = Shapes::IntegerShape.new(name: 'WidthPixels')
 
     ClientLimitExceededException.add_member(:message, Shapes::ShapeRef.new(shape: ErrorMessage, location_name: "Message"))
     ClientLimitExceededException.struct_class = Types::ClientLimitExceededException
@@ -89,6 +104,9 @@ module Aws::KinesisVideoArchivedMedia
     DASHTimestampRange.add_member(:end_timestamp, Shapes::ShapeRef.new(shape: Timestamp, location_name: "EndTimestamp"))
     DASHTimestampRange.struct_class = Types::DASHTimestampRange
 
+    FormatConfig.key = Shapes::ShapeRef.new(shape: FormatConfigKey)
+    FormatConfig.value = Shapes::ShapeRef.new(shape: FormatConfigValue)
+
     Fragment.add_member(:fragment_number, Shapes::ShapeRef.new(shape: FragmentNumberString, location_name: "FragmentNumber"))
     Fragment.add_member(:fragment_size_in_bytes, Shapes::ShapeRef.new(shape: Long, location_name: "FragmentSizeInBytes"))
     Fragment.add_member(:producer_timestamp, Shapes::ShapeRef.new(shape: Timestamp, location_name: "ProducerTimestamp"))
@@ -142,6 +160,24 @@ module Aws::KinesisVideoArchivedMedia
     GetHLSStreamingSessionURLOutput.add_member(:hls_streaming_session_url, Shapes::ShapeRef.new(shape: HLSStreamingSessionURL, location_name: "HLSStreamingSessionURL"))
     GetHLSStreamingSessionURLOutput.struct_class = Types::GetHLSStreamingSessionURLOutput
 
+    GetImagesInput.add_member(:stream_name, Shapes::ShapeRef.new(shape: StreamName, location_name: "StreamName"))
+    GetImagesInput.add_member(:stream_arn, Shapes::ShapeRef.new(shape: ResourceARN, location_name: "StreamARN"))
+    GetImagesInput.add_member(:image_selector_type, Shapes::ShapeRef.new(shape: ImageSelectorType, required: true, location_name: "ImageSelectorType"))
+    GetImagesInput.add_member(:start_timestamp, Shapes::ShapeRef.new(shape: Timestamp, required: true, location_name: "StartTimestamp"))
+    GetImagesInput.add_member(:end_timestamp, Shapes::ShapeRef.new(shape: Timestamp, required: true, location_name: "EndTimestamp"))
+    GetImagesInput.add_member(:sampling_interval, Shapes::ShapeRef.new(shape: SamplingInterval, required: true, location_name: "SamplingInterval"))
+    GetImagesInput.add_member(:format, Shapes::ShapeRef.new(shape: Format, required: true, location_name: "Format"))
+    GetImagesInput.add_member(:format_config, Shapes::ShapeRef.new(shape: FormatConfig, location_name: "FormatConfig"))
+    GetImagesInput.add_member(:width_pixels, Shapes::ShapeRef.new(shape: WidthPixels, location_name: "WidthPixels"))
+    GetImagesInput.add_member(:height_pixels, Shapes::ShapeRef.new(shape: HeightPixels, location_name: "HeightPixels"))
+    GetImagesInput.add_member(:max_results, Shapes::ShapeRef.new(shape: GetImagesMaxResults, location_name: "MaxResults"))
+    GetImagesInput.add_member(:next_token, Shapes::ShapeRef.new(shape: NextToken, location_name: "NextToken"))
+    GetImagesInput.struct_class = Types::GetImagesInput
+
+    GetImagesOutput.add_member(:images, Shapes::ShapeRef.new(shape: Images, location_name: "Images"))
+    GetImagesOutput.add_member(:next_token, Shapes::ShapeRef.new(shape: NextToken, location_name: "NextToken"))
+    GetImagesOutput.struct_class = Types::GetImagesOutput
+
     GetMediaForFragmentListInput.add_member(:stream_name, Shapes::ShapeRef.new(shape: StreamName, location_name: "StreamName"))
     GetMediaForFragmentListInput.add_member(:stream_arn, Shapes::ShapeRef.new(shape: ResourceARN, location_name: "StreamARN"))
     GetMediaForFragmentListInput.add_member(:fragments, Shapes::ShapeRef.new(shape: FragmentNumberList, required: true, location_name: "Fragments"))
@@ -161,6 +197,13 @@ module Aws::KinesisVideoArchivedMedia
     HLSTimestampRange.add_member(:end_timestamp, Shapes::ShapeRef.new(shape: Timestamp, location_name: "EndTimestamp"))
     HLSTimestampRange.struct_class = Types::HLSTimestampRange
 
+    Image.add_member(:time_stamp, Shapes::ShapeRef.new(shape: Timestamp, location_name: "TimeStamp"))
+    Image.add_member(:error, Shapes::ShapeRef.new(shape: ImageError, location_name: "Error"))
+    Image.add_member(:image_content, Shapes::ShapeRef.new(shape: ImageContent, location_name: "ImageContent"))
+    Image.struct_class = Types::Image
+
+    Images.member = Shapes::ShapeRef.new(shape: Image)
+
     InvalidArgumentException.add_member(:message, Shapes::ShapeRef.new(shape: ErrorMessage, location_name: "Message"))
     InvalidArgumentException.struct_class = Types::InvalidArgumentException
 
@@ -266,6 +309,24 @@ module Aws::KinesisVideoArchivedMedia
         o.errors << Shapes::ShapeRef.new(shape: InvalidCodecPrivateDataException)
       end)
 
+      api.add_operation(:get_images, Seahorse::Model::Operation.new.tap do |o|
+        o.name = "GetImages"
+        o.http_method = "POST"
+        o.http_request_uri = "/getImages"
+        o.input = Shapes::ShapeRef.new(shape: GetImagesInput)
+        o.output = Shapes::ShapeRef.new(shape: GetImagesOutput)
+        o.errors << Shapes::ShapeRef.new(shape: ResourceNotFoundException)
+        o.errors << Shapes::ShapeRef.new(shape: InvalidArgumentException)
+        o.errors << Shapes::ShapeRef.new(shape: ClientLimitExceededException)
+        o.errors << Shapes::ShapeRef.new(shape: NotAuthorizedException)
+        o[:pager] = Aws::Pager.new(
+          limit_key: "max_results",
+          tokens: {
+            "next_token" => "next_token"
+          }
+        )
+      end)
+
       api.add_operation(:get_media_for_fragment_list, Seahorse::Model::Operation.new.tap do |o|
         o.name = "GetMediaForFragmentList"
         o.http_method = "POST"

data/lib/aws-sdk-kinesisvideoarchivedmedia/types.rb

@@ -826,6 +826,156 @@ module Aws::KinesisVideoArchivedMedia
       include Aws::Structure
     end
 
+    # @note When making an API call, you may pass GetImagesInput
+    #   data as a hash:
+    #
+    #       {
+    #         stream_name: "StreamName",
+    #         stream_arn: "ResourceARN",
+    #         image_selector_type: "PRODUCER_TIMESTAMP", # required, accepts PRODUCER_TIMESTAMP, SERVER_TIMESTAMP
+    #         start_timestamp: Time.now, # required
+    #         end_timestamp: Time.now, # required
+    #         sampling_interval: 1, # required
+    #         format: "JPEG", # required, accepts JPEG, PNG
+    #         format_config: {
+    #           "JPEGQuality" => "FormatConfigValue",
+    #         },
+    #         width_pixels: 1,
+    #         height_pixels: 1,
+    #         max_results: 1,
+    #         next_token: "NextToken",
+    #       }
+    #
+    # @!attribute [rw] stream_name
+    #   The name of the stream from which to retrieve the images. You must
+    #   specify either the `StreamName` or the `StreamARN`.
+    #   @return [String]
+    #
+    # @!attribute [rw] stream_arn
+    #   The Amazon Resource Name (ARN) of the stream from which to retrieve
+    #   the images. You must specify either the `StreamName` or the
+    #   `StreamARN`.
+    #   @return [String]
+    #
+    # @!attribute [rw] image_selector_type
+    #   The origin of the Server or Producer timestamps to use to generate
+    #   the images.
+    #   @return [String]
+    #
+    # @!attribute [rw] start_timestamp
+    #   The starting point from which the images should be generated. This
+    #   `StartTimestamp` must be within an inclusive range of timestamps for
+    #   an image to be returned.
+    #   @return [Time]
+    #
+    # @!attribute [rw] end_timestamp
+    #   The end timestamp for the range of images to be generated.
+    #   @return [Time]
+    #
+    # @!attribute [rw] sampling_interval
+    #   The time interval in milliseconds (ms) at which the images need to
+    #   be generated from the stream. The minimum value that can be provided
+    #   is 3000 ms. If the timestamp range is less than the sampling
+    #   interval, the Image from the `startTimestamp` will be returned if
+    #   available.
+    #
+    #   <note markdown="1"> The minimum value of 3000 ms is a soft limit. If needed, a lower
+    #   sampling frequency can be requested.
+    #
+    #    </note>
+    #   @return [Integer]
+    #
+    # @!attribute [rw] format
+    #   The format that will be used to encode the image.
+    #   @return [String]
+    #
+    # @!attribute [rw] format_config
+    #   The list of a key-value pair structure that contains extra
+    #   parameters that can be applied when the image is generated. The
+    #   `FormatConfig` key is the `JPEGQuality`, which indicates the JPEG
+    #   quality key to be used to generate the image. The `FormatConfig`
+    #   value accepts ints from 1 to 100. If the value is 1, the image will
+    #   be generated with less quality and the best compression. If the
+    #   value is 100, the image will be generated with the best quality and
+    #   less compression. If no value is provided, the default value of the
+    #   `JPEGQuality` key will be set to 80.
+    #   @return [Hash<String,String>]
+    #
+    # @!attribute [rw] width_pixels
+    #   The width of the output image that is used in conjunction with the
+    #   `HeightPixels` parameter. When both `WidthPixels` and `HeightPixels`
+    #   parameters are provided, the image will be stretched to fit the
+    #   specified aspect ratio. If only the `WidthPixels` parameter is
+    #   provided or if only the `HeightPixels` is provided, a
+    #   `ValidationException` will be thrown. If neither parameter is
+    #   provided, the original image size from the stream will be returned.
+    #   @return [Integer]
+    #
+    # @!attribute [rw] height_pixels
+    #   The height of the output image that is used in conjunction with the
+    #   `WidthPixels` parameter. When both `HeightPixels` and `WidthPixels`
+    #   parameters are provided, the image will be stretched to fit the
+    #   specified aspect ratio. If only the `HeightPixels` parameter is
+    #   provided, its original aspect ratio will be used to calculate the
+    #   `WidthPixels` ratio. If neither parameter is provided, the original
+    #   image size will be returned.
+    #   @return [Integer]
+    #
+    # @!attribute [rw] max_results
+    #   The maximum number of images to be returned by the API.
+    #
+    #   <note markdown="1"> The default limit is 100 images per API response. The additional
+    #   results will be paginated.
+    #
+    #    </note>
+    #   @return [Integer]
+    #
+    # @!attribute [rw] next_token
+    #   A token that specifies where to start paginating the next set of
+    #   Images. This is the `GetImages:NextToken` from a previously
+    #   truncated response.
+    #   @return [String]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/kinesis-video-archived-media-2017-09-30/GetImagesInput AWS API Documentation
+    #
+    class GetImagesInput < Struct.new(
+      :stream_name,
+      :stream_arn,
+      :image_selector_type,
+      :start_timestamp,
+      :end_timestamp,
+      :sampling_interval,
+      :format,
+      :format_config,
+      :width_pixels,
+      :height_pixels,
+      :max_results,
+      :next_token)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
+    # @!attribute [rw] images
+    #   The list of images generated from the video stream. If there is no
+    #   media available for the given timestamp, the `NO_MEDIA` error will
+    #   be listed in the output. If an error occurs while the image is being
+    #   generated, the `MEDIA_ERROR` will be listed in the output as the
+    #   cause of the missing image.
+    #   @return [Array<Types::Image>]
+    #
+    # @!attribute [rw] next_token
+    #   The encrypted token that was used in the request to get more images.
+    #   @return [String]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/kinesis-video-archived-media-2017-09-30/GetImagesOutput AWS API Documentation
+    #
+    class GetImagesOutput < Struct.new(
+      :images,
+      :next_token)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
     # @note When making an API call, you may pass GetMediaForFragmentListInput
     #   data as a hash:
     #
@@ -1022,6 +1172,46 @@ module Aws::KinesisVideoArchivedMedia
       include Aws::Structure
     end
 
+    # A structure that contains the `Timestamp`, `Error`, and
+    # `ImageContent`.
+    #
+    # @!attribute [rw] time_stamp
+    #   An attribute of the `Image` object that is used to extract an image
+    #   from the video stream. This field is used to manage gaps on images
+    #   or to better understand the pagination window.
+    #   @return [Time]
+    #
+    # @!attribute [rw] error
+    #   The error message shown when the image for the provided timestamp
+    #   was not extracted due to a non-tryable error. An error will be
+    #   returned if:
+    #
+    #   * There is no media that exists for the specified `Timestamp`.
+    #
+    #   ^
+    #   ^
+    #
+    #   * The media for the specified time does not allow an image to be
+    #     extracted. In this case the media is audio only, or the incorrect
+    #     media has been ingested.
+    #
+    #   ^
+    #   @return [String]
+    #
+    # @!attribute [rw] image_content
+    #   An attribute of the `Image` object that is Base64 encoded.
+    #   @return [String]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/kinesis-video-archived-media-2017-09-30/Image AWS API Documentation
+    #
+    class Image < Struct.new(
+      :time_stamp,
+      :error,
+      :image_content)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
     # A specified parameter exceeds its restrictions, is not supported, or
     # can't be used.
     #

data/lib/aws-sdk-kinesisvideoarchivedmedia.rb

@@ -48,6 +48,6 @@ require_relative 'aws-sdk-kinesisvideoarchivedmedia/customizations'
 # @!group service
 module Aws::KinesisVideoArchivedMedia
 
-  GEM_VERSION = '1.43.0'
+  GEM_VERSION = '1.44.0'
 
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: aws-sdk-kinesisvideoarchivedmedia
 version: !ruby/object:Gem::Version
-  version: 1.43.0
+  version: 1.44.0
 platform: ruby
 authors:
 - Amazon Web Services
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-02-24 00:00:00.000000000 Z
+date: 2022-05-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk-core