Esempi per lo Streaming in tempo reale di Amazon IVS con AWS CLI - AWS Command Line Interface
Operazioni

Esempi per lo Streaming in tempo reale di Amazon IVS con AWS CLI

Gli esempi di codice seguenti mostrano come eseguire azioni e implementare scenari comuni utilizzando AWS Command Line Interface con lo Streaming in tempo reale di Amazon IVS.

Le operazioni sono estratti di codice da programmi più grandi e devono essere eseguite nel contesto. Sebbene le operazioni mostrino come richiamare le singole funzioni del servizio, è possibile visualizzarle contestualizzate negli scenari correlati.

Ogni esempio include un link al codice sorgente completo, dove è possibile trovare le istruzioni su come configurare ed eseguire il codice nel contesto.

Argomenti

Operazioni

L’esempio di codice seguente mostra come utilizzare create-encoder-configuration.

AWS CLI

Come creare una configurazione del codificatore di composizione

L’esempio create-encoder-configuration seguente crea una configurazione del codificatore di composizione con le proprietà specificate.

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

Output:

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

Per ulteriori informazioni, consulta Abilitazione di host multipli su un flusso Amazon IVS nella Guida per l’utente del Servizio video interattivo Amazon.

L’esempio di codice seguente mostra come utilizzare create-ingest-configuration.

AWS CLI

Come creare una configurazione di importazione

L’esempio create-ingest-configuration seguente crea una configurazione di importazione utilizzando il protocollo RTMPS.

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

Output:

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

Per ulteriori informazioni, consulta Acquisizione dei flussi in IVS | Streaming in tempo reale nella Guida per l’utente di Servizio video interattivo Amazon.

L’esempio di codice seguente mostra come utilizzare create-participant-token.

AWS CLI

Come creare un token di partecipazione di fase

L’esempio create-participant-token seguente crea un token di partecipazione per la fase specificata.

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

Output:

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

Per ulteriori informazioni, consulta Abilitazione di host multipli su un flusso Amazon IVS nella Guida per l’utente del Servizio video interattivo Amazon.

L’esempio di codice seguente mostra come utilizzare create-stage.

AWS CLI

Esempio 1: creare una fase

L’esempio create-stage seguente crea una fase e un token di partecipazione di fase per un utente specificato.

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

Output:

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

Per ulteriori informazioni, consulta Abilitazione di host multipli su un flusso Amazon IVS nella Guida per l’utente dello Streaming a bassa latenza di Amazon IVS.

Esempio 2: creare una fase e configurare la registrazione dei singoli partecipanti

L’esempio create-stage seguente crea una fase e configura la registrazione dei singoli partecipanti.

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

Output:

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

Per ulteriori informazioni, consulta Abilitazione di host multipli su un flusso Amazon IVS nella Guida per l’utente dello Streaming a bassa latenza di Amazon IVS.

Esempio 3: creare una fase e configurare la registrazione dei singoli partecipanti con la registrazione delle anteprime abilitata

L’esempio create-stage seguente crea una fase e configura la registrazione dei singoli partecipanti con la registrazione delle anteprime abilitata.

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

Output:

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

Per ulteriori informazioni, consulta Abilitazione di host multipli su un flusso Amazon IVS nella Guida per l’utente dello Streaming a bassa latenza di Amazon IVS.

  • Per informazioni dettagliate sull’API, consulta CreateStage in AWS CLI Command Reference.

L’esempio di codice seguente mostra come utilizzare create-storage-configuration.

AWS CLI

Come creare una configurazione dell’archiviazione della composizione

L’esempio create-storage-configuration seguente crea una configurazione dell’archiviazione della composizione con le proprietà specificate.

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

Output:

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

Per ulteriori informazioni, consulta Abilitazione di host multipli su un flusso Amazon IVS nella Guida per l’utente del Servizio video interattivo Amazon.

L’esempio di codice seguente mostra come utilizzare delete-encoder-configuration.

AWS CLI

Come eliminare una configurazione del codificatore di composizione

L’esempio delete-encoder-configuration seguente elimina la configurazione del codificatore di composizione specificata dal nome della risorsa Amazon (ARN) indicato.

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

Questo comando non produce alcun output.

Per ulteriori informazioni, consulta Abilitazione di host multipli su un flusso Amazon IVS nella Guida per l’utente del Servizio video interattivo Amazon.

