IVSExemplos da Amazon usando AWS CLI - AWS Command Line Interface

Esta documentação é para a AWS CLI única versão 1. Para obter a documentação relacionada à versão 2 do AWS CLI, consulte o Guia do usuário da versão 2.

As traduções são geradas por tradução automática. Em caso de conflito entre o conteúdo da tradução e da versão original em inglês, a versão em inglês prevalecerá.

IVSExemplos da Amazon usando AWS CLI

Os exemplos de código a seguir mostram como realizar ações e implementar cenários comuns usando o AWS Command Line Interface com a AmazonIVS.

Ações são trechos de código de programas maiores e devem ser executadas em contexto. Embora as ações mostrem como chamar funções de serviço individuais, você pode ver as ações no contexto em seus cenários relacionados.

Cada exemplo inclui um link para o código-fonte completo, onde você pode encontrar instruções sobre como configurar e executar o código no contexto.

Tópicos

Ações

O código de exemplo a seguir mostra como usar batch-get-channel.

AWS CLI

Para obter informações de configuração de canais sobre vários canais

O batch-get-channel exemplo a seguir lista informações sobre os canais especificados.

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

Saída:

{ "channels": [ { "arn": "arn:aws:ivs:us-west-2:123456789012:channel/abcdABCDefgh", "authorized": false, "ingestEndpoint": "a1b2c3d4e5f6.global-contribute.live-video.net", "insecureIngest": false, "latencyMode": "LOW", "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, "ingestEndpoint": "a1b2c3d4e5f6.global-contribute.live-video.net", "insecureIngest": true, "latencyMode": "LOW", "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" } ] }

Para obter mais informações, consulte Criar um canal no Guia do usuário IVS de baixa latência.

  • Para API obter detalhes, consulte BatchGetChannelna Referência de AWS CLI Comandos.

O código de exemplo a seguir mostra como usar batch-get-stream-key.

AWS CLI

Para obter informações sobre várias chaves de transmissão

O batch-get-stream-key exemplo a seguir obtém informações sobre as chaves de stream especificadas.

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

Saída:

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

Para obter mais informações, consulte Criar um canal no Guia do usuário IVS de baixa latência.

  • Para API obter detalhes, consulte BatchGetStreamKeyna Referência de AWS CLI Comandos.

O código de exemplo a seguir mostra como usar batch-start-viewer-session-revocation.

AWS CLI

Para revogar sessões de visualizador para vários pares de canais ARN e IDs de visualizador

O batch-start-viewer-session-revocation exemplo a seguir executa a revogação de sessão em vários pares de ID de canal ARN e visualizador simultaneamente. A solicitação pode ser concluída normalmente, mas retornar valores no campo de erros se o chamador não tiver permissão para revogar a sessão especificada.

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

Saída:

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

Para obter mais informações, consulte Configuração de canais privados no Guia do usuário do Amazon Interactive Video Service.

O código de exemplo a seguir mostra como usar create-channel.

AWS CLI

Exemplo 1: Para criar um canal sem gravação

O create-channel exemplo a seguir cria um novo canal e uma chave de transmissão associada para iniciar a transmissão.

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

Saída:

{ "channel": { "arn": "arn:aws:ivs:us-west-2:123456789012:channel/abcdABCDefgh", "authorized": false, "name": "test-channel", "latencyMode": "LOW", "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": {} } }

Para obter mais informações, consulte Criar um canal no Guia do usuário IVS de baixa latência.

Exemplo 2: Para criar um canal com gravação ativada, usando o RecordingConfiguration recurso especificado por seu ARN

O create-channel exemplo a seguir cria um novo canal e uma chave de transmissão associada para iniciar a transmissão e configura a gravação do 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"

Saída:

{ "channel": { "arn": "arn:aws:ivs:us-west-2:123456789012:channel/abcdABCDefgh", "name": "test-channel-with-recording", "latencyMode": "LOW", "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": {} } }

Para obter mais informações, consulte Gravar no Amazon S3 no Guia do usuário de IVSbaixa latência.

Exemplo 3: Para criar um canal com uma política de restrição de reprodução especificada por seu ARN

O create-channel exemplo a seguir cria um novo canal e uma chave de transmissão associada para iniciar a transmissão e configura uma política de restrição de reprodução para o 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"

Saída:

{ "channel": { "arn": "arn:aws:ivs:us-west-2:123456789012:channel/abcdABCDefgh", "name": "test-channel-with-playback-restriction-policy", "latencyMode": "LOW", "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": {} } }

Para obter mais informações, consulte Conteúdo e visualizadores indesejados no Guia do usuário IVSde baixa latência.

  • Para API obter detalhes, consulte CreateChannelna Referência de AWS CLI Comandos.

O código de exemplo a seguir mostra como usar create-playback-restriction-policy.

AWS CLI

Para criar uma política de restrição de reprodução

O create-playback-restriction-policy exemplo a seguir cria uma nova política de restrição de reprodução.

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

Saída:

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

Para obter mais informações, consulte Conteúdo e visualizadores indesejados no Guia do usuário IVSde baixa latência.

O código de exemplo a seguir mostra como usar create-recording-configuration.

AWS CLI

Para criar um RecordingConfiguration recurso

O create-recording-configuration exemplo a seguir cria um RecordingConfiguration recurso para permitir a gravação no 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}

Saída:

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

Para obter mais informações, consulte Gravar no Amazon S3 no Guia do usuário do Amazon Interactive Video Service.

O código de exemplo a seguir mostra como usar create-stream-key.

AWS CLI

Para criar uma chave de transmissão

O create-stream-key exemplo a seguir cria uma chave de stream para um determinado ARN (Amazon Resource Name).

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

Saída:

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

Para obter mais informações, consulte Criar um canal no Guia do usuário IVS de baixa latência.

  • Para API obter detalhes, consulte CreateStreamKeyna Referência de AWS CLI Comandos.

O código de exemplo a seguir mostra como usar delete-channel.

AWS CLI

Para excluir um canal e suas chaves de transmissão associadas

O delete-channel exemplo a seguir exclui o canal com o especificado ARN (Amazon Resource Name).

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

Este comando não produz saída.

Para obter mais informações, consulte Criar um canal no Guia do usuário IVS de baixa latência.

  • Para API obter detalhes, consulte DeleteChannelna Referência de AWS CLI Comandos.

O código de exemplo a seguir mostra como usar delete-playback-key-pair.

AWS CLI

Para excluir um par de chaves de reprodução especificado

O delete-playback-key-pair exemplo a seguir retorna a impressão digital do par de chaves especificado.

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

Este comando não produz saída.

Para obter mais informações, consulte Configuração de canais privados no Guia do usuário do Amazon Interactive Video Service.

O código de exemplo a seguir mostra como usar delete-playback-restriction-policy.

AWS CLI

Para excluir uma política de restrição de reprodução

O delete-playback-restriction-policy exemplo a seguir exclui a política de restrição de reprodução com a política especificada (ARNAmazon Resource Name).

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

Este comando não produz saída.

Para obter mais informações, consulte Conteúdo e visualizadores indesejados no Guia do usuário IVSde baixa latência.

O código de exemplo a seguir mostra como usar delete-recording-configuration.

AWS CLI

Para excluir o RecordingConfiguration recurso especificado por seu ARN

O delete-recording-configuration exemplo a seguir exclui o RecordingConfiguration recurso com o especificadoARN.

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

Este comando não produz saída.

Para obter mais informações, consulte Gravar no Amazon S3 no Guia do usuário do Amazon Interactive Video Service.

O código de exemplo a seguir mostra como usar delete-stream-key.

AWS CLI

Para excluir uma chave de transmissão

O delete-stream-key exemplo a seguir exclui a chave de stream de um determinado ARN (Amazon Resource Name), então ela não pode mais ser usada para streaming.

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

Este comando não produz saída.

Para obter mais informações, consulte Criar um canal no Guia do usuário IVS de baixa latência.

  • Para API obter detalhes, consulte DeleteStreamKeyna Referência de AWS CLI Comandos.

O código de exemplo a seguir mostra como usar get-channel.

AWS CLI

Para obter as informações de configuração de um canal

O get-channel exemplo a seguir obtém a configuração do canal para um canal específico ARN (Amazon Resource Name).

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

Saída:

{ "channel": { "arn": "arn:aws:ivs:us-west-2:123456789012:channel/abcdABCDefgh", "name": "channel-1", "latencyMode": "LOW", "type": "STANDARD", "playbackRestrictionPolicyArn": "", "preset": "", "recordingConfigurationArn": "arn:aws:ivs:us-west-2:123456789012:recording-configuration/ABCD12cdEFgh", "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", "tags": {} } }

Para obter mais informações, consulte Criar um canal no Guia do usuário IVS de baixa latência.

  • Para API obter detalhes, consulte GetChannelna Referência de AWS CLI Comandos.

O código de exemplo a seguir mostra como usar get-playback-key-pair.

AWS CLI

Para obter um par de chaves de reprodução especificado

O get-playback-key-pair exemplo a seguir retorna a impressão digital do par de chaves especificado.

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

Saída:

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

Para obter mais informações, consulte Configuração de canais privados no Guia do usuário do Amazon Interactive Video Service.

O código de exemplo a seguir mostra como usar get-playback-restriction-policy.

AWS CLI

Para obter as informações de configuração de uma política de restrição de reprodução

O get-playback-restriction-policy exemplo a seguir obtém a configuração da política de restrição de reprodução com a política especificada (ARNAmazon Resource Name).

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

Saída:

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

Para obter mais informações, consulte Conteúdo e visualizadores indesejados no Guia do usuário IVSde baixa latência.

O código de exemplo a seguir mostra como usar get-recording-configuration.

AWS CLI

Para obter informações sobre um RecordingConfiguration recurso

O get-recording-configuration exemplo a seguir obtém informações sobre o RecordingConfiguration recurso especificadoARN.

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

Saída:

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

Para obter mais informações, consulte Gravar no Amazon S3 no Guia do usuário do Amazon Interactive Video Service.

O código de exemplo a seguir mostra como usar get-stream-key.

AWS CLI

Para obter informações sobre um stream

O get-stream-key exemplo a seguir obtém informações sobre a chave de stream especificada.

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

Saída:

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

Para obter mais informações, consulte Criar um canal no Guia do usuário IVS de baixa latência.

  • Para API obter detalhes, consulte GetStreamKeyna Referência de AWS CLI Comandos.

O código de exemplo a seguir mostra como usar get-stream-session.

AWS CLI

Para obter metadados de um fluxo especificado

O get-stream-session exemplo a seguir obtém a configuração de metadados do canal especificado ARN (Amazon Resource Name) e do stream especificado; se não streamId for fornecido, o stream mais recente do canal será selecionado.

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

Saída:

{ "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", "srt": { "endpoint": "a1b2c3d4e5f6.srt.live-video.net", "passphrase": "AB1C2defGHijkLMNo3PqQRstUvwxyzaBCDEfghh4ijklMN5opqrStuVWxyzAbCDEfghIJ" }, "ingestEndpoint": "a1b2c3d4e5f6.global-contribute.live-video.net", "playbackUrl": "url-string", "authorized": false, "insecureIngest": false, "preset": "" }, "ingestConfiguration": { "video": { "avcProfile": "Baseline", "avcLevel": "4.2", "codec": "avc1.42C02A", "encoder": "Lavf58.45.100", "targetBitrate": 8789062, "targetFramerate": 60, "videoHeight": 1080, "videoWidth": 1920 }, "audio": { "codec": "mp4a.40.2", "targetBitrate": 46875, "sampleRate": 8000, "channels": 2 } }, "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": [ { "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" } ] } }

