# Exemplos do Amazon IVS usando a AWS CLI
Os exemplos de código a seguir mostram como realizar ações e implementar cenários comuns usando a AWS Command Line Interface com o Amazon IVS.
*Ações* são trechos de código de programas maiores e devem ser executadas em contexto. Embora as ações mostrem como chamar perfis 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, em que você pode encontrar instruções sobre como configurar e executar o código.
**Topics**
+ [Ações](#actions)
## Ações
### `batch-get-channel`
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 exemplo `batch-get-channel` a seguir lista as 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
```
Resultado:
```
{
"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"
}
]
}
```
Para obter mais informações, consulte [Criar um canal](https://docs.aws.amazon.com/ivs/latest/LowLatencyUserGuide/getting-started-create-channel.html) no *Guia do usuário do IVS Low-Latency*.
+ Para ver detalhes da API, consulte [BatchGetChannel](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ivs/batch-get-channel.html) na *Referência de comandos da AWS CLI*.
### `batch-get-stream-key`
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 stream**
O exemplo `batch-get-stream-key` a seguir obtém as 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
```
Resultado:
```
{
"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](https://docs.aws.amazon.com/ivs/latest/LowLatencyUserGuide/getting-started-create-channel.html) no *Guia do usuário do IVS Low-Latency*.
+ Para ver detalhes da API, consulte [BatchGetStreamKey](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ivs/batch-get-stream-key.html) na *Referência de comandos da AWS CLI*.
### `batch-start-viewer-session-revocation`
O código de exemplo a seguir mostra como usar `batch-start-viewer-session-revocation`.
**AWS CLI**
**Como revogar sessões de visualizador para vários pares de ARN de canal e ID de visualizador**
O exemplo `batch-start-viewer-session-revocation` a seguir executa a revogação de sessão em vários pares de ARN de canal e ID de visualizador simultaneamente. A solicitação pode ser concluída normalmente, mas retorna valores no campo de erros se não houver 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}]'
```
Resultado:
```
{
"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](https://docs.aws.amazon.com/ivs/latest/userguide/private-channels.html) no *Guia do usuário do Amazon Interactive Video Service*.
+ Para ver detalhes da API, consulte [BatchStartViewerSessionRevocation](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ivs/batch-start-viewer-session-revocation.html) na *Referência de comandos da AWS CLI*.
### `create-channel`
O código de exemplo a seguir mostra como usar `create-channel`.
**AWS CLI**
**Exemplo 1: criar um canal sem gravação**
O exemplo `create-channel` a seguir cria um novo canal e uma chave de stream associada para iniciar o streaming.
```
aws ivs create-channel \
--name 'test-channel' \
--no-insecure-ingest
```
Resultado:
```
{
"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": {}
}
}
```
Para obter mais informações, consulte [Criar um canal](https://docs.aws.amazon.com/ivs/latest/LowLatencyUserGuide/getting-started-create-channel.html) no *Guia do usuário do IVS Low-Latency*.
**Exemplo 2: criar um canal com gravação ativada, usando o recurso RecordingConfiguration especificado por seu ARN**
O exemplo de `create-channel` a seguir cria um canal e uma chave de fluxo associada para iniciar o streaming, além de definir a gravação no 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'
```
Resultado:
```
{
"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": {}
}
}
```
Para obter mais informações, consulte [Gravar no Amazon S3](https://docs.aws.amazon.com/ivs/latest/LowLatencyUserGuide/record-to-s3.html) no *Guia do usuário do IVS Low-Latency*.
**Exemplo 3: criar um canal com uma política de restrição de reprodução especificada por seu ARN**
O exemplo de `create-channel` a seguir cria um canal e uma chave de fluxo associada para iniciar o streaming, além de definir 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'
```
Resultado:
```
{
"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": {}
}
}
```
Para obter mais informações, consulte [Conteúdo e espectadores indesejados](https://docs.aws.amazon.com/ivs/latest/LowLatencyUserGuide/undesired-content.html) no *Guia do usuário do IVS Low-Latency*.
**Exemplo 4: como criar um canal com o recurso de várias faixas habilitado**
O exemplo de `create-channel` a seguir cria um canal e uma chave de fluxo associada para iniciar o streaming, além de habilitar o recurso de várias faixas.
```
aws ivs create-channel \
--name 'test-channel' \
--no-insecure-ingest \
--container-format 'FRAGMENTED_MP4' \
--multitrack-input-configuration '{"enabled": true,"maximumResolution": "FULL_HD","policy": "ALLOW"}'
```
Resultado:
```
{
"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": {}
}
}
```
Para obter mais informações, consulte [Criar um canal](https://docs.aws.amazon.com/ivs/latest/LowLatencyUserGuide/multitrack-video.html) no *Guia do usuário do IVS Low-Latency*.
+ Para ver detalhes da API, consulte [CreateChannel](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ivs/create-channel.html) na *Referência de comandos da AWS CLI*.
### `create-playback-restriction-policy`
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 exemplo `create-playback-restriction-policy` 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
```
Resultado:
```
{
"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 espectadores indesejados](https://docs.aws.amazon.com/ivs/latest/LowLatencyUserGuide/undesired-content.html) no *Guia do usuário do IVS Low-Latency*.
+ Para ver detalhes da API, consulte [CreatePlaybackRestrictionPolicy](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ivs/create-playback-restriction-policy.html) na *Referência de comandos da AWS CLI*.
### `create-recording-configuration`
O código de exemplo a seguir mostra como usar `create-recording-configuration`.
**AWS CLI**
**Para criar um recurso RecordingConfiguration**
O exemplo `create-recording-configuration` a seguir cria um recurso RecordingConfiguration 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}
```
Resultado:
```
{
"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](https://docs.aws.amazon.com/ivs/latest/userguide/record-to-s3.html) no *Guia de usuário do Amazon Interactive Video Service*.
+ Para ver detalhes da API, consulte [CreateRecordingConfiguration](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ivs/create-recording-configuration.html) na *Referência de comandos da AWS CLI*.
### `create-stream-key`
O código de exemplo a seguir mostra como usar `create-stream-key`.
**AWS CLI**
**Para criar uma chave de stream**
O exemplo `create-stream-key` a seguir cria uma chave de stream para o ARN (Amazon Resource Name) do palco especificado.
```
aws ivs create-stream-key \
--channel-arn arn:aws:ivs:us-west-2:123456789012:channel/abcdABCDefgh
```
Resultado:
```
{
"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](https://docs.aws.amazon.com/ivs/latest/LowLatencyUserGuide/getting-started-create-channel.html) no *Guia do usuário do IVS Low-Latency*.
+ Para ver detalhes da API, consulte [CreateStreamKey](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ivs/create-stream-key.html) na *Referência de comandos da AWS CLI*.
### `delete-channel`
O código de exemplo a seguir mostra como usar `delete-channel`.
**AWS CLI**
**Para excluir um canal e suas chaves de stream associadas**
O exemplo `delete-channel` a seguir exclui o canal com o ARN (Amazon Resource Name) especificado.
```
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](https://docs.aws.amazon.com/ivs/latest/LowLatencyUserGuide/getting-started-create-channel.html) no *Guia do usuário do IVS Low-Latency*.
+ Para ver detalhes da API, consulte [DeleteChannel](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ivs/delete-channel.html) na *Referência de comandos da AWS CLI*.
### `delete-playback-key-pair`
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 exemplo `delete-playback-key-pair` 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](https://docs.aws.amazon.com/ivs/latest/userguide/private-channels.html) no *Guia do usuário do Amazon Interactive Video Service*.
+ Para ver detalhes da API, consulte [DeletePlaybackKeyPair](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ivs/delete-playback-key-pair.html) na *Referência de comandos da AWS CLI*.
### `delete-playback-restriction-policy`
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 exemplo `delete-playback-restriction-policy` a seguir exclui a política de restrição de reprodução com o ARN (Amazon Resource Name) especificado.
```
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 espectadores indesejados](https://docs.aws.amazon.com/ivs/latest/LowLatencyUserGuide/undesired-content.html) no *Guia do usuário do IVS Low-Latency*.
+ Para ver detalhes da API, consulte [DeletePlaybackRestrictionPolicy](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ivs/delete-playback-restriction-policy.html) na *Referência de comandos da AWS CLI*.
### `delete-recording-configuration`
O código de exemplo a seguir mostra como usar `delete-recording-configuration`.
**AWS CLI**
**Para excluir o recurso RecordingConfiguration especificado por seu ARN**
O exemplo `delete-recording-configuration` a seguir exclui o recurso RecordingConfiguration com o ARN especificado.
```
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](https://docs.aws.amazon.com/ivs/latest/userguide/record-to-s3.html) no *Guia de usuário do Amazon Interactive Video Service*.
+ Para ver detalhes da API, consulte [DeleteRecordingConfiguration](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ivs/delete-recording-configuration.html) na *Referência de comandos da AWS CLI*.
### `delete-stream-key`
O código de exemplo a seguir mostra como usar `delete-stream-key`.
**AWS CLI**
**Para excluir uma chave de stream**
O exemplo `delete-stream-key` a seguir exclui a chave de stream de um ARN (Amazon Resource Name) especificado, e ele não poderá 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](https://docs.aws.amazon.com/ivs/latest/LowLatencyUserGuide/getting-started-create-channel.html) no *Guia do usuário do IVS Low-Latency*.
+ Para ver detalhes da API, consulte [DeleteStreamKey](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ivs/delete-stream-key.html) na *Referência de comandos da AWS CLI*.
### `get-channel`
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 exemplo `get-channel` a seguir obtém a configuração de canal para um ARN (Amazon Resource Name) especificado.
```
aws ivs get-channel \
--arn 'arn:aws:ivs:us-west-2:123456789012:channel/abcdABCDefgh'
```
Resultado:
```
{
"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",
}
}
```
Para obter mais informações, consulte [Criar um canal](https://docs.aws.amazon.com/ivs/latest/LowLatencyUserGuide/getting-started-create-channel.html) no *Guia do usuário do IVS Low-Latency*.
+ Para ver detalhes da API, consulte [GetChannel](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ivs/get-channel.html) na *Referência de comandos da AWS CLI*.
### `get-playback-key-pair`
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 exemplo `get-playback-key-pair` 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
```
Resultado:
```
{
"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](https://docs.aws.amazon.com/ivs/latest/userguide//private-channels.html) no *Guia do usuário do Amazon Interactive Video Service*.
+ Para ver detalhes da API, consulte [GetPlaybackKeyPair](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ivs/get-playback-key-pair.html) na *Referência de comandos da AWS CLI*.
### `get-playback-restriction-policy`
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 exemplo `get-playback-restriction-policy` a seguir obtém a configuração da política de restrição de reprodução com o ARN (Amazon Resource Name) especificado.
```
aws ivs get-playback-restriction-policy \
--arn "arn:aws:ivs:us-west-2:123456789012:playback-restriction-policy/ABcdef34ghIJ"
```
Resultado:
```
{
"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 espectadores indesejados](https://docs.aws.amazon.com/ivs/latest/LowLatencyUserGuide/undesired-content.html) no *Guia do usuário do IVS Low-Latency*.
+ Para ver detalhes da API, consulte [GetPlaybackRestrictionPolicy](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ivs/get-playback-restriction-policy.html) na *Referência de comandos da AWS CLI*.
### `get-recording-configuration`
O código de exemplo a seguir mostra como usar `get-recording-configuration`.
**AWS CLI**
**Para obter informações sobre um recurso RecordingConfiguration**
O exemplo `get-recording-configuration` a seguir obtém informações sobre o recurso RecordingConfiguration com o ARN especificado.
```
aws ivs get-recording-configuration \
--arn "arn:aws:ivs:us-west-2:123456789012:recording-configuration/ABcdef34ghIJ"
```
Resultado:
```
{
"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](https://docs.aws.amazon.com/ivs/latest/userguide/record-to-s3.html) no *Guia de usuário do Amazon Interactive Video Service*.
+ Para ver detalhes da API, consulte [GetRecordingConfiguration](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ivs/get-recording-configuration.html) na *Referência de comandos da AWS CLI*.
### `get-stream-key`
O código de exemplo a seguir mostra como usar `get-stream-key`.
**AWS CLI**
**Para obter informações sobre um fluxo**
O exemplo `get-stream-key` a seguir obtém as 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
```
Resultado:
```
{
"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](https://docs.aws.amazon.com/ivs/latest/LowLatencyUserGuide/getting-started-create-channel.html) no *Guia do usuário do IVS Low-Latency*.
+ Para ver detalhes da API, consulte [GetStreamKey](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ivs/get-stream-key.html) na *Referência de comandos da AWS CLI*.
### `get-stream-session`
O código de exemplo a seguir mostra como usar `get-stream-session`.
**AWS CLI**
**Para obter metadados de um stream especificado**
O exemplo de `get-stream-session` a seguir obtém a configuração de metadados para o nome do recurso da Amazon (ARN) de canal especificado e o fluxo especificado. Se o `streamId` não for fornecido, o fluxo 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'
```
Resultado:
```
{
"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"
}
]
}
}
```
Para obter mais informações, consulte [Criar um canal](https://docs.aws.amazon.com/ivs/latest/LowLatencyUserGuide/getting-started-create-channel.html) no *Guia do usuário do IVS Low-Latency*.
+ Para ver detalhes da API, consulte [GetStreamSession](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ivs/get-stream-session.html) na *Referência de comandos da AWS CLI*.
### `get-stream`
O código de exemplo a seguir mostra como usar `get-stream`.
**AWS CLI**
**Para obter informações sobre um fluxo**
O exemplo `get-stream` a seguir obtém as informações sobre o stream no canal especificado.
```
aws ivs get-stream \
--channel-arn arn:aws:ivs:us-west-2:123456789012:channel/abcdABCDefgh
```
Resultado:
```
{
"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](https://docs.aws.amazon.com/ivs/latest/LowLatencyUserGuide/getting-started-create-channel.html) no *Guia do usuário do IVS Low-Latency*.
+ Para ver detalhes da API, consulte [GetStream](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ivs/get-stream.html) na *Referência de comandos da AWS CLI*.
### `import-playback-key-pair`
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 exemplo `import-playback-key-pair` a seguir importa a chave pública especificada (especificada como uma string no formato PEM) 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..."
```
Resultado:
```
{
"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](https://docs.aws.amazon.com/ivs/latest/userguide//private-channels.html) no *Guia do usuário do Amazon Interactive Video Service*.
+ *Para ver detalhes da API, consulte [ImportPlaybackKeyPair](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ivs/import-playback-key-pair.html) na Referência de comandos da AWS CLI*.
### `list-channels`
O código de exemplo a seguir mostra como usar `list-channels`.
**AWS CLI**
**Exemplo 1: obter informações resumidas sobre todos os canais**
O exemplo `list-channels` a seguir lista todos os canais da sua conta da AWS.
```
aws ivs list-channels
```
Resultado:
```
{
"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](https://docs.aws.amazon.com/ivs/latest/LowLatencyUserGuide/getting-started-create-channel.html) no *Guia do usuário do IVS Low-Latency*.
**Exemplo 2: obter informações resumidas sobre todos os canais, filtradas pelo ARN da RecordingConfiguration especificada**
O exemplo `list-channels` a seguir lista todos os canais da sua conta da AWS associados ao ARN da RecordingConfiguration especificada.
```
aws ivs list-channels \
--filter-by-recording-configuration-arn "arn:aws:ivs:us-west-2:123456789012:recording-configuration/ABCD12cdEFgh"
```
Resultado:
```
{
"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](https://docs.aws.amazon.com/ivs/latest/LowLatencyUserGuide/record-to-s3.html) no *Guia do usuário do IVS Low-Latency*.
**Exemplo 3: obter informações resumidas sobre todos os canais, filtradas pelo ARN da PlaybackRestrictionPolicy especificada**
O exemplo `list-channels` a seguir lista todos os canais da sua conta da AWS associados ao ARN da PlaybackRestrictionPolicy especificada.
```
aws ivs list-channels \
--filter-by-playback-restriction-policy-arn "arn:aws:ivs:us-west-2:123456789012:playback-restriction-policy/ABcdef34ghIJ"
```
Resultado:
```
{
"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 espectadores indesejados](https://docs.aws.amazon.com/ivs/latest/LowLatencyUserGuide/undesired-content.html) no *Guia do usuário do IVS Low-Latency*.
+ Consulte detalhes da API em [ListChannels](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ivs/list-channels.html) na *Referência de comandos da AWS CLI*.
### `list-playback-key-pairs`
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 chaves de reprodução**
O exemplo `list-playback-key-pairs` a seguir retorna informações sobre todos os pares de chaves.
```
aws ivs list-playback-key-pairs
```
Resultado:
```
{
"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](https://docs.aws.amazon.com/ivs/latest/userguide//private-channels.html) no *Guia do usuário do Amazon Interactive Video Service*.
+ Para ver detalhes da API, consulte [ListPlaybackKeyPairs](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ivs/list-playback-key-pairs.html) na *Referência de comandos da AWS CLI*.
### `list-playback-restriction-policies`
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 exemplo `list-playback-restriction-policies` a seguir lista todas as políticas de restrição de reprodução da sua conta da AWS.
```
aws ivs list-playback-restriction-policies
```
Resultado:
```
{
"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 espectadores indesejados](https://docs.aws.amazon.com/ivs/latest/LowLatencyUserGuide/undesired-content.html) no *Guia do usuário do IVS Low-Latency*.
+ Para ver detalhes da API, consulte [ListPlaybackRestrictionPolicies](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ivs/list-playback-restriction-policies.html) na *Referência de comandos da AWS CLI*.
### `list-recording-configurations`
O código de exemplo a seguir mostra como usar `list-recording-configurations`.
**AWS CLI**
**Para listar todos os recursos de RecordingConfiguration criados nessa conta**
O exemplo `list-recording-configurations` a seguir obtém informações sobre o todos os recursos de RecordingConfiguration em sua conta.
```
aws ivs list-recording-configurations
```
Resultado:
```
{
"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](https://docs.aws.amazon.com/ivs/latest/userguide/record-to-s3.html) no *Guia de usuário do Amazon Interactive Video Service*.
+ Para ver detalhes da API, consulte [ListRecordingConfigurations](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ivs/list-recording-configurations.html) na *Referência de comandos da AWS CLI*.
### `list-stream-keys`
O código de exemplo a seguir mostra como usar `list-stream-keys`.
**AWS CLI**
**Para obter uma lista de chaves de stream**
O exemplo `list-stream-keys` a seguir lista todas as chaves de stream para o ARN (Amazon Resource Name) especificado.
```
aws ivs list-stream-keys \
--channel-arn arn:aws:ivs:us-west-2:123456789012:channel/abcdABCDefgh
```
Resultado:
```
{
"streamKeys": [
{
"arn": "arn:aws:ivs:us-west-2:123456789012:stream-key/abcdABCDefgh",
"channelArn": "arn:aws:ivs:us-west-2:123456789012:channel/abcdABCDefgh",
"tags": {}
}
]
}
```
Para obter mais informações, consulte [Criar um canal](https://docs.aws.amazon.com/ivs/latest/LowLatencyUserGuide/getting-started-create-channel.html) no Guia do usuário de *baixa latência do IVS*.
+ Para ver detalhes da API, consulte [ListStreamKeys](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ivs/list-stream-keys.html) na *Referência de comandos da AWS CLI*.
### `list-stream-sessions`
O código de exemplo a seguir mostra como usar `list-stream-sessions`.
**AWS CLI**
**Para obter um resumo dos streams atuais e anteriores de um canal específico na região da AWS atual**
O exemplo `list-stream-sessions` a seguir relata informações resumidas de streams para um ARN (Amazon Resource Name) do canal especificado.
```
aws ivs list-stream-sessions \
--channel-arn arn:aws:ivs:us-west-2:123456789012:channel/abcdABCDefgh \
--max-results 25 \
--next-token ""
```
Resultado:
```
{
"nextToken": "set-2",
"streamSessions": [
{
"startTime": 1641578182,
"endTime": 1641579982,
"hasErrorEvent": false,
"streamId": "mystream"
}
...
]
}
```
Para obter mais informações, consulte [Criar um canal](https://docs.aws.amazon.com/ivs/latest/LowLatencyUserGuide/getting-started-create-channel.html) no *Guia do usuário do IVS Low-Latency*.
+ Para ver detalhes da API, consulte [ListStreamSessions](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ivs/list-stream-sessions.html) na *Referência de comandos da AWS CLI*.
### `list-streams`
O código de exemplo a seguir mostra como usar `list-streams`.
**AWS CLI**
**Para obter uma lista de streams ao vivo e seu estado**
O exemplo `list-streams` a seguir lista todos streams ao vivo em sua conta da AWS.
```
aws ivs list-streams
```
Resultado:
```
{
"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](https://docs.aws.amazon.com/ivs/latest/LowLatencyUserGuide/getting-started-create-channel.html) no *Guia do usuário do IVS Low-Latency*.
+ Consulte detalhes da API em [ListStreams](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ivs/list-streams.html) na *Referência de comandos da AWS CLI*.
### `list-tags-for-resource`
O código de exemplo a seguir mostra como usar `list-tags-for-resource`.
**AWS CLI**
**Para listar todas as tags de um recurso AWS (por exemplo: canal, chave de stream)**
O exemplo `list-tags-for-resource` a seguir lista todas as tags do recurso ARN (Amazon Resource Name) especificado.
```
aws ivs list-tags-for-resource \
--resource-arn arn:aws:ivs:us-west-2:12345689012:channel/abcdABCDefgh
```
Resultado:
```
{
"tags":
{
"key1": "value1",
"key2": "value2"
}
}
```
Para obter mais informações, consulte [Tags](https://docs.aws.amazon.com/ivs/latest/APIReference/Welcome.html) na *Referência da API do Amazon Interactive Video Service*.
+ Para obter detalhes sobre a API, consulte [ListTagsForResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ivs/list-tags-for-resource.html) na *AWS CLI Command Reference*.
### `put-metadata`
O código de exemplo a seguir mostra como usar `put-metadata`.
**AWS CLI**
**Como inserir metadados no stream ativo para um canal especificado**
O exemplo `put-metadata` a seguir insere os metadados fornecidos no stream 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](https://docs.aws.amazon.com/ivs/latest/LowLatencyUserGuide/getting-started-create-channel.html) no *Guia do usuário do IVS Low-Latency*.
+ Para ver detalhes da API, consulte [PutMetadata](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ivs/put-metadata.html) na *Referência de comandos da AWS CLI*.
### `start-viewer-session-revocation`
O código de exemplo a seguir mostra como usar `start-viewer-session-revocation`.
**AWS CLI**
**Como revogar sessões de visualizador para vários pares de ARN de canal e ID de visualizador**
O exemplo `start-viewer-session-revocation` a seguir inicia o processo de revogação da sessão do visualizador associada a um ARN de canal e ID de visualizador, incluindo até o número da versão de sessão especificada. Se uma versão não for fornecida, o valor padrão será 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](https://docs.aws.amazon.com/ivs/latest/userguide/private-channels.html) no *Guia do usuário do Amazon Interactive Video Service*.
+ Para ver detalhes da API, consulte [StartViewerSessionRevocation](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ivs/start-viewer-session-revocation.html) na *Referência de comandos da AWS CLI*.
### `stop-stream`
O código de exemplo a seguir mostra como usar `stop-stream`.
**AWS CLI**
**Para interromper um stream especificado**
O exemplo `stop-stream` a seguir interrompe o stream 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](https://docs.aws.amazon.com/ivs/latest/LowLatencyUserGuide/getting-started-create-channel.html) no *Guia do usuário do IVS Low-Latency*.
+ Para ver detalhes da API, consulte [StopStream](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ivs/stop-stream.html) na *Referência de comandos da AWS CLI*.
### `tag-resource`
O código de exemplo a seguir mostra como usar `tag-resource`.
**AWS CLI**
**Para adicionar ou atualizar tags de um recurso AWS (por exemplo: canal, chave de stream)**
O exemplo `tag-resource` a adiciona ou atualiza as tags do recurso ARN (Amazon Resource Name) especificado.
```
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 [Tags](https://docs.aws.amazon.com/ivs/latest/APIReference/Welcome.html) na *Referência da API do Amazon Interactive Video Service*.
+ Consulte detalhes da API em [TagResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ivs/tag-resource.html) na *Referência de comandos da AWS CLI*.
### `untag-resource`
O código de exemplo a seguir mostra como usar `untag-resource`.
**AWS CLI**
**Para remover tags de um recurso AWS (por exemplo: canal, chave de stream)**
O exemplo `untag-resource` a seguir remove as tags especificadas do recurso ARN (Amazon Resource Name) especificado.
```
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 [Tags](https://docs.aws.amazon.com/ivs/latest/APIReference/Welcome.html) na *Referência da API do Amazon Interactive Video Service*.
+ Para obter detalhes sobre a API, consulte [UntagResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ivs/untag-resource.html) na *Referência de comandos da AWS CLI*.
### `update-channel`
O código de exemplo a seguir mostra como usar `update-channel`.
**AWS CLI**
**Exemplo 1: obter as informações de configuração de um canal**
O exemplo `update-channel` a seguir atualiza a configuração do canal do ARN de canal especificado para alterar o nome do canal. Isso não afeta o stream em andamento neste canal; é necessário interromper e reiniciar o stream para que as alterações sejam aplicadas.
```
aws ivs update-channel \
--arn 'arn:aws:ivs:us-west-2:123456789012:channel/abcdABCDefgh' \
--name 'channel-1' \
--insecure-ingest
```
Resultado:
```
{
"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": {}
}
```
Para obter mais informações, consulte [Criar um canal](https://docs.aws.amazon.com/ivs/latest/LowLatencyUserGuide/getting-started-create-channel.html) no *Guia do usuário do IVS Low-Latency*.
**Exemplo 2: atualizar a configuração de um canal para ativar a gravação**
O exemplo `update-channel` a seguir atualiza a configuração do canal do ARN de canal especificado para ativar a gravação. Isso não afeta o stream em andamento neste canal; é necessário interromper e reiniciar o stream para que as alterações sejam aplicadas.
```
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'
```
Resultado:
```
{
"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": {}
}
}
```
Para obter mais informações, consulte [Gravar no Amazon S3](https://docs.aws.amazon.com/ivs/latest/LowLatencyUserGuide/record-to-s3.html) no *Guia do usuário do IVS Low-Latency*.
**Exemplo 3: atualizar a configuração de um canal para desativar a gravação**
O exemplo `update-channel` a seguir atualiza a configuração do canal do ARN de canal especificado para desativar a gravação. Isso não afeta o stream em andamento neste canal; é necessário interromper e reiniciar o stream para que as alterações sejam aplicadas.
```
aws ivs update-channel \
--arn 'arn:aws:ivs:us-west-2:123456789012:channel/abcdABCDefgh' \
--recording-configuration-arn ''
```
Resultado:
```
{
"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": {}
}
}
```
Para obter mais informações, consulte [Gravar no Amazon S3](https://docs.aws.amazon.com/ivs/latest/LowLatencyUserGuide/record-to-s3.html) no *Guia do usuário do IVS Low-Latency*.
**Exemplo 4: atualizar a configuração de um canal para ativar a restrição de reprodução**
O exemplo `update-channel` a seguir atualiza a configuração do canal do ARN de canal especificado para aplicar uma política de restrição de reprodução. Isso não afeta o stream em andamento neste canal; é necessário interromper e reiniciar o stream para que as alterações sejam aplicadas.
```
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'
```
Resultado:
```
{
"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": {}
}
}
```
Para obter mais informações, consulte [Conteúdo e espectadores indesejados](https://docs.aws.amazon.com/ivs/latest/LowLatencyUserGuide/undesired-content.html) no *Guia do usuário do IVS Low-Latency*.
**Exemplo 5: como atualizar a configuração de um canal para desabilitar a restrição de reprodução**
O exemplo `update-channel` a seguir atualiza a configuração do canal do ARN de canal especificado para desativar uma política de restrição de reprodução. Isso não afeta o stream em andamento neste canal; é necessário interromper e reiniciar o stream para que as alterações sejam aplicadas.
```
aws ivs update-channel \
--arn 'arn:aws:ivs:us-west-2:123456789012:channel/abcdABCDefgh' \
--playback-restriction-policy-arn ''
```
Resultado:
```
{
"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": {}
}
}
```
Para obter mais informações, consulte [Conteúdo e espectadores indesejados](https://docs.aws.amazon.com/ivs/latest/LowLatencyUserGuide/undesired-content.html) no *Guia do usuário do IVS Low-Latency*.
**Exemplo 6: como atualizar a configuração de um canal para habilitar o recurso de várias faixas**
O exemplo de `update-channel` a seguir atualiza a configuração do canal para o ARN de canal especificado com o objetivo de habilitar o recurso de várias faixas. Isso não afeta o stream em andamento neste canal; é necessário interromper e reiniciar o stream para que as alterações sejam aplicadas.
```
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"}'
```
Resultado:
```
{
"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": {}
}
}
```
Para obter mais informações, consulte [Conteúdo e espectadores indesejados](https://docs.aws.amazon.com/ivs/latest/LowLatencyUserGuide/multitrack-video.html) no *Guia do usuário do IVS Low-Latency*.
**Exemplo 7: como atualizar a configuração de um canal para desabilitar a restrição de reprodução**
O exemplo de `update-channel` a seguir atualiza a configuração do canal para o ARN de canal especificado com o objetivo de desabilitar o recurso de várias faixas. Isso não afeta o stream em andamento neste canal; é necessário interromper e reiniciar o stream para que as alterações sejam aplicadas.
```
aws ivs update-channel \
--arn 'arn:aws:ivs:us-west-2:123456789012:channel/abcdABCDefgh' \
--container-format 'TS' \
--multitrack-input-configuration '{"enabled": false}'
```
Resultado:
```
{
"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": {}
}
}
```
Para obter mais informações, consulte [Conteúdo e espectadores indesejados](https://docs.aws.amazon.com/ivs/latest/LowLatencyUserGuide/multitrack-video.html) no *Guia do usuário do IVS Low-Latency*.
+ Para ver detalhes da API, consulte [UpdateChannel](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ivs/update-channel.html) na *Referência de comandos da AWS CLI*.
### `update-playback-restriction-policy`
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 exemplo `update-playback-restriction-policy` a seguir atualiza a política de restrição de reprodução com o ARN da política especificada para desativar a imposição estrita de origem. Isso não afeta o stream contínuo do canal associado; você deverá interromper e reiniciar o stream para que as alterações sejam aplicadas.
```
aws ivs update-playback-restriction-policy \
--arn "arn:aws:ivs:us-west-2:123456789012:playback-restriction-policy/ABcdef34ghIJ" \
--no-enable-strict-origin-enforcement
```
Resultado:
```
{
"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 espectadores indesejados](https://docs.aws.amazon.com/ivs/latest/LowLatencyUserGuide/undesired-content.html) no *Guia do usuário do IVS Low-Latency*.
+ Para ver detalhes da API, consulte [UpdatePlaybackRestrictionPolicy](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ivs/update-playback-restriction-policy.html) na *Referência de comandos da AWS CLI*.