L’esempio di codice seguente mostra come utilizzare delete-ingest-configuration.

AWS CLI

Esempio 1: eliminare una configurazione di importazione inattiva

L’esempio delete-ingest-configuration seguente elimina la configurazione di importazione inattiva per un nome della risorsa Amazon (ARN) di configurazione di importazione specificato.

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

Questo comando non produce alcun output.

Per ulteriori informazioni, consulta Acquisizione dei flussi in IVS | Streaming in tempo reale nella Guida per l’utente di Servizio video interattivo Amazon.

Esempio 2: forzare l’eliminazione di una configurazione di importazione attiva

L’esempio delete-ingest-configuration seguente forza l’eliminazione della configurazione di importazione attiva per un nome della risorsa Amazon (ARN) di configurazione di importazione specificato.

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

Questo comando non produce alcun output.

Per ulteriori informazioni, consulta Acquisizione dei flussi in IVS | Streaming in tempo reale nella Guida per l’utente di Servizio video interattivo Amazon.

L’esempio di codice seguente mostra come utilizzare delete-public-key.

AWS CLI

Come eliminare una chiave pubblica

L’esempio delete-public-key seguente elimina la chiave pubblica specificata.

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

Questo comando non produce alcun output.

Per ulteriori informazioni, consulta Distribuzione dei token di partecipazione nella Guida per l’utente dello Streaming in tempo reale di Amazon IVS.

  • Per informazioni dettagliate sull’API, consulta DeletePublicKey in AWS CLI Command Reference.

L’esempio di codice seguente mostra come utilizzare delete-stage.

AWS CLI

Come eliminare una fase

L’esempio delete-stage seguente elimina la fase specificata.

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

Questo comando non produce alcun output.

Per ulteriori informazioni, consulta Abilitazione di host multipli su un flusso Amazon IVS nella Guida per l’utente del Servizio video interattivo Amazon.

  • Per informazioni dettagliate sull’API, consulta DeleteStage in AWS CLI Command Reference.

L’esempio di codice seguente mostra come utilizzare delete-storage-configuration.

AWS CLI

Come eliminare una configurazione dell’archiviazione della composizione

L’esempio delete-storage-configuration seguente elimina la configurazione dell’archiviazione della composizione specificata dal nome della risorsa Amazon (ARN) indicato.

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

Questo comando non produce alcun output.

Per ulteriori informazioni, consulta Abilitazione di host multipli su un flusso Amazon IVS nella Guida per l’utente del Servizio video interattivo Amazon.

L’esempio di codice seguente mostra come utilizzare disconnect-participant.

AWS CLI

Come disconnettere un partecipante dalla fase

L’esempio disconnect-participant seguente disconnette il partecipante specificato dalla fase specificata.

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

Questo comando non produce alcun output.

Per ulteriori informazioni, consulta Abilitazione di host multipli su un flusso Amazon IVS nella Guida per l’utente del Servizio video interattivo Amazon.

L’esempio di codice seguente mostra come utilizzare get-composition.

AWS CLI

Esempio 1: ottenere una composizione con le impostazioni di layout predefinite

L’esempio get-composition seguente ottiene la composizione per il nome della risorsa Amazon (ARN) specificato.

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

Output:

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

Per ulteriori informazioni, consulta Registrazione composita in IVS I Streaming in tempo reale nella Guida per l’utente dello Streaming in tempo reale di Amazon IVS.

Esempio 2: ottenere una composizione con layout PiP

L’esempio get-composition seguente ottiene la composizione per il nome della risorsa Amazon (ARN) specificato che utilizza il layout PiP.

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

Output:

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

Per ulteriori informazioni, consulta Registrazione composita in IVS I Streaming in tempo reale nella Guida per l’utente dello Streaming in tempo reale di Amazon IVS.

Esempio 3: ottenere una composizione con la registrazione delle anteprime abilitata

L’esempio get-composition seguente ottiene la composizione per il nome della risorsa Amazon (ARN) specificato, che ha la registrazione delle anteprime abilitata con le impostazioni predefinite.

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

Output:

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

Per ulteriori informazioni, consulta Registrazione composita in IVS I Streaming in tempo reale nella Guida per l’utente dello Streaming in tempo reale di Amazon IVS.

  • Per informazioni dettagliate sull’API, consulta GetComposition in AWS CLI Command Reference.

L’esempio di codice seguente mostra come utilizzare get-encoder-configuration.