Para obter mais informações, consulte Criar um canal no Guia do usuário IVS de baixa latência.

  • Para API obter detalhes, consulte GetStreamSessionna Referência de AWS CLI Comandos.

O código de exemplo a seguir mostra como usar get-stream.

AWS CLI

Para obter informações sobre um stream

O get-stream exemplo a seguir obtém informações sobre o stream do canal especificado.

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

Saída:

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

Para obter mais informações, consulte Criar um canal no Guia do usuário IVS de baixa latência.

  • Para API obter detalhes, consulte GetStreamna Referência de AWS CLI Comandos.

O código de exemplo a seguir mostra como usar import-playback-key-pair.

AWS CLI

Para importar a parte pública de um novo par de chaves

O import-playback-key-pair exemplo a seguir importa a chave pública especificada (especificada como uma string no PEM formato) e retorna o arn e a impressão digital do novo par de chaves.

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

Saída:

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

Para obter mais informações, consulte Configuração de canais privados no Guia do usuário do Amazon Interactive Video Service.

O código de exemplo a seguir mostra como usar list-channels.

AWS CLI

Exemplo 1: Para obter informações resumidas sobre todos os canais

O list-channels exemplo a seguir lista todos os canais AWS da sua conta.

aws ivs list-channels

Saída:

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

