Beispiele für die Verwendung der AWS CLI mit Amazon-IVS-Streaming in Echtzeit - AWS Command Line Interface

Beispiele für die Verwendung der AWS CLI mit Amazon-IVS-Streaming in Echtzeit

Die folgenden Codebeispiele zeigen, wie Sie Aktionen durchführen und gängige Szenarien implementieren, indem Sie die AWS Command Line Interface mit Amazon-IVS-Streaming in Echtzeit verwenden.

Aktionen sind Codeauszüge aus größeren Programmen und müssen im Kontext ausgeführt werden. Während Aktionen Ihnen zeigen, wie Sie einzelne Service-Funktionen aufrufen, können Sie Aktionen im Kontext der zugehörigen Szenarien anzeigen.

Jedes Beispiel enthält einen Link zum vollständigen Quellcode, wo Sie Anleitungen zum Einrichten und Ausführen des Codes im Kontext finden.

Themen

Aktionen

Das folgende Codebeispiel zeigt, wie create-encoder-configuration verwendet wird.

AWS CLI

So erstellen Sie eine Encoder-Konfiguration einer Komposition

Im folgenden create-encoder-configuration-Beispiel wird eine Encoder-Konfiguration für eine Komposition mit den angegebenen Eigenschaften erstellt.

aws ivs-realtime create-encoder-configuration \ --name test-ec --video bitrate=3500000,framerate=30.0,height=1080,width=1920

Ausgabe:

{ "encoderConfiguration": { "arn": "arn:aws:ivs:ap-northeast-1:123456789012:encoder-configuration/ABabCDcdEFef", "name": "test-ec", "tags": {}, "video": { "bitrate": 3500000, "framerate": 30, "height": 1080, "width": 1920 } } }

Weitere Informationen finden Sie unter Aktivieren mehrerer Hosts in einem Amazon-IVS-Stream im Benutzerhandbuch zu Amazon Interactive Video Service.

Das folgende Codebeispiel zeigt, wie create-ingest-configuration verwendet wird.

AWS CLI

So erstellen Sie eine Erfassungskonfiguration

Im folgenden create-ingest-configuration-Beispiel wird eine Erfassungskonfiguration mithilfe des RTMPS-Protokolls erstellt.

aws ivs-realtime create-ingest-configuration \ --name ingest1 \ --ingest-protocol rtmps

Ausgabe:

{ "ingestConfiguration": { "name": "ingest1", "arn": "arn:aws:ivs:us-west-2:123456789012:ingest-configuration/AbCdEfGh1234", "ingestProtocol": "RTMPS", "streamKey": "rt_123456789012_us-west-2_AbCdEfGh1234_abcd1234efgh5678ijkl9012MNOP34", "stageArn": "", "participantId": "xyZ654abC321", "state": "INACTIVE", "userId": "", "tags": {} } }

Weitere Informationen finden Sie unter IVS-Streamerfassung | Echtzeit-Streaming im Benutzerhandbuch zu Amazon Interactive Video Service.

Das folgende Codebeispiel zeigt, wie create-participant-token verwendet wird.

AWS CLI

So erstellen Sie ein Stufen-Teilnehmer-Token

Im folgenden create-participant-token-Beispiel wird ein Teilnehmer-Token für die angegebene Stufe erstellt.

aws ivs-realtime create-participant-token \ --stage-arn arn:aws:ivs:us-west-2:123456789012:stage/abcdABCDefgh \ --user-id bob

Ausgabe:

{ "participantToken": { "expirationTime": "2023-03-07T09:47:43+00:00", "participantId": "ABCDEfghij01234KLMN6789", "token": "abcd1234defg5678" } }

Weitere Informationen finden Sie unter Aktivieren mehrerer Hosts in einem Amazon-IVS-Stream im Benutzerhandbuch zu Amazon Interactive Video Service.

Das folgende Codebeispiel zeigt, wie create-stage verwendet wird.

AWS CLI

Beispiel 1: So erstellen Sie eine Stufe

Im folgenden create-stage-Beispiel wird ein Token für Stufe und Stufenteilnehmer für einen angegebenen Benutzer erstellt.

aws ivs-realtime create-stage \ --name stage1 \ --participant-token-configurations userId=alice

Ausgabe:

{ "participantTokens": [ { "participantId": "ABCDEfghij01234KLMN5678", "token": "a1b2c3d4567890ab", "userId": "alice" } ], "stage": { "activeSessionId": "st-a1b2c3d4e5f6g", "arn": "arn:aws:ivs:us-west-2:123456789012:stage/abcdABCDefgh", "autoParticipantRecordingConfiguration": { "storageConfigurationArn": "", "mediaTypes": [ "AUDIO_VIDEO" ], "thumbnailConfiguration": { "targetIntervalSeconds": 60, "storage": [ "SEQUENTIAL" ], "recordingMode": "DISABLED" }, "recordingReconnectWindowSeconds": 0, "hlsConfiguration": { "targetSegmentDurationSeconds": 6 }, "recordParticipantReplicas": true }, "endpoints": { "events": "wss://global.events.live-video.net", "rtmp": "rtmp://9x0y8z7s6t5u.global-contribute-staging.live-video.net/app/", "rtmps": "rtmps://9x0y8z7s6t5u.global-contribute-staging.live-video.net:443/app/", "whip": "https://9x0y8z7s6t5u.global-bm.whip.live-video.net" }, "name": "stage1", "tags": {} } }

Weitere Informationen finden Sie unter Aktivieren mehrerer Hosts in einem Amazon-IVS-Stream im Benutzerhandbuch zu Amazon-IVS-Streaming mit niedriger Latenz.

Beispiel 2: So erstellen Sie eine Stufe und konfigurieren die Aufzeichnung einzelner Teilnehmer

Im folgenden create-stage-Beispiel wird eine Stufe erstellt und die Aufzeichnung einzelner Teilnehmer konfiguriert.

aws ivs-realtime create-stage \ --name stage1 \ --auto-participant-recording-configuration '{"mediaTypes": ["AUDIO_VIDEO"],"storageConfigurationArn": "arn:aws:ivs:us-west-2:123456789012:storage-configuration/abcdABCDefgh", "recordingReconnectWindowSeconds": 100, \ "hlsConfiguration": {"targetSegmentDurationSeconds": 5}}'

Ausgabe:

{ "stage": { "activeSessionId": "st-a1b2c3d4e5f6g", "arn": "arn:aws:ivs:us-west-2:123456789012:stage/abcdABCDefgh", "autoParticipantRecordingConfiguration": { "storageConfigurationArn": "arn:aws:ivs:us-west-2:123456789012:storage-configuration/abcdABCDefgh" "mediaTypes": [ "AUDIO_VIDEO" ], "thumbnailConfiguration": { "targetIntervalSeconds": 60, "storage": [ "SEQUENTIAL" ], "recordingMode": "DISABLED" }, "recordingReconnectWindowSeconds": 100, "hlsConfiguration": { "targetSegmentDurationSeconds": 5 }, "recordParticipantReplicas": true }, "endpoints": { "events": "wss://global.events.live-video.net", "rtmp": "rtmp://9x0y8z7s6t5u.global-contribute-staging.live-video.net/app/", "rtmps": "rtmps://9x0y8z7s6t5u.global-contribute-staging.live-video.net:443/app/", "whip": "https://9x0y8z7s6t5u.global-bm.whip.live-video.net" }, "name": "stage1", "tags": {} } }

Weitere Informationen finden Sie unter Aktivieren mehrerer Hosts in einem Amazon-IVS-Stream im Benutzerhandbuch zu Amazon-IVS-Streaming mit niedriger Latenz.

Beispiel 3: So erstellen Sie eine Stufe und konfigurieren die Aufzeichnung einzelner Teilnehmer mit aktivierter Thumbnail-Aufzeichnung

Im folgenden create-stage-Beispiel wird eine Stufe erstellt und die Aufzeichnung einzelner Teilnehmer mit aktivierter Thumbnail-Aufzeichnung konfiguriert.

aws ivs-realtime create-stage \ --name stage1 \ --auto-participant-recording-configuration '{"mediaTypes": ["AUDIO_VIDEO"],"storageConfigurationArn": "arn:aws:ivs:us-west-2:123456789012:storage-configuration/abcdABCDefgh", \ "thumbnailConfiguration": {"recordingMode": "INTERVAL","storage": ["SEQUENTIAL"],"targetIntervalSeconds": 60}}'

Ausgabe:

{ "stage": { "activeSessionId": "st-a1b2c3d4e5f6g", "arn": "arn:aws:ivs:us-west-2:123456789012:stage/abcdABCDefgh", "autoParticipantRecordingConfiguration": { "storageConfigurationArn": "arn:aws:ivs:us-west-2:123456789012:storage-configuration/abcdABCDefgh", "mediaTypes": [ "AUDIO_VIDEO" ], "thumbnailConfiguration": { "targetIntervalSeconds": 60, "storage": [ "SEQUENTIAL" ], "recordingMode": "INTERVAL" }, "recordingReconnectWindowSeconds": 0, "hlsConfiguration": { "targetSegmentDurationSeconds": 6 }, "recordParticipantReplicas": true }, "endpoints": { "events": "wss://global.events.live-video.net", "rtmp": "rtmp://9x0y8z7s6t5u.global-contribute-staging.live-video.net/app/", "rtmps": "rtmps://9x0y8z7s6t5u.global-contribute-staging.live-video.net:443/app/", "whip": "https://9x0y8z7s6t5u.global-bm.whip.live-video.net" }, "name": "stage1", "tags": {} } }

