Exemples d'utilisation d'Amazon IVS AWS CLI - AWS Exemples de code SDK
Actions

D'autres exemples de AWS SDK sont disponibles dans le référentiel AWS Doc SDK Examples GitHub .

Les traductions sont fournies par des outils de traduction automatique. En cas de conflit entre le contenu d'une traduction et celui de la version originale en anglais, la version anglaise prévaudra.

Exemples d'utilisation d'Amazon IVS AWS CLI

Les exemples de code suivants vous montrent comment effectuer des actions et implémenter des scénarios courants à l' AWS Command Line Interface aide 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 façon de configurer et d'exécuter le code en contexte.

Rubriques

Actions

L'exemple de code suivant montre comment utiliserbatch-get-channel.

AWS CLI

Pour obtenir des informations de configuration de canal concernant plusieurs canaux

L'batch-get-channelexemple suivant répertorie les informations relatives aux canaux spécifiés.

aws ivs batch-get-channel \
    --arns arn:aws:ivs:us-west-2:123456789012:channel/abcdABCDefgh \
        arn:aws:ivs:us-west-2:123456789012:channel/efghEFGHijkl

Sortie :

{
    "channels": [
        {
            "arn": "arn:aws:ivs:us-west-2:123456789012:channel/abcdABCDefgh",
            "authorized": false,
            "containerFormat": "TS",
            "ingestEndpoint": "a1b2c3d4e5f6.global-contribute.live-video.net",
            "insecureIngest": false,
            "latencyMode": "LOW",
            "multitrackInputConfiguration": {
                "enabled": false,
                "maximumResolution": "FULL_HD",
                "policy": "ALLOW"
            },
            "name": "channel-1",
            "playbackUrl": "https://a1b2c3d4e5f6.us-west-2.playback.live-video.net/api/video/v1/us-west-2.123456789012.channel-1.abcdEFGH.m3u8",
            "preset": "",
            "playbackRestrictionPolicyArn": "",
            "recordingConfigurationArn": "arn:aws:ivs:us-west-2:123456789012:recording-configuration/ABCD12cdEFgh",
            "srt": {
                "endpoint": "a1b2c3d4e5f6.srt.live-video.net",
                "passphrase": "AB1C2defGHijkLMNo3PqQRstUvwxyzaBCDEfghh4ijklMN5opqrStuVWxyzAbCDEfghIJ"
            },
            "tags": {},
            "type": "STANDARD"
        },
        {
            "arn": "arn:aws:ivs:us-west-2:123456789012:channel/efghEFGHijkl",
            "authorized": false,
            "containerFormat": "FRAGMENTED_MP4",
            "ingestEndpoint": "a1b2c3d4e5f6.global-contribute.live-video.net",
            "insecureIngest": false,
            "latencyMode": "LOW",
            "multitrackInputConfiguration": {
                "enabled": true,
                "maximumResolution": "FULL_HD",
                "policy": "ALLOW"
            },
            "name": "channel-2",
            "playbackUrl": "https://a1b2c3d4e5f6.us-west-2.playback.live-video.net/api/video/v1/us-west-2.123456789012.channel-2.abcdEFGH.m3u8",
            "preset": "",
            "playbackRestrictionPolicyArn": "arn:aws:ivs:us-west-2:123456789012:playback-restriction-policy/ABcdef34ghIJ"",
            "recordingConfigurationArn": "",
            "srt": {
                "endpoint": "a1b2c3d4e5f6.srt.live-video.net",
                "passphrase": "BA1C2defGHijkLMNo3PqQRstUvwxyzaBCDEfghh4ijklMN5opqrStuVWxyzAbCDEfghIJ"
            },
            "tags": {},
            "type": "STANDARD"
        }
    ]
}

Pour plus d'informations, consultez la section Créer un canal dans le guide de l'utilisateur IVS Low-Latency.

  • Pour plus de détails sur l'API, reportez-vous BatchGetChannelà la section Référence des AWS CLI commandes.

L'exemple de code suivant montre comment utiliserbatch-get-stream-key.

AWS CLI

Pour obtenir des informations sur plusieurs clés de flux

L'batch-get-stream-keyexemple suivant permet d'obtenir des informations sur les clés de flux spécifiées.

aws ivs batch-get-stream-key \
    --arns arn:aws:ivs:us-west-2:123456789012:stream-key/skSKABCDefgh \
       arn:aws:ivs:us-west-2:123456789012:stream-key/skSKIJKLmnop

Sortie :

{
    "streamKeys": [
        {
            "arn": "arn:aws:ivs:us-west-2:123456789012:stream-key/skSKABCDefgh",
            "value": "sk_us-west-2_abcdABCDefgh_567890abcdef",
            "channelArn": "arn:aws:ivs:us-west-2:123456789012:channel/abcdABCDefgh",
            "tags": {}
        },
        {
            "arn": "arn:aws:ivs:us-west-2:123456789012:stream-key/skSKIJKLmnop",
            "value": "sk_us-west-2_abcdABCDefgh_567890ghijkl",
            "channelArn": "arn:aws:ivs:us-west-2:123456789012:channel/abcdABCDefgh",
            "tags": {}
        }
     ]
}

Pour plus d'informations, consultez la section Créer un canal dans le guide de l'utilisateur IVS Low-Latency.

  • Pour plus de détails sur l'API, reportez-vous BatchGetStreamKeyà la section Référence des AWS CLI commandes.

L'exemple de code suivant montre comment utiliserbatch-start-viewer-session-revocation.

AWS CLI

Pour révoquer les sessions de visionnage pour plusieurs paires canal-ARN et Viewer-ID

L'batch-start-viewer-session-revocationexemple suivant effectue la révocation de session sur plusieurs paires Channel-ARN et Viewer-ID simultanément. La demande peut se terminer normalement mais renvoyer des valeurs dans le champ d'erreurs si l'appelant n'est pas autorisé à révoquer la session spécifiée.

aws ivs batch-start-viewer-session-revocation \
    --viewer-sessions '[{"channelArn":"arn:aws:ivs:us-west-2:123456789012:channel/abcdABCDefgh1","viewerId":"abcdefg1","viewerSessionVersionsLessThanOrEqualTo":1234567890}, \
      {"channelArn":"arn:aws:ivs:us-west-2:123456789012:channel/abcdABCDefgh2","viewerId":"abcdefg2","viewerSessionVersionsLessThanOrEqualTo":1234567890}]'

Sortie :

{
    "errors": [
        {
            "channelArn": "arn:aws:ivs:us-west-2:123456789012:channel/abcdABCDefgh1",
            "viewerId": "abcdefg1",
            "code": "403",
            "message": "not authorized",
        },
        {
            "channelArn": "arn:aws:ivs:us-west-2:123456789012:channel/abcdABCDefgh2",
            "viewerId": "abcdefg2",
            "code": "403",
            "message": "not authorized",
        }
    ]
}

Pour plus d'informations, reportez-vous à la section Configuration des canaux privés dans le Guide de l'utilisateur d'Amazon Interactive Video Service.

L'exemple de code suivant montre comment utilisercreate-channel.

AWS CLI

Exemple 1 : pour créer une chaîne sans enregistrement

L'create-channelexemple suivant crée une nouvelle chaîne et une clé de diffusion associée pour démarrer le streaming.

aws ivs create-channel \
    --name 'test-channel' \
    --no-insecure-ingest

Sortie :

{
    "channel": {
        "arn": "arn:aws:ivs:us-west-2:123456789012:channel/abcdABCDefgh",
        "authorized": false,
        "containerFormat": "TS",
        "name": "test-channel",
        "latencyMode": "LOW",
        "multitrackInputConfiguration": {
            "enabled": false,
            "maximumResolution": "FULL_HD",
            "policy": "ALLOW"
        },
        "playbackRestrictionPolicyArn": "",
        "recordingConfigurationArn": "",
        "srt": {
            "endpoint": "a1b2c3d4e5f6.srt.live-video.net",
            "passphrase": "AB1C2defGHijkLMNo3PqQRstUvwxyzaBCDEfghh4ijklMN5opqrStuVWxyzAbCDEfghIJ"
        },
        "ingestEndpoint": "a1b2c3d4e5f6.global-contribute.live-video.net",
        "insecureIngest": false,
        "playbackUrl": "https://a1b2c3d4e5f6.us-west-2.playback.live-video.net/api/video/v1/us-west-2.123456789012.channel.abcdEFGH.m3u8",
        "preset": "",
        "tags": {},
        "type": "STANDARD"
    },
    "streamKey": {
        "arn": "arn:aws:ivs:us-west-2:123456789012:stream-key/g1H2I3j4k5L6",
        "value": "sk_us-west-2_abcdABCDefgh_567890abcdef",
        "channelArn": "arn:aws:ivs:us-west-2:123456789012:channel/abcdABCDefgh",
        "tags": {}
    }
}

