Exemples d’utilisation de l’AWS CLI avec Amazon IVS - AWS Command Line Interface
Actions

Exemples d’utilisation de l’AWS CLI avec Amazon IVS

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

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

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

Rubriques

Actions

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

AWS CLI

Pour obtenir les informations de configuration concernant plusieurs canaux

L’exemple batch-get-channel 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 Création d’un canal dans le Guide de l’utilisateur d’IVS à faible latence.

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

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

AWS CLI

Pour obtenir les informations sur plusieurs clés de flux

L’exemple batch-get-stream-key suivant affiche les 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 Création d’un canal dans le Guide de l’utilisateur d’IVS à faible latence.

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

L’exemple de code suivant montre comment utiliser batch-start-viewer-session-revocation.

AWS CLI

Pour révoquer les sessions d’utilisateur pour plusieurs paires canal-ARN et utilisateur-ID

L’exemple batch-start-viewer-session-revocation suivant effectue la révocation de session sur plusieurs paires canal-ARN et utilisateur-ID simultanément. La demande peut s’exécuter 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, consultez Configuration des canaux privés dans le Guide de l’utilisateur d’Amazon Interactive Video Service.

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

AWS CLI

Exemple 1 : pour créer un canal sans enregistrement

L’exemple create-channel suivant crée un canal et une clé de flux associée pour démarrer la diffusion.

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 Création d’un canal dans le Guide de l’utilisateur d’IVS à faible latence.

Exemple 2 : pour créer un canal avec activation de l’enregistrement, à l’aide de la ressource RecordingConfiguration spécifiée par son ARN

L’exemple create-channel suivant crée un canal et une clé de flux associée pour démarrer la diffusion, et configure l’enregistrement pour le canal :

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 Enregistrement vers Amazon S3 dans le Guide de l’utilisateur d’IVS à faible latence.

Exemple 3 : pour créer un canal avec une politique de restriction de lecture spécifiée par son ARN

L’exemple create-channel suivant crée un canal et une clé de flux associée pour démarrer la diffusion, et configure une politique de restriction de lecture pour le canal :

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 Contenu et spectateurs indésirables dans le Guide de l’utilisateur d’IVS à faible latence.

Exemple 4 : pour créer un canal avec activation du multipiste

L’exemple create-channel suivant crée un canal et une clé de flux associée pour démarrer la diffusion, 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 Création d’un canal dans le Guide de l’utilisateur d’IVS à faible latence.

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

L’exemple de code suivant montre comment utiliser create-playback-restriction-policy.

AWS CLI

Pour créer une politique de restriction de lecture

L’exemple create-playback-restriction-policy suivant crée une 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 Contenu et spectateurs indésirables dans le Guide de l’utilisateur d’IVS à faible latence.

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

AWS CLI

Pour créer une ressource RecordingConfiguration

L’exemple create-recording-configuration suivant crée une ressource RecordingConfiguration pour activer l’enregistrement vers 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 Enregistrement vers Amazon S3 dans le Guide de l’utilisateur d’Amazon Interactive Video Service.

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

AWS CLI

Pour créer une clé de flux

L’exemple create-stream-key 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 Création d’un canal dans le Guide de l’utilisateur d’IVS à faible latence.

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

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

AWS CLI

Pour supprimer un canal et les clés de flux associées

L’exemple delete-channel 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 aucune sortie.

Pour plus d’informations, consultez Création d’un canal dans le Guide de l’utilisateur d’IVS à faible latence.

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

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

AWS CLI

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

L’exemple delete-playback-key-pair suivant renvoie l’empreinte 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 aucune sortie.

Pour plus d’informations, consultez Configuration des canaux privés dans le Guide de l’utilisateur d’Amazon Interactive Video Service.

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

L’exemple de code suivant montre comment utiliser delete-playback-restriction-policy.

AWS CLI

Pour supprimer une politique de restriction de lecture

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

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

Cette commande ne produit aucune sortie.

Pour plus d’informations, consultez Contenu et spectateurs indésirables dans le Guide de l’utilisateur d’IVS à faible latence.

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

AWS CLI

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

L’exemple delete-recording-configuration suivant supprime la ressource RecordingConfiguration 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 aucune sortie.

Pour plus d’informations, consultez Enregistrement vers Amazon S3 dans le Guide de l’utilisateur d’Amazon Interactive Video Service.

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

AWS CLI

Pour supprimer une clé de flux

L’exemple delete-stream-key suivant supprime la clé de flux pour un ARN (Amazon Resource Name) spécifié, de sorte qu’elle ne peut plus être utilisée pour la diffusion.

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

Cette commande ne produit aucune sortie.