Weitere Informationen finden Sie unter Aktivieren mehrerer Hosts in einem Amazon-IVS-Stream im Benutzerhandbuch zu Amazon-IVS-Streaming mit niedriger Latenz.

  • API-Details finden Sie unter CreateStage in der AWS CLI-Befehlsreferenz.

Das folgende Codebeispiel zeigt, wie create-storage-configuration verwendet wird.

AWS CLI

So erstellen Sie eine Speicherkonfiguration für eine Komposition

Im folgenden create-storage-configuration-Beispiel wird eine Speicherkonfiguration für eine Komposition mit den angegebenen Eigenschaften erstellt.

aws ivs-realtime create-storage-configuration \ --name "test-sc" --s3 "bucketName=amzn-s3-demo-bucket"

Ausgabe:

{ "storageConfiguration": { "arn": "arn:aws:ivs:ap-northeast-1:123456789012:storage-configuration/ABabCDcdEFef", "name": "test-sc", "s3": { "bucketName": "amzn-s3-demo-bucket" }, "tags": {} } }

Weitere Informationen finden Sie unter Aktivieren mehrerer Hosts in einem Amazon-IVS-Stream im Benutzerhandbuch zu Amazon Interactive Video Service.

Das folgende Codebeispiel zeigt, wie delete-encoder-configuration verwendet wird.

AWS CLI

So löschen Sie eine Encoder-Konfiguration für eine Komposition

Im folgenden delete-encoder-configuration-Beispiel wird die durch den angegebenen ARN (Amazon Resource Name) festgelegte Encoder-Konfiguration für die Komposition gelöscht.

aws ivs-realtime delete-encoder-configuration \ --arn "arn:aws:ivs:ap-northeast-1:123456789012:encoder-configuration/ABabCDcdEFef"

Mit diesem Befehl wird keine Ausgabe zurückgegeben.

Weitere Informationen finden Sie unter Aktivieren mehrerer Hosts in einem Amazon-IVS-Stream im Benutzerhandbuch zu Amazon Interactive Video Service.

Das folgende Codebeispiel zeigt, wie delete-ingest-configuration verwendet wird.

AWS CLI

Beispiel 1: So löschen Sie eine inaktive Erfassungskonfiguration

Im folgenden delete-ingest-configuration-Beispiel wird die inaktive Erfassungskonfiguration für einen angegebenen ARN (Amazon Resource Name) einer Erfassungskonfiguration gelöscht.

aws ivs-realtime delete-ingest-configuration \ --arn arn:aws:ivs:us-west-2:123456789012:ingest-configuration/AbCdEfGh1234

Mit diesem Befehl wird keine Ausgabe zurückgegeben.

Weitere Informationen finden Sie unter IVS-Streamerfassung | Echtzeit-Streaming im Benutzerhandbuch zu Amazon Interactive Video Service.

Beispiel 2: So erzwingen Sie das Löschen einer aktiven Erfassungskonfiguration

Im folgenden delete-ingest-configuration-Beispiel wird die Löschung der aktiven Erfassungskonfiguration für einen angegebenen ARN (Amazon Resource Name) einer Erfassungskonfiguration erzwungen.

aws ivs-realtime delete-ingest-configuration \ --arn arn:aws:ivs:us-west-2:123456789012:ingest-configuration/AbCdEfGh1234 \ --force

Mit diesem Befehl wird keine Ausgabe zurückgegeben.

Weitere Informationen finden Sie unter IVS-Streamerfassung | Echtzeit-Streaming im Benutzerhandbuch zu Amazon Interactive Video Service.

Das folgende Codebeispiel zeigt, wie delete-public-key verwendet wird.

AWS CLI

So löschen Sie einen öffentlichen Schlüssel

Im folgenden delete-public-key-Beispiel wird der angegebene öffentliche Schlüssel gelöscht.

aws ivs-realtime delete-public-key \ --arn arn:aws:ivs:us-west-2:123456789012:public-key/abcdABC1efg2

Mit diesem Befehl wird keine Ausgabe zurückgegeben.

Weitere Informationen finden Sie unter Verteilen von Teilnehmertoken im Benutzerhandbuch zu Amazon-IVS-Streaming in Echtzeit.

  • API-Details finden Sie unter DeletePublicKey in der AWS CLI-Befehlsreferenz.

Das folgende Codebeispiel zeigt, wie delete-stage verwendet wird.

AWS CLI

So löschen Sie eine Stufe

Im folgenden delete-stage-Beispiel wird die angegebene Stufe gelöscht.

aws ivs-realtime delete-stage \ --arn arn:aws:ivs:us-west-2:123456789012:stage/abcdABCDefgh

Mit diesem Befehl wird keine Ausgabe zurückgegeben.

Weitere Informationen finden Sie unter Aktivieren mehrerer Hosts in einem Amazon-IVS-Stream im Benutzerhandbuch zu Amazon Interactive Video Service.

  • API-Details finden Sie unter DeleteStage in der AWS CLI-Befehlsreferenz.

Das folgende Codebeispiel zeigt, wie delete-storage-configuration verwendet wird.

AWS CLI

So löschen Sie eine Speicherkonfiguration für eine Komposition

Im folgenden delete-storage-configuration-Beispiel wird die durch den angegebenen ARN (Amazon Resource Name) festgelegte Speicherkonfiguration für die Komposition gelöscht.

aws ivs-realtime delete-storage-configuration \ --arn "arn:aws:ivs:ap-northeast-1:123456789012:storage-configuration/ABabCDcdEFef"

Mit diesem Befehl wird keine Ausgabe zurückgegeben.

Weitere Informationen finden Sie unter Aktivieren mehrerer Hosts in einem Amazon-IVS-Stream im Benutzerhandbuch zu Amazon Interactive Video Service.

Das folgende Codebeispiel zeigt, wie disconnect-participant verwendet wird.

AWS CLI

So trennen Sie einen Stufenteilnehmer

Im folgenden disconnect-participant-Beispiel wird der angegebene Teilnehmer von der angegebenen Stufe getrennt.

aws ivs-realtime disconnect-participant \ --stage-arn arn:aws:ivs:us-west-2:123456789012:stage/abcdABCDefgh \ --participant-id ABCDEfghij01234KLMN5678

Mit diesem Befehl wird keine Ausgabe zurückgegeben.

Weitere Informationen finden Sie unter Aktivieren mehrerer Hosts in einem Amazon-IVS-Stream im Benutzerhandbuch zu Amazon Interactive Video Service.

Das folgende Codebeispiel zeigt, wie get-composition verwendet wird.

AWS CLI

Beispiel 1: So rufen Sie eine Komposition mit Standard-Layouteinstellungen ab

Im folgenden get-composition-Beispiel wird die Komposition für den angegebenen ARN (Amazon Resource Name) abgerufen.

aws ivs-realtime get-composition \ --arn "arn:aws:ivs:ap-northeast-1:123456789012:composition/abcdABCDefgh"

Ausgabe:

{ "composition": { "arn": "arn:aws:ivs:ap-northeast-1:123456789012:composition/abcdABCDefgh", "destinations": [ { "configuration": { "channel": { "channelArn": "arn:aws:ivs:ap-northeast-1:123456789012:channel/abcABCdefDEg", "encoderConfigurationArn": "arn:aws:ivs:ap-northeast-1:123456789012:encoder-configuration/ABabCDcdEFef" }, "name": "" }, "id": "AabBCcdDEefF", "startTime": "2023-10-16T23:26:00+00:00", "state": "ACTIVE" }, { "configuration": { "name": "", "s3": { "encoderConfigurationArns": [ "arn:aws:ivs:arn:aws:ivs:ap-northeast-1:123456789012:encoder-configuration/ABabCDcdEFef" ], "recordingConfiguration": { "format": "HLS", "hlsConfiguration": { "targetSegmentDurationSeconds": 2 } }, "storageConfigurationArn": "arn:arn:aws:ivs:ap-northeast-1:123456789012:storage-configuration/FefABabCDcdE", } }, "detail": { "s3": { "recordingPrefix": "aBcDeFgHhGfE/AbCdEfGhHgFe/GHFabcgefABC/composite" } }, "id": "GHFabcgefABC", "startTime": "2023-10-16T23:26:00+00:00", "state": "STARTING" } ], "layout": { "grid": { "featuredParticipantAttribute": "" "gridGap": 2, "omitStoppedVideo": false, "videoAspectRatio": "VIDEO", "videoFillMode": "" } }, "stageArn": "arn:aws:ivs:ap-northeast-1:123456789012:stage/defgABCDabcd", "startTime": "2023-10-16T23:24:00+00:00", "state": "ACTIVE", "tags": {} } }

Weitere Informationen finden Sie unter Zusammengesetzte Aufzeichnung | Echtzeit-Streaming im Benutzerhandbuch zu Amazon-IVS-Streaming in Echtzeit.