Pour plus d'informations, consultez la section Créer un canal dans le guide de l'utilisateur IVS Low-Latency.

Exemple 2 : pour créer un canal avec l'enregistrement activé, en utilisant la RecordingConfiguration ressource spécifiée par son ARN

L'create-channelexemple suivant crée une nouvelle chaîne et une clé de diffusion associée pour démarrer le streaming, et configure l'enregistrement pour la chaîne :

aws ivs create-channel \
    --name test-channel-with-recording \
    --insecure-ingest \
    --recording-configuration-arn 'arn:aws:ivs:us-west-2:123456789012:recording-configuration/ABCD12cdEFgh'

Sortie :

{
    "channel": {
        "arn": "arn:aws:ivs:us-west-2:123456789012:channel/abcdABCDefgh",
        "containerFormat": "TS",
        "name": "test-channel-with-recording",
        "latencyMode": "LOW",
        "multitrackInputConfiguration": {
            "enabled": false,
            "maximumResolution": "FULL_HD",
            "policy": "ALLOW"
        },
        "type": "STANDARD",
        "playbackRestrictionPolicyArn": "",
        "recordingConfigurationArn": "arn:aws:ivs:us-west-2:123456789012:recording-configuration/ABCD12cdEFgh",
        "srt": {
            "endpoint": "a1b2c3d4e5f6.srt.live-video.net",
            "passphrase": "BA1C2defGHijkLMNo3PqQRstUvwxyzaBCDEfghh4ijklMN5opqrStuVWxyzAbCDEfghIJ"
        },
        "ingestEndpoint": "a1b2c3d4e5f6.global-contribute.live-video.net",
        "insecureIngest": true,
        "playbackUrl": "https://a1b2c3d4e5f6.us-west-2.playback.live-video.net/api/video/v1/us-west-2.123456789012.channel.abcdEFGH.m3u8",
        "preset": "",
        "authorized": false,
        "tags": {},
        "type": "STANDARD"
    },
    "streamKey": {
        "arn": "arn:aws:ivs:us-west-2:123456789012:stream-key/abcdABCDefgh",
        "value": "sk_us-west-2_abcdABCDefgh_567890abcdef",
        "channelArn": "arn:aws:ivs:us-west-2:123456789012:channel/abcdABCDefgh",
        "tags": {}
    }
}

Pour plus d'informations, consultez la section Enregistrer sur Amazon S3 dans le guide de l'utilisateur IVS Low-Latency.

Exemple 3 : pour créer une chaîne avec une politique de restriction de lecture spécifiée par son ARN

L'create-channelexemple suivant crée une nouvelle chaîne et une clé de diffusion associée pour démarrer le streaming, et définit une politique de restriction de lecture pour la chaîne :

aws ivs create-channel \
    --name test-channel-with-playback-restriction-policy\
    --insecure-ingest \
    --playback-restriction-policy-arn 'arn:aws:ivs:us-west-2:123456789012:playback-restriction-policy/ABcdef34ghIJ'

Sortie :

{
    "channel": {
        "arn": "arn:aws:ivs:us-west-2:123456789012:channel/abcdABCDefgh",
        "containerFormat": "TS",
        "name": "test-channel-with-playback-restriction-policy",
        "latencyMode": "LOW",
        "multitrackInputConfiguration": {
            "enabled": false,
            "maximumResolution": "FULL_HD",
            "policy": "ALLOW"
        },
        "type": "STANDARD",
        "playbackRestrictionPolicyArn": "arn:aws:ivs:us-west-2:123456789012:playback-restriction-policy/ABcdef34ghIJ",
        "recordingConfigurationArn": "",
        "srt": {
            "endpoint": "a1b2c3d4e5f6.srt.live-video.net",
            "passphrase": "AB1C2edfGHijkLMNo3PqQRstUvwxyzaBCDEfghh4ijklMN5opqrStuVWxyzAbCDEfghIJ"
        },
        "ingestEndpoint": "a1b2c3d4e5f6.global-contribute.live-video.net",
        "insecureIngest": true,
        "playbackUrl": "https://a1b2c3d4e5f6.us-west-2.playback.live-video.net/api/video/v1/us-west-2.123456789012.channel.abcdEFGH.m3u8",
        "preset": "",
        "authorized": false,
        "tags": {},
        "type": "STANDARD"
    },
    "streamKey": {
        "arn": "arn:aws:ivs:us-west-2:123456789012:stream-key/abcdABCDefgh",
        "value": "sk_us-west-2_abcdABCDefgh_567890abcdef",
        "channelArn": "arn:aws:ivs:us-west-2:123456789012:channel/abcdABCDefgh",
        "tags": {}
    }
}

Pour plus d'informations, consultez la section Contenu et spectateurs indésirables dans le guide de l'utilisateur IVS Low-Latency.

Exemple 4 : pour créer une chaîne avec le multipiste activé

L'create-channelexemple suivant crée un nouveau canal et une clé de diffusion associée pour démarrer le streaming, et active le multipiste.

aws ivs create-channel \
    --name 'test-channel' \
    --no-insecure-ingest \
    --container-format 'FRAGMENTED_MP4' \
    --multitrack-input-configuration '{"enabled": true,"maximumResolution": "FULL_HD","policy": "ALLOW"}'

Sortie :

{
    "channel": {
        "arn": "arn:aws:ivs:us-west-2:123456789012:channel/abcdABCDefgh",
        "authorized": false,
        "containerFormat": "FRAGMENTED_MP4",
        "name": "test-channel",
        "latencyMode": "LOW",
        "multitrackInputConfiguration": {
            "enabled": true,
            "maximumResolution": "FULL_HD",
            "policy": "ALLOW"
        },
        "playbackRestrictionPolicyArn": "",
        "recordingConfigurationArn": "",
        "srt": {
            "endpoint": "a1b2c3d4e5f6.srt.live-video.net",
            "passphrase": "AB1C2defGHijkLMNo3PqQRstUvwxyzaBCDEfghh4ijklMN5opqrStuVWxyzAbCDEfghIJ"
        },
        "ingestEndpoint": "a1b2c3d4e5f6.global-contribute.live-video.net",
        "insecureIngest": false,
        "playbackUrl": "https://a1b2c3d4e5f6.us-west-2.playback.live-video.net/api/video/v1/us-west-2.123456789012.channel.abcdEFGH.m3u8",
        "preset": "",
        "tags": {},
        "type": "STANDARD"
    },
    "streamKey": {
        "arn": "arn:aws:ivs:us-west-2:123456789012:stream-key/g1H2I3j4k5L6",
        "value": "sk_us-west-2_abcdABCDefgh_567890abcdef",
        "channelArn": "arn:aws:ivs:us-west-2:123456789012:channel/abcdABCDefgh",
        "tags": {}
    }
}

Pour plus d'informations, consultez la section Créer un canal dans le guide de l'utilisateur IVS Low-Latency.

  • Pour plus de détails sur l'API, reportez-vous CreateChannelà la section Référence des AWS CLI commandes.

L'exemple de code suivant montre comment utilisercreate-playback-restriction-policy.

AWS CLI

Pour créer une politique de restriction de lecture

L'create-playback-restriction-policyexemple suivant crée une nouvelle politique de restriction de lecture.

aws ivs create-playback-restriction-policy \
    --name "test-playback-restriction-policy" \
    --enable-strict-origin-enforcement \
    --tags "key1=value1, key2=value2" \
    --allowed-countries US MX \
    --allowed-origins https://www.website1.com https://www.website2.com