AWS CLI

Come ottenere una configurazione del codificatore di composizione

L’esempio get-encoder-configuration seguente ottiene la configurazione del codificatore di composizione specificata dal nome della risorsa Amazon (ARN) indicato.

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

Output:

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

Per ulteriori informazioni, consulta Abilitazione di host multipli su un flusso Amazon IVS nella Guida per l’utente del Servizio video interattivo Amazon.

L’esempio di codice seguente mostra come utilizzare get-ingest-configuration.

AWS CLI

Come ottenere informazioni sulla configurazione di importazione

L’esempio get-ingest-configuration seguente ottiene la configurazione di importazione per un nome della risorsa Amazon (ARN) di configurazione di importazione specificato.

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

Output:

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

Per ulteriori informazioni, consulta Acquisizione dei flussi in IVS | Streaming in tempo reale nella Guida per l’utente di Servizio video interattivo Amazon.

L’esempio di codice seguente mostra come utilizzare get-participant.

AWS CLI

Esempio 1: ottenere un partecipante alla fase

L’esempio get-participant seguente ottiene il partecipante alla fase per un ID partecipante e un ID sessione specificati nel nome della risorsa Amazon (ARN) della fase specificato.

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

Output:

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

Per ulteriori informazioni, consulta Abilitazione di host multipli su un flusso Amazon IVS nella Guida per l’utente dello Streaming a bassa latenza di Amazon IVS.

Esempio 2: ottenere un partecipante alla fase che è stato replicato in un’altra fase

L’esempio get-participant seguente ottiene il partecipante alla fase per un ID partecipante e un ID sessione specificati nel nome della risorsa Amazon (ARN) della fase specificato, quando il partecipante è stato replicato anche in un’altra fase.

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

Output:

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

Per ulteriori informazioni, consulta Abilitazione di host multipli su un flusso Amazon IVS nella Guida per l’utente dello Streaming a bassa latenza di Amazon IVS.

Esempio 3: ottenere un partecipante alla fase che è stato replicato da un’altra fase

L’esempio get-participant seguente ottiene il partecipante alla fase per un ID partecipante e un ID sessione specificati nel nome della risorsa Amazon (ARN) della fase specificato, quando il partecipante è stato replicato da un’altra fase.

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

Output:

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

Per ulteriori informazioni, consulta Abilitazione di host multipli su un flusso Amazon IVS nella Guida per l’utente dello Streaming a bassa latenza di Amazon IVS.

  • Per informazioni dettagliate sull’API, consulta GetParticipant in AWS CLI Command Reference.

L’esempio di codice seguente mostra come utilizzare get-public-key.

AWS CLI

Come ottenere una chiave pubblica esistente utilizzata per firmare i token di partecipazione di fase

L’esempio get-public-key seguente ottiene una chiave pubblica specificata dall’ARN fornito, per firmare i token di partecipazione di fase.

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

Output:

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

Per ulteriori informazioni, consulta Distribuzione dei token di partecipazione nella Guida per l’utente dello Streaming in tempo reale di Amazon IVS.

  • Per informazioni dettagliate sull’API, consulta GetPublicKey in AWS CLI Command Reference.

L’esempio di codice seguente mostra come utilizzare get-stage-session.

AWS CLI

Come ottenere una sessione di fase

L’esempio get-stage-session seguente ottiene la sessione di fase per un ID di sessione specificato di un nome della risorsa Amazon (ARN) della fase specificato.

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

Output:

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

Per ulteriori informazioni, consulta Abilitazione di host multipli su un flusso Amazon IVS nella Guida per l’utente del Servizio video interattivo Amazon.

  • Per informazioni dettagliate sull’API, consulta GetStageSession in AWS CLI Command Reference.

L’esempio di codice seguente mostra come utilizzare get-stage.

AWS CLI

Come ottenere informazioni sulla configurazione di una fase

L’esempio get-stage seguente ottiene la configurazione della fase per un nome della risorsa Amazon (ARN) specificato.

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

Output:

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

Per ulteriori informazioni, consulta Abilitazione di host multipli su un flusso Amazon IVS nella Guida per l’utente dello Streaming a bassa latenza di Amazon IVS.

  • Per informazioni dettagliate sull’API, consulta GetStage in AWS CLI Command Reference.

L’esempio di codice seguente mostra come utilizzare get-storage-configuration.