Beispiel 2: So rufen Sie eine Komposition mit PiP-Layout ab

Im folgenden get-composition-Beispiel wird die Komposition für den angegebenen ARN (Amazon Resource Name) abgerufen, die das PiP-Layout verwendet.

aws ivs-realtime get-composition \ --arn "arn:aws:ivs:ap-northeast-1:123456789012:composition/wxyzWXYZpqrs"

Ausgabe:

{ "composition": { "arn": "arn:aws:ivs:ap-northeast-1:123456789012:composition/wxyzWXYZpqrs", "destinations": [ { "configuration": { "channel": { "channelArn": "arn:aws:ivs:ap-northeast-1:123456789012:channel/abcABCdefDEg", "encoderConfigurationArn": "arn:aws:ivs:ap-northeast-1:123456789012:encoder-configuration/ABabCDcdEFef" }, "name": "" }, "id": "AabBCcdDEefF", "startTime": "2023-10-16T23:26:00+00:00", "state": "ACTIVE" }, { "configuration": { "name": "", "s3": { "encoderConfigurationArns": [ "arn:aws:ivs:arn:aws:ivs:ap-northeast-1:123456789012:encoder-configuration/ABabCDcdEFef" ], "recordingConfiguration": { "format": "HLS", "hlsConfiguration": { "targetSegmentDurationSeconds": 2 } }, "storageConfigurationArn": "arn:arn:aws:ivs:ap-northeast-1:123456789012:storage-configuration/FefABabCDcdE" } }, "detail": { "s3": { "recordingPrefix": "aBcDeFgHhGfE/AbCdEfGhHgFe/GHFabcgefABC/composite" } }, "id": "GHFabcgefABC", "startTime": "2023-10-16T23:26:00+00:00", "state": "STARTING" } ], "layout": { "pip": { "featuredParticipantAttribute": "abcdefg", "gridGap": 0, "omitStoppedVideo": false, "pipBehavior": "STATIC", "pipOffset": 0, "pipParticipantAttribute": "", "pipPosition": "BOTTOM_RIGHT", "videoFillMode": "COVER" } }, "stageArn": "arn:aws:ivs:ap-northeast-1:123456789012:stage/defgABCDabcd", "startTime": "2023-10-16T23:24:00+00:00", "state": "ACTIVE", "tags": {} } }

Weitere Informationen finden Sie unter Zusammengesetzte Aufzeichnung | Echtzeit-Streaming im Benutzerhandbuch zu Amazon-IVS-Streaming in Echtzeit.

Beispiel 3: So rufen Sie eine Komposition mit aktivierter Thumbnail-Aufzeichnung ab

Im folgenden get-composition-Beispiel wird die Komposition für den angegebenen ARN (Amazon Resource Name) abgerufen, bei dem die Thumbnail-Erfassung über die Standardeinstellungen aktiviert ist.

aws ivs-realtime get-composition \ --arn "arn:aws:ivs:ap-northeast-1:123456789012:composition/abcdABCDefgh"

Ausgabe:

{ "composition": { "arn": "arn:aws:ivs:ap-northeast-1:123456789012:composition/abcdABCDefgh", "destinations": [ { "configuration": { "channel": { "channelArn": "arn:aws:ivs:ap-northeast-1:123456789012:channel/abcABCdefDEg", "encoderConfigurationArn": "arn:aws:ivs:ap-northeast-1:123456789012:encoder-configuration/ABabCDcdEFef" }, "name": "" }, "id": "AabBCcdDEefF", "startTime": "2023-10-16T23:26:00+00:00", "state": "ACTIVE" }, { "configuration": { "name": "", "s3": { "encoderConfigurationArns": [ "arn:aws:ivs:arn:aws:ivs:ap-northeast-1:123456789012:encoder-configuration/ABabCDcdEFef" ], "recordingConfiguration": { "format": "HLS", "hlsConfiguration": { "targetSegmentDurationSeconds": 2 } }, "storageConfigurationArn": "arn:arn:aws:ivs:ap-northeast-1:123456789012:storage-configuration/FefABabCDcdE", "thumbnailConfigurations": [ { "targetIntervalSeconds": 60, "storage": [ "SEQUENTIAL" ], } ] } }, "detail": { "s3": { "recordingPrefix": "aBcDeFgHhGfE/AbCdEfGhHgFe/GHFabcgefABC/composite" } }, "id": "GHFabcgefABC", "startTime": "2023-10-16T23:26:00+00:00", "state": "STARTING" } ], "layout": { "grid": { "featuredParticipantAttribute": "" "gridGap": 2, "omitStoppedVideo": false, "videoAspectRatio": "VIDEO", "videoFillMode": "" } }, "stageArn": "arn:aws:ivs:ap-northeast-1:123456789012:stage/defgABCDabcd", "startTime": "2023-10-16T23:24:00+00:00", "state": "ACTIVE", "tags": {} } }

Weitere Informationen finden Sie unter Zusammengesetzte Aufzeichnung | Echtzeit-Streaming im Benutzerhandbuch zu Amazon-IVS-Streaming in Echtzeit.

  • API-Details finden Sie unter GetComposition in der AWS CLI-Befehlsreferenz.

Das folgende Codebeispiel zeigt, wie get-encoder-configuration verwendet wird.

AWS CLI

So rufen Sie die Encoder-Konfiguration für eine Komposition ab

Im folgenden get-encoder-configuration-Beispiel wird die durch den angegebenen ARN (Amazon Resource Name) festgelegte Encoder-Konfiguration für die Komposition abgerufen.

aws ivs-realtime get-encoder-configuration \ --arn "arn:aws:ivs:ap-northeast-1:123456789012:encoder-configuration/abcdABCDefgh"

Ausgabe:

{ "encoderConfiguration": { "arn": "arn:aws:ivs:ap-northeast-1:123456789012:encoder-configuration/abcdABCDefgh", "name": "test-ec", "tags": {}, "video": { "bitrate": 3500000, "framerate": 30, "height": 1080, "width": 1920 } } }

Weitere Informationen finden Sie unter Aktivieren mehrerer Hosts in einem Amazon-IVS-Stream im Benutzerhandbuch zu Amazon Interactive Video Service.

Das folgende Codebeispiel zeigt, wie get-ingest-configuration verwendet wird.

AWS CLI

So rufen Sie Informationen zur Erfassungskonfiguration ab

Im folgenden get-ingest-configuration-Beispiel wird die Erfassungskonfiguration für einen angegebenen ARN (Amazon Resource Name) einer Erfassungskonfiguration abgerufen.

aws ivs-realtime get-ingest-configuration \ --arn arn:aws:ivs:us-west-2:123456789012:ingest-configuration/AbCdEfGh1234

Ausgabe:

{ "ingestConfiguration": { "name": "ingest1", "arn": "arn:aws:ivs:us-west-2:123456789012:ingest-configuration/AbCdEfGh1234", "ingestProtocol": "RTMPS", "streamKey": "rt_123456789012_us-west-2_AbCdEfGh1234_abcd1234efgh5678ijkl9012MNOP34", "stageArn": "", "participantId": "xyZ654abC321", "state": "INACTIVE", "userId": "", "tags": {} } }

Weitere Informationen finden Sie unter IVS-Streamerfassung | Echtzeit-Streaming im Benutzerhandbuch zu Amazon Interactive Video Service.

Das folgende Codebeispiel zeigt, wie get-participant verwendet wird.

AWS CLI

Beispiel 1: So rufen Sie einen Stufenteilnehmer ab

Im folgenden get-participant-Beispiel wird der Stufenteilnehmer für eine angegebene Teilnehmer-ID und Sitzungs-ID im angegebenen Stufen-ARN (Amazon Resource Name) abgerufen.

aws ivs-realtime get-participant \ --stage-arn arn:aws:ivs:us-west-2:123456789012:stage/abcdABCDefgh \ --session-id st-a1b2c3d4e5f6g \ --participant-id abCDEf12GHIj

Ausgabe:

{ "participant": { "browserName": "Google Chrome", "browserVersion": "116", "firstJoinTime": "2023-04-26T20:30:34+00:00", "ispName": "Comcast", "osName": "Microsoft Windows 10 Pro", "osVersion": "10.0.19044", "participantId": "abCDEf12GHIj", "published": true, "recordingS3BucketName": "bucket-name", "recordingS3Prefix": "abcdABCDefgh/st-a1b2c3d4e5f6g/abCDEf12GHIj/1234567890", "recordingState": "ACTIVE", "sdkVersion": "", "state": "CONNECTED", "userId": "" } }

Weitere Informationen finden Sie unter Aktivieren mehrerer Hosts in einem Amazon-IVS-Stream im Benutzerhandbuch zu Amazon-IVS-Streaming mit niedriger Latenz.

Beispiel 2: So rufen Sie einen Stufenteilnehmer ab, der auf eine andere Stufe repliziert wurde

Im folgenden get-participant-Beispiel wird der Stufenteilnehmer für eine angegebene Teilnehmer-ID und Sitzungs-ID im angegebenen Stufen-ARN (Amazon Resource Name) abgerufen, wenn der Teilnehmer auch auf eine andere Stufe repliziert wurde.