Sortie :

{
    "playbackRestrictionPolicy": {
        "arn": "arn:aws:ivs:us-west-2:123456789012:playback-restriction-policy/ABcdef34ghIJ",
        "allowedCountries": [
            "US",
            "MX"
        ],
        "allowedOrigins": [
            "https://www.website1.com",
            "https://www.website2.com"
        ],
        "enableStrictOriginEnforcement": true,
        "name": "test-playback-restriction-policy",
        "tags": {
            "key1": "value1",
            "key2": "value2"
        }
    }
}

Pour plus d'informations, consultez la section Contenu et spectateurs indésirables dans le guide de l'utilisateur IVS Low-Latency.

L'exemple de code suivant montre comment utilisercreate-recording-configuration.

AWS CLI

Pour créer une RecordingConfiguration ressource

L'create-recording-configurationexemple suivant crée une RecordingConfiguration ressource pour activer l'enregistrement sur Amazon S3.

aws ivs create-recording-configuration \
    --name "test-recording-config" \
    --recording-reconnect-window-seconds 60 \
    --tags "key1=value1, key2=value2" \
    --rendition-configuration renditionSelection="CUSTOM",renditions="HD" \
    --thumbnail-configuration recordingMode="INTERVAL",targetIntervalSeconds=1,storage="LATEST",resolution="LOWEST_RESOLUTION" \
    --destination-configuration s3={bucketName=demo-recording-bucket}

Sortie :

{
    "recordingConfiguration": {
        "arn": "arn:aws:ivs:us-west-2:123456789012:recording-configuration/ABcdef34ghIJ",
        "name": "test-recording-config",
        "destinationConfiguration": {
            "s3": {
                "bucketName": "demo-recording-bucket"
            }
        },
        "state": "CREATING",
        "tags": {
            "key1": "value1",
            "key2": "value2"
        },
        "thumbnailConfiguration": {
            "recordingMode": "INTERVAL",
            "targetIntervalSeconds": 1,
            "resolution": "LOWEST_RESOLUTION",
            "storage": [
                "LATEST"
            ]
        },
        "recordingReconnectWindowSeconds": 60,
        "renditionConfiguration": {
            "renditionSelection": "CUSTOM",
            "renditions": [
                "HD"
            ]
        }
    }
}

Pour plus d'informations, consultez la section Enregistrer sur Amazon S3 dans le guide de l'utilisateur d'Amazon Interactive Video Service.

L'exemple de code suivant montre comment utilisercreate-stream-key.

AWS CLI

Pour créer une clé de flux

L'create-stream-keyexemple suivant crée une clé de flux pour un ARN (Amazon Resource Name) spécifié.

aws ivs create-stream-key \
    --channel-arn arn:aws:ivs:us-west-2:123456789012:channel/abcdABCDefgh

Sortie :

{
    "streamKey": {
        "arn": "arn:aws:ivs:us-west-2:123456789012:stream-key/abcdABCDefgh",
        "value": "sk_us-west-2_abcdABCDefgh_567890abcdef",
        "channelArn": "arn:aws:ivs:us-west-2:123456789012:channel/abcdABCDefgh",
        "tags": {}
    }
}

Pour plus d'informations, consultez la section Créer un canal dans le guide de l'utilisateur IVS Low-Latency.

  • Pour plus de détails sur l'API, reportez-vous CreateStreamKeyà la section Référence des AWS CLI commandes.

L'exemple de code suivant montre comment utiliserdelete-channel.

AWS CLI

Pour supprimer une chaîne et les clés de diffusion associées

L'delete-channelexemple suivant supprime le canal avec l'ARN (Amazon Resource Name) spécifié.

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

Cette commande ne produit aucun résultat.

Pour plus d'informations, consultez la section Créer un canal dans le guide de l'utilisateur IVS Low-Latency.

  • Pour plus de détails sur l'API, reportez-vous DeleteChannelà la section Référence des AWS CLI commandes.

L'exemple de code suivant montre comment utiliserdelete-playback-key-pair.

AWS CLI

Pour supprimer une paire de clés de lecture spécifiée

L'delete-playback-key-pairexemple suivant renvoie l'empreinte digitale de la paire de clés spécifiée.

aws ivs delete-playback-key-pair \
    --arn arn:aws:ivs:us-west-2:123456789012:playback-key/abcd1234efgh

Cette commande ne produit aucun résultat.

Pour plus d'informations, reportez-vous à la section Configuration des canaux privés dans le Guide de l'utilisateur d'Amazon Interactive Video Service.

  • Pour plus de détails sur l'API, reportez-vous DeletePlaybackKeyPairà la section Référence des AWS CLI commandes.

L'exemple de code suivant montre comment utiliserdelete-playback-restriction-policy.

AWS CLI

Pour supprimer une politique de restriction de lecture

L'delete-playback-restriction-policyexemple suivant supprime la politique de restriction de lecture avec l'ARN de politique spécifié (Amazon Resource Name).

aws ivs delete-playback-restriction-policy \
    --arn "arn:aws:ivs:us-west-2:123456789012:playback-restriction-policy/ABcdef34ghIJ"

Cette commande ne produit aucun résultat.

Pour plus d'informations, consultez la section Contenu et spectateurs indésirables dans le guide de l'utilisateur IVS Low-Latency.

L'exemple de code suivant montre comment utiliserdelete-recording-configuration.

AWS CLI

Pour supprimer la RecordingConfiguration ressource spécifiée par son ARN

L'delete-recording-configurationexemple suivant supprime la RecordingConfiguration ressource avec l'ARN spécifié.

aws ivs delete-recording-configuration \
    --arn "arn:aws:ivs:us-west-2:123456789012:recording-configuration/ABcdef34ghIJ"

Cette commande ne produit aucun résultat.

Pour plus d'informations, consultez la section Enregistrer sur Amazon S3 dans le guide de l'utilisateur d'Amazon Interactive Video Service.

L'exemple de code suivant montre comment utiliserdelete-stream-key.

AWS CLI

Pour supprimer une clé de diffusion

L'delete-stream-keyexemple suivant supprime la clé de flux pour un ARN (Amazon Resource Name) spécifié, afin qu'il ne puisse plus être utilisé pour le streaming.

aws ivs delete-stream-key \
    --arn arn:aws:ivs:us-west-2:123456789012:stream-key/g1H2I3j4k5L6

Cette commande ne produit aucun résultat.

Pour plus d'informations, consultez la section Créer un canal dans le guide de l'utilisateur IVS Low-Latency.

  • Pour plus de détails sur l'API, reportez-vous DeleteStreamKeyà la section Référence des AWS CLI commandes.

L'exemple de code suivant montre comment utiliserget-channel.

AWS CLI

Pour obtenir les informations de configuration d'une chaîne

L'get-channelexemple suivant obtient la configuration du canal pour un ARN de canal spécifié (Amazon Resource Name).

aws ivs get-channel \
    --arn 'arn:aws:ivs:us-west-2:123456789012:channel/abcdABCDefgh'

Sortie :

{
    "channel": {
        "arn": "arn:aws:ivs:us-west-2:123456789012:channel/abcdABCDefgh",
        "authorized": false,
        "containerFormat": "TS",
        "ingestEndpoint": "a1b2c3d4e5f6.global-contribute.live-video.net",
        "insecureIngest": false,
        "latencyMode": "LOW",
        "multitrackInputConfiguration": {
            "enabled": false,
            "maximumResolution": "FULL_HD",
            "policy": "ALLOW"
        },
        "name": "channel-1",
        "playbackRestrictionPolicyArn": "",
        "playbackUrl": "https://a1b2c3d4e5f6.us-west-2.playback.live-video.net/api/video/v1/us-west-2.123456789012.channel.abcdEFGH.m3u8",
        "preset": "",
        "recordingConfigurationArn": "",
        "srt": {
            "endpoint": "a1b2c3d4e5f6.srt.live-video.net",
            "passphrase": "AB1C2defGHijkLMNo3PqQRstUvwxyzaBCDEfghh4ijklMN5opqrStuVWxyzAbCDEfghIJ"
        },
        "tags": {}
        "type": "STANDARD",
    }
}

