Exemples d’utilisation de l’AWS CLI avec la diffusion en temps réel d’Amazon IVS - AWS Command Line Interface
Actions

Exemples d’utilisation de l’AWS CLI avec la diffusion en temps réel d’Amazon IVS

Les exemples de code suivants montrent comment réaliser des actions et mettre en œuvre des scénarios courants en utilisant AWS Command Line Interface avec la diffusion en temps réel d’Amazon IVS.

Les actions sont des extraits de code de programmes plus larges et doivent être exécutées dans leur contexte. Alors que les actions vous indiquent comment appeler des fonctions de service individuelles, vous pouvez les voir en contexte dans leurs scénarios associés.

Chaque exemple inclut un lien vers le code source complet, où vous trouverez des instructions sur la configuration et l’exécution du code en contexte.

Rubriques

Actions

L’exemple de code suivant montre comment utiliser create-encoder-configuration.

AWS CLI

Pour créer une configuration d’encodeur de montage

L’exemple create-encoder-configuration suivant crée une configuration d’encodeur de montage avec les propriétés spécifiées.

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

Sortie :

{
    "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
        }
    }
}

Pour plus d’informations, consultez Activation d’hôtes multiples sur un flux Amazon IVS dans le Guide de l’utilisateur Amazon Interactive Video Service.

L’exemple de code suivant montre comment utiliser create-ingest-configuration.

AWS CLI

Pour créer une configuration d’ingestion

L’exemple create-ingest-configuration suivant crée une configuration d’ingestion à l’aide du protocole RTMPS.

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

Sortie :

{
    "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": {}
    }
}

Pour plus d’informations, consultez Ingestion de flux IVS | Diffusion en temps réel dans le Guide de l’utilisateur Amazon Interactive Video Service.

L’exemple de code suivant montre comment utiliser create-participant-token.

AWS CLI

Pour créer un jeton de participant à l’étape

L’exemple create-participant-token suivant crée un jeton de participant pour l’étape spécifiée.

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

Sortie :

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

Pour plus d’informations, consultez Activation d’hôtes multiples sur un flux Amazon IVS dans le Guide de l’utilisateur Amazon Interactive Video Service.

  • Pour plus de détails sur l’API, consultez CreateParticipantToken dans la Référence des commandes de l’AWS CLI.

L’exemple de code suivant montre comment utiliser create-stage.

AWS CLI

Exemple 1 : pour créer une étape

L’exemple create-stage suivant crée une étape et un jeton de participant à l’étape pour un utilisateur spécifié.

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

Sortie :

{
    "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": {}
    }
}

Pour plus d’informations, consultez Activation d’hôtes multiples sur un flux Amazon IVS dans le Guide de l’utilisateur de la diffusion à faible latence d’Amazon IVS.

Exemple 2 : pour créer une étape et configurer l’enregistrement individuel des participants

L’exemple create-stage suivant crée une étape et configure l’enregistrement individuel des participants.

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}}'

Sortie :

{
    "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": {}
    }
}

Pour plus d’informations, consultez Activation d’hôtes multiples sur un flux Amazon IVS dans le Guide de l’utilisateur de la diffusion à faible latence d’Amazon IVS.

Exemple 3 : pour créer une étape et configurer l’enregistrement individuel des participants avec l’enregistrement des miniatures activé

L’exemple create-stage suivant crée une étape et configure l’enregistrement individuel des participants avec l’enregistrement des miniatures activé.

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}}'

Sortie :

{
    "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": {}
    }
}

Pour plus d’informations, consultez Activation d’hôtes multiples sur un flux Amazon IVS dans le Guide de l’utilisateur de la diffusion à faible latence d’Amazon IVS.

  • Pour plus de détails sur l’API, consultez CreateStage dans la Référence des commandes de l’AWS CLI.

L’exemple de code suivant montre comment utiliser create-storage-configuration.

AWS CLI

Pour créer une configuration de stockage de montage

L’exemple create-storage-configuration suivant crée une configuration de stockage de montage avec les propriétés spécifiées.

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

Sortie :

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

