

Die vorliegende Übersetzung wurde maschinell erstellt. Im Falle eines Konflikts oder eines Widerspruchs zwischen dieser übersetzten Fassung und der englischen Fassung (einschließlich infolge von Verzögerungen bei der Übersetzung) ist die englische Fassung maßgeblich.

# GetImages
<a name="API_reader_GetImages"></a>

Die verwaltete Unterstützung für Bilder bietet eine vollständig verwaltete Möglichkeit, Bilder aus den Videodaten abzurufen, die in Kinesis Video Streams gestreamt und gespeichert werden. Sie können Bilder verwenden, um Workloads für maschinelles Lernen (ML) wie die Erkennung von Personen, Haustieren oder Fahrzeugen auszuführen. Bilder können auch verwendet werden, um interaktive Elemente zur Wiedergabe hinzuzufügen, z. B. Bildvorschauen für Bewegungsereignisse und Scrubbing für einen Videoclip. 

GetImages ruft außerdem eine Liste von Bildern ab, die jedem Zeitstempel für einen bestimmten Zeitraum, ein bestimmtes Abtastintervall und eine bestimmte Bildformatkonfiguration entsprechen.

**Anmerkung**  
Sie müssen zuerst die `GetDataEndpoint` API aufrufen, um einen Endpunkt zu erhalten. Senden Sie dann die `GetImages` Anfragen mit dem Parameter [--endpoint-url an diesen Endpunkt](https://docs.aws.amazon.com/cli/latest/reference/). 

 Anforderungen an den Titel für die [Videowiedergabe](https://docs.aws.amazon.com/kinesisvideostreams/latest/dg/video-playback-requirements.html).

## Anforderungssyntax
<a name="API_reader_GetImages_RequestSyntax"></a>

```
POST /getImages HTTP/1.1
Content-type: application/json

{
   "EndTimestamp": number,
   "Format": "string",
   "FormatConfig": { 
      "string" : "string" 
   },
   "HeightPixels": number,
   "ImageSelectorType": "string",
   "MaxResults": number,
   "NextToken": "string",
   "SamplingInterval": number,
   "StartTimestamp": number,
   "StreamARN": "string",
   "StreamName": "string",
   "WidthPixels": number
}
```

## URI-Anfrageparameter
<a name="API_reader_GetImages_RequestParameters"></a>

Die Anforderung verwendet keine URI-Parameter.

## Anforderungstext
<a name="API_reader_GetImages_RequestBody"></a>

Die Anforderung akzeptiert die folgenden Daten im JSON-Format.

 ** [EndTimestamp](#API_reader_GetImages_RequestSyntax) **   <a name="KinesisVideo-reader_GetImages-request-EndTimestamp"></a>
Der Endzeitstempel für den Bereich der zu generierenden Bilder. Liegt der Zeitbereich zwischen `StartTimestamp` und `EndTimestamp` mehr als 300 Sekunden darüber`StartTimestamp`, erhalten Sie eine`IllegalArgumentException`.  
Typ: Zeitstempel  
Erforderlich: Ja

 ** [Format](#API_reader_GetImages_RequestSyntax) **   <a name="KinesisVideo-reader_GetImages-request-Format"></a>
Das Format, das zum Codieren des Bilds verwendet wird.  
Typ: Zeichenfolge  
Zulässige Werte: `JPEG | PNG`   
Erforderlich: Ja

 ** [FormatConfig](#API_reader_GetImages_RequestSyntax) **   <a name="KinesisVideo-reader_GetImages-request-FormatConfig"></a>
Die Liste einer Struktur mit Schlüssel-Wert-Paaren, die zusätzliche Parameter enthält, die bei der Generierung des Bildes angewendet werden können. Der `FormatConfig` Schlüssel ist der`JPEGQuality`, der den JPEG-Qualitätsschlüssel angibt, der zur Generierung des Bildes verwendet werden soll. Der `FormatConfig` Wert akzeptiert Ganzzahlen von 1 bis 100. Wenn der Wert 1 ist, wird das Bild mit geringerer Qualität und der besten Komprimierung generiert. Wenn der Wert 100 ist, wird das Bild mit der besten Qualität und weniger Komprimierung generiert. Wenn kein Wert angegeben wird, wird der Standardwert des `JPEGQuality` Schlüssels auf 80 gesetzt.  
Typ: Abbildung einer Zeichenfolge auf eine Zeichenfolge  
Karteneinträge: Maximale Anzahl von 1 Element.  
Gültige Schlüssel: `JPEGQuality`   
Längenbeschränkungen für Werte: Mindestlänge von 0. Maximale Länge beträgt 256 Zeichen.  
Wertemuster: `^[a-zA-Z_0-9]+`   
Erforderlich: Nein

 ** [HeightPixels](#API_reader_GetImages_RequestSyntax) **   <a name="KinesisVideo-reader_GetImages-request-HeightPixels"></a>
Die Höhe des Ausgabebilds, das in Verbindung mit dem `WidthPixels` Parameter verwendet wird. Wenn `HeightPixels` sowohl als auch `WidthPixels` Parameter angegeben sind, wird das Bild gestreckt, sodass es dem angegebenen Seitenverhältnis entspricht. Wenn nur der `HeightPixels` Parameter angegeben wird, wird das ursprüngliche Seitenverhältnis zur Berechnung des `WidthPixels` Verhältnisses verwendet. Wenn keiner der Parameter angegeben wird, wird die ursprüngliche Bildgröße zurückgegeben.  
Typ: Ganzzahl  
Gültiger Bereich: Mindestwert 1. Der Maximalwert ist 2160.  
Erforderlich: Nein

 ** [ImageSelectorType](#API_reader_GetImages_RequestSyntax) **   <a name="KinesisVideo-reader_GetImages-request-ImageSelectorType"></a>
Der Ursprung der Server- oder Producer-Zeitstempel, die zur Generierung der Bilder verwendet werden sollen.  
Typ: Zeichenfolge  
Zulässige Werte: `PRODUCER_TIMESTAMP | SERVER_TIMESTAMP`   
Erforderlich: Ja

 ** [MaxResults](#API_reader_GetImages_RequestSyntax) **   <a name="KinesisVideo-reader_GetImages-request-MaxResults"></a>
Die maximale Anzahl von Bildern, die von der API zurückgegeben werden sollen.   
Das Standardlimit liegt bei 25 Bildern pro API-Antwort. Wenn Sie einen `MaxResults` Wert angeben, der über diesem Wert liegt, ergibt sich eine Seitengröße von 25. Alle weiteren Ergebnisse werden paginiert. 
Type: Long  
Gültiger Bereich: Mindestwert 1. Maximalwert 100.  
Erforderlich: Nein

 ** [NextToken](#API_reader_GetImages_RequestSyntax) **   <a name="KinesisVideo-reader_GetImages-request-NextToken"></a>
Ein Token, das angibt, wo mit der Paginierung der nächsten Gruppe von Bildern begonnen werden soll. Dies ist das Ergebnis `GetImages:NextToken` einer zuvor gekürzten Antwort.  
Typ: Zeichenfolge  
Längenbeschränkungen: Minimale Länge beträgt 1 Zeichen. Maximale Länge beträgt 4096 Zeichen.  
Pattern: `[a-zA-Z0-9+/]+={0,2}`   
Erforderlich: Nein

 ** [SamplingInterval](#API_reader_GetImages_RequestSyntax) **   <a name="KinesisVideo-reader_GetImages-request-SamplingInterval"></a>
Das Zeitintervall in Millisekunden (ms), in dem die Bilder aus dem Stream generiert werden müssen. Der Mindestwert, der bereitgestellt werden kann, ist 200 ms (5 Bilder pro Sekunde). Wenn der Zeitstempelbereich unter dem Abtastintervall liegt, `startTimestamp` wird das Bild von zurückgegeben, sofern verfügbar.   
Typ: Ganzzahl  
Erforderlich: Nein

 ** [StartTimestamp](#API_reader_GetImages_RequestSyntax) **   <a name="KinesisVideo-reader_GetImages-request-StartTimestamp"></a>
Der Startpunkt, von dem aus die Bilder generiert werden sollen. Damit ein Bild zurückgegeben werden kann, `StartTimestamp` muss dieser Wert innerhalb eines gültigen Zeitstempelbereichs liegen.  
Typ: Zeitstempel  
Erforderlich: Ja

 ** [StreamARN](#API_reader_GetImages_RequestSyntax) **   <a name="KinesisVideo-reader_GetImages-request-StreamARN"></a>
Der Amazon-Ressourcenname (ARN) des Streams, aus dem die Bilder abgerufen werden sollen. Sie müssen entweder den `StreamName` oder den angeben`StreamARN`.  
Typ: Zeichenfolge  
Längenbeschränkungen: Minimale Länge von 1. Maximale Länge beträgt 1024 Zeichen.  
Pattern: `arn:[a-z\d-]+:kinesisvideo:[a-z0-9-]+:[0-9]+:[a-z]+/[a-zA-Z0-9_.-]+/[0-9]+`   
Erforderlich: Nein

 ** [StreamName](#API_reader_GetImages_RequestSyntax) **   <a name="KinesisVideo-reader_GetImages-request-StreamName"></a>
Der Name des Streams, aus dem die Bilder abgerufen werden sollen. Sie müssen entweder den `StreamName` oder den angeben`StreamARN`.  
Typ: Zeichenfolge  
Längenbeschränkungen: Minimale Länge beträgt 1 Zeichen. Maximale Länge beträgt 256 Zeichen.  
Pattern: `[a-zA-Z0-9_.-]+`   
Erforderlich: Nein

 ** [WidthPixels](#API_reader_GetImages_RequestSyntax) **   <a name="KinesisVideo-reader_GetImages-request-WidthPixels"></a>
Die Breite des Ausgabebilds, das in Verbindung mit dem `HeightPixels` Parameter verwendet wird. Wenn `WidthPixels` sowohl als auch `HeightPixels` Parameter angegeben sind, wird das Bild gestreckt, sodass es dem angegebenen Seitenverhältnis entspricht. Wenn nur der `WidthPixels` Parameter angegeben wird oder wenn nur der angegeben `HeightPixels` wird, `ValidationException` wird a ausgelöst. Wenn keiner der Parameter angegeben wird, wird die ursprüngliche Bildgröße aus dem Stream zurückgegeben.  
Typ: Ganzzahl  
Gültiger Bereich: Mindestwert 1. Der Maximalwert ist 3840.  
Erforderlich: Nein

## Antwortsyntax
<a name="API_reader_GetImages_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "Images": [ 
      { 
         "Error": "string",
         "ImageContent": "string",
         "TimeStamp": number
      }
   ],
   "NextToken": "string"
}
```

## Antwortelemente
<a name="API_reader_GetImages_ResponseElements"></a>

Wenn die Aktion erfolgreich ist, sendet der Service eine HTTP 200-Antwort zurück.

Die folgenden Daten werden vom Service im JSON-Format zurückgegeben.

 ** [Images](#API_reader_GetImages_ResponseSyntax) **   <a name="KinesisVideo-reader_GetImages-response-Images"></a>
Die Liste der Bilder, die aus dem Videostream generiert wurden. Wenn für den angegebenen Zeitstempel keine Medien verfügbar sind, wird der `NO_MEDIA` Fehler in der Ausgabe aufgeführt. Wenn während der Generierung des Bildes ein Fehler auftritt, `MEDIA_ERROR` wird dieser in der Ausgabe als Ursache für das fehlende Bild aufgeführt.   
Typ: Array von [Image](API_reader_Image.md)-Objekten

 ** [NextToken](#API_reader_GetImages_ResponseSyntax) **   <a name="KinesisVideo-reader_GetImages-response-NextToken"></a>
Das verschlüsselte Token, das in der Anfrage zum Abrufen weiterer Bilder verwendet wurde.  
Typ: Zeichenfolge  
Längenbeschränkungen: Minimale Länge beträgt 1 Zeichen. Maximale Länge beträgt 4096 Zeichen.  
Pattern: `[a-zA-Z0-9+/]+={0,2}` 

## Fehler
<a name="API_reader_GetImages_Errors"></a>

Weitere Informationen zu den allgemeinen Fehlern, die bei allen Aktionen zurückgegeben werden, finden Sie unter [Häufige Fehlertypen](CommonErrors.md).

 ** ClientLimitExceededException **   
Kinesis Video Streams hat die Anfrage gedrosselt, weil Sie ein Limit überschritten haben. Versuchen Sie später, den Anruf zu tätigen. Informationen zu Grenzwerten finden Sie unter [Kinesis Video Streams Streams-Kontingente](https://docs.aws.amazon.com/kinesisvideostreams/latest/dg/limits.html).  
HTTP-Statuscode: 400

 ** InvalidArgumentException **   
Ein angegebener Parameter überschreitet seine Beschränkungen, wird nicht unterstützt oder kann nicht verwendet werden.  
HTTP-Statuscode: 400

 ** NoDataRetentionException **   
 `GetImages`wurde für einen Stream angefordert, der keine Daten speichert (d. h. den Wert `DataRetentionInHours` 0 hat).   
HTTP-Statuscode: 400

 ** NotAuthorizedException **   
Statuscode: 403, Der Aufrufer ist nicht berechtigt, einen Vorgang mit dem angegebenen Stream auszuführen, oder das Token ist abgelaufen.  
HTTP-Statuscode: 401

 ** ResourceNotFoundException **   
 `GetImages`löst diesen Fehler aus, wenn Kinesis Video Streams den von Ihnen angegebenen Stream nicht finden kann.  
 `GetHLSStreamingSessionURL`und `GetDASHStreamingSessionURL` gibt diesen Fehler aus, wenn eine Sitzung mit einem `PlaybackMode` of `ON_DEMAND` oder für einen Stream angefordert `LIVE_REPLAY` wird, der innerhalb des angeforderten Zeitraums keine Fragmente enthält, oder wenn eine Sitzung mit einem `PlaybackMode` of für einen Stream angefordert `LIVE` wird, der innerhalb der letzten 30 Sekunden keine Fragmente enthält.  
HTTP-Statuscode: 404

## Weitere Informationen finden Sie unter:
<a name="API_reader_GetImages_SeeAlso"></a>

Weitere Informationen zur Verwendung dieser API in einer der sprachspezifischen Sprachen AWS SDKs finden Sie im Folgenden:
+  [AWS Befehlszeilenschnittstelle V2](https://docs.aws.amazon.com/goto/cli2/kinesis-video-reader-data-2017-09-30/GetImages) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/kinesis-video-reader-data-2017-09-30/GetImages) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/kinesis-video-reader-data-2017-09-30/GetImages) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/kinesis-video-reader-data-2017-09-30/GetImages) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/kinesis-video-reader-data-2017-09-30/GetImages) 
+  [AWS SDK für JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/kinesis-video-reader-data-2017-09-30/GetImages) 
+  [AWS SDK für Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/kinesis-video-reader-data-2017-09-30/GetImages) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/kinesis-video-reader-data-2017-09-30/GetImages) 
+  [AWS SDK für Python](https://docs.aws.amazon.com/goto/boto3/kinesis-video-reader-data-2017-09-30/GetImages) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/kinesis-video-reader-data-2017-09-30/GetImages) 