Pour plus d'informations, consultez la section Créer un canal dans le guide de l'utilisateur IVS Low-Latency.

  • Pour plus de détails sur l'API, reportez-vous GetChannelà la section Référence des AWS CLI commandes.

L'exemple de code suivant montre comment utiliserget-playback-key-pair.

AWS CLI

Pour obtenir une paire de clés de lecture spécifiée

L'get-playback-key-pairexemple suivant renvoie l'empreinte digitale de la paire de clés spécifiée.

aws ivs get-playback-key-pair \
    --arn arn:aws:ivs:us-west-2:123456789012:playback-key/abcd1234efgh

Sortie :

{
    "keyPair": {
        "arn": "arn:aws:ivs:us-west-2:123456789012:playback-key/abcd1234efgh",
        "name": "my-playback-key",
        "fingerprint": "0a:1b:2c:ab:cd:ef:34:56:70:b1:b2:71:01:2a:a3:72",
        "tags": {}
    }
}

Pour plus d'informations, reportez-vous à la section Configuration des canaux privés dans le Guide de l'utilisateur d'Amazon Interactive Video Service.

  • Pour plus de détails sur l'API, reportez-vous GetPlaybackKeyPairà la section Référence des AWS CLI commandes.

L'exemple de code suivant montre comment utiliserget-playback-restriction-policy.

AWS CLI

Pour obtenir les informations de configuration d'une politique de restriction de lecture

L'get-playback-restriction-policyexemple suivant obtient la configuration de la politique de restriction de lecture avec l'ARN de politique spécifié (Amazon Resource Name).

aws ivs get-playback-restriction-policy \
    --arn "arn:aws:ivs:us-west-2:123456789012:playback-restriction-policy/ABcdef34ghIJ"

Sortie :

{
    "playbackRestrictionPolicy": {
        "arn": "arn:aws:ivs:us-west-2:123456789012:playback-restriction-policy/ABcdef34ghIJ",
        "allowedCountries": [
            "US",
            "MX"
        ],
        "allowedOrigins": [
            "https://www.website1.com",
            "https://www.website2.com"
        ],
        "enableStrictOriginEnforcement": true,
        "name": "test-playback-restriction-policy",
        "tags": {
            "key1": "value1",
            "key2": "value2"
        }
    }
}

Pour plus d'informations, consultez la section Contenu et spectateurs indésirables dans le guide de l'utilisateur IVS Low-Latency.

L'exemple de code suivant montre comment utiliserget-recording-configuration.

AWS CLI

Pour obtenir des informations sur une RecordingConfiguration ressource

L'get-recording-configurationexemple suivant permet d'obtenir des informations sur la RecordingConfiguration ressource pour l'ARN spécifié.

aws ivs get-recording-configuration \
    --arn "arn:aws:ivs:us-west-2:123456789012:recording-configuration/ABcdef34ghIJ"

Sortie :

{
    "recordingConfiguration": {
        "arn": "arn:aws:ivs:us-west-2:123456789012:recording-configuration/ABcdef34ghIJ",
        "destinationConfiguration": {
            "s3": {
                "bucketName": "demo-recording-bucket"
            }
        },
        "name": "test-recording-config",
        "recordingReconnectWindowSeconds": 60,
        "state": "ACTIVE",
        "tags": {
            "key1" : "value1",
            "key2" : "value2"
        },
        "thumbnailConfiguration": {
            "recordingMode": "INTERVAL",
            "targetIntervalSeconds": 1,
            "resolution": "LOWEST_RESOLUTION",
            "storage": [
                "LATEST"
            ]
        },
        "renditionConfiguration": {
            "renditionSelection": "CUSTOM",
            "renditions": [
                "HD"
            ]
        }
    }
}

Pour plus d'informations, consultez la section Enregistrer sur Amazon S3 dans le guide de l'utilisateur d'Amazon Interactive Video Service.

L'exemple de code suivant montre comment utiliserget-stream-key.

AWS CLI

Pour obtenir des informations sur un stream

L'get-stream-keyexemple suivant permet d'obtenir des informations sur la clé de flux spécifiée.

aws ivs get-stream-key \
    --arn arn:aws:ivs:us-west-2:123456789012:stream-key/skSKABCDefgh --region=us-west-2

Sortie :

{
    "streamKey": {
        "arn": "arn:aws:ivs:us-west-2:123456789012:stream-key/skSKABCDefgh",
        "value": "sk_us-west-2_abcdABCDefgh_567890abcdef",
        "channelArn": "arn:aws:ivs:us-west-2:123456789012:channel/abcdABCDefgh",
        "tags": {}
    }
}

Pour plus d'informations, consultez la section Créer un canal dans le guide de l'utilisateur IVS Low-Latency.

  • Pour plus de détails sur l'API, reportez-vous GetStreamKeyà la section Référence des AWS CLI commandes.

L'exemple de code suivant montre comment utiliserget-stream-session.

AWS CLI

Pour obtenir les métadonnées d'un flux spécifique

L'get-stream-sessionexemple suivant obtient la configuration des métadonnées pour l'ARN du canal spécifié (Amazon Resource Name) et le flux spécifié ; si ce n'streamIdest pas le cas, le flux le plus récent du canal est sélectionné.

aws ivs get-stream-session \
    --channel-arn 'arn:aws:ivs:us-west-2:123456789012:channel/abcdABCDefgh' \
    --stream-id 'mystream'

Sortie :

{
    "streamSession": {
        "streamId": "mystream1",
        "startTime": "2023-06-26T19:09:28+00:00",
        "channel": {
            "arn": "arn:aws:ivs:us-west-2:123456789012:channel/abcdABCDefgh",
            "name": "mychannel",
            "latencyMode": "LOW",
            "type": "STANDARD",
            "recordingConfigurationArn": "arn:aws:ivs:us-west-2:123456789012:recording-configuration/ABcdef34ghIJ",
            "ingestEndpoint": "a1b2c3d4e5f6.global-contribute.live-video.net",
            "playbackUrl": "url-string",
            "authorized": false,
            "insecureIngest": false,
            "preset": ""
        },
        "ingestConfiguration": {
            "audio": {
                "channels": 2,
                "codec": "mp4a.40.2",
                "sampleRate": 8000,
                "targetBitrate": 46875,
                "track": "Track0"
            },
            "video": {
                "avcProfile": "Baseline",
                "avcLevel": "4.2",
                "codec": "avc1.42C02A",
                "encoder": "Lavf58.45.100",
                "level": "4.2",
                "profile": "Baseline",
                "targetBitrate": 8789062,
                "targetFramerate": 60,
                "track": "Track0",
                "videoHeight": 1080,
                "videoWidth": 1920
            }
        },
        "ingestConfigurations": {
            "audioConfigurations": [
                {
                    "channels": 2,
                    "codec": "mp4a.40.2",
                    "sampleRate": 8000,
                    "targetBitrate": 46875,
                    "track": "Track0"
                }
            ],
            "videoConfigurations": [
                {
                    "codec": "avc1.42C02A",
                    "encoder": "Lavf58.45.100",
                    "level": "4.2",
                    "profile": "Baseline",
                    "targetBitrate": 8789062,
                    "targetFramerate": 60,
                    "track": "Track0",
                    "videoHeight": 1080,
                    "videoWidth": 1920
                }
            ]
        },
        "recordingConfiguration": {
            "arn": "arn:aws:ivs:us-west-2:123456789012:recording-configuration/ABcdef34ghIJ",
            "name": "test-recording-config",
            "destinationConfiguration": {
                "s3": {
                    "bucketName": "demo-recording-bucket"
                }
            },
            "state": "ACTIVE",
            "tags": {
                "key1": "value1",
                "key2": "value2"
            },
            "thumbnailConfiguration": {
                "recordingMode": "INTERVAL",
                "targetIntervalSeconds": 1,
                "resolution": "LOWEST_RESOLUTION",
                "storage": [
                    "LATEST"
                ]
            },
            "recordingReconnectWindowSeconds": 60,
            "renditionConfiguration": {
                "renditionSelection": "CUSTOM",
                "renditions": [
                    "HD"
                ]
            }
        },
        "truncatedEvents": [
            {
                "code": "StreamTakeoverInvalidPriority",
                "name": "Stream Takeover Failure",
                "type": "IVS Stream State Change",
                "eventTime": "2023-06-26T19:09:48+00:00"
            },
            {
                "name": "Stream Takeover",
                "type": "IVS Stream State Change",
                "eventTime": "2023-06-26T19:09:47+00:00"
            },
            {
                "name": "Recording Start",
                "type": "IVS Recording State Change",
                "eventTime": "2023-06-26T19:09:35+00:00"
            },
            {
                "name": "Stream Start",
                "type": "IVS Stream State Change",
                "eventTime": "2023-06-26T19:09:34+00:00"
            },
            {
                "name": "Session Created",
                "type": "IVS Stream State Change",
                "eventTime": "2023-06-26T19:09:28+00:00"
            }
        ]
    }
}