Pour plus d’informations, consultez Activation d’hôtes multiples sur un flux Amazon IVS dans le Guide de l’utilisateur Amazon Interactive Video Service.

L’exemple de code suivant montre comment utiliser delete-encoder-configuration.

AWS CLI

Pour supprimer la configuration d’un encodeur de montage

L’exemple delete-encoder-configuration suivant supprime la configuration de l’encodeur de montage spécifiée par l’ARN (Amazon Resource Name) donné.

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

Cette commande ne produit aucune sortie.

Pour plus d’informations, consultez Activation d’hôtes multiples sur un flux Amazon IVS dans le Guide de l’utilisateur Amazon Interactive Video Service.

L’exemple de code suivant montre comment utiliser delete-ingest-configuration.

AWS CLI

Exemple 1 : pour supprimer une configuration d’ingestion inactive

L’exemple delete-ingest-configuration suivant supprime la configuration d’ingestion inactive pour un ARN (Amazon Resource Name) de configuration d’ingestion spécifié.

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

Cette commande ne produit aucune sortie.

Pour plus d’informations, consultez Ingestion de flux IVS | Diffusion en temps réel dans le Guide de l’utilisateur Amazon Interactive Video Service.

Exemple 2 : pour forcer la suppression d’une configuration d’ingestion active

L’exemple delete-ingest-configuration suivant force la suppression de la configuration d’ingestion active pour un ARN (Amazon Resource Name) de configuration d’ingestion spécifié.

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

Cette commande ne produit aucune sortie.

Pour plus d’informations, consultez Ingestion de flux IVS | Diffusion en temps réel dans le Guide de l’utilisateur Amazon Interactive Video Service.

L’exemple de code suivant montre comment utiliser delete-public-key.

AWS CLI

Pour supprimer une clé publique

L’exemple delete-public-key suivant supprime la clé publique spécifiée.

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

Cette commande ne produit aucune sortie.

Pour plus d’informations, consultez Distribuer des jetons de participants dans le Guide de l’utilisateur de la diffusion en temps réel d’Amazon IVS.

  • Pour plus de détails sur l’API, consultez DeletePublicKey dans la Référence des commandes de l’AWS CLI.

L’exemple de code suivant montre comment utiliser delete-stage.

AWS CLI

Pour supprimer une étape

L’exemple delete-stage suivant supprime l’étape spécifiée.

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

Cette commande ne produit aucune sortie.

Pour plus d’informations, consultez Activation d’hôtes multiples sur un flux Amazon IVS dans le Guide de l’utilisateur Amazon Interactive Video Service.

  • Pour plus de détails sur l’API, consultez DeleteStage dans la Référence des commandes de l’AWS CLI.

L’exemple de code suivant montre comment utiliser delete-storage-configuration.

AWS CLI

Pour supprimer une configuration de stockage de montage

L’exemple delete-storage-configuration suivant supprime la configuration du stockage de montage spécifiée par l’ARN (Amazon Resource Name) donné.

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

Cette commande ne produit aucune sortie.

Pour plus d’informations, consultez Activation d’hôtes multiples sur un flux Amazon IVS dans le Guide de l’utilisateur Amazon Interactive Video Service.

L’exemple de code suivant montre comment utiliser disconnect-participant.

AWS CLI

Pour déconnecter un participant à l’étape

L’exemple disconnect-participant suivant déconnecte le participant spécifié de l’étape spécifiée.

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

Cette commande ne produit aucune sortie.

Pour plus d’informations, consultez Activation d’hôtes multiples sur un flux Amazon IVS dans le Guide de l’utilisateur Amazon Interactive Video Service.

  • Pour plus de détails sur l’API, consultez DisconnectParticipant dans la Référence des commandes de l’AWS CLI.

L’exemple de code suivant montre comment utiliser get-composition.

AWS CLI

Exemple 1 : pour obtenir un montage avec les paramètres de mise en page par défaut

L’exemple get-composition suivant obtient le montage de l’ARN (Amazon Resource Name) spécifié.

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

Sortie :

{
    "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": {}
    }
}