aws ivs-realtime get-participant \ --stage-arn arn:aws:ivs:us-west-2:123456789012:stage/abcdABCDefgh \ --session-id st-a1b2c3d4e5f6g \ --participant-id abCDEf12GHIj

Ausgabe:

{ "participant": { "browserName": "Google Chrome", "browserVersion": "116", "firstJoinTime": "2023-04-26T20:30:34+00:00", "ispName": "Comcast", "osName": "Microsoft Windows 10 Pro", "osVersion": "10.0.19044", "participantId": "abCDEf12GHIj", "published": true, "recordingS3BucketName": "bucket-name", "recordingS3Prefix": "abcdABCDefgh/st-a1b2c3d4e5f6g/abCDEf12GHIj/1234567890", "recordingState": "ACTIVE", "replicationState": "ACTIVE", "replicationType": "SOURCE", "sdkVersion": "", "state": "CONNECTED", "userId": "" } }

Weitere Informationen finden Sie unter Aktivieren mehrerer Hosts in einem Amazon-IVS-Stream im Benutzerhandbuch zu Amazon-IVS-Streaming mit niedriger Latenz.

Beispiel 3: So rufen Sie einen Stufenteilnehmer ab, der von einer anderen Stufe repliziert wurde

Im folgenden get-participant-Beispiel wird der Stufenteilnehmer für eine angegebene Teilnehmer-ID und Sitzungs-ID im angegebenen Stufen-ARN (Amazon Resource Name) abgerufen, wenn der Teilnehmer von einer anderen Stufe repliziert wurde.

aws ivs-realtime get-participant \ --stage-arn arn:aws:ivs:us-west-2:123456789012:stage/abcdABCDefgh \ --session-id st-a1b2c3d4e5f6g \ --participant-id abCDEf12GHIj

Ausgabe:

{ "participant": { "browserName": "Google Chrome", "browserVersion": "116", "firstJoinTime": "2023-04-26T20:30:34+00:00", "ispName": "Comcast", "osName": "Microsoft Windows 10 Pro", "osVersion": "10.0.19044", "participantId": "abCDEf12GHIj", "published": true, "recordingS3BucketName": "bucket-name", "recordingS3Prefix": "abcdABCDefgh/st-a1b2c3d4e5f6g/abCDEf12GHIj/1234567890", "recordingState": "ACTIVE", "replicationState": "ACTIVE", "replicationType": "REPLICA", "sdkVersion": "", "state": "CONNECTED", "userId": "" } }

Weitere Informationen finden Sie unter Aktivieren mehrerer Hosts in einem Amazon-IVS-Stream im Benutzerhandbuch zu Amazon-IVS-Streaming mit niedriger Latenz.

  • API-Details finden Sie unter GetParticipant in der AWS CLI-Befehlsreferenz.

Das folgende Codebeispiel zeigt, wie get-public-key verwendet wird.

AWS CLI

So rufen Sie einen vorhandenen öffentlichen Schlüssel ab, der zum Signieren von Stufenteilnehmer-Token verwendet wird

Im folgenden get-public-key-Beispiel wird ein durch den bereitgestellten ARN angegebener öffentlicher Schlüssel zum Signieren von Stufenteilnehmer-Token abgerufen.

aws ivs-realtime get-public-key \ --arn arn:aws:ivs:us-west-2:123456789012:public-key/abcdABC1efg2

Ausgabe:

{ "publicKey": { "arn": "arn:aws:ivs:us-west-2:123456789012:public-key/abcdABC1efg2", "name": "", "publicKeyMaterial": "-----BEGIN PUBLIC KEY-----\nMHYwEAYHKoZIzj0CAQYFK4EEACIDYgAEqVWUtqs6EktQMR1sCYmEzGvRwtaycI16\n9pmzcpiWu/uhNStGlteJ5odRfRwVkoQUMnSZXTCcbn9bBTTmiWo4mJcFOOAzsthH\n0UAb8NdD4tUE0At4a9hYP9IETEXAMPLE\n-----END PUBLIC KEY-----", "fingerprint": "12:a3:44:56:bc:7d:e8:9f:10:2g:34:hi:56:78:90:12", "tags": {} } }

Weitere Informationen finden Sie unter Verteilen von Teilnehmertoken im Benutzerhandbuch zu Amazon-IVS-Streaming in Echtzeit.

  • API-Details finden Sie unter GetPublicKey in der AWS CLI-Befehlsreferenz.

Das folgende Codebeispiel zeigt, wie get-stage-session verwendet wird.

AWS CLI

So rufen Sie eine Stufensitzung ab

Im folgenden get-stage-session-Beispiel wird die Stufensitzung für eine angegebene Sitzungs-ID des angegebenen Stufen-ARN (Amazon Resource Name) abgerufen.

aws ivs-realtime get-stage-session \ --stage-arn arn:aws:ivs:us-west-2:123456789012:stage/abcdABCDefgh \ --session-id st-a1b2c3d4e5f6g

Ausgabe:

{ "stageSession": { "endTime": "2023-04-26T20:36:29+00:00", "sessionId": "st-a1b2c3d4e5f6g", "startTime": "2023-04-26T20:30:29.602000+00:00" } }

Weitere Informationen finden Sie unter Aktivieren mehrerer Hosts in einem Amazon-IVS-Stream im Benutzerhandbuch zu Amazon Interactive Video Service.

  • API-Details finden Sie unter GetStageSession in der AWS CLI-Befehlsreferenz.

Das folgende Codebeispiel zeigt, wie get-stage verwendet wird.

AWS CLI

So rufen Sie die Konfigurationsinformationen einer Stufe ab

Im folgenden get-stage-Beispiel wird die Stufenkonfiguration für einen angegebenen Stufen-ARN (Amazon Resource Name) abgerufen.

aws ivs-realtime get-stage \ --arn arn:aws:ivs:us-west-2:123456789012:stage/abcdABCDefgh

Ausgabe:

{ "stage": { "activeSessionId": "st-a1b2c3d4e5f6g", "arn": "arn:aws:ivs:us-west-2:123456789012:stage/abcdABCDefgh", "autoParticipantRecordingConfiguration": { "storageConfigurationArn": "", "mediaTypes": [ "AUDIO_VIDEO" ], "thumbnailConfiguration": { "targetIntervalSeconds": 60, "storage": [ "SEQUENTIAL" ], "recordingMode": "DISABLED" }, "recordingReconnectWindowSeconds": 0, "hlsConfiguration": { "targetSegmentDurationSeconds": 6 }, "recordParticipantReplicas": true }, "endpoints": { "events": "wss://global.events.live-video.net", "rtmp": "rtmp://9x0y8z7s6t5u.global-contribute-staging.live-video.net/app/", "rtmps": "rtmps://9x0y8z7s6t5u.global-contribute-staging.live-video.net:443/app/", "whip": "https://9x0y8z7s6t5u.global-bm.whip.live-video.net" }, "name": "test", "tags": {} } }

Weitere Informationen finden Sie unter Aktivieren mehrerer Hosts in einem Amazon-IVS-Stream im Benutzerhandbuch zu Amazon-IVS-Streaming mit niedriger Latenz.

  • API-Details finden Sie unter GetStage in der AWS CLI-Befehlsreferenz.

Das folgende Codebeispiel zeigt, wie get-storage-configuration verwendet wird.

AWS CLI

So rufen Sie die Speicherkonfiguration für eine Komposition ab

Im folgenden get-storage-configuration-Beispiel wird die durch den angegebenen ARN (Amazon Resource Name) festgelegte Speicherkonfiguration für die Komposition abgerufen.

aws ivs-realtime get-storage-configuration \ --name arn "arn:aws:ivs:ap-northeast-1:123456789012:storage-configuration/abcdABCDefgh"

Ausgabe:

{ "storageConfiguration": { "arn": "arn:aws:ivs:ap-northeast-1:123456789012:storage-configuration/abcdABCDefgh", "name": "test-sc", "s3": { "bucketName": "amzn-s3-demo-bucket" }, "tags": {} } }

Weitere Informationen finden Sie unter Aktivieren mehrerer Hosts in einem Amazon-IVS-Stream im Benutzerhandbuch zu Amazon Interactive Video Service.

Das folgende Codebeispiel zeigt, wie import-public-key verwendet wird.

AWS CLI

So importieren Sie einen vorhandenen öffentlichen Schlüssel, der zum Signieren von Stufenteilnehmer-Token verwendet wird

Im folgenden import-public-key-Beispiel wird ein öffentlicher Schlüssel aus einer Materialdatei importiert, der zum Signieren von Stufenteilnehmer-Token verwendet werden soll.

aws ivs-realtime import-public-key \ --public-key-material="`cat public.pem`"

Ausgabe:

{ "publicKey": { "arn": "arn:aws:ivs:us-west-2:123456789012:public-key/abcdABC1efg2", "name": "", "publicKeyMaterial": "-----BEGIN PUBLIC KEY-----\nMHYwEAYHKoZIzj0CAQYFK4EEACIDYgAEqVWUtqs6EktQMR1sCYmEzGvRwtaycI16\n9pmzcpiWu/uhNStGlteJ5odRfRwVkoQUMnSZXTCcbn9bBTTmiWo4mJcFOOAzsthH\n0UAb8NdD4tUE0At4a9hYP9IETEXAMPLE\n-----END PUBLIC KEY-----", "fingerprint": "12:a3:44:56:bc:7d:e8:9f:10:2g:34:hi:56:78:90:12", "tags": {} } }