Pour plus d'informations, consultez la section Créer un canal dans le guide de l'utilisateur IVS Low-Latency.

  • Pour plus de détails sur l'API, reportez-vous GetStreamSessionà la section Référence des AWS CLI commandes.

L'exemple de code suivant montre comment utiliserget-stream.

AWS CLI

Pour obtenir des informations sur un stream

L'get-streamexemple suivant permet d'obtenir des informations sur le flux pour le canal spécifié.

aws ivs get-stream \
    --channel-arn arn:aws:ivs:us-west-2:123456789012:channel/abcdABCDefgh

Sortie :

{
    "stream": {
        "channelArn": "arn:aws:ivs:us-west-2:123456789012:channel/abcdABCDefgh",
        "playbackUrl": "https://a1b2c3d4e5f6.us-west-2.playback.live-video.net/api/video/v1/us-west-2.123456789012.channel.abcdEFGH.m3u8",
        "startTime": "2020-05-05T21:55:38Z",
        "state": "LIVE",
        "health": "HEALTHY",
        "streamId": "st-ABCDEfghij01234KLMN5678",
        "viewerCount": 1
    }
}

Pour plus d'informations, consultez la section Créer un canal dans le guide de l'utilisateur IVS Low-Latency.

  • Pour plus de détails sur l'API, reportez-vous GetStreamà la section Référence des AWS CLI commandes.

L'exemple de code suivant montre comment utiliserimport-playback-key-pair.

AWS CLI

Pour importer la partie publique d'une nouvelle paire de clés

L'import-playback-key-pairexemple suivant importe la clé publique spécifiée (spécifiée sous forme de chaîne au format PEM) et renvoie l'ARN et l'empreinte de la nouvelle paire de clés.

aws ivs import-playback-key-pair \
    --name "my-playback-key" \
    --public-key-material "G1lbnQxOTA3BgNVBAMMMFdoeSBhcmUgeW91IGRl..."

Sortie :

{
    "keyPair": {
        "arn": "arn:aws:ivs:us-west-2:123456789012:playback-key/abcd1234efgh",
        "name": "my-playback-key",
        "fingerprint": "0a:1b:2c:ab:cd:ef:34:56:70:b1:b2:71:01:2a:a3:72",
        "tags": {}
    }
}

Pour plus d'informations, reportez-vous à la section Configuration des canaux privés dans le Guide de l'utilisateur d'Amazon Interactive Video Service.

  • Pour plus de détails sur l'API, reportez-vous ImportPlaybackKeyPairà la section Référence des AWS CLI commandes.

L'exemple de code suivant montre comment utiliserlist-channels.

AWS CLI

Exemple 1 : Pour obtenir des informations récapitulatives sur toutes les chaînes

L'list-channelsexemple suivant répertorie toutes les chaînes associées à votre AWS compte.

aws ivs list-channels

Sortie :

{
    "channels": [
        {
            "arn": "arn:aws:ivs:us-west-2:123456789012:channel/abcdABCDefgh",
            "name": "channel-1",
            "latencyMode": "LOW",
            "authorized": false,
            "insecureIngest": false,
            "preset": "",
            "playbackRestrictionPolicyArn": "",
            "recordingConfigurationArn": "arn:aws:ivs:us-west-2:123456789012:recording-configuration/ABCD12cdEFgh",
            "tags": {},
            "type": "STANDARD"
        },
        {
            "arn": "arn:aws:ivs:us-west-2:123456789012:channel/efghEFGHijkl",
            "name": "channel-2",
            "latencyMode": "LOW",
            "authorized": false,
            "preset": "",
            "playbackRestrictionPolicyArn": "arn:aws:ivs:us-west-2:123456789012:playback-restriction-policy/ABcdef34ghIJ",
            "recordingConfigurationArn": "",
            "tags": {},
            "type": "STANDARD"
        }
    ]
}

Pour plus d'informations, consultez la section Créer un canal dans le guide de l'utilisateur IVS Low-Latency.

Exemple 2 : pour obtenir des informations récapitulatives sur tous les canaux, filtrées selon l' RecordingConfiguration ARN spécifié

L'list-channelsexemple suivant répertorie tous les canaux associés à l' RecordingConfiguration ARN spécifié pour votre AWS compte.

aws ivs list-channels \
    --filter-by-recording-configuration-arn "arn:aws:ivs:us-west-2:123456789012:recording-configuration/ABCD12cdEFgh"

Sortie :

{
    "channels": [
        {
            "arn": "arn:aws:ivs:us-west-2:123456789012:channel/abcdABCDefgh",
            "name": "channel-1",
            "latencyMode": "LOW",
            "authorized": false,
            "insecureIngest": false,
            "preset": "",
            "playbackRestrictionPolicyArn": "",
            "recordingConfigurationArn": "arn:aws:ivs:us-west-2:123456789012:recording-configuration/ABCD12cdEFgh",
            "tags": {},
            "type": "STANDARD"
        }
    ]
}

Pour plus d'informations, consultez la section Enregistrer sur Amazon S3 dans le guide de l'utilisateur IVS Low-Latency.

Exemple 3 : pour obtenir des informations récapitulatives sur tous les canaux, filtrées selon l' PlaybackRestrictionPolicy ARN spécifié

L'list-channelsexemple suivant répertorie tous les canaux associés à l' PlaybackRestrictionPolicy ARN spécifié pour votre AWS compte.

aws ivs list-channels \
    --filter-by-playback-restriction-policy-arn "arn:aws:ivs:us-west-2:123456789012:playback-restriction-policy/ABcdef34ghIJ"

Sortie :

{
    "channels": [
        {
            "arn": "arn:aws:ivs:us-west-2:123456789012:channel/efghEFGHijkl",
            "name": "channel-2",
            "latencyMode": "LOW",
            "authorized": false,
            "preset": "",
            "playbackRestrictionPolicyArn": "arn:aws:ivs:us-west-2:123456789012:playback-restriction-policy/ABcdef34ghIJ",
            "recordingConfigurationArn": "",
            "tags": {},
            "type": "STANDARD"
        }
    ]
}

Pour plus d'informations, consultez la section Contenu et spectateurs indésirables dans le guide de l'utilisateur IVS Low-Latency.

  • Pour plus de détails sur l'API, reportez-vous ListChannelsà la section Référence des AWS CLI commandes.

L'exemple de code suivant montre comment utiliserlist-playback-key-pairs.

AWS CLI

Pour obtenir des informations récapitulatives sur toutes les paires de touches de lecture

L'list-playback-key-pairsexemple suivant renvoie des informations sur toutes les paires de clés.

aws ivs list-playback-key-pairs

Sortie :

{
    "keyPairs": [
        {
            "arn": "arn:aws:ivs:us-west-2:123456789012:playback-key/abcd1234efgh",
            "name": "test-key-0",
            "tags": {}
        },
        {
            "arn": "arn:aws:ivs:us-west-2:123456789012:playback-key/ijkl5678mnop",
            "name": "test-key-1",
            "tags": {}
        }
    ]
}

Pour plus d'informations, reportez-vous à la section Configuration des canaux privés dans le Guide de l'utilisateur d'Amazon Interactive Video Service.

  • Pour plus de détails sur l'API, reportez-vous ListPlaybackKeyPairsà la section Référence des AWS CLI commandes.

L'exemple de code suivant montre comment utiliserlist-playback-restriction-policies.

AWS CLI

Pour obtenir des informations récapitulatives sur toutes les politiques de restriction de lecture