Pour plus d’informations, consultez Enregistrement composite IVS | Diffusion en temps réel dans le Guide de l’utilisateur de la diffusion en temps réel d’Amazon IVS.

Exemple 2 : pour obtenir un montage avec une mise en page PiP

L’exemple get-composition suivant obtient le montage de l’ARN (Amazon Resource Name) spécifié, qui utilise la mise en page PiP.

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

Sortie :

{
    "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": {}
    }
}

Pour plus d’informations, consultez Enregistrement composite IVS | Diffusion en temps réel dans le Guide de l’utilisateur de la diffusion en temps réel d’Amazon IVS.

Exemple 3 : pour obtenir un montage avec l’enregistrement des miniatures activé

L’exemple get-composition suivant obtient le montage de l’ARN (Amazon Resource Name) spécifié, pour lequel l’enregistrement des miniatures est activé avec les paramètres par défaut.

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

Sortie :

{
    "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": {}
    }
}

Pour plus d’informations, consultez Enregistrement composite IVS | Diffusion en temps réel dans le Guide de l’utilisateur de la diffusion en temps réel d’Amazon IVS.

  • Pour plus de détails sur l’API, consultez GetComposition dans la Référence des commandes de l’AWS CLI.

L’exemple de code suivant montre comment utiliser get-encoder-configuration.

AWS CLI

Pour obtenir la configuration d’un encodeur de montage

L’exemple get-encoder-configuration suivant obtient la configuration d’un encodeur de montage spécifiée par l’ARN (Amazon Resource Name) donné.

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

Sortie :

{
    "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
        }
    }
}

Pour plus d’informations, consultez Activation d’hôtes multiples sur un flux Amazon IVS dans le Guide de l’utilisateur Amazon Interactive Video Service.

  • Pour plus de détails sur l’API, consultez GetEncoderConfiguration dans la Référence des commandes de l’AWS CLI.

L’exemple de code suivant montre comment utiliser get-ingest-configuration.

AWS CLI

Pour obtenir les informations de configuration d’ingestion

L’exemple get-ingest-configuration suivant obtient la configuration d’ingestion pour un ARN (Amazon Resource Name) de configuration d’ingestion spécifié.

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

Sortie :

{
    "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": {}
    }
}

Pour plus d’informations, consultez Ingestion de flux IVS | Diffusion en temps réel dans le Guide de l’utilisateur Amazon Interactive Video Service.

  • Pour plus de détails sur l’API, consultez GetIngestConfiguration dans la Référence des commandes de l’AWS CLI.

L’exemple de code suivant montre comment utiliser get-participant.

AWS CLI

Exemple 1 : pour obtenir un participant à l’étape

L’exemple get-participant suivant obtient le participant à l’étape pour un ID de participant et un identifiant de session spécifiés dans l’ARN (Amazon Resource Name) de l’étape spécifié.

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

Sortie :

{
    "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": ""
    }
}

Pour plus d’informations, consultez Activation d’hôtes multiples sur un flux Amazon IVS dans le Guide de l’utilisateur de la diffusion à faible latence d’Amazon IVS.

Exemple 2 : pour obtenir un participant à l’étape qui a été répliqué sur une autre étape

L’exemple get-participant suivant obtient le participant à l’étape pour un ID de participant et un identifiant de session spécifiés dans l’ARN (Amazon Resource Name) de l’étape spécifié, lorsque le participant a également été répliqué sur une autre étape.

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

Sortie :

{
    "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": ""
    }
}

Pour plus d’informations, consultez Activation d’hôtes multiples sur un flux Amazon IVS dans le Guide de l’utilisateur de la diffusion à faible latence d’Amazon IVS.

Exemple 3 : pour obtenir un participant à une étape qui a été répliqué depuis une autre étape

L’exemple get-participant suivant obtient le participant à l’étape pour un ID de participant et un identifiant de session spécifiés dans l’ARN (Amazon Resource Name) de l’étape spécifié, lorsque le participant a été répliqué depuis une autre étape.

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

Sortie :

{
    "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": ""
    }
}