Para obter mais informações, consulte Criar um canal no Guia do usuário IVS de baixa latência.

Exemplo 2: Para obter informações resumidas sobre todos os canais, filtradas pelo especificado RecordingConfiguration ARN

O list-channels exemplo a seguir lista todos os canais AWS da sua conta associados ao especificado RecordingConfiguration ARN.

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

Saída:

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

Para obter mais informações, consulte Gravar no Amazon S3 no Guia do usuário de IVSbaixa latência.

Exemplo 3: Para obter informações resumidas sobre todos os canais, filtradas pelo especificado PlaybackRestrictionPolicy ARN

O list-channels exemplo a seguir lista todos os canais AWS da sua conta associados ao especificado PlaybackRestrictionPolicy ARN.

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

Saída:

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

Para obter mais informações, consulte Conteúdo e visualizadores indesejados no Guia do usuário IVSde baixa latência.

  • Para API obter detalhes, consulte ListChannelsna Referência de AWS CLI Comandos.

O código de exemplo a seguir mostra como usar list-playback-key-pairs.

AWS CLI

Para obter informações resumidas sobre todos os pares de teclas de reprodução

O list-playback-key-pairs exemplo a seguir retorna informações sobre todos os pares de chaves.

aws ivs list-playback-key-pairs

Saída:

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