L'list-playback-restriction-policiesexemple suivant répertorie toutes les politiques de restriction de lecture applicables à votre AWS compte.

aws ivs list-playback-restriction-policies

Sortie :

{
    "playbackRestrictionPolicies": [
        {
            "arn": "arn:aws:ivs:us-west-2:123456789012:playback-restriction-policy/ABcdef34ghIJ",
            "allowedCountries": [
                "US",
                "MX"
            ],
            "allowedOrigins": [
                "https://www.website1.com",
                "https://www.website2.com"
            ],
            "enableStrictOriginEnforcement": true,
            "name": "test-playback-restriction-policy",
            "tags": {
                "key1": "value1",
                "key2": "value2"
            }
        }
    ]
}

Pour plus d'informations, consultez la section Contenu et spectateurs indésirables dans le guide de l'utilisateur IVS Low-Latency.

L'exemple de code suivant montre comment utiliserlist-recording-configurations.

AWS CLI

Pour répertorier toutes les RecordingConfiguration ressources créées dans ce compte

L'list-recording-configurationsexemple suivant permet d'obtenir des informations sur toutes les RecordingConfiguration ressources de votre compte.

aws ivs list-recording-configurations

Sortie :

{
    "recordingConfigurations": [
        {
            "arn": "arn:aws:ivs:us-west-2:123456789012:recording-configuration/ABcdef34ghIJ",
            "name": "test-recording-config-1",
            "destinationConfiguration": {
                "s3": {
                    "bucketName": "demo-recording-bucket-1"
                }
            },
            "state": "ACTIVE",
            "tags": {}
        },
        {
            "arn": "arn:aws:ivs:us-west-2:123456789012:recording-configuration/CD12abcdGHIJ",
            "name": "test-recording-config-2",
            "destinationConfiguration": {
                "s3": {
                    "bucketName": "demo-recording-bucket-2"
                }
            },
            "state": "ACTIVE",
            "tags": {}
        }
    ]
}

Pour plus d'informations, consultez la section Enregistrer sur Amazon S3 dans le guide de l'utilisateur d'Amazon Interactive Video Service.

L'exemple de code suivant montre comment utiliserlist-stream-keys.

AWS CLI

Pour obtenir une liste des clés de diffusion

L'list-stream-keysexemple suivant répertorie toutes les clés de flux pour un ARN (Amazon Resource Name) spécifié.

aws ivs list-stream-keys \
    --channel-arn arn:aws:ivs:us-west-2:123456789012:channel/abcdABCDefgh

Sortie :

{
    "streamKeys": [
        {
            "arn": "arn:aws:ivs:us-west-2:123456789012:stream-key/abcdABCDefgh",
            "channelArn": "arn:aws:ivs:us-west-2:123456789012:channel/abcdABCDefgh",
            "tags": {}
        }
    ]
}

FFor Pour plus d'informations, consultez la section Créer un canal dans le guide de l'utilisateur IVS Low-Latency.

  • Pour plus de détails sur l'API, reportez-vous ListStreamKeysà la section Référence des AWS CLI commandes.

L'exemple de code suivant montre comment utiliserlist-stream-sessions.

AWS CLI

Pour obtenir un résumé des diffusions actuelles et précédentes pour une chaîne spécifique dans la AWS région actuelle

L'list-stream-sessionsexemple suivant fournit des informations récapitulatives pour les flux pour un canal ARN (Amazon Resource Name) spécifié.

aws ivs list-stream-sessions \
    --channel-arn arn:aws:ivs:us-west-2:123456789012:channel/abcdABCDefgh \
    --max-results 25 \
    --next-token ""

Sortie :

{
    "nextToken": "set-2",
    "streamSessions": [
        {
            "startTime": 1641578182,
            "endTime": 1641579982,
            "hasErrorEvent": false,
            "streamId": "mystream"
        }
        ...
    ]
}

Pour plus d'informations, consultez la section Créer un canal dans le guide de l'utilisateur IVS Low-Latency.

  • Pour plus de détails sur l'API, reportez-vous ListStreamSessionsà la section Référence des AWS CLI commandes.

L'exemple de code suivant montre comment utiliserlist-streams.

AWS CLI

Pour obtenir une liste des diffusions en direct et leur état

L'list-streamsexemple suivant répertorie toutes les diffusions en direct de votre AWS compte.

aws ivs list-streams

Sortie :

{
   "streams": [
        {
            "channelArn": "arn:aws:ivs:us-west-2:123456789012:channel/abcdABCDefgh",
            "state": "LIVE",
            "health": "HEALTHY",
            "streamId": "st-ABCDEfghij01234KLMN5678",
            "viewerCount": 1
        }
    ]
}

Pour plus d'informations, consultez la section Créer un canal dans le guide de l'utilisateur IVS Low-Latency.

  • Pour plus de détails sur l'API, reportez-vous ListStreamsà la section Référence des AWS CLI commandes.

L'exemple de code suivant montre comment utiliserlist-tags-for-resource.

AWS CLI

Pour répertorier tous les tags d'une AWS ressource (par exemple : channel, stream key)

L'list-tags-for-resourceexemple suivant répertorie toutes les balises associées à un ARN de ressource spécifié (Amazon Resource Name).

aws ivs list-tags-for-resource \
    --resource-arn arn:aws:ivs:us-west-2:12345689012:channel/abcdABCDefgh

Sortie :

{
    "tags":
    {
        "key1": "value1",
        "key2": "value2"
    }
}

Pour plus d'informations, consultez la section Balisage dans le manuel Amazon Interactive Video Service API Reference.

  • Pour plus de détails sur l'API, reportez-vous ListTagsForResourceà la section Référence des AWS CLI commandes.

L'exemple de code suivant montre comment utiliserput-metadata.

AWS CLI

Pour insérer des métadonnées dans le flux actif pour un canal spécifique

L'put-metadataexemple suivant insère les métadonnées données dans le flux pour le canal spécifié.

aws ivs put-metadata \
    --channel-arn arn:aws:ivs:us-west-2:123456789012:channel/abcdABCDefgh \
    --metadata '{"my": "metadata"}'

Cette commande ne produit aucun résultat.

Pour plus d'informations, consultez la section Créer un canal dans le guide de l'utilisateur IVS Low-Latency.

  • Pour plus de détails sur l'API, reportez-vous PutMetadataà la section Référence des AWS CLI commandes.

L'exemple de code suivant montre comment utiliserstart-viewer-session-revocation.

AWS CLI

Pour révoquer une session de visionnage pour une paire ARN-canal et Viewer-ID donnée

L'start-viewer-session-revocationexemple suivant lance le processus de révocation de la session de visionnage associée à un ARN de canal et à un ID de lecteur spécifiés, jusqu'au numéro de version de session spécifié inclus. Si la version n'est pas fournie, la valeur par défaut est 0.

aws ivs batch-start-viewer-session-revocation \
    --channel-arn arn:aws:ivs:us-west-2:123456789012:channel/abcdABCDefgh \
    --viewer-id abcdefg \
    --viewer-session-versions-less-than-or-equal-to 1234567890

Cette commande ne produit aucun résultat.

Pour plus d'informations, reportez-vous à la section Configuration des canaux privés dans le Guide de l'utilisateur d'Amazon Interactive Video Service.

L'exemple de code suivant montre comment utiliserstop-stream.

AWS CLI

Pour arrêter un flux spécifique

L'stop-streamexemple suivant arrête le flux sur le canal spécifié.

aws ivs stop-stream \
    --channel-arn arn:aws:ivs:us-west-2:123456789012:channel/abcdABCDefgh

Cette commande ne produit aucun résultat.

Pour plus d'informations, consultez la section Créer un canal dans le guide de l'utilisateur IVS Low-Latency.

  • Pour plus de détails sur l'API, reportez-vous StopStreamà la section Référence des AWS CLI commandes.

L'exemple de code suivant montre comment utilisertag-resource.

AWS CLI

Pour ajouter ou mettre à jour des balises pour une AWS ressource (par exemple : canal, clé de flux)

L'tag-resourceexemple suivant ajoute ou met à jour des balises pour un ARN de ressource spécifié (Amazon Resource Name).