Weitere Informationen finden Sie unter Verteilen von Teilnehmertoken im Benutzerhandbuch zu Amazon-IVS-Streaming in Echtzeit.

  • API-Details finden Sie unter ImportPublicKey in der AWS CLI-Befehlsreferenz.

Das folgende Codebeispiel zeigt, wie list-compositions verwendet wird.

AWS CLI

So rufen Sie eine Liste von Kompositionen ab

Im folgenden list-compositions-Beispiel werden alle Kompositionen für Ihr AWS-Konto in der AWS-Region aufgelistet, in der die API-Anfrage verarbeitet wird.

aws ivs-realtime list-compositions

Ausgabe:

{ "compositions": [ { "arn": "arn:aws:ivs:ap-northeast-1:123456789012:composition/abcdABCDefgh", "destinations": [ { "id": "AabBCcdDEefF", "startTime": "2023-10-16T23:25:23+00:00", "state": "ACTIVE" } ], "stageArn": "arn:aws:ivs:ap-northeast-1:123456789012:stage/defgABCDabcd", "startTime": "2023-10-16T23:25:21+00:00", "state": "ACTIVE", "tags": {} }, { "arn": "arn:aws:ivs:ap-northeast-1:123456789012:composition/ABcdabCDefgh", "destinations": [ { "endTime": "2023-10-16T23:25:00.786512+00:00", "id": "aABbcCDdeEFf", "startTime": "2023-10-16T23:24:01+00:00", "state": "STOPPED" }, { "endTime": "2023-10-16T23:25:00.786512+00:00", "id": "deEFfaABbcCD", "startTime": "2023-10-16T23:24:01+00:00", "state": "STOPPED" } ], "endTime": "2023-10-16T23:25:00+00:00", "stageArn": "arn:aws:ivs:ap-northeast-1:123456789012:stage/efghabcdABCD", "startTime": "2023-10-16T23:24:00+00:00", "state": "STOPPED", "tags": {} } ] }

Weitere Informationen finden Sie unter Aktivieren mehrerer Hosts in einem Amazon-IVS-Stream im Benutzerhandbuch zu Amazon Interactive Video Service.

Das folgende Codebeispiel zeigt, wie list-encoder-configurations verwendet wird.

AWS CLI

So listen Sie die Konfigurationen des Kompositions-Encoders auf

Im folgenden list-encoder-configurations-Beispiel werden alle Encoder-Konfigurationen für Kompositionen für Ihr AWS-Konto in der AWS-Region aufgelistet, in der die API-Anfrage verarbeitet wird.

aws ivs-realtime list-encoder-configurations

Ausgabe:

{ "encoderConfigurations": [ { "arn": "arn:aws:ivs:ap-northeast-1:123456789012:encoder-configuration/abcdABCDefgh", "name": "test-ec-1", "tags": {} }, { "arn": "arn:aws:ivs:ap-northeast-1:123456789012:encoder-configuration/ABCefgEFGabc", "name": "test-ec-2", "tags": {} } ] }

Weitere Informationen finden Sie unter Aktivieren mehrerer Hosts in einem Amazon-IVS-Stream im Benutzerhandbuch zu Amazon Interactive Video Service.

Das folgende Codebeispiel zeigt, wie list-ingest-configurations verwendet wird.

AWS CLI

So rufen Sie zusammenfassende Informationen zu allen Erfassungskonfigurationen ab

Im folgenden list-ingest-configurations-Beispiel werden alle Erfassungskonfigurationen für Ihr AWS-Konto in der AWS-Region aufgelistet, in der die API-Anfrage verarbeitet wird.

aws ivs-realtime list-ingest-configurations

Ausgabe:

{ "ingestConfigurations": [ { "name": "", "arn": "arn:aws:ivs:us-west-2:123456789012:ingest-configuration/XYZuvwSt4567", "ingestProtocol": "RTMPS", "stageArn": "arn:aws:ivs:us-west-2:123456789012:stage/abcdABCDefgh", "participnatId": "abC789Xyz456", "state": "INACTIVE" "userId": "", } ] }

Weitere Informationen finden Sie unter IVS-Streamerfassung | Echtzeit-Streaming im Benutzerhandbuch zu Amazon Interactive Video Service.

Das folgende Codebeispiel zeigt, wie list-participant-events verwendet wird.

AWS CLI

Beispiel 1: So rufen Sie eine Liste der Ereignisse von Stufenteilnehmern ab

Im folgenden list-participant-events-Beispiel werden alle Teilnehmerereignisse für eine angegebene Teilnehmer-ID und Sitzungs-ID eines bestimmten Phasen-ARN (Amazon Resource Name) aufgelistet.

aws ivs-realtime list-participant-events \ --stage-arn arn:aws:ivs:us-west-2:123456789012:stage/abcdABCDefgh \ --session-id st-a1b2c3d4e5f6g \ --participant-id abCDEf12GHIj

Ausgabe:

{ "events": [ { "eventTime": "2023-04-26T20:36:28+00:00", "name": "LEFT", "participantId": "abCDEf12GHIj" }, { "eventTime": "2023-04-26T20:36:28+00:00", "name": "PUBLISH_STOPPED", "participantId": "abCDEf12GHIj" }, { "eventTime": "2023-04-26T20:30:34+00:00", "name": "JOINED", "participantId": "abCDEf12GHIj" }, { "eventTime": "2023-04-26T20:30:34+00:00", "name": "PUBLISH_STARTED", "participantId": "abCDEf12GHIj" } ] }

Weitere Informationen finden Sie unter Aktivieren mehrerer Hosts in einem Amazon-IVS-Stream im Benutzerhandbuch zu Amazon-IVS-Streaming mit niedriger Latenz.

Beispiel 2: So rufen Sie eine Liste der Ereignisse von Stufenteilnehmern ab, einschließlich Stopp und Start der Replikation von Teilnehmern

Im folgenden list-participant-events-Beispiel werden alle Teilnehmerereignisse für eine angegebene Sitzungs-ID eines bestimmten Phasen-ARN (Amazon Resource Name) aufgelistet, in denen ein Teilnehmer auf eine andere Stufe repliziert wird.

aws ivs-realtime list-participant-events \ --stage-arn arn:aws:ivs:us-west-2:123456789012:stage/abcdABCDefgh \ --session-id st-a1b2c3d4e5f6g \ --participant-id abCDEf12GHIj

Ausgabe:

{ "events": [ { "eventTime": "2025-04-26T20:36:28+00:00", "name": "LEFT", "participantId": "abCDEf12GHIj" }, { "eventTime": "2025-04-26T20:36:28+00:00", "name": "PUBLISH_STOPPED", "participantId": "abCDEf12GHIj" }, { "eventTime": "2025-04-26T20:30:34+00:00", "name": "JOINED", "participantId": "abCDEf12GHIj" }, { "eventTime": "2025-04-26T20:30:34+00:00", "name": "PUBLISH_STARTED", "participantId": "abCDEf12GHIj" }, { "name": "REPLICATION_STARTED", "participantId": "abCDEf12GHIj", "eventTime": "2025-04-26T20:30:34+00:00", "destinationStageArn": "arn:aws:ivs:us-west-2:12345678901:stage/ABCDabcdefgh", "destinationSessionId": "st-b1c2d3e4f5g6a" }, { "name": "REPLICATION_STOPPED", "participantId": "abCDEf12GHIj", "eventTime": "2025-04-26T20:32:34+00:00", "destinationStageArn": "arn:aws:ivs:us-west-2:12345678901:stage/ABCDabcdefgh", "destinationSessionId": "st-b1c2d3e4f5g6a" } ] }

Weitere Informationen finden Sie unter Aktivieren mehrerer Hosts in einem Amazon-IVS-Stream im Benutzerhandbuch zu Amazon-IVS-Streaming mit niedriger Latenz.

Das folgende Codebeispiel zeigt, wie list-participant-replicas verwendet wird.

AWS CLI

So rufen Sie eine Liste der Replikate von Stufenteilnehmern ab

Im folgenden list-participant-replicas-Beispiel werden alle Teilnehmer der Stufe aufgelistet, die von dem angegebenen Quellstufen-ARN (Amazon Resource Name) auf eine andere Stufe repliziert wurden.

aws ivs-realtime list-participant-replicas \ --source-stage-arn arn:aws:ivs:us-west-2:123456789012:stage/abcdABCDefgh \ --participant-id abCDEf12GHIj

Ausgabe:

{ "replicas": [ { "sourceStageArn": "arn:aws:ivs:us-west-2:123456789012:stage/abcdABCDefgh", "participantId": "abCDEf12GHIj", "sourceSessionId": "st-a1b2c3d4e5f6g", "destinationStageArn": "arn:aws:ivs:us-west-2:012345678901:stage/ABCDabcdefgh", "destinationSessionId": "st-b1c2d3e4f5g6a", "replicationState": "ACTIVE" } ] }

