aws-sdk-kinesisvideoarchivedmedia 1.43.0 → 1.44.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/CHANGELOG.md +5 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-kinesisvideoarchivedmedia/client.rb +124 -1
- data/lib/aws-sdk-kinesisvideoarchivedmedia/client_api.rb +61 -0
- data/lib/aws-sdk-kinesisvideoarchivedmedia/types.rb +190 -0
- data/lib/aws-sdk-kinesisvideoarchivedmedia.rb +1 -1
- metadata +2 -2
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: a4bb3b405b3992492f228b38dbc2fb69ab1b3439f8e778f7071f9b85afd89b34
|
4
|
+
data.tar.gz: 766738022d303884128e501c15e6a2d08bdc3ab4c794cdf4a160f11a94c4e141
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 6f90d2c66a7de9420424e18b6e95d89dcb44b3eacacb57425bffa6b79c77fb3c05cde5fa8e88e0f98ebbc2c60d126f5e742f1425791acdb561ef907a4ea95169
|
7
|
+
data.tar.gz: d49e2d0e5cbd55f61e81f7ed008fff9ce0e76c9a735f38aac1c91bdc333d47c205cab3d8a9abf80915391f92d54f76366504da343aad5c691d28a4fb9c8110df
|
data/CHANGELOG.md
CHANGED
data/VERSION
CHANGED
@@ -1 +1 @@
|
|
1
|
-
1.
|
1
|
+
1.44.0
|
@@ -1155,6 +1155,129 @@ module Aws::KinesisVideoArchivedMedia
|
|
1155
1155
|
req.send_request(options)
|
1156
1156
|
end
|
1157
1157
|
|
1158
|
+
# Retrieves a list of Images corresponding to each timestamp for a given
|
1159
|
+
# time range, sampling interval, and image format configuration.
|
1160
|
+
#
|
1161
|
+
# @option params [String] :stream_name
|
1162
|
+
# The name of the stream from which to retrieve the images. You must
|
1163
|
+
# specify either the `StreamName` or the `StreamARN`.
|
1164
|
+
#
|
1165
|
+
# @option params [String] :stream_arn
|
1166
|
+
# The Amazon Resource Name (ARN) of the stream from which to retrieve
|
1167
|
+
# the images. You must specify either the `StreamName` or the
|
1168
|
+
# `StreamARN`.
|
1169
|
+
#
|
1170
|
+
# @option params [required, String] :image_selector_type
|
1171
|
+
# The origin of the Server or Producer timestamps to use to generate the
|
1172
|
+
# images.
|
1173
|
+
#
|
1174
|
+
# @option params [required, Time,DateTime,Date,Integer,String] :start_timestamp
|
1175
|
+
# The starting point from which the images should be generated. This
|
1176
|
+
# `StartTimestamp` must be within an inclusive range of timestamps for
|
1177
|
+
# an image to be returned.
|
1178
|
+
#
|
1179
|
+
# @option params [required, Time,DateTime,Date,Integer,String] :end_timestamp
|
1180
|
+
# The end timestamp for the range of images to be generated.
|
1181
|
+
#
|
1182
|
+
# @option params [required, Integer] :sampling_interval
|
1183
|
+
# The time interval in milliseconds (ms) at which the images need to be
|
1184
|
+
# generated from the stream. The minimum value that can be provided is
|
1185
|
+
# 3000 ms. If the timestamp range is less than the sampling interval,
|
1186
|
+
# the Image from the `startTimestamp` will be returned if available.
|
1187
|
+
#
|
1188
|
+
# <note markdown="1"> The minimum value of 3000 ms is a soft limit. If needed, a lower
|
1189
|
+
# sampling frequency can be requested.
|
1190
|
+
#
|
1191
|
+
# </note>
|
1192
|
+
#
|
1193
|
+
# @option params [required, String] :format
|
1194
|
+
# The format that will be used to encode the image.
|
1195
|
+
#
|
1196
|
+
# @option params [Hash<String,String>] :format_config
|
1197
|
+
# The list of a key-value pair structure that contains extra parameters
|
1198
|
+
# that can be applied when the image is generated. The `FormatConfig`
|
1199
|
+
# key is the `JPEGQuality`, which indicates the JPEG quality key to be
|
1200
|
+
# used to generate the image. The `FormatConfig` value accepts ints from
|
1201
|
+
# 1 to 100. If the value is 1, the image will be generated with less
|
1202
|
+
# quality and the best compression. If the value is 100, the image will
|
1203
|
+
# be generated with the best quality and less compression. If no value
|
1204
|
+
# is provided, the default value of the `JPEGQuality` key will be set to
|
1205
|
+
# 80.
|
1206
|
+
#
|
1207
|
+
# @option params [Integer] :width_pixels
|
1208
|
+
# The width of the output image that is used in conjunction with the
|
1209
|
+
# `HeightPixels` parameter. When both `WidthPixels` and `HeightPixels`
|
1210
|
+
# parameters are provided, the image will be stretched to fit the
|
1211
|
+
# specified aspect ratio. If only the `WidthPixels` parameter is
|
1212
|
+
# provided or if only the `HeightPixels` is provided, a
|
1213
|
+
# `ValidationException` will be thrown. If neither parameter is
|
1214
|
+
# provided, the original image size from the stream will be returned.
|
1215
|
+
#
|
1216
|
+
# @option params [Integer] :height_pixels
|
1217
|
+
# The height of the output image that is used in conjunction with the
|
1218
|
+
# `WidthPixels` parameter. When both `HeightPixels` and `WidthPixels`
|
1219
|
+
# parameters are provided, the image will be stretched to fit the
|
1220
|
+
# specified aspect ratio. If only the `HeightPixels` parameter is
|
1221
|
+
# provided, its original aspect ratio will be used to calculate the
|
1222
|
+
# `WidthPixels` ratio. If neither parameter is provided, the original
|
1223
|
+
# image size will be returned.
|
1224
|
+
#
|
1225
|
+
# @option params [Integer] :max_results
|
1226
|
+
# The maximum number of images to be returned by the API.
|
1227
|
+
#
|
1228
|
+
# <note markdown="1"> The default limit is 100 images per API response. The additional
|
1229
|
+
# results will be paginated.
|
1230
|
+
#
|
1231
|
+
# </note>
|
1232
|
+
#
|
1233
|
+
# @option params [String] :next_token
|
1234
|
+
# A token that specifies where to start paginating the next set of
|
1235
|
+
# Images. This is the `GetImages:NextToken` from a previously truncated
|
1236
|
+
# response.
|
1237
|
+
#
|
1238
|
+
# @return [Types::GetImagesOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1239
|
+
#
|
1240
|
+
# * {Types::GetImagesOutput#images #images} => Array<Types::Image>
|
1241
|
+
# * {Types::GetImagesOutput#next_token #next_token} => String
|
1242
|
+
#
|
1243
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
1244
|
+
#
|
1245
|
+
# @example Request syntax with placeholder values
|
1246
|
+
#
|
1247
|
+
# resp = client.get_images({
|
1248
|
+
# stream_name: "StreamName",
|
1249
|
+
# stream_arn: "ResourceARN",
|
1250
|
+
# image_selector_type: "PRODUCER_TIMESTAMP", # required, accepts PRODUCER_TIMESTAMP, SERVER_TIMESTAMP
|
1251
|
+
# start_timestamp: Time.now, # required
|
1252
|
+
# end_timestamp: Time.now, # required
|
1253
|
+
# sampling_interval: 1, # required
|
1254
|
+
# format: "JPEG", # required, accepts JPEG, PNG
|
1255
|
+
# format_config: {
|
1256
|
+
# "JPEGQuality" => "FormatConfigValue",
|
1257
|
+
# },
|
1258
|
+
# width_pixels: 1,
|
1259
|
+
# height_pixels: 1,
|
1260
|
+
# max_results: 1,
|
1261
|
+
# next_token: "NextToken",
|
1262
|
+
# })
|
1263
|
+
#
|
1264
|
+
# @example Response structure
|
1265
|
+
#
|
1266
|
+
# resp.images #=> Array
|
1267
|
+
# resp.images[0].time_stamp #=> Time
|
1268
|
+
# resp.images[0].error #=> String, one of "NO_MEDIA", "MEDIA_ERROR"
|
1269
|
+
# resp.images[0].image_content #=> String
|
1270
|
+
# resp.next_token #=> String
|
1271
|
+
#
|
1272
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/kinesis-video-archived-media-2017-09-30/GetImages AWS API Documentation
|
1273
|
+
#
|
1274
|
+
# @overload get_images(params = {})
|
1275
|
+
# @param [Hash] params ({})
|
1276
|
+
def get_images(params = {}, options = {})
|
1277
|
+
req = build_request(:get_images, params)
|
1278
|
+
req.send_request(options)
|
1279
|
+
end
|
1280
|
+
|
1158
1281
|
# Gets media for a list of fragments (specified by fragment number) from
|
1159
1282
|
# the archived data in an Amazon Kinesis video stream.
|
1160
1283
|
#
|
@@ -1352,7 +1475,7 @@ module Aws::KinesisVideoArchivedMedia
|
|
1352
1475
|
params: params,
|
1353
1476
|
config: config)
|
1354
1477
|
context[:gem_name] = 'aws-sdk-kinesisvideoarchivedmedia'
|
1355
|
-
context[:gem_version] = '1.
|
1478
|
+
context[:gem_version] = '1.44.0'
|
1356
1479
|
Seahorse::Client::Request.new(handlers, context)
|
1357
1480
|
end
|
1358
1481
|
|
@@ -29,6 +29,10 @@ module Aws::KinesisVideoArchivedMedia
|
|
29
29
|
DASHTimestampRange = Shapes::StructureShape.new(name: 'DASHTimestampRange')
|
30
30
|
ErrorMessage = Shapes::StringShape.new(name: 'ErrorMessage')
|
31
31
|
Expires = Shapes::IntegerShape.new(name: 'Expires')
|
32
|
+
Format = Shapes::StringShape.new(name: 'Format')
|
33
|
+
FormatConfig = Shapes::MapShape.new(name: 'FormatConfig')
|
34
|
+
FormatConfigKey = Shapes::StringShape.new(name: 'FormatConfigKey')
|
35
|
+
FormatConfigValue = Shapes::StringShape.new(name: 'FormatConfigValue')
|
32
36
|
Fragment = Shapes::StructureShape.new(name: 'Fragment')
|
33
37
|
FragmentList = Shapes::ListShape.new(name: 'FragmentList')
|
34
38
|
FragmentNumberList = Shapes::ListShape.new(name: 'FragmentNumberList')
|
@@ -41,6 +45,9 @@ module Aws::KinesisVideoArchivedMedia
|
|
41
45
|
GetDASHStreamingSessionURLOutput = Shapes::StructureShape.new(name: 'GetDASHStreamingSessionURLOutput')
|
42
46
|
GetHLSStreamingSessionURLInput = Shapes::StructureShape.new(name: 'GetHLSStreamingSessionURLInput')
|
43
47
|
GetHLSStreamingSessionURLOutput = Shapes::StructureShape.new(name: 'GetHLSStreamingSessionURLOutput')
|
48
|
+
GetImagesInput = Shapes::StructureShape.new(name: 'GetImagesInput')
|
49
|
+
GetImagesMaxResults = Shapes::IntegerShape.new(name: 'GetImagesMaxResults')
|
50
|
+
GetImagesOutput = Shapes::StructureShape.new(name: 'GetImagesOutput')
|
44
51
|
GetMediaForFragmentListInput = Shapes::StructureShape.new(name: 'GetMediaForFragmentListInput')
|
45
52
|
GetMediaForFragmentListOutput = Shapes::StructureShape.new(name: 'GetMediaForFragmentListOutput')
|
46
53
|
HLSDiscontinuityMode = Shapes::StringShape.new(name: 'HLSDiscontinuityMode')
|
@@ -51,6 +58,12 @@ module Aws::KinesisVideoArchivedMedia
|
|
51
58
|
HLSPlaybackMode = Shapes::StringShape.new(name: 'HLSPlaybackMode')
|
52
59
|
HLSStreamingSessionURL = Shapes::StringShape.new(name: 'HLSStreamingSessionURL')
|
53
60
|
HLSTimestampRange = Shapes::StructureShape.new(name: 'HLSTimestampRange')
|
61
|
+
HeightPixels = Shapes::IntegerShape.new(name: 'HeightPixels')
|
62
|
+
Image = Shapes::StructureShape.new(name: 'Image')
|
63
|
+
ImageContent = Shapes::StringShape.new(name: 'ImageContent')
|
64
|
+
ImageError = Shapes::StringShape.new(name: 'ImageError')
|
65
|
+
ImageSelectorType = Shapes::StringShape.new(name: 'ImageSelectorType')
|
66
|
+
Images = Shapes::ListShape.new(name: 'Images')
|
54
67
|
InvalidArgumentException = Shapes::StructureShape.new(name: 'InvalidArgumentException')
|
55
68
|
InvalidCodecPrivateDataException = Shapes::StructureShape.new(name: 'InvalidCodecPrivateDataException')
|
56
69
|
InvalidMediaFrameException = Shapes::StructureShape.new(name: 'InvalidMediaFrameException')
|
@@ -65,10 +78,12 @@ module Aws::KinesisVideoArchivedMedia
|
|
65
78
|
Payload = Shapes::BlobShape.new(name: 'Payload', streaming: true)
|
66
79
|
ResourceARN = Shapes::StringShape.new(name: 'ResourceARN')
|
67
80
|
ResourceNotFoundException = Shapes::StructureShape.new(name: 'ResourceNotFoundException')
|
81
|
+
SamplingInterval = Shapes::IntegerShape.new(name: 'SamplingInterval')
|
68
82
|
StreamName = Shapes::StringShape.new(name: 'StreamName')
|
69
83
|
Timestamp = Shapes::TimestampShape.new(name: 'Timestamp')
|
70
84
|
TimestampRange = Shapes::StructureShape.new(name: 'TimestampRange')
|
71
85
|
UnsupportedStreamMediaTypeException = Shapes::StructureShape.new(name: 'UnsupportedStreamMediaTypeException')
|
86
|
+
WidthPixels = Shapes::IntegerShape.new(name: 'WidthPixels')
|
72
87
|
|
73
88
|
ClientLimitExceededException.add_member(:message, Shapes::ShapeRef.new(shape: ErrorMessage, location_name: "Message"))
|
74
89
|
ClientLimitExceededException.struct_class = Types::ClientLimitExceededException
|
@@ -89,6 +104,9 @@ module Aws::KinesisVideoArchivedMedia
|
|
89
104
|
DASHTimestampRange.add_member(:end_timestamp, Shapes::ShapeRef.new(shape: Timestamp, location_name: "EndTimestamp"))
|
90
105
|
DASHTimestampRange.struct_class = Types::DASHTimestampRange
|
91
106
|
|
107
|
+
FormatConfig.key = Shapes::ShapeRef.new(shape: FormatConfigKey)
|
108
|
+
FormatConfig.value = Shapes::ShapeRef.new(shape: FormatConfigValue)
|
109
|
+
|
92
110
|
Fragment.add_member(:fragment_number, Shapes::ShapeRef.new(shape: FragmentNumberString, location_name: "FragmentNumber"))
|
93
111
|
Fragment.add_member(:fragment_size_in_bytes, Shapes::ShapeRef.new(shape: Long, location_name: "FragmentSizeInBytes"))
|
94
112
|
Fragment.add_member(:producer_timestamp, Shapes::ShapeRef.new(shape: Timestamp, location_name: "ProducerTimestamp"))
|
@@ -142,6 +160,24 @@ module Aws::KinesisVideoArchivedMedia
|
|
142
160
|
GetHLSStreamingSessionURLOutput.add_member(:hls_streaming_session_url, Shapes::ShapeRef.new(shape: HLSStreamingSessionURL, location_name: "HLSStreamingSessionURL"))
|
143
161
|
GetHLSStreamingSessionURLOutput.struct_class = Types::GetHLSStreamingSessionURLOutput
|
144
162
|
|
163
|
+
GetImagesInput.add_member(:stream_name, Shapes::ShapeRef.new(shape: StreamName, location_name: "StreamName"))
|
164
|
+
GetImagesInput.add_member(:stream_arn, Shapes::ShapeRef.new(shape: ResourceARN, location_name: "StreamARN"))
|
165
|
+
GetImagesInput.add_member(:image_selector_type, Shapes::ShapeRef.new(shape: ImageSelectorType, required: true, location_name: "ImageSelectorType"))
|
166
|
+
GetImagesInput.add_member(:start_timestamp, Shapes::ShapeRef.new(shape: Timestamp, required: true, location_name: "StartTimestamp"))
|
167
|
+
GetImagesInput.add_member(:end_timestamp, Shapes::ShapeRef.new(shape: Timestamp, required: true, location_name: "EndTimestamp"))
|
168
|
+
GetImagesInput.add_member(:sampling_interval, Shapes::ShapeRef.new(shape: SamplingInterval, required: true, location_name: "SamplingInterval"))
|
169
|
+
GetImagesInput.add_member(:format, Shapes::ShapeRef.new(shape: Format, required: true, location_name: "Format"))
|
170
|
+
GetImagesInput.add_member(:format_config, Shapes::ShapeRef.new(shape: FormatConfig, location_name: "FormatConfig"))
|
171
|
+
GetImagesInput.add_member(:width_pixels, Shapes::ShapeRef.new(shape: WidthPixels, location_name: "WidthPixels"))
|
172
|
+
GetImagesInput.add_member(:height_pixels, Shapes::ShapeRef.new(shape: HeightPixels, location_name: "HeightPixels"))
|
173
|
+
GetImagesInput.add_member(:max_results, Shapes::ShapeRef.new(shape: GetImagesMaxResults, location_name: "MaxResults"))
|
174
|
+
GetImagesInput.add_member(:next_token, Shapes::ShapeRef.new(shape: NextToken, location_name: "NextToken"))
|
175
|
+
GetImagesInput.struct_class = Types::GetImagesInput
|
176
|
+
|
177
|
+
GetImagesOutput.add_member(:images, Shapes::ShapeRef.new(shape: Images, location_name: "Images"))
|
178
|
+
GetImagesOutput.add_member(:next_token, Shapes::ShapeRef.new(shape: NextToken, location_name: "NextToken"))
|
179
|
+
GetImagesOutput.struct_class = Types::GetImagesOutput
|
180
|
+
|
145
181
|
GetMediaForFragmentListInput.add_member(:stream_name, Shapes::ShapeRef.new(shape: StreamName, location_name: "StreamName"))
|
146
182
|
GetMediaForFragmentListInput.add_member(:stream_arn, Shapes::ShapeRef.new(shape: ResourceARN, location_name: "StreamARN"))
|
147
183
|
GetMediaForFragmentListInput.add_member(:fragments, Shapes::ShapeRef.new(shape: FragmentNumberList, required: true, location_name: "Fragments"))
|
@@ -161,6 +197,13 @@ module Aws::KinesisVideoArchivedMedia
|
|
161
197
|
HLSTimestampRange.add_member(:end_timestamp, Shapes::ShapeRef.new(shape: Timestamp, location_name: "EndTimestamp"))
|
162
198
|
HLSTimestampRange.struct_class = Types::HLSTimestampRange
|
163
199
|
|
200
|
+
Image.add_member(:time_stamp, Shapes::ShapeRef.new(shape: Timestamp, location_name: "TimeStamp"))
|
201
|
+
Image.add_member(:error, Shapes::ShapeRef.new(shape: ImageError, location_name: "Error"))
|
202
|
+
Image.add_member(:image_content, Shapes::ShapeRef.new(shape: ImageContent, location_name: "ImageContent"))
|
203
|
+
Image.struct_class = Types::Image
|
204
|
+
|
205
|
+
Images.member = Shapes::ShapeRef.new(shape: Image)
|
206
|
+
|
164
207
|
InvalidArgumentException.add_member(:message, Shapes::ShapeRef.new(shape: ErrorMessage, location_name: "Message"))
|
165
208
|
InvalidArgumentException.struct_class = Types::InvalidArgumentException
|
166
209
|
|
@@ -266,6 +309,24 @@ module Aws::KinesisVideoArchivedMedia
|
|
266
309
|
o.errors << Shapes::ShapeRef.new(shape: InvalidCodecPrivateDataException)
|
267
310
|
end)
|
268
311
|
|
312
|
+
api.add_operation(:get_images, Seahorse::Model::Operation.new.tap do |o|
|
313
|
+
o.name = "GetImages"
|
314
|
+
o.http_method = "POST"
|
315
|
+
o.http_request_uri = "/getImages"
|
316
|
+
o.input = Shapes::ShapeRef.new(shape: GetImagesInput)
|
317
|
+
o.output = Shapes::ShapeRef.new(shape: GetImagesOutput)
|
318
|
+
o.errors << Shapes::ShapeRef.new(shape: ResourceNotFoundException)
|
319
|
+
o.errors << Shapes::ShapeRef.new(shape: InvalidArgumentException)
|
320
|
+
o.errors << Shapes::ShapeRef.new(shape: ClientLimitExceededException)
|
321
|
+
o.errors << Shapes::ShapeRef.new(shape: NotAuthorizedException)
|
322
|
+
o[:pager] = Aws::Pager.new(
|
323
|
+
limit_key: "max_results",
|
324
|
+
tokens: {
|
325
|
+
"next_token" => "next_token"
|
326
|
+
}
|
327
|
+
)
|
328
|
+
end)
|
329
|
+
|
269
330
|
api.add_operation(:get_media_for_fragment_list, Seahorse::Model::Operation.new.tap do |o|
|
270
331
|
o.name = "GetMediaForFragmentList"
|
271
332
|
o.http_method = "POST"
|
@@ -826,6 +826,156 @@ module Aws::KinesisVideoArchivedMedia
|
|
826
826
|
include Aws::Structure
|
827
827
|
end
|
828
828
|
|
829
|
+
# @note When making an API call, you may pass GetImagesInput
|
830
|
+
# data as a hash:
|
831
|
+
#
|
832
|
+
# {
|
833
|
+
# stream_name: "StreamName",
|
834
|
+
# stream_arn: "ResourceARN",
|
835
|
+
# image_selector_type: "PRODUCER_TIMESTAMP", # required, accepts PRODUCER_TIMESTAMP, SERVER_TIMESTAMP
|
836
|
+
# start_timestamp: Time.now, # required
|
837
|
+
# end_timestamp: Time.now, # required
|
838
|
+
# sampling_interval: 1, # required
|
839
|
+
# format: "JPEG", # required, accepts JPEG, PNG
|
840
|
+
# format_config: {
|
841
|
+
# "JPEGQuality" => "FormatConfigValue",
|
842
|
+
# },
|
843
|
+
# width_pixels: 1,
|
844
|
+
# height_pixels: 1,
|
845
|
+
# max_results: 1,
|
846
|
+
# next_token: "NextToken",
|
847
|
+
# }
|
848
|
+
#
|
849
|
+
# @!attribute [rw] stream_name
|
850
|
+
# The name of the stream from which to retrieve the images. You must
|
851
|
+
# specify either the `StreamName` or the `StreamARN`.
|
852
|
+
# @return [String]
|
853
|
+
#
|
854
|
+
# @!attribute [rw] stream_arn
|
855
|
+
# The Amazon Resource Name (ARN) of the stream from which to retrieve
|
856
|
+
# the images. You must specify either the `StreamName` or the
|
857
|
+
# `StreamARN`.
|
858
|
+
# @return [String]
|
859
|
+
#
|
860
|
+
# @!attribute [rw] image_selector_type
|
861
|
+
# The origin of the Server or Producer timestamps to use to generate
|
862
|
+
# the images.
|
863
|
+
# @return [String]
|
864
|
+
#
|
865
|
+
# @!attribute [rw] start_timestamp
|
866
|
+
# The starting point from which the images should be generated. This
|
867
|
+
# `StartTimestamp` must be within an inclusive range of timestamps for
|
868
|
+
# an image to be returned.
|
869
|
+
# @return [Time]
|
870
|
+
#
|
871
|
+
# @!attribute [rw] end_timestamp
|
872
|
+
# The end timestamp for the range of images to be generated.
|
873
|
+
# @return [Time]
|
874
|
+
#
|
875
|
+
# @!attribute [rw] sampling_interval
|
876
|
+
# The time interval in milliseconds (ms) at which the images need to
|
877
|
+
# be generated from the stream. The minimum value that can be provided
|
878
|
+
# is 3000 ms. If the timestamp range is less than the sampling
|
879
|
+
# interval, the Image from the `startTimestamp` will be returned if
|
880
|
+
# available.
|
881
|
+
#
|
882
|
+
# <note markdown="1"> The minimum value of 3000 ms is a soft limit. If needed, a lower
|
883
|
+
# sampling frequency can be requested.
|
884
|
+
#
|
885
|
+
# </note>
|
886
|
+
# @return [Integer]
|
887
|
+
#
|
888
|
+
# @!attribute [rw] format
|
889
|
+
# The format that will be used to encode the image.
|
890
|
+
# @return [String]
|
891
|
+
#
|
892
|
+
# @!attribute [rw] format_config
|
893
|
+
# The list of a key-value pair structure that contains extra
|
894
|
+
# parameters that can be applied when the image is generated. The
|
895
|
+
# `FormatConfig` key is the `JPEGQuality`, which indicates the JPEG
|
896
|
+
# quality key to be used to generate the image. The `FormatConfig`
|
897
|
+
# value accepts ints from 1 to 100. If the value is 1, the image will
|
898
|
+
# be generated with less quality and the best compression. If the
|
899
|
+
# value is 100, the image will be generated with the best quality and
|
900
|
+
# less compression. If no value is provided, the default value of the
|
901
|
+
# `JPEGQuality` key will be set to 80.
|
902
|
+
# @return [Hash<String,String>]
|
903
|
+
#
|
904
|
+
# @!attribute [rw] width_pixels
|
905
|
+
# The width of the output image that is used in conjunction with the
|
906
|
+
# `HeightPixels` parameter. When both `WidthPixels` and `HeightPixels`
|
907
|
+
# parameters are provided, the image will be stretched to fit the
|
908
|
+
# specified aspect ratio. If only the `WidthPixels` parameter is
|
909
|
+
# provided or if only the `HeightPixels` is provided, a
|
910
|
+
# `ValidationException` will be thrown. If neither parameter is
|
911
|
+
# provided, the original image size from the stream will be returned.
|
912
|
+
# @return [Integer]
|
913
|
+
#
|
914
|
+
# @!attribute [rw] height_pixels
|
915
|
+
# The height of the output image that is used in conjunction with the
|
916
|
+
# `WidthPixels` parameter. When both `HeightPixels` and `WidthPixels`
|
917
|
+
# parameters are provided, the image will be stretched to fit the
|
918
|
+
# specified aspect ratio. If only the `HeightPixels` parameter is
|
919
|
+
# provided, its original aspect ratio will be used to calculate the
|
920
|
+
# `WidthPixels` ratio. If neither parameter is provided, the original
|
921
|
+
# image size will be returned.
|
922
|
+
# @return [Integer]
|
923
|
+
#
|
924
|
+
# @!attribute [rw] max_results
|
925
|
+
# The maximum number of images to be returned by the API.
|
926
|
+
#
|
927
|
+
# <note markdown="1"> The default limit is 100 images per API response. The additional
|
928
|
+
# results will be paginated.
|
929
|
+
#
|
930
|
+
# </note>
|
931
|
+
# @return [Integer]
|
932
|
+
#
|
933
|
+
# @!attribute [rw] next_token
|
934
|
+
# A token that specifies where to start paginating the next set of
|
935
|
+
# Images. This is the `GetImages:NextToken` from a previously
|
936
|
+
# truncated response.
|
937
|
+
# @return [String]
|
938
|
+
#
|
939
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/kinesis-video-archived-media-2017-09-30/GetImagesInput AWS API Documentation
|
940
|
+
#
|
941
|
+
class GetImagesInput < Struct.new(
|
942
|
+
:stream_name,
|
943
|
+
:stream_arn,
|
944
|
+
:image_selector_type,
|
945
|
+
:start_timestamp,
|
946
|
+
:end_timestamp,
|
947
|
+
:sampling_interval,
|
948
|
+
:format,
|
949
|
+
:format_config,
|
950
|
+
:width_pixels,
|
951
|
+
:height_pixels,
|
952
|
+
:max_results,
|
953
|
+
:next_token)
|
954
|
+
SENSITIVE = []
|
955
|
+
include Aws::Structure
|
956
|
+
end
|
957
|
+
|
958
|
+
# @!attribute [rw] images
|
959
|
+
# The list of images generated from the video stream. If there is no
|
960
|
+
# media available for the given timestamp, the `NO_MEDIA` error will
|
961
|
+
# be listed in the output. If an error occurs while the image is being
|
962
|
+
# generated, the `MEDIA_ERROR` will be listed in the output as the
|
963
|
+
# cause of the missing image.
|
964
|
+
# @return [Array<Types::Image>]
|
965
|
+
#
|
966
|
+
# @!attribute [rw] next_token
|
967
|
+
# The encrypted token that was used in the request to get more images.
|
968
|
+
# @return [String]
|
969
|
+
#
|
970
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/kinesis-video-archived-media-2017-09-30/GetImagesOutput AWS API Documentation
|
971
|
+
#
|
972
|
+
class GetImagesOutput < Struct.new(
|
973
|
+
:images,
|
974
|
+
:next_token)
|
975
|
+
SENSITIVE = []
|
976
|
+
include Aws::Structure
|
977
|
+
end
|
978
|
+
|
829
979
|
# @note When making an API call, you may pass GetMediaForFragmentListInput
|
830
980
|
# data as a hash:
|
831
981
|
#
|
@@ -1022,6 +1172,46 @@ module Aws::KinesisVideoArchivedMedia
|
|
1022
1172
|
include Aws::Structure
|
1023
1173
|
end
|
1024
1174
|
|
1175
|
+
# A structure that contains the `Timestamp`, `Error`, and
|
1176
|
+
# `ImageContent`.
|
1177
|
+
#
|
1178
|
+
# @!attribute [rw] time_stamp
|
1179
|
+
# An attribute of the `Image` object that is used to extract an image
|
1180
|
+
# from the video stream. This field is used to manage gaps on images
|
1181
|
+
# or to better understand the pagination window.
|
1182
|
+
# @return [Time]
|
1183
|
+
#
|
1184
|
+
# @!attribute [rw] error
|
1185
|
+
# The error message shown when the image for the provided timestamp
|
1186
|
+
# was not extracted due to a non-tryable error. An error will be
|
1187
|
+
# returned if:
|
1188
|
+
#
|
1189
|
+
# * There is no media that exists for the specified `Timestamp`.
|
1190
|
+
#
|
1191
|
+
# ^
|
1192
|
+
# ^
|
1193
|
+
#
|
1194
|
+
# * The media for the specified time does not allow an image to be
|
1195
|
+
# extracted. In this case the media is audio only, or the incorrect
|
1196
|
+
# media has been ingested.
|
1197
|
+
#
|
1198
|
+
# ^
|
1199
|
+
# @return [String]
|
1200
|
+
#
|
1201
|
+
# @!attribute [rw] image_content
|
1202
|
+
# An attribute of the `Image` object that is Base64 encoded.
|
1203
|
+
# @return [String]
|
1204
|
+
#
|
1205
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/kinesis-video-archived-media-2017-09-30/Image AWS API Documentation
|
1206
|
+
#
|
1207
|
+
class Image < Struct.new(
|
1208
|
+
:time_stamp,
|
1209
|
+
:error,
|
1210
|
+
:image_content)
|
1211
|
+
SENSITIVE = []
|
1212
|
+
include Aws::Structure
|
1213
|
+
end
|
1214
|
+
|
1025
1215
|
# A specified parameter exceeds its restrictions, is not supported, or
|
1026
1216
|
# can't be used.
|
1027
1217
|
#
|
metadata
CHANGED
@@ -1,14 +1,14 @@
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
2
2
|
name: aws-sdk-kinesisvideoarchivedmedia
|
3
3
|
version: !ruby/object:Gem::Version
|
4
|
-
version: 1.
|
4
|
+
version: 1.44.0
|
5
5
|
platform: ruby
|
6
6
|
authors:
|
7
7
|
- Amazon Web Services
|
8
8
|
autorequire:
|
9
9
|
bindir: bin
|
10
10
|
cert_chain: []
|
11
|
-
date: 2022-
|
11
|
+
date: 2022-05-03 00:00:00.000000000 Z
|
12
12
|
dependencies:
|
13
13
|
- !ruby/object:Gem::Dependency
|
14
14
|
name: aws-sdk-core
|