Para obter mais informações, consulte Configuração de canais privados no Guia do usuário do Amazon Interactive Video Service.

O código de exemplo a seguir mostra como usar list-playback-restriction-policies.

AWS CLI

Para obter informações resumidas sobre todas as políticas de restrição de reprodução

O list-playback-restriction-policies exemplo a seguir lista todas as políticas de restrição de reprodução da sua AWS conta.

aws ivs list-playback-restriction-policies

Saída:

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

Para obter mais informações, consulte Conteúdo e visualizadores indesejados no Guia do usuário IVSde baixa latência.

O código de exemplo a seguir mostra como usar list-recording-configurations.

AWS CLI

Para listar todos os RecordingConfiguration recursos criados nessa conta

O list-recording-configurations exemplo a seguir obtém informações sobre todos os RecordingConfiguration recursos da sua conta.

aws ivs list-recording-configurations

Saída:

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

Para obter mais informações, consulte Gravar no Amazon S3 no Guia do usuário do Amazon Interactive Video Service.

O código de exemplo a seguir mostra como usar list-stream-keys.

AWS CLI

Para obter uma lista de chaves de transmissão

O list-stream-keys exemplo a seguir lista todas as chaves de stream de um determinado ARN (Amazon Resource Name).

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

Saída:

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

FForpara obter mais informações, consulte Criar um canal no Guia do usuário IVS de baixa latência.

  • Para API obter detalhes, consulte ListStreamKeysna Referência de AWS CLI Comandos.

