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.
# Aktionen
Die folgenden Aktionen werden von Amazon Kinesis Video Streams unterstützt:
+ [CreateSignalingChannel](API_CreateSignalingChannel.md)
+ [CreateStream](API_CreateStream.md)
+ [DeleteEdgeConfiguration](API_DeleteEdgeConfiguration.md)
+ [DeleteSignalingChannel](API_DeleteSignalingChannel.md)
+ [DeleteStream](API_DeleteStream.md)
+ [DescribeEdgeConfiguration](API_DescribeEdgeConfiguration.md)
+ [DescribeImageGenerationConfiguration](API_DescribeImageGenerationConfiguration.md)
+ [DescribeMappedResourceConfiguration](API_DescribeMappedResourceConfiguration.md)
+ [DescribeMediaStorageConfiguration](API_DescribeMediaStorageConfiguration.md)
+ [DescribeNotificationConfiguration](API_DescribeNotificationConfiguration.md)
+ [DescribeSignalingChannel](API_DescribeSignalingChannel.md)
+ [DescribeStream](API_DescribeStream.md)
+ [DescribeStreamStorageConfiguration](API_DescribeStreamStorageConfiguration.md)
+ [GetDataEndpoint](API_GetDataEndpoint.md)
+ [GetSignalingChannelEndpoint](API_GetSignalingChannelEndpoint.md)
+ [ListEdgeAgentConfigurations](API_ListEdgeAgentConfigurations.md)
+ [ListSignalingChannels](API_ListSignalingChannels.md)
+ [ListStreams](API_ListStreams.md)
+ [ListTagsForResource](API_ListTagsForResource.md)
+ [ListTagsForStream](API_ListTagsForStream.md)
+ [StartEdgeConfigurationUpdate](API_StartEdgeConfigurationUpdate.md)
+ [TagResource](API_TagResource.md)
+ [TagStream](API_TagStream.md)
+ [UntagResource](API_UntagResource.md)
+ [UntagStream](API_UntagStream.md)
+ [UpdateDataRetention](API_UpdateDataRetention.md)
+ [UpdateImageGenerationConfiguration](API_UpdateImageGenerationConfiguration.md)
+ [UpdateMediaStorageConfiguration](API_UpdateMediaStorageConfiguration.md)
+ [UpdateNotificationConfiguration](API_UpdateNotificationConfiguration.md)
+ [UpdateSignalingChannel](API_UpdateSignalingChannel.md)
+ [UpdateStream](API_UpdateStream.md)
+ [UpdateStreamStorageConfiguration](API_UpdateStreamStorageConfiguration.md)
Die folgenden Aktionen werden von Amazon Kinesis Video Streams Media unterstützt:
+ [GetMedia](API_dataplane_GetMedia.md)
+ [PutMedia](API_dataplane_PutMedia.md)
Die folgenden Aktionen werden von Amazon Kinesis Video Streams Archived Media unterstützt:
+ [GetClip](API_reader_GetClip.md)
+ [GetDASHStreamingSessionURL](API_reader_GetDASHStreamingSessionURL.md)
+ [GetHLSStreamingSessionURL](API_reader_GetHLSStreamingSessionURL.md)
+ [GetImages](API_reader_GetImages.md)
+ [GetMediaForFragmentList](API_reader_GetMediaForFragmentList.md)
+ [ListFragments](API_reader_ListFragments.md)
Die folgenden Aktionen werden von Amazon Kinesis Video Signaling Channels unterstützt:
+ [GetIceServerConfig](API_signaling_GetIceServerConfig.md)
+ [SendAlexaOfferToMaster](API_signaling_SendAlexaOfferToMaster.md)
Die folgenden Aktionen werden von Amazon Kinesis Video WebRTC Storage unterstützt:
+ [JoinStorageSession](API_webrtc_JoinStorageSession.md)
+ [JoinStorageSessionAsViewer](API_webrtc_JoinStorageSessionAsViewer.md)
# Amazon Kinesis Video Streams
Die folgenden Aktionen werden von Amazon Kinesis Video Streams unterstützt:
+ [CreateSignalingChannel](API_CreateSignalingChannel.md)
+ [CreateStream](API_CreateStream.md)
+ [DeleteEdgeConfiguration](API_DeleteEdgeConfiguration.md)
+ [DeleteSignalingChannel](API_DeleteSignalingChannel.md)
+ [DeleteStream](API_DeleteStream.md)
+ [DescribeEdgeConfiguration](API_DescribeEdgeConfiguration.md)
+ [DescribeImageGenerationConfiguration](API_DescribeImageGenerationConfiguration.md)
+ [DescribeMappedResourceConfiguration](API_DescribeMappedResourceConfiguration.md)
+ [DescribeMediaStorageConfiguration](API_DescribeMediaStorageConfiguration.md)
+ [DescribeNotificationConfiguration](API_DescribeNotificationConfiguration.md)
+ [DescribeSignalingChannel](API_DescribeSignalingChannel.md)
+ [DescribeStream](API_DescribeStream.md)
+ [DescribeStreamStorageConfiguration](API_DescribeStreamStorageConfiguration.md)
+ [GetDataEndpoint](API_GetDataEndpoint.md)
+ [GetSignalingChannelEndpoint](API_GetSignalingChannelEndpoint.md)
+ [ListEdgeAgentConfigurations](API_ListEdgeAgentConfigurations.md)
+ [ListSignalingChannels](API_ListSignalingChannels.md)
+ [ListStreams](API_ListStreams.md)
+ [ListTagsForResource](API_ListTagsForResource.md)
+ [ListTagsForStream](API_ListTagsForStream.md)
+ [StartEdgeConfigurationUpdate](API_StartEdgeConfigurationUpdate.md)
+ [TagResource](API_TagResource.md)
+ [TagStream](API_TagStream.md)
+ [UntagResource](API_UntagResource.md)
+ [UntagStream](API_UntagStream.md)
+ [UpdateDataRetention](API_UpdateDataRetention.md)
+ [UpdateImageGenerationConfiguration](API_UpdateImageGenerationConfiguration.md)
+ [UpdateMediaStorageConfiguration](API_UpdateMediaStorageConfiguration.md)
+ [UpdateNotificationConfiguration](API_UpdateNotificationConfiguration.md)
+ [UpdateSignalingChannel](API_UpdateSignalingChannel.md)
+ [UpdateStream](API_UpdateStream.md)
+ [UpdateStreamStorageConfiguration](API_UpdateStreamStorageConfiguration.md)
# CreateSignalingChannel
Erzeugt einen Signalkanal.
`CreateSignalingChannel` ist ein asynchroner Vorgang.
## Anforderungssyntax
```
POST /createSignalingChannel HTTP/1.1
Content-type: application/json
{
"ChannelName": "string",
"ChannelType": "string",
"SingleMasterConfiguration": {
"MessageTtlSeconds": number
},
"Tags": [
{
"Key": "string",
"Value": "string"
}
]
}
```
## URI-Anfrageparameter
Die Anforderung verwendet keine URI-Parameter.
## Anforderungstext
Die Anforderung akzeptiert die folgenden Daten im JSON-Format.
** [ChannelName](#API_CreateSignalingChannel_RequestSyntax) **
Ein Name für den Signalisierungskanal, den Sie erstellen. Es muss für jedes AWS-Konto Band einzigartig sein AWS-Region.
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: Ja
** [ChannelType](#API_CreateSignalingChannel_RequestSyntax) **
Ein Typ des Signalisierungskanals, den Sie erstellen. Derzeit ist `SINGLE_MASTER` der einzige unterstützte Kanaltyp.
Typ: Zeichenfolge
Zulässige Werte: `SINGLE_MASTER | FULL_MESH`
Erforderlich: Nein
** [SingleMasterConfiguration](#API_CreateSignalingChannel_RequestSyntax) **
Eine Struktur, die die Konfiguration für den `SINGLE_MASTER` Kanaltyp enthält. Die Standardkonfiguration für die Gültigkeitsdauer der Kanalnachricht beträgt 60 Sekunden (1 Minute).
Typ: [SingleMasterConfiguration](API_SingleMasterConfiguration.md) Objekt
Erforderlich: Nein
** [Tags](#API_CreateSignalingChannel_RequestSyntax) **
Eine Reihe von Tags (Schlüssel-Wert-Paare), die Sie diesem Kanal zuordnen möchten.
Typ: Array von [Tag](API_Tag.md)-Objekten
Array-Mitglieder: Die Mindestanzahl beträgt 0 Elemente. Die maximale Anzahl beträgt 50 Elemente.
Erforderlich: Nein
## Antwortsyntax
```
HTTP/1.1 200
Content-type: application/json
{
"ChannelARN": "string"
}
```
## Antwortelemente
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.
** [ChannelARN](#API_CreateSignalingChannel_ResponseSyntax) **
Der Amazon-Ressourcenname (ARN) des erstellten Kanals.
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]+`
## Fehler
Weitere Informationen zu den allgemeinen Fehlern, die bei allen Aktionen zurückgegeben werden, finden Sie unter [Häufige Fehlertypen](CommonErrors.md).
** AccessDeniedException **
Sie verfügen nicht über die erforderlichen Berechtigungen, um diesen Vorgang auszuführen.
HTTP-Statuscode: 401
** AccountChannelLimitExceededException **
Sie haben in dieser Region die maximale Anzahl an aktiven Signalkanälen dafür AWS-Konto erreicht.
HTTP-Statuscode: 400
** ClientLimitExceededException **
Kinesis Video Streams hat die Anfrage gedrosselt, weil Sie das Limit der erlaubten Client-Aufrufe überschritten haben. Versuchen Sie später, den Anruf zu tätigen.
HTTP-Statuscode: 400
** InvalidArgumentException **
Der Wert für diesen Eingabeparameter ist ungültig.
HTTP-Statuscode: 400
** ResourceInUseException **
Wenn der Eingang `StreamARN` oder `ChannelARN` Eingang bereits einer anderen Kinesis Video Stream-Ressource zugeordnet `CLOUD_STORAGE_MODE` ist oder wenn sich der angegebene Eingang `StreamARN` oder Eingang nicht im Status Aktiv `ChannelARN` befindet, versuchen Sie es mit einer der folgenden Methoden:
1. Die `DescribeMediaStorageConfiguration` API, um zu ermitteln, welchem Stream der angegebene Kanal zugeordnet ist.
1. Die `DescribeMappedResourceConfiguration` API zur Bestimmung des Kanals, dem der angegebene Stream zugeordnet ist.
1. Die `DescribeStream` oder `DescribeSignalingChannel` API zur Bestimmung des Status der Ressource.
HTTP-Statuscode: 400
** TagsPerResourceExceededLimitException **
Sie haben das Limit an Tags überschritten, die Sie der Ressource zuordnen können. Ein Kinesis-Videostream kann bis zu 50 Tags unterstützen.
HTTP-Statuscode: 400
## Weitere Informationen finden Sie unter:
Weitere Informationen zur Verwendung dieser API in einer der sprachspezifischen Sprachen finden Sie im AWS SDKs Folgenden:
+ [AWS Befehlszeilenschnittstelle V2](https://docs.aws.amazon.com/goto/cli2/kinesisvideo-2017-09-30/CreateSignalingChannel)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/kinesisvideo-2017-09-30/CreateSignalingChannel)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/kinesisvideo-2017-09-30/CreateSignalingChannel)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/kinesisvideo-2017-09-30/CreateSignalingChannel)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/kinesisvideo-2017-09-30/CreateSignalingChannel)
+ [AWS SDK für JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/kinesisvideo-2017-09-30/CreateSignalingChannel)
+ [AWS SDK für Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/kinesisvideo-2017-09-30/CreateSignalingChannel)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/kinesisvideo-2017-09-30/CreateSignalingChannel)
+ [AWS SDK für Python](https://docs.aws.amazon.com/goto/boto3/kinesisvideo-2017-09-30/CreateSignalingChannel)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/kinesisvideo-2017-09-30/CreateSignalingChannel)
# CreateStream
Erzeugt einen neuen Kinesis-Videostream.
Wenn Sie einen neuen Stream erstellen, weist Kinesis Video Streams ihm eine Versionsnummer zu. Wenn Sie die Metadaten des Streams ändern, aktualisiert Kinesis Video Streams die Version.
`CreateStream` ist ein asynchroner Vorgang.
Weitere Information zur Funktionsweise des Services finden Sie unter [Funktionsweise](https://docs.aws.amazon.com/kinesisvideostreams/latest/dg/how-it-works.html).
Sie müssen über Berechtigungen für die `KinesisVideo:CreateStream`-Aktion verfügen.
## Anforderungssyntax
```
POST /createStream HTTP/1.1
Content-type: application/json
{
"DataRetentionInHours": number,
"DeviceName": "string",
"KmsKeyId": "string",
"MediaType": "string",
"StreamName": "string",
"StreamStorageConfiguration": {
"DefaultStorageTier": "string"
},
"Tags": {
"string" : "string"
}
}
```
## URI-Anfrageparameter
Die Anforderung verwendet keine URI-Parameter.
## Anforderungstext
Die Anforderung akzeptiert die folgenden Daten im JSON-Format.
** [DataRetentionInHours](#API_CreateStream_RequestSyntax) **
Die Anzahl der Stunden, für die Sie die Daten im Stream behalten möchten. Kinesis Video Streams speichert die Daten in einem Datenspeicher, der dem Datenstrom zugeordnet ist.
Der Standardwert ist 0. Er gibt an, dass der Stream keine Daten beibehält. Das Minimum ist 1 Stunde.
Wenn der `DataRetentionInHours` Wert 0 ist, können Verbraucher immer noch die Fragmente verwenden, die im Service-Host-Puffer verbleiben. Dieser Puffer hat eine Aufbewahrungszeit von 5 Minuten und eine Speicherbegrenzung von 200 MB. Fragmente werden aus dem Puffer entfernt, wenn einer der Grenzwerte erreicht ist.
Typ: Ganzzahl
Gültiger Bereich: Mindestwert 0.
Erforderlich: Nein
** [DeviceName](#API_CreateStream_RequestSyntax) **
Der Name des Geräts, das in den Stream schreibt.
In der aktuellen Implementierung verwendet Kinesis Video Streams diesen Namen nicht.
Typ: Zeichenfolge
Längenbeschränkungen: Minimale Länge beträgt 1 Zeichen. Maximale Länge beträgt 128 Zeichen.
Pattern: `[a-zA-Z0-9_.-]+`
Erforderlich: Nein
** [KmsKeyId](#API_CreateStream_RequestSyntax) **
Die ID des Schlüssels AWS Key Management Service (AWS KMS), den Kinesis Video Streams zum Verschlüsseln von Stream-Daten verwenden soll.
Wenn keine Schlüssel-ID angegeben ist, wird standardmäßig der von Kinesis Video verwaltete Schlüssel (`aws/kinesisvideo`) verwendet.
Weitere Informationen finden Sie unter [DescribeKey](https://docs.aws.amazon.com/kms/latest/APIReference/API_DescribeKey.html#API_DescribeKey_RequestParameters).
Typ: Zeichenfolge
Längenbeschränkungen: Minimale Länge beträgt 1 Zeichen. Maximale Länge beträgt 2048 Zeichen.
Pattern: `.+`
Erforderlich: Nein
** [MediaType](#API_CreateStream_RequestSyntax) **
Der Medientyp des Streams. Nutzer des Streams können diese Informationen bei der Verarbeitung des Streams verwenden. Weitere Informationen zu Medientypen finden Sie unter [Medientypen](http://www.iana.org/assignments/media-types/media-types.xhtml). Wenn Sie sich für die Angabe von entscheiden`MediaType`, finden Sie Richtlinien unter [Benennungsvoraussetzungen](https://tools.ietf.org/html/rfc6838#section-4.2).
Zu den gültigen Werten gehören beispielsweise "video/h264" and "video/h264,audio/aac“.
Dieser Parameter ist optional; der Standardwert ist `null` (oder leer in JSON).
Typ: Zeichenfolge
Längenbeschränkungen: Minimale Länge beträgt 1 Zeichen. Maximale Länge beträgt 128 Zeichen.
Pattern: `[\w\-\.\+]+/[\w\-\.\+]+(,[\w\-\.\+]+/[\w\-\.\+]+)*`
Erforderlich: Nein
** [StreamName](#API_CreateStream_RequestSyntax) **
Ein Name für den Stream, den Sie erstellen.
Der Streamname ist eine Kennung für den Stream und muss für jedes Konto und jede Region eindeutig sein.
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: Ja
** [StreamStorageConfiguration](#API_CreateStream_RequestSyntax) **
Die Konfiguration für den Speicher des Streams, einschließlich der Standardspeicherebene für Stream-Daten. Diese Konfiguration bestimmt, wie Stream-Daten gespeichert und abgerufen werden, wobei verschiedene Stufen unterschiedliche Leistungs- und Kostenoptimierungsstufen bieten.
Wenn nicht angegeben, verwendet der Stream die Standardspeicherkonfiguration mit HOT-Stufe, um eine optimale Leistung zu erzielen.
Typ: [StreamStorageConfiguration](API_StreamStorageConfiguration.md) Objekt
Erforderlich: Nein
** [Tags](#API_CreateStream_RequestSyntax) **
Eine Liste von Tags, die dem angegebenen Stream zugeordnet werden sollen. Jedes Tag ist ein Schlüssel-Wert-Paar (der Wert ist optional).
Typ: Abbildung einer Zeichenfolge auf eine Zeichenfolge
Karteneinträge: Maximale Anzahl von 50 Elementen.
Schlüssel-Längenbeschränkungen: Minimale Länge von 1. Maximale Länge beträgt 128 Zeichen.
Schlüssel-Muster: `^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$`
Längenbeschränkungen für Werte: Mindestlänge von 0. Maximale Länge beträgt 256 Zeichen.
Wertemuster: `[\p{L}\p{Z}\p{N}_.:/=+\-@]*`
Erforderlich: Nein
## Antwortsyntax
```
HTTP/1.1 200
Content-type: application/json
{
"StreamARN": "string"
}
```
## Antwortelemente
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.
** [StreamARN](#API_CreateStream_ResponseSyntax) **
Der Amazon-Ressourcenname (ARN) des -Stream.
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]+`
## Fehler
Weitere Informationen zu den allgemeinen Fehlern, die bei allen Aktionen zurückgegeben werden, finden Sie unter [Häufige Fehlertypen](CommonErrors.md).
** AccountStreamLimitExceededException **
Die Anzahl der für das Konto erstellten Streams ist zu hoch.
HTTP-Statuscode: 400
** ClientLimitExceededException **
Kinesis Video Streams hat die Anfrage gedrosselt, weil Sie das Limit der erlaubten Client-Aufrufe überschritten haben. Versuchen Sie später, den Anruf zu tätigen.
HTTP-Statuscode: 400
** DeviceStreamLimitExceededException **
Nicht implementiert.
HTTP-Statuscode: 400
** InvalidArgumentException **
Der Wert für diesen Eingabeparameter ist ungültig.
HTTP-Statuscode: 400
** InvalidDeviceException **
Nicht implementiert.
HTTP-Statuscode: 400
** ResourceInUseException **
Wenn der Eingang `StreamARN` oder `ChannelARN` Eingang bereits einer anderen Kinesis Video Stream-Ressource zugeordnet `CLOUD_STORAGE_MODE` ist oder wenn sich der angegebene Eingang `StreamARN` oder Eingang nicht im Status Aktiv `ChannelARN` befindet, versuchen Sie es mit einer der folgenden Methoden:
1. Die `DescribeMediaStorageConfiguration` API, um zu ermitteln, welchem Stream der angegebene Kanal zugeordnet ist.
1. Die `DescribeMappedResourceConfiguration` API zur Bestimmung des Kanals, dem der angegebene Stream zugeordnet ist.
1. Die `DescribeStream` oder `DescribeSignalingChannel` API zur Bestimmung des Status der Ressource.
HTTP-Statuscode: 400
** TagsPerResourceExceededLimitException **
Sie haben das Limit an Tags überschritten, die Sie der Ressource zuordnen können. Ein Kinesis-Videostream kann bis zu 50 Tags unterstützen.
HTTP-Statuscode: 400
## Weitere Informationen finden Sie unter:
Weitere Informationen zur Verwendung dieser API in einer der sprachspezifischen Sprachen finden Sie im AWS SDKs Folgenden:
+ [AWS Befehlszeilenschnittstelle V2](https://docs.aws.amazon.com/goto/cli2/kinesisvideo-2017-09-30/CreateStream)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/kinesisvideo-2017-09-30/CreateStream)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/kinesisvideo-2017-09-30/CreateStream)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/kinesisvideo-2017-09-30/CreateStream)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/kinesisvideo-2017-09-30/CreateStream)
+ [AWS SDK für JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/kinesisvideo-2017-09-30/CreateStream)
+ [AWS SDK für Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/kinesisvideo-2017-09-30/CreateStream)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/kinesisvideo-2017-09-30/CreateStream)
+ [AWS SDK für Python](https://docs.aws.amazon.com/goto/boto3/kinesisvideo-2017-09-30/CreateStream)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/kinesisvideo-2017-09-30/CreateStream)
# DeleteEdgeConfiguration
Eine asynchrone API, die die bestehende Edge-Konfiguration eines Streams sowie die entsprechenden Medien aus dem Edge-Agent löscht.
Wenn Sie diese API aufrufen, wird der Synchronisierungsstatus auf gesetzt. `DELETING` Ein Löschvorgang wird gestartet, bei dem aktive Edge-Jobs gestoppt und alle Medien vom Edge-Gerät gelöscht werden. Die Dauer des Löschvorgangs hängt von der Gesamtmenge der gespeicherten Medien ab. Schlägt der Löschvorgang fehl, ändert sich der Synchronisierungsstatus auf`DELETE_FAILED`. Sie müssen den Löschvorgang erneut versuchen.
Wenn der Löschvorgang erfolgreich abgeschlossen wurde, kann nicht mehr auf die Edge-Konfiguration zugegriffen werden.
**Anmerkung**
Diese API ist in der Region AWS Afrika (Kapstadt), af-south-1, nicht verfügbar.
## Anforderungssyntax
```
POST /deleteEdgeConfiguration HTTP/1.1
Content-type: application/json
{
"StreamARN": "string",
"StreamName": "string"
}
```
## URI-Anfrageparameter
Die Anforderung verwendet keine URI-Parameter.
## Anforderungstext
Die Anforderung akzeptiert die folgenden Daten im JSON-Format.
** [StreamARN](#API_DeleteEdgeConfiguration_RequestSyntax) **
Der Amazon-Ressourcenname (ARN) des -Stream. Geben Sie entweder den oder den an`StreamName`. `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_DeleteEdgeConfiguration_RequestSyntax) **
Der Name des Streams, aus dem die Edge-Konfiguration gelöscht werden soll. Geben Sie entweder den `StreamName` oder den an`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
## Antwortsyntax
```
HTTP/1.1 200
```
## Antwortelemente
Wenn die Aktion erfolgreich ist, gibt der Dienst eine HTTP 200-Antwort mit leerem HTTP-Textinhalt zurück.
## Fehler
Weitere Informationen zu den allgemeinen Fehlern, die bei allen Aktionen zurückgegeben werden, finden Sie unter [Häufige Fehlertypen](CommonErrors.md).
** AccessDeniedException **
Sie verfügen nicht über die erforderlichen Berechtigungen, um diesen Vorgang auszuführen.
HTTP-Statuscode: 401
** ClientLimitExceededException **
Kinesis Video Streams hat die Anfrage gedrosselt, weil Sie das Limit der erlaubten Client-Aufrufe überschritten haben. Versuchen Sie später, den Anruf zu tätigen.
HTTP-Statuscode: 400
** InvalidArgumentException **
Der Wert für diesen Eingabeparameter ist ungültig.
HTTP-Statuscode: 400
** ResourceNotFoundException **
Amazon Kinesis Video Streams kann den von Ihnen angegebenen Stream nicht finden.
HTTP-Statuscode: 404
** StreamEdgeConfigurationNotFoundException **
Die Ausnahme wurde gerendert, wenn Amazon Kinesis Video Stream die von Ihnen angegebene Edge-Konfiguration eines Streams nicht finden kann.
HTTP-Statuscode: 404
## Weitere Informationen finden Sie unter:
Weitere Informationen zur Verwendung dieser API in einer der sprachspezifischen Sprachen finden Sie im AWS SDKs Folgenden:
+ [AWS Befehlszeilenschnittstelle V2](https://docs.aws.amazon.com/goto/cli2/kinesisvideo-2017-09-30/DeleteEdgeConfiguration)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/kinesisvideo-2017-09-30/DeleteEdgeConfiguration)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/kinesisvideo-2017-09-30/DeleteEdgeConfiguration)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/kinesisvideo-2017-09-30/DeleteEdgeConfiguration)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/kinesisvideo-2017-09-30/DeleteEdgeConfiguration)
+ [AWS SDK für JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/kinesisvideo-2017-09-30/DeleteEdgeConfiguration)
+ [AWS SDK für Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/kinesisvideo-2017-09-30/DeleteEdgeConfiguration)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/kinesisvideo-2017-09-30/DeleteEdgeConfiguration)
+ [AWS SDK für Python](https://docs.aws.amazon.com/goto/boto3/kinesisvideo-2017-09-30/DeleteEdgeConfiguration)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/kinesisvideo-2017-09-30/DeleteEdgeConfiguration)
# DeleteSignalingChannel
Löscht einen angegebenen Signalkanal. `DeleteSignalingChannel`ist eine asynchrone Operation. Wenn Sie die aktuelle Version des Kanals nicht angeben, wird die neueste Version gelöscht.
## Anforderungssyntax
```
POST /deleteSignalingChannel HTTP/1.1
Content-type: application/json
{
"ChannelARN": "string",
"CurrentVersion": "string"
}
```
## URI-Anfrageparameter
Die Anforderung verwendet keine URI-Parameter.
## Anforderungstext
Die Anforderung akzeptiert die folgenden Daten im JSON-Format.
** [ChannelARN](#API_DeleteSignalingChannel_RequestSyntax) **
Der Amazon-Ressourcenname (ARN) des Signalkanals, den Sie löschen möchten.
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: Ja
** [CurrentVersion](#API_DeleteSignalingChannel_RequestSyntax) **
Die aktuelle Version des Signalkanals, den Sie löschen möchten. Sie können die aktuelle Version abrufen, indem Sie die `ListSignalingChannels` API-Operationen `DescribeSignalingChannel` oder aufrufen.
Typ: Zeichenfolge
Längenbeschränkungen: Minimale Länge beträgt 1 Zeichen. Maximale Länge beträgt 64 Zeichen.
Pattern: `[a-zA-Z0-9]+`
Erforderlich: Nein
## Antwortsyntax
```
HTTP/1.1 200
```
## Antwortelemente
Wenn die Aktion erfolgreich ist, gibt der Dienst eine HTTP 200-Antwort mit leerem HTTP-Textinhalt zurück.
## Fehler
Weitere Informationen zu den allgemeinen Fehlern, die bei allen Aktionen zurückgegeben werden, finden Sie unter [Häufige Fehlertypen](CommonErrors.md).
** AccessDeniedException **
Sie verfügen nicht über die erforderlichen Berechtigungen, um diesen Vorgang auszuführen.
HTTP-Statuscode: 401
** ClientLimitExceededException **
Kinesis Video Streams hat die Anfrage gedrosselt, weil Sie das Limit der erlaubten Client-Aufrufe überschritten haben. Versuchen Sie später, den Anruf zu tätigen.
HTTP-Statuscode: 400
** InvalidArgumentException **
Der Wert für diesen Eingabeparameter ist ungültig.
HTTP-Statuscode: 400
** ResourceInUseException **
Wenn der Eingang `StreamARN` oder `ChannelARN` Eingang bereits einer anderen Kinesis Video Stream-Ressource zugeordnet `CLOUD_STORAGE_MODE` ist oder wenn sich der angegebene Eingang `StreamARN` oder Eingang nicht im Status Aktiv `ChannelARN` befindet, versuchen Sie es mit einer der folgenden Methoden:
1. Die `DescribeMediaStorageConfiguration` API, um zu ermitteln, welchem Stream der angegebene Kanal zugeordnet ist.
1. Die `DescribeMappedResourceConfiguration` API zur Bestimmung des Kanals, dem der angegebene Stream zugeordnet ist.
1. Die `DescribeStream` oder `DescribeSignalingChannel` API, um den Status der Ressource zu bestimmen.
HTTP-Statuscode: 400
** ResourceNotFoundException **
Amazon Kinesis Video Streams kann den von Ihnen angegebenen Stream nicht finden.
HTTP-Statuscode: 404
** VersionMismatchException **
Die von Ihnen angegebene Stream-Version ist nicht die neueste Version. Verwenden Sie die [DescribeStream](https://docs.aws.amazon.com/kinesisvideostreams/latest/dg/API_DescribeStream.html)API, um die neueste Version zu erhalten.
HTTP-Statuscode: 400
## Weitere Informationen finden Sie unter:
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/kinesisvideo-2017-09-30/DeleteSignalingChannel)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/kinesisvideo-2017-09-30/DeleteSignalingChannel)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/kinesisvideo-2017-09-30/DeleteSignalingChannel)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/kinesisvideo-2017-09-30/DeleteSignalingChannel)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/kinesisvideo-2017-09-30/DeleteSignalingChannel)
+ [AWS SDK für JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/kinesisvideo-2017-09-30/DeleteSignalingChannel)
+ [AWS SDK für Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/kinesisvideo-2017-09-30/DeleteSignalingChannel)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/kinesisvideo-2017-09-30/DeleteSignalingChannel)
+ [AWS SDK für Python](https://docs.aws.amazon.com/goto/boto3/kinesisvideo-2017-09-30/DeleteSignalingChannel)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/kinesisvideo-2017-09-30/DeleteSignalingChannel)
# DeleteStream
Löscht einen Kinesis-Videostream und die darin enthaltenen Daten.
Diese Methode markiert den Stream zum Löschen und macht den Zugriff auf die Daten im Stream sofort unmöglich.
Um sicherzustellen, dass Sie über die neueste Version des Streams verfügen, bevor Sie ihn löschen, können Sie die Stream-Version angeben. Kinesis Video Streams weist jedem Stream eine Version zu. Wenn Sie einen Stream aktualisieren, weist Kinesis Video Streams eine neue Versionsnummer zu. Verwenden Sie die API, um die neueste Stream-Version zu erhalten. `DescribeStream`
Diese Operation setzt eine Berechtigung für die `KinesisVideo:DeleteStream`-Aktion voraus.
## Anforderungssyntax
```
POST /deleteStream HTTP/1.1
Content-type: application/json
{
"CurrentVersion": "string",
"StreamARN": "string"
}
```
## URI-Anfrageparameter
Die Anforderung verwendet keine URI-Parameter.
## Anforderungstext
Die Anforderung akzeptiert die folgenden Daten im JSON-Format.
** [CurrentVersion](#API_DeleteStream_RequestSyntax) **
Optional: Die Version des Streams, die Sie löschen möchten.
Geben Sie die Version als Sicherheitsmaßnahme an, um sicherzustellen, dass Sie den richtigen Stream löschen. Verwenden Sie die `DescribeStream` API, um die Stream-Version abzurufen.
Wenn nicht angegeben, `CreationTime` wird nur der überprüft, bevor der Stream gelöscht wird.
Typ: Zeichenfolge
Längenbeschränkungen: Minimale Länge beträgt 1 Zeichen. Maximale Länge beträgt 64 Zeichen.
Pattern: `[a-zA-Z0-9]+`
Erforderlich: Nein
** [StreamARN](#API_DeleteStream_RequestSyntax) **
Der Amazon-Ressourcenname (ARN) des Streams, den Sie löschen möchten.
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: Ja
## Antwortsyntax
```
HTTP/1.1 200
```
## Antwortelemente
Wenn die Aktion erfolgreich ist, gibt der Dienst eine HTTP 200-Antwort mit leerem HTTP-Textinhalt zurück.
## Fehler
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 das Limit der erlaubten Client-Aufrufe überschritten haben. Versuchen Sie später, den Anruf zu tätigen.
HTTP-Statuscode: 400
** InvalidArgumentException **
Der Wert für diesen Eingabeparameter ist ungültig.
HTTP-Statuscode: 400
** NotAuthorizedException **
Der Anrufer ist nicht autorisiert, diesen Vorgang auszuführen.
HTTP-Statuscode: 401
** ResourceInUseException **
Wenn der Eingang `StreamARN` oder `ChannelARN` Eingang bereits einer anderen Kinesis Video Stream-Ressource zugeordnet `CLOUD_STORAGE_MODE` ist oder wenn sich der angegebene Eingang `StreamARN` oder Eingang nicht im Status Aktiv `ChannelARN` befindet, versuchen Sie es mit einer der folgenden Methoden:
1. Die `DescribeMediaStorageConfiguration` API, um zu ermitteln, welchem Stream der angegebene Kanal zugeordnet ist.
1. Die `DescribeMappedResourceConfiguration` API zur Bestimmung des Kanals, dem der angegebene Stream zugeordnet ist.
1. Die `DescribeStream` oder `DescribeSignalingChannel` API, um den Status der Ressource zu bestimmen.
HTTP-Statuscode: 400
** ResourceNotFoundException **
Amazon Kinesis Video Streams kann den von Ihnen angegebenen Stream nicht finden.
HTTP-Statuscode: 404
** VersionMismatchException **
Die von Ihnen angegebene Stream-Version ist nicht die neueste Version. Verwenden Sie die [DescribeStream](https://docs.aws.amazon.com/kinesisvideostreams/latest/dg/API_DescribeStream.html)API, um die neueste Version zu erhalten.
HTTP-Statuscode: 400
## Weitere Informationen finden Sie unter:
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/kinesisvideo-2017-09-30/DeleteStream)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/kinesisvideo-2017-09-30/DeleteStream)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/kinesisvideo-2017-09-30/DeleteStream)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/kinesisvideo-2017-09-30/DeleteStream)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/kinesisvideo-2017-09-30/DeleteStream)
+ [AWS SDK für JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/kinesisvideo-2017-09-30/DeleteStream)
+ [AWS SDK für Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/kinesisvideo-2017-09-30/DeleteStream)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/kinesisvideo-2017-09-30/DeleteStream)
+ [AWS SDK für Python](https://docs.aws.amazon.com/goto/boto3/kinesisvideo-2017-09-30/DeleteStream)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/kinesisvideo-2017-09-30/DeleteStream)
# DescribeEdgeConfiguration
Beschreibt die Edge-Konfiguration eines Streams, die mithilfe der `StartEdgeConfigurationUpdate` API festgelegt wurde, und den aktuellen Status der Recorder- und Uploader-Jobs des Edge-Agenten. Verwenden Sie diese API, um den Status der Konfiguration abzurufen und festzustellen, ob die Konfiguration mit dem Edge-Agent synchronisiert ist. Verwenden Sie diese API, um den Zustand des Edge-Agenten zu bewerten.
**Anmerkung**
Diese API ist in der Region AWS Afrika (Kapstadt), af-south-1, nicht verfügbar.
## Anforderungssyntax
```
POST /describeEdgeConfiguration HTTP/1.1
Content-type: application/json
{
"StreamARN": "string",
"StreamName": "string"
}
```
## URI-Anfrageparameter
Die Anforderung verwendet keine URI-Parameter.
## Anforderungstext
Die Anforderung akzeptiert die folgenden Daten im JSON-Format.
** [StreamARN](#API_DescribeEdgeConfiguration_RequestSyntax) **
Der Amazon-Ressourcenname (ARN) des -Stream. Geben Sie entweder den oder den an`StreamName`. `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_DescribeEdgeConfiguration_RequestSyntax) **
Der Name des Streams, dessen Edge-Konfiguration Sie aktualisieren möchten. Geben Sie entweder den `StreamName` oder den an`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
## Antwortsyntax
```
HTTP/1.1 200
Content-type: application/json
{
"CreationTime": number,
"EdgeAgentStatus": {
"LastRecorderStatus": {
"JobStatusDetails": "string",
"LastCollectedTime": number,
"LastUpdatedTime": number,
"RecorderStatus": "string"
},
"LastUploaderStatus": {
"JobStatusDetails": "string",
"LastCollectedTime": number,
"LastUpdatedTime": number,
"UploaderStatus": "string"
}
},
"EdgeConfig": {
"DeletionConfig": {
"DeleteAfterUpload": boolean,
"EdgeRetentionInHours": number,
"LocalSizeConfig": {
"MaxLocalMediaSizeInMB": number,
"StrategyOnFullSize": "string"
}
},
"HubDeviceArn": "string",
"RecorderConfig": {
"MediaSourceConfig": {
"MediaUriSecretArn": "string",
"MediaUriType": "string"
},
"ScheduleConfig": {
"DurationInSeconds": number,
"ScheduleExpression": "string"
}
},
"UploaderConfig": {
"ScheduleConfig": {
"DurationInSeconds": number,
"ScheduleExpression": "string"
}
}
},
"FailedStatusDetails": "string",
"LastUpdatedTime": number,
"StreamARN": "string",
"StreamName": "string",
"SyncStatus": "string"
}
```
## Antwortelemente
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.
** [CreationTime](#API_DescribeEdgeConfiguration_ResponseSyntax) **
Der Zeitstempel, zu dem die Edge-Konfiguration eines Streams zum ersten Mal erstellt wurde.
Typ: Zeitstempel
** [EdgeAgentStatus](#API_DescribeEdgeConfiguration_ResponseSyntax) **
Ein Objekt, das die neuesten Statusdetails für die Recorder- und Uploader-Jobs eines Edge-Agenten enthält. Verwenden Sie diese Informationen, um den aktuellen Zustand eines Edge-Agents zu ermitteln.
Typ: [EdgeAgentStatus](API_EdgeAgentStatus.md) Objekt
** [EdgeConfig](#API_DescribeEdgeConfiguration_ResponseSyntax) **
Eine Beschreibung der Edge-Konfiguration des Streams, die für die Synchronisierung mit der Edge Agent IoT Greengrass-Komponente verwendet wird. Die Edge Agent-Komponente wird auf einem IoT Hub-Gerät ausgeführt, das bei Ihnen vor Ort eingerichtet ist.
Typ: [EdgeConfig](API_EdgeConfig.md) Objekt
** [FailedStatusDetails](#API_DescribeEdgeConfiguration_ResponseSyntax) **
Eine Beschreibung des generierten Fehlerstatus.
Typ: Zeichenfolge
** [LastUpdatedTime](#API_DescribeEdgeConfiguration_ResponseSyntax) **
Der Zeitstempel, zu dem die Edge-Konfiguration eines Streams zuletzt aktualisiert wurde.
Typ: Zeitstempel
** [StreamARN](#API_DescribeEdgeConfiguration_ResponseSyntax) **
Der Amazon-Ressourcenname (ARN) des -Stream.
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]+`
** [StreamName](#API_DescribeEdgeConfiguration_ResponseSyntax) **
Der Name des Streams, von dem aus die Edge-Konfiguration aktualisiert wurde.
Typ: Zeichenfolge
Längenbeschränkungen: Minimale Länge beträgt 1 Zeichen. Maximale Länge beträgt 256 Zeichen.
Pattern: `[a-zA-Z0-9_.-]+`
** [SyncStatus](#API_DescribeEdgeConfiguration_ResponseSyntax) **
Der neueste Status des Edge-Konfigurationsupdates.
Typ: Zeichenfolge
Zulässige Werte: `SYNCING | ACKNOWLEDGED | IN_SYNC | SYNC_FAILED | DELETING | DELETE_FAILED | DELETING_ACKNOWLEDGED`
## Fehler
Weitere Informationen zu den allgemeinen Fehlern, die bei allen Aktionen zurückgegeben werden, finden Sie unter [Häufige Fehlertypen](CommonErrors.md).
** AccessDeniedException **
Sie verfügen nicht über die erforderlichen Berechtigungen, um diesen Vorgang auszuführen.
HTTP-Statuscode: 401
** ClientLimitExceededException **
Kinesis Video Streams hat die Anfrage gedrosselt, weil Sie das Limit der erlaubten Client-Aufrufe überschritten haben. Versuchen Sie später, den Anruf zu tätigen.
HTTP-Statuscode: 400
** InvalidArgumentException **
Der Wert für diesen Eingabeparameter ist ungültig.
HTTP-Statuscode: 400
** ResourceNotFoundException **
Amazon Kinesis Video Streams kann den von Ihnen angegebenen Stream nicht finden.
HTTP-Statuscode: 404
** StreamEdgeConfigurationNotFoundException **
Die Ausnahme wurde gerendert, wenn Amazon Kinesis Video Stream die von Ihnen angegebene Edge-Konfiguration eines Streams nicht finden kann.
HTTP-Statuscode: 404
## Weitere Informationen finden Sie unter:
Weitere Informationen zur Verwendung dieser API in einer der sprachspezifischen Sprachen finden Sie im AWS SDKs Folgenden:
+ [AWS Befehlszeilenschnittstelle V2](https://docs.aws.amazon.com/goto/cli2/kinesisvideo-2017-09-30/DescribeEdgeConfiguration)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/kinesisvideo-2017-09-30/DescribeEdgeConfiguration)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/kinesisvideo-2017-09-30/DescribeEdgeConfiguration)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/kinesisvideo-2017-09-30/DescribeEdgeConfiguration)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/kinesisvideo-2017-09-30/DescribeEdgeConfiguration)
+ [AWS SDK für JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/kinesisvideo-2017-09-30/DescribeEdgeConfiguration)
+ [AWS SDK für Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/kinesisvideo-2017-09-30/DescribeEdgeConfiguration)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/kinesisvideo-2017-09-30/DescribeEdgeConfiguration)
+ [AWS SDK für Python](https://docs.aws.amazon.com/goto/boto3/kinesisvideo-2017-09-30/DescribeEdgeConfiguration)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/kinesisvideo-2017-09-30/DescribeEdgeConfiguration)
# DescribeImageGenerationConfiguration
Ruft das `ImageGenerationConfiguration` für einen bestimmten Kinesis-Videostream ab.
## Anforderungssyntax
```
POST /describeImageGenerationConfiguration HTTP/1.1
Content-type: application/json
{
"StreamARN": "string",
"StreamName": "string"
}
```
## URI-Anfrageparameter
Die Anforderung verwendet keine URI-Parameter.
## Anforderungstext
Die Anforderung akzeptiert die folgenden Daten im JSON-Format.
** [StreamARN](#API_DescribeImageGenerationConfiguration_RequestSyntax) **
Der Amazon-Ressourcenname (ARN) des Kinesis-Videostreams, aus dem die Konfiguration zur Bilderzeugung abgerufen werden soll. Sie müssen entweder den `StreamName` oder den `StreamARN` angeben.
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_DescribeImageGenerationConfiguration_RequestSyntax) **
Der Name des Streams, aus dem die Konfiguration zur Image-Generierung abgerufen werden soll. 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
## Antwortsyntax
```
HTTP/1.1 200
Content-type: application/json
{
"ImageGenerationConfiguration": {
"DestinationConfig": {
"DestinationRegion": "string",
"Uri": "string"
},
"Format": "string",
"FormatConfig": {
"string" : "string"
},
"HeightPixels": number,
"ImageSelectorType": "string",
"SamplingInterval": number,
"Status": "string",
"WidthPixels": number
}
}
```
## Antwortelemente
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.
** [ImageGenerationConfiguration](#API_DescribeImageGenerationConfiguration_ResponseSyntax) **
Die Struktur, die die Informationen enthält, die für die Übertragung von Kinesis-Videostream (KVS) -Bildern erforderlich sind. Wenn diese Struktur Null ist, wird die Konfiguration aus dem Stream gelöscht.
Typ: [ImageGenerationConfiguration](API_ImageGenerationConfiguration.md) Objekt
## Fehler
Weitere Informationen zu den allgemeinen Fehlern, die bei allen Aktionen zurückgegeben werden, finden Sie unter [Häufige Fehlertypen](CommonErrors.md).
** AccessDeniedException **
Sie verfügen nicht über die erforderlichen Berechtigungen, um diesen Vorgang auszuführen.
HTTP-Statuscode: 401
** ClientLimitExceededException **
Kinesis Video Streams hat die Anfrage gedrosselt, weil Sie das Limit der erlaubten Client-Aufrufe überschritten haben. Versuchen Sie später, den Anruf zu tätigen.
HTTP-Statuscode: 400
** InvalidArgumentException **
Der Wert für diesen Eingabeparameter ist ungültig.
HTTP-Statuscode: 400
** ResourceNotFoundException **
Amazon Kinesis Video Streams kann den von Ihnen angegebenen Stream nicht finden.
HTTP-Statuscode: 404
## Weitere Informationen finden Sie unter:
Weitere Informationen zur Verwendung dieser API in einer der sprachspezifischen Sprachen finden Sie im AWS SDKs Folgenden:
+ [AWS Befehlszeilenschnittstelle V2](https://docs.aws.amazon.com/goto/cli2/kinesisvideo-2017-09-30/DescribeImageGenerationConfiguration)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/kinesisvideo-2017-09-30/DescribeImageGenerationConfiguration)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/kinesisvideo-2017-09-30/DescribeImageGenerationConfiguration)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/kinesisvideo-2017-09-30/DescribeImageGenerationConfiguration)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/kinesisvideo-2017-09-30/DescribeImageGenerationConfiguration)
+ [AWS SDK für JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/kinesisvideo-2017-09-30/DescribeImageGenerationConfiguration)
+ [AWS SDK für Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/kinesisvideo-2017-09-30/DescribeImageGenerationConfiguration)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/kinesisvideo-2017-09-30/DescribeImageGenerationConfiguration)
+ [AWS SDK für Python](https://docs.aws.amazon.com/goto/boto3/kinesisvideo-2017-09-30/DescribeImageGenerationConfiguration)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/kinesisvideo-2017-09-30/DescribeImageGenerationConfiguration)
# DescribeMappedResourceConfiguration
Gibt die aktuellsten Informationen über den Stream zurück. Das `streamName` oder `streamARN` sollte in der Eingabe angegeben werden.
## Anforderungssyntax
```
POST /describeMappedResourceConfiguration HTTP/1.1
Content-type: application/json
{
"MaxResults": number,
"NextToken": "string",
"StreamARN": "string",
"StreamName": "string"
}
```
## URI-Anfrageparameter
Die Anforderung verwendet keine URI-Parameter.
## Anforderungstext
Die Anforderung akzeptiert die folgenden Daten im JSON-Format.
** [MaxResults](#API_DescribeMappedResourceConfiguration_RequestSyntax) **
Die maximale Anzahl von Ergebnissen, die in der Antwort zurückgegeben werden sollen.
Typ: Ganzzahl
Gültiger Bereich: Fester Wert von 1.
Erforderlich: Nein
** [NextToken](#API_DescribeMappedResourceConfiguration_RequestSyntax) **
Das Token, das Sie in Ihrer nächsten Anfrage angeben müssen, um weitere Ergebnisse zu erhalten.
Typ: Zeichenfolge
Längenbeschränkungen: Minimale Länge von 0. Maximale Länge beträgt 1024 Zeichen.
Pattern: `[a-zA-Z0-9+/=]*`
Erforderlich: Nein
** [StreamARN](#API_DescribeMappedResourceConfiguration_RequestSyntax) **
Der Amazon-Ressourcenname (ARN) des -Stream.
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_DescribeMappedResourceConfiguration_RequestSyntax) **
Name des -Streams.
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
## Antwortsyntax
```
HTTP/1.1 200
Content-type: application/json
{
"MappedResourceConfigurationList": [
{
"ARN": "string",
"Type": "string"
}
],
"NextToken": "string"
}
```
## Antwortelemente
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.
** [MappedResourceConfigurationList](#API_DescribeMappedResourceConfiguration_ResponseSyntax) **
Eine Struktur, die die Eigenschaften der Medienspeicherkonfiguration kapselt oder enthält.
Typ: Array von [MappedResourceConfigurationListItem](API_MappedResourceConfigurationListItem.md)-Objekten
Array-Mitglieder: Die Mindestanzahl beträgt 0 Elemente. Die maximale Anzahl beträgt 1 Element.
** [NextToken](#API_DescribeMappedResourceConfiguration_ResponseSyntax) **
Das Token, das in der `NextToken` Anforderung verwendet wurde, um die nächsten Ergebnisse abzurufen.
Typ: Zeichenfolge
Längenbeschränkungen: Minimale Länge von 0. Maximale Länge beträgt 1024 Zeichen.
Pattern: `[a-zA-Z0-9+/=]*`
## Fehler
Weitere Informationen zu den allgemeinen Fehlern, die bei allen Aktionen zurückgegeben werden, finden Sie unter [Häufige Fehlertypen](CommonErrors.md).
** AccessDeniedException **
Sie verfügen nicht über die erforderlichen Berechtigungen, um diesen Vorgang auszuführen.
HTTP-Statuscode: 401
** ClientLimitExceededException **
Kinesis Video Streams hat die Anfrage gedrosselt, weil Sie das Limit der erlaubten Client-Aufrufe überschritten haben. Versuchen Sie später, den Anruf zu tätigen.
HTTP-Statuscode: 400
** InvalidArgumentException **
Der Wert für diesen Eingabeparameter ist ungültig.
HTTP-Statuscode: 400
** ResourceNotFoundException **
Amazon Kinesis Video Streams kann den von Ihnen angegebenen Stream nicht finden.
HTTP-Statuscode: 404
## Weitere Informationen finden Sie unter:
Weitere Informationen zur Verwendung dieser API in einer der sprachspezifischen Sprachen finden Sie im AWS SDKs Folgenden:
+ [AWS Befehlszeilenschnittstelle V2](https://docs.aws.amazon.com/goto/cli2/kinesisvideo-2017-09-30/DescribeMappedResourceConfiguration)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/kinesisvideo-2017-09-30/DescribeMappedResourceConfiguration)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/kinesisvideo-2017-09-30/DescribeMappedResourceConfiguration)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/kinesisvideo-2017-09-30/DescribeMappedResourceConfiguration)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/kinesisvideo-2017-09-30/DescribeMappedResourceConfiguration)
+ [AWS SDK für JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/kinesisvideo-2017-09-30/DescribeMappedResourceConfiguration)
+ [AWS SDK für Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/kinesisvideo-2017-09-30/DescribeMappedResourceConfiguration)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/kinesisvideo-2017-09-30/DescribeMappedResourceConfiguration)
+ [AWS SDK für Python](https://docs.aws.amazon.com/goto/boto3/kinesisvideo-2017-09-30/DescribeMappedResourceConfiguration)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/kinesisvideo-2017-09-30/DescribeMappedResourceConfiguration)
# DescribeMediaStorageConfiguration
Gibt die aktuellsten Informationen über den Kanal zurück. Geben Sie das `ChannelName` oder `ChannelARN` in der Eingabe an.
## Anforderungssyntax
```
POST /describeMediaStorageConfiguration HTTP/1.1
Content-type: application/json
{
"ChannelARN": "string",
"ChannelName": "string"
}
```
## URI-Anfrageparameter
Die Anforderung verwendet keine URI-Parameter.
## Anforderungstext
Die Anforderung akzeptiert die folgenden Daten im JSON-Format.
** [ChannelARN](#API_DescribeMediaStorageConfiguration_RequestSyntax) **
Der Amazon-Ressourcenname (ARN) des Kanals.
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
** [ChannelName](#API_DescribeMediaStorageConfiguration_RequestSyntax) **
Der Name des Kanal.
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
## Antwortsyntax
```
HTTP/1.1 200
Content-type: application/json
{
"MediaStorageConfiguration": {
"Status": "string",
"StreamARN": "string"
}
}
```
## Antwortelemente
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.
** [MediaStorageConfiguration](#API_DescribeMediaStorageConfiguration_ResponseSyntax) **
Eine Struktur, die die Konfigurationseigenschaften des Medienspeichers kapselt oder enthält.
Typ: [MediaStorageConfiguration](API_MediaStorageConfiguration.md) Objekt
## Fehler
Weitere Informationen zu den allgemeinen Fehlern, die bei allen Aktionen zurückgegeben werden, finden Sie unter [Häufige Fehlertypen](CommonErrors.md).
** AccessDeniedException **
Sie verfügen nicht über die erforderlichen Berechtigungen, um diesen Vorgang auszuführen.
HTTP-Statuscode: 401
** ClientLimitExceededException **
Kinesis Video Streams hat die Anfrage gedrosselt, weil Sie das Limit der erlaubten Client-Aufrufe überschritten haben. Versuchen Sie später, den Anruf zu tätigen.
HTTP-Statuscode: 400
** InvalidArgumentException **
Der Wert für diesen Eingabeparameter ist ungültig.
HTTP-Statuscode: 400
** ResourceNotFoundException **
Amazon Kinesis Video Streams kann den von Ihnen angegebenen Stream nicht finden.
HTTP-Statuscode: 404
## Weitere Informationen finden Sie unter:
Weitere Informationen zur Verwendung dieser API in einer der sprachspezifischen Sprachen finden Sie im AWS SDKs Folgenden:
+ [AWS Befehlszeilenschnittstelle V2](https://docs.aws.amazon.com/goto/cli2/kinesisvideo-2017-09-30/DescribeMediaStorageConfiguration)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/kinesisvideo-2017-09-30/DescribeMediaStorageConfiguration)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/kinesisvideo-2017-09-30/DescribeMediaStorageConfiguration)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/kinesisvideo-2017-09-30/DescribeMediaStorageConfiguration)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/kinesisvideo-2017-09-30/DescribeMediaStorageConfiguration)
+ [AWS SDK für JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/kinesisvideo-2017-09-30/DescribeMediaStorageConfiguration)
+ [AWS SDK für Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/kinesisvideo-2017-09-30/DescribeMediaStorageConfiguration)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/kinesisvideo-2017-09-30/DescribeMediaStorageConfiguration)
+ [AWS SDK für Python](https://docs.aws.amazon.com/goto/boto3/kinesisvideo-2017-09-30/DescribeMediaStorageConfiguration)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/kinesisvideo-2017-09-30/DescribeMediaStorageConfiguration)
# DescribeNotificationConfiguration
Ruft das `NotificationConfiguration` für einen bestimmten Kinesis-Videostream ab.
## Anforderungssyntax
```
POST /describeNotificationConfiguration HTTP/1.1
Content-type: application/json
{
"StreamARN": "string",
"StreamName": "string"
}
```
## URI-Anfrageparameter
Die Anforderung verwendet keine URI-Parameter.
## Anforderungstext
Die Anforderung akzeptiert die folgenden Daten im JSON-Format.
** [StreamARN](#API_DescribeNotificationConfiguration_RequestSyntax) **
Der Amazon-Ressourcenname (ARN) des Kinesis-Videostreams, von dem Sie die Benachrichtigungskonfiguration abrufen möchten. Sie müssen entweder den `StreamName` oder den StreamArn angeben.
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_DescribeNotificationConfiguration_RequestSyntax) **
Der Name des Streams, aus dem die Benachrichtigungskonfiguration abgerufen werden soll. 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
## Antwortsyntax
```
HTTP/1.1 200
Content-type: application/json
{
"NotificationConfiguration": {
"DestinationConfig": {
"Uri": "string"
},
"Status": "string"
}
}
```
## Antwortelemente
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.
** [NotificationConfiguration](#API_DescribeNotificationConfiguration_ResponseSyntax) **
Die Struktur, die die für Benachrichtigungen erforderlichen Informationen enthält. Wenn die Struktur Null ist, wird die Konfiguration aus dem Stream gelöscht.
Typ: [NotificationConfiguration](API_NotificationConfiguration.md) Objekt
## Fehler
Weitere Informationen zu den allgemeinen Fehlern, die bei allen Aktionen zurückgegeben werden, finden Sie unter [Häufige Fehlertypen](CommonErrors.md).
** AccessDeniedException **
Sie verfügen nicht über die erforderlichen Berechtigungen, um diesen Vorgang auszuführen.
HTTP-Statuscode: 401
** ClientLimitExceededException **
Kinesis Video Streams hat die Anfrage gedrosselt, weil Sie das Limit der erlaubten Client-Aufrufe überschritten haben. Versuchen Sie später, den Anruf zu tätigen.
HTTP-Statuscode: 400
** InvalidArgumentException **
Der Wert für diesen Eingabeparameter ist ungültig.
HTTP-Statuscode: 400
** ResourceNotFoundException **
Amazon Kinesis Video Streams kann den von Ihnen angegebenen Stream nicht finden.
HTTP-Statuscode: 404
## Weitere Informationen finden Sie unter:
Weitere Informationen zur Verwendung dieser API in einer der sprachspezifischen Sprachen finden Sie im AWS SDKs Folgenden:
+ [AWS Befehlszeilenschnittstelle V2](https://docs.aws.amazon.com/goto/cli2/kinesisvideo-2017-09-30/DescribeNotificationConfiguration)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/kinesisvideo-2017-09-30/DescribeNotificationConfiguration)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/kinesisvideo-2017-09-30/DescribeNotificationConfiguration)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/kinesisvideo-2017-09-30/DescribeNotificationConfiguration)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/kinesisvideo-2017-09-30/DescribeNotificationConfiguration)
+ [AWS SDK für JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/kinesisvideo-2017-09-30/DescribeNotificationConfiguration)
+ [AWS SDK für Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/kinesisvideo-2017-09-30/DescribeNotificationConfiguration)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/kinesisvideo-2017-09-30/DescribeNotificationConfiguration)
+ [AWS SDK für Python](https://docs.aws.amazon.com/goto/boto3/kinesisvideo-2017-09-30/DescribeNotificationConfiguration)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/kinesisvideo-2017-09-30/DescribeNotificationConfiguration)
# DescribeSignalingChannel
Gibt die aktuellsten Informationen über den Signalkanal zurück. Sie müssen entweder den Namen oder den Amazon-Ressourcennamen (ARN) des Kanals angeben, den Sie beschreiben möchten.
## Anforderungssyntax
```
POST /describeSignalingChannel HTTP/1.1
Content-type: application/json
{
"ChannelARN": "string",
"ChannelName": "string"
}
```
## URI-Anfrageparameter
Die Anforderung verwendet keine URI-Parameter.
## Anforderungstext
Die Anforderung akzeptiert die folgenden Daten im JSON-Format.
** [ChannelARN](#API_DescribeSignalingChannel_RequestSyntax) **
Der ARN des Signalkanals, den Sie beschreiben möchten.
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
** [ChannelName](#API_DescribeSignalingChannel_RequestSyntax) **
Der Name des Signalkanals, den Sie beschreiben möchten.
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
## Antwortsyntax
```
HTTP/1.1 200
Content-type: application/json
{
"ChannelInfo": {
"ChannelARN": "string",
"ChannelName": "string",
"ChannelStatus": "string",
"ChannelType": "string",
"CreationTime": number,
"SingleMasterConfiguration": {
"MessageTtlSeconds": number
},
"Version": "string"
}
}
```
## Antwortelemente
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.
** [ChannelInfo](#API_DescribeSignalingChannel_ResponseSyntax) **
Eine Struktur, die die Metadaten und Eigenschaften des angegebenen Signalkanals kapselt.
Typ: [ChannelInfo](API_ChannelInfo.md) Objekt
## Fehler
Weitere Informationen zu den allgemeinen Fehlern, die bei allen Aktionen zurückgegeben werden, finden Sie unter [Häufige Fehlertypen](CommonErrors.md).
** AccessDeniedException **
Sie verfügen nicht über die erforderlichen Berechtigungen, um diesen Vorgang auszuführen.
HTTP-Statuscode: 401
** ClientLimitExceededException **
Kinesis Video Streams hat die Anfrage gedrosselt, weil Sie das Limit der erlaubten Client-Aufrufe überschritten haben. Versuchen Sie später, den Anruf zu tätigen.
HTTP-Statuscode: 400
** InvalidArgumentException **
Der Wert für diesen Eingabeparameter ist ungültig.
HTTP-Statuscode: 400
** ResourceNotFoundException **
Amazon Kinesis Video Streams kann den von Ihnen angegebenen Stream nicht finden.
HTTP-Statuscode: 404
## Weitere Informationen finden Sie unter:
Weitere Informationen zur Verwendung dieser API in einer der sprachspezifischen Sprachen finden Sie im AWS SDKs Folgenden:
+ [AWS Befehlszeilenschnittstelle V2](https://docs.aws.amazon.com/goto/cli2/kinesisvideo-2017-09-30/DescribeSignalingChannel)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/kinesisvideo-2017-09-30/DescribeSignalingChannel)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/kinesisvideo-2017-09-30/DescribeSignalingChannel)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/kinesisvideo-2017-09-30/DescribeSignalingChannel)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/kinesisvideo-2017-09-30/DescribeSignalingChannel)
+ [AWS SDK für JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/kinesisvideo-2017-09-30/DescribeSignalingChannel)
+ [AWS SDK für Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/kinesisvideo-2017-09-30/DescribeSignalingChannel)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/kinesisvideo-2017-09-30/DescribeSignalingChannel)
+ [AWS SDK für Python](https://docs.aws.amazon.com/goto/boto3/kinesisvideo-2017-09-30/DescribeSignalingChannel)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/kinesisvideo-2017-09-30/DescribeSignalingChannel)
# DescribeStream
Gibt die aktuellsten Informationen über den angegebenen Stream zurück. Sie müssen entweder den `StreamName` oder den angeben`StreamARN`.
## Anforderungssyntax
```
POST /describeStream HTTP/1.1
Content-type: application/json
{
"StreamARN": "string",
"StreamName": "string"
}
```
## URI-Anfrageparameter
Die Anforderung verwendet keine URI-Parameter.
## Anforderungstext
Die Anforderung akzeptiert die folgenden Daten im JSON-Format.
** [StreamARN](#API_DescribeStream_RequestSyntax) **
Der Amazon-Ressourcenname (ARN) des -Stream.
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_DescribeStream_RequestSyntax) **
Name des -Streams.
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
## Antwortsyntax
```
HTTP/1.1 200
Content-type: application/json
{
"StreamInfo": {
"CreationTime": number,
"DataRetentionInHours": number,
"DeviceName": "string",
"KmsKeyId": "string",
"MediaType": "string",
"Status": "string",
"StreamARN": "string",
"StreamName": "string",
"Version": "string"
}
}
```
## Antwortelemente
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.
** [StreamInfo](#API_DescribeStream_ResponseSyntax) **
Ein Objekt, das den Stream beschreibt.
Typ: [StreamInfo](API_StreamInfo.md) Objekt
## Fehler
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 das Limit der erlaubten Client-Aufrufe überschritten haben. Versuchen Sie später, den Anruf zu tätigen.
HTTP-Statuscode: 400
** InvalidArgumentException **
Der Wert für diesen Eingabeparameter ist ungültig.
HTTP-Statuscode: 400
** NotAuthorizedException **
Der Anrufer ist nicht autorisiert, diesen Vorgang auszuführen.
HTTP-Statuscode: 401
** ResourceNotFoundException **
Amazon Kinesis Video Streams kann den von Ihnen angegebenen Stream nicht finden.
HTTP-Statuscode: 404
## Weitere Informationen finden Sie unter:
Weitere Informationen zur Verwendung dieser API in einer der sprachspezifischen Sprachen finden Sie im AWS SDKs Folgenden:
+ [AWS Befehlszeilenschnittstelle V2](https://docs.aws.amazon.com/goto/cli2/kinesisvideo-2017-09-30/DescribeStream)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/kinesisvideo-2017-09-30/DescribeStream)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/kinesisvideo-2017-09-30/DescribeStream)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/kinesisvideo-2017-09-30/DescribeStream)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/kinesisvideo-2017-09-30/DescribeStream)
+ [AWS SDK für JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/kinesisvideo-2017-09-30/DescribeStream)
+ [AWS SDK für Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/kinesisvideo-2017-09-30/DescribeStream)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/kinesisvideo-2017-09-30/DescribeStream)
+ [AWS SDK für Python](https://docs.aws.amazon.com/goto/boto3/kinesisvideo-2017-09-30/DescribeStream)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/kinesisvideo-2017-09-30/DescribeStream)
# DescribeStreamStorageConfiguration
Ruft die aktuelle Speicherkonfiguration für den angegebenen Kinesis-Videostream ab.
In der Anfrage müssen Sie entweder den `StreamName` oder den angeben. `StreamARN`
Sie müssen über Berechtigungen für die `KinesisVideo:DescribeStreamStorageConfiguration`-Aktion verfügen.
## Anforderungssyntax
```
POST /describeStreamStorageConfiguration HTTP/1.1
Content-type: application/json
{
"StreamARN": "string",
"StreamName": "string"
}
```
## URI-Anfrageparameter
Die Anforderung verwendet keine URI-Parameter.
## Anforderungstext
Die Anforderung akzeptiert die folgenden Daten im JSON-Format.
** [StreamARN](#API_DescribeStreamStorageConfiguration_RequestSyntax) **
Der Amazon-Ressourcenname (ARN) des Streams, für den Sie die Speicherkonfiguration abrufen möchten.
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_DescribeStreamStorageConfiguration_RequestSyntax) **
Der Name des Streams, für den Sie die Speicherkonfiguration abrufen möchten.
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
## Antwortsyntax
```
HTTP/1.1 200
Content-type: application/json
{
"StreamARN": "string",
"StreamName": "string",
"StreamStorageConfiguration": {
"DefaultStorageTier": "string"
}
}
```
## Antwortelemente
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.
** [StreamARN](#API_DescribeStreamStorageConfiguration_ResponseSyntax) **
Der Amazon-Ressourcenname (ARN) des -Stream.
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]+`
** [StreamName](#API_DescribeStreamStorageConfiguration_ResponseSyntax) **
Name des -Streams.
Typ: Zeichenfolge
Längenbeschränkungen: Minimale Länge beträgt 1 Zeichen. Maximale Länge beträgt 256 Zeichen.
Pattern: `[a-zA-Z0-9_.-]+`
** [StreamStorageConfiguration](#API_DescribeStreamStorageConfiguration_ResponseSyntax) **
Die aktuelle Speicherkonfiguration für den Stream, einschließlich der Standardspeicherebene und anderer speicherbezogener Einstellungen.
Typ: [StreamStorageConfiguration](API_StreamStorageConfiguration.md) Objekt
## Fehler
Weitere Informationen zu den allgemeinen Fehlern, die bei allen Aktionen zurückgegeben werden, finden Sie unter [Häufige Fehlertypen](CommonErrors.md).
** AccessDeniedException **
Sie verfügen nicht über die erforderlichen Berechtigungen, um diesen Vorgang auszuführen.
HTTP-Statuscode: 401
** ClientLimitExceededException **
Kinesis Video Streams hat die Anfrage gedrosselt, weil Sie das Limit der erlaubten Client-Aufrufe überschritten haben. Versuchen Sie später, den Anruf zu tätigen.
HTTP-Statuscode: 400
** InvalidArgumentException **
Der Wert für diesen Eingabeparameter ist ungültig.
HTTP-Statuscode: 400
** ResourceNotFoundException **
Amazon Kinesis Video Streams kann den von Ihnen angegebenen Stream nicht finden.
HTTP-Statuscode: 404
## Weitere Informationen finden Sie unter:
Weitere Informationen zur Verwendung dieser API in einer der sprachspezifischen Sprachen finden Sie im AWS SDKs Folgenden:
+ [AWS Befehlszeilenschnittstelle V2](https://docs.aws.amazon.com/goto/cli2/kinesisvideo-2017-09-30/DescribeStreamStorageConfiguration)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/kinesisvideo-2017-09-30/DescribeStreamStorageConfiguration)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/kinesisvideo-2017-09-30/DescribeStreamStorageConfiguration)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/kinesisvideo-2017-09-30/DescribeStreamStorageConfiguration)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/kinesisvideo-2017-09-30/DescribeStreamStorageConfiguration)
+ [AWS SDK für JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/kinesisvideo-2017-09-30/DescribeStreamStorageConfiguration)
+ [AWS SDK für Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/kinesisvideo-2017-09-30/DescribeStreamStorageConfiguration)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/kinesisvideo-2017-09-30/DescribeStreamStorageConfiguration)
+ [AWS SDK für Python](https://docs.aws.amazon.com/goto/boto3/kinesisvideo-2017-09-30/DescribeStreamStorageConfiguration)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/kinesisvideo-2017-09-30/DescribeStreamStorageConfiguration)
# GetDataEndpoint
Ruft einen Endpunkt für einen angegebenen Stream zum Lesen oder Schreiben ab. Verwenden Sie diesen Endpunkt in Ihrer Anwendung, um aus dem angegebenen Stream zu lesen (mithilfe der `GetMediaForFragmentList` Operationen `GetMedia` oder) oder in ihn zu schreiben (mithilfe der `PutMedia` Operation).
**Anmerkung**
An den zurückgegebenen Endpunkt ist der API-Name nicht angehängt. Der Client muss den API-Namen zum zurückgegebenen Endpunkt hinzufügen.
Geben Sie in der Anfrage den Stream entweder mit `StreamName` oder an`StreamARN`.
## Anforderungssyntax
```
POST /getDataEndpoint HTTP/1.1
Content-type: application/json
{
"APIName": "string",
"StreamARN": "string",
"StreamName": "string"
}
```
## URI-Anfrageparameter
Die Anforderung verwendet keine URI-Parameter.
## Anforderungstext
Die Anforderung akzeptiert die folgenden Daten im JSON-Format.
** [APIName](#API_GetDataEndpoint_RequestSyntax) **
Der Name der API-Aktion, für die ein Endpunkt abgerufen werden soll.
Typ: Zeichenfolge
Zulässige Werte: `PUT_MEDIA | GET_MEDIA | LIST_FRAGMENTS | GET_MEDIA_FOR_FRAGMENT_LIST | GET_HLS_STREAMING_SESSION_URL | GET_DASH_STREAMING_SESSION_URL | GET_CLIP | GET_IMAGES`
Erforderlich: Ja
** [StreamARN](#API_GetDataEndpoint_RequestSyntax) **
Der Amazon-Ressourcenname (ARN) des Streams, für den Sie den Endpunkt abrufen möchten. Sie müssen entweder diesen Parameter oder a `StreamName` in der Anfrage angeben.
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_GetDataEndpoint_RequestSyntax) **
Der Name des Streams, für den Sie den Endpunkt abrufen möchten. Sie müssen entweder diesen Parameter oder a `StreamARN` in der Anfrage angeben.
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
## Antwortsyntax
```
HTTP/1.1 200
Content-type: application/json
{
"DataEndpoint": "string"
}
```
## Antwortelemente
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.
** [DataEndpoint](#API_GetDataEndpoint_ResponseSyntax) **
Der Endpunktwert. Um Daten aus dem Stream zu lesen oder Daten in den Stream zu schreiben, geben Sie diesen Endpunkt in Ihrer Anwendung an.
Typ: Zeichenfolge
## Fehler
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 das Limit der erlaubten Client-Aufrufe überschritten haben. Versuchen Sie später, den Anruf zu tätigen.
HTTP-Statuscode: 400
** InvalidArgumentException **
Der Wert für diesen Eingabeparameter ist ungültig.
HTTP-Statuscode: 400
** NotAuthorizedException **
Der Anrufer ist nicht autorisiert, diesen Vorgang auszuführen.
HTTP-Statuscode: 401
** ResourceNotFoundException **
Amazon Kinesis Video Streams kann den von Ihnen angegebenen Stream nicht finden.
HTTP-Statuscode: 404
## Weitere Informationen finden Sie unter:
Weitere Informationen zur Verwendung dieser API in einer der sprachspezifischen Sprachen finden Sie im AWS SDKs Folgenden:
+ [AWS Befehlszeilenschnittstelle V2](https://docs.aws.amazon.com/goto/cli2/kinesisvideo-2017-09-30/GetDataEndpoint)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/kinesisvideo-2017-09-30/GetDataEndpoint)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/kinesisvideo-2017-09-30/GetDataEndpoint)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/kinesisvideo-2017-09-30/GetDataEndpoint)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/kinesisvideo-2017-09-30/GetDataEndpoint)
+ [AWS SDK für JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/kinesisvideo-2017-09-30/GetDataEndpoint)
+ [AWS SDK für Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/kinesisvideo-2017-09-30/GetDataEndpoint)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/kinesisvideo-2017-09-30/GetDataEndpoint)
+ [AWS SDK für Python](https://docs.aws.amazon.com/goto/boto3/kinesisvideo-2017-09-30/GetDataEndpoint)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/kinesisvideo-2017-09-30/GetDataEndpoint)
# GetSignalingChannelEndpoint
Stellt einen Endpunkt für den angegebenen Signalkanal zum Senden und Empfangen von Nachrichten bereit. Diese API verwendet den `SingleMasterChannelEndpointConfiguration` Eingabeparameter, der aus den `Role` Eigenschaften `Protocols` und besteht.
`Protocols`wird verwendet, um den Kommunikationsmechanismus zu bestimmen. Wenn Sie beispielsweise `WSS` als Protokoll angeben, erzeugt diese API einen sicheren Websocket-Endpunkt. Wenn Sie `HTTPS` als Protokoll angeben, generiert diese API einen HTTPS-Endpunkt. Wenn Sie `WEBRTC` als Protokoll angeben, der Signalkanal jedoch nicht für die Aufnahme konfiguriert ist, erhalten Sie den Fehler. `InvalidArgumentException`
`Role`bestimmt die Messaging-Berechtigungen. Eine `MASTER` Rolle führt dazu, dass diese API einen Endpunkt generiert, über den ein Client mit allen Zuschauern auf dem Kanal kommunizieren kann. Eine `VIEWER` Rolle führt dazu, dass diese API einen Endpunkt generiert, über den ein Client nur mit einem kommunizieren kann`MASTER`.
## Anforderungssyntax
```
POST /getSignalingChannelEndpoint HTTP/1.1
Content-type: application/json
{
"ChannelARN": "string",
"SingleMasterChannelEndpointConfiguration": {
"Protocols": [ "string" ],
"Role": "string"
}
}
```
## URI-Anfrageparameter
Die Anforderung verwendet keine URI-Parameter.
## Anforderungstext
Die Anforderung akzeptiert die folgenden Daten im JSON-Format.
** [ChannelARN](#API_GetSignalingChannelEndpoint_RequestSyntax) **
Der Amazon-Ressourcenname (ARN) des Signalisierungskanals, für den Sie einen Endpunkt abrufen möchten.
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: Ja
** [SingleMasterChannelEndpointConfiguration](#API_GetSignalingChannelEndpoint_RequestSyntax) **
Eine Struktur, die die Endpunktkonfiguration für den `SINGLE_MASTER` Kanaltyp enthält.
Typ: [SingleMasterChannelEndpointConfiguration](API_SingleMasterChannelEndpointConfiguration.md) Objekt
Erforderlich: Nein
## Antwortsyntax
```
HTTP/1.1 200
Content-type: application/json
{
"ResourceEndpointList": [
{
"Protocol": "string",
"ResourceEndpoint": "string"
}
]
}
```
## Antwortelemente
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.
** [ResourceEndpointList](#API_GetSignalingChannelEndpoint_ResponseSyntax) **
Eine Liste von Endpunkten für den angegebenen Signalkanal.
Typ: Array von [ResourceEndpointListItem](API_ResourceEndpointListItem.md)-Objekten
## Fehler
Weitere Informationen zu den allgemeinen Fehlern, die bei allen Aktionen zurückgegeben werden, finden Sie unter [Häufige Fehlertypen](CommonErrors.md).
** AccessDeniedException **
Sie verfügen nicht über die erforderlichen Berechtigungen, um diesen Vorgang auszuführen.
HTTP-Statuscode: 401
** ClientLimitExceededException **
Kinesis Video Streams hat die Anfrage gedrosselt, weil Sie das Limit der erlaubten Client-Aufrufe überschritten haben. Versuchen Sie später, den Anruf zu tätigen.
HTTP-Statuscode: 400
** InvalidArgumentException **
Der Wert für diesen Eingabeparameter ist ungültig.
HTTP-Statuscode: 400
** ResourceInUseException **
Wenn der Eingang `StreamARN` oder `ChannelARN` Eingang bereits einer anderen Kinesis Video Stream-Ressource zugeordnet `CLOUD_STORAGE_MODE` ist oder wenn sich der angegebene Eingang `StreamARN` oder Eingang nicht im Status Aktiv `ChannelARN` befindet, versuchen Sie es mit einer der folgenden Methoden:
1. Die `DescribeMediaStorageConfiguration` API, um zu ermitteln, welchem Stream der angegebene Kanal zugeordnet ist.
1. Die `DescribeMappedResourceConfiguration` API zur Bestimmung des Kanals, dem der angegebene Stream zugeordnet ist.
1. Die `DescribeStream` oder `DescribeSignalingChannel` API zur Bestimmung des Status der Ressource.
HTTP-Statuscode: 400
** ResourceNotFoundException **
Amazon Kinesis Video Streams kann den von Ihnen angegebenen Stream nicht finden.
HTTP-Statuscode: 404
## Weitere Informationen finden Sie unter:
Weitere Informationen zur Verwendung dieser API in einer der sprachspezifischen Sprachen finden Sie im AWS SDKs Folgenden:
+ [AWS Befehlszeilenschnittstelle V2](https://docs.aws.amazon.com/goto/cli2/kinesisvideo-2017-09-30/GetSignalingChannelEndpoint)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/kinesisvideo-2017-09-30/GetSignalingChannelEndpoint)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/kinesisvideo-2017-09-30/GetSignalingChannelEndpoint)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/kinesisvideo-2017-09-30/GetSignalingChannelEndpoint)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/kinesisvideo-2017-09-30/GetSignalingChannelEndpoint)
+ [AWS SDK für JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/kinesisvideo-2017-09-30/GetSignalingChannelEndpoint)
+ [AWS SDK für Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/kinesisvideo-2017-09-30/GetSignalingChannelEndpoint)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/kinesisvideo-2017-09-30/GetSignalingChannelEndpoint)
+ [AWS SDK für Python](https://docs.aws.amazon.com/goto/boto3/kinesisvideo-2017-09-30/GetSignalingChannelEndpoint)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/kinesisvideo-2017-09-30/GetSignalingChannelEndpoint)
# ListEdgeAgentConfigurations
Gibt ein Array von Edge-Konfigurationen zurück, die dem angegebenen Edge-Agenten zugeordnet sind.
In der Anfrage müssen Sie den Edge-Agent angeben`HubDeviceArn`.
**Anmerkung**
Diese API ist in der Region AWS Afrika (Kapstadt), af-south-1, nicht verfügbar.
## Anforderungssyntax
```
POST /listEdgeAgentConfigurations HTTP/1.1
Content-type: application/json
{
"HubDeviceArn": "string",
"MaxResults": number,
"NextToken": "string"
}
```
## URI-Anfrageparameter
Die Anforderung verwendet keine URI-Parameter.
## Anforderungstext
Die Anforderung akzeptiert die folgenden Daten im JSON-Format.
** [HubDeviceArn](#API_ListEdgeAgentConfigurations_RequestSyntax) **
Das „Internet der Dinge (IoT) -Ding“ Arn of the Edge Agent.
Typ: Zeichenfolge
Längenbeschränkungen: Minimale Länge von 1. Maximale Länge beträgt 1024 Zeichen.
Pattern: `arn:[a-z\d-]+:iot:[a-z0-9-]+:[0-9]+:thing/[a-zA-Z0-9_.-]+`
Erforderlich: Ja
** [MaxResults](#API_ListEdgeAgentConfigurations_RequestSyntax) **
Die maximale Anzahl von Edge-Konfigurationen, die in der Antwort zurückgegeben werden sollen. Der Standardwert ist 5.
Typ: Ganzzahl
Gültiger Bereich: Mindestwert 1. Maximalwert 10.
Erforderlich: Nein
** [NextToken](#API_ListEdgeAgentConfigurations_RequestSyntax) **
Wenn Sie diesen Parameter angeben und das Ergebnis einer `ListEdgeAgentConfigurations` Operation gekürzt wird, gibt der Aufruf `NextToken` in der Antwort den zurück. Um einen weiteren Stapel von Edge-Konfigurationen zu erhalten, geben Sie dieses Token in Ihrer nächsten Anfrage an.
Typ: Zeichenfolge
Längenbeschränkungen: Minimale Länge von 0. Maximale Länge beträgt 1024 Zeichen.
Pattern: `[a-zA-Z0-9+/=]*`
Erforderlich: Nein
## Antwortsyntax
```
HTTP/1.1 200
Content-type: application/json
{
"EdgeConfigs": [
{
"CreationTime": number,
"EdgeConfig": {
"DeletionConfig": {
"DeleteAfterUpload": boolean,
"EdgeRetentionInHours": number,
"LocalSizeConfig": {
"MaxLocalMediaSizeInMB": number,
"StrategyOnFullSize": "string"
}
},
"HubDeviceArn": "string",
"RecorderConfig": {
"MediaSourceConfig": {
"MediaUriSecretArn": "string",
"MediaUriType": "string"
},
"ScheduleConfig": {
"DurationInSeconds": number,
"ScheduleExpression": "string"
}
},
"UploaderConfig": {
"ScheduleConfig": {
"DurationInSeconds": number,
"ScheduleExpression": "string"
}
}
},
"FailedStatusDetails": "string",
"LastUpdatedTime": number,
"StreamARN": "string",
"StreamName": "string",
"SyncStatus": "string"
}
],
"NextToken": "string"
}
```
## Antwortelemente
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.
** [EdgeConfigs](#API_ListEdgeAgentConfigurations_ResponseSyntax) **
Eine Beschreibung der Edge-Konfiguration eines einzelnen Streams.
Typ: Array von [ListEdgeAgentConfigurationsEdgeConfig](API_ListEdgeAgentConfigurationsEdgeConfig.md)-Objekten
** [NextToken](#API_ListEdgeAgentConfigurations_ResponseSyntax) **
Wenn die Antwort gekürzt wird, gibt der Aufruf dieses Element mit einem bestimmten Token zurück. Verwenden Sie dieses Token in Ihrer nächsten Anfrage, um den nächsten Stapel von Edge-Konfigurationen abzurufen.
Typ: Zeichenfolge
Längenbeschränkungen: Minimale Länge von 0. Maximale Länge beträgt 1024 Zeichen.
Pattern: `[a-zA-Z0-9+/=]*`
## Fehler
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 das Limit der erlaubten Client-Aufrufe überschritten haben. Versuchen Sie später, den Anruf zu tätigen.
HTTP-Statuscode: 400
** InvalidArgumentException **
Der Wert für diesen Eingabeparameter ist ungültig.
HTTP-Statuscode: 400
** NotAuthorizedException **
Der Anrufer ist nicht autorisiert, diesen Vorgang auszuführen.
HTTP-Statuscode: 401
## Weitere Informationen finden Sie unter:
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/kinesisvideo-2017-09-30/ListEdgeAgentConfigurations)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/kinesisvideo-2017-09-30/ListEdgeAgentConfigurations)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/kinesisvideo-2017-09-30/ListEdgeAgentConfigurations)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/kinesisvideo-2017-09-30/ListEdgeAgentConfigurations)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/kinesisvideo-2017-09-30/ListEdgeAgentConfigurations)
+ [AWS SDK für JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/kinesisvideo-2017-09-30/ListEdgeAgentConfigurations)
+ [AWS SDK für Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/kinesisvideo-2017-09-30/ListEdgeAgentConfigurations)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/kinesisvideo-2017-09-30/ListEdgeAgentConfigurations)
+ [AWS SDK für Python](https://docs.aws.amazon.com/goto/boto3/kinesisvideo-2017-09-30/ListEdgeAgentConfigurations)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/kinesisvideo-2017-09-30/ListEdgeAgentConfigurations)
# ListSignalingChannels
Gibt ein Array von `ChannelInfo` Objekten zurück. Jedes Objekt beschreibt einen Signalkanal. Um nur die Kanäle abzurufen, die eine bestimmte Bedingung erfüllen, können Sie a angeben`ChannelNameCondition`.
## Anforderungssyntax
```
POST /listSignalingChannels HTTP/1.1
Content-type: application/json
{
"ChannelNameCondition": {
"ComparisonOperator": "string",
"ComparisonValue": "string"
},
"MaxResults": number,
"NextToken": "string"
}
```
## URI-Anfrageparameter
Die Anforderung verwendet keine URI-Parameter.
## Anforderungstext
Die Anforderung akzeptiert die folgenden Daten im JSON-Format.
** [ChannelNameCondition](#API_ListSignalingChannels_RequestSyntax) **
Optional: Gibt nur die Kanäle zurück, die eine bestimmte Bedingung erfüllen.
Typ: [ChannelNameCondition](API_ChannelNameCondition.md) Objekt
Erforderlich: Nein
** [MaxResults](#API_ListSignalingChannels_RequestSyntax) **
Die maximale Anzahl von Kanälen, die in der Antwort zurückgegeben werden sollen. Die Standardeinstellung ist 500.
Typ: Ganzzahl
Gültiger Bereich: Mindestwert 1. Maximaler Wert von 10000.
Erforderlich: Nein
** [NextToken](#API_ListSignalingChannels_RequestSyntax) **
Wenn Sie diesen Parameter angeben und das Ergebnis einer `ListSignalingChannels` Operation gekürzt wird, gibt der Aufruf das `NextToken` in der Antwort zurück. Um einen weiteren Stapel von Kanälen zu erhalten, geben Sie dieses Token in Ihrer nächsten Anfrage an.
Typ: Zeichenfolge
Längenbeschränkungen: Minimale Länge von 0. Maximale Länge beträgt 1024 Zeichen.
Pattern: `[a-zA-Z0-9+/=]*`
Erforderlich: Nein
## Antwortsyntax
```
HTTP/1.1 200
Content-type: application/json
{
"ChannelInfoList": [
{
"ChannelARN": "string",
"ChannelName": "string",
"ChannelStatus": "string",
"ChannelType": "string",
"CreationTime": number,
"SingleMasterConfiguration": {
"MessageTtlSeconds": number
},
"Version": "string"
}
],
"NextToken": "string"
}
```
## Antwortelemente
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.
** [ChannelInfoList](#API_ListSignalingChannels_ResponseSyntax) **
Ein Array von `ChannelInfo`-Objekten.
Typ: Array von [ChannelInfo](API_ChannelInfo.md)-Objekten
** [NextToken](#API_ListSignalingChannels_ResponseSyntax) **
Wenn die Antwort gekürzt wird, gibt der Aufruf dieses Element mit einem Token zurück. Verwenden Sie dieses Token in Ihrer nächsten Anfrage, um den nächsten Stapel von Streams abzurufen.
Typ: Zeichenfolge
Längenbeschränkungen: Minimale Länge von 0. Maximale Länge beträgt 1024 Zeichen.
Pattern: `[a-zA-Z0-9+/=]*`
## Fehler
Weitere Informationen zu den allgemeinen Fehlern, die bei allen Aktionen zurückgegeben werden, finden Sie unter [Häufige Fehlertypen](CommonErrors.md).
** AccessDeniedException **
Sie verfügen nicht über die erforderlichen Berechtigungen, um diesen Vorgang auszuführen.
HTTP-Statuscode: 401
** ClientLimitExceededException **
Kinesis Video Streams hat die Anfrage gedrosselt, weil Sie das Limit der erlaubten Client-Aufrufe überschritten haben. Versuchen Sie später, den Anruf zu tätigen.
HTTP-Statuscode: 400
** InvalidArgumentException **
Der Wert für diesen Eingabeparameter ist ungültig.
HTTP-Statuscode: 400
## Weitere Informationen finden Sie unter:
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/kinesisvideo-2017-09-30/ListSignalingChannels)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/kinesisvideo-2017-09-30/ListSignalingChannels)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/kinesisvideo-2017-09-30/ListSignalingChannels)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/kinesisvideo-2017-09-30/ListSignalingChannels)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/kinesisvideo-2017-09-30/ListSignalingChannels)
+ [AWS SDK für JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/kinesisvideo-2017-09-30/ListSignalingChannels)
+ [AWS SDK für Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/kinesisvideo-2017-09-30/ListSignalingChannels)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/kinesisvideo-2017-09-30/ListSignalingChannels)
+ [AWS SDK für Python](https://docs.aws.amazon.com/goto/boto3/kinesisvideo-2017-09-30/ListSignalingChannels)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/kinesisvideo-2017-09-30/ListSignalingChannels)
# ListStreams
Gibt ein Array von `StreamInfo` Objekten zurück. Jedes Objekt beschreibt einen Stream. Um nur Streams abzurufen, die eine bestimmte Bedingung erfüllen, können Sie a angeben`StreamNameCondition`.
## Anforderungssyntax
```
POST /listStreams HTTP/1.1
Content-type: application/json
{
"MaxResults": number,
"NextToken": "string",
"StreamNameCondition": {
"ComparisonOperator": "string",
"ComparisonValue": "string"
}
}
```
## URI-Anfrageparameter
Die Anforderung verwendet keine URI-Parameter.
## Anforderungstext
Die Anforderung akzeptiert die folgenden Daten im JSON-Format.
** [MaxResults](#API_ListStreams_RequestSyntax) **
Die maximale Anzahl von Streams, die in der Antwort zurückgegeben werden sollen. Der Standardwert ist 10 000.
Typ: Ganzzahl
Gültiger Bereich: Mindestwert 1. Maximaler Wert von 10000.
Erforderlich: Nein
** [NextToken](#API_ListStreams_RequestSyntax) **
Wenn Sie diesen Parameter angeben und das Ergebnis einer `ListStreams` Operation gekürzt wird, gibt der Aufruf `NextToken` in der Antwort den zurück. Um einen weiteren Stapel von Streams zu erhalten, geben Sie dieses Token in Ihrer nächsten Anfrage an.
Typ: Zeichenfolge
Längenbeschränkungen: Minimale Länge von 0. Maximale Länge beträgt 1024 Zeichen.
Pattern: `[a-zA-Z0-9+/=]*`
Erforderlich: Nein
** [StreamNameCondition](#API_ListStreams_RequestSyntax) **
Optional: Gibt nur Streams zurück, die eine bestimmte Bedingung erfüllen. Derzeit können Sie nur das Präfix eines Streamnamens als Bedingung angeben.
Typ: [StreamNameCondition](API_StreamNameCondition.md) Objekt
Erforderlich: Nein
## Antwortsyntax
```
HTTP/1.1 200
Content-type: application/json
{
"NextToken": "string",
"StreamInfoList": [
{
"CreationTime": number,
"DataRetentionInHours": number,
"DeviceName": "string",
"KmsKeyId": "string",
"MediaType": "string",
"Status": "string",
"StreamARN": "string",
"StreamName": "string",
"Version": "string"
}
]
}
```
## Antwortelemente
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.
** [NextToken](#API_ListStreams_ResponseSyntax) **
Wenn die Antwort gekürzt ist, gibt der Aufruf dieses Element mit einem Token zurück. Verwenden Sie dieses Token in Ihrer nächsten Anfrage, um den nächsten Stapel von Streams abzurufen.
Typ: Zeichenfolge
Längenbeschränkungen: Minimale Länge von 0. Maximale Länge beträgt 1024 Zeichen.
Pattern: `[a-zA-Z0-9+/=]*`
** [StreamInfoList](#API_ListStreams_ResponseSyntax) **
Ein Array von `StreamInfo`-Objekten.
Typ: Array von [StreamInfo](API_StreamInfo.md)-Objekten
## Fehler
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 das Limit der erlaubten Client-Aufrufe überschritten haben. Versuchen Sie später, den Anruf zu tätigen.
HTTP-Statuscode: 400
** InvalidArgumentException **
Der Wert für diesen Eingabeparameter ist ungültig.
HTTP-Statuscode: 400
## Weitere Informationen finden Sie unter:
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/kinesisvideo-2017-09-30/ListStreams)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/kinesisvideo-2017-09-30/ListStreams)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/kinesisvideo-2017-09-30/ListStreams)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/kinesisvideo-2017-09-30/ListStreams)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/kinesisvideo-2017-09-30/ListStreams)
+ [AWS SDK für JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/kinesisvideo-2017-09-30/ListStreams)
+ [AWS SDK für Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/kinesisvideo-2017-09-30/ListStreams)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/kinesisvideo-2017-09-30/ListStreams)
+ [AWS SDK für Python](https://docs.aws.amazon.com/goto/boto3/kinesisvideo-2017-09-30/ListStreams)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/kinesisvideo-2017-09-30/ListStreams)
# ListTagsForResource
Gibt eine Liste von Tags zurück, die dem angegebenen Signalkanal zugeordnet sind.
## Anforderungssyntax
```
POST /ListTagsForResource HTTP/1.1
Content-type: application/json
{
"NextToken": "string",
"ResourceARN": "string"
}
```
## URI-Anfrageparameter
Die Anforderung verwendet keine URI-Parameter.
## Anforderungstext
Die Anforderung akzeptiert die folgenden Daten im JSON-Format.
** [NextToken](#API_ListTagsForResource_RequestSyntax) **
Wenn Sie diesen Parameter angeben und das Ergebnis eines `ListTagsForResource` Aufrufs gekürzt wird, enthält die Antwort ein Token, das Sie in der nächsten Anforderung verwenden können, um den nächsten Stapel von Tags abzurufen.
Typ: Zeichenfolge
Längenbeschränkungen: Minimale Länge von 0. Maximale Länge beträgt 1024 Zeichen.
Pattern: `[a-zA-Z0-9+/=]*`
Erforderlich: Nein
** [ResourceARN](#API_ListTagsForResource_RequestSyntax) **
Der Amazon-Ressourcenname (ARN) des Signalisierungskanals, für den Sie Tags auflisten möchten.
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: Ja
## Antwortsyntax
```
HTTP/1.1 200
Content-type: application/json
{
"NextToken": "string",
"Tags": {
"string" : "string"
}
}
```
## Antwortelemente
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.
** [NextToken](#API_ListTagsForResource_ResponseSyntax) **
Wenn Sie diesen Parameter angeben und das Ergebnis eines `ListTagsForResource` Aufrufs gekürzt wird, enthält die Antwort ein Token, das Sie in der nächsten Anfrage verwenden können, um den nächsten Satz von Tags abzurufen.
Typ: Zeichenfolge
Längenbeschränkungen: Minimale Länge von 0. Maximale Länge beträgt 1024 Zeichen.
Pattern: `[a-zA-Z0-9+/=]*`
** [Tags](#API_ListTagsForResource_ResponseSyntax) **
Eine Zuordnung von Tag-Schlüsseln und -Werten, die dem angegebenen Signalkanal zugeordnet sind.
Typ: Abbildung einer Zeichenfolge auf eine Zeichenfolge
Karteneinträge: Maximale Anzahl von 50 Elementen.
Schlüssel-Längenbeschränkungen: Minimale Länge von 1. Maximale Länge beträgt 128 Zeichen.
Schlüssel-Muster: `^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$`
Längenbeschränkungen für Werte: Mindestlänge von 0. Maximale Länge beträgt 256 Zeichen.
Wertemuster: `[\p{L}\p{Z}\p{N}_.:/=+\-@]*`
## Fehler
Weitere Informationen zu den allgemeinen Fehlern, die bei allen Aktionen zurückgegeben werden, finden Sie unter [Häufige Fehlertypen](CommonErrors.md).
** AccessDeniedException **
Sie verfügen nicht über die erforderlichen Berechtigungen, um diesen Vorgang auszuführen.
HTTP-Statuscode: 401
** ClientLimitExceededException **
Kinesis Video Streams hat die Anfrage gedrosselt, weil Sie das Limit der erlaubten Client-Aufrufe überschritten haben. Versuchen Sie später, den Anruf zu tätigen.
HTTP-Statuscode: 400
** InvalidArgumentException **
Der Wert für diesen Eingabeparameter ist ungültig.
HTTP-Statuscode: 400
** ResourceNotFoundException **
Amazon Kinesis Video Streams kann den von Ihnen angegebenen Stream nicht finden.
HTTP-Statuscode: 404
## Weitere Informationen finden Sie unter:
Weitere Informationen zur Verwendung dieser API in einer der sprachspezifischen Sprachen finden Sie im AWS SDKs Folgenden:
+ [AWS Befehlszeilenschnittstelle V2](https://docs.aws.amazon.com/goto/cli2/kinesisvideo-2017-09-30/ListTagsForResource)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/kinesisvideo-2017-09-30/ListTagsForResource)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/kinesisvideo-2017-09-30/ListTagsForResource)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/kinesisvideo-2017-09-30/ListTagsForResource)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/kinesisvideo-2017-09-30/ListTagsForResource)
+ [AWS SDK für JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/kinesisvideo-2017-09-30/ListTagsForResource)
+ [AWS SDK für Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/kinesisvideo-2017-09-30/ListTagsForResource)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/kinesisvideo-2017-09-30/ListTagsForResource)
+ [AWS SDK für Python](https://docs.aws.amazon.com/goto/boto3/kinesisvideo-2017-09-30/ListTagsForResource)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/kinesisvideo-2017-09-30/ListTagsForResource)
# ListTagsForStream
Gibt eine Liste von Tags zurück, die dem angegebenen Stream zugeordnet sind.
In der Anfrage müssen Sie entweder den `StreamName` oder den angeben`StreamARN`.
## Anforderungssyntax
```
POST /listTagsForStream HTTP/1.1
Content-type: application/json
{
"NextToken": "string",
"StreamARN": "string",
"StreamName": "string"
}
```
## URI-Anfrageparameter
Die Anforderung verwendet keine URI-Parameter.
## Anforderungstext
Die Anforderung akzeptiert die folgenden Daten im JSON-Format.
** [NextToken](#API_ListTagsForStream_RequestSyntax) **
Wenn Sie diesen Parameter angeben und das Ergebnis eines `ListTagsForStream` Aufrufs gekürzt wird, enthält die Antwort ein Token, das Sie in der nächsten Anforderung verwenden können, um den nächsten Stapel von Tags abzurufen.
Typ: Zeichenfolge
Längenbeschränkungen: Minimale Länge von 0. Maximale Länge beträgt 1024 Zeichen.
Pattern: `[a-zA-Z0-9+/=]*`
Erforderlich: Nein
** [StreamARN](#API_ListTagsForStream_RequestSyntax) **
Der Amazon-Ressourcenname (ARN) des Streams, für den Sie Tags auflisten möchten.
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_ListTagsForStream_RequestSyntax) **
Der Name des Streams, für den Sie Tags auflisten möchten.
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
## Antwortsyntax
```
HTTP/1.1 200
Content-type: application/json
{
"NextToken": "string",
"Tags": {
"string" : "string"
}
}
```
## Antwortelemente
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.
** [NextToken](#API_ListTagsForStream_ResponseSyntax) **
Wenn Sie diesen Parameter angeben und das Ergebnis eines `ListTags` Aufrufs gekürzt wird, enthält die Antwort ein Token, das Sie in der nächsten Anforderung verwenden können, um den nächsten Satz von Tags abzurufen.
Typ: Zeichenfolge
Längenbeschränkungen: Minimale Länge von 0. Maximale Länge beträgt 1024 Zeichen.
Pattern: `[a-zA-Z0-9+/=]*`
** [Tags](#API_ListTagsForStream_ResponseSyntax) **
Eine Zuordnung von Tag-Schlüsseln und -Werten, die dem angegebenen Stream zugeordnet sind.
Typ: Abbildung einer Zeichenfolge auf eine Zeichenfolge
Karteneinträge: Maximale Anzahl von 50 Elementen.
Schlüssel-Längenbeschränkungen: Minimale Länge von 1. Maximale Länge beträgt 128 Zeichen.
Schlüssel-Muster: `^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$`
Längenbeschränkungen für Werte: Mindestlänge von 0. Maximale Länge beträgt 256 Zeichen.
Wertemuster: `[\p{L}\p{Z}\p{N}_.:/=+\-@]*`
## Fehler
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 das Limit der erlaubten Client-Aufrufe überschritten haben. Versuchen Sie später, den Anruf zu tätigen.
HTTP-Statuscode: 400
** InvalidArgumentException **
Der Wert für diesen Eingabeparameter ist ungültig.
HTTP-Statuscode: 400
** InvalidResourceFormatException **
Das Format von `StreamARN` ist ungültig.
HTTP-Statuscode: 400
** NotAuthorizedException **
Der Anrufer ist nicht autorisiert, diesen Vorgang auszuführen.
HTTP-Statuscode: 401
** ResourceNotFoundException **
Amazon Kinesis Video Streams kann den von Ihnen angegebenen Stream nicht finden.
HTTP-Statuscode: 404
## Weitere Informationen finden Sie unter:
Weitere Informationen zur Verwendung dieser API in einer der sprachspezifischen Sprachen finden Sie im AWS SDKs Folgenden:
+ [AWS Befehlszeilenschnittstelle V2](https://docs.aws.amazon.com/goto/cli2/kinesisvideo-2017-09-30/ListTagsForStream)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/kinesisvideo-2017-09-30/ListTagsForStream)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/kinesisvideo-2017-09-30/ListTagsForStream)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/kinesisvideo-2017-09-30/ListTagsForStream)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/kinesisvideo-2017-09-30/ListTagsForStream)
+ [AWS SDK für JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/kinesisvideo-2017-09-30/ListTagsForStream)
+ [AWS SDK für Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/kinesisvideo-2017-09-30/ListTagsForStream)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/kinesisvideo-2017-09-30/ListTagsForStream)
+ [AWS SDK für Python](https://docs.aws.amazon.com/goto/boto3/kinesisvideo-2017-09-30/ListTagsForStream)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/kinesisvideo-2017-09-30/ListTagsForStream)
# StartEdgeConfigurationUpdate
Eine asynchrone API, die die bestehende Edge-Konfiguration eines Streams aktualisiert. Der Kinesis Video Stream synchronisiert die Edge-Konfiguration des Streams mit der Edge Agent IoT Greengrass-Komponente, die auf einem bei Ihnen vor Ort eingerichteten IoT Hub-Gerät ausgeführt wird. Die Dauer der Synchronisierung kann variieren und hängt von der Konnektivität des Hub-Geräts ab. Das `SyncStatus` wird aktualisiert, sobald die Edge-Konfiguration bestätigt und mit dem Edge-Agenten synchronisiert wird.
Wenn diese API zum ersten Mal aufgerufen wird, wird eine neue Edge-Konfiguration für den Stream erstellt, und der Synchronisierungsstatus wird auf gesetzt. `SYNCING` Sie müssen warten, bis der Synchronisierungsstatus einen Terminalstatus wie: oder erreicht hat `IN_SYNC``SYNC_FAILED`, bevor Sie diese API erneut verwenden können. Wenn Sie diese API während des Synchronisierungsvorgangs aufrufen, `ResourceInUseException` wird a ausgelöst. Die Verbindung zwischen der Edge-Konfiguration des Streams und dem Edge-Agenten wird für 15 Minuten erneut versucht. Nach 15 Minuten wechselt der Status in den `SYNC_FAILED` Status.
Um eine Edge-Konfiguration von einem Gerät auf ein anderes zu verschieben, verwenden Sie, [DeleteEdgeConfiguration](API_DeleteEdgeConfiguration.md) um die aktuelle Edge-Konfiguration zu löschen. Sie können dann StartEdgeConfigurationUpdate mit einem aktualisierten Hub-Geräte-ARN aufrufen.
**Anmerkung**
Diese API ist in der Region AWS Afrika (Kapstadt), af-south-1, nicht verfügbar.
## Anforderungssyntax
```
POST /startEdgeConfigurationUpdate HTTP/1.1
Content-type: application/json
{
"EdgeConfig": {
"DeletionConfig": {
"DeleteAfterUpload": boolean,
"EdgeRetentionInHours": number,
"LocalSizeConfig": {
"MaxLocalMediaSizeInMB": number,
"StrategyOnFullSize": "string"
}
},
"HubDeviceArn": "string",
"RecorderConfig": {
"MediaSourceConfig": {
"MediaUriSecretArn": "string",
"MediaUriType": "string"
},
"ScheduleConfig": {
"DurationInSeconds": number,
"ScheduleExpression": "string"
}
},
"UploaderConfig": {
"ScheduleConfig": {
"DurationInSeconds": number,
"ScheduleExpression": "string"
}
}
},
"StreamARN": "string",
"StreamName": "string"
}
```
## URI-Anfrageparameter
Die Anforderung verwendet keine URI-Parameter.
## Anforderungstext
Die Anforderung akzeptiert die folgenden Daten im JSON-Format.
** [EdgeConfig](#API_StartEdgeConfigurationUpdate_RequestSyntax) **
Die Edge-Konfigurationsdetails, die zum Aufrufen des Aktualisierungsvorgangs erforderlich sind.
Typ: [EdgeConfig](API_EdgeConfig.md) Objekt
Erforderlich: Ja
** [StreamARN](#API_StartEdgeConfigurationUpdate_RequestSyntax) **
Der Amazon-Ressourcenname (ARN) des -Stream. Geben Sie entweder den `StreamName` oder den an`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_StartEdgeConfigurationUpdate_RequestSyntax) **
Der Name des Streams, dessen Edge-Konfiguration Sie aktualisieren möchten. Geben Sie entweder den `StreamName` oder den an`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
## Antwortsyntax
```
HTTP/1.1 200
Content-type: application/json
{
"CreationTime": number,
"EdgeConfig": {
"DeletionConfig": {
"DeleteAfterUpload": boolean,
"EdgeRetentionInHours": number,
"LocalSizeConfig": {
"MaxLocalMediaSizeInMB": number,
"StrategyOnFullSize": "string"
}
},
"HubDeviceArn": "string",
"RecorderConfig": {
"MediaSourceConfig": {
"MediaUriSecretArn": "string",
"MediaUriType": "string"
},
"ScheduleConfig": {
"DurationInSeconds": number,
"ScheduleExpression": "string"
}
},
"UploaderConfig": {
"ScheduleConfig": {
"DurationInSeconds": number,
"ScheduleExpression": "string"
}
}
},
"FailedStatusDetails": "string",
"LastUpdatedTime": number,
"StreamARN": "string",
"StreamName": "string",
"SyncStatus": "string"
}
```
## Antwortelemente
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.
** [CreationTime](#API_StartEdgeConfigurationUpdate_ResponseSyntax) **
Der Zeitstempel, zu dem die Edge-Konfiguration eines Streams zum ersten Mal erstellt wurde.
Typ: Zeitstempel
** [EdgeConfig](#API_StartEdgeConfigurationUpdate_ResponseSyntax) **
Eine Beschreibung der Edge-Konfiguration des Streams, die für die Synchronisierung mit der Edge Agent IoT Greengrass-Komponente verwendet wird. Die Edge Agent-Komponente wird auf einem IoT Hub-Gerät ausgeführt, das bei Ihnen vor Ort eingerichtet ist.
Typ: [EdgeConfig](API_EdgeConfig.md) Objekt
** [FailedStatusDetails](#API_StartEdgeConfigurationUpdate_ResponseSyntax) **
Eine Beschreibung des generierten Fehlerstatus.
Typ: Zeichenfolge
** [LastUpdatedTime](#API_StartEdgeConfigurationUpdate_ResponseSyntax) **
Der Zeitstempel, zu dem die Edge-Konfiguration eines Streams zuletzt aktualisiert wurde.
Typ: Zeitstempel
** [StreamARN](#API_StartEdgeConfigurationUpdate_ResponseSyntax) **
Der Amazon-Ressourcenname (ARN) des -Stream.
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]+`
** [StreamName](#API_StartEdgeConfigurationUpdate_ResponseSyntax) **
Der Name des Streams, von dem aus die Edge-Konfiguration aktualisiert wurde.
Typ: Zeichenfolge
Längenbeschränkungen: Minimale Länge beträgt 1 Zeichen. Maximale Länge beträgt 256 Zeichen.
Pattern: `[a-zA-Z0-9_.-]+`
** [SyncStatus](#API_StartEdgeConfigurationUpdate_ResponseSyntax) **
Der aktuelle Synchronisierungsstatus der Edge-Konfiguration des Streams. Wenn Sie diese API aufrufen, wird der Synchronisierungsstatus auf den `SYNCING` Status gesetzt. Verwenden Sie die `DescribeEdgeConfiguration` API, um den neuesten Status der Edge-Konfiguration abzurufen.
Typ: Zeichenfolge
Zulässige Werte: `SYNCING | ACKNOWLEDGED | IN_SYNC | SYNC_FAILED | DELETING | DELETE_FAILED | DELETING_ACKNOWLEDGED`
## Fehler
Weitere Informationen zu den allgemeinen Fehlern, die bei allen Aktionen zurückgegeben werden, finden Sie unter [Häufige Fehlertypen](CommonErrors.md).
** AccessDeniedException **
Sie verfügen nicht über die erforderlichen Berechtigungen, um diesen Vorgang auszuführen.
HTTP-Statuscode: 401
** ClientLimitExceededException **
Kinesis Video Streams hat die Anfrage gedrosselt, weil Sie das Limit der erlaubten Client-Aufrufe überschritten haben. Versuchen Sie später, den Anruf zu tätigen.
HTTP-Statuscode: 400
** InvalidArgumentException **
Der Wert für diesen Eingabeparameter ist ungültig.
HTTP-Statuscode: 400
** NoDataRetentionException **
Die Stream-Datenspeicherung in Stunden ist gleich Null.
HTTP-Statuscode: 400
** ResourceInUseException **
Wenn der Eingang `StreamARN` oder `ChannelARN` Eingang bereits einer anderen Kinesis Video Stream-Ressource zugeordnet `CLOUD_STORAGE_MODE` ist oder wenn sich der angegebene Eingang `StreamARN` oder Eingang nicht im Status Aktiv `ChannelARN` befindet, versuchen Sie es mit einer der folgenden Methoden:
1. Die `DescribeMediaStorageConfiguration` API, um zu ermitteln, welchem Stream der angegebene Kanal zugeordnet ist.
1. Die `DescribeMappedResourceConfiguration` API zur Bestimmung des Kanals, dem der angegebene Stream zugeordnet ist.
1. Die `DescribeStream` oder `DescribeSignalingChannel` API zur Bestimmung des Status der Ressource.
HTTP-Statuscode: 400
** ResourceNotFoundException **
Amazon Kinesis Video Streams kann den von Ihnen angegebenen Stream nicht finden.
HTTP-Statuscode: 404
## Weitere Informationen finden Sie unter:
Weitere Informationen zur Verwendung dieser API in einer der sprachspezifischen Sprachen finden Sie im AWS SDKs Folgenden:
+ [AWS Befehlszeilenschnittstelle V2](https://docs.aws.amazon.com/goto/cli2/kinesisvideo-2017-09-30/StartEdgeConfigurationUpdate)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/kinesisvideo-2017-09-30/StartEdgeConfigurationUpdate)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/kinesisvideo-2017-09-30/StartEdgeConfigurationUpdate)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/kinesisvideo-2017-09-30/StartEdgeConfigurationUpdate)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/kinesisvideo-2017-09-30/StartEdgeConfigurationUpdate)
+ [AWS SDK für JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/kinesisvideo-2017-09-30/StartEdgeConfigurationUpdate)
+ [AWS SDK für Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/kinesisvideo-2017-09-30/StartEdgeConfigurationUpdate)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/kinesisvideo-2017-09-30/StartEdgeConfigurationUpdate)
+ [AWS SDK für Python](https://docs.aws.amazon.com/goto/boto3/kinesisvideo-2017-09-30/StartEdgeConfigurationUpdate)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/kinesisvideo-2017-09-30/StartEdgeConfigurationUpdate)
# TagResource
Fügt **nur** einem Signalkanal ein oder mehrere Tags hinzu. **Hinweis:** Verwenden Sie stattdessen die TagStream API, um Streams zu taggen. Ein *Tag* ist ein Schlüssel-Wert-Paar (der Wert ist optional), das Sie definieren und Ressourcen zuweisen AWS können. Wenn Sie ein Tag spezifizieren, das bereits existiert, wird der Tag-Wert durch den Wert ersetzt, den Sie in der Anfrage angeben. Weitere Informationen finden Sie unter [Verwenden von Kostenzuordnungs-Tags](https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/cost-alloc-tags.html) im * AWS Fakturierung und Kostenmanagement and Cost Management-Benutzerhandbuch*.
## Anforderungssyntax
```
POST /TagResource HTTP/1.1
Content-type: application/json
{
"ResourceARN": "string",
"Tags": [
{
"Key": "string",
"Value": "string"
}
]
}
```
## URI-Anfrageparameter
Die Anforderung verwendet keine URI-Parameter.
## Anforderungstext
Die Anforderung akzeptiert die folgenden Daten im JSON-Format.
** [ResourceARN](#API_TagResource_RequestSyntax) **
Der Amazon-Ressourcenname (ARN) des Signalisierungskanals, zu dem Sie Tags hinzufügen möchten.
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: Ja
** [Tags](#API_TagResource_RequestSyntax) **
Eine Liste von Tags, die dem angegebenen Signalkanal zugeordnet werden sollen. Jeder Tag ist ein Schlüssel/Wert-Paar.
Typ: Array von [Tag](API_Tag.md)-Objekten
Array-Mitglieder: Die Mindestanzahl beträgt 1 Element. Die maximale Anzahl beträgt 50 Elemente.
Erforderlich: Ja
## Antwortsyntax
```
HTTP/1.1 200
```
## Antwortelemente
Wenn die Aktion erfolgreich ist, gibt der Dienst eine HTTP 200-Antwort mit leerem HTTP-Textinhalt zurück.
## Fehler
Weitere Informationen zu den allgemeinen Fehlern, die bei allen Aktionen zurückgegeben werden, finden Sie unter [Häufige Fehlertypen](CommonErrors.md).
** AccessDeniedException **
Sie verfügen nicht über die erforderlichen Berechtigungen, um diesen Vorgang auszuführen.
HTTP-Statuscode: 401
** ClientLimitExceededException **
Kinesis Video Streams hat die Anfrage gedrosselt, weil Sie das Limit der erlaubten Client-Aufrufe überschritten haben. Versuchen Sie später, den Anruf zu tätigen.
HTTP-Statuscode: 400
** InvalidArgumentException **
Der Wert für diesen Eingabeparameter ist ungültig.
HTTP-Statuscode: 400
** ResourceNotFoundException **
Amazon Kinesis Video Streams kann den von Ihnen angegebenen Stream nicht finden.
HTTP-Statuscode: 404
** TagsPerResourceExceededLimitException **
Sie haben das Limit an Tags überschritten, die Sie der Ressource zuordnen können. Ein Kinesis-Videostream kann bis zu 50 Tags unterstützen.
HTTP-Statuscode: 400
## Weitere Informationen finden Sie unter:
Weitere Informationen zur Verwendung dieser API in einer der sprachspezifischen Sprachen finden Sie im AWS SDKs Folgenden:
+ [AWS Befehlszeilenschnittstelle V2](https://docs.aws.amazon.com/goto/cli2/kinesisvideo-2017-09-30/TagResource)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/kinesisvideo-2017-09-30/TagResource)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/kinesisvideo-2017-09-30/TagResource)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/kinesisvideo-2017-09-30/TagResource)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/kinesisvideo-2017-09-30/TagResource)
+ [AWS SDK für JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/kinesisvideo-2017-09-30/TagResource)
+ [AWS SDK für Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/kinesisvideo-2017-09-30/TagResource)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/kinesisvideo-2017-09-30/TagResource)
+ [AWS SDK für Python](https://docs.aws.amazon.com/goto/boto3/kinesisvideo-2017-09-30/TagResource)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/kinesisvideo-2017-09-30/TagResource)
# TagStream
Fügt einem Stream ein oder mehrere Tags hinzu. Ein *Tag* ist ein Schlüssel-Wert-Paar (der Wert ist optional), das Sie definieren und Ressourcen zuweisen AWS können. Wenn Sie ein Tag spezifizieren, das bereits existiert, wird der Tag-Wert durch den Wert ersetzt, den Sie in der Anfrage angeben. Weitere Informationen finden Sie unter [Verwenden von Kostenzuordnungs-Tags](https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/cost-alloc-tags.html) im * AWS Fakturierung und Kostenmanagement and Cost Management-Benutzerhandbuch*.
Sie müssen entweder den `StreamName` oder den angeben`StreamARN`.
Diese Operation setzt eine Berechtigung für die `KinesisVideo:TagStream`-Aktion voraus.
Ein Kinesis-Videostream kann bis zu 50 Tags unterstützen.
## Anforderungssyntax
```
POST /tagStream HTTP/1.1
Content-type: application/json
{
"StreamARN": "string",
"StreamName": "string",
"Tags": {
"string" : "string"
}
}
```
## URI-Anfrageparameter
Die Anforderung verwendet keine URI-Parameter.
## Anforderungstext
Die Anforderung akzeptiert die folgenden Daten im JSON-Format.
** [StreamARN](#API_TagStream_RequestSyntax) **
Der Amazon-Ressourcenname (ARN) der Ressource, zu der Sie das Tag oder die Tags hinzufügen möchten.
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_TagStream_RequestSyntax) **
Der Name des Streams, zu dem Sie das Tag oder die Tags hinzufügen möchten.
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
** [Tags](#API_TagStream_RequestSyntax) **
Eine Liste von Tags, die dem angegebenen Stream zugeordnet werden sollen. Jedes Tag ist ein Schlüssel-Wert-Paar (der Wert ist optional).
Typ: Abbildung einer Zeichenfolge auf eine Zeichenfolge
Karteneinträge: Maximale Anzahl von 50 Elementen.
Schlüssel-Längenbeschränkungen: Minimale Länge von 1. Maximale Länge beträgt 128 Zeichen.
Schlüssel-Muster: `^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$`
Längenbeschränkungen für Werte: Mindestlänge von 0. Maximale Länge beträgt 256 Zeichen.
Wertemuster: `[\p{L}\p{Z}\p{N}_.:/=+\-@]*`
Erforderlich: Ja
## Antwortsyntax
```
HTTP/1.1 200
```
## Antwortelemente
Wenn die Aktion erfolgreich ist, gibt der Dienst eine HTTP 200-Antwort mit leerem HTTP-Textinhalt zurück.
## Fehler
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 das Limit der erlaubten Client-Aufrufe überschritten haben. Versuchen Sie später, den Anruf zu tätigen.
HTTP-Statuscode: 400
** InvalidArgumentException **
Der Wert für diesen Eingabeparameter ist ungültig.
HTTP-Statuscode: 400
** InvalidResourceFormatException **
Das Format von `StreamARN` ist ungültig.
HTTP-Statuscode: 400
** NotAuthorizedException **
Der Anrufer ist nicht autorisiert, diesen Vorgang auszuführen.
HTTP-Statuscode: 401
** ResourceNotFoundException **
Amazon Kinesis Video Streams kann den von Ihnen angegebenen Stream nicht finden.
HTTP-Statuscode: 404
** TagsPerResourceExceededLimitException **
Sie haben das Limit an Tags überschritten, die Sie der Ressource zuordnen können. Ein Kinesis-Videostream kann bis zu 50 Tags unterstützen.
HTTP-Statuscode: 400
## Weitere Informationen finden Sie unter:
Weitere Informationen zur Verwendung dieser API in einer der sprachspezifischen Sprachen finden Sie im AWS SDKs Folgenden:
+ [AWS Befehlszeilenschnittstelle V2](https://docs.aws.amazon.com/goto/cli2/kinesisvideo-2017-09-30/TagStream)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/kinesisvideo-2017-09-30/TagStream)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/kinesisvideo-2017-09-30/TagStream)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/kinesisvideo-2017-09-30/TagStream)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/kinesisvideo-2017-09-30/TagStream)
+ [AWS SDK für JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/kinesisvideo-2017-09-30/TagStream)
+ [AWS SDK für Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/kinesisvideo-2017-09-30/TagStream)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/kinesisvideo-2017-09-30/TagStream)
+ [AWS SDK für Python](https://docs.aws.amazon.com/goto/boto3/kinesisvideo-2017-09-30/TagStream)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/kinesisvideo-2017-09-30/TagStream)
# UntagResource
Entfernt ein oder mehrere Tags **nur** aus einem Signalkanal. **Hinweis:** Verwenden Sie stattdessen die UntagStream API, um Tags aus Streams zu entfernen. Geben Sie in der Anfrage nur einen oder mehrere Tag-Schlüssel an; geben Sie nicht den Wert an. Wenn Sie einen Tag-Schlüssel angeben, der nicht existiert, wird er ignoriert.
## Anforderungssyntax
```
POST /UntagResource HTTP/1.1
Content-type: application/json
{
"ResourceARN": "string",
"TagKeyList": [ "string" ]
}
```
## URI-Anfrageparameter
Die Anforderung verwendet keine URI-Parameter.
## Anforderungstext
Die Anforderung akzeptiert die folgenden Daten im JSON-Format.
** [ResourceARN](#API_UntagResource_RequestSyntax) **
Der Amazon-Ressourcenname (ARN) des Signalisierungskanals, aus dem Sie Tags entfernen möchten.
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: Ja
** [TagKeyList](#API_UntagResource_RequestSyntax) **
Eine Liste der Schlüssel der Tags, die Sie entfernen möchten.
Typ: Zeichenfolgen-Array
Array-Mitglieder: Die Mindestanzahl beträgt 1 Element. Die maximale Anzahl beträgt 50 Elemente.
Längenbeschränkungen: Minimale Länge beträgt 1 Zeichen. Maximale Länge beträgt 128 Zeichen.
Pattern: `^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$`
Erforderlich: Ja
## Antwortsyntax
```
HTTP/1.1 200
```
## Antwortelemente
Wenn die Aktion erfolgreich ist, gibt der Dienst eine HTTP 200-Antwort mit leerem HTTP-Textinhalt zurück.
## Fehler
Weitere Informationen zu den allgemeinen Fehlern, die bei allen Aktionen zurückgegeben werden, finden Sie unter [Häufige Fehlertypen](CommonErrors.md).
** AccessDeniedException **
Sie verfügen nicht über die erforderlichen Berechtigungen, um diesen Vorgang auszuführen.
HTTP-Statuscode: 401
** ClientLimitExceededException **
Kinesis Video Streams hat die Anfrage gedrosselt, weil Sie das Limit der erlaubten Client-Aufrufe überschritten haben. Versuchen Sie später, den Anruf zu tätigen.
HTTP-Statuscode: 400
** InvalidArgumentException **
Der Wert für diesen Eingabeparameter ist ungültig.
HTTP-Statuscode: 400
** ResourceNotFoundException **
Amazon Kinesis Video Streams kann den von Ihnen angegebenen Stream nicht finden.
HTTP-Statuscode: 404
## Weitere Informationen finden Sie unter:
Weitere Informationen zur Verwendung dieser API in einer der sprachspezifischen Sprachen finden Sie im AWS SDKs Folgenden:
+ [AWS Befehlszeilenschnittstelle V2](https://docs.aws.amazon.com/goto/cli2/kinesisvideo-2017-09-30/UntagResource)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/kinesisvideo-2017-09-30/UntagResource)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/kinesisvideo-2017-09-30/UntagResource)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/kinesisvideo-2017-09-30/UntagResource)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/kinesisvideo-2017-09-30/UntagResource)
+ [AWS SDK für JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/kinesisvideo-2017-09-30/UntagResource)
+ [AWS SDK für Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/kinesisvideo-2017-09-30/UntagResource)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/kinesisvideo-2017-09-30/UntagResource)
+ [AWS SDK für Python](https://docs.aws.amazon.com/goto/boto3/kinesisvideo-2017-09-30/UntagResource)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/kinesisvideo-2017-09-30/UntagResource)
# UntagStream
Entfernt ein oder mehrere Tags aus einem Stream. Geben Sie in der Anfrage nur einen oder mehrere Tag-Schlüssel an, geben Sie nicht den Wert an. Wenn Sie einen Tag-Schlüssel angeben, der nicht existiert, wird er ignoriert.
In der Anfrage müssen Sie das `StreamName` oder angeben`StreamARN`.
## Anforderungssyntax
```
POST /untagStream HTTP/1.1
Content-type: application/json
{
"StreamARN": "string",
"StreamName": "string",
"TagKeyList": [ "string" ]
}
```
## URI-Anfrageparameter
Die Anforderung verwendet keine URI-Parameter.
## Anforderungstext
Die Anforderung akzeptiert die folgenden Daten im JSON-Format.
** [StreamARN](#API_UntagStream_RequestSyntax) **
Der Amazon-Ressourcenname (ARN) des Streams, aus dem Sie Tags entfernen möchten.
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_UntagStream_RequestSyntax) **
Der Name des Streams, aus dem Sie Tags entfernen möchten.
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
** [TagKeyList](#API_UntagStream_RequestSyntax) **
Eine Liste der Schlüssel der Tags, die Sie entfernen möchten.
Typ: Zeichenfolgen-Array
Array-Mitglieder: Die Mindestanzahl beträgt 1 Element. Die maximale Anzahl beträgt 50 Elemente.
Längenbeschränkungen: Minimale Länge beträgt 1 Zeichen. Maximale Länge beträgt 128 Zeichen.
Pattern: `^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$`
Erforderlich: Ja
## Antwortsyntax
```
HTTP/1.1 200
```
## Antwortelemente
Wenn die Aktion erfolgreich ist, gibt der Dienst eine HTTP 200-Antwort mit leerem HTTP-Textinhalt zurück.
## Fehler
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 das Limit der erlaubten Client-Aufrufe überschritten haben. Versuchen Sie später, den Anruf zu tätigen.
HTTP-Statuscode: 400
** InvalidArgumentException **
Der Wert für diesen Eingabeparameter ist ungültig.
HTTP-Statuscode: 400
** InvalidResourceFormatException **
Das Format von `StreamARN` ist ungültig.
HTTP-Statuscode: 400
** NotAuthorizedException **
Der Anrufer ist nicht autorisiert, diesen Vorgang auszuführen.
HTTP-Statuscode: 401
** ResourceNotFoundException **
Amazon Kinesis Video Streams kann den von Ihnen angegebenen Stream nicht finden.
HTTP-Statuscode: 404
## Weitere Informationen finden Sie unter:
Weitere Informationen zur Verwendung dieser API in einer der sprachspezifischen Sprachen finden Sie im AWS SDKs Folgenden:
+ [AWS Befehlszeilenschnittstelle V2](https://docs.aws.amazon.com/goto/cli2/kinesisvideo-2017-09-30/UntagStream)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/kinesisvideo-2017-09-30/UntagStream)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/kinesisvideo-2017-09-30/UntagStream)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/kinesisvideo-2017-09-30/UntagStream)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/kinesisvideo-2017-09-30/UntagStream)
+ [AWS SDK für JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/kinesisvideo-2017-09-30/UntagStream)
+ [AWS SDK für Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/kinesisvideo-2017-09-30/UntagStream)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/kinesisvideo-2017-09-30/UntagStream)
+ [AWS SDK für Python](https://docs.aws.amazon.com/goto/boto3/kinesisvideo-2017-09-30/UntagStream)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/kinesisvideo-2017-09-30/UntagStream)
# UpdateDataRetention
Erhöht oder verringert die Datenaufbewahrungsdauer des Streams um den von Ihnen angegebenen Wert. Um anzugeben, ob Sie die Datenaufbewahrungsdauer verlängern oder verkürzen möchten, geben Sie den `Operation` Parameter im Anfragetext an. In der Anfrage müssen Sie entweder den `StreamName` oder den angeben`StreamARN`.
Diese Operation setzt eine Berechtigung für die `KinesisVideo:UpdateDataRetention`-Aktion voraus.
Eine Änderung der Datenaufbewahrungsdauer wirkt sich wie folgt auf die Daten im Stream aus:
+ Wenn die Datenaufbewahrungsfrist verlängert wird, werden bestehende Daten für die neue Aufbewahrungsfrist aufbewahrt. Wenn beispielsweise die Datenaufbewahrungsdauer von einer Stunde auf sieben Stunden verlängert wird, werden alle vorhandenen Daten sieben Stunden lang aufbewahrt.
+ Wenn die Datenaufbewahrungsdauer verkürzt wird, werden die vorhandenen Daten für die neue Aufbewahrungsfrist aufbewahrt. Wenn beispielsweise die Datenaufbewahrungsdauer von sieben Stunden auf eine Stunde verkürzt wird, werden alle vorhandenen Daten für eine Stunde aufbewahrt, und alle Daten, die älter als eine Stunde sind, werden sofort gelöscht.
## Anforderungssyntax
```
POST /updateDataRetention HTTP/1.1
Content-type: application/json
{
"CurrentVersion": "string",
"DataRetentionChangeInHours": number,
"Operation": "string",
"StreamARN": "string",
"StreamName": "string"
}
```
## URI-Anfrageparameter
Die Anforderung verwendet keine URI-Parameter.
## Anforderungstext
Die Anforderung akzeptiert die folgenden Daten im JSON-Format.
** [CurrentVersion](#API_UpdateDataRetention_RequestSyntax) **
Die Version des Streams, dessen Aufbewahrungszeitraum Sie ändern möchten. Um die Version abzurufen, rufen Sie entweder die `DescribeStream` oder die `ListStreams` API auf.
Typ: Zeichenfolge
Längenbeschränkungen: Minimale Länge beträgt 1 Zeichen. Maximale Länge beträgt 64 Zeichen.
Pattern: `[a-zA-Z0-9]+`
Erforderlich: Ja
** [DataRetentionChangeInHours](#API_UpdateDataRetention_RequestSyntax) **
Die Anzahl der Stunden, um die die aktuelle Aufbewahrung angepasst werden soll. Der von Ihnen angegebene Wert wird zum aktuellen Wert addiert oder von diesem subtrahiert, abhängig von. `operation`
Der Mindestwert für die Datenspeicherung ist 0 und der Höchstwert ist 87600 (zehn Jahre).
Typ: Ganzzahl
Gültiger Bereich: Mindestwert 1.
Erforderlich: Ja
** [Operation](#API_UpdateDataRetention_RequestSyntax) **
Gibt an, ob Sie die Aufbewahrungsdauer verlängern oder verkürzen möchten.
Typ: Zeichenfolge
Zulässige Werte: `INCREASE_DATA_RETENTION | DECREASE_DATA_RETENTION`
Erforderlich: Ja
** [StreamARN](#API_UpdateDataRetention_RequestSyntax) **
Der Amazon-Ressourcenname (ARN) des Streams, dessen Aufbewahrungszeitraum Sie ändern möchten.
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_UpdateDataRetention_RequestSyntax) **
Der Name des Streams, dessen Aufbewahrungszeitraum Sie ändern möchten.
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
## Antwortsyntax
```
HTTP/1.1 200
```
## Antwortelemente
Wenn die Aktion erfolgreich ist, gibt der Dienst eine HTTP 200-Antwort mit leerem HTTP-Textinhalt zurück.
## Fehler
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 das Limit der erlaubten Client-Aufrufe überschritten haben. Versuchen Sie später, den Anruf zu tätigen.
HTTP-Statuscode: 400
** InvalidArgumentException **
Der Wert für diesen Eingabeparameter ist ungültig.
HTTP-Statuscode: 400
** NotAuthorizedException **
Der Anrufer ist nicht autorisiert, diesen Vorgang auszuführen.
HTTP-Statuscode: 401
** ResourceInUseException **
Wenn der Eingang `StreamARN` oder `ChannelARN` Eingang bereits einer anderen Kinesis Video Stream-Ressource zugeordnet `CLOUD_STORAGE_MODE` ist oder wenn sich der angegebene Eingang `StreamARN` oder Eingang nicht im Status Aktiv `ChannelARN` befindet, versuchen Sie es mit einer der folgenden Methoden:
1. Die `DescribeMediaStorageConfiguration` API, um zu ermitteln, welchem Stream der angegebene Kanal zugeordnet ist.
1. Die `DescribeMappedResourceConfiguration` API zur Bestimmung des Kanals, dem der angegebene Stream zugeordnet ist.
1. Die `DescribeStream` oder `DescribeSignalingChannel` API, um den Status der Ressource zu bestimmen.
HTTP-Statuscode: 400
** ResourceNotFoundException **
Amazon Kinesis Video Streams kann den von Ihnen angegebenen Stream nicht finden.
HTTP-Statuscode: 404
** VersionMismatchException **
Die von Ihnen angegebene Stream-Version ist nicht die neueste Version. Verwenden Sie die [DescribeStream](https://docs.aws.amazon.com/kinesisvideostreams/latest/dg/API_DescribeStream.html)API, um die neueste Version zu erhalten.
HTTP-Statuscode: 400
## Weitere Informationen finden Sie unter:
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/kinesisvideo-2017-09-30/UpdateDataRetention)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/kinesisvideo-2017-09-30/UpdateDataRetention)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/kinesisvideo-2017-09-30/UpdateDataRetention)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/kinesisvideo-2017-09-30/UpdateDataRetention)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/kinesisvideo-2017-09-30/UpdateDataRetention)
+ [AWS SDK für JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/kinesisvideo-2017-09-30/UpdateDataRetention)
+ [AWS SDK für Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/kinesisvideo-2017-09-30/UpdateDataRetention)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/kinesisvideo-2017-09-30/UpdateDataRetention)
+ [AWS SDK für Python](https://docs.aws.amazon.com/goto/boto3/kinesisvideo-2017-09-30/UpdateDataRetention)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/kinesisvideo-2017-09-30/UpdateDataRetention)
# UpdateImageGenerationConfiguration
Aktualisiert die `ImageProcessingConfiguration` Felder `StreamInfo` und.
## Anforderungssyntax
```
POST /updateImageGenerationConfiguration HTTP/1.1
Content-type: application/json
{
"ImageGenerationConfiguration": {
"DestinationConfig": {
"DestinationRegion": "string",
"Uri": "string"
},
"Format": "string",
"FormatConfig": {
"string" : "string"
},
"HeightPixels": number,
"ImageSelectorType": "string",
"SamplingInterval": number,
"Status": "string",
"WidthPixels": number
},
"StreamARN": "string",
"StreamName": "string"
}
```
## URI-Anfrageparameter
Die Anforderung verwendet keine URI-Parameter.
## Anforderungstext
Die Anforderung akzeptiert die folgenden Daten im JSON-Format.
** [ImageGenerationConfiguration](#API_UpdateImageGenerationConfiguration_RequestSyntax) **
Die Struktur, die die Informationen enthält, die für die Lieferung von KVS-Images erforderlich sind. Wenn die Struktur Null ist, wird die Konfiguration aus dem Stream gelöscht.
Typ: [ImageGenerationConfiguration](API_ImageGenerationConfiguration.md) Objekt
Erforderlich: Nein
** [StreamARN](#API_UpdateImageGenerationConfiguration_RequestSyntax) **
Der Amazon-Ressourcenname (ARN) des Kinesis-Videostreams, von dem aus Sie die Konfiguration der Image-Generierung aktualisieren möchten. Sie müssen entweder den `StreamName` oder den `StreamARN` angeben.
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_UpdateImageGenerationConfiguration_RequestSyntax) **
Der Name des Streams, aus dem die Konfiguration der Image-Generierung aktualisiert werden soll. 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
## Antwortsyntax
```
HTTP/1.1 200
```
## Antwortelemente
Wenn die Aktion erfolgreich ist, gibt der Dienst eine HTTP 200-Antwort mit leerem HTTP-Textinhalt zurück.
## Fehler
Weitere Informationen zu den allgemeinen Fehlern, die bei allen Aktionen zurückgegeben werden, finden Sie unter [Häufige Fehlertypen](CommonErrors.md).
** AccessDeniedException **
Sie verfügen nicht über die erforderlichen Berechtigungen, um diesen Vorgang auszuführen.
HTTP-Statuscode: 401
** ClientLimitExceededException **
Kinesis Video Streams hat die Anfrage gedrosselt, weil Sie das Limit der erlaubten Client-Aufrufe überschritten haben. Versuchen Sie später, den Anruf zu tätigen.
HTTP-Statuscode: 400
** InvalidArgumentException **
Der Wert für diesen Eingabeparameter ist ungültig.
HTTP-Statuscode: 400
** NoDataRetentionException **
Die Stream-Datenspeicherung in Stunden ist gleich Null.
HTTP-Statuscode: 400
** ResourceInUseException **
Wenn der Eingang `StreamARN` oder `ChannelARN` Eingang bereits einer anderen Kinesis Video Stream-Ressource zugeordnet `CLOUD_STORAGE_MODE` ist oder wenn sich der angegebene Eingang `StreamARN` oder Eingang nicht im Status Aktiv `ChannelARN` befindet, versuchen Sie es mit einer der folgenden Methoden:
1. Die `DescribeMediaStorageConfiguration` API, um zu ermitteln, welchem Stream der angegebene Kanal zugeordnet ist.
1. Die `DescribeMappedResourceConfiguration` API zur Bestimmung des Kanals, dem der angegebene Stream zugeordnet ist.
1. Die `DescribeStream` oder `DescribeSignalingChannel` API, um den Status der Ressource zu bestimmen.
HTTP-Statuscode: 400
** ResourceNotFoundException **
Amazon Kinesis Video Streams kann den von Ihnen angegebenen Stream nicht finden.
HTTP-Statuscode: 404
## Weitere Informationen finden Sie unter:
Weitere Informationen zur Verwendung dieser API in einer der sprachspezifischen Sprachen finden Sie im AWS SDKs Folgenden:
+ [AWS Befehlszeilenschnittstelle V2](https://docs.aws.amazon.com/goto/cli2/kinesisvideo-2017-09-30/UpdateImageGenerationConfiguration)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/kinesisvideo-2017-09-30/UpdateImageGenerationConfiguration)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/kinesisvideo-2017-09-30/UpdateImageGenerationConfiguration)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/kinesisvideo-2017-09-30/UpdateImageGenerationConfiguration)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/kinesisvideo-2017-09-30/UpdateImageGenerationConfiguration)
+ [AWS SDK für JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/kinesisvideo-2017-09-30/UpdateImageGenerationConfiguration)
+ [AWS SDK für Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/kinesisvideo-2017-09-30/UpdateImageGenerationConfiguration)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/kinesisvideo-2017-09-30/UpdateImageGenerationConfiguration)
+ [AWS SDK für Python](https://docs.aws.amazon.com/goto/boto3/kinesisvideo-2017-09-30/UpdateImageGenerationConfiguration)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/kinesisvideo-2017-09-30/UpdateImageGenerationConfiguration)
# UpdateMediaStorageConfiguration
Ordnet a `SignalingChannel` einem Stream zu, um die Medien zu speichern. Es gibt zwei Signalmodi, die Sie angeben können:
+ Wenn `StorageStatus` aktiviert, werden die Daten im `StreamARN` bereitgestellten Ordner gespeichert. Damit WebRTC Ingestion funktioniert, muss für den Stream die Datenspeicherung aktiviert sein.
+ Wenn deaktiviert `StorageStatus` ist, werden keine Daten gespeichert und der `StreamARN` Parameter wird nicht benötigt.
**Wichtig**
Wenn diese Option aktiviert `StorageStatus` ist, treten keine direkten Verbindungen peer-to-peer (Master-Viewer) mehr auf. Peers stellen eine direkte Verbindung zur Speichersitzung her. Sie müssen die `JoinStorageSession` API aufrufen, um das Senden eines SDP-Angebots auszulösen und eine Verbindung zwischen einem Peer und der Speichersitzung herzustellen.
## Anforderungssyntax
```
POST /updateMediaStorageConfiguration HTTP/1.1
Content-type: application/json
{
"ChannelARN": "string",
"MediaStorageConfiguration": {
"Status": "string",
"StreamARN": "string"
}
}
```
## URI-Anfrageparameter
Die Anforderung verwendet keine URI-Parameter.
## Anforderungstext
Die Anforderung akzeptiert die folgenden Daten im JSON-Format.
** [ChannelARN](#API_UpdateMediaStorageConfiguration_RequestSyntax) **
Der Amazon-Ressourcenname (ARN) des Kanals.
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: Ja
** [MediaStorageConfiguration](#API_UpdateMediaStorageConfiguration_RequestSyntax) **
Eine Struktur, die die Konfigurationseigenschaften des Medienspeichers kapselt oder enthält.
Typ: [MediaStorageConfiguration](API_MediaStorageConfiguration.md) Objekt
Erforderlich: Ja
## Antwortsyntax
```
HTTP/1.1 200
```
## Antwortelemente
Wenn die Aktion erfolgreich ist, gibt der Dienst eine HTTP 200-Antwort mit leerem HTTP-Textinhalt zurück.
## Fehler
Weitere Informationen zu den allgemeinen Fehlern, die bei allen Aktionen zurückgegeben werden, finden Sie unter [Häufige Fehlertypen](CommonErrors.md).
** AccessDeniedException **
Sie verfügen nicht über die erforderlichen Berechtigungen, um diesen Vorgang auszuführen.
HTTP-Statuscode: 401
** ClientLimitExceededException **
Kinesis Video Streams hat die Anfrage gedrosselt, weil Sie das Limit der erlaubten Client-Aufrufe überschritten haben. Versuchen Sie später, den Anruf zu tätigen.
HTTP-Statuscode: 400
** InvalidArgumentException **
Der Wert für diesen Eingabeparameter ist ungültig.
HTTP-Statuscode: 400
** NoDataRetentionException **
Die Stream-Datenspeicherung in Stunden ist gleich Null.
HTTP-Statuscode: 400
** ResourceInUseException **
Wenn der Eingang `StreamARN` oder `ChannelARN` Eingang bereits einer anderen Kinesis Video Stream-Ressource zugeordnet `CLOUD_STORAGE_MODE` ist oder wenn sich der angegebene Eingang `StreamARN` oder Eingang nicht im Status Aktiv `ChannelARN` befindet, versuchen Sie es mit einer der folgenden Methoden:
1. Die `DescribeMediaStorageConfiguration` API, um zu ermitteln, welchem Stream der angegebene Kanal zugeordnet ist.
1. Die `DescribeMappedResourceConfiguration` API zur Bestimmung des Kanals, dem der angegebene Stream zugeordnet ist.
1. Die `DescribeStream` oder `DescribeSignalingChannel` API, um den Status der Ressource zu bestimmen.
HTTP-Statuscode: 400
** ResourceNotFoundException **
Amazon Kinesis Video Streams kann den von Ihnen angegebenen Stream nicht finden.
HTTP-Statuscode: 404
## Weitere Informationen finden Sie unter:
Weitere Informationen zur Verwendung dieser API in einer der sprachspezifischen Sprachen finden Sie im AWS SDKs Folgenden:
+ [AWS Befehlszeilenschnittstelle V2](https://docs.aws.amazon.com/goto/cli2/kinesisvideo-2017-09-30/UpdateMediaStorageConfiguration)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/kinesisvideo-2017-09-30/UpdateMediaStorageConfiguration)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/kinesisvideo-2017-09-30/UpdateMediaStorageConfiguration)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/kinesisvideo-2017-09-30/UpdateMediaStorageConfiguration)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/kinesisvideo-2017-09-30/UpdateMediaStorageConfiguration)
+ [AWS SDK für JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/kinesisvideo-2017-09-30/UpdateMediaStorageConfiguration)
+ [AWS SDK für Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/kinesisvideo-2017-09-30/UpdateMediaStorageConfiguration)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/kinesisvideo-2017-09-30/UpdateMediaStorageConfiguration)
+ [AWS SDK für Python](https://docs.aws.amazon.com/goto/boto3/kinesisvideo-2017-09-30/UpdateMediaStorageConfiguration)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/kinesisvideo-2017-09-30/UpdateMediaStorageConfiguration)
# UpdateNotificationConfiguration
Aktualisiert die Benachrichtigungsinformationen für einen Stream.
## Anforderungssyntax
```
POST /updateNotificationConfiguration HTTP/1.1
Content-type: application/json
{
"NotificationConfiguration": {
"DestinationConfig": {
"Uri": "string"
},
"Status": "string"
},
"StreamARN": "string",
"StreamName": "string"
}
```
## URI-Anfrageparameter
Die Anforderung verwendet keine URI-Parameter.
## Anforderungstext
Die Anforderung akzeptiert die folgenden Daten im JSON-Format.
** [NotificationConfiguration](#API_UpdateNotificationConfiguration_RequestSyntax) **
Die Struktur, die die für Benachrichtigungen erforderlichen Informationen enthält. Wenn die Struktur Null ist, wird die Konfiguration aus dem Stream gelöscht.
Typ: [NotificationConfiguration](API_NotificationConfiguration.md) Objekt
Erforderlich: Nein
** [StreamARN](#API_UpdateNotificationConfiguration_RequestSyntax) **
Der Amazon-Ressourcenname (ARN) des Kinesis-Videostreams, von dem aus Sie die Benachrichtigungskonfiguration aktualisieren möchten. Sie müssen entweder den `StreamName` oder den `StreamARN` angeben.
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_UpdateNotificationConfiguration_RequestSyntax) **
Der Name des Streams, aus dem die Benachrichtigungskonfiguration aktualisiert werden soll. 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
## Antwortsyntax
```
HTTP/1.1 200
```
## Antwortelemente
Wenn die Aktion erfolgreich ist, gibt der Dienst eine HTTP 200-Antwort mit leerem HTTP-Textinhalt zurück.
## Fehler
Weitere Informationen zu den allgemeinen Fehlern, die bei allen Aktionen zurückgegeben werden, finden Sie unter [Häufige Fehlertypen](CommonErrors.md).
** AccessDeniedException **
Sie verfügen nicht über die erforderlichen Berechtigungen, um diesen Vorgang auszuführen.
HTTP-Statuscode: 401
** ClientLimitExceededException **
Kinesis Video Streams hat die Anfrage gedrosselt, weil Sie das Limit der erlaubten Client-Aufrufe überschritten haben. Versuchen Sie später, den Anruf zu tätigen.
HTTP-Statuscode: 400
** InvalidArgumentException **
Der Wert für diesen Eingabeparameter ist ungültig.
HTTP-Statuscode: 400
** NoDataRetentionException **
Die Stream-Datenspeicherung in Stunden ist gleich Null.
HTTP-Statuscode: 400
** ResourceInUseException **
Wenn der Eingang `StreamARN` oder `ChannelARN` Eingang bereits einer anderen Kinesis Video Stream-Ressource zugeordnet `CLOUD_STORAGE_MODE` ist oder wenn sich der angegebene Eingang `StreamARN` oder Eingang nicht im Status Aktiv `ChannelARN` befindet, versuchen Sie es mit einer der folgenden Methoden:
1. Die `DescribeMediaStorageConfiguration` API, um zu ermitteln, welchem Stream der angegebene Kanal zugeordnet ist.
1. Die `DescribeMappedResourceConfiguration` API zur Bestimmung des Kanals, dem der angegebene Stream zugeordnet ist.
1. Die `DescribeStream` oder `DescribeSignalingChannel` API zur Bestimmung des Status der Ressource.
HTTP-Statuscode: 400
** ResourceNotFoundException **
Amazon Kinesis Video Streams kann den von Ihnen angegebenen Stream nicht finden.
HTTP-Statuscode: 404
## Weitere Informationen finden Sie unter:
Weitere Informationen zur Verwendung dieser API in einer der sprachspezifischen Sprachen finden Sie im AWS SDKs Folgenden:
+ [AWS Befehlszeilenschnittstelle V2](https://docs.aws.amazon.com/goto/cli2/kinesisvideo-2017-09-30/UpdateNotificationConfiguration)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/kinesisvideo-2017-09-30/UpdateNotificationConfiguration)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/kinesisvideo-2017-09-30/UpdateNotificationConfiguration)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/kinesisvideo-2017-09-30/UpdateNotificationConfiguration)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/kinesisvideo-2017-09-30/UpdateNotificationConfiguration)
+ [AWS SDK für JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/kinesisvideo-2017-09-30/UpdateNotificationConfiguration)
+ [AWS SDK für Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/kinesisvideo-2017-09-30/UpdateNotificationConfiguration)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/kinesisvideo-2017-09-30/UpdateNotificationConfiguration)
+ [AWS SDK für Python](https://docs.aws.amazon.com/goto/boto3/kinesisvideo-2017-09-30/UpdateNotificationConfiguration)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/kinesisvideo-2017-09-30/UpdateNotificationConfiguration)
# UpdateSignalingChannel
Aktualisiert den vorhandenen Signalkanal. Dies ist ein asynchroner Vorgang, dessen Abschluss einige Zeit in Anspruch nimmt.
Wenn der `MessageTtlSeconds` Wert aktualisiert (entweder erhöht oder reduziert) wird, gilt er nur für neue Nachrichten, die über diesen Kanal gesendet wurden, nachdem er aktualisiert wurde. Bestehende Nachrichten sind weiterhin gemäß dem vorherigen `MessageTtlSeconds` Wert abgelaufen.
## Anforderungssyntax
```
POST /updateSignalingChannel HTTP/1.1
Content-type: application/json
{
"ChannelARN": "string",
"CurrentVersion": "string",
"SingleMasterConfiguration": {
"MessageTtlSeconds": number
}
}
```
## URI-Anfrageparameter
Die Anforderung verwendet keine URI-Parameter.
## Anforderungstext
Die Anforderung akzeptiert die folgenden Daten im JSON-Format.
** [ChannelARN](#API_UpdateSignalingChannel_RequestSyntax) **
Der Amazon-Ressourcenname (ARN) des Signalkanals, den Sie aktualisieren möchten.
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: Ja
** [CurrentVersion](#API_UpdateSignalingChannel_RequestSyntax) **
Die aktuelle Version des Signalkanals, den Sie aktualisieren möchten.
Typ: Zeichenfolge
Längenbeschränkungen: Minimale Länge beträgt 1 Zeichen. Maximale Länge beträgt 64 Zeichen.
Pattern: `[a-zA-Z0-9]+`
Erforderlich: Ja
** [SingleMasterConfiguration](#API_UpdateSignalingChannel_RequestSyntax) **
Die Struktur, die die Konfiguration für den `SINGLE_MASTER` Typ des Signalkanals enthält, den Sie aktualisieren möchten. Dieser Parameter und die Kanalnachrichten time-to-live sind für Kanäle mit dem `SINGLE_MASTER` Kanaltyp erforderlich.
Typ: [SingleMasterConfiguration](API_SingleMasterConfiguration.md) Objekt
Erforderlich: Nein
## Antwortsyntax
```
HTTP/1.1 200
```
## Antwortelemente
Wenn die Aktion erfolgreich ist, gibt der Dienst eine HTTP 200-Antwort mit leerem HTTP-Textinhalt zurück.
## Fehler
Weitere Informationen zu den allgemeinen Fehlern, die bei allen Aktionen zurückgegeben werden, finden Sie unter [Häufige Fehlertypen](CommonErrors.md).
** AccessDeniedException **
Sie verfügen nicht über die erforderlichen Berechtigungen, um diesen Vorgang auszuführen.
HTTP-Statuscode: 401
** ClientLimitExceededException **
Kinesis Video Streams hat die Anfrage gedrosselt, weil Sie das Limit der erlaubten Client-Aufrufe überschritten haben. Versuchen Sie später, den Anruf zu tätigen.
HTTP-Statuscode: 400
** InvalidArgumentException **
Der Wert für diesen Eingabeparameter ist ungültig.
HTTP-Statuscode: 400
** ResourceInUseException **
Wenn der Eingang `StreamARN` oder `ChannelARN` Eingang bereits einer anderen Kinesis Video Stream-Ressource zugeordnet `CLOUD_STORAGE_MODE` ist oder wenn sich der angegebene Eingang `StreamARN` oder Eingang nicht im Status Aktiv `ChannelARN` befindet, versuchen Sie es mit einer der folgenden Methoden:
1. Die `DescribeMediaStorageConfiguration` API, um zu ermitteln, welchem Stream der angegebene Kanal zugeordnet ist.
1. Die `DescribeMappedResourceConfiguration` API zur Bestimmung des Kanals, dem der angegebene Stream zugeordnet ist.
1. Die `DescribeStream` oder `DescribeSignalingChannel` API, um den Status der Ressource zu bestimmen.
HTTP-Statuscode: 400
** ResourceNotFoundException **
Amazon Kinesis Video Streams kann den von Ihnen angegebenen Stream nicht finden.
HTTP-Statuscode: 404
** VersionMismatchException **
Die von Ihnen angegebene Stream-Version ist nicht die neueste Version. Verwenden Sie die [DescribeStream](https://docs.aws.amazon.com/kinesisvideostreams/latest/dg/API_DescribeStream.html)API, um die neueste Version zu erhalten.
HTTP-Statuscode: 400
## Weitere Informationen finden Sie unter:
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/kinesisvideo-2017-09-30/UpdateSignalingChannel)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/kinesisvideo-2017-09-30/UpdateSignalingChannel)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/kinesisvideo-2017-09-30/UpdateSignalingChannel)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/kinesisvideo-2017-09-30/UpdateSignalingChannel)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/kinesisvideo-2017-09-30/UpdateSignalingChannel)
+ [AWS SDK für JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/kinesisvideo-2017-09-30/UpdateSignalingChannel)
+ [AWS SDK für Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/kinesisvideo-2017-09-30/UpdateSignalingChannel)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/kinesisvideo-2017-09-30/UpdateSignalingChannel)
+ [AWS SDK für Python](https://docs.aws.amazon.com/goto/boto3/kinesisvideo-2017-09-30/UpdateSignalingChannel)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/kinesisvideo-2017-09-30/UpdateSignalingChannel)
# UpdateStream
Aktualisiert Stream-Metadaten wie den Gerätenamen und den Medientyp.
Sie müssen den Stream-Namen oder den Amazon-Ressourcennamen (ARN) des Streams angeben.
Um sicherzustellen, dass Sie über die neueste Version des Streams verfügen, bevor Sie ihn aktualisieren, können Sie die Stream-Version angeben. Kinesis Video Streams weist jedem Stream eine Version zu. Wenn Sie einen Stream aktualisieren, weist Kinesis Video Streams eine neue Versionsnummer zu. Verwenden Sie die API, um die neueste Stream-Version zu erhalten. `DescribeStream`
`UpdateStream`ist ein asynchroner Vorgang, dessen Abschluss einige Zeit in Anspruch nimmt.
## Anforderungssyntax
```
POST /updateStream HTTP/1.1
Content-type: application/json
{
"CurrentVersion": "string",
"DeviceName": "string",
"MediaType": "string",
"StreamARN": "string",
"StreamName": "string"
}
```
## URI-Anfrageparameter
Die Anforderung verwendet keine URI-Parameter.
## Anforderungstext
Die Anforderung akzeptiert die folgenden Daten im JSON-Format.
** [CurrentVersion](#API_UpdateStream_RequestSyntax) **
Die Version des Streams, dessen Metadaten Sie aktualisieren möchten.
Typ: Zeichenfolge
Längenbeschränkungen: Minimale Länge beträgt 1 Zeichen. Maximale Länge beträgt 64 Zeichen.
Pattern: `[a-zA-Z0-9]+`
Erforderlich: Ja
** [DeviceName](#API_UpdateStream_RequestSyntax) **
Der Name des Geräts, das in den Stream schreibt.
In der aktuellen Implementierung verwendet Kinesis Video Streams diesen Namen nicht.
Typ: Zeichenfolge
Längenbeschränkungen: Minimale Länge beträgt 1 Zeichen. Maximale Länge beträgt 128 Zeichen.
Pattern: `[a-zA-Z0-9_.-]+`
Erforderlich: Nein
** [MediaType](#API_UpdateStream_RequestSyntax) **
Der Medientyp des Streams. Wird verwendet`MediaType`, um den Inhaltstyp anzugeben, den der Stream für die Nutzer des Streams enthält. Weitere Informationen zu Medientypen finden Sie unter [Medientypen](http://www.iana.org/assignments/media-types/media-types.xhtml). Wenn Sie das `MediaType` angeben möchten, finden Sie weitere Informationen unter [Benennungsvoraussetzungen](https://tools.ietf.org/html/rfc6838#section-4.2).
Um Video auf der Konsole abzuspielen, müssen Sie den richtigen Videotyp angeben. Wenn es sich bei dem Video im Stream beispielsweise um H.264 handelt, geben Sie `video/h264` als an`MediaType`.
Typ: Zeichenfolge
Längenbeschränkungen: Minimale Länge beträgt 1 Zeichen. Maximale Länge beträgt 128 Zeichen.
Pattern: `[\w\-\.\+]+/[\w\-\.\+]+(,[\w\-\.\+]+/[\w\-\.\+]+)*`
Erforderlich: Nein
** [StreamARN](#API_UpdateStream_RequestSyntax) **
Der ARN des Streams, dessen Metadaten Sie aktualisieren möchten.
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_UpdateStream_RequestSyntax) **
Der Name des Streams, dessen Metadaten Sie aktualisieren möchten.
Der Streamname ist eine Kennung für den Stream und muss für jedes Konto und jede Region eindeutig sein.
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
## Antwortsyntax
```
HTTP/1.1 200
```
## Antwortelemente
Wenn die Aktion erfolgreich ist, gibt der Dienst eine HTTP 200-Antwort mit leerem HTTP-Textinhalt zurück.
## Fehler
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 das Limit der erlaubten Client-Aufrufe überschritten haben. Versuchen Sie später, den Anruf zu tätigen.
HTTP-Statuscode: 400
** InvalidArgumentException **
Der Wert für diesen Eingabeparameter ist ungültig.
HTTP-Statuscode: 400
** NotAuthorizedException **
Der Anrufer ist nicht autorisiert, diesen Vorgang auszuführen.
HTTP-Statuscode: 401
** ResourceInUseException **
Wenn der Eingang `StreamARN` oder `ChannelARN` Eingang bereits einer anderen Kinesis Video Stream-Ressource zugeordnet `CLOUD_STORAGE_MODE` ist oder wenn sich der angegebene Eingang `StreamARN` oder Eingang nicht im Status Aktiv `ChannelARN` befindet, versuchen Sie es mit einer der folgenden Methoden:
1. Die `DescribeMediaStorageConfiguration` API, um zu ermitteln, welchem Stream der angegebene Kanal zugeordnet ist.
1. Die `DescribeMappedResourceConfiguration` API zur Bestimmung des Kanals, dem der angegebene Stream zugeordnet ist.
1. Die `DescribeStream` oder `DescribeSignalingChannel` API, um den Status der Ressource zu bestimmen.
HTTP-Statuscode: 400
** ResourceNotFoundException **
Amazon Kinesis Video Streams kann den von Ihnen angegebenen Stream nicht finden.
HTTP-Statuscode: 404
** VersionMismatchException **
Die von Ihnen angegebene Stream-Version ist nicht die neueste Version. Verwenden Sie die [DescribeStream](https://docs.aws.amazon.com/kinesisvideostreams/latest/dg/API_DescribeStream.html)API, um die neueste Version zu erhalten.
HTTP-Statuscode: 400
## Weitere Informationen finden Sie unter:
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/kinesisvideo-2017-09-30/UpdateStream)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/kinesisvideo-2017-09-30/UpdateStream)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/kinesisvideo-2017-09-30/UpdateStream)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/kinesisvideo-2017-09-30/UpdateStream)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/kinesisvideo-2017-09-30/UpdateStream)
+ [AWS SDK für JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/kinesisvideo-2017-09-30/UpdateStream)
+ [AWS SDK für Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/kinesisvideo-2017-09-30/UpdateStream)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/kinesisvideo-2017-09-30/UpdateStream)
+ [AWS SDK für Python](https://docs.aws.amazon.com/goto/boto3/kinesisvideo-2017-09-30/UpdateStream)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/kinesisvideo-2017-09-30/UpdateStream)
# UpdateStreamStorageConfiguration
Aktualisiert die Speicherkonfiguration für einen vorhandenen Kinesis-Videostream.
Dieser Vorgang ermöglicht es Ihnen, die Einstellungen der Speicherebene für einen Stream zu ändern, sodass Sie die Speicherkosten und die Leistung auf der Grundlage Ihrer Zugriffsmuster optimieren können.
`UpdateStreamStorageConfiguration` ist ein asynchroner Vorgang.
Sie müssen über Berechtigungen für die `KinesisVideo:UpdateStreamStorageConfiguration`-Aktion verfügen.
## Anforderungssyntax
```
POST /updateStreamStorageConfiguration HTTP/1.1
Content-type: application/json
{
"CurrentVersion": "string",
"StreamARN": "string",
"StreamName": "string",
"StreamStorageConfiguration": {
"DefaultStorageTier": "string"
}
}
```
## URI-Anfrageparameter
Die Anforderung verwendet keine URI-Parameter.
## Anforderungstext
Die Anforderung akzeptiert die folgenden Daten im JSON-Format.
** [CurrentVersion](#API_UpdateStreamStorageConfiguration_RequestSyntax) **
Die Version des Streams, dessen Speicherkonfiguration Sie ändern möchten. Um die Version abzurufen, rufen Sie entweder die `DescribeStream` oder die `ListStreams` API auf.
Typ: Zeichenfolge
Längenbeschränkungen: Minimale Länge beträgt 1 Zeichen. Maximale Länge beträgt 64 Zeichen.
Pattern: `[a-zA-Z0-9]+`
Erforderlich: Ja
** [StreamARN](#API_UpdateStreamStorageConfiguration_RequestSyntax) **
Der Amazon-Ressourcenname (ARN) des Streams, für den Sie die Speicherkonfiguration aktualisieren möchten.
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_UpdateStreamStorageConfiguration_RequestSyntax) **
Der Name des Streams, für den Sie die Speicherkonfiguration aktualisieren möchten.
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
** [StreamStorageConfiguration](#API_UpdateStreamStorageConfiguration_RequestSyntax) **
Die neue Speicherkonfiguration für den Stream. Dazu gehört die Standardspeicherebene, die bestimmt, wie Stream-Daten gespeichert und abgerufen werden.
Verschiedene Speicherstufen bieten ein unterschiedliches Maß an Leistung und Kostenoptimierung, um Ihren spezifischen Anwendungsfallanforderungen gerecht zu werden.
Typ: [StreamStorageConfiguration](API_StreamStorageConfiguration.md) Objekt
Erforderlich: Ja
## Antwortsyntax
```
HTTP/1.1 200
```
## Antwortelemente
Wenn die Aktion erfolgreich ist, gibt der Dienst eine HTTP 200-Antwort mit leerem HTTP-Textinhalt zurück.
## Fehler
Weitere Informationen zu den allgemeinen Fehlern, die bei allen Aktionen zurückgegeben werden, finden Sie unter [Häufige Fehlertypen](CommonErrors.md).
** AccessDeniedException **
Sie verfügen nicht über die erforderlichen Berechtigungen, um diesen Vorgang auszuführen.
HTTP-Statuscode: 401
** ClientLimitExceededException **
Kinesis Video Streams hat die Anfrage gedrosselt, weil Sie das Limit der erlaubten Client-Aufrufe überschritten haben. Versuchen Sie später, den Anruf zu tätigen.
HTTP-Statuscode: 400
** InvalidArgumentException **
Der Wert für diesen Eingabeparameter ist ungültig.
HTTP-Statuscode: 400
** ResourceInUseException **
Wenn der Eingang `StreamARN` oder `ChannelARN` Eingang bereits einer anderen Kinesis Video Stream-Ressource zugeordnet `CLOUD_STORAGE_MODE` ist oder wenn sich der angegebene Eingang `StreamARN` oder Eingang nicht im Status Aktiv `ChannelARN` befindet, versuchen Sie es mit einer der folgenden Methoden:
1. Die `DescribeMediaStorageConfiguration` API, um zu ermitteln, welchem Stream der angegebene Kanal zugeordnet ist.
1. Die `DescribeMappedResourceConfiguration` API zur Bestimmung des Kanals, dem der angegebene Stream zugeordnet ist.
1. Die `DescribeStream` oder `DescribeSignalingChannel` API, um den Status der Ressource zu bestimmen.
HTTP-Statuscode: 400
** ResourceNotFoundException **
Amazon Kinesis Video Streams kann den von Ihnen angegebenen Stream nicht finden.
HTTP-Statuscode: 404
** VersionMismatchException **
Die von Ihnen angegebene Stream-Version ist nicht die neueste Version. Verwenden Sie die [DescribeStream](https://docs.aws.amazon.com/kinesisvideostreams/latest/dg/API_DescribeStream.html)API, um die neueste Version zu erhalten.
HTTP-Statuscode: 400
## Weitere Informationen finden Sie unter:
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/kinesisvideo-2017-09-30/UpdateStreamStorageConfiguration)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/kinesisvideo-2017-09-30/UpdateStreamStorageConfiguration)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/kinesisvideo-2017-09-30/UpdateStreamStorageConfiguration)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/kinesisvideo-2017-09-30/UpdateStreamStorageConfiguration)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/kinesisvideo-2017-09-30/UpdateStreamStorageConfiguration)
+ [AWS SDK für JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/kinesisvideo-2017-09-30/UpdateStreamStorageConfiguration)
+ [AWS SDK für Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/kinesisvideo-2017-09-30/UpdateStreamStorageConfiguration)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/kinesisvideo-2017-09-30/UpdateStreamStorageConfiguration)
+ [AWS SDK für Python](https://docs.aws.amazon.com/goto/boto3/kinesisvideo-2017-09-30/UpdateStreamStorageConfiguration)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/kinesisvideo-2017-09-30/UpdateStreamStorageConfiguration)
# Amazon Kinesis Video Streams Streams-Medien
Die folgenden Aktionen werden von Amazon Kinesis Video Streams Media unterstützt:
+ [GetMedia](API_dataplane_GetMedia.md)
+ [PutMedia](API_dataplane_PutMedia.md)
# GetMedia
Verwenden Sie diese API, um Medieninhalte aus einem Kinesis-Videostream abzurufen. In der Anfrage identifizieren Sie den Streamnamen oder den Stream-Amazon-Ressourcennamen (ARN) und den Startblock. Kinesis Video Streams gibt dann einen Stream von Chunks zurück, der nach Fragmentnummer sortiert ist.
**Anmerkung**
Sie müssen zuerst die `GetDataEndpoint` API aufrufen, um einen Endpunkt zu erhalten. Senden Sie dann die `GetMedia` Anfragen mit dem Parameter [--endpoint-url an diesen Endpunkt](https://docs.aws.amazon.com/cli/latest/reference/).
Wenn Sie Mediendaten (Fragmente) in einen Stream einfügen, speichert Kinesis Video Streams jedes eingehende Fragment und die zugehörigen Metadaten in einem sogenannten „Chunk“. Weitere Informationen finden Sie unter [PutMedia](https://docs.aws.amazon.com/kinesisvideostreams/latest/dg/API_dataplane_PutMedia.html). Die `GetMedia` API gibt einen Stream dieser Chunks zurück, der mit dem Chunk beginnt, den Sie in der Anfrage angeben.
Die `GetMedia` API ist so konzipiert, dass sie als Streaming-API über eine lang andauernde Verbindung funktioniert. Sie ist nicht für die herkömmliche Verwendung vorgesehen, RESTful bei der für jedes Fragment eine neue HTTP-Verbindung hergestellt und geschlossen wird. Wenn Sie die `GetMedia` API aufrufen, überträgt Kinesis Video Streams Fragmente kontinuierlich über eine persistente Verbindung mit langer Laufzeit unter Verwendung der HTTP-Chunked-Transfercodierung.
Bei der Verwendung der API gelten die folgenden Beschränkungen: `GetMedia`
+ Ein Client kann `GetMedia` bis zu fünf Mal pro Sekunde pro Stream aufrufen.
+ Kinesis Video Streams sendet während einer Sitzung Mediendaten mit einer Geschwindigkeit von bis zu 25 Megabyte pro Sekunde (oder 200 Megabit pro Sekunde). `GetMedia`
**Anmerkung**
Wird `GetMedia` als Streaming-Verbindung mit langer Laufzeit verwendet, um mehrere Fragmente in einer einzigen persistenten Verbindung abzurufen. Verwenden Sie die `GetMedia` API nicht RESTful auf herkömmliche Weise, bei der Sie für jedes Fragment eine neue HTTP-Verbindung einrichten und schließen. Wenn Sie versuchen, mehr als drei `GetMedia` Verbindungen gleichzeitig herzustellen, drosselt Kinesis Video Streams die letzten Verbindungen mit einem Fehler. `ConnectionLimitExceededException`
**Anmerkung**
Der Statuscode der `GetMedia` HTTP-Antwort wird sofort zurückgegeben, aber das Lesen der Nutzdaten der HTTP-Antwort wird nach 3 Sekunden beendet, wenn keine aufgenommenen Fragmente für die Wiedergabe verfügbar sind.
**Anmerkung**
Wenn nach dem Aufrufen einer Kinesis Video Streams Streams-Medien-API ein Fehler ausgelöst wird, enthält dieser zusätzlich zum HTTP-Statuscode und dem Antworttext die folgenden Informationen:
`x-amz-ErrorType`HTTP-Header — enthält zusätzlich zu dem, was der HTTP-Statuscode bietet, einen spezifischeren Fehlertyp.
`x-amz-RequestId`HTTP-Header — Wenn Sie ein Problem melden möchten AWS, kann das Support-Team das Problem anhand der Anforderungs-ID besser diagnostizieren.
Sowohl der HTTP-Statuscode als auch der ErrorType Header können verwendet werden, um programmatische Entscheidungen darüber zu treffen, ob und unter welchen Bedingungen Fehler wiederholt werden können. Außerdem können Informationen darüber bereitgestellt werden, welche Maßnahmen der Client-Programmierer möglicherweise ergreifen muss, um es erneut erfolgreich zu versuchen.
[Weitere Informationen finden Sie im Abschnitt **Fehler** am Ende dieses Themas sowie unter Häufige Fehler.](https://docs.aws.amazon.com/kinesisvideostreams/latest/dg/CommonErrors.html)
## Anforderungssyntax
```
POST /getMedia HTTP/1.1
Content-type: application/json
{
"StartSelector": {
"AfterFragmentNumber": "string",
"ContinuationToken": "string",
"StartSelectorType": "string",
"StartTimestamp": number
},
"StreamARN": "string",
"StreamName": "string"
}
```
## URI-Anfrageparameter
Die Anforderung verwendet keine URI-Parameter.
## Anforderungstext
Die Anforderung akzeptiert die folgenden Daten im JSON-Format.
** [StartSelector](#API_dataplane_GetMedia_RequestSyntax) **
Identifiziert den Startblock, der aus dem angegebenen Stream abgerufen werden soll.
Typ: [StartSelector](API_dataplane_StartSelector.md) Objekt
Erforderlich: Ja
** [StreamARN](#API_dataplane_GetMedia_RequestSyntax) **
Der ARN des Streams, von dem Sie den Medieninhalt abrufen möchten. Wenn Sie den nicht angeben`streamARN`, müssen Sie den angeben`streamName`.
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_dataplane_GetMedia_RequestSyntax) **
Der Name des Kinesis-Videostreams, von dem Sie den Medieninhalt abrufen möchten. Wenn Sie den nicht angeben`streamName`, müssen Sie den `streamARN` angeben.
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
## Antwortsyntax
```
HTTP/1.1 200
Content-Type: ContentType
Payload
```
## Antwortelemente
Wenn die Aktion erfolgreich ist, sendet der Service eine HTTP 200-Antwort zurück.
Die Antwort gibt die folgenden HTTP-Header zurück.
** [ContentType](#API_dataplane_GetMedia_ResponseSyntax) **
Der Inhaltstyp des angeforderten Mediums.
Längenbeschränkungen: Minimale Länge beträgt 1 Zeichen. Maximale Länge beträgt 128 Zeichen.
Pattern: `^[a-zA-Z0-9_\.\-]+$`
Die Antwort gibt folgendes als HTTP-Hauptteil zurück.
** [Payload](#API_dataplane_GetMedia_ResponseSyntax) **
Die Payload, die Kinesis Video Streams zurückgibt, ist eine Sequenz von Chunks aus dem angegebenen Stream. Weitere Informationen zu den Chunks finden Sie unter. [PutMedia](https://docs.aws.amazon.com/kinesisvideostreams/latest/dg/API_dataplane_PutMedia.html) Die Chunks, die Kinesis Video Streams im `GetMedia` Aufruf zurückgibt, enthalten auch die folgenden zusätzlichen Matroska-Tags (MKV):
+ AWS\$1KINESISVIDEO\$1CONTINUATION\$1TOKEN (UTF-8-Zeichenfolge) — Falls Ihr `GetMedia` Anruf beendet wird, können Sie dieses Fortsetzungstoken in Ihrer nächsten Anfrage verwenden, um den nächsten Abschnitt abzurufen, in dem die letzte Anfrage beendet wurde.
+ AWS\$1KINESISVIDEO\$1MILLIS\$1BEHIND\$1NOW (UTF-8-Zeichenfolge) — Client-Anwendungen können diesen Tag-Wert verwenden, um zu ermitteln, wie weit der in der Antwort zurückgegebene Chunk vom letzten Chunk im Stream zurückliegt.
+ AWS\$1KINESISVIDEO\$1FRAGMENT\$1NUMBER - Die im Chunk zurückgegebene Fragmentnummer.
+ AWS\$1KINESISVIDEO\$1SERVER\$1TIMESTAMP - Serverzeitstempel des Fragments.
+ AWS\$1KINESISVIDEO\$1PRODUCER\$1TIMESTAMP - Zeitstempel des Produzenten des Fragments.
Die folgenden Tags sind vorhanden, falls ein Fehler auftritt:
+ AWS\$1KINESISVIDEO\$1ERROR\$1CODE - Zeichenkettenbeschreibung eines Fehlers, der GetMedia zum Abbruch geführt hat.
+ AWS\$1KINESISVIDEO\$1ERROR\$1ID: Ganzzahlcode des Fehlers.
Die Fehlercodes lauten wie folgt:
+ 3002 — Fehler beim Schreiben in den Stream
+ 4000 — Das angeforderte Fragment wurde nicht gefunden
+ 4500 — Zugriff für den KMS-Schlüssel des Streams verweigert
+ 4501 — Der KMS-Schlüssel des Streams ist deaktiviert
+ 4502 — Validierungsfehler beim KMS-Schlüssel des Streams
+ 4503 — Der im Stream angegebene KMS-Schlüssel ist nicht verfügbar
+ 4504 — Ungültige Verwendung des im Stream angegebenen KMS-Schlüssels
+ 4505 — Ungültiger Status des im Stream angegebenen KMS-Schlüssels
+ 4506 — Der im Stream angegebene KMS-Schlüssel konnte nicht gefunden werden
+ 5000 — Interner Fehler
## Fehler
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 das Limit der erlaubten Client-Aufrufe überschritten haben. Versuchen Sie später, den Anruf zu tätigen.
HTTP-Statuscode: 400
** ConnectionLimitExceededException **
Kinesis Video Streams hat die Anfrage gedrosselt, weil Sie das Limit der zulässigen Client-Verbindungen überschritten haben.
HTTP-Statuscode: 400
** InvalidArgumentException **
Der Wert für diesen Eingabeparameter ist ungültig.
HTTP-Statuscode: 400
** InvalidEndpointException **
Der Aufrufer hat einen falschen Endpunkt verwendet, um Daten in einen Stream zu schreiben. Bei Empfang einer solchen Ausnahme muss der Benutzer `GetDataEndpoint` mit `APIName` set to aufrufen `PUT_MEDIA` und den Endpunkt aus der Antwort verwenden, um den nächsten `PutMedia` Aufruf aufzurufen.
HTTP-Statuscode: 400
** NotAuthorizedException **
Der Aufrufer ist nicht autorisiert, eine Operation mit dem angegebenen Stream auszuführen, oder das Token ist abgelaufen.
HTTP-Statuscode: 401
** ResourceNotFoundException **
Statuscode: 404, Der Stream mit dem angegebenen Namen existiert nicht.
HTTP-Statuscode: 404
## Weitere Informationen finden Sie unter:
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-data-2017-09-30/GetMedia)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/kinesis-video-data-2017-09-30/GetMedia)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/kinesis-video-data-2017-09-30/GetMedia)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/kinesis-video-data-2017-09-30/GetMedia)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/kinesis-video-data-2017-09-30/GetMedia)
+ [AWS SDK für JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/kinesis-video-data-2017-09-30/GetMedia)
+ [AWS SDK für Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/kinesis-video-data-2017-09-30/GetMedia)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/kinesis-video-data-2017-09-30/GetMedia)
+ [AWS SDK für Python](https://docs.aws.amazon.com/goto/boto3/kinesis-video-data-2017-09-30/GetMedia)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/kinesis-video-data-2017-09-30/GetMedia)
# PutMedia
Verwenden Sie diese API, um Mediendaten an einen Kinesis-Videostream zu senden.
**Anmerkung**
Sie müssen zuerst die `GetDataEndpoint` API aufrufen, um einen Endpunkt zu erhalten. Senden Sie dann die `PutMedia` Anfragen mit dem Parameter [--endpoint-url an diesen Endpunkt](https://docs.aws.amazon.com/cli/latest/reference/).
In der Anfrage verwenden Sie die HTTP-Header, um Parameterinformationen bereitzustellen, z. B. Streamname, Zeitstempel und ob der Zeitstempelwert absolut oder relativ zu dem Zeitpunkt ist, zu dem der Producer mit der Aufnahme begonnen hat. Sie verwenden den Anfragetext, um die Mediendaten zu senden. Kinesis Video Streams unterstützt nur das Matroska-Containerformat (MKV) für das Senden von Mediendaten über diese API.
Sie haben die folgenden Optionen für das Senden von Daten mit dieser API:
+ Mediendaten in Echtzeit senden: Eine Sicherheitskamera kann beispielsweise Bilder in Echtzeit senden, während sie sie generiert. Dieser Ansatz minimiert die Latenz zwischen der Videoaufnahme und den über das Kabel gesendeten Daten. Dies wird als kontinuierlicher Produzent bezeichnet. In diesem Fall kann eine Verbraucheranwendung den Stream in Echtzeit oder bei Bedarf lesen.
+ Mediendaten offline (stapelweise) senden: Eine Körperkamera kann beispielsweise stundenlang Videos aufnehmen und auf dem Gerät speichern. Später, wenn Sie die Kamera an den Docking-Anschluss anschließen, kann die Kamera eine `PutMedia` Sitzung starten, um Daten an einen Kinesis-Videostream zu senden. In diesem Szenario ist Latenz kein Problem.
Beachten Sie bei der Verwendung dieser API die folgenden Überlegungen:
+ Sie müssen entweder `streamName` oder `streamARN` angeben, aber nicht beides.
+ Um die Medien auf der Konsole oder über HLS abspielen zu können, sollte Track 1 jedes Fragments H.264-kodiertes Video enthalten, die CodeCid in den Fragment-Metadaten sollte „V\$1MPEG/ISO/AVC“ lauten und die Fragment-Metadaten sollten private H.264-Codec-Daten im AVCC-Format enthalten. Optional sollte Track 2 jedes Fragments AAC-codiertes Audio enthalten, die CodeCid in den Fragment-Metadaten sollte „A\$1AAC“ lauten und die Fragment-Metadaten sollten private AAC-Codec-Daten enthalten.
+ Die `PutMedia` API ist so konzipiert, dass sie als Streaming-API über eine lang andauernde Verbindung funktioniert. Sie ist nicht für die herkömmliche Verwendung vorgesehen, RESTful bei der für jedes Fragment eine neue HTTP-Verbindung hergestellt und geschlossen wird. Verwenden Sie bei Verwendung der `PutMedia` API die HTTP-Chunked-Transfercodierung, um Fragmente kontinuierlich über eine persistente Verbindung zu senden.
+ Für jedes in einer `PutMedia` Sitzung empfangene Fragment sendet Kinesis Video Streams eine oder mehrere Bestätigungen. Mögliche Überlegungen zum clientseitigen Netzwerk können dazu führen, dass Sie nicht alle diese Bestätigungen erhalten, sobald sie generiert werden.
**Anmerkung**
Wird `PutMedia` als Streaming-Verbindung mit langer Laufzeit verwendet, um mehrere Fragmente in einer einzigen persistenten Verbindung zu senden. Wenn Sie versuchen, mehrere Verbindungen gleichzeitig `PutMedia` herzustellen, drosselt Kinesis Video Streams die letzten Verbindungen mit einem Fehler. `ConnectionLimitExceededException`
Bei der Verwendung der API gelten die folgenden Beschränkungen: `PutMedia`
+ Ein Client kann `PutMedia` bis zu fünf Mal pro Sekunde pro Stream aufrufen.
+ Ein Client kann bis zu fünf Fragmente pro Sekunde pro Stream senden.
+ Kinesis Video Streams liest Mediendaten mit einer Geschwindigkeit von bis zu 12,5 MB/Sekunde oder 100 Mbit/s während einer Sitzung. `PutMedia`
Beachten Sie die folgenden Einschränkungen. In diesen Fällen sendet Kinesis Video Streams die Fehlerbestätigung in der Antwort.
+ Fragmente mit Zeitcodes, die den maximal zulässigen Grenzwert überschreiten, und die mehr als 50 MB an Daten enthalten, sind nicht zulässig.
+ Fragmente, die mehr als drei Spuren enthalten, sind nicht zulässig. Jeder Frame in jedem Fragment muss dieselbe Spurnummer haben wie eine der im Fragment-Header definierten Spuren. Darüber hinaus muss jedes Fragment mindestens einen Frame für jede im Fragment-Header definierte Spur enthalten.
+ Jedes Fragment muss mindestens einen Frame für jede in den Fragment-Metadaten definierte Spur enthalten.
+ Der früheste Frame-Zeitstempel in einem Fragment muss nach dem letzten Frame-Zeitstempel im vorherigen Fragment liegen.
+ Ein MKV-Stream, der mehr als ein MKV-Segment enthält oder unzulässige MKV-Elemente (wie`track*`) enthält, führt ebenfalls zur Fehlerbestätigung.
Kinesis Video Streams speichert jedes eingehende Fragment und die zugehörigen Metadaten in einem sogenannten „Chunk“. Die Fragment-Metadaten umfassen Folgendes:
+ Die MKV-Header, die zu Beginn der Anfrage bereitgestellt wurden `PutMedia`
+ Die folgenden Kinesis Video Streams-spezifischen Metadaten für das Fragment:
+ `server_timestamp`- Zeitstempel, zu dem Kinesis Video Streams mit dem Empfang des Fragments begonnen hat.
+ `producer_timestamp`- Zeitstempel, wann der Produzent mit der Aufnahme des Fragments begonnen hat. Kinesis Video Streams verwendet drei in der Anfrage empfangene Informationen, um diesen Wert zu berechnen.
+ Der Timecode-Wert des Fragments, der zusammen mit dem Fragment im Hauptteil der Anfrage empfangen wurde.
+ Zwei Anforderungsheader: `producerStartTimestamp` (als der Produzent mit der Aufnahme begonnen hat) und `fragmentTimeCodeType` (ob der Fragment-Timecode in der Payload absolut oder relativ ist).
Kinesis Video Streams berechnet dann den `producer_timestamp` für das Fragment wie folgt:
Wenn es relativ `fragmentTimeCodeType` ist, dann
`producer_timestamp`= `producerStartTimeStamp` \$1 Fragment-Timecode
Wenn `fragmentTimeCodeType` es absolut ist, dann
`producer_timestamp`= Fragment-Timecode (in Millisekunden umgewandelt)
+ Von Kinesis Video Streams zugewiesene eindeutige Fragmentnummer.
**Anmerkung**
Wenn Sie die `GetMedia` Anfrage stellen, gibt Kinesis Video Streams einen Stream dieser Chunks zurück. Der Client kann die Metadaten nach Bedarf verarbeiten.
**Anmerkung**
Dieser Vorgang ist nur für das AWS SDK for Java verfügbar. In AWS SDKs anderen Sprachen wird er nicht unterstützt.
**Anmerkung**
Kinesis Video Streams analysiert und validiert die privaten Codec-Daten während der Aufnahme und Archivierung über die API nicht. PutMedia KVS extrahiert und validiert die erforderlichen Informationen aus den privaten Codec-Daten für MPEG-TS und Fragment-Paketierung, wenn der Stream über die HLS abgerufen wird. MP4 APIs
**Anmerkung**
Wenn nach dem Aufrufen einer Kinesis Video Streams Streams-Medien-API ein Fehler ausgelöst wird, enthält dieser zusätzlich zum HTTP-Statuscode und dem Antworttext die folgenden Informationen:
`x-amz-ErrorType`HTTP-Header — enthält zusätzlich zu dem, was der HTTP-Statuscode bietet, einen spezifischeren Fehlertyp.
`x-amz-RequestId`HTTP-Header — Wenn Sie ein Problem melden möchten AWS, kann das Support-Team das Problem anhand der Anforderungs-ID besser diagnostizieren.
Sowohl der HTTP-Statuscode als auch der ErrorType Header können verwendet werden, um programmatische Entscheidungen darüber zu treffen, ob und unter welchen Bedingungen Fehler wiederholt werden können. Außerdem können Informationen darüber bereitgestellt werden, welche Maßnahmen der Client-Programmierer möglicherweise ergreifen muss, um es erneut erfolgreich zu versuchen.
[Weitere Informationen finden Sie im Abschnitt **Fehler** am Ende dieses Themas sowie unter Häufige Fehler.](https://docs.aws.amazon.com/kinesisvideostreams/latest/dg/CommonErrors.html)
## Anforderungssyntax
```
POST /putMedia HTTP/1.1
x-amzn-stream-name: StreamName
x-amzn-stream-arn: StreamARN
x-amzn-fragment-timecode-type: FragmentTimecodeType
x-amzn-producer-start-timestamp: ProducerStartTimestamp
Payload
```
## URI-Anfrageparameter
Die Anforderung verwendet die folgenden URI-Parameter.
** [FragmentTimecodeType](#API_dataplane_PutMedia_RequestSyntax) **
Sie übergeben diesen Wert als `x-amzn-fragment-timecode-type` HTTP-Header.
Gibt an, ob die Timecodes in den Fragmenten (Payload, HTTP-Anforderungstext) absolut oder relativ zu sind. `producerStartTimestamp` Kinesis Video Streams verwendet diese Informationen, um die `producer_timestamp` für das in der Anfrage empfangene Fragment zu berechnen, wie in der API-Übersicht beschrieben.
Zulässige Werte: `ABSOLUTE | RELATIVE`
Erforderlich: Ja
** [ProducerStartTimestamp](#API_dataplane_PutMedia_RequestSyntax) **
Sie übergeben diesen Wert als `x-amzn-producer-start-timestamp` HTTP-Header.
Dies ist der Producer-Zeitstempel, zu dem der Producer mit der Aufnahme der Medien begonnen hat (nicht der Zeitstempel der spezifischen Fragmente in der Anfrage).
** [StreamARN](#API_dataplane_PutMedia_RequestSyntax) **
Sie übergeben diesen Wert als `x-amzn-stream-arn` HTTP-Header.
Amazon-Ressourcenname (ARN) des Kinesis-Videostreams, in den Sie den Medieninhalt schreiben möchten. Wenn Sie den nicht angeben`streamARN`, müssen Sie den `streamName` angeben.
Längenbeschränkungen: Minimale Länge beträgt 1 Zeichen. 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]+`
** [StreamName](#API_dataplane_PutMedia_RequestSyntax) **
Sie übergeben diesen Wert als `x-amzn-stream-name` HTTP-Header.
Name des Kinesis-Videostreams, in den Sie den Medieninhalt schreiben möchten. Wenn Sie den nicht angeben`streamName`, müssen Sie den `streamARN` angeben.
Längenbeschränkungen: Minimale Länge beträgt 1 Zeichen. Maximale Länge beträgt 256 Zeichen.
Pattern: `[a-zA-Z0-9_.-]+`
## Anforderungstext
Die Anfrage akzeptiert die folgenden Binärdaten.
** [Payload](#API_dataplane_PutMedia_RequestSyntax) **
Der Medieninhalt, der in den Kinesis-Videostream geschrieben werden soll. In der aktuellen Implementierung unterstützt Kinesis Video Streams nur das Matroska (MKV) -Containerformat mit einem einzigen MKV-Segment. Ein Segment kann einen oder mehrere Cluster enthalten.
Jeder MKV-Cluster ist einem Kinesis-Videostream-Fragment zugeordnet. Die von Ihnen gewählte Clusterdauer wird zur Fragmentdauer.
## Antwortsyntax
```
HTTP/1.1 200
Payload
```
## Antwortelemente
Wenn die Aktion erfolgreich ist, sendet der Service eine HTTP 200-Antwort zurück.
Die Antwort gibt folgendes als HTTP-Hauptteil zurück.
** [Payload](#API_dataplane_PutMedia_ResponseSyntax) **
Nachdem Kinesis Video Streams erfolgreich eine `PutMedia` Anfrage empfangen hat, validiert der Dienst die Anforderungsheader. Der Dienst beginnt dann mit dem Lesen der Payload und sendet zunächst eine HTTP 200-Antwort.
Der Dienst gibt dann einen Stream zurück, der eine Reihe von JSON-Objekten (`Acknowledgement`Objekten) enthält, die durch Zeilenumbrüche getrennt sind. Die Bestätigungen werden auf derselben Verbindung empfangen, über die die Mediendaten gesendet werden. Für eine Anfrage kann es viele Bestätigungen geben. `PutMedia` Jedes `Acknowledgement` besteht aus den folgenden Schlüssel-Wert-Paaren:
+ `AckEventType`- Ereignistyp, für den die Bestätigung steht.
+ **Pufferung:** Kinesis Video Streams hat begonnen, das Fragment zu empfangen. Kinesis Video Streams sendet die erste Buffering-Bestätigung, wenn das erste Byte von Fragmentdaten empfangen wird.
+ **Empfangen:** Kinesis Video Streams hat das gesamte Fragment empfangen. Wenn Sie den Stream nicht so konfiguriert haben, dass die Daten dauerhaft gespeichert werden, kann der Producer die Pufferung des Fragments beenden, sobald er diese Bestätigung erhält.
+ **Persistent:** Kinesis Video Streams hat das Fragment beibehalten (z. B. in Amazon S3). Sie erhalten diese Bestätigung, wenn Sie den Stream so konfiguriert haben, dass die Daten dauerhaft gespeichert werden. Nachdem Sie diese Bestätigung erhalten haben, kann der Producer die Pufferung des Fragments beenden.
+ **Fehler: Bei** Kinesis Video Streams ist bei der Verarbeitung des Fragments ein Fehler aufgetreten. Sie können den Fehlercode überprüfen und die nächste Vorgehensweise festlegen.
+ **Inaktiv:** Die `PutMedia` Sitzung ist im Gange. Kinesis Video Streams empfängt derzeit jedoch keine Daten. Kinesis Video Streams sendet diese Bestätigung in regelmäßigen Abständen für bis zu 30 Sekunden nach den letzten empfangenen Daten. Wenn innerhalb der 30 Sekunden keine Daten empfangen werden, schließt Kinesis Video Streams die Anfrage.
**Anmerkung**
Anhand dieser Bestätigung kann ein Produzent feststellen, ob die `PutMedia` Verbindung aktiv ist, auch wenn keine Daten gesendet werden.
+ `FragmentTimecode`— Fragment-Timecode, für den die Bestätigung gesendet wird.
**Das Element kann fehlen, wenn es im Leerlauf ist`AckEventType`.**
+ `FragmentNumber`- Von Kinesis Video Streams generierte Fragmentnummer, für die die Bestätigung gesendet wird.
+ `ErrorId`und `ErrorCode` — Falls ja`Error`, enthält dieses Feld den `AckEventType` entsprechenden Fehlercode. Im Folgenden finden Sie eine Liste der Fehler IDs und der entsprechenden Fehlercodes und Fehlermeldungen:
+ 4000 - STREAM\$1READ\$1ERROR - Fehler beim Lesen des Datenstroms.
+ 4001 - MAX\$1FRAGMENT\$1SIZE\$1REACHED — Die Fragmentgröße liegt über dem zulässigen Höchstwert von 50 MB.
+ 4002 - MAX\$1FRAGMENT\$1DURATION\$1REACHED — Die Fragmentdauer liegt über dem maximal zulässigen Grenzwert.
+ 4003 - MAX\$1CONNECTION\$1DURATION\$1REACHED — Die Verbindungsdauer ist größer als der maximal zulässige Schwellenwert.
+ 4004 - FRAGMENT\$1TIMECODE\$1LESSER\$1THAN\$1PREVIOUS — Der Fragment-Timecode ist kleiner als der Timecode des vorherigen Timecodes (innerhalb eines Anrufs können Sie Fragmente nicht in der falschen Reihenfolge senden). `PutMedia`
+ 4005 - MORE\$1THAN\$1ALLOWED\$1TRACKS\$1FOUND - In MKV wurde mehr als ein Titel gefunden. (veraltet)
+ 4006 - INVALID\$1MKV\$1DATA - Der Eingabestream konnte nicht als gültiges MKV-Format analysiert werden.
+ 4007 - INVALID\$1PRODUCER\$1TIMESTAMP — Ungültiger Producer-Zeitstempel.
+ 4008 - STREAM\$1NOT\$1ACTIVE - Stream existiert nicht mehr (gelöscht).
+ 4009 - FRAGMENT\$1METADATA\$1LIMIT\$1REACHED — Das Limit für Fragment-Metadaten wurde erreicht. [Weitere Informationen finden Sie im Abschnitt Grenzwerte im Entwicklerhandbuch.](https://docs.aws.amazon.com/kinesisvideostreams/latest/dg/limits.html)
+ 4010 - TRACK\$1NUMBER\$1MISMATCH - Die Titelnummer in einem MKV-Frame stimmte nicht mit den Titeln im MKV-Header überein.
+ 4011 - FRAMES\$1MISSING\$1FOR\$1TRACK - Das Fragment enthielt keine Frames für mindestens einen der Tracks im MKV-Header.
+ 4012 - INVALID\$1FRAGMENT\$1METADATA - Der Name der Fragment-Metadaten darf nicht mit der Zeichenfolge beginnen. ` AWS_`
+ 4500 - KMS\$1KEY\$1ACCESS\$1DENIED — Der Zugriff auf den angegebenen KMS-Schlüssel des Streams wurde verweigert.
+ 4501 - KMS\$1KEY\$1DISABLED — Der für den Stream angegebene KMS-Schlüssel ist deaktiviert.
+ 4502 - KMS\$1KEY\$1VALIDATION\$1ERROR — Der angegebene KMS-Schlüssel des Streams konnte nicht überprüft werden.
+ 4503 - KMS\$1KEY\$1UNAVAILABLE — Der angegebene KMS-Schlüssel des Streams ist nicht verfügbar.
+ 4504 - KMS\$1KEY\$1INVALID\$1USAGE — Ungültige Verwendung des angegebenen KMS-Schlüssels für den Stream.
+ 4505 - KMS\$1KEY\$1INVALID\$1STATE — Der angegebene KMS-Schlüssel des Streams befindet sich in einem ungültigen Zustand.
+ 4506 - KMS\$1KEY\$1NOT\$1FOUND — Der angegebene KMS-Schlüssel des Streams wurde nicht gefunden.
+ 5000 - INTERNAL\$1ERROR - Interner Dienstfehler.
+ 5001 - ARCHIVAL\$1ERROR - Kinesis Video Streams konnte keine Fragmente im Datenspeicher speichern.
Der Producer sollte beim Senden der Nutzdaten für eine lang andauernde `PutMedia` Anfrage die Antwort zur Bestätigung lesen. Ein Producer kann aufgrund der Pufferung auf einem zwischengeschalteten Proxyserver mehrere Bestätigungen gleichzeitig erhalten. Ein Produzent, der zeitnahe Bestätigungen erhalten möchte, kann in jeder Anfrage weniger Fragmente senden. `PutMedia`
## Fehler
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 das Limit der erlaubten Client-Aufrufe überschritten haben. Versuchen Sie später, den Anruf zu tätigen.
HTTP-Statuscode: 400
** ConnectionLimitExceededException **
Kinesis Video Streams hat die Anfrage gedrosselt, weil Sie das Limit der zulässigen Client-Verbindungen überschritten haben.
HTTP-Statuscode: 400
** InvalidArgumentException **
Der Wert für diesen Eingabeparameter ist ungültig.
HTTP-Statuscode: 400
** InvalidEndpointException **
Der Aufrufer hat einen falschen Endpunkt verwendet, um Daten in einen Stream zu schreiben. Bei Empfang einer solchen Ausnahme muss der Benutzer `GetDataEndpoint` mit `APIName` set to aufrufen `PUT_MEDIA` und den Endpunkt aus der Antwort verwenden, um den nächsten `PutMedia` Aufruf aufzurufen.
HTTP-Statuscode: 400
** NotAuthorizedException **
Der Aufrufer ist nicht autorisiert, eine Operation mit dem angegebenen Stream auszuführen, oder das Token ist abgelaufen.
HTTP-Statuscode: 401
** ResourceNotFoundException **
Statuscode: 404, Der Stream mit dem angegebenen Namen existiert nicht.
HTTP-Statuscode: 404
## Beispiele
### Format der Bestätigung
Das Format der Bestätigung lautet wie folgt:
```
{
Acknowledgement : {
"EventType": enum
"FragmentTimecode": Long,
"FragmentNumber": Long,
"ErrorId" : String
}
}
```
## Weitere Informationen finden Sie unter:
Weitere Informationen zur Verwendung dieser API in einer der sprachspezifischen Sprachen finden Sie im Folgenden AWS SDKs:
+ [AWS Befehlszeilenschnittstelle V2](https://docs.aws.amazon.com/goto/cli2/kinesis-video-data-2017-09-30/PutMedia)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/kinesis-video-data-2017-09-30/PutMedia)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/kinesis-video-data-2017-09-30/PutMedia)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/kinesis-video-data-2017-09-30/PutMedia)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/kinesis-video-data-2017-09-30/PutMedia)
+ [AWS SDK für JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/kinesis-video-data-2017-09-30/PutMedia)
+ [AWS SDK für Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/kinesis-video-data-2017-09-30/PutMedia)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/kinesis-video-data-2017-09-30/PutMedia)
+ [AWS SDK für Python](https://docs.aws.amazon.com/goto/boto3/kinesis-video-data-2017-09-30/PutMedia)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/kinesis-video-data-2017-09-30/PutMedia)
# Amazon Kinesis Video Streams — Archivierte Medien
Die folgenden Aktionen werden von Amazon Kinesis Video Streams Archived Media unterstützt:
+ [GetClip](API_reader_GetClip.md)
+ [GetDASHStreamingSessionURL](API_reader_GetDASHStreamingSessionURL.md)
+ [GetHLSStreamingSessionURL](API_reader_GetHLSStreamingSessionURL.md)
+ [GetImages](API_reader_GetImages.md)
+ [GetMediaForFragmentList](API_reader_GetMediaForFragmentList.md)
+ [ListFragments](API_reader_ListFragments.md)
# GetClip
Lädt eine MP4 Datei (Clip) mit den archivierten On-Demand-Medien aus dem angegebenen Videostream über den angegebenen Zeitraum herunter.
StreamName Sowohl der Parameter als auch der StreamArn-Parameter sind optional, aber Sie müssen entweder den StreamName oder den StreamArn angeben, wenn Sie diesen API-Vorgang aufrufen.
**Anmerkung**
Sie müssen zuerst die `GetDataEndpoint` API aufrufen, um einen Endpunkt zu erhalten. Senden Sie dann die `GetClip` Anfragen mit dem Parameter [--endpoint-url an diesen Endpunkt](https://docs.aws.amazon.com/cli/latest/reference/).
Für einen Amazon Kinesis Kinesis-Videostream gelten die folgenden Anforderungen für die Bereitstellung von Daten über MP4:
+ [Anforderungen an den Titel für die Videowiedergabe](https://docs.aws.amazon.com/kinesisvideostreams/latest/dg/video-playback-requirements.html).
+ Der Datenerhaltzeitraum muss größer als 0 sein.
+ Die Videospur jedes Fragments muss private Codec-Daten in Advanced Video Coding (AVC) für H.264 und HEVC für H.265 enthalten. Weitere Informationen finden Sie in der [MPEG-4-Spezifikation ISO/IEC ](https://www.iso.org/standard/55980.html) 14496-15. Informationen zur Adaptierung von Stream-Daten für ein bestimmtes Format finden Sie unter [NAL Adaptation Flags](https://docs.aws.amazon.com/kinesisvideostreams/latest/dg/producer-reference-nal.html).
+ [Die Audiospur (falls vorhanden) jedes Fragments muss private Codec-Daten im [AAC-Format (AAC-Spezifikation ISO/IEC ](https://www.iso.org/standard/43345.html) 13818-7) oder im MS Wave-Format enthalten.](https://www.mmsp.ece.mcgill.ca/Documents/AudioFormats/WAVE/WAVE.html)
Sie können die Menge der ausgehenden Daten überwachen, indem Sie die `GetClip.OutgoingBytes` CloudWatch Amazon-Metrik überwachen. Informationen CloudWatch zur Überwachung von Kinesis Video Streams finden Sie unter [Kinesis Video Streams überwachen](https://docs.aws.amazon.com/kinesisvideostreams/latest/dg/monitoring.html). Preisinformationen finden Sie unter [Amazon Kinesis Video Streams — Preise](https://aws.amazon.com/kinesis/video-streams/pricing/) und [AWS Preise](https://aws.amazon.com/pricing/). Für ausgehende AWS Daten fallen Gebühren an.
**Wichtig**
Die in jedem Fragment enthaltenen privaten Codec Data (CPD) enthalten codecspezifische Initialisierungsinformationen wie Bildrate, Auflösung und Kodierungsprofil, die für die korrekte Dekodierung des Fragments erforderlich sind. CPD-Änderungen zwischen den Zielfragmenten des resultierenden Clips werden nicht unterstützt. Die CPD muss auf den abgefragten Medien konsistent bleiben, andernfalls wird ein Fehler zurückgegeben.
**Wichtig**
Änderungen nachverfolgen wird nicht unterstützt. Die Titel müssen in den abgefragten Medien einheitlich sein. Es wird ein Fehler zurückgegeben, wenn die Fragmente im Stream nicht mehr nur Video enthalten, sondern sowohl Audio als auch Video enthalten, oder wenn eine AAC-Audiospur in eine A-Law-Audiospur umgewandelt wird.
## Anforderungssyntax
```
POST /getClip HTTP/1.1
Content-type: application/json
{
"ClipFragmentSelector": {
"FragmentSelectorType": "string",
"TimestampRange": {
"EndTimestamp": number,
"StartTimestamp": number
}
},
"StreamARN": "string",
"StreamName": "string"
}
```
## URI-Anfrageparameter
Die Anforderung verwendet keine URI-Parameter.
## Anforderungstext
Die Anforderung akzeptiert die folgenden Daten im JSON-Format.
** [ClipFragmentSelector](#API_reader_GetClip_RequestSyntax) **
Der Zeitbereich des angeforderten Clips und die Quelle der Zeitstempel.
Typ: [ClipFragmentSelector](API_reader_ClipFragmentSelector.md) Objekt
Erforderlich: Ja
** [StreamARN](#API_reader_GetClip_RequestSyntax) **
Der Amazon-Ressourcenname (ARN) des Streams, für den der Medienclip abgerufen werden soll.
Sie müssen entweder den StreamName oder den StreamArn angeben.
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_GetClip_RequestSyntax) **
Der Name des Streams, für den der Medienclip abgerufen werden soll.
Sie müssen entweder den StreamName oder den StreamArn angeben.
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
## Antwortsyntax
```
HTTP/1.1 200
Content-Type: ContentType
Payload
```
## Antwortelemente
Wenn die Aktion erfolgreich ist, sendet der Service eine HTTP 200-Antwort zurück.
Die Antwort gibt die folgenden HTTP-Header zurück.
** [ContentType](#API_reader_GetClip_ResponseSyntax) **
Der Inhaltstyp der Medien im angeforderten Clip.
Längenbeschränkungen: Minimale Länge beträgt 1 Zeichen. Maximale Länge beträgt 128 Zeichen.
Pattern: `^[a-zA-Z0-9_\.\-]+$`
Die Antwort gibt folgendes als HTTP-Hauptteil zurück.
** [Payload](#API_reader_GetClip_ResponseSyntax) **
Herkömmliche MP4 Datei, die den Medienclip aus dem angegebenen Videostream enthält. Die Ausgabe enthält die ersten 100 MB oder die ersten 200 Fragmente des angegebenen Startzeitstempels. Weitere Informationen finden Sie unter [Kinesis Video Streams Streams-Kontingente](https://docs.aws.amazon.com/kinesisvideostreams/latest/dg/limits.html).
## Fehler
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 bestimmter Parameter überschreitet seine Beschränkungen, wird nicht unterstützt oder kann nicht verwendet werden.
HTTP-Statuscode: 400
** InvalidCodecPrivateDataException **
Die privaten Codec-Daten in mindestens einem der Tracks des Videostreams sind für diesen Vorgang nicht gültig.
HTTP-Statuscode: 400
** InvalidMediaFrameException **
Ein oder mehrere Frames im angeforderten Clip konnten nicht auf der Grundlage des angegebenen Codecs analysiert werden.
HTTP-Statuscode: 400
** MissingCodecPrivateDataException **
In mindestens einem der Spuren des Videostreams wurden keine privaten Codec-Daten gefunden.
HTTP-Statuscode: 400
** NoDataRetentionException **
`GetImages`wurde für einen Stream angefordert, der keine Daten speichert (d. h. den Wert 0 hat`DataRetentionInHours`).
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
** UnsupportedStreamMediaTypeException **
Der Medientyp (z. B. h.264- oder h.265-Video oder AAC- oder G.711-Audio) konnte anhand IDs des Codec der Titel im ersten Fragment für eine Wiedergabesitzung nicht bestimmt werden. Die Codec-ID für Track 1 sollte `V_MPEG/ISO/AVC` und optional die Codec-ID für Track 2 sein. `A_AAC`
HTTP-Statuscode: 400
## Weitere Informationen finden Sie unter:
Weitere Informationen zur Verwendung dieser API in einer der sprachspezifischen Sprachen finden Sie im Folgenden AWS SDKs:
+ [AWS Befehlszeilenschnittstelle V2](https://docs.aws.amazon.com/goto/cli2/kinesis-video-reader-data-2017-09-30/GetClip)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/kinesis-video-reader-data-2017-09-30/GetClip)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/kinesis-video-reader-data-2017-09-30/GetClip)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/kinesis-video-reader-data-2017-09-30/GetClip)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/kinesis-video-reader-data-2017-09-30/GetClip)
+ [AWS SDK für JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/kinesis-video-reader-data-2017-09-30/GetClip)
+ [AWS SDK für Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/kinesis-video-reader-data-2017-09-30/GetClip)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/kinesis-video-reader-data-2017-09-30/GetClip)
+ [AWS SDK für Python](https://docs.aws.amazon.com/goto/boto3/kinesis-video-reader-data-2017-09-30/GetClip)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/kinesis-video-reader-data-2017-09-30/GetClip)
# GetDASHStreamingSessionURL
Ruft eine MPEG-URL für dynamisches adaptives Streaming über HTTP (DASH) für den Stream ab. Sie können die URL dann in einem Media Player öffnen, um den Inhalt des Streams anzusehen.
`StreamName`Sowohl der als auch der `StreamARN` Parameter sind optional, aber Sie müssen entweder den `StreamName` oder den angeben, `StreamARN` wenn Sie diesen API-Vorgang aufrufen.
Für einen Amazon Kinesis Kinesis-Videostream gelten die folgenden Anforderungen für die Bereitstellung von Daten über MPEG-DASH:
+ Anforderungen an den Titel für die [Videowiedergabe](https://docs.aws.amazon.com/kinesisvideostreams/latest/dg/video-playback-requirements.html).
+ Der Datenerhaltzeitraum muss größer als 0 sein.
+ Die Videospur jedes Fragments muss private Codec-Daten in Advanced Video Coding (AVC) für H.264 und HEVC für H.265 enthalten. Weitere Informationen finden Sie in der [MPEG-4-Spezifikation ISO/IEC ](https://www.iso.org/standard/55980.html) 14496-15. Informationen zur Adaptierung von Stream-Daten für ein bestimmtes Format finden Sie unter [NAL Adaptation Flags](https://docs.aws.amazon.com/kinesisvideostreams/latest/dg/producer-reference-nal.html).
+ [Die Audiospur (falls vorhanden) jedes Fragments muss private Codec-Daten im [AAC-Format (AAC-Spezifikation ISO/IEC ](https://www.iso.org/standard/43345.html) 13818-7) oder im MS Wave-Format enthalten.](https://www.mmsp.ece.mcgill.ca/Documents/AudioFormats/WAVE/WAVE.html)
Das folgende Verfahren zeigt, wie MPEG-DASH mit Kinesis Video Streams verwendet wird:
1. Rufen Sie die `GetDataEndpoint` API auf, um einen Endpunkt zu erhalten. Senden Sie dann die `GetDASHStreamingSessionURL` Anfragen mit dem Parameter [--endpoint-url an diesen Endpunkt](https://docs.aws.amazon.com/cli/latest/reference/).
1. Rufen Sie die MPEG-DASH-URL ab mit. `GetDASHStreamingSessionURL` Kinesis Video Streams erstellt eine MPEG-DASH-Streaming-Sitzung, die für den Zugriff auf Inhalte in einem Stream mithilfe des MPEG-DASH-Protokolls verwendet wird. `GetDASHStreamingSessionURL`gibt eine authentifizierte URL (die ein verschlüsseltes Sitzungstoken enthält) für das *MPEG-DASH-Manifest* der Sitzung zurück (die Root-Ressource, die für das Streaming mit MPEG-DASH benötigt wird).
**Anmerkung**
Teilen oder speichern Sie dieses Token nicht dort, wo eine nicht autorisierte Entität darauf zugreifen kann. Das Token ermöglicht den Zugriff auf den Inhalt des Streams. Schützen Sie das Token mit denselben Maßnahmen, die Sie für Ihre AWS Anmeldeinformationen verwenden.
Die Medien, die über das Manifest verfügbar gemacht werden, bestehen nur aus dem angeforderten Stream, Zeitbereich und Format. Es werden keine anderen Mediendaten (wie Frames außerhalb des angeforderten Fensters oder alternative Bitraten) zur Verfügung gestellt.
1. Geben Sie die URL (mit dem verschlüsselten Sitzungstoken) für das MPEG-DASH-Manifest an einen Media Player weiter, der das MPEG-DASH-Protokoll unterstützt. Kinesis Video Streams stellt das Initialisierungsfragment und die Medienfragmente über die Manifest-URL zur Verfügung. Das Initialisierungsfragment enthält die privaten Codec-Daten für den Stream und andere Daten, die zur Einrichtung des Video- oder Audiodecoders und Renderers benötigt werden. Die Medienfragmente enthalten kodierte Videoframes oder kodierte Audiobeispiele.
1. Der Media Player empfängt die authentifizierte URL und fordert Stream-Metadaten und Mediendaten normal an. Wenn der Media Player Daten anfordert, ruft er die folgenden Aktionen auf:
+ **AbrufenDASHManifest:** Ruft ein MPEG DASH-Manifest ab, das die Metadaten für die Medien enthält, die Sie wiedergeben möchten.
+ **Abrufen MP4InitFragment:** Ruft das MP4 Initialisierungsfragment ab. Der Media Player lädt normalerweise das Initialisierungsfragment, bevor er Medienfragmente lädt. Dieses Fragment enthält die Atome `fytp` "" und "`moov`" sowie die untergeordneten MP4 Atome, die zur Initialisierung des Media Player-Decoders benötigt werden.
Das Initialisierungsfragment entspricht keinem Fragment in einem Kinesis-Videostream. Es enthält nur die privaten Codec-Daten für den Stream und den jeweiligen Titel, die der Media Player benötigt, um die Medienframes zu dekodieren.
+ **Abrufen MP4MediaFragment:** Ruft MP4 Medienfragmente ab. Diese Fragmente enthalten die MP4 Atome `moof` "" und "`mdat`" und ihre untergeordneten Atome, die die Medienframes und ihre Zeitstempel des codierten Fragments enthalten.
**Wichtig**
Die in jedem Fragment enthaltenen privaten Codec Data (CPD) enthalten Codec-spezifische Initialisierungsinformationen wie Bildrate, Auflösung und Kodierungsprofil, die für die korrekte Dekodierung des Fragments erforderlich sind. CPD-Änderungen werden während einer Streaming-Sitzung nicht unterstützt. Die CPD muss in den abgefragten Medien konsistent bleiben.
**Wichtig**
Änderungen nachverfolgen wird nicht unterstützt. Die Titel müssen in den abgefragten Medien einheitlich sein. Das Streaming schlägt fehl, wenn die Fragmente im Stream nicht mehr nur Video enthalten, sondern sowohl Audio als auch Video enthalten, oder wenn eine AAC-Audiospur in eine A-Law-Audiospur umgewandelt wird.
Mit dieser Aktion abgerufene Daten sind abrechnungsfähig. Einzelheiten finden Sie unter [Preise](https://aws.amazon.com/kinesis/video-streams/pricing/).
**Anmerkung**
Einschränkungen, die für MPEG-DASH-Sitzungen gelten, finden Sie unter [Kinesis](https://docs.aws.amazon.com/kinesisvideostreams/latest/dg/limits.html) Video Streams Streams-Kontingente.
Sie können die Datenmenge, die der Media Player verbraucht, überwachen, indem Sie die `GetMP4MediaFragment.OutgoingBytes` CloudWatch Amazon-Metrik überwachen. Informationen CloudWatch zur Überwachung von Kinesis Video Streams finden Sie unter [Kinesis Video Streams überwachen](https://docs.aws.amazon.com/kinesisvideostreams/latest/dg/monitoring.html). Preisinformationen finden Sie unter [Amazon Kinesis Video Streams — Preise](https://aws.amazon.com/kinesis/video-streams/pricing/) und [AWS Preise](https://aws.amazon.com/pricing/). Sowohl für HLS-Sitzungen als auch für ausgehende AWS Daten fallen Gebühren an.
Weitere Informationen zu HLS finden Sie unter [HTTP Live Streaming](https://developer.apple.com/streaming/) auf der [Apple Developer-Website](https://developer.apple.com).
**Wichtig**
Wenn nach dem Aufrufen einer Kinesis Video Streams Streams-API für archivierte Medien ein Fehler ausgelöst wird, enthält dieser zusätzlich zum HTTP-Statuscode und dem Antworttext die folgenden Informationen:
`x-amz-ErrorType`HTTP-Header — enthält zusätzlich zu den Angaben des HTTP-Statuscodes einen spezifischeren Fehlertyp.
`x-amz-RequestId`HTTP-Header — Wenn Sie AWS dem Support-Team ein Problem melden möchten, können Sie das Problem anhand der Anforderungs-ID besser diagnostizieren.
Sowohl der HTTP-Statuscode als auch der ErrorType Header können verwendet werden, um programmatische Entscheidungen darüber zu treffen, ob und unter welchen Bedingungen Fehler wiederholt werden können, sowie Informationen darüber bereitzustellen, welche Maßnahmen der Client-Programmierer möglicherweise ergreifen muss, um es erneut erfolgreich zu versuchen.
[Weitere Informationen finden Sie im Abschnitt **Fehler** am Ende dieses Themas sowie unter Häufige Fehler.](https://docs.aws.amazon.com/kinesisvideostreams/latest/dg/CommonErrors.html)
## Anforderungssyntax
```
POST /getDASHStreamingSessionURL HTTP/1.1
Content-type: application/json
{
"DASHFragmentSelector": {
"FragmentSelectorType": "string",
"TimestampRange": {
"EndTimestamp": number,
"StartTimestamp": number
}
},
"DisplayFragmentNumber": "string",
"DisplayFragmentTimestamp": "string",
"Expires": number,
"MaxManifestFragmentResults": number,
"PlaybackMode": "string",
"StreamARN": "string",
"StreamName": "string"
}
```
## URI-Anfrageparameter
Die Anforderung verwendet keine URI-Parameter.
## Anforderungstext
Die Anforderung akzeptiert die folgenden Daten im JSON-Format.
** [DASHFragmentSelector](#API_reader_GetDASHStreamingSessionURL_RequestSyntax) **
Der Zeitbereich des angeforderten Fragments und die Quelle der Zeitstempel.
Dieser Parameter ist erforderlich, wenn er `ON_DEMAND` oder `PlaybackMode` `LIVE_REPLAY` ist. Dieser Parameter ist optional, falls PlaybackMode ja ```LIVE`. Wenn `PlaybackMode` ja`LIVE`, `FragmentSelectorType` kann er gesetzt werden, `TimestampRange` sollte aber nicht gesetzt werden. Wenn `PlaybackMode` ist `ON_DEMAND` oder`LIVE_REPLAY`, `TimestampRange` müssen beide `FragmentSelectorType` gesetzt werden.
Typ: [DASHFragmentSelector](API_reader_DASHFragmentSelector.md) Objekt
Erforderlich: Nein
** [DisplayFragmentNumber](#API_reader_GetDASHStreamingSessionURL_RequestSyntax) **
Fragmente werden in der Manifestdatei anhand ihrer Sequenznummer in der Sitzung identifiziert. Wenn auf gesetzt DisplayFragmentNumber ist`ALWAYS`, wird die Kinesis Video Streams Streams-Fragmentnummer zu jedem S-Element in der Manifestdatei mit dem Attributnamen „kvs:fn“ hinzugefügt. Diese Fragmentnummern können für die Protokollierung oder für die Verwendung mit anderen Fragmenten APIs (z. B. `GetMedia` und) verwendet werden. `GetMediaForFragmentList` Um dieses benutzerdefinierte Attribut nutzen zu können, ist ein benutzerdefinierter MPEG-DASH Media Player erforderlich.
Der Standardwert ist `NEVER`.
Typ: Zeichenfolge
Zulässige Werte: `ALWAYS | NEVER`
Erforderlich: Nein
** [DisplayFragmentTimestamp](#API_reader_GetDASHStreamingSessionURL_RequestSyntax) **
Gemäß der MPEG-DASH-Spezifikation kann die Uhrzeit der Wanduhr von Fragmenten in der Manifestdatei anhand von Attributen im Manifest selbst abgeleitet werden. In der Regel können MPEG-DASH-kompatible Mediaplayer Lücken in der Medien-Timeline jedoch nicht richtig behandeln. Kinesis Video Streams passt die Medien-Timeline in der Manifestdatei an, um die Wiedergabe von Medien mit Unterbrechungen zu ermöglichen. Daher kann die aus der Manifestdatei abgeleitete Uhrzeit der Wanduhr ungenau sein. Wenn auf gesetzt DisplayFragmentTimestamp ist`ALWAYS`, wird jedem S-Element in der Manifestdatei mit dem Attributnamen „kvs:ts“ der genaue Fragment-Zeitstempel hinzugefügt. Um dieses benutzerdefinierte Attribut nutzen zu können, ist ein benutzerdefinierter MPEG-DASH Media Player erforderlich.
Der Standardwert ist `NEVER`. Wenn dies der [DASHFragmentSelector](API_reader_DASHFragmentSelector.md) Fall ist`SERVER_TIMESTAMP`, sind die Zeitstempel die Startzeitstempel des Servers. In ähnlicher Weise werden bei den `PRODUCER_TIMESTAMP` Zeitstempeln die Startzeitstempel des Produzenten verwendet, wenn dies der Fall [DASHFragmentSelector](API_reader_DASHFragmentSelector.md) ist.
Typ: Zeichenfolge
Zulässige Werte: `ALWAYS | NEVER`
Erforderlich: Nein
** [Expires](#API_reader_GetDASHStreamingSessionURL_RequestSyntax) **
Die Zeit in Sekunden, bis die angeforderte Sitzung abläuft. Dieser Wert kann zwischen 300 (5 Minuten) und 43200 (12 Stunden) liegen.
Wenn eine Sitzung abläuft, `GetMP4MediaFragment` können keine neuen Aufrufe für diese Sitzung getätigt werden. `GetDashManifest` `GetMP4InitFragment`
Der Standardwert ist 300 (5 Minuten).
Typ: Ganzzahl
Gültiger Bereich: Mindestwert von 300. Maximalwert 43200.
Erforderlich: Nein
** [MaxManifestFragmentResults](#API_reader_GetDASHStreamingSessionURL_RequestSyntax) **
Die maximale Anzahl von Fragmenten, die im MPEG-DASH-Manifest zurückgegeben werden.
Wenn ja `PlaybackMode``LIVE`, werden die neuesten Fragmente bis zu diesem Wert zurückgegeben. Wenn der `PlaybackMode` Wert ist`ON_DEMAND`, werden die ältesten Fragmente zurückgegeben, bis zu dieser Höchstzahl.
Wenn in einem Live-MPEG-DASH-Manifest eine höhere Anzahl von Fragmenten verfügbar ist, puffern Videoplayer häufig Inhalte, bevor sie mit der Wiedergabe beginnen. Eine Erhöhung der Puffergröße erhöht die Wiedergabe-Latenz, verringert jedoch die Wahrscheinlichkeit, dass während der Wiedergabe eine Zwischenpufferung auftritt. Wir empfehlen, dass ein Live-MPEG-DASH-Manifest mindestens 3 Fragmente und maximal 10 Fragmente enthält.
Die Standardeinstellung ist 5 Fragmente, wenn `PlaybackMode` es `LIVE` oder ist`LIVE_REPLAY`, und 1.000, wenn es ist. `PlaybackMode` `ON_DEMAND`
Der Höchstwert von 1.000 Fragmenten entspricht mehr als 16 Minuten Video bei Streams mit 1-Sekunden-Fragmenten und mehr als 2 1/2 Stunden Video bei Streams mit 10-Sekunden-Fragmenten.
Type: Long
Gültiger Bereich: Mindestwert 1. Der Höchstwert ist 5000.
Erforderlich: Nein
** [PlaybackMode](#API_reader_GetDASHStreamingSessionURL_RequestSyntax) **
Ob Live-, Live-Wiedergabe- oder archivierte On-Demand-Daten abgerufen werden sollen.
Zu den Funktionen der drei Sitzungstypen gehören:
+ **`LIVE`**: Für Sitzungen dieses Typs wird das MPEG-DASH-Manifest kontinuierlich mit den neuesten Fragmenten aktualisiert, sobald diese verfügbar sind. Wir empfehlen, dass der Media Player alle eine Sekunde ein neues Manifest abruft. Wenn diese Art von Sitzung in einem Media Player wiedergegeben wird, zeigt die Benutzeroberfläche in der Regel eine Live-Benachrichtigung an, ohne dass die gewünschte Position im Wiedergabefenster ausgewählt werden kann.
**Anmerkung**
Im `LIVE` Modus sind die neuesten verfügbaren Fragmente in einem MPEG-DASH-Manifest enthalten, auch wenn zwischen den Fragmenten eine Lücke besteht (d. h. wenn ein Fragment fehlt). Eine solche Lücke kann dazu führen, dass ein Media Player stoppt oder die Wiedergabe unterbrochen wird. In diesem Modus werden Fragmente nicht zum MPEG-DASH-Manifest hinzugefügt, wenn sie älter als das neueste Fragment in der Playlist sind. Wenn das fehlende Fragment verfügbar wird, nachdem ein weiteres Fragment zum Manifest hinzugefügt wurde, wird das ältere Fragment nicht hinzugefügt und die Lücke wird nicht gefüllt.
+ **`LIVE_REPLAY`**: Bei Sessions dieses Typs wird das MPEG-DASH-Manifest ähnlich aktualisiert, wie es für den `LIVE` Modus aktualisiert wird, außer dass es zunächst Fragmente aus einer bestimmten Startzeit einbezieht. Anstatt Fragmente hinzuzufügen, wenn sie aufgenommen werden, werden Fragmente hinzugefügt, wenn die Dauer des nächsten Fragments verstrichen ist. Wenn die Fragmente in der Sitzung beispielsweise zwei Sekunden lang sind, wird dem Manifest alle zwei Sekunden ein neues Fragment hinzugefügt. Dieser Modus ist nützlich, um die Wiedergabe ab dem Zeitpunkt starten zu können, an dem ein Ereignis erkannt wird, und das Live-Streaming von Medien fortsetzen zu können, die zum Zeitpunkt der Sitzungserstellung noch nicht aufgenommen wurden. Dieser Modus ist auch nützlich, um zuvor archivierte Medien zu streamen, ohne durch die Obergrenze von 1.000 Fragmenten in diesem `ON_DEMAND` Modus eingeschränkt zu sein.
+ **`ON_DEMAND`**: Für Sitzungen dieses Typs enthält das MPEG-DASH-Manifest alle Fragmente für die Sitzung, bis zu der Anzahl, die in angegeben ist. `MaxManifestFragmentResults` Das Manifest muss für jede Sitzung nur einmal abgerufen werden. Wenn diese Art von Sitzung in einem Media Player wiedergegeben wird, zeigt die Benutzeroberfläche normalerweise ein Steuerelement an, mit dem Sie die anzuzeigende Position im Wiedergabefenster auswählen können.
Wenn dies der Fall `FragmentSelectorType` ist `PRODUCER_TIMESTAMP` und mehrere Fragmente mit demselben Startzeitstempel vorhanden sind, ist in allen Wiedergabemodi das Fragment mit der größeren Fragmentnummer (d. h. das neuere Fragment) im MPEG-DASH-Manifest enthalten. Die anderen Fragmente sind nicht enthalten. Fragmente mit unterschiedlichen Zeitstempeln, aber überlappender Dauer sind weiterhin im MPEG-DASH-Manifest enthalten. Dies kann zu unerwartetem Verhalten im Media Player führen.
Der Standardwert ist `LIVE`.
Typ: Zeichenfolge
Zulässige Werte: `LIVE | LIVE_REPLAY | ON_DEMAND`
Erforderlich: Nein
** [StreamARN](#API_reader_GetDASHStreamingSessionURL_RequestSyntax) **
Der Amazon-Ressourcenname (ARN) des Streams, für den die MPEG-DASH-Manifest-URL abgerufen werden soll.
Sie müssen entweder den oder den `StreamName` 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_GetDASHStreamingSessionURL_RequestSyntax) **
Der Name des Streams, für den die MPEG-DASH-Manifest-URL abgerufen werden soll.
Sie müssen entweder den oder den `StreamName` 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
## Antwortsyntax
```
HTTP/1.1 200
Content-type: application/json
{
"DASHStreamingSessionURL": "string"
}
```
## Antwortelemente
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.
** [DASHStreamingSessionURL](#API_reader_GetDASHStreamingSessionURL_ResponseSyntax) **
Die URL (die das Sitzungstoken enthält), die ein Media Player verwenden kann, um das MPEG-DASH-Manifest abzurufen.
Typ: Zeichenfolge
## Fehler
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
** InvalidCodecPrivateDataException **
Die privaten Codec-Daten in mindestens einem der Tracks des Videostreams sind für diesen Vorgang nicht gültig.
HTTP-Statuscode: 400
** MissingCodecPrivateDataException **
In mindestens einem der Spuren des Videostreams wurden keine privaten Codec-Daten gefunden.
HTTP-Statuscode: 400
** NoDataRetentionException **
`GetImages`wurde für einen Stream angefordert, der keine Daten speichert (d. h. einen Wert `DataRetentionInHours` von 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
** UnsupportedStreamMediaTypeException **
Der Medientyp (z. B. h.264- oder h.265-Video oder AAC- oder G.711-Audio) konnte anhand IDs des Codec der Titel im ersten Fragment für eine Wiedergabesitzung nicht bestimmt werden. Die Codec-ID für Track 1 sollte `V_MPEG/ISO/AVC` und optional die Codec-ID für Track 2 sein. `A_AAC`
HTTP-Statuscode: 400
## Weitere Informationen finden Sie unter:
Weitere Informationen zur Verwendung dieser API in einer der sprachspezifischen Sprachen finden Sie im Folgenden AWS SDKs:
+ [AWS Befehlszeilenschnittstelle V2](https://docs.aws.amazon.com/goto/cli2/kinesis-video-reader-data-2017-09-30/GetDASHStreamingSessionURL)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/kinesis-video-reader-data-2017-09-30/GetDASHStreamingSessionURL)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/kinesis-video-reader-data-2017-09-30/GetDASHStreamingSessionURL)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/kinesis-video-reader-data-2017-09-30/GetDASHStreamingSessionURL)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/kinesis-video-reader-data-2017-09-30/GetDASHStreamingSessionURL)
+ [AWS SDK für JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/kinesis-video-reader-data-2017-09-30/GetDASHStreamingSessionURL)
+ [AWS SDK für Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/kinesis-video-reader-data-2017-09-30/GetDASHStreamingSessionURL)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/kinesis-video-reader-data-2017-09-30/GetDASHStreamingSessionURL)
+ [AWS SDK für Python](https://docs.aws.amazon.com/goto/boto3/kinesis-video-reader-data-2017-09-30/GetDASHStreamingSessionURL)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/kinesis-video-reader-data-2017-09-30/GetDASHStreamingSessionURL)
# GetHLSStreamingSessionURL
Ruft eine HTTP Live Streaming (HLS) -URL für den Stream ab. Sie können die URL dann in einem Browser oder Media Player öffnen, um den Stream-Inhalt anzusehen.
`StreamName`Sowohl der als auch der `StreamARN` Parameter sind optional, aber Sie müssen entweder den `StreamName` oder den angeben, `StreamARN` wenn Sie diesen API-Vorgang aufrufen.
Für einen Amazon Kinesis Kinesis-Videostream gelten die folgenden Anforderungen für die Bereitstellung von Daten über HLS:
+ Anforderungen an den [Titel für die Videowiedergabe](https://docs.aws.amazon.com/kinesisvideostreams/latest/dg/video-playback-requirements.html).
+ Der Datenerhaltzeitraum muss größer als 0 sein.
+ Die Videospur jedes Fragments muss private Codec-Daten im Advanced Video Coding (AVC) für das H.264-Format oder HEVC für das H.265-Format ([MPEG-4-Spezifikation](https://www.iso.org/standard/55980.html) ISO/IEC 14496-15) enthalten. Informationen zur Adaptierung von Stream-Daten für ein bestimmtes Format finden Sie unter [NAL Adaptation Flags](https://docs.aws.amazon.com/kinesisvideostreams/latest/dg/producer-reference-nal.html).
+ [Die Audiospur (falls vorhanden) jedes Fragments muss private Codec-Daten im AAC-Format (AAC-Spezifikation 13818-7) enthalten. ISO/IEC ](https://www.iso.org/standard/43345.html)
Kinesis Video Streams HLS-Sitzungen enthalten Fragmente in der fragmentierten MPEG-4-Form (auch als f MP4 oder CMAF bezeichnet) oder der MPEG-2-Form (auch TS-Chunks genannt, die von der HLS-Spezifikation ebenfalls unterstützt werden). [Weitere Informationen zu HLS-Fragmenttypen finden Sie in der HLS-Spezifikation.](https://tools.ietf.org/html/draft-pantos-http-live-streaming-23)
Das folgende Verfahren zeigt, wie HLS mit Kinesis Video Streams verwendet wird:
1. Rufen Sie die `GetDataEndpoint` API auf, um einen Endpunkt zu erhalten. Senden Sie dann die `GetHLSStreamingSessionURL` Anfragen mit dem Parameter [--endpoint-url an diesen Endpunkt](https://docs.aws.amazon.com/cli/latest/reference/).
1. Rufen Sie die HLS-URL ab mit. `GetHLSStreamingSessionURL` Kinesis Video Streams erstellt eine HLS-Streaming-Sitzung, die für den Zugriff auf Inhalte in einem Stream mithilfe des HLS-Protokolls verwendet wird. `GetHLSStreamingSessionURL`gibt eine authentifizierte URL (die ein verschlüsseltes Sitzungstoken enthält) für die *HLS-Master-Playlist* der Sitzung zurück (die Root-Ressource, die für das Streaming mit HLS benötigt wird).
**Anmerkung**
Teilen oder speichern Sie dieses Token nicht, wenn eine nicht autorisierte Entität darauf zugreifen könnte. Das Token ermöglicht den Zugriff auf den Inhalt des Streams. Schützen Sie das Token mit denselben Maßnahmen, die Sie für Ihre AWS Anmeldeinformationen verwenden würden.
Die Medien, die über die Playlist verfügbar gemacht werden, bestehen nur aus dem angeforderten Stream, Zeitraum und Format. Es werden keine anderen Mediendaten (wie Frames außerhalb des angeforderten Fensters oder alternative Bitraten) zur Verfügung gestellt.
1. Geben Sie die URL (mit dem verschlüsselten Sitzungstoken) für die HLS-Master-Playlist an einen Media Player weiter, der das HLS-Protokoll unterstützt. Kinesis Video Streams stellt die HLS-Medien-Playlist, das Initialisierungsfragment und die Medienfragmente über die URL der Master-Playlist zur Verfügung. Das Initialisierungsfragment enthält die privaten Codec-Daten für den Stream und andere Daten, die zur Einrichtung des Video- oder Audiodecoders und Renderers benötigt werden. Die Medienfragmente enthalten H.264-kodierte Videoframes oder AAC-kodierte Audiobeispiele.
1. Der Media Player empfängt die authentifizierte URL und fordert Stream-Metadaten und Mediendaten normal an. Wenn der Media Player Daten anfordert, ruft er die folgenden Aktionen auf:
+ **HLSMasterPlaylist abrufen:** Ruft eine HLS-Master-Playlist ab, die eine URL für die `GetHLSMediaPlaylist` Aktion für jeden Titel und zusätzliche Metadaten für den Media Player, einschließlich der geschätzten Bitrate und Auflösung, enthält.
+ **HLSMediaPlaylist abrufen:** Ruft eine HLS-Medien-Playlist ab, die eine URL für den Zugriff auf das MP4 Initialisierungsfragment mit der `GetMP4InitFragment` Aktion und URLs für den Zugriff auf die Medienfragmente mit den MP4 Aktionen enthält. `GetMP4MediaFragment` Die HLS-Medien-Playlist enthält auch Metadaten über den Stream, den der Player zum Abspielen benötigt, z. B. ob der Stream ist oder. `PlaybackMode` `LIVE` `ON_DEMAND` Die HLS-Medien-Playlist ist in der Regel statisch für Sessions mit einem `PlaybackType` von. `ON_DEMAND` Die HLS-Medien-Playlist wird kontinuierlich mit neuen Fragmenten für Sitzungen mit einem `PlaybackType` von aktualisiert. `LIVE` Es gibt eine eigene HLS-Medien-Playlist für den Videotrack und den Audiotrack (falls zutreffend), die MP4 Medien URLs für den jeweiligen Titel enthält.
+ **Abrufen MP4InitFragment:** Ruft das MP4 Initialisierungsfragment ab. Der Media Player lädt normalerweise das Initialisierungsfragment, bevor er Medienfragmente lädt. Dieses Fragment enthält die Atome `fytp` "" und "`moov`" sowie die untergeordneten MP4 Atome, die zur Initialisierung des Media Player-Decoders benötigt werden.
Das Initialisierungsfragment entspricht keinem Fragment in einem Kinesis-Videostream. Es enthält nur die privaten Codec-Daten für den Stream und den jeweiligen Titel, die der Media Player benötigt, um die Medienframes zu dekodieren.
+ **Abrufen MP4MediaFragment:** Ruft MP4 Medienfragmente ab. Diese Fragmente enthalten die MP4 Atome `moof` "" und "`mdat`" und ihre untergeordneten Atome, die die Medienframes und ihre Zeitstempel des codierten Fragments enthalten.
**Anmerkung**
Die in jedem Fragment enthaltenen privaten Codec Data (CPD) enthalten Codec-spezifische Initialisierungsinformationen wie Bildrate, Auflösung und Kodierungsprofil, die für die korrekte Dekodierung des Fragments erforderlich sind. Sowohl für TS- als auch für CPD-Änderungen werden während einer MP4 Streaming-Sitzung unterstützt. Daher können die Fragmente in einer Sitzung unterschiedliche Informationen in der CPD enthalten, ohne dass die Wiedergabe unterbrochen wird. Für jede Streaming-Sitzung sind nur 500 CPD-Änderungen zulässig.
**Wichtig**
Änderungen nachverfolgen werden nicht unterstützt. Die Titel müssen in den abgefragten Medien einheitlich sein. Das Streaming schlägt fehl, wenn die Fragmente im Stream nicht mehr nur Video enthalten, sondern sowohl Audio als auch Video enthalten, oder wenn eine AAC-Audiospur in eine A-Law-Audiospur umgewandelt wird.
Mit dieser Aktion abgerufene Daten sind abrechnungsfähig. Weitere Informationen finden Sie unter [-Preise](https://aws.amazon.com/kinesis/video-streams/pricing/).
+ **AbrufenTSFragment:** Ruft MPEG TS-Fragmente ab, die sowohl Initialisierungs- als auch Mediendaten für alle Titel im Stream enthalten.
**Anmerkung**
Falls ja`MPEG_TS`, `ContainerFormat` wird diese API anstelle von `GetMP4InitFragment` und zum Abrufen von `GetMP4MediaFragment` Stream-Medien verwendet.
Mit dieser Aktion abgerufene Daten sind fakturierbar. Weitere Informationen finden Sie unter [Preise für Kinesis Video Streams](https://aws.amazon.com/kinesis/video-streams/pricing/).
Die URL einer Streaming-Sitzung darf nicht von Spielern gemeinsam genutzt werden. Der Dienst drosselt möglicherweise eine Sitzung, wenn sie von mehreren Mediaplayern gemeinsam genutzt wird. Verbindungslimits finden Sie unter [Kinesis Video Streams Streams-Kontingente](https://docs.aws.amazon.com/kinesisvideostreams/latest/dg/limits.html).
Sie können die Datenmenge, die der Media Player verbraucht, überwachen, indem Sie die `GetMP4MediaFragment.OutgoingBytes` CloudWatch Amazon-Metrik überwachen. Informationen CloudWatch zur Überwachung von Kinesis Video Streams finden Sie unter [Kinesis Video Streams überwachen](https://docs.aws.amazon.com/kinesisvideostreams/latest/dg/monitoring.html). Preisinformationen finden Sie unter [Amazon Kinesis Video Streams — Preise](https://aws.amazon.com/kinesis/video-streams/pricing/) und [AWS Preise](https://aws.amazon.com/pricing/). Sowohl für HLS-Sitzungen als auch für ausgehende AWS Daten fallen Gebühren an.
Die Beispiele für die Videowiedergabe finden Sie im Dokumentationsleitfaden: [Verwenden Sie die AWS CLI , um die URL einer HLS-Streaming-Sitzung abzurufen](hls-playback.md#retrieve-hls-url) und[Beispiel: Verwenden Sie HLS in HTML und JavaScript](hls-playback.md#how-hls-ex1).
Weitere Informationen zu HLS finden Sie unter [HTTP Live Streaming](https://developer.apple.com/streaming/) auf der [Apple Developer-Website.](https://developer.apple.com)
**Wichtig**
Wenn nach dem Aufrufen einer Kinesis Video Streams Streams-API für archivierte Medien ein Fehler ausgelöst wird, enthält dieser zusätzlich zum HTTP-Statuscode und dem Antworttext die folgenden Informationen:
`x-amz-ErrorType`HTTP-Header — enthält zusätzlich zu dem, was der HTTP-Statuscode bietet, einen spezifischeren Fehlertyp.
`x-amz-RequestId`HTTP-Header — Wenn Sie ein Problem melden möchten AWS, kann das Support-Team das Problem anhand der Anforderungs-ID besser diagnostizieren.
Sowohl der HTTP-Statuscode als auch der ErrorType Header können verwendet werden, um programmatische Entscheidungen darüber zu treffen, ob und unter welchen Bedingungen Fehler wiederholt werden können. Außerdem können Informationen darüber bereitgestellt werden, welche Maßnahmen der Client-Programmierer möglicherweise ergreifen muss, um es erneut erfolgreich zu versuchen.
[Weitere Informationen finden Sie im Abschnitt **Fehler** am Ende dieses Themas sowie unter Häufige Fehler.](https://docs.aws.amazon.com/kinesisvideostreams/latest/dg/CommonErrors.html)
## Anforderungssyntax
```
POST /getHLSStreamingSessionURL HTTP/1.1
Content-type: application/json
{
"ContainerFormat": "string",
"DiscontinuityMode": "string",
"DisplayFragmentTimestamp": "string",
"Expires": number,
"HLSFragmentSelector": {
"FragmentSelectorType": "string",
"TimestampRange": {
"EndTimestamp": number,
"StartTimestamp": number
}
},
"MaxMediaPlaylistFragmentResults": number,
"PlaybackMode": "string",
"StreamARN": "string",
"StreamName": "string"
}
```
## URI-Anfrageparameter
Die Anforderung verwendet keine URI-Parameter.
## Anforderungstext
Die Anforderung akzeptiert die folgenden Daten im JSON-Format.
** [ContainerFormat](#API_reader_GetHLSStreamingSessionURL_RequestSyntax) **
Gibt an, welches Format für die Verpackung der Medien verwendet werden soll. Durch die Angabe des `FRAGMENTED_MP4` Containerformats werden die Medien in MP4 Fragmente (f MP4 oder CMAF) verpackt. Dies ist die empfohlene Verpackung, da nur ein minimaler Verpackungsaufwand anfällt. Die andere Option für das Containerformat ist`MPEG_TS`. HLS unterstützt seit seiner Veröffentlichung MPEG TS-Chunks und ist manchmal das einzige unterstützte Paket auf älteren HLS-Playern. MPEG TS hat in der Regel einen Paketierungsaufwand von 5 bis 25 Prozent. Das bedeutet, dass MPEG TS in der Regel 5 bis 25 Prozent mehr Bandbreite und Kosten benötigt als f. MP4
Der Standardwert ist `FRAGMENTED_MP4`.
Typ: Zeichenfolge
Zulässige Werte: `FRAGMENTED_MP4 | MPEG_TS`
Erforderlich: Nein
** [DiscontinuityMode](#API_reader_GetHLSStreamingSessionURL_RequestSyntax) **
Gibt an, wann Markierungen, die Unterbrechungen zwischen Fragmenten kennzeichnen, zu den Medien-Playlisten hinzugefügt werden.
Media-Player erstellen in der Regel eine Zeitleiste mit den abzuspielenden Medieninhalten, die auf den Zeitstempeln der einzelnen Fragmente basiert. Das heißt, wenn es Überschneidungen oder Lücken zwischen Fragmenten gibt (was bei Einstellung üblich [HLSFragmentSelector](API_reader_HLSFragmentSelector.md) ist`SERVER_TIMESTAMP`), weist die Timeline des Media Players an einigen Stellen auch kleine Lücken zwischen den Fragmenten auf und überschreibt an anderen Stellen Frames. Lücken in der Timeline des Media Players können dazu führen, dass die Wiedergabe ins Stocken gerät, und Überlappungen können dazu führen, dass die Wiedergabe ruckelig wird. Wenn zwischen Fragmenten Unterbrechungen auftreten, wird erwartet, dass der Media Player die Timeline zurücksetzt, sodass das nächste Fragment unmittelbar nach dem vorherigen Fragment abgespielt wird.
Die folgenden Modi werden unterstützt:
+ `ALWAYS`: Zwischen jedem Fragment in der HLS-Medien-Playlist wird eine Diskontinuitätsmarkierung platziert. Es wird empfohlen, den Wert von zu verwenden, `ALWAYS` wenn die Zeitstempel der Fragmente nicht korrekt sind.
+ `NEVER`: Es sind nirgends Diskontinuitätsmarkierungen platziert. Es wird empfohlen, den Wert von zu verwenden, `NEVER` um sicherzustellen, dass die Timeline des Media Players möglichst genau den Zeitstempeln des Produzenten entspricht.
+ `ON_DISCONTINUITY`: Zwischen Fragmenten, die eine Lücke oder Überlappung von mehr als 50 Millisekunden aufweisen, wird ein Diskontinuitätsmarker platziert. Für die meisten Wiedergabeszenarien wird empfohlen, den Wert von zu verwenden, `ON_DISCONTINUITY` sodass die Media Player-Zeitleiste nur zurückgesetzt wird, wenn ein erhebliches Problem mit der Medien-Timeline vorliegt (z. B. ein fehlendes Fragment).
Die Standardeinstellung ist`SERVER_TIMESTAMP`, `ALWAYS` wann auf eingestellt [HLSFragmentSelector](API_reader_HLSFragmentSelector.md) ist und `NEVER` wann es auf eingestellt ist`PRODUCER_TIMESTAMP`.
Typ: Zeichenfolge
Zulässige Werte: `ALWAYS | NEVER | ON_DISCONTINUITY`
Erforderlich: Nein
** [DisplayFragmentTimestamp](#API_reader_GetHLSStreamingSessionURL_RequestSyntax) **
Gibt an, wann die Startzeitstempel des Fragments in die HLS-Medien-Playlist aufgenommen werden sollen. In der Regel geben Media Player die Position des Abspielkopfs als Zeit relativ zum Beginn des ersten Fragments in der Wiedergabesitzung an. Wenn die Startzeitstempel jedoch in der HLS-Medien-Playlist enthalten sind, geben einige Media Player den aktuellen Abspielkopf möglicherweise als absolute Zeit an, die auf den Zeitstempeln des Fragments basiert. Dies kann nützlich sein, um ein Wiedergabeerlebnis zu schaffen, bei dem den Zuschauern die Uhrzeit des Mediums angezeigt wird, zu der die Wandzeit angezeigt wird.
Der Standardwert ist `NEVER`. Wenn dies der [HLSFragmentSelector](API_reader_HLSFragmentSelector.md) Fall ist`SERVER_TIMESTAMP`, sind die Zeitstempel die Startzeitstempel des Servers. In ähnlicher Weise sind die Zeitstempel die `PRODUCER_TIMESTAMP` Startzeitstempel des Produzenten, wenn dies der Fall [HLSFragmentSelector](API_reader_HLSFragmentSelector.md) ist.
Typ: Zeichenfolge
Zulässige Werte: `ALWAYS | NEVER`
Erforderlich: Nein
** [Expires](#API_reader_GetHLSStreamingSessionURL_RequestSyntax) **
Die Zeit in Sekunden, bis die angeforderte Sitzung abläuft. Dieser Wert kann zwischen 300 (5 Minuten) und 43200 (12 Stunden) liegen.
Wenn eine Sitzung abläuft, `GetTSFragment` können für diese `GetHLSMasterPlaylist` Sitzung keine neuen Aufrufe von `GetHLSMediaPlaylist` `GetMP4InitFragment``GetMP4MediaFragment`,,, oder getätigt werden.
Der Standardwert ist 300 (5 Minuten).
Typ: Ganzzahl
Gültiger Bereich: Mindestwert von 300. Maximalwert 43200.
Erforderlich: Nein
** [HLSFragmentSelector](#API_reader_GetHLSStreamingSessionURL_RequestSyntax) **
Der Zeitbereich des angeforderten Fragments und die Quelle der Zeitstempel.
Dieser Parameter ist erforderlich, wenn er `ON_DEMAND` oder `PlaybackMode` `LIVE_REPLAY` ist. Dieser Parameter ist optional, falls PlaybackMode ja ```LIVE`. Wenn `PlaybackMode` ja`LIVE`, `FragmentSelectorType` kann er gesetzt werden, `TimestampRange` sollte aber nicht gesetzt werden. Wenn `PlaybackMode` ist `ON_DEMAND` oder`LIVE_REPLAY`, `TimestampRange` müssen beide `FragmentSelectorType` gesetzt werden.
Typ: [HLSFragmentSelector](API_reader_HLSFragmentSelector.md) Objekt
Erforderlich: Nein
** [MaxMediaPlaylistFragmentResults](#API_reader_GetHLSStreamingSessionURL_RequestSyntax) **
Die maximale Anzahl von Fragmenten, die in den HLS-Medien-Playlisten zurückgegeben werden.
Wenn ja `PlaybackMode``LIVE`, werden die neuesten Fragmente bis zu diesem Wert zurückgegeben. Wenn der `PlaybackMode` Wert ist`ON_DEMAND`, werden die ältesten Fragmente zurückgegeben, bis zu dieser Höchstzahl.
Wenn in einer Live-HLS-Medien-Playlist eine höhere Anzahl von Fragmenten verfügbar ist, puffern Videoplayer häufig Inhalte, bevor sie mit der Wiedergabe beginnen. Eine Erhöhung der Puffergröße erhöht die Wiedergabe-Latenz, verringert jedoch die Wahrscheinlichkeit, dass während der Wiedergabe eine Zwischenpufferung auftritt. Wir empfehlen, dass eine Live-HLS-Medien-Playlist mindestens 3 Fragmente und maximal 10 Fragmente enthält.
Die Standardeinstellung ist 5 Fragmente, falls `PlaybackMode` es `LIVE` oder ist`LIVE_REPLAY`, und 1.000, wenn ja`PlaybackMode`. `ON_DEMAND`
Der Höchstwert von 5.000 Fragmenten entspricht mehr als 80 Minuten Video bei Streams mit 1-Sekunden-Fragmenten und mehr als 13 Stunden Video bei Streams mit 10-Sekunden-Fragmenten.
Type: Long
Gültiger Bereich: Mindestwert 1. Der Höchstwert ist 5000.
Erforderlich: Nein
** [PlaybackMode](#API_reader_GetHLSStreamingSessionURL_RequestSyntax) **
Ob Live-, Live-Wiedergabe- oder archivierte On-Demand-Daten abgerufen werden sollen.
Zu den Funktionen der drei Sitzungstypen gehören:
+ **`LIVE`**: Bei Sitzungen dieses Typs wird die HLS-Medien-Playlist ständig mit den neuesten Fragmenten aktualisiert, sobald sie verfügbar sind. Wir empfehlen, dass der Media Player alle eine Sekunde lang eine neue Playlist abruft. Wenn diese Art von Sitzung in einem Media Player abgespielt wird, zeigt die Benutzeroberfläche in der Regel eine Live-Benachrichtigung an, ohne dass die gewünschte Position im Wiedergabefenster ausgewählt werden kann.
**Anmerkung**
Im `LIVE` Modus werden die neuesten verfügbaren Fragmente in eine HLS-Medien-Playlist aufgenommen, auch wenn zwischen den Fragmenten eine Lücke besteht (d. h. wenn ein Fragment fehlt). Eine solche Lücke kann dazu führen, dass ein Media Player angehalten wird oder die Wiedergabe unterbrochen wird. In diesem Modus werden Fragmente nicht zur HLS-Medien-Playlist hinzugefügt, wenn sie älter als das neueste Fragment in der Playlist sind. Wenn das fehlende Fragment verfügbar wird, nachdem ein weiteres Fragment zur Playlist hinzugefügt wurde, wird das ältere Fragment nicht hinzugefügt und die Lücke wird nicht gefüllt.
+ **`LIVE_REPLAY`**: Bei Sessions dieses Typs wird die HLS-Medien-Playlist ähnlich wie bei der Aktualisierung für den `LIVE` Modus aktualisiert, außer dass sie damit beginnt, Fragmente ab einer bestimmten Startzeit einzubeziehen. Fragmente werden nicht bei der Aufnahme hinzugefügt, sondern Fragmente werden hinzugefügt, wenn die Dauer des nächsten Fragments verstrichen ist. Wenn die Fragmente in der Sitzung beispielsweise zwei Sekunden lang sind, wird der Medien-Playlist alle zwei Sekunden ein neues Fragment hinzugefügt. Dieser Modus ist nützlich, um die Wiedergabe ab dem Zeitpunkt starten zu können, an dem ein Ereignis erkannt wird, und das Live-Streaming von Medien fortsetzen zu können, die zum Zeitpunkt der Sitzungserstellung noch nicht aufgenommen wurden. Dieser Modus ist auch nützlich, um zuvor archivierte Medien zu streamen, ohne durch die Obergrenze von 1.000 Fragmenten in diesem `ON_DEMAND` Modus eingeschränkt zu sein.
+ **`ON_DEMAND`**: Bei Sitzungen dieses Typs enthält die HLS-Medien-Playlist alle Fragmente für die Sitzung, bis zu der Anzahl, die in `MaxMediaPlaylistFragmentResults` angegeben ist. Die Playlist darf für jede Sitzung nur einmal abgerufen werden. Wenn diese Art von Sitzung in einem Media Player abgespielt wird, zeigt die Benutzeroberfläche in der Regel ein Steuerelement an, mit dem Sie die anzuzeigende Position im Wiedergabefenster auswählen können.
Wenn dies der Fall `FragmentSelectorType` ist `PRODUCER_TIMESTAMP` und mehrere Fragmente mit demselben Startzeitstempel vorhanden sind, ist in allen Wiedergabemodi das Fragment mit der größten Fragmentnummer (d. h. das neueste Fragment) in der HLS-Medien-Playlist enthalten. Die anderen Fragmente sind nicht enthalten. Fragmente mit unterschiedlichen Zeitstempeln, deren Dauer sich jedoch überschneidet, sind weiterhin in der HLS-Medien-Playlist enthalten. Dies kann zu unerwartetem Verhalten im Media Player führen.
Der Standardwert ist `LIVE`.
Typ: Zeichenfolge
Zulässige Werte: `LIVE | LIVE_REPLAY | ON_DEMAND`
Erforderlich: Nein
** [StreamARN](#API_reader_GetHLSStreamingSessionURL_RequestSyntax) **
Der Amazon-Ressourcenname (ARN) des Streams, für den die URL der HLS-Master-Playlist abgerufen werden soll.
Sie müssen entweder den `StreamName` oder den `StreamARN` angeben.
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_GetHLSStreamingSessionURL_RequestSyntax) **
Der Name des Streams, für den die URL der HLS-Master-Playlist abgerufen werden soll.
Sie müssen entweder den `StreamName` oder den `StreamARN` angeben.
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
## Antwortsyntax
```
HTTP/1.1 200
Content-type: application/json
{
"HLSStreamingSessionURL": "string"
}
```
## Antwortelemente
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.
** [HLSStreamingSessionURL](#API_reader_GetHLSStreamingSessionURL_ResponseSyntax) **
Die URL (die das Sitzungstoken enthält), mit der ein Media Player die HLS-Master-Playlist abrufen kann.
Typ: Zeichenfolge
## Fehler
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
** InvalidCodecPrivateDataException **
Die privaten Codec-Daten in mindestens einem der Tracks des Videostreams sind für diesen Vorgang nicht gültig.
HTTP-Statuscode: 400
** MissingCodecPrivateDataException **
In mindestens einem der Spuren des Videostreams wurden keine privaten Codec-Daten gefunden.
HTTP-Statuscode: 400
** NoDataRetentionException **
`GetImages`wurde für einen Stream angefordert, der keine Daten speichert (d. h. einen Wert `DataRetentionInHours` von 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
** UnsupportedStreamMediaTypeException **
Der Medientyp (z. B. h.264- oder h.265-Video oder AAC- oder G.711-Audio) konnte anhand IDs des Codec der Titel im ersten Fragment für eine Wiedergabesitzung nicht bestimmt werden. Die Codec-ID für Track 1 sollte `V_MPEG/ISO/AVC` und optional die Codec-ID für Track 2 sein. `A_AAC`
HTTP-Statuscode: 400
## Weitere Informationen finden Sie unter:
Weitere Informationen zur Verwendung dieser API in einer der sprachspezifischen Sprachen finden Sie im Folgenden AWS SDKs:
+ [AWS Befehlszeilenschnittstelle V2](https://docs.aws.amazon.com/goto/cli2/kinesis-video-reader-data-2017-09-30/GetHLSStreamingSessionURL)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/kinesis-video-reader-data-2017-09-30/GetHLSStreamingSessionURL)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/kinesis-video-reader-data-2017-09-30/GetHLSStreamingSessionURL)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/kinesis-video-reader-data-2017-09-30/GetHLSStreamingSessionURL)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/kinesis-video-reader-data-2017-09-30/GetHLSStreamingSessionURL)
+ [AWS SDK für JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/kinesis-video-reader-data-2017-09-30/GetHLSStreamingSessionURL)
+ [AWS SDK für Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/kinesis-video-reader-data-2017-09-30/GetHLSStreamingSessionURL)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/kinesis-video-reader-data-2017-09-30/GetHLSStreamingSessionURL)
+ [AWS SDK für Python](https://docs.aws.amazon.com/goto/boto3/kinesis-video-reader-data-2017-09-30/GetHLSStreamingSessionURL)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/kinesis-video-reader-data-2017-09-30/GetHLSStreamingSessionURL)
# GetImages
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
```
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
Die Anforderung verwendet keine URI-Parameter.
## Anforderungstext
Die Anforderung akzeptiert die folgenden Daten im JSON-Format.
** [EndTimestamp](#API_reader_GetImages_RequestSyntax) **
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) **
Das Format, das zum Codieren des Bilds verwendet wird.
Typ: Zeichenfolge
Zulässige Werte: `JPEG | PNG`
Erforderlich: Ja
** [FormatConfig](#API_reader_GetImages_RequestSyntax) **
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) **
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) **
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) **
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) **
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) **
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) **
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) **
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) **
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) **
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
```
HTTP/1.1 200
Content-type: application/json
{
"Images": [
{
"Error": "string",
"ImageContent": "string",
"TimeStamp": number
}
],
"NextToken": "string"
}
```
## Antwortelemente
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) **
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) **
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
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:
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)
# GetMediaForFragmentList
Ruft Medien für eine Liste von Fragmenten (angegeben durch die Fragmentnummer) aus den archivierten Daten in einem Amazon Kinesis Kinesis-Videostream ab.
**Anmerkung**
Sie müssen zuerst die `GetDataEndpoint` API aufrufen, um einen Endpunkt zu erhalten. Senden Sie dann die `GetMediaForFragmentList` Anfragen mit dem Parameter [--endpoint-url an diesen Endpunkt](https://docs.aws.amazon.com/cli/latest/reference/).
Grenzwerte finden Sie unter [Kinesis Video Streams Streams-Kontingente](https://docs.aws.amazon.com/kinesisvideostreams/latest/dg/limits.html).
**Wichtig**
Wenn nach dem Aufrufen einer Kinesis Video Streams Streams-API für archivierte Medien ein Fehler ausgelöst wird, enthält dieser zusätzlich zum HTTP-Statuscode und dem Antworttext die folgenden Informationen:
`x-amz-ErrorType`HTTP-Header — enthält zusätzlich zu dem, was der HTTP-Statuscode bietet, einen spezifischeren Fehlertyp.
`x-amz-RequestId`HTTP-Header — Wenn Sie ein Problem melden möchten AWS, kann das Support-Team das Problem anhand der Anforderungs-ID besser diagnostizieren.
Sowohl der HTTP-Statuscode als auch der ErrorType Header können verwendet werden, um programmatische Entscheidungen darüber zu treffen, ob und unter welchen Bedingungen Fehler wiederholt werden können. Außerdem können Informationen darüber bereitgestellt werden, welche Maßnahmen der Client-Programmierer möglicherweise ergreifen muss, um es erneut erfolgreich zu versuchen.
[Weitere Informationen finden Sie im Abschnitt **Fehler** am Ende dieses Themas sowie unter Häufige Fehler.](https://docs.aws.amazon.com/kinesisvideostreams/latest/dg/CommonErrors.html)
## Anforderungssyntax
```
POST /getMediaForFragmentList HTTP/1.1
Content-type: application/json
{
"Fragments": [ "string" ],
"StreamARN": "string",
"StreamName": "string"
}
```
## URI-Anfrageparameter
Die Anforderung verwendet keine URI-Parameter.
## Anforderungstext
Die Anforderung akzeptiert die folgenden Daten im JSON-Format.
** [Fragments](#API_reader_GetMediaForFragmentList_RequestSyntax) **
Eine Liste der Fragmente, für die Medien abgerufen werden sollen. Sie rufen diese Werte mit ab[ListFragments](API_reader_ListFragments.md).
Typ: Zeichenfolgen-Array
Array-Mitglieder: Die Mindestanzahl beträgt 1 Element. Die maximale Anzahl beträgt 1000 Elemente.
Längenbeschränkungen: Minimale Länge beträgt 1 Zeichen. Maximale Länge beträgt 128 Zeichen.
Pattern: `^[0-9]+$`
Erforderlich: Ja
** [StreamARN](#API_reader_GetMediaForFragmentList_RequestSyntax) **
Der Amazon-Ressourcenname (ARN) des Streams, aus dem Fragmentmedien abgerufen werden sollen. Geben Sie entweder diesen Parameter oder den `StreamName` Parameter an.
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_GetMediaForFragmentList_RequestSyntax) **
Der Name des Streams, aus dem Fragmentmedien abgerufen werden sollen. Geben Sie entweder diesen Parameter oder den `StreamARN` Parameter an.
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
## Antwortsyntax
```
HTTP/1.1 200
Content-Type: ContentType
Payload
```
## Antwortelemente
Wenn die Aktion erfolgreich ist, sendet der Service eine HTTP 200-Antwort zurück.
Die Antwort gibt die folgenden HTTP-Header zurück.
** [ContentType](#API_reader_GetMediaForFragmentList_ResponseSyntax) **
Der Inhaltstyp des angeforderten Mediums.
Längenbeschränkungen: Minimale Länge beträgt 1 Zeichen. Maximale Länge beträgt 128 Zeichen.
Pattern: `^[a-zA-Z0-9_\.\-]+$`
Die Antwort gibt folgendes als HTTP-Hauptteil zurück.
** [Payload](#API_reader_GetMediaForFragmentList_ResponseSyntax) **
Die Payload, die Kinesis Video Streams zurückgibt, ist eine Sequenz von Chunks aus dem angegebenen Stream. Informationen zu den Chunks finden Sie unter. [PutMedia](https://docs.aws.amazon.com/kinesisvideostreams/latest/dg/API_dataplane_PutMedia.html) Die Chunks, die Kinesis Video Streams im `GetMediaForFragmentList` Aufruf zurückgibt, enthalten auch die folgenden zusätzlichen Matroska-Tags (MKV):
+ AWS\$1KINESISVIDEO\$1FRAGMENT\$1NUMBER - Die Fragmentnummer wurde im Chunk zurückgegeben.
+ AWS\$1KINESISVIDEO\$1SERVER\$1SIDE\$1TIMESTAMP - Serverseitiger Zeitstempel des Fragments.
+ AWS\$1KINESISVIDEO\$1PRODUCER\$1SIDE\$1TIMESTAMP - Herstellerseitiger Zeitstempel des Fragments.
Die folgenden Tags werden hinzugefügt, falls eine Ausnahme auftritt:
+ AWS\$1KINESISVIDEO\$1FRAGMENT\$1NUMBER - Die Nummer des Fragments, das die Ausnahme ausgelöst hat.
+ AWS\$1KINESISVIDEO\$1EXCEPTION\$1ERROR\$1CODE - Der Integer-Code des Fehlers.
+ AWS\$1KINESISVIDEO\$1EXCEPTION\$1MESSAGE - Eine Textbeschreibung der Ausnahme.
## Fehler
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
** 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:
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/GetMediaForFragmentList)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/kinesis-video-reader-data-2017-09-30/GetMediaForFragmentList)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/kinesis-video-reader-data-2017-09-30/GetMediaForFragmentList)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/kinesis-video-reader-data-2017-09-30/GetMediaForFragmentList)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/kinesis-video-reader-data-2017-09-30/GetMediaForFragmentList)
+ [AWS SDK für JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/kinesis-video-reader-data-2017-09-30/GetMediaForFragmentList)
+ [AWS SDK für Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/kinesis-video-reader-data-2017-09-30/GetMediaForFragmentList)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/kinesis-video-reader-data-2017-09-30/GetMediaForFragmentList)
+ [AWS SDK für Python](https://docs.aws.amazon.com/goto/boto3/kinesis-video-reader-data-2017-09-30/GetMediaForFragmentList)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/kinesis-video-reader-data-2017-09-30/GetMediaForFragmentList)
# ListFragments
Gibt eine Liste von [Fragment](API_reader_Fragment.md) Objekten aus dem angegebenen Stream- und Zeitstempelbereich innerhalb der archivierten Daten zurück.
Das Auflisten von Fragmenten ist letztendlich konsistent. Das bedeutet, dass selbst wenn der Hersteller eine Bestätigung erhält, dass ein Fragment persistent ist, das Ergebnis einer Anfrage an möglicherweise nicht sofort zurückgegeben wird. `ListFragments` Die Ergebnisse sind jedoch in der Regel in weniger als einer Sekunde verfügbar.
**Anmerkung**
Sie müssen zuerst die `GetDataEndpoint` API aufrufen, um einen Endpunkt zu erhalten. Senden Sie dann die `ListFragments` Anfragen mit dem Parameter [--endpoint-url an diesen Endpunkt](https://docs.aws.amazon.com/cli/latest/reference/).
**Wichtig**
Wenn nach dem Aufrufen einer Kinesis Video Streams Streams-API für archivierte Medien ein Fehler ausgelöst wird, enthält dieser zusätzlich zum HTTP-Statuscode und dem Antworttext die folgenden Informationen:
`x-amz-ErrorType`HTTP-Header — enthält zusätzlich zu dem, was der HTTP-Statuscode bietet, einen spezifischeren Fehlertyp.
`x-amz-RequestId`HTTP-Header — Wenn Sie ein Problem melden möchten AWS, kann das Support-Team das Problem anhand der Anforderungs-ID besser diagnostizieren.
Sowohl der HTTP-Statuscode als auch der ErrorType Header können verwendet werden, um programmatische Entscheidungen darüber zu treffen, ob und unter welchen Bedingungen Fehler wiederholt werden können. Außerdem können Informationen darüber bereitgestellt werden, welche Maßnahmen der Client-Programmierer möglicherweise ergreifen muss, um es erneut erfolgreich zu versuchen.
[Weitere Informationen finden Sie im Abschnitt **Fehler** am Ende dieses Themas sowie unter Häufige Fehler.](https://docs.aws.amazon.com/kinesisvideostreams/latest/dg/CommonErrors.html)
## Anforderungssyntax
```
POST /listFragments HTTP/1.1
Content-type: application/json
{
"FragmentSelector": {
"FragmentSelectorType": "string",
"TimestampRange": {
"EndTimestamp": number,
"StartTimestamp": number
}
},
"MaxResults": number,
"NextToken": "string",
"StreamARN": "string",
"StreamName": "string"
}
```
## URI-Anfrageparameter
Die Anforderung verwendet keine URI-Parameter.
## Anforderungstext
Die Anforderung akzeptiert die folgenden Daten im JSON-Format.
** [FragmentSelector](#API_reader_ListFragments_RequestSyntax) **
Beschreibt den Zeitstempelbereich und den Ursprung des Zeitstempels für den Bereich der zurückzugebenden Fragmente.
Dies ist nur erforderlich, wenn der `NextToken` nicht in der API übergeben wird.
Typ: [FragmentSelector](API_reader_FragmentSelector.md) Objekt
Erforderlich: Nein
** [MaxResults](#API_reader_ListFragments_RequestSyntax) **
Die Gesamtzahl der zurückzugebenden Fragmente. Wenn die Gesamtzahl der verfügbaren Fragmente den in angegebenen Wert übersteigt`max-results`, NextToken wird in der Ausgabe ein [ListFragments:](#KinesisVideo-reader_ListFragments-response-NextToken) bereitgestellt, mit dem Sie die Paginierung fortsetzen können.
Der Standardwert lautet 100.
Type: Long
Gültiger Bereich: Mindestwert 1. Maximaler Wert von 1 000.
Erforderlich: Nein
** [NextToken](#API_reader_ListFragments_RequestSyntax) **
Ein Token für den Beginn der Seitennummerierung. Dies ist das [ListFragments: NextToken](#KinesisVideo-reader_ListFragments-response-NextToken) aus 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
** [StreamARN](#API_reader_ListFragments_RequestSyntax) **
Der Amazon-Ressourcenname (ARN) des Streams, aus dem eine Fragmentliste abgerufen werden soll. Geben Sie entweder diesen Parameter oder den `StreamName` Parameter an.
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_ListFragments_RequestSyntax) **
Der Name des Streams, aus dem eine Fragmentliste abgerufen werden soll. Geben Sie entweder diesen Parameter oder den `StreamARN` Parameter an.
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
## Antwortsyntax
```
HTTP/1.1 200
Content-type: application/json
{
"Fragments": [
{
"FragmentLengthInMilliseconds": number,
"FragmentNumber": "string",
"FragmentSizeInBytes": number,
"ProducerTimestamp": number,
"ServerTimestamp": number
}
],
"NextToken": "string"
}
```
## Antwortelemente
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.
** [Fragments](#API_reader_ListFragments_ResponseSyntax) **
Eine Liste der archivierten [Fragment](API_reader_Fragment.md) Objekte aus dem Stream, die die Auswahlkriterien erfüllen. Die Ergebnisse sind in keiner bestimmten Reihenfolge, auch nicht seitenübergreifend.
Wenn der Stream keine Fragmente enthält, die die Auswahlkriterien erfüllen, wird eine leere Liste zurückgegeben.
Typ: Array von [Fragment](API_reader_Fragment.md)-Objekten
** [NextToken](#API_reader_ListFragments_ResponseSyntax) **
Wenn die zurückgegebene Liste gekürzt ist, gibt der Vorgang dieses Token zurück, mit dem die nächste Ergebnisseite abgerufen werden kann. Dieser Wert ist angegeben`null`, wenn keine weiteren Ergebnisse zurückgegeben werden können.
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
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
** 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:
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/ListFragments)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/kinesis-video-reader-data-2017-09-30/ListFragments)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/kinesis-video-reader-data-2017-09-30/ListFragments)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/kinesis-video-reader-data-2017-09-30/ListFragments)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/kinesis-video-reader-data-2017-09-30/ListFragments)
+ [AWS SDK für JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/kinesis-video-reader-data-2017-09-30/ListFragments)
+ [AWS SDK für Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/kinesis-video-reader-data-2017-09-30/ListFragments)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/kinesis-video-reader-data-2017-09-30/ListFragments)
+ [AWS SDK für Python](https://docs.aws.amazon.com/goto/boto3/kinesis-video-reader-data-2017-09-30/ListFragments)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/kinesis-video-reader-data-2017-09-30/ListFragments)
# Amazon Kinesis Kinesis-Videosignalkanäle
Die folgenden Aktionen werden von Amazon Kinesis Video Signaling Channels unterstützt:
+ [GetIceServerConfig](API_signaling_GetIceServerConfig.md)
+ [SendAlexaOfferToMaster](API_signaling_SendAlexaOfferToMaster.md)
# GetIceServerConfig
**Hinweis:** Bevor Sie diese API verwenden, müssen Sie die `GetSignalingChannelEndpoint` API aufrufen, um den HTTPS-Endpunkt anzufordern. Anschließend geben Sie den Endpunkt und die Region in Ihrer `GetIceServerConfig` API-Anfrage an.
Ruft die ICE-Serverkonfigurationsinformationen (Interactive Connectivity Establishment) ab URIs, einschließlich Benutzername und Kennwort, die zur Konfiguration der WebRTC-Verbindung verwendet werden können. Die ICE-Komponente verwendet diese Konfigurationsinformationen, um die WebRTC-Verbindung einzurichten, einschließlich der Authentifizierung beim Relay-Server Traversal Using Relays around NAT (TURN).
TURN ist ein Protokoll, das zur Verbesserung der Konnektivität von Anwendungen verwendet wird. peer-to-peer Durch die Bereitstellung eines cloudbasierten Relay-Dienstes stellt TURN sicher, dass eine Verbindung auch dann hergestellt werden kann, wenn ein oder mehrere Peers keine direkte peer-to-peer Verbindung herstellen können. Weitere Informationen finden Sie unter [Eine REST-API für den Zugriff auf TURN-Dienste](https://tools.ietf.org/html/draft-uberti-rtcweb-turn-rest-00).
Sie können diese API aufrufen, um einen Fallback-Mechanismus einzurichten, falls einer der Peers keine direkte peer-to-peer Verbindung über einen Signalkanal herstellen kann. Sie müssen den Amazon-Ressourcennamen (ARN) Ihres Signalisierungskanals angeben, um diese API aufzurufen.
## Anforderungssyntax
```
POST /v1/get-ice-server-config HTTP/1.1
Content-type: application/json
{
"ChannelARN": "string",
"ClientId": "string",
"Service": "string",
"Username": "string"
}
```
## URI-Anfrageparameter
Die Anforderung verwendet keine URI-Parameter.
## Anforderungstext
Die Anforderung akzeptiert die folgenden Daten im JSON-Format.
** [ChannelARN](#API_signaling_GetIceServerConfig_RequestSyntax) **
Der ARN des Signalkanals, der für die peer-to-peer Verbindung zwischen konfigurierten Peers verwendet werden soll.
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: Ja
** [ClientId](#API_signaling_GetIceServerConfig_RequestSyntax) **
Eindeutiger Bezeichner für den Betrachter. Muss innerhalb des Signalkanals eindeutig sein.
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
** [Service](#API_signaling_GetIceServerConfig_RequestSyntax) **
Gibt den gewünschten Dienst an. Derzeit `TURN` ist dies der einzig gültige Wert.
Typ: Zeichenfolge
Zulässige Werte: `TURN`
Erforderlich: Nein
** [Username](#API_signaling_GetIceServerConfig_RequestSyntax) **
Eine optionale Benutzer-ID, die den Anmeldeinformationen zugeordnet werden soll.
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
## Antwortsyntax
```
HTTP/1.1 200
Content-type: application/json
{
"IceServerList": [
{
"Password": "string",
"Ttl": number,
"Uris": [ "string" ],
"Username": "string"
}
]
}
```
## Antwortelemente
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.
** [IceServerList](#API_signaling_GetIceServerConfig_ResponseSyntax) **
Die Liste der ICE-Serverinformationsobjekte.
Typ: Array von [IceServer](API_signaling_IceServer.md)-Objekten
## Fehler
Weitere Informationen zu den allgemeinen Fehlern, die bei allen Aktionen zurückgegeben werden, finden Sie unter [Häufige Fehlertypen](CommonErrors.md).
** ClientLimitExceededException **
Ihre Anfrage wurde gedrosselt, weil Sie das Limit der erlaubten Client-Aufrufe überschritten haben. Versuchen Sie später, den Anruf zu tätigen.
HTTP-Statuscode: 400
** InvalidArgumentException **
Der Wert für diesen Eingabeparameter ist ungültig.
HTTP-Statuscode: 400
** InvalidClientException **
Der angegebene Client ist ungültig.
HTTP-Statuscode: 400
** NotAuthorizedException **
Der Anrufer ist nicht autorisiert, diesen Vorgang auszuführen.
HTTP-Statuscode: 401
** ResourceNotFoundException **
Die angegebene Ressource wurde nicht gefunden.
HTTP-Statuscode: 404
** SessionExpiredException **
Wenn die Clientsitzung abgelaufen ist. Sobald der Client verbunden ist, ist die Sitzung 45 Minuten lang gültig. Der Client sollte sich erneut mit dem Kanal verbinden, um weiterhin Nachrichten senden/empfangen zu können.
HTTP-Statuscode: 400
## Weitere Informationen finden Sie unter:
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-signaling-2019-12-04/GetIceServerConfig)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/kinesis-video-signaling-2019-12-04/GetIceServerConfig)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/kinesis-video-signaling-2019-12-04/GetIceServerConfig)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/kinesis-video-signaling-2019-12-04/GetIceServerConfig)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/kinesis-video-signaling-2019-12-04/GetIceServerConfig)
+ [AWS SDK für JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/kinesis-video-signaling-2019-12-04/GetIceServerConfig)
+ [AWS SDK für Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/kinesis-video-signaling-2019-12-04/GetIceServerConfig)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/kinesis-video-signaling-2019-12-04/GetIceServerConfig)
+ [AWS SDK für Python](https://docs.aws.amazon.com/goto/boto3/kinesis-video-signaling-2019-12-04/GetIceServerConfig)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/kinesis-video-signaling-2019-12-04/GetIceServerConfig)
# SendAlexaOfferToMaster
**Anmerkung**
Bevor Sie diese API verwenden, müssen Sie die `GetSignalingChannelEndpoint` API aufrufen, um einen Endpunkt zu erhalten. Anschließend geben Sie den Endpunkt und die Region in Ihrer `SendAlexaOfferToMaster` API-Anfrage an.
Diese API ermöglicht es Ihnen, WebRTC-fähige Geräte mit Alexa-Anzeigegeräten zu verbinden. Wenn sie aufgerufen wird, sendet sie das SDP-Angebot (Alexa Session Description Protocol) an den Master-Peer. Das Angebot wird zugestellt, sobald der Master mit dem angegebenen Signalkanal verbunden ist. Diese API gibt die SDP-Antwort vom verbundenen Master zurück. Wenn der Master nicht mit dem Signalkanal verbunden ist, werden Anfragen zur erneuten Zustellung gestellt, bis die Nachricht abläuft.
## Anforderungssyntax
```
POST /v1/send-alexa-offer-to-master HTTP/1.1
Content-type: application/json
{
"ChannelARN": "string",
"MessagePayload": "string",
"SenderClientId": "string"
}
```
## URI-Anfrageparameter
Die Anforderung verwendet keine URI-Parameter.
## Anforderungstext
Die Anforderung akzeptiert die folgenden Daten im JSON-Format.
** [ChannelARN](#API_signaling_SendAlexaOfferToMaster_RequestSyntax) **
Der Amazon-Ressourcenname (ARN) des Signalkanals, über den Alexa und der Master-Peer kommunizieren.
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: Ja
** [MessagePayload](#API_signaling_SendAlexaOfferToMaster_RequestSyntax) **
Das Base64-kodierte SDP bietet Inhalte.
Typ: Zeichenfolge
Längenbeschränkungen: Minimale Länge beträgt 1 Zeichen. Die maximale Länge beträgt 10000.
Pattern: `[a-zA-Z0-9+/=]+`
Erforderlich: Ja
** [SenderClientId](#API_signaling_SendAlexaOfferToMaster_RequestSyntax) **
Die eindeutige Kennung für den Absender-Client.
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: Ja
## Antwortsyntax
```
HTTP/1.1 200
Content-type: application/json
{
"Answer": "string"
}
```
## Antwortelemente
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.
** [Answer](#API_signaling_SendAlexaOfferToMaster_ResponseSyntax) **
Der Base64-kodierte SDP-Antwortinhalt.
Typ: Zeichenfolge
Längenbeschränkungen: Minimale Länge beträgt 1 Zeichen. Die maximale Länge beträgt 10000.
## Fehler
Weitere Informationen zu den allgemeinen Fehlern, die bei allen Aktionen zurückgegeben werden, finden Sie unter [Häufige Fehlertypen](CommonErrors.md).
** ClientLimitExceededException **
Ihre Anfrage wurde gedrosselt, weil Sie das Limit der erlaubten Client-Aufrufe überschritten haben. Versuchen Sie später, den Anruf zu tätigen.
HTTP-Statuscode: 400
** InvalidArgumentException **
Der Wert für diesen Eingabeparameter ist ungültig.
HTTP-Statuscode: 400
** NotAuthorizedException **
Der Anrufer ist nicht autorisiert, diesen Vorgang auszuführen.
HTTP-Statuscode: 401
** ResourceNotFoundException **
Die angegebene Ressource wurde nicht gefunden.
HTTP-Statuscode: 404
## Weitere Informationen finden Sie unter:
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-signaling-2019-12-04/SendAlexaOfferToMaster)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/kinesis-video-signaling-2019-12-04/SendAlexaOfferToMaster)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/kinesis-video-signaling-2019-12-04/SendAlexaOfferToMaster)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/kinesis-video-signaling-2019-12-04/SendAlexaOfferToMaster)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/kinesis-video-signaling-2019-12-04/SendAlexaOfferToMaster)
+ [AWS SDK für JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/kinesis-video-signaling-2019-12-04/SendAlexaOfferToMaster)
+ [AWS SDK für Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/kinesis-video-signaling-2019-12-04/SendAlexaOfferToMaster)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/kinesis-video-signaling-2019-12-04/SendAlexaOfferToMaster)
+ [AWS SDK für Python](https://docs.aws.amazon.com/goto/boto3/kinesis-video-signaling-2019-12-04/SendAlexaOfferToMaster)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/kinesis-video-signaling-2019-12-04/SendAlexaOfferToMaster)
# Amazon Kinesis Video WebRTC-Speicher
Die folgenden Aktionen werden von Amazon Kinesis Video WebRTC Storage unterstützt:
+ [JoinStorageSession](API_webrtc_JoinStorageSession.md)
+ [JoinStorageSessionAsViewer](API_webrtc_JoinStorageSessionAsViewer.md)
# JoinStorageSession
**Anmerkung**
Bevor Sie diese API verwenden, müssen Sie die `GetSignalingChannelEndpoint` API aufrufen, um den WEBRTC-Endpunkt anzufordern. Anschließend geben Sie den Endpunkt und die Region in Ihrer `JoinStorageSession` API-Anfrage an.
Nehmen Sie an der laufenden WebRTC-Sitzung mit Einwegvideo und and/or Mehrwege-Audio als Videoproduktionsgerät für einen Eingangskanal teil. Wenn es keine bestehende Sitzung für den Kanal gibt, erstellen Sie eine neue Streaming-Sitzung und geben Sie den Amazon-Ressourcennamen (ARN) des Signalisierungskanals an.
Derzeit kann ein Videoproduktionsgerät für diesen `SINGLE_MASTER` Typ sowohl Audio- als auch Videomedien in einen Stream aufnehmen. Nur Videoproduktionsgeräte können an der Sitzung teilnehmen und Medien aufnehmen.
**Wichtig**
Für die WebRTC-Aufnahme sind derzeit sowohl Audio- als auch Videospuren erforderlich.
Aktuelle Anforderungen:
Videospur: H.264
Audiospur: Opus
Video:
Die maximale Auflösung ist SQFHD (1920x1920)
KVS WebRTC Ingestion unterstützt derzeit einen bestimmten Satz von H264-Profilen:
eingeschränkte Basislinie
Baseline
Haupt
high
eingeschränkt-hoch
progressiv-hoch
Das resultierende aufgenommene Video im Kinesis-Videostream hat die folgenden Parameter: H.264-Video und AAC-Audio.
Sobald ein Master-Teilnehmer eine Verbindung über WebRTC ausgehandelt hat, wird die aufgenommene Mediensitzung im Kinesis-Videostream gespeichert. Über unser Playback können dann mehrere Zuschauer Medien in Echtzeit wiedergeben. APIs
Sie können auch vorhandene Kinesis Video Streams Streams-Funktionen wie `HLS` `DASH` OD-Wiedergabe, Bilderzeugung über [GetImages](https://docs.aws.amazon.com/kinesisvideostreams/latest/dg/gs-getImages.html)und mehr mit aufgenommenen WebRTC-Medien verwenden.
**Anmerkung**
Die Bereitstellung von S3-Bildern und Benachrichtigungen werden derzeit nicht unterstützt.
**Anmerkung**
Gehen Sie davon aus, dass einer Sitzung für den Kanal nur ein Client für ein Videoproduktionsgerät zugeordnet werden kann. Wenn mehr als ein Client der Sitzung eines bestimmten Kanals als Videoproduktionsgerät beitritt, hat die neueste Client-Anfrage Vorrang.
**Zusätzliche Informationen**
+ **Idempotent — Diese API ist nicht idempotent**.
+ **Wiederholungsverhalten** — Dies wird als neuer API-Aufruf gezählt.
+ **Gleichzeitige Aufrufe** — Gleichzeitige Aufrufe sind zulässig. Pro Anruf wird einmal ein Angebot gesendet.
## Anforderungssyntax
```
POST /joinStorageSession HTTP/1.1
Content-type: application/json
{
"channelArn": "string"
}
```
## URI-Anfrageparameter
Die Anforderung verwendet keine URI-Parameter.
## Anforderungstext
Die Anforderung akzeptiert die folgenden Daten im JSON-Format.
** [channelArn](#API_webrtc_JoinStorageSession_RequestSyntax) **
Der Amazon-Ressourcenname (ARN) des Signalisierungskanals.
Beachten Sie die Großschreibung dieses Eingabeparameters.
Typ: Zeichenfolge
Pattern: `arn:(aws[a-zA-Z-]*):kinesisvideo:[a-z0-9-]+:[0-9]+:[a-z]+/[a-zA-Z0-9_.-]+/[0-9]+`
Erforderlich: Ja
## Antwortsyntax
```
HTTP/1.1 200
```
## Antwortelemente
Wenn die Aktion erfolgreich ist, gibt der Dienst eine HTTP 200-Antwort mit leerem HTTP-Textinhalt zurück.
## Fehler
Weitere Informationen zu den allgemeinen Fehlern, die bei allen Aktionen zurückgegeben werden, finden Sie unter [Häufige Fehlertypen](CommonErrors.md).
** AccessDeniedException **
Sie verfügen nicht über die erforderlichen Berechtigungen, um diesen Vorgang auszuführen.
HTTP-Statuscode: 403
** ClientLimitExceededException **
Kinesis Video Streams hat die Anfrage gedrosselt, weil Sie das Limit der erlaubten Client-Aufrufe überschritten haben. Versuchen Sie später, den Anruf zu tätigen.
HTTP-Statuscode: 400
** InvalidArgumentException **
Der Wert für diesen Eingabeparameter ist ungültig.
HTTP-Statuscode: 400
** ResourceNotFoundException **
Die angegebene Ressource wurde nicht gefunden.
HTTP-Statuscode: 404
## Weitere Informationen finden Sie unter:
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-webrtc-storage-2018-05-10/JoinStorageSession)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/kinesis-video-webrtc-storage-2018-05-10/JoinStorageSession)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/kinesis-video-webrtc-storage-2018-05-10/JoinStorageSession)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/kinesis-video-webrtc-storage-2018-05-10/JoinStorageSession)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/kinesis-video-webrtc-storage-2018-05-10/JoinStorageSession)
+ [AWS SDK für JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/kinesis-video-webrtc-storage-2018-05-10/JoinStorageSession)
+ [AWS SDK für Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/kinesis-video-webrtc-storage-2018-05-10/JoinStorageSession)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/kinesis-video-webrtc-storage-2018-05-10/JoinStorageSession)
+ [AWS SDK für Python](https://docs.aws.amazon.com/goto/boto3/kinesis-video-webrtc-storage-2018-05-10/JoinStorageSession)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/kinesis-video-webrtc-storage-2018-05-10/JoinStorageSession)
# JoinStorageSessionAsViewer
**Anmerkung**
Bevor Sie diese API verwenden, müssen Sie die `GetSignalingChannelEndpoint` API aufrufen, um den WEBRTC-Endpunkt anzufordern. Anschließend geben Sie den Endpunkt und die Region in Ihrer `JoinStorageSessionAsViewer` API-Anfrage an.
`JoinStorageSessionAsViewer`ermöglicht es einem Zuschauer, an einer laufenden, in der Cloud aufgezeichneten WebRTC-Streaming-Sitzung teilzunehmen. Diese API initiiert eine WebRTC-Verbindung, indem sie ein SDP-Angebot und ICE-Kandidaten zwischen dem Zuschauer und dem Aufzeichnungsagenten sendet, sodass der Zuschauer Echtzeitvideos vom Master über den Aufzeichnungsagenten empfangen und an der bidirektionalen Audiokommunikation über den Aufzeichnungsagenten teilnehmen kann. Sobald die Verbindung hergestellt ist, wird das Audio des Zuschauers, sofern bereitgestellt, an alle anderen verbundenen Peers, einschließlich des Master-Teilnehmers, weitergeleitet und in den WebRTC-Stream integriert, der im Kinesis Video-Stream gespeichert wird.
**Wichtig**
Zuschauer können derzeit keine Videotracks senden. Zuschauer können eine optionale Audiospur oder gar keine Titel senden.
Aktuelle Anforderungen für das Senden von Zuschauern und Teilnehmern:
Videotrack: Nicht unterstützt
Audiospur (optional): Opus
Wenn der Master-Teilnehmer derzeit mit dem Videoproduktionsgerät verbunden ist, hat das resultierende aufgenommene Video im Kinesis-Videostream die folgenden Parameter: H.264-Video und AAC-Audio.
**Anmerkung**
Die Viewer-Teilnehmer stellen direkt eine Verbindung zur Speichersitzung her und nicht direkt mit dem Master-Teilnehmer. Die Speichersitzung kümmert sich um das Mischen, Duplizieren und Weiterleiten der Medien an das entsprechende Ziel.
**Anmerkung**
Wenn der Master-Teilnehmer nicht anwesend ist, können sich die Zuschauer nicht gegenseitig hören.
Sobald der Zuschauer-Teilnehmer eine Verbindung über WebRTC ausgehandelt hat, wird die aufgenommene Audiositzung im Kinesis-Videostream gespeichert, solange der Master-Teilnehmer auch mit der Speichersitzung verbunden ist.
Sie können auch vorhandene Kinesis Video Streams Streams-Funktionen wie `HLS` `DASH` OD-Wiedergabe, Bilderzeugung über [GetImages](https://docs.aws.amazon.com/kinesisvideostreams/latest/dg/gs-getImages.html)und mehr mit aufgenommenen WebRTC-Medien verwenden.
**Anmerkung**
Die Bereitstellung von S3-Bildern und Benachrichtigungen werden derzeit nicht unterstützt.
**Anmerkung**
Gehen Sie davon aus, dass einer Sitzung für den Kanal nur ein Client für ein Videoproduktionsgerät zugeordnet werden kann. Wenn mehr als ein Client der Sitzung eines bestimmten Kanals als Videoproduktionsgerät beitritt, hat die neueste Client-Anfrage Vorrang.
**Beschränkungen**
Die aktuellen Grenzwerte gelten:
+ **Maximale Anzahl von Zuschauern:** 3
+ **Maximale Zeit, für die Zuschauerteilnehmer mit der Speichersitzung verbunden bleiben, ohne dass ein Master-Teilnehmer anwesend ist:** 3 Minuten
**Wichtig**
Wenn ein Zuschauer die Verbindung zur Speichersitzung trennt (die Peer-Verbindung schließt), bleibt sein Kontingent (Zuschauerlimit) 1 Minute lang verbraucht. Während dieses Zeitraums von einer Minute kann der Zuschauer diese API mit derselben Client-ID aufrufen, um wieder an der Sitzung teilzunehmen, ohne ein zusätzliches Zuschauerkontingent zu verbrauchen. Nach 1 Minute wird das Zuschauerkontingent freigegeben und steht anderen Zuschauern zur Teilnahme zur Verfügung.
**Zusätzliche Informationen**
+ **Idempotent** — Diese API ist nicht idempotent.
+ **Wiederholungsverhalten** — Dies wird als neuer API-Aufruf gezählt.
+ **Gleichzeitige Aufrufe** — Gleichzeitige Aufrufe sind zulässig. Pro Anruf wird einmal ein Angebot gesendet.
## Anforderungssyntax
```
POST /joinStorageSessionAsViewer HTTP/1.1
Content-type: application/json
{
"channelArn": "string",
"clientId": "string"
}
```
## URI-Anfrageparameter
Die Anforderung verwendet keine URI-Parameter.
## Anforderungstext
Die Anforderung akzeptiert die folgenden Daten im JSON-Format.
** [channelArn](#API_webrtc_JoinStorageSessionAsViewer_RequestSyntax) **
Der Amazon-Ressourcenname (ARN) des Signalisierungskanals.
Beachten Sie die Großschreibung dieses Eingabeparameters.
Typ: Zeichenfolge
Pattern: `arn:(aws[a-zA-Z-]*):kinesisvideo:[a-z0-9-]+:[0-9]+:[a-z]+/[a-zA-Z0-9_.-]+/[0-9]+`
Erforderlich: Ja
** [clientId](#API_webrtc_JoinStorageSessionAsViewer_RequestSyntax) **
Die eindeutige Kennung für den Absender-Client.
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: Ja
## Antwortsyntax
```
HTTP/1.1 200
```
## Antwortelemente
Wenn die Aktion erfolgreich ist, gibt der Dienst eine HTTP 200-Antwort mit leerem HTTP-Textinhalt zurück.
## Fehler
Weitere Informationen zu den allgemeinen Fehlern, die bei allen Aktionen zurückgegeben werden, finden Sie unter [Häufige Fehlertypen](CommonErrors.md).
** AccessDeniedException **
Sie verfügen nicht über die erforderlichen Berechtigungen, um diesen Vorgang auszuführen.
HTTP-Statuscode: 403
** ClientLimitExceededException **
Kinesis Video Streams hat die Anfrage gedrosselt, weil Sie das Limit der erlaubten Client-Aufrufe überschritten haben. Versuchen Sie später, den Anruf zu tätigen.
HTTP-Statuscode: 400
** InvalidArgumentException **
Der Wert für diesen Eingabeparameter ist ungültig.
HTTP-Statuscode: 400
** ResourceNotFoundException **
Die angegebene Ressource wurde nicht gefunden.
HTTP-Statuscode: 404
## Weitere Informationen finden Sie unter:
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-webrtc-storage-2018-05-10/JoinStorageSessionAsViewer)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/kinesis-video-webrtc-storage-2018-05-10/JoinStorageSessionAsViewer)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/kinesis-video-webrtc-storage-2018-05-10/JoinStorageSessionAsViewer)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/kinesis-video-webrtc-storage-2018-05-10/JoinStorageSessionAsViewer)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/kinesis-video-webrtc-storage-2018-05-10/JoinStorageSessionAsViewer)
+ [AWS SDK für JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/kinesis-video-webrtc-storage-2018-05-10/JoinStorageSessionAsViewer)
+ [AWS SDK für Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/kinesis-video-webrtc-storage-2018-05-10/JoinStorageSessionAsViewer)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/kinesis-video-webrtc-storage-2018-05-10/JoinStorageSessionAsViewer)
+ [AWS SDK für Python](https://docs.aws.amazon.com/goto/boto3/kinesis-video-webrtc-storage-2018-05-10/JoinStorageSessionAsViewer)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/kinesis-video-webrtc-storage-2018-05-10/JoinStorageSessionAsViewer)