AWS CLI

Come ottenere la configurazione di un’archiviazione della composizione

L’esempio get-storage-configuration seguente ottiene la configurazione dell’archiviazione della composizione specificata dal nome della risorsa Amazon (ARN) indicato.

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

Output:

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

Per ulteriori informazioni, consulta Abilitazione di host multipli su un flusso Amazon IVS nella Guida per l’utente del Servizio video interattivo Amazon.

L’esempio di codice seguente mostra come utilizzare import-public-key.

AWS CLI

Come importare una chiave pubblica esistente da utilizzare per firmare i token di partecipazione di fase

L’esempio import-public-key seguente importa una chiave pubblica da un file di materiale, da utilizzare per firmare i token di partecipazione di fase.

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

Output:

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

Per ulteriori informazioni, consulta Distribuzione dei token di partecipazione nella Guida per l’utente dello Streaming in tempo reale di Amazon IVS.

  • Per informazioni dettagliate sull’API, consulta ImportPublicKey in AWS CLI Command Reference.

L’esempio di codice seguente mostra come utilizzare list-compositions.

AWS CLI

Come ottenere un elenco di composizioni

L’esempio list-compositions seguente elenca tutte le composizioni per l’account AWS, nella Regione AWS in cui viene elaborata la richiesta API.

aws ivs-realtime list-compositions

Output:

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

Per ulteriori informazioni, consulta Abilitazione di host multipli su un flusso Amazon IVS nella Guida per l’utente del Servizio video interattivo Amazon.

  • Per informazioni dettagliate sull’API, consulta ListCompositions in AWS CLI Command Reference.

L’esempio di codice seguente mostra come utilizzare list-encoder-configurations.

AWS CLI

Come elencare le configurazioni del codificatore di composizione

L’esempio list-encoder-configurations seguente elenca tutte le configurazioni del codificatore di composizione per l’account AWS, nella Regione AWS in cui viene elaborata la richiesta API.

aws ivs-realtime list-encoder-configurations

Output:

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

Per ulteriori informazioni, consulta Abilitazione di host multipli su un flusso Amazon IVS nella Guida per l’utente del Servizio video interattivo Amazon.

L’esempio di codice seguente mostra come utilizzare list-ingest-configurations.

AWS CLI

Come ottenere informazioni di riepilogo su tutte le configurazioni di importazione

L’esempio list-ingest-configurations seguente elenca tutte le configurazioni di importazione per l’account AWS, nella Regione AWS in cui viene elaborata la richiesta API.

aws ivs-realtime list-ingest-configurations

Output:

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

Per ulteriori informazioni, consulta Acquisizione dei flussi in IVS | Streaming in tempo reale nella Guida per l’utente di Servizio video interattivo Amazon.

L’esempio di codice seguente mostra come utilizzare list-participant-events.

AWS CLI

Esempio 1: ottenere un elenco degli eventi di partecipazione di fase

L’esempio list-participant-events seguente elenca tutti gli eventi di partecipazione per un ID partecipante e un ID sessione specificati di un nome della risorsa Amazon (ARN) della fase specificato.

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

Output:

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

Per ulteriori informazioni, consulta Abilitazione di host multipli su un flusso Amazon IVS nella Guida per l’utente dello Streaming a bassa latenza di Amazon IVS.

Esempio 2: ottenere un elenco di eventi di partecipazione di fase, inclusi l’arresto e l’avvio della replica del partecipante

L’esempio list-participant-events seguente elenca tutti gli eventi di partecipazione per un ID sessione specificato di un nome della risorsa Amazon (ARN) della fase specificato, in cui un partecipante viene replicato in un’altra fase.

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

Output:

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

Per ulteriori informazioni, consulta Abilitazione di host multipli su un flusso Amazon IVS nella Guida per l’utente dello Streaming a bassa latenza di Amazon IVS.

L’esempio di codice seguente mostra come utilizzare list-participant-replicas.

AWS CLI

Come ottenere un elenco delle repliche dei partecipanti alla fase

L’esempio list-participant-replicas seguente elenca tutti i partecipanti alla fase replicati dal nome della risorsa Amazon (ARN) della fase di origine specificato in un’altra fase.

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

Output:

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

Per ulteriori informazioni, consulta Replica dei partecipanti IVS I Streaming in tempo reale nella Guida per l’utente dello Streaming in tempo reale di Amazon IVS.