Weitere Informationen finden Sie unter IVS-Teilnehmerreplikation im Benutzerhandbuch zu Amazon-IVS-Streaming in Echtzeit.

Das folgende Codebeispiel zeigt, wie list-participants verwendet wird.

AWS CLI

Beispiel 1: So rufen Sie eine Liste von Stufenteilnehmern ab

Im folgenden list-participants-Beispiel werden alle Teilnehmer für eine angegebene Sitzungs-ID eines bestimmten Phasen-ARN (Amazon Resource Name) aufgelistet.

aws ivs-realtime list-participants \ --stage-arn arn:aws:ivs:us-west-2:123456789012:stage/abcdABCDefgh \ --session-id st-a1b2c3d4e5f6g

Ausgabe:

{ "participants": [ { "firstJoinTime": "2023-04-26T20:30:34+00:00", "participantId": "abCDEf12GHIj", "published": true, "recordingState": "STOPPED", "state": "DISCONNECTED", "userId": "" } ] }

Weitere Informationen finden Sie unter Aktivieren mehrerer Hosts in einem Amazon-IVS-Stream im Benutzerhandbuch zu Amazon-IVS-Streaming mit niedriger Latenz.

Beispiel 2: So rufen Sie eine Liste von Stufenteilnehmern ab, wenn ein Teilnehmer auf eine andere Stufe repliziert wurde

Im folgenden list-participants-Beispiel werden alle Teilnehmer für eine angegebene Sitzungs-ID eines bestimmten Phasen-ARN (Amazon Resource Name) aufgelistet, wenn ein Teilnehmer auf eine andere Stufe repliziert wurde.

aws ivs-realtime list-participants \ --stage-arn arn:aws:ivs:us-west-2:123456789012:stage/abcdABCDefgh \ --session-id st-a1b2c3d4e5f6g

Ausgabe:

{ "participants": [ { "firstJoinTime": "2023-04-26T20:30:34+00:00", "participantId": "abCDEf12GHIj", "published": true, "recordingState": "STOPPED", "state": "DISCONNECTED", "userId": "", "replicationState": "ACTIVE", "replicationType": "SOURCE", "sourceStageArn": "", "sourceSessionId": "" } ] }

Weitere Informationen finden Sie unter Aktivieren mehrerer Hosts in einem Amazon-IVS-Stream im Benutzerhandbuch zu Amazon-IVS-Streaming mit niedriger Latenz.

Beispiel 3: So rufen Sie eine Liste von Stufenteilnehmern ab, wenn ein Teilnehmer aus einer anderen Stufe repliziert wurde

Im folgenden list-participants-Beispiel werden alle Teilnehmer für eine angegebene Sitzungs-ID eines bestimmten Phasen-ARN (Amazon Resource Name) aufgelistet, wenn ein Teilnehmer von einer anderen Stufe repliziert wurde.

aws ivs-realtime list-participants \ --stage-arn arn:aws:ivs:us-west-2:123456789012:stage/abcdABCDefgh \ --session-id st-a1b2c3d4e5f6g

Ausgabe:

{ "participants": [ { "firstJoinTime": "2023-04-26T20:30:34+00:00", "participantId": "abCDEf12GHIj", "published": true, "recordingState": "STOPPED", "state": "DISCONNECTED", "userId": "", "replicationState": "ACTIVE", "replicationType": "REPLICA", "sourceStageArn": "arn:aws:ivs:us-west-2:123456789012:stage/abcdABCDefgh", "sourceSessionId": "st-a1b2c3d4e5f6g" } ] }

Weitere Informationen finden Sie unter Aktivieren mehrerer Hosts in einem Amazon-IVS-Stream im Benutzerhandbuch zu Amazon-IVS-Streaming mit niedriger Latenz.

Das folgende Codebeispiel zeigt, wie list-public-keys verwendet wird.

AWS CLI

So listen Sie bestehende öffentliche Schlüssel auf, die zum Signieren von Stufenteilnehmer-Token verfügbar sind

Im folgenden list-public-keys-Beispiel werden alle öffentlichen Schlüssel aufgelistet, die in der AWS-Region, in der die API-Anfrage verarbeitet wird, zum Signieren von Token für Stufenteilnehmer verfügbar sind.

aws ivs-realtime list-public-keys

Ausgabe:

{ "publicKeys": [ { "arn": "arn:aws:ivs:us-west-2:123456789012:public-key/abcdABC1efg2", "name": "", "tags": {} }, { "arn": "arn:aws:ivs:us-west-2:123456789012:public-key/3bcdABCDefg4", "name": "", "tags": {} } ] }

Weitere Informationen finden Sie unter Verteilen von Teilnehmertoken im Benutzerhandbuch zu Amazon-IVS-Streaming in Echtzeit.

  • API-Details finden Sie unter ListPublicKeys in der AWS CLI-Befehlsreferenz.

Das folgende Codebeispiel zeigt, wie list-stage-sessions verwendet wird.

AWS CLI

So rufen Sie eine Liste der Stufensitzungen auf

Im folgenden list-stage-sessions-Beispiel werden alle Sitzungen für einen angegebenen Phasen-ARN (Amazon Resource Name) aufgelistet.

aws ivs-realtime list-stage-sessions \ --stage-arn arn:aws:ivs:us-west-2:123456789012:stage/abcdABCDefgh

Ausgabe:

{ "stageSessions": [ { "endTime": "2023-04-26T20:36:29+00:00", "sessionId": "st-a1b2c3d4e5f6g", "startTime": "2023-04-26T20:30:29.602000+00:00" } ] }

Weitere Informationen finden Sie unter Aktivieren mehrerer Hosts in einem Amazon-IVS-Stream im Benutzerhandbuch zu Amazon Interactive Video Service.

Das folgende Codebeispiel zeigt, wie list-stages verwendet wird.

AWS CLI

So rufen Sie zusammenfassende Informationen über alle Stufen ab

Im folgenden list-stages-Beispiel werden alle Stufen für Ihr AWS-Konto in der AWS-Region aufgelistet, in der die API-Anfrage verarbeitet wird.

aws ivs-realtime list-stages

Ausgabe:

{ "stages": [ { "activeSessionId": "st-a1b2c3d4e5f6g", "arn": "arn:aws:ivs:us-west-2:123456789012:stage/abcdABCDefgh", "name": "stage1", "tags": {} }, { "activeSessionId": "st-a123bcd456efg", "arn": "arn:aws:ivs:us-west-2:123456789012:stage/abcd1234ABCD", "name": "stage2", "tags": {} }, { "activeSessionId": "st-abcDEF1234ghi", "arn": "arn:aws:ivs:us-west-2:123456789012:stage/ABCD1234efgh", "name": "stage3", "tags": {} } ] }

Weitere Informationen finden Sie unter Aktivieren mehrerer Hosts in einem Amazon-IVS-Stream im Benutzerhandbuch zu Amazon Interactive Video Service.

  • API-Details finden Sie unter ListStages in der AWS CLI-Befehlsreferenz.

Das folgende Codebeispiel zeigt, wie list-storage-configurations verwendet wird.

AWS CLI

So listen Sie die Konfigurationen des Kompositionsspeichers auf

Im folgenden list-storage-configurations-Beispiel werden alle Speicherkonfigurationen für Kompositionen für Ihr AWS-Konto in der AWS-Region aufgelistet, in der die API-Anfrage verarbeitet wird.

aws ivs-realtime list-storage-configurations

Ausgabe:

{ "storageConfigurations": [ { "arn": "arn:aws:ivs:ap-northeast-1:123456789012:storage-configuration/abcdABCDefgh", "name": "test-sc-1", "s3": { "bucketName": "amzn-s3-demo-bucket-1" }, "tags": {} }, { "arn": "arn:aws:ivs:ap-northeast-1:123456789012:storage-configuration/ABCefgEFGabc", "name": "test-sc-2", "s3": { "bucketName": "amzn-s3-demo-bucket-2" }, "tags": {} } ] }

Weitere Informationen finden Sie unter Aktivieren mehrerer Hosts in einem Amazon-IVS-Stream im Benutzerhandbuch zu Amazon Interactive Video Service.

Das folgende Codebeispiel zeigt, wie start-composition verwendet wird.

AWS CLI

Beispiel 1: So starten Sie eine Komposition mit Standard-Layouteinstellungen

Im folgenden start-composition-Beispiel wird eine Komposition für die angegebene Stufe gestartet, die an die angegebenen Speicherorte gestreamt wird.

aws ivs-realtime start-composition \ --stage-arn arn:aws:ivs:ap-northeast-1:123456789012:stage/defgABCDabcd \ --destinations '[{"channel": {"channelArn": "arn:aws:ivs:ap-northeast-1:123456789012:channel/abcABCdefDEg", \ "encoderConfigurationArn": "arn:aws:ivs:ap-northeast-1:123456789012:encoder-configuration/ABabCDcdEFef"}}, \ {"s3":{"encoderConfigurationArns":["arn:aws:ivs:ap-northeast-1:123456789012:encoder-configuration/ABabCDcdEFef"], \ "recordingConfiguration": {"hlsConfiguration": {"targetSegmentDurationSeconds": 5}}, \ "storageConfigurationArn":"arn:aws:ivs:ap-northeast-1:123456789012:storage-configuration/FefABabCDcdE"}}]'