Pour plus d’informations, consultez Création d’un canal dans le Guide de l’utilisateur d’IVS à faible latence.

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

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

AWS CLI

Pour obtenir les informations de configuration d’un canal

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

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 Création d’un canal dans le Guide de l’utilisateur d’IVS à faible latence.

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

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

AWS CLI

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

L’exemple get-playback-key-pair suivant renvoie l’empreinte 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, consultez Configuration des canaux privés dans le Guide de l’utilisateur d’Amazon Interactive Video Service.

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

L’exemple de code suivant montre comment utiliser get-playback-restriction-policy.

AWS CLI

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

L’exemple get-playback-restriction-policy suivant obtient la configuration d’une politique de restriction de lecture avec l’ARN (Amazon Resource Name) de politique spécifié.

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 Contenu et spectateurs indésirables dans le Guide de l’utilisateur d’IVS à faible latence.

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

AWS CLI

Pour obtenir les informations sur une ressource RecordingConfiguration

L’exemple get-recording-configuration suivant obtient les informations sur la ressource RecordingConfiguration 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 Enregistrement vers Amazon S3 dans le Guide de l’utilisateur d’Amazon Interactive Video Service.

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

AWS CLI

Pour obtenir les informations sur un flux

L’exemple get-stream-key suivant obtient les informations sur une 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 Création d’un canal dans le Guide de l’utilisateur d’IVS à faible latence.

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

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

AWS CLI

Pour obtenir les métadonnées d’un flux spécifié

L’exemple get-stream-session suivant obtient la configuration des métadonnées pour l’ARN (Amazon Resource Name) du canal et le flux spécifiés ; si streamId n’est pas fourni, 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 Création d’un canal dans le Guide de l’utilisateur d’IVS à faible latence.

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

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

AWS CLI

Pour obtenir les informations sur un flux

L’exemple get-stream suivant obtient les informations sur le flux du 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 Création d’un canal dans le Guide de l’utilisateur d’IVS à faible latence.

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

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

AWS CLI

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

L’exemple import-playback-key-pair 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, consultez Configuration des canaux privés dans le Guide de l’utilisateur d’Amazon Interactive Video Service.

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

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

AWS CLI

Exemple 1 : pour obtenir des informations récapitulatives sur tous les canaux

L’exemple list-channels suivant répertorie tous les canaux de votre compte AWS.

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 Création d’un canal dans le Guide de l’utilisateur d’IVS à faible latence.

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

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

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 Enregistrement vers Amazon S3 dans le Guide de l’utilisateur d’IVS à faible latence.

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

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

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 Contenu et spectateurs indésirables dans le Guide de l’utilisateur d’IVS à faible latence.

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

L’exemple de code suivant montre comment utiliser list-playback-key-pairs.

AWS CLI

Pour obtenir les informations récapitulatives sur toutes les paires de clés de lecture

L’exemple list-playback-key-pairs suivant renvoie les 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, consultez Configuration des canaux privés dans le Guide de l’utilisateur d’Amazon Interactive Video Service.

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

L’exemple de code suivant montre comment utiliser list-playback-restriction-policies.

AWS CLI

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

L’exemple list-playback-restriction-policies suivant répertorie toutes les politiques de restriction de lecture pour votre compte AWS.

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 Contenu et spectateurs indésirables dans le Guide de l’utilisateur d’IVS à faible latence.

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

AWS CLI

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

L’exemple list-recording-configurations suivant obtient les informations sur toutes les ressources RecordingConfiguration 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 Enregistrement vers Amazon S3 dans le Guide de l’utilisateur d’Amazon Interactive Video Service.

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

AWS CLI

Pour obtenir une liste de clés de flux

L’exemple list-stream-keys 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": {}
        }
    ]
}

Pour plus d’informations, consultez Création d’un canal dans le Guide de l’utilisateur d’IVS à faible latence.

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

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

AWS CLI

Pour obtenir un résumé des flux actuels et précédents pour un canal spécifique dans la région AWS actuelle

L’exemple list-stream-sessions suivant fournit les informations récapitulatives pour les flux d’un ARN (Amazon Resource Name) de canal 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 Création d’un canal dans le Guide de l’utilisateur d’IVS à faible latence.

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

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

AWS CLI

Pour obtenir la liste des flux en direct et de leur état

L’exemple list-streams suivant répertorie tous les flux en direct de votre compte AWS.

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 Création d’un canal dans le Guide de l’utilisateur d’IVS à faible latence.

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

L’exemple de code suivant montre comment utiliser list-tags-for-resource.

AWS CLI

Pour répertorier toutes les balises d’une ressource AWS (par exemple : canal, clé de flux)