Pour plus d’informations, consultez Activation d’hôtes multiples sur un flux Amazon IVS dans le Guide de l’utilisateur de la diffusion à faible latence d’Amazon IVS.

  • Pour plus de détails sur l’API, consultez GetParticipant dans la Référence des commandes de l’AWS CLI.

L’exemple de code suivant montre comment utiliser get-public-key.

AWS CLI

Pour obtenir une clé publique existante utilisée pour signer les jetons des participants à l’étape

L’exemple get-public-key suivant obtient une clé publique spécifiée par l’ARN fourni, pour signer les jetons des participants à l’étape.

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

Sortie :

{
    "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": {}
    }
}

Pour plus d’informations, consultez Distribuer des jetons de participants dans le Guide de l’utilisateur de la diffusion en temps réel d’Amazon IVS.

  • Pour plus de détails sur l’API, consultez GetPublicKey dans la Référence des commandes de l’AWS CLI.

L’exemple de code suivant montre comment utiliser get-stage-session.

AWS CLI

Pour obtenir une session d’étape

L’exemple get-stage-session suivant obtient la session d’étape pour un ID de session spécifié d’un ARN (Amazon Resource Name) d’étape spécifié.

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

Sortie :

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

Pour plus d’informations, consultez Activation d’hôtes multiples sur un flux Amazon IVS dans le Guide de l’utilisateur Amazon Interactive Video Service.

  • Pour plus de détails sur l’API, consultez GetStageSession dans la Référence des commandes de l’AWS CLI.

L’exemple de code suivant montre comment utiliser get-stage.

AWS CLI

Pour obtenir les informations de configuration d’une étape

L’exemple get-stage suivant obtient la configuration d’une étape pour un ARN (Amazon Resource Name) d’étape spécifié.

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

Sortie :

{
    "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": {}
    }
}

Pour plus d’informations, consultez Activation d’hôtes multiples sur un flux Amazon IVS dans le Guide de l’utilisateur de la diffusion à faible latence d’Amazon IVS.

  • Pour plus de détails sur l’API, consultez GetStage dans la Référence des commandes de l’AWS CLI.

L’exemple de code suivant montre comment utiliser get-storage-configuration.

AWS CLI

Pour obtenir une configuration de stockage de montage

L’exemple get-storage-configuration suivant obtient la configuration de stockage de montage spécifiée par l’ARN (Amazon Resource Name) donné.

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

Sortie :

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

Pour plus d’informations, consultez Activation d’hôtes multiples sur un flux Amazon IVS dans le Guide de l’utilisateur Amazon Interactive Video Service.

  • Pour plus de détails sur l’API, consultez GetStorageConfiguration dans la Référence des commandes de l’AWS CLI.

L’exemple de code suivant montre comment utiliser import-public-key.

AWS CLI

Pour importer une clé publique existante à utiliser pour signer les jetons des participants à l’étape

L’exemple import-public-key suivant importe une clé publique à partir d’un fichier matériel, à utiliser pour signer les jetons des participants à l’étape.

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

Sortie :

{
    "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": {}
    }
}

Pour plus d’informations, consultez Distribuer des jetons de participants dans le Guide de l’utilisateur de la diffusion en temps réel d’Amazon IVS.

  • Pour plus de détails sur l’API, consultez ImportPublicKey dans la Référence des commandes de l’AWS CLI.

L’exemple de code suivant montre comment utiliser list-compositions.

AWS CLI

Pour obtenir une liste des montages

L’exemple list-compositions suivant répertorie tous les montages pour votre compte AWS, dans la région AWS où la demande d’API est traitée.

aws ivs-realtime list-compositions

Sortie :

{
    "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": {}
        }
    ]
}

Pour plus d’informations, consultez Activation d’hôtes multiples sur un flux Amazon IVS dans le Guide de l’utilisateur Amazon Interactive Video Service.

  • Pour plus de détails sur l’API, consultez ListCompositions dans la Référence des commandes de l’AWS CLI.

L’exemple de code suivant montre comment utiliser list-encoder-configurations.

AWS CLI

Pour répertorier les configurations des encodeurs de montage

L’exemple list-encoder-configurations suivant répertorie toutes les configurations des encodeurs de montage pour votre compte AWS, dans la région AWS où la demande d’API est traitée.