L’esempio di codice seguente mostra come utilizzare list-participants.

AWS CLI

Esempio 1: ottenere un elenco dei partecipanti alla fase

L’esempio list-participants seguente elenca tutti i partecipanti per un ID sessione specificato di un nome della risorsa Amazon (ARN) della fase specificato.

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

Output:

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

Per ulteriori informazioni, consulta Abilitazione di host multipli su un flusso Amazon IVS nella Guida per l’utente dello Streaming a bassa latenza di Amazon IVS.

Esempio 2: ottenere un elenco dei partecipanti alla fase, quando un partecipante è stato replicato in un’altra fase

L’esempio list-participants seguente elenca tutti i partecipanti per un ID sessione specificato di un nome della risorsa Amazon (ARN) della fase specificato, quando un partecipante è stato replicato in un’altra fase.

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

Output:

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

Per ulteriori informazioni, consulta Abilitazione di host multipli su un flusso Amazon IVS nella Guida per l’utente dello Streaming a bassa latenza di Amazon IVS.

Esempio 3: ottenere un elenco dei partecipanti alla fase, quando un partecipante è stato replicato da un’altra fase

L’esempio list-participants seguente elenca tutti i partecipanti per un ID sessione specificato di un nome della risorsa Amazon (ARN) della fase specificato, quando un partecipante è stato replicato da un’altra fase.

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

Output:

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

Per ulteriori informazioni, consulta Abilitazione di host multipli su un flusso Amazon IVS nella Guida per l’utente dello Streaming a bassa latenza di Amazon IVS.

  • Per informazioni dettagliate sull’API, consulta ListParticipants in AWS CLI Command Reference.

L’esempio di codice seguente mostra come utilizzare list-public-keys.

AWS CLI

Come elencare le chiavi pubbliche esistenti disponibili per firmare i token di partecipazione alla fase

L’esempio list-public-keys seguente elenca tutte le chiavi pubbliche disponibili per la firma dei token di partecipazione alla fase, nella Regione AWS in cui viene elaborata la richiesta API.

aws ivs-realtime list-public-keys

Output:

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

Per ulteriori informazioni, consulta Distribuzione dei token di partecipazione nella Guida per l’utente dello Streaming in tempo reale di Amazon IVS.

  • Per informazioni dettagliate sull’API, consulta ListPublicKeys in AWS CLI Command Reference.

L’esempio di codice seguente mostra come utilizzare list-stage-sessions.

AWS CLI

Come ottenere un elenco delle sessioni di fase

L’esempio list-stage-sessions seguente elenca tutte le sessioni per un nome della risorsa Amazon (ARN) della fase specificato.

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

Output:

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

Per ulteriori informazioni, consulta Abilitazione di host multipli su un flusso Amazon IVS nella Guida per l’utente del Servizio video interattivo Amazon.

  • Per informazioni dettagliate sull’API, consulta ListStageSessions in AWS CLI Command Reference.

L’esempio di codice seguente mostra come utilizzare list-stages.

AWS CLI

Come ottenere informazioni di riepilogo su tutte le fasi

L’esempio list-stages seguente elenca tutte le fasi per l’account AWS, nella Regione AWS in cui viene elaborata la richiesta API.

aws ivs-realtime list-stages

Output:

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

Per ulteriori informazioni, consulta Abilitazione di host multipli su un flusso Amazon IVS nella Guida per l’utente del Servizio video interattivo Amazon.

  • Per informazioni dettagliate sull’API, consulta ListStages in AWS CLI Command Reference.

L’esempio di codice seguente mostra come utilizzare list-storage-configurations.

AWS CLI

Come elencare le configurazioni dell’archiviazione della composizione

L’esempio list-storage-configurations seguente elenca tutte le configurazioni dell’archiviazione della composizione per l’account AWS, nella Regione AWS in cui viene elaborata la richiesta API.

aws ivs-realtime list-storage-configurations

Output:

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

Per ulteriori informazioni, consulta Abilitazione di host multipli su un flusso Amazon IVS nella Guida per l’utente del Servizio video interattivo Amazon.

L’esempio di codice seguente mostra come utilizzare start-composition.

AWS CLI

Esempio 1: avviare una composizione con le impostazioni di layout predefinite

L’esempio start-composition seguente avvia una composizione per la fase specificata da trasmettere nelle posizioni specificate.

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

Output:

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