L’exemple list-tags-for-resource suivant répertorie toutes les balises pour un ARN (Amazon Resource Name) de ressource spécifié.

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 Ajout de balises dans la Référence des API d’Amazon Interactive Video Service.

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

L’exemple de code suivant montre comment utiliser put-metadata.

AWS CLI

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

L’exemple put-metadata 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 aucune sortie.

Pour plus d’informations, consultez Création d’un canal dans le Guide de l’utilisateur d’IVS à faible latence.

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

L’exemple de code suivant montre comment utiliser start-viewer-session-revocation.

AWS CLI

Pour révoquer une session d’utilisateur pour une paire canal-ARN et utilisateur-ID multiple donnée

L’exemple start-viewer-session-revocation suivant démarre le processus de révocation de la session d’utilisateur associée à un ARN de canal et à un ID d’utilisateur spécifiés, allant 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 aucune sortie.

Pour plus d’informations, consultez Configuration des canaux privés dans le Guide de l’utilisateur d’Amazon Interactive Video Service.

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

AWS CLI

Pour arrêter un flux spécifique

L’exemple stop-stream 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 aucune sortie.

Pour plus d’informations, consultez Création d’un canal dans le Guide de l’utilisateur d’IVS à faible latence.

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

L’exemple de code suivant montre comment utiliser tag-resource.

AWS CLI

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

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

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

Cette commande ne produit aucune sortie.

Pour plus d’informations, consultez Ajout de balises dans la Référence des API d’Amazon Interactive Video Service.

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

L’exemple de code suivant montre comment utiliser untag-resource.

AWS CLI

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

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

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

Cette commande ne produit aucune sortie.

Pour plus d’informations, consultez Ajout de balises dans la Référence des API d’Amazon Interactive Video Service.

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

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

AWS CLI

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

L’exemple update-channel suivant met à jour la configuration de canal pour un ARN de canal spécifié afin de modifier le nom du canal. Cela n’affecte pas le flux continu de ce canal ; 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 Création d’un canal dans le Guide de l’utilisateur d’IVS à faible latence.

Exemple 2 : pour mettre à jour la configuration d’un canal afin d’activer l’enregistrement

L’exemple update-channel suivant met à jour la configuration de canal pour un ARN de canal spécifié afin d’activer l’enregistrement. Cela n’affecte pas le flux continu de ce canal ; 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 Enregistrement vers Amazon S3 dans le Guide de l’utilisateur d’IVS à faible latence.

Exemple 3 : pour mettre à jour la configuration d’un canal afin de désactiver l’enregistrement

L’exemple update-channel suivant met à jour la configuration de canal pour un ARN de canal spécifié afin de désactiver l’enregistrement. Cela n’affecte pas le flux continu de ce canal ; 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 Enregistrement vers Amazon S3 dans le Guide de l’utilisateur d’IVS à faible latence.

Exemple 4 : pour mettre à jour la configuration d’un canal afin d’activer la restriction de lecture

L’exemple update-channel suivant met à jour la configuration de 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 ce canal ; 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 Contenu et spectateurs indésirables dans le Guide de l’utilisateur d’IVS à faible latence.

Exemple 5 : pour mettre à jour la configuration d’un canal afin de désactiver la restriction de lecture

L’exemple update-channel suivant met à jour la configuration de canal pour un ARN de canal spécifié afin de désactiver la restriction de lecture. Cela n’affecte pas le flux continu de ce canal ; 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 Contenu et spectateurs indésirables dans le Guide de l’utilisateur d’IVS à faible latence.

Exemple 6 : pour mettre à jour la configuration d’un canal afin d’activer le multipiste

L’exemple update-channel suivant met à jour la configuration de canal pour un ARN de canal spécifié afin d’activer le multipiste. Cela n’affecte pas le flux continu de ce canal ; 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 Contenu et spectateurs indésirables dans le Guide de l’utilisateur d’IVS à faible latence.

Exemple 7 : pour mettre à jour la configuration d’un canal afin de désactiver la restriction de lecture

L’exemple update-channel suivant met à jour la configuration de canal pour un ARN de canal spécifié afin de désactiver le multipiste. Cela n’affecte pas le flux continu de ce canal ; 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 Contenu et spectateurs indésirables dans le Guide de l’utilisateur d’IVS à faible latence.

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

L’exemple de code suivant montre comment utiliser update-playback-restriction-policy.

AWS CLI

Pour mettre à jour une politique de restriction de lecture

L’exemple update-playback-restriction-policy suivant met à jour la politique de restriction de lecture avec l’ARN de politique spécifié afin de désactiver l’application stricte d’origine. Cela n’affecte pas le flux continu du canal associé ; 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 Contenu et spectateurs indésirables dans le Guide de l’utilisateur d’IVS à faible latence.