aws ivs-realtime list-encoder-configurations

Sortie :

{
    "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": {}
        }
    ]
}

Pour plus d’informations, consultez Activation d’hôtes multiples sur un flux Amazon IVS dans le Guide de l’utilisateur Amazon Interactive Video Service.

L’exemple de code suivant montre comment utiliser list-ingest-configurations.

AWS CLI

Pour obtenir les informations récapitulatives sur toutes les configurations d’ingestion

L’exemple list-ingest-configurations suivant répertorie toutes les configurations d’ingestion pour votre compte AWS, dans la région AWS où la demande d’API est traitée.

aws ivs-realtime list-ingest-configurations

Sortie :

{
    "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": "",
        }
    ]
}

Pour plus d’informations, consultez Ingestion de flux IVS | Diffusion en temps réel dans le Guide de l’utilisateur Amazon Interactive Video Service.

  • Pour plus de détails sur l’API, consultez ListIngestConfigurations dans la Référence des commandes de l’AWS CLI.

L’exemple de code suivant montre comment utiliser list-participant-events.

AWS CLI

Exemple 1 : pour obtenir une liste des événements des participants à l’étape

L’exemple list-participant-events suivant répertorie tous les événements des participants pour un ID de participant et un ID de session spécifiés pour un ARN (Amazon Resource Name) d’étape spécifié.

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

Sortie :

{
    "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"
        }
    ]
}

Pour plus d’informations, consultez Activation d’hôtes multiples sur un flux Amazon IVS dans le Guide de l’utilisateur de la diffusion à faible latence d’Amazon IVS.

Exemple 2 : pour obtenir une liste des événements des participants à l’étape, y compris l’arrêt et le démarrage de la réplication des participants

L’exemple list-participant-events suivant répertorie tous les événements des participants pour un ID de session spécifié ou un ARN (Amazon Resource Name) d’étape spécifiés, lorsqu’un participant est répliqué vers une autre étape.

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

Sortie :

{
    "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"
        }
    ]
}

Pour plus d’informations, consultez Activation d’hôtes multiples sur un flux Amazon IVS dans le Guide de l’utilisateur de la diffusion à faible latence d’Amazon IVS.

  • Pour plus de détails sur l’API, consultez ListParticipantEvents dans la Référence des commandes de l’AWS CLI.

L’exemple de code suivant montre comment utiliser list-participant-replicas.

AWS CLI

Pour obtenir une liste des réplicas des participants à l’étape

L’exemple list-participant-replicas suivant répertorie tous les participants à l’étape répliqués depuis l’ARN (Amazon Resource Name) de l’étape source spécifié vers une autre étape.

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

Sortie :

{
    "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"
        }
    ]
}

Pour plus d’informations, consultez Réplication du participant IVS dans le Guide de l’utilisateur de la diffusion en temps réel d’Amazon IVS.

  • Pour plus de détails sur l’API, consultez ListParticipantReplicas dans la Référence des commandes de l’AWS CLI.

L’exemple de code suivant montre comment utiliser list-participants.

AWS CLI

Exemple 1 : pour obtenir la liste des participants à l’étape

L’exemple list-participants suivant répertorie tous les participants pour un ID de session spécifié d’un ARN (Amazon Resource Name) d’étape spécifié.

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

Sortie :

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

Pour plus d’informations, consultez Activation d’hôtes multiples sur un flux Amazon IVS dans le Guide de l’utilisateur de la diffusion à faible latence d’Amazon IVS.

Exemple 2 : pour obtenir une liste des participants à une étape, lorsqu’un participant a été répliqué vers une autre étape

L’exemple list-participants suivant répertorie tous les participants pour un ID de session spécifié d’un ARN (Amazon Resource Name) d’étape spécifié, lorsqu’un participant a été répliqué vers une autre étape.

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

Sortie :

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

Pour plus d’informations, consultez Activation d’hôtes multiples sur un flux Amazon IVS dans le Guide de l’utilisateur de la diffusion à faible latence d’Amazon IVS.