O código de exemplo a seguir mostra como usar list-stream-sessions.

AWS CLI

Para obter um resumo dos fluxos atuais e anteriores de um canal específico na região atual AWS

O list-stream-sessions exemplo a seguir relata informações resumidas de streams de um canal específico ARN (Amazon Resource Name).

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

Saída:

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

Para obter mais informações, consulte Criar um canal no Guia do usuário IVS de baixa latência.

O código de exemplo a seguir mostra como usar list-streams.

AWS CLI

Para obter uma lista de transmissões ao vivo e seu estado

O list-streams exemplo a seguir lista todas as transmissões ao vivo da sua AWS conta.

aws ivs list-streams

Saída:

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

Para obter mais informações, consulte Criar um canal no Guia do usuário IVS de baixa latência.

  • Para API obter detalhes, consulte ListStreamsna Referência de AWS CLI Comandos.

O código de exemplo a seguir mostra como usar list-tags-for-resource.

AWS CLI

Para listar todas as tags de um AWS recurso (por exemplo: canal, chave de transmissão)

O list-tags-for-resource exemplo a seguir lista todas as tags de um recurso específico ARN (Amazon Resource Name).

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

Saída:

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

Para obter mais informações, consulte Marcação na APIReferência do Amazon Interactive Video Service.

O código de exemplo a seguir mostra como usar put-metadata.

AWS CLI

Para inserir metadados no fluxo ativo de um canal especificado

O put-metadata exemplo a seguir insere os metadados fornecidos no fluxo do canal especificado.

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

Este comando não produz saída.

Para obter mais informações, consulte Criar um canal no Guia do usuário IVS de baixa latência.

  • Para API obter detalhes, consulte PutMetadatana Referência de AWS CLI Comandos.

O código de exemplo a seguir mostra como usar start-viewer-session-revocation.

AWS CLI

Para revogar uma sessão de espectador para um determinado par de vários canais ARN e IDs de visualizador

O start-viewer-session-revocation exemplo a seguir inicia o processo de revogação da sessão do espectador associada a um canal ARN e ID de visualizador especificados, incluindo o número da versão da sessão especificada. Se a versão não for fornecida, o padrão é 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

Este comando não produz saída.

Para obter mais informações, consulte Configuração de canais privados no Guia do usuário do Amazon Interactive Video Service.

O código de exemplo a seguir mostra como usar stop-stream.

AWS CLI

Para interromper um fluxo especificado

O stop-stream exemplo a seguir interrompe a transmissão no canal especificado.

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

Este comando não produz saída.

Para obter mais informações, consulte Criar um canal no Guia do usuário IVS de baixa latência.

  • Para API obter detalhes, consulte StopStreamna Referência de AWS CLI Comandos.

O código de exemplo a seguir mostra como usar tag-resource.

AWS CLI

Para adicionar ou atualizar tags para um AWS recurso (por exemplo: canal, chave de transmissão)

O tag-resource exemplo a seguir adiciona ou atualiza tags para um recurso específico ARN (Amazon Resource Name).

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

Este comando não produz saída.

Para obter mais informações, consulte Marcação na APIReferência do Amazon Interactive Video Service.

  • Para API obter detalhes, consulte TagResourcena Referência de AWS CLI Comandos.

O código de exemplo a seguir mostra como usar untag-resource.

AWS CLI

Para remover tags de um AWS recurso (por exemplo: canal, chave de transmissão)

O untag-resource exemplo a seguir remove as tags especificadas para um recurso específico ARN (Amazon Resource Name).

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

Este comando não produz saída.

Para obter mais informações, consulte Marcação na APIReferência do Amazon Interactive Video Service.

  • Para API obter detalhes, consulte UntagResourcena Referência de AWS CLI Comandos.

O código de exemplo a seguir mostra como usar update-channel.

AWS CLI