aws ivs tag-resource \
    --resource-arn arn:aws:ivs:us-west-2:123456789012:channel/abcdABCDefgh \
    --tags "tagkey1=tagvalue1, tagkey2=tagvalue2"

Cette commande ne produit aucun résultat.

Pour plus d'informations, consultez la section Balisage dans le manuel Amazon Interactive Video Service API Reference.

  • Pour plus de détails sur l'API, reportez-vous TagResourceà la section Référence des AWS CLI commandes.

L'exemple de code suivant montre comment utiliseruntag-resource.

AWS CLI

Pour supprimer les balises d'une AWS ressource (par exemple : canal, clé de flux)

L'untag-resourceexemple suivant supprime les balises spécifiées pour un ARN de ressource spécifié (Amazon Resource Name).

aws ivs untag-resource \
    --resource-arn arn:aws:ivs:us-west-2:123456789012:channel/abcdABCDefgh \
    --tag-keys "tagkey1, tagkey2"

Cette commande ne produit aucun résultat.

Pour plus d'informations, consultez la section Balisage dans le manuel Amazon Interactive Video Service API Reference.

  • Pour plus de détails sur l'API, reportez-vous UntagResourceà la section Référence des AWS CLI commandes.

L'exemple de code suivant montre comment utiliserupdate-channel.

AWS CLI

Exemple 1 : pour mettre à jour les informations de configuration d'un canal

L'update-channelexemple suivant met à jour la configuration du canal pour un ARN de canal spécifié afin de modifier le nom du canal. Cela n'affecte pas le flux continu de cette chaîne ; vous devez arrêter et redémarrer le flux pour que les modifications prennent effet.

aws ivs update-channel \
    --arn 'arn:aws:ivs:us-west-2:123456789012:channel/abcdABCDefgh' \
    --name 'channel-1' \
    --insecure-ingest

Sortie :