Exemple 3 : pour obtenir une liste des participants à l’étape, lorsqu’un participant a été répliqué depuis une autre étape

L’exemple list-participants suivant répertorie tous les participants pour un ID de session spécifié d’un ARN (Amazon Resource Name) d’étape spécifié, lorsqu’un participant a été répliqué depuis une autre étape.

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

Sortie :

{
    "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"
        }
    ]
}

Pour plus d’informations, consultez Activation d’hôtes multiples sur un flux Amazon IVS dans le Guide de l’utilisateur de la diffusion à faible latence d’Amazon IVS.

  • Pour plus de détails sur l’API, consultez ListParticipants dans la Référence des commandes de l’AWS CLI.

L’exemple de code suivant montre comment utiliser list-public-keys.

AWS CLI

Pour répertorier les clés publiques existantes disponibles pour signer les jetons des participants

L’exemple list-public-keys suivant répertorie toutes les clés publiques disponibles pour signer les jetons des participants à l’étape, dans la région AWS où la demande d’API est traitée.

aws ivs-realtime list-public-keys

Sortie :

{
    "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": {}
        }
    ]
}

Pour plus d’informations, consultez Distribuer des jetons de participants dans le Guide de l’utilisateur de la diffusion en temps réel d’Amazon IVS.

  • Pour plus de détails sur l’API, consultez ListPublicKeys dans la Référence des commandes de l’AWS CLI.

L’exemple de code suivant montre comment utiliser list-stage-sessions.

AWS CLI

Pour obtenir une liste des sessions d’étape

L’exemple list-stage-sessions suivant répertorie toutes les sessions pour un ARN (Amazon Resource Name) d’étape spécifié.

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

Sortie :

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

Pour plus d’informations, consultez Activation d’hôtes multiples sur un flux Amazon IVS dans le Guide de l’utilisateur Amazon Interactive Video Service.

  • Pour plus de détails sur l’API, consultez ListStageSessions dans la Référence des commandes de l’AWS CLI.

L’exemple de code suivant montre comment utiliser list-stages.

AWS CLI

Pour obtenir les informations récapitulatives sur toutes les étapes

L’exemple list-stages suivant répertorie toutes les étapes de votre compte AWS, dans la région AWS où la demande d’API est traitée.

aws ivs-realtime list-stages

Sortie :

{
    "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": {}
        }
    ]
}

Pour plus d’informations, consultez Activation d’hôtes multiples sur un flux Amazon IVS dans le Guide de l’utilisateur Amazon Interactive Video Service.

  • Pour plus de détails sur l’API, consultez ListStages dans la Référence des commandes de l’AWS CLI.

L’exemple de code suivant montre comment utiliser list-storage-configurations.

AWS CLI

Pour répertorier les configurations de stockage de montage

L’exemple list-storage-configurations suivant répertorie toutes les configurations de stockage de montage pour votre compte AWS, dans la région AWS où la demande d’API est traitée.

aws ivs-realtime list-storage-configurations

Sortie :

{
    "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": {}
        }
    ]
}

Pour plus d’informations, consultez Activation d’hôtes multiples sur un flux Amazon IVS dans le Guide de l’utilisateur Amazon Interactive Video Service.

L’exemple de code suivant montre comment utiliser start-composition.

AWS CLI

Exemple 1 : pour démarrer un montage avec les paramètres de mise en page par défaut

L’exemple start-composition suivant démarre un montage pour l’étape spécifiée à diffuser vers les emplacements spécifiés.

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"}}]'

Sortie :

{
    "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": {}
    }
}

Pour plus d’informations, consultez Enregistrement composite IVS | Diffusion en temps réel dans le Guide de l’utilisateur de la diffusion en temps réel d’Amazon IVS.

Exemple 2 : pour démarrer un montage avec une mise en page PiP

L’exemple start-composition suivant démarre un montage pour l’étape spécifiée à diffuser vers les emplacements spécifiés à l’aide d’une mise en page PiP.

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"}'

Sortie :

{
    "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": {}
    }
}