Exemplo 1: Para atualizar as informações de configuração de um canal

O update-channel exemplo a seguir atualiza a configuração do canal de um canal especificado ARN para alterar o nome do canal. Isso não afeta um fluxo contínuo desse canal; você deve parar e reiniciar o fluxo para que as alterações entrem em vigor.

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

Saída:

{ "channel": { "arn": "arn:aws:ivs:us-west-2:123456789012:channel/abcdABCDefgh", "name": "channel-1", "latencyMode": "LOW", "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": {} }

Para obter mais informações, consulte Criar um canal no Guia do usuário IVS de baixa latência.

Exemplo 2: Para atualizar a configuração de um canal para ativar a gravação

O update-channel exemplo a seguir atualiza a configuração do canal de um canal específico ARN para permitir a gravação. Isso não afeta um fluxo contínuo desse canal; você deve parar e reiniciar o fluxo para que as alterações entrem em vigor.

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"

Saída:

{ "channel": { "arn": "arn:aws:ivs:us-west-2:123456789012:channel/abcdABCDefgh", "name": "test-channel-with-recording", "latencyMode": "LOW", "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": {} } }

Para obter mais informações, consulte Gravar no Amazon S3 no Guia do usuário de IVSbaixa latência.

Exemplo 3: Para atualizar a configuração de um canal para desativar a gravação

O update-channel exemplo a seguir atualiza a configuração do canal de um canal específico ARN para desativar a gravação. Isso não afeta um fluxo contínuo desse canal; você deve parar e reiniciar o fluxo para que as alterações entrem em vigor.

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

Saída:

{ "channel": { "arn": "arn:aws:ivs:us-west-2:123456789012:channel/abcdABCDefgh", "name": "test-channel-with-recording", "latencyMode": "LOW", "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": {} } }

Para obter mais informações, consulte Gravar no Amazon S3 no Guia do usuário de IVSbaixa latência.

Exemplo 4: Para atualizar a configuração de um canal para ativar a restrição de reprodução

O update-channel exemplo a seguir atualiza a configuração do canal de um canal específico ARN para aplicar uma política de restrição de reprodução. Isso não afeta um fluxo contínuo desse canal; você deve parar e reiniciar o fluxo para que as alterações entrem em vigor.

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"

Saída:

{ "channel": { "arn": "arn:aws:ivs:us-west-2:123456789012:channel/abcdABCDefgh", "name": "test-channel-with-playback-restriction-policy", "latencyMode": "LOW", "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": {} } }

Para obter mais informações, consulte Conteúdo e visualizadores indesejados no Guia do usuário IVSde baixa latência.

Exemplo 5: Para atualizar a configuração de um canal para desativar a restrição de reprodução

O update-channel exemplo a seguir atualiza a configuração do canal de um canal específico ARN para desativar a restrição de reprodução. Isso não afeta um fluxo contínuo desse canal; você deve parar e reiniciar o fluxo para que as alterações entrem em vigor.

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

Saída:

{ "channel": { "arn": "arn:aws:ivs:us-west-2:123456789012:channel/abcdABCDefgh", "name": "test-channel-with-playback-restriction-policy", "latencyMode": "LOW", "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": {} } }

Para obter mais informações, consulte Conteúdo e visualizadores indesejados no Guia do usuário IVSde baixa latência.

  • Para API obter detalhes, consulte UpdateChannelna Referência de AWS CLI Comandos.

O código de exemplo a seguir mostra como usar update-playback-restriction-policy.

AWS CLI

Para atualizar uma política de restrição de reprodução

O update-playback-restriction-policy exemplo a seguir atualiza a política de restrição de reprodução com a política especificada ARN para desativar a imposição estrita de origem. Isso não afeta um fluxo contínuo do canal associado; você deve parar e reiniciar o fluxo para que as alterações entrem em vigor.

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

Saída:

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

Para obter mais informações, consulte Conteúdo e visualizadores indesejados no Guia do usuário IVSde baixa latência.