Per ulteriori informazioni, consulta Registrazione composita in IVS I Streaming in tempo reale nella Guida per l’utente dello Streaming in tempo reale di Amazon IVS.

Esempio 2: avviare una composizione con il layout PiP

L’esempio start-composition seguente avvia una composizione per la fase specificata da trasmettere nelle posizioni specificate utilizzando il layout 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"}'

Output:

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

Per ulteriori informazioni, consulta Registrazione composita in IVS I Streaming in tempo reale nella Guida per l’utente dello Streaming in tempo reale di Amazon IVS.

Esempio 3: avviare una composizione con la registrazione delle anteprime abilitata

L’esempio start-composition seguente avvia una composizione per la fase specificata da trasmettere nelle posizioni specificate con la registrazione delle anteprime abilitata.

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

Output:

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

Per ulteriori informazioni, consulta Registrazione composita in IVS I Streaming in tempo reale nella Guida per l’utente dello Streaming in tempo reale di Amazon IVS.

  • Per informazioni dettagliate sull’API, consulta StartComposition in AWS CLI Command Reference.

L’esempio di codice seguente mostra come utilizzare start-participant-replication.

AWS CLI

Come avviare la replica di un partecipante da una fase all’altra

L’esempio start-participant-replication seguente replica un partecipante da una fase di origine a una fase di destinazione, con ogni fase specificata dal relativo nome della risorsa Amazon (ARN).

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

Output:

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

Per ulteriori informazioni, consulta Replica dei partecipanti IVS I Streaming in tempo reale nella Guida per l’utente dello Streaming in tempo reale di Amazon IVS.

L’esempio di codice seguente mostra come utilizzare stop-composition.

AWS CLI

Come arrestare una composizione

L’esempio stop-composition seguente arresta la composizione specificata dal nome della risorsa Amazon (ARN) indicato.

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

Questo comando non produce alcun output.

Per ulteriori informazioni, consulta Abilitazione di host multipli su un flusso Amazon IVS nella Guida per l’utente del Servizio video interattivo Amazon.

  • Per informazioni dettagliate sull’API, consulta StopComposition in AWS CLI Command Reference.

L’esempio di codice seguente mostra come utilizzare stop-participant-replication.

AWS CLI

Come arrestare la replica di un partecipante da una fase all’altra

L’esempio stop-participant-replication seguente arresta la replica di un partecipante da una fase di origine a una fase di destinazione, con ogni fase specificata dal relativo nome della risorsa Amazon (ARN).

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

Output:

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

Per ulteriori informazioni, consulta Replica dei partecipanti IVS I Streaming in tempo reale nella Guida per l’utente dello Streaming in tempo reale di Amazon IVS.

L’esempio di codice seguente mostra come utilizzare update-ingest-configuration.

AWS CLI

Come aggiornare una configurazione di importazione

L’esempio update-inegst-configuration seguente aggiorna una configurazione di importazione per collegarla a una fase.

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

Output:

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

Per ulteriori informazioni, consulta Acquisizione dei flussi in IVS | Streaming in tempo reale nella Guida per l’utente di Servizio video interattivo Amazon.

L’esempio di codice seguente mostra come utilizzare update-stage.

AWS CLI

Esempio 1: aggiornare la configurazione di una fase

L’esempio update-stage seguente aggiorna una fase per un nome della risorsa Amazon (ARN) specificato per aggiornare il nome della fase e configurare la registrazione dei singoli partecipanti con la registrazione delle anteprime abilitata.

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

Output:

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

Per ulteriori informazioni, consulta Abilitazione di host multipli su un flusso Amazon IVS nella Guida per l’utente dello Streaming a bassa latenza di Amazon IVS.

Esempio 2: aggiornare la configurazione di una fase, inclusa la disabilitazione della registrazione delle repliche dei partecipanti

L’esempio update-stage seguente aggiorna una fase per un nome della risorsa Amazon (ARN) specificato per aggiornare il nome della fase e configurare la registrazione dei singoli partecipanti con la registrazione delle anteprime abilitata e la registrazione delle repliche dei partecipanti disabilitata.

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

Output:

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

Per ulteriori informazioni, consulta Abilitazione di host multipli su un flusso Amazon IVS nella Guida per l’utente dello Streaming a bassa latenza di Amazon IVS.

  • Per informazioni dettagliate sull’API, consulta UpdateStage in AWS CLI Command Reference.