Ausgabe:

{ "composition": { "arn": "arn:aws:ivs:ap-northeast-1:123456789012:composition/abcdABCDefgh", "destinations": [ { "configuration": { "channel": { "channelArn": "arn:aws:ivs:ap-northeast-1:123456789012:channel/abcABCdefDEg", "encoderConfigurationArn": "arn:aws:ivs:ap-northeast-1:123456789012:encoder-configuration/ABabCDcdEFef" }, "name": "" }, "id": "AabBCcdDEefF", "state": "STARTING" }, { "configuration": { "name": "", "s3": { "encoderConfigurationArns": [ "arn:aws:ivs:arn:aws:ivs:ap-northeast-1:123456789012:encoder-configuration/ABabCDcdEFef" ], "recordingConfiguration": { "format": "HLS", "hlsConfiguration": { "targetSegmentDurationSeconds": 5 } }, "storageConfigurationArn": "arn:arn:aws:ivs:ap-northeast-1:123456789012:storage-configuration/FefABabCDcdE" } }, "detail": { "s3": { "recordingPrefix": "aBcDeFgHhGfE/AbCdEfGhHgFe/GHFabcgefABC/composite" } }, "id": "GHFabcgefABC", "state": "STARTING" } ], "layout": { "grid": { "featuredParticipantAttribute": "" "gridGap": 2, "omitStoppedVideo": false, "videoAspectRatio": "VIDEO", "videoFillMode": "" } }, "stageArn": "arn:aws:ivs:ap-northeast-1:123456789012:stage/defgABCDabcd", "startTime": "2023-10-16T23:24:00+00:00", "state": "STARTING", "tags": {} } }

Weitere Informationen finden Sie unter Zusammengesetzte Aufzeichnung | Echtzeit-Streaming im Benutzerhandbuch zu Amazon-IVS-Streaming in Echtzeit.

Beispiel 2: So starten Sie eine Komposition mit PiP-Layout

Im folgenden start-composition-Beispiel wird eine Komposition für die angegebene Stufe gestartet, die mithilfe des PiP-Layouts an die angegebenen Speicherorte gestreamt wird.

aws ivs-realtime start-composition \ --stage-arn arn:aws:ivs:ap-northeast-1:123456789012:stage/defgABCDabcd \ --destinations '[{"channel": {"channelArn": "arn:aws:ivs:ap-northeast-1:123456789012:channel/abcABCdefDEg", \ "encoderConfigurationArn": "arn:aws:ivs:ap-northeast-1:123456789012:encoder-configuration/ABabCDcdEFef"}}, \ {"s3":{"encoderConfigurationArns":["arn:aws:ivs:ap-northeast-1:123456789012:encoder-configuration/ABabCDcdEFef"], \ "storageConfigurationArn":"arn:aws:ivs:ap-northeast-1:123456789012:storage-configuration/FefABabCDcdE"}}]' \ --layout pip='{featuredParticipantAttribute="abcdefg"}'

Ausgabe:

{ "composition": { "arn": "arn:aws:ivs:ap-northeast-1:123456789012:composition/wxyzWXYZpqrs", "destinations": [ { "configuration": { "channel": { "channelArn": "arn:aws:ivs:ap-northeast-1:123456789012:channel/abcABCdefDEg", "encoderConfigurationArn": "arn:aws:ivs:ap-northeast-1:123456789012:encoder-configuration/ABabCDcdEFef" }, "name": "" }, "id": "AabBCcdDEefF", "state": "STARTING" }, { "configuration": { "name": "", "s3": { "encoderConfigurationArns": [ "arn:aws:ivs:arn:aws:ivs:ap-northeast-1:123456789012:encoder-configuration/ABabCDcdEFef" ], "recordingConfiguration": { "format": "HLS", "hlsConfiguration": { "targetSegmentDurationSeconds": 2 } }, "storageConfigurationArn": "arn:arn:aws:ivs:ap-northeast-1:123456789012:storage-configuration/FefABabCDcdE" } }, "detail": { "s3": { "recordingPrefix": "aBcDeFgHhGfE/AbCdEfGhHgFe/GHFabcgefABC/composite" } }, "id": "GHFabcgefABC", "state": "STARTING" } ], "layout": { "pip": { "featuredParticipantAttribute": "abcdefg", "gridGap": 0, "omitStoppedVideo": false, "pipBehavior": "STATIC", "pipOffset": 0, "pipParticipantAttribute": "", "pipPosition": "BOTTOM_RIGHT", "videoFillMode": "COVER" } }, "stageArn": "arn:aws:ivs:ap-northeast-1:123456789012:stage/defgABCDabcd", "startTime": "2023-10-16T23:24:00+00:00", "state": "STARTING", "tags": {} } }

Weitere Informationen finden Sie unter Zusammengesetzte Aufzeichnung | Echtzeit-Streaming im Benutzerhandbuch zu Amazon-IVS-Streaming in Echtzeit.

Beispiel 3: So starten Sie eine Komposition mit aktivierter Thumbnail-Aufzeichnung

Im folgenden start-composition-Beispiel wird eine Komposition für die angegebene Stufe gestartet, die an die angegebenen Speicherorte mit aktivierter Thumbnail-Aufzeichnung gestreamt wird.

aws ivs-realtime start-composition \ --stage-arn arn:aws:ivs:ap-northeast-1:123456789012:stage/defgABCDabcd \ --destinations '[{"channel": {"channelArn": "arn:aws:ivs:ap-northeast-1:123456789012:channel/abcABCdefDEg", \ "encoderConfigurationArn": "arn:aws:ivs:ap-northeast-1:123456789012:encoder-configuration/ABabCDcdEFef"}}, \ {"s3": {"encoderConfigurationArns": ["arn:aws:ivs:ap-northeast-1:123456789012:encoder-configuration/ABabCDcdEFef"], \ "storageConfigurationArn": "arn:aws:ivs:ap-northeast-1:123456789012:storage-configuration/FefABabCDcdE", \ "thumbnailConfigurations": [{"storage": ["SEQUENTIAL"],"targetIntervalSeconds": 60}]}}]'

Ausgabe:

{ "composition": { "arn": "arn:aws:ivs:ap-northeast-1:123456789012:composition/abcdABCDefgh", "destinations": [ { "configuration": { "channel": { "channelArn": "arn:aws:ivs:ap-northeast-1:123456789012:channel/abcABCdefDEg", "encoderConfigurationArn": "arn:aws:ivs:ap-northeast-1:123456789012:encoder-configuration/ABabCDcdEFef" }, "name": "" }, "id": "AabBCcdDEefF", "state": "STARTING" }, { "configuration": { "name": "", "s3": { "encoderConfigurationArns": [ "arn:aws:ivs:arn:aws:ivs:ap-northeast-1:123456789012:encoder-configuration/ABabCDcdEFef" ], "recordingConfiguration": { "format": "HLS", "hlsConfiguration": { "targetSegmentDurationSeconds": 2 } }, "storageConfigurationArn": "arn:arn:aws:ivs:ap-northeast-1:123456789012:storage-configuration/FefABabCDcdE", "thumbnailConfigurations": [ { "targetIntervalSeconds": 60, "storage": [ "SEQUENTIAL" ] } ] } }, "detail": { "s3": { "recordingPrefix": "aBcDeFgHhGfE/AbCdEfGhHgFe/GHFabcgefABC/composite" } }, "id": "GHFabcgefABC", "state": "STARTING" } ], "layout": { "grid": { "featuredParticipantAttribute": "" "gridGap": 2, "omitStoppedVideo": false, "videoAspectRatio": "VIDEO", "videoFillMode": "" } }, "stageArn": "arn:aws:ivs:ap-northeast-1:123456789012:stage/defgABCDabcd", "startTime": "2023-10-16T23:24:00+00:00", "state": "STARTING", "tags": {} } }

Weitere Informationen finden Sie unter Zusammengesetzte Aufzeichnung | Echtzeit-Streaming im Benutzerhandbuch zu Amazon-IVS-Streaming in Echtzeit.

Das folgende Codebeispiel zeigt, wie start-participant-replication verwendet wird.

AWS CLI

So starten Sie die Replikation eines Teilnehmers von einer Stufe auf eine andere

Im folgenden start-participant-replication-Beispiel wird ein Teilnehmer von einer Quellstufe in eine Zielstufe repliziert, wobei jede Stufe durch ihren ARN (Amazon Resource Name) angegeben wird.

aws ivs-realtime start-participant-replication \ --source-stage-arn arn:aws:ivs:us-west-2:123456789012:stage/abcdABCDefgh \ --destination-stage-arn arn:aws:ivs:us-west-2:234567890123:stage/bcdABCDefghi \ --participant-id abCDEf12GHIj

Ausgabe:

{ "accessControlAllowOrigin": "*", "accessControlExposeHeaders": "Access-Control-Allow-Origin,Access-Control-Expose-Headers,Cache-Control,Content-Length, \ Content-Security-Policy,Content-Type,date,Strict-Transport-Security,x-amz-apigw-id,x-amzn-errormessage,x-amzn-errortype, \ x-amzn-requestid,x-amzn-trace-id,X-Content-Type-Options,X-Frame-Options", "cacheControl": "no-store, no-cache", "contentSecurityPolicy": "default-src 'self'; upgrade-insecure-requests;", "strictTransportSecurity": "max-age:47304000; includeSubDomains", "xContentTypeOptions": "nosniff", "xFrameOptions": "DENY" }

Weitere Informationen finden Sie unter IVS-Teilnehmerreplikation im Benutzerhandbuch zu Amazon-IVS-Streaming in Echtzeit.

Das folgende Codebeispiel zeigt, wie stop-composition verwendet wird.

AWS CLI

So stoppen Sie eine Komposition

Im folgenden stop-composition-Beispiel wird die durch den angegebenen ARN (Amazon Resource Name) festgelegte Komposition gestoppt.

aws ivs-realtime stop-composition \ --arn "arn:aws:ivs:ap-northeast-1:123456789012:composition/abcdABCDefgh"

Mit diesem Befehl wird keine Ausgabe zurückgegeben.

Weitere Informationen finden Sie unter Aktivieren mehrerer Hosts in einem Amazon-IVS-Stream im Benutzerhandbuch zu Amazon Interactive Video Service.

  • API-Details finden Sie unter StopComposition in der AWS CLI-Befehlsreferenz.

Das folgende Codebeispiel zeigt, wie stop-participant-replication verwendet wird.

AWS CLI

So stoppen Sie die Replikation eines Teilnehmers von einer Stufe auf eine andere

Im folgenden stop-participant-replication-Beispiel wird die Replikation eines Teilnehmers von einer Quellstufe in eine Zielstufe gestoppt, wobei jede Stufe durch ihren ARN (Amazon Resource Name) angegeben wird.

aws ivs-realtime stop-participant-replication \ --source-stage-arn arn:aws:ivs:us-west-2:123456789012:stage/abcdABCDefgh \ --destination-stage-arn arn:aws:ivs:us-west-2:234567890123:stage/bcdABCDefghi \ --participant-id abCDEf12GHIj

Ausgabe:

{ "accessControlAllowOrigin": "*", "accessControlExposeHeaders": "Access-Control-Allow-Origin,Access-Control-Expose-Headers,Cache-Control,Content-Length, \ Content-Security-Policy,Content-Type,date,Strict-Transport-Security,x-amz-apigw-id,x-amzn-errormessage,x-amzn-errortype, \ x-amzn-requestid,x-amzn-trace-id,X-Content-Type-Options,X-Frame-Options", "cacheControl": "no-store, no-cache", "contentSecurityPolicy": "default-src 'self'; upgrade-insecure-requests;", "strictTransportSecurity": "max-age:47304000; includeSubDomains", "xContentTypeOptions": "nosniff", "xFrameOptions": "DENY" }

Weitere Informationen finden Sie unter IVS-Teilnehmerreplikation im Benutzerhandbuch zu Amazon-IVS-Streaming in Echtzeit.

Das folgende Codebeispiel zeigt, wie update-ingest-configuration verwendet wird.

AWS CLI

So aktualisieren Sie eine Erfassungskonfiguration

Im folgenden update-inegst-configuration-Beispiel wird eine Erfassungskonfiguration aktualisiert, um sie an eine Stufe anzuhängen.

aws ivs-realtime update-ingest-configuration \ --arn arn:aws:ivs:us-west-2:123456789012:ingest-configuration/AbCdEfGh1234 \ --stage-arn arn:aws:ivs:us-west-2:123456789012:stage/abcdABCDefgh

Ausgabe:

{ "ingestConfiguration": { "name": "ingest1", "arn": "arn:aws:ivs:us-west-2:123456789012:ingest-configuration/AbCdEfGh1234", "ingestProtocol": "RTMPS", "streamKey": "rt_123456789012_us-west-2_AbCdEfGh1234_abcd1234efgh5678ijkl9012MNOP34", "stageArn": "arn:aws:ivs:us-west-2:123456789012:stage/abcdABCDefgh", "participantId": "xyZ654abC321", "state": "INACTIVE", "userId": "", "tags": {} } }

Weitere Informationen finden Sie unter IVS-Streamerfassung | Echtzeit-Streaming im Benutzerhandbuch zu Amazon Interactive Video Service.

Das folgende Codebeispiel zeigt, wie update-stage verwendet wird.

AWS CLI

Beispiel 1: So aktualisieren Sie die Konfiguration einer Stufe

Im folgenden update-stage-Beispiel wird eine Stufe für einen angegebenen Stufen-ARN aktualisiert, um den Stufennamen zu aktualisieren und die Aufzeichnung einzelner Teilnehmer mit aktivierter Thumbnail-Aufzeichnung zu konfigurieren.

aws ivs-realtime update-stage \ --arn arn:aws:ivs:us-west-2:123456789012:stage/abcdABCDefgh \ --auto-participant-recording-configuration '{"mediaTypes": ["AUDIO_VIDEO"],"storageConfigurationArn": "arn:aws:ivs:us-west-2:123456789012:storage-configuration/abcdABCDefgh", "recordingReconnectWindowSeconds": 100, \ "thumbnailConfiguration": {"recordingMode": "INTERVAL","storage": ["SEQUENTIAL"],"targetIntervalSeconds": 60}} \ "hlsConfiguration": {"targetSegmentDurationSeconds": 5}}' \ --name stage1a

Ausgabe:

{ "stage": { "arn": "arn:aws:ivs:us-west-2:123456789012:stage/abcdABCDefgh", "autoParticipantRecordingConfiguration": { "mediaTypes": [ "AUDIO_VIDEO" ], "storageConfigurationArn": "arn:aws:ivs:us-west-2:123456789012:storage-configuration/abcdABCDefgh", "thumbnailConfiguration": { "targetIntervalSeconds": 60, "storage": [ "SEQUENTIAL" ], "recordingMode": "INTERVAL" }, "recordingReconnectWindowSeconds": 100, "hlsConfiguration": { "targetSegmentDurationSeconds": 5 }, "recordParticipantReplicas": true }, "endpoints": { "events": "wss://global.events.live-video.net", "rtmp": "rtmp://9x0y8z7s6t5u.global-contribute-staging.live-video.net/app/", "rtmps": "rtmps://9x0y8z7s6t5u.global-contribute-staging.live-video.net:443/app/", "whip": "https://1a2b3c4d5e6f.global-bm.whip.live-video.net" }, "name": "stage1a", "tags": {} } }

Weitere Informationen finden Sie unter Aktivieren mehrerer Hosts in einem Amazon-IVS-Stream im Benutzerhandbuch zu Amazon-IVS-Streaming mit niedriger Latenz.

Beispiel 2: So aktualisieren Sie die Konfiguration einer Stufe, einschließlich der Deaktivierung der Aufzeichnung von Teilnehmerreplikaten

Im folgenden update-stage-Beispiel wird eine Stufe für einen angegebenen Stufen-ARN aktualisiert, um den Stufennamen zu aktualisieren und die Aufzeichnung einzelner Teilnehmer mit aktivierter Thumbnail-Aufzeichnung und deaktivierter Aufzeichnung von Teilnehmerreplikaten zu konfigurieren.

aws ivs-realtime update-stage \ --arn arn:aws:ivs:us-west-2:123456789012:stage/abcdABCDefgh \ --auto-participant-recording-configuration '{"mediaTypes": ["AUDIO_VIDEO"],"storageConfigurationArn": "arn:aws:ivs:us-west-2:123456789012:storage-configuration/abcdABCDefgh", "recordingReconnectWindowSeconds": 100, \ "thumbnailConfiguration": {"recordingMode": "INTERVAL","storage": ["SEQUENTIAL"],"targetIntervalSeconds": 60}, "recordParticipantReplicas":false} \ "hlsConfiguration": {"targetSegmentDurationSeconds": 5}}' \ --name stage1a

Ausgabe:

{ "stage": { "arn": "arn:aws:ivs:us-west-2:123456789012:stage/abcdABCDefgh", "autoParticipantRecordingConfiguration": { "mediaTypes": [ "AUDIO_VIDEO" ], "storageConfigurationArn": "arn:aws:ivs:us-west-2:123456789012:storage-configuration/abcdABCDefgh", "thumbnailConfiguration": { "targetIntervalSeconds": 60, "storage": [ "SEQUENTIAL" ], "recordingMode": "INTERVAL" }, "recordingReconnectWindowSeconds": 100, "hlsConfiguration": { "targetSegmentDurationSeconds": 5 }, "recordParticipantReplicas": false }, "endpoints": { "events": "wss://global.events.live-video.net", "rtmp": "rtmp://9x0y8z7s6t5u.global-contribute-staging.live-video.net/app/", "rtmps": "rtmps://9x0y8z7s6t5u.global-contribute-staging.live-video.net:443/app/", "whip": "https://1a2b3c4d5e6f.global-bm.whip.live-video.net" }, "name": "stage1a", "tags": {} } }

Weitere Informationen finden Sie unter Aktivieren mehrerer Hosts in einem Amazon-IVS-Stream im Benutzerhandbuch zu Amazon-IVS-Streaming mit niedriger Latenz.

  • API-Details finden Sie unter UpdateStage in der AWS CLI-Befehlsreferenz.