Pour plus d’informations, consultez Enregistrement composite IVS | Diffusion en temps réel dans le Guide de l’utilisateur de la diffusion en temps réel d’Amazon IVS.

Exemple 3 : pour démarrer un montage avec l’enregistrement des miniatures activé

L’exemple start-composition suivant démarre un montage pour l’étape spécifiée à diffuser vers les emplacements spécifiés avec l’enregistrement des miniatures activé.

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}]}}]'

Sortie :

{
    "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": {}
    }
}

Pour plus d’informations, consultez Enregistrement composite IVS | Diffusion en temps réel dans le Guide de l’utilisateur de la diffusion en temps réel d’Amazon IVS.

  • Pour plus de détails sur l’API, consultez StartComposition dans la Référence des commandes de l’AWS CLI.

L’exemple de code suivant montre comment utiliser start-participant-replication.

AWS CLI

Pour commencer à répliquer un participant d’une étape à l’autre

L’exemple start-participant-replication suivant réplique un participant d’une étape source vers une étape de destination, chaque étape étant spécifiée par son ARN (Amazon Resource Name).

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

Sortie :

{
    "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"
}

Pour plus d’informations, consultez Réplication du participant IVS dans le Guide de l’utilisateur de la diffusion en temps réel d’Amazon IVS.

L’exemple de code suivant montre comment utiliser stop-composition.

AWS CLI

Pour arrêter un montage

L’exemple stop-composition suivant arrête le montage spécifié par l’ARN (Amazon Resource Name) donné.

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

Cette commande ne produit aucune sortie.

Pour plus d’informations, consultez Activation d’hôtes multiples sur un flux Amazon IVS dans le Guide de l’utilisateur Amazon Interactive Video Service.

  • Pour plus de détails sur l’API, consultez StopComposition dans la Référence des commandes de l’AWS CLI.

L’exemple de code suivant montre comment utiliser stop-participant-replication.

AWS CLI

Pour arrêter de répliquer un participant d’une étape à l’autre

L’exemple stop-participant-replication suivant arrête de répliquer un participant d’une étape source vers une étape de destination, chaque étape étant spécifiée par son ARN (Amazon Resource Name).

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

Sortie :

{
    "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"
}

Pour plus d’informations, consultez Réplication du participant IVS dans le Guide de l’utilisateur de la diffusion en temps réel d’Amazon IVS.

L’exemple de code suivant montre comment utiliser update-ingest-configuration.

AWS CLI

Pour mettre à jour une configuration d’ingestion

L’exemple update-inegst-configuration suivant met à jour une configuration d’ingestion pour l’associer à une étape.

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

Sortie :

{
    "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": {}
    }
}

Pour plus d’informations, consultez Ingestion de flux IVS | Diffusion en temps réel dans le Guide de l’utilisateur Amazon Interactive Video Service.

L’exemple de code suivant montre comment utiliser update-stage.

AWS CLI

Exemple 1 : pour mettre à jour la configuration d’une étape

L’exemple update-stage suivant met à jour une étape pour un ARN d’étape spécifié afin de mettre à jour le nom de l’étape et de configurer l’enregistrement individuel des participants avec l’enregistrement des miniatures activé.

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

Sortie :

{
    "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": {}
    }
}

Pour plus d’informations, consultez Activation d’hôtes multiples sur un flux Amazon IVS dans le Guide de l’utilisateur de la diffusion à faible latence d’Amazon IVS.

Exemple 2 : pour mettre à jour la configuration d’une étape, notamment en désactivant l’enregistrement des réplicas des participants

L’exemple update-stage suivant met à jour une étape pour un ARN d’étape spécifié afin de mettre à jour le nom de l’étape et de configurer l’enregistrement individuel des participants avec l’enregistrement des miniatures activé et l’enregistrement des réplicas des participants désactivé.

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

Sortie :

{
    "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": {}
    }
}

Pour plus d’informations, consultez Activation d’hôtes multiples sur un flux Amazon IVS dans le Guide de l’utilisateur de la diffusion à faible latence d’Amazon IVS.

  • Pour plus de détails sur l’API, consultez UpdateStage dans la Référence des commandes de l’AWS CLI.