{
    "channel": {
        "arn": "arn:aws:ivs:us-west-2:123456789012:channel/abcdABCDefgh",
        "name": "channel-1",
        "latencyMode": "LOW",
        "containerFormat": "TS",
        "multitrackInputConfiguration": {
            "enabled": false,
            "maximumResolution": "FULL_HD",
            "policy": "ALLOW"
        },
        "type": "STANDARD",
        "playbackRestrictionPolicyArn": "",
        "recordingConfigurationArn": "",
        "srt": {
            "endpoint": "a1b2c3d4e5f6.srt.live-video.net",
            "passphrase": "AB1C2defGHijkLMNo3PqQRstUvwxyzaBCDEfghh4ijklMN5opqrStuVWxyzAbCDEfghIJ"
        },
        "ingestEndpoint": "a1b2c3d4e5f6.global-contribute.live-video.net",
        "insecureIngest": true,
        "playbackUrl": "https://a1b2c3d4e5f6.us-west-2.playback.live-video.net/api/video/v1/us-west-2.123456789012.channel.abcdEFGH.m3u8",
        "preset": "",
        "authorized": false,
        "tags": {}
}

Pour plus d'informations, consultez la section Créer un canal dans le guide de l'utilisateur IVS Low-Latency.

Exemple 2 : pour mettre à jour la configuration d'une chaîne afin d'activer l'enregistrement

L'update-channelexemple suivant met à jour la configuration du canal pour un ARN de canal spécifié afin de permettre l'enregistrement. Cela n'affecte pas le flux continu de cette chaîne ; vous devez arrêter et redémarrer le flux pour que les modifications prennent effet.

aws ivs update-channel \
    --arn 'arn:aws:ivs:us-west-2:123456789012:channel/abcdABCDefgh' \
    --no-insecure-ingest \
    --recording-configuration-arn 'arn:aws:ivs:us-west-2:123456789012:recording-configuration/ABCD12cdEFgh'

Sortie :

{
    "channel": {
        "arn": "arn:aws:ivs:us-west-2:123456789012:channel/abcdABCDefgh",
        "name": "test-channel-with-recording",
        "latencyMode": "LOW",
        "containerFormat": "TS",
        "multitrackInputConfiguration": {
            "enabled": false,
            "maximumResolution": "FULL_HD",
            "policy": "ALLOW"
        },
        "type": "STANDARD",
        "playbackRestrictionPolicyArn": "",
        "recordingConfigurationArn": "arn:aws:ivs:us-west-2:123456789012:recording-configuration/ABCD12cdEFgh",
        "srt": {
            "endpoint": "a1b2c3d4e5f6.srt.live-video.net",
            "passphrase": "BA1C2defGHijkLMNo3PqQRstUvwxyzaBCDEfghh4ijklMN5opqrStuVWxyzAbCDEfghIJ"
        },
        "ingestEndpoint": "a1b2c3d4e5f6.global-contribute.live-video.net",
        "insecureIngest": false,
        "playbackUrl": "https://a1b2c3d4e5f6.us-west-2.playback.live-video.net/api/video/v1/us-west-2.123456789012.channel.abcdEFGH.m3u8",
        "preset": "",
        "authorized": false,
        "tags": {}
    }
}

Pour plus d'informations, consultez la section Enregistrer sur Amazon S3 dans le guide de l'utilisateur IVS Low-Latency.

Exemple 3 : pour mettre à jour la configuration d'une chaîne afin de désactiver l'enregistrement

L'update-channelexemple suivant met à jour la configuration du canal pour un ARN de canal spécifié afin de désactiver l'enregistrement. Cela n'affecte pas le flux continu de cette chaîne ; vous devez arrêter et redémarrer le flux pour que les modifications prennent effet.

aws ivs update-channel \
    --arn 'arn:aws:ivs:us-west-2:123456789012:channel/abcdABCDefgh' \
    --recording-configuration-arn ''

Sortie :

{
    "channel": {
        "arn": "arn:aws:ivs:us-west-2:123456789012:channel/abcdABCDefgh",
        "name": "test-channel-with-recording",
        "latencyMode": "LOW",
        "containerFormat": "TS",
        "multitrackInputConfiguration": {
            "enabled": false,
            "maximumResolution": "FULL_HD",
            "policy": "ALLOW"
        },
        "type": "STANDARD",
        "playbackRestrictionPolicyArn": "",
        "recordingConfigurationArn": "",
        "srt": {
            "endpoint": "a1b2c3d4e5f6.srt.live-video.net",
            "passphrase": "AB1C2edfGHijkLMNo3PqQRstUvwxyzaBCDEfghh4ijklMN5opqrStuVWxyzAbCDEfghIJ"
        },
        "ingestEndpoint": "a1b2c3d4e5f6.global-contribute.live-video.net",
        "insecureIngest": false,
        "playbackUrl": "https://a1b2c3d4e5f6.us-west-2.playback.live-video.net/api/video/v1/us-west-2.123456789012.channel.abcdEFGH.m3u8",
        "preset": "",
        "authorized": false,
        "tags": {}
    }
}

Pour plus d'informations, consultez la section Enregistrer sur Amazon S3 dans le guide de l'utilisateur IVS Low-Latency.

Exemple 4 : pour mettre à jour la configuration d'une chaîne afin d'activer la restriction de lecture

L'update-channelexemple suivant met à jour la configuration du canal pour un ARN de canal spécifié afin d'appliquer une politique de restriction de lecture. Cela n'affecte pas le flux continu de cette chaîne ; vous devez arrêter et redémarrer le flux pour que les modifications prennent effet.

aws ivs update-channel \
    --arn 'arn:aws:ivs:us-west-2:123456789012:channel/abcdABCDefgh' \
    --no-insecure-ingest \
    --playback-restriction-policy-arn 'arn:aws:ivs:us-west-2:123456789012:playback-restriction-policy/ABcdef34ghIJ'

Sortie :

{
    "channel": {
        "arn": "arn:aws:ivs:us-west-2:123456789012:channel/abcdABCDefgh",
        "name": "test-channel-with-playback-restriction-policy",
        "latencyMode": "LOW",
        "containerFormat": "TS",
        "multitrackInputConfiguration": {
            "enabled": false,
            "maximumResolution": "FULL_HD",
            "policy": "ALLOW"
        },
        "type": "STANDARD",
        "playbackRestrictionPolicyArn": "arn:aws:ivs:us-west-2:123456789012:playback-restriction-policy/ABcdef34ghIJ",
        "recordingConfigurationArn": "",
        "srt": {
            "endpoint": "a1b2c3d4e5f6.srt.live-video.net",
            "passphrase": "AB1C2defGHijkLMNo3PqQRstUvwxyzaCBDEfghh4ijklMN5opqrStuVWxyzAbCDEfghIJ"
        },
        "ingestEndpoint": "a1b2c3d4e5f6.global-contribute.live-video.net",
        "insecureIngest": false,
        "playbackUrl": "https://a1b2c3d4e5f6.us-west-2.playback.live-video.net/api/video/v1/us-west-2.123456789012.channel.abcdEFGH.m3u8",
        "preset": "",
        "authorized": false,
        "tags": {}
    }
}

Pour plus d'informations, consultez la section Contenu et spectateurs indésirables dans le guide de l'utilisateur IVS Low-Latency.

Exemple 5 : Pour mettre à jour la configuration d'une chaîne afin de désactiver la restriction de lecture

L'update-channelexemple suivant met à jour la configuration du canal pour un ARN de canal spécifié afin de désactiver la restriction de lecture. Cela n'affecte pas le flux continu de cette chaîne ; vous devez arrêter et redémarrer le flux pour que les modifications prennent effet.

aws ivs update-channel \
    --arn 'arn:aws:ivs:us-west-2:123456789012:channel/abcdABCDefgh' \
    --playback-restriction-policy-arn ''

Sortie :

{
    "channel": {
        "arn": "arn:aws:ivs:us-west-2:123456789012:channel/abcdABCDefgh",
        "name": "test-channel-with-playback-restriction-policy",
        "latencyMode": "LOW",
        "containerFormat": "TS",
        "multitrackInputConfiguration": {
            "enabled": false,
            "maximumResolution": "FULL_HD",
            "policy": "ALLOW"
        },
        "type": "STANDARD",
        "playbackRestrictionPolicyArn": "",
        "recordingConfigurationArn": "",
        "srt": {
            "endpoint": "a1b2c3d4e5f6.srt.live-video.net",
            "passphrase": "AB1C2defGHijkLMNo3PqQRstUvwxyzaBCDeFghh4ijklMN5opqrStuVWxyzAbCDEfghIJ"
        },
        "ingestEndpoint": "a1b2c3d4e5f6.global-contribute.live-video.net",
        "insecureIngest": false,
        "playbackUrl": "https://a1b2c3d4e5f6.us-west-2.playback.live-video.net/api/video/v1/us-west-2.123456789012.channel.abcdEFGH.m3u8",
        "preset": "",
        "authorized": false,
        "tags": {}
    }
}

Pour plus d'informations, consultez la section Contenu et spectateurs indésirables dans le guide de l'utilisateur IVS Low-Latency.

Exemple 6 : Pour mettre à jour la configuration d'un canal afin d'activer le multipiste

L'update-channelexemple suivant met à jour la configuration du canal pour un ARN de canal spécifié afin d'activer le multipiste. Cela n'affecte pas le flux continu de cette chaîne ; vous devez arrêter et redémarrer le flux pour que les modifications prennent effet.

aws ivs update-channel \
    --arn 'arn:aws:ivs:us-west-2:123456789012:channel/abcdABCDefgh' \
    --container-format 'FRAGMENTED_MP4' \
    --multitrack-input-configuration '{"enabled": true,"maximumResolution": "FULL_HD","policy": "ALLOW"}'

Sortie :

{
    "channel": {
        "arn": "arn:aws:ivs:us-west-2:123456789012:channel/abcdABCDefgh",
        "containerFormat": "FRAGMENTED_MP4",
        "name": "test-channel-with-multitrack",
        "latencyMode": "LOW",
        "multitrackInputConfiguration": {
            "enabled": true,
            "maximumResolution": "FULL_HD",
            "policy": "ALLOW"
        },
        "type": "STANDARD",
        "playbackRestrictionPolicyArn": "",
        "recordingConfigurationArn": "",
        "srt": {
            "endpoint": "a1b2c3d4e5f6.srt.live-video.net",
            "passphrase": "AB1C2defGHijkLMNo3PqQRstUvwxyzaCBDEfghh4ijklMN5opqrStuVWxyzAbCDEfghIJ"
        },
        "ingestEndpoint": "a1b2c3d4e5f6.global-contribute.live-video.net",
        "insecureIngest": false,
        "playbackUrl": "https://a1b2c3d4e5f6.us-west-2.playback.live-video.net/api/video/v1/us-west-2.123456789012.channel.abcdEFGH.m3u8",
        "preset": "",
        "authorized": false,
        "tags": {}
    }
}

Pour plus d'informations, consultez la section Contenu et spectateurs indésirables dans le guide de l'utilisateur IVS Low-Latency.

Exemple 7 : Pour mettre à jour la configuration d'une chaîne afin de désactiver la restriction de lecture

L'update-channelexemple suivant met à jour la configuration du canal pour un ARN de canal spécifié afin de désactiver le multipiste. Cela n'affecte pas le flux continu de cette chaîne ; vous devez arrêter et redémarrer le flux pour que les modifications prennent effet.

aws ivs update-channel \
    --arn 'arn:aws:ivs:us-west-2:123456789012:channel/abcdABCDefgh' \
    --container-format 'TS' \
    --multitrack-input-configuration '{"enabled": false}'

Sortie :

{
    "channel": {
        ""arn": "arn:aws:ivs:us-west-2:123456789012:channel/abcdABCDefgh",
        "containerFormat": "TS",
        "name": "test-channel-with-multitrack",
        "latencyMode": "LOW",
        "multitrackInputConfiguration": {
            "enabled": false,
            "maximumResolution": "FULL_HD",
            "policy": "ALLOW"
        },
        "type": "STANDARD",
        "playbackRestrictionPolicyArn": "",
        "recordingConfigurationArn": "",
        "srt": {
            "endpoint": "a1b2c3d4e5f6.srt.live-video.net",
            "passphrase": "AB1C2defGHijkLMNo3PqQRstUvwxyzaCBDEfghh4ijklMN5opqrStuVWxyzAbCDEfghIJ"
        },
        "ingestEndpoint": "a1b2c3d4e5f6.global-contribute.live-video.net",
        "insecureIngest": false,
        "playbackUrl": "https://a1b2c3d4e5f6.us-west-2.playback.live-video.net/api/video/v1/us-west-2.123456789012.channel.abcdEFGH.m3u8",
        "preset": "",
        "authorized": false,
        "tags": {}
    }
}

Pour plus d'informations, consultez la section Contenu et spectateurs indésirables dans le guide de l'utilisateur IVS Low-Latency.

  • Pour plus de détails sur l'API, reportez-vous UpdateChannelà la section Référence des AWS CLI commandes.

L'exemple de code suivant montre comment utiliserupdate-playback-restriction-policy.

AWS CLI

Pour mettre à jour une politique de restriction de lecture

L'update-playback-restriction-policyexemple suivant met à jour la politique de restriction de lecture avec l'ARN de politique spécifié afin de désactiver l'application stricte de l'origine. Cela n'affecte pas le flux en cours de la chaîne associée ; vous devez arrêter et redémarrer le flux pour que les modifications prennent effet.

aws ivs update-playback-restriction-policy \
    --arn "arn:aws:ivs:us-west-2:123456789012:playback-restriction-policy/ABcdef34ghIJ" \
    --no-enable-strict-origin-enforcement

Sortie :

{
    "playbackRestrictionPolicy": {
        "arn": "arn:aws:ivs:us-west-2:123456789012:playback-restriction-policy/ABcdef34ghIJ",
        "allowedCountries": [
            "US",
            "MX"
        ],
        "allowedOrigins": [
            "https://www.website1.com",
            "https://www.website2.com"
        ],
        "enableStrictOriginEnforcement": false,
        "name": "test-playback-restriction-policy",
        "tags": {
            "key1": "value1",
            "key2": "value2"
        }
    }
}

Pour plus d'informations, consultez la section Contenu et spectateurs indésirables dans le guide de l'utilisateur IVS Low-Latency.