import type { MetadataBearer as __MetadataBearer } from "@smithy/types"; import type { GetImagesInput, GetImagesOutput } from "../models/models_0"; /** * @public */ export type { __MetadataBearer }; /** * @public * * The input for {@link GetImagesCommand}. */ export interface GetImagesCommandInput extends GetImagesInput { } /** * @public * * The output of {@link GetImagesCommand}. */ export interface GetImagesCommandOutput extends GetImagesOutput, __MetadataBearer { } declare const GetImagesCommand_base: { new (input: GetImagesCommandInput): import("@smithy/core/client").CommandImpl; new (input: GetImagesCommandInput): import("@smithy/core/client").CommandImpl; getEndpointParameterInstructions(): import("@smithy/types").EndpointParameterInstructions; }; /** *

Retrieves a list of images corresponding to each timestamp for a given time range, * sampling interval, and image format configuration.

* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript * import { KinesisVideoArchivedMediaClient, GetImagesCommand } from "@aws-sdk/client-kinesis-video-archived-media"; // ES Modules import * // const { KinesisVideoArchivedMediaClient, GetImagesCommand } = require("@aws-sdk/client-kinesis-video-archived-media"); // CommonJS import * // import type { KinesisVideoArchivedMediaClientConfig } from "@aws-sdk/client-kinesis-video-archived-media"; * const config = {}; // type is KinesisVideoArchivedMediaClientConfig * const client = new KinesisVideoArchivedMediaClient(config); * const input = { // GetImagesInput * StreamName: "STRING_VALUE", * StreamARN: "STRING_VALUE", * ImageSelectorType: "PRODUCER_TIMESTAMP" || "SERVER_TIMESTAMP", // required * StartTimestamp: new Date("TIMESTAMP"), // required * EndTimestamp: new Date("TIMESTAMP"), // required * SamplingInterval: Number("int"), * Format: "JPEG" || "PNG", // required * FormatConfig: { // FormatConfig * "": "STRING_VALUE", * }, * WidthPixels: Number("int"), * HeightPixels: Number("int"), * MaxResults: Number("long"), * NextToken: "STRING_VALUE", * }; * const command = new GetImagesCommand(input); * const response = await client.send(command); * // { // GetImagesOutput * // Images: [ // Images * // { // Image * // TimeStamp: new Date("TIMESTAMP"), * // Error: "NO_MEDIA" || "MEDIA_ERROR", * // ImageContent: "STRING_VALUE", * // }, * // ], * // NextToken: "STRING_VALUE", * // }; * * ``` * * @param GetImagesCommandInput - {@link GetImagesCommandInput} * @returns {@link GetImagesCommandOutput} * @see {@link GetImagesCommandInput} for command's `input` shape. * @see {@link GetImagesCommandOutput} for command's `response` shape. * @see {@link KinesisVideoArchivedMediaClientResolvedConfig | config} for KinesisVideoArchivedMediaClient's `config` shape. * * @throws {@link ClientLimitExceededException} (client fault) *

Kinesis Video Streams has throttled the request because you have exceeded a limit. Try making the call later. For information about limits, see Kinesis Video Streams Limits.

* * @throws {@link InvalidArgumentException} (client fault) *

A specified parameter exceeds its restrictions, is not supported, or can't be * used.

* * @throws {@link NoDataRetentionException} (client fault) *

* GetImages was requested for a stream that does not retain data (that is, has * a DataRetentionInHours of 0).

* * @throws {@link NotAuthorizedException} (client fault) *

Status Code: 403, The caller is not authorized to perform an operation on the given * stream, or the token has expired.

* * @throws {@link ResourceNotFoundException} (client fault) *

* GetImages will throw this error when Kinesis Video Streams can't find the stream * that you specified.

*

* GetHLSStreamingSessionURL and GetDASHStreamingSessionURL throw * this error if a session with a PlaybackMode of ON_DEMAND or * LIVE_REPLAYis requested for a stream that has no fragments within the * requested time range, or if a session with a PlaybackMode of * LIVE is requested for a stream that has no fragments within the last 30 * seconds.

* * @throws {@link KinesisVideoArchivedMediaServiceException} *

Base exception class for all service exceptions from KinesisVideoArchivedMedia service.

* * * @public */ export declare class GetImagesCommand extends GetImagesCommand_base { /** @internal type navigation helper, not in runtime. */ protected static __types: { api: { input: GetImagesInput; output: GetImagesOutput; }; sdk: { input: GetImagesCommandInput; output: GetImagesCommandOutput; }; }; }