Há mais exemplos de AWS SDK disponíveis no repositório [AWS Doc SDK Examples](https://github.com/awsdocs/aws-doc-sdk-examples) GitHub .
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á.
# Exemplos de streaming em tempo real do Amazon IVS 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 Amazon IVS Real-Time Streaming.
*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
### `create-encoder-configuration`
O código de exemplo a seguir mostra como usar `create-encoder-configuration`.
**AWS CLI**
**Para criar uma configuração de codificador de composição**
O exemplo `create-encoder-configuration` a seguir cria um codificador de composição com as propriedades especificadas.
```
aws ivs-realtime create-encoder-configuration \
--name test-ec --video bitrate=3500000,framerate=30.0,height=1080,width=1920
```
Saída:
```
{
"encoderConfiguration": {
"arn": "arn:aws:ivs:ap-northeast-1:123456789012:encoder-configuration/ABabCDcdEFef",
"name": "test-ec",
"tags": {},
"video": {
"bitrate": 3500000,
"framerate": 30,
"height": 1080,
"width": 1920
}
}
}
```
Para obter mais informações, consulte [Habilitar vários hosts em um stream do Amazon IVS](https://docs.aws.amazon.com/ivs/latest/LowLatencyUserGuide/multiple-hosts.html) e *Service Quotas do Amazon IVS*.
+ Para obter detalhes da API, consulte [CreateEncoderConfiguration](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ivs-realtime/create-encoder-configuration.html)em *Referência de AWS CLI Comandos*.
### `create-ingest-configuration`
O código de exemplo a seguir mostra como usar `create-ingest-configuration`.
**AWS CLI**
**Como criar uma configuração de ingestão**
O exemplo de `create-ingest-configuration` a seguir cria uma configuração de ingestão usando o protocolo RTMPS.
```
aws ivs-realtime create-ingest-configuration \
--name ingest1 \
--ingest-protocol rtmps
```
Saída:
```
{
"ingestConfiguration": {
"name": "ingest1",
"arn": "arn:aws:ivs:us-west-2:123456789012:ingest-configuration/AbCdEfGh1234",
"ingestProtocol": "RTMPS",
"streamKey": "rt_123456789012_us-west-2_AbCdEfGh1234_abcd1234efgh5678ijkl9012MNOP34",
"stageArn": "",
"participantId": "xyZ654abC321",
"state": "INACTIVE",
"userId": "",
"tags": {}
}
}
```
Consulte mais informações em [Ingestão de streams do IVS \$1 Streaming em tempo real](https://docs.aws.amazon.com/ivs/latest/RealTimeUserGuide/rt-stream-ingest.html) no *Guia do usuário do Amazon Interactive Video Service*.
+ Para obter detalhes da API, consulte [CreateIngestConfiguration](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ivs-realtime/create-ingest-configuration.html)em *Referência de AWS CLI Comandos*.
### `create-participant-token`
O código de exemplo a seguir mostra como usar `create-participant-token`.
**AWS CLI**
**Para criar um token de participante de palco**
O exemplo `create-participant-token` a seguir cria um token de participante para o palco especificado.
```
aws ivs-realtime create-participant-token \
--stage-arn arn:aws:ivs:us-west-2:123456789012:stage/abcdABCDefgh \
--user-id bob
```
Saída:
```
{
"participantToken": {
"expirationTime": "2023-03-07T09:47:43+00:00",
"participantId": "ABCDEfghij01234KLMN6789",
"token": "abcd1234defg5678"
}
}
```
Para obter mais informações, consulte [Habilitar vários hosts em um stream do Amazon IVS](https://docs.aws.amazon.com/ivs/latest/userguide/multiple-hosts.html) e *Service Quotas do Amazon IVS*.
+ Para obter detalhes da API, consulte [CreateParticipantToken](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ivs-realtime/create-participant-token.html)em *Referência de AWS CLI Comandos*.
### `create-stage`
O código de exemplo a seguir mostra como usar `create-stage`.
**AWS CLI**
**Exemplo 1: criar um palco**
O exemplo `create-stage` a seguir cria um token de participante para o palco especificado.
```
aws ivs-realtime create-stage \
--name stage1 \
--participant-token-configurations userId=alice
```
Saída:
```
{
"participantTokens": [
{
"participantId": "ABCDEfghij01234KLMN5678",
"token": "a1b2c3d4567890ab",
"userId": "alice"
}
],
"stage": {
"activeSessionId": "st-a1b2c3d4e5f6g",
"arn": "arn:aws:ivs:us-west-2:123456789012:stage/abcdABCDefgh",
"autoParticipantRecordingConfiguration": {
"storageConfigurationArn": "",
"mediaTypes": [
"AUDIO_VIDEO"
],
"thumbnailConfiguration": {
"targetIntervalSeconds": 60,
"storage": [
"SEQUENTIAL"
],
"recordingMode": "DISABLED"
},
"recordingReconnectWindowSeconds": 0,
"hlsConfiguration": {
"targetSegmentDurationSeconds": 6
},
"recordParticipantReplicas": true
},
"endpoints": {
"events": "wss://global.events.live-video.net",
"rtmp": "rtmp://9x0y8z7s6t5u.global-contribute-staging.live-video.net/app/",
"rtmps": "rtmps://9x0y8z7s6t5u.global-contribute-staging.live-video.net:443/app/",
"whip": "https://9x0y8z7s6t5u.global-bm.whip.live-video.net"
},
"name": "stage1",
"tags": {}
}
}
```
Para ter mais informações, consulte [Habilitação de vários hosts em uma transmissão do Amazon IVS](https://docs.aws.amazon.com/ivs/latest/LowLatencyUserGuide/multiple-hosts.html) no *Guia do usuário do streaming de baixa latência do Amazon IVS*.
**Exemplo 2: criar um estágio e configurar a gravação de participantes individuais**
O exemplo `create-stage` a seguir cria um palco e a configura a gravação individual do participante.
```
aws ivs-realtime create-stage \
--name stage1 \
--auto-participant-recording-configuration '{"mediaTypes": ["AUDIO_VIDEO"],"storageConfigurationArn": "arn:aws:ivs:us-west-2:123456789012:storage-configuration/abcdABCDefgh", "recordingReconnectWindowSeconds": 100, \
"hlsConfiguration": {"targetSegmentDurationSeconds": 5}}'
```
Saída:
```
{
"stage": {
"activeSessionId": "st-a1b2c3d4e5f6g",
"arn": "arn:aws:ivs:us-west-2:123456789012:stage/abcdABCDefgh",
"autoParticipantRecordingConfiguration": {
"storageConfigurationArn": "arn:aws:ivs:us-west-2:123456789012:storage-configuration/abcdABCDefgh"
"mediaTypes": [
"AUDIO_VIDEO"
],
"thumbnailConfiguration": {
"targetIntervalSeconds": 60,
"storage": [
"SEQUENTIAL"
],
"recordingMode": "DISABLED"
},
"recordingReconnectWindowSeconds": 100,
"hlsConfiguration": {
"targetSegmentDurationSeconds": 5
},
"recordParticipantReplicas": true
},
"endpoints": {
"events": "wss://global.events.live-video.net",
"rtmp": "rtmp://9x0y8z7s6t5u.global-contribute-staging.live-video.net/app/",
"rtmps": "rtmps://9x0y8z7s6t5u.global-contribute-staging.live-video.net:443/app/",
"whip": "https://9x0y8z7s6t5u.global-bm.whip.live-video.net"
},
"name": "stage1",
"tags": {}
}
}
```
Para ter mais informações, consulte [Habilitação de vários hosts em uma transmissão do Amazon IVS](https://docs.aws.amazon.com/ivs/latest/LowLatencyUserGuide/multiple-hosts.html) no *Guia do usuário do streaming de baixa latência do Amazon IVS*.
**Exemplo 3: criar um estágio e configurar a gravação de participantes individuais com a gravação de miniatura habilitada**
O exemplo de `create-stage` a seguir cria um estágio e configura a gravação individual do participante com a gravação de miniatura habilitada.
```
aws ivs-realtime create-stage \
--name stage1 \
--auto-participant-recording-configuration '{"mediaTypes": ["AUDIO_VIDEO"],"storageConfigurationArn": "arn:aws:ivs:us-west-2:123456789012:storage-configuration/abcdABCDefgh", \
"thumbnailConfiguration": {"recordingMode": "INTERVAL","storage": ["SEQUENTIAL"],"targetIntervalSeconds": 60}}'
```
Saída:
```
{
"stage": {
"activeSessionId": "st-a1b2c3d4e5f6g",
"arn": "arn:aws:ivs:us-west-2:123456789012:stage/abcdABCDefgh",
"autoParticipantRecordingConfiguration": {
"storageConfigurationArn": "arn:aws:ivs:us-west-2:123456789012:storage-configuration/abcdABCDefgh",
"mediaTypes": [
"AUDIO_VIDEO"
],
"thumbnailConfiguration": {
"targetIntervalSeconds": 60,
"storage": [
"SEQUENTIAL"
],
"recordingMode": "INTERVAL"
},
"recordingReconnectWindowSeconds": 0,
"hlsConfiguration": {
"targetSegmentDurationSeconds": 6
},
"recordParticipantReplicas": true
},
"endpoints": {
"events": "wss://global.events.live-video.net",
"rtmp": "rtmp://9x0y8z7s6t5u.global-contribute-staging.live-video.net/app/",
"rtmps": "rtmps://9x0y8z7s6t5u.global-contribute-staging.live-video.net:443/app/",
"whip": "https://9x0y8z7s6t5u.global-bm.whip.live-video.net"
},
"name": "stage1",
"tags": {}
}
}
```
Para ter mais informações, consulte [Habilitação de vários hosts em uma transmissão do Amazon IVS](https://docs.aws.amazon.com/ivs/latest/LowLatencyUserGuide/multiple-hosts.html) no *Guia do usuário do streaming de baixa latência do Amazon IVS*.
+ Para obter detalhes da API, consulte [CreateStage](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ivs-realtime/create-stage.html)em *Referência de AWS CLI Comandos*.
### `create-storage-configuration`
O código de exemplo a seguir mostra como usar `create-storage-configuration`.
**AWS CLI**
**Para criar uma configuração de armazenamento de composição**
O exemplo `create-storage-configuration` a seguir cria uma configuração de armazenamento de composição com as propriedades especificadas.
```
aws ivs-realtime create-storage-configuration \
--name "test-sc" --s3 "bucketName=amzn-s3-demo-bucket"
```
Saída:
```
{
"storageConfiguration": {
"arn": "arn:aws:ivs:ap-northeast-1:123456789012:storage-configuration/ABabCDcdEFef",
"name": "test-sc",
"s3": {
"bucketName": "amzn-s3-demo-bucket"
},
"tags": {}
}
}
```
Para obter mais informações, consulte [Habilitar vários hosts em um stream do Amazon IVS](https://docs.aws.amazon.com/ivs/latest/LowLatencyUserGuide/multiple-hosts.html) e *Service Quotas do Amazon IVS*.
+ Para obter detalhes da API, consulte [CreateStorageConfiguration](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ivs-realtime/create-storage-configuration.html)em *Referência de AWS CLI Comandos*.
### `delete-encoder-configuration`
O código de exemplo a seguir mostra como usar `delete-encoder-configuration`.
**AWS CLI**
**Para excluir uma configuração de codificador de composição**
O seguinte `delete-encoder-configuration` exclui a configuração do codificador de composição especificada pelo ARN (Amazon Resource Name) fornecido.
```
aws ivs-realtime delete-encoder-configuration \
--arn "arn:aws:ivs:ap-northeast-1:123456789012:encoder-configuration/ABabCDcdEFef"
```
Este comando não produz saída.
Para obter mais informações, consulte [Habilitar vários hosts em um stream do Amazon IVS](https://docs.aws.amazon.com/ivs/latest/LowLatencyUserGuide/multiple-hosts.html) e *Service Quotas do Amazon IVS*.
+ Para obter detalhes da API, consulte [DeleteEncoderConfiguration](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ivs-realtime/delete-encoder-configuration.html)em *Referência de AWS CLI Comandos*.
### `delete-ingest-configuration`
O código de exemplo a seguir mostra como usar `delete-ingest-configuration`.
**AWS CLI**
**Exemplo 1: como excluir uma configuração de ingestão inativa**
O exemplo de `delete-ingest-configuration` a seguir exclui a configuração de ingestão inativa para um nome de recurso da Amazon (ARN) de configuração de ingestão especificado.
```
aws ivs-realtime delete-ingest-configuration \
--arn arn:aws:ivs:us-west-2:123456789012:ingest-configuration/AbCdEfGh1234
```
Este comando não produz saída.
Consulte mais informações em [Ingestão de streams do IVS \$1 Streaming em tempo real](https://docs.aws.amazon.com/ivs/latest/RealTimeUserGuide/rt-stream-ingest.html) no *Guia do usuário do Amazon Interactive Video Service*.
**Exemplo 2: como forçar a exclusão de uma configuração de ingestão inativa**
O exemplo de `delete-ingest-configuration` a seguir força a exclusão da configuração de ingestão ativa para um nome de recurso da Amazon (ARN) de configuração de ingestão especificado.
```
aws ivs-realtime delete-ingest-configuration \
--arn arn:aws:ivs:us-west-2:123456789012:ingest-configuration/AbCdEfGh1234 \
--force
```
Este comando não produz saída.
Consulte mais informações em [Ingestão de streams do IVS \$1 Streaming em tempo real](https://docs.aws.amazon.com/ivs/latest/RealTimeUserGuide/rt-stream-ingest.html) no *Guia do usuário do Amazon Interactive Video Service*.
+ Para obter detalhes da API, consulte [DeleteIngestConfiguration](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ivs-realtime/delete-ingest-configuration.html)em *Referência de AWS CLI Comandos*.
### `delete-public-key`
O código de exemplo a seguir mostra como usar `delete-public-key`.
**AWS CLI**
**Para excluir uma chave pública**
O exemplo `delete-public-key` a seguir exclui a chave pública especificada.
```
aws ivs-realtime delete-public-key \
--arn arn:aws:ivs:us-west-2:123456789012:public-key/abcdABC1efg2
```
Este comando não produz saída.
Para obter mais informações, consulte [Distribuir tokens de participantes](https://docs.aws.amazon.com/ivs/latest/RealTimeUserGuide/getting-started-distribute-tokens.html) no *Guia do usuário de streaming em tempo real do Amazon IVS*.
+ Para obter detalhes da API, consulte [DeletePublicKey](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ivs-realtime/delete-public-key.html)em *Referência de AWS CLI Comandos*.
### `delete-stage`
O código de exemplo a seguir mostra como usar `delete-stage`.
**AWS CLI**
**Para excluir uma estágio**
O exemplo `delete-stage` a seguir exclui o palco especificado.
```
aws ivs-realtime delete-stage \
--arn arn:aws:ivs:us-west-2:123456789012:stage/abcdABCDefgh
```
Este comando não produz saída.
Para obter mais informações, consulte [Habilitar vários hosts em um stream do Amazon IVS](https://docs.aws.amazon.com/ivs/latest/userguide/multiple-hosts.html) e *Service Quotas do Amazon IVS*.
+ Para obter detalhes da API, consulte [DeleteStage](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ivs-realtime/delete-stage.html)em *Referência de AWS CLI Comandos*.
### `delete-storage-configuration`
O código de exemplo a seguir mostra como usar `delete-storage-configuration`.
**AWS CLI**
**Para excluir uma configuração de armazenamento de composição**
O seguinte `delete-storage-configuration` exclui a configuração de armazenamento de composição especificada pelo ARN (Amazon Resource Name) fornecido.
```
aws ivs-realtime delete-storage-configuration \
--arn "arn:aws:ivs:ap-northeast-1:123456789012:storage-configuration/ABabCDcdEFef"
```
Este comando não produz saída.
Para obter mais informações, consulte [Habilitar vários hosts em um stream do Amazon IVS](https://docs.aws.amazon.com/ivs/latest/LowLatencyUserGuide/multiple-hosts.html) e *Service Quotas do Amazon IVS*.
+ Para obter detalhes da API, consulte [DeleteStorageConfiguration](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ivs-realtime/delete-storage-configuration.html)em *Referência de AWS CLI Comandos*.
### `disconnect-participant`
O código de exemplo a seguir mostra como usar `disconnect-participant`.
**AWS CLI**
**Como desconectar um participante do palco**
O exemplo `disconnect-participant` a seguir desconecta o participante especificado do palco especificada.
```
aws ivs-realtime disconnect-participant \
--stage-arn arn:aws:ivs:us-west-2:123456789012:stage/abcdABCDefgh \
--participant-id ABCDEfghij01234KLMN5678
```
Este comando não produz saída.
Para obter mais informações, consulte [Habilitar vários hosts em um stream do Amazon IVS](https://docs.aws.amazon.com/ivs/latest/userguide/multiple-hosts.html) e *Service Quotas do Amazon IVS*.
+ Para obter detalhes da API, consulte [DisconnectParticipant](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ivs-realtime/disconnect-participant.html)em *Referência de AWS CLI Comandos*.
### `get-composition`
O código de exemplo a seguir mostra como usar `get-composition`.
**AWS CLI**
**Exemplo 1: obter uma composição com configurações de layout padrão**
O exemplo `get-composition` a seguir obtém a composição do ARN (Amazon Resource Name) especificado.
```
aws ivs-realtime get-composition \
--arn "arn:aws:ivs:ap-northeast-1:123456789012:composition/abcdABCDefgh"
```
Saída:
```
{
"composition": {
"arn": "arn:aws:ivs:ap-northeast-1:123456789012:composition/abcdABCDefgh",
"destinations": [
{
"configuration": {
"channel": {
"channelArn": "arn:aws:ivs:ap-northeast-1:123456789012:channel/abcABCdefDEg",
"encoderConfigurationArn": "arn:aws:ivs:ap-northeast-1:123456789012:encoder-configuration/ABabCDcdEFef"
},
"name": ""
},
"id": "AabBCcdDEefF",
"startTime": "2023-10-16T23:26:00+00:00",
"state": "ACTIVE"
},
{
"configuration": {
"name": "",
"s3": {
"encoderConfigurationArns": [
"arn:aws:ivs:arn:aws:ivs:ap-northeast-1:123456789012:encoder-configuration/ABabCDcdEFef"
],
"recordingConfiguration": {
"format": "HLS",
"hlsConfiguration": {
"targetSegmentDurationSeconds": 2
}
},
"storageConfigurationArn": "arn:arn:aws:ivs:ap-northeast-1:123456789012:storage-configuration/FefABabCDcdE",
}
},
"detail": {
"s3": {
"recordingPrefix": "aBcDeFgHhGfE/AbCdEfGhHgFe/GHFabcgefABC/composite"
}
},
"id": "GHFabcgefABC",
"startTime": "2023-10-16T23:26:00+00:00",
"state": "STARTING"
}
],
"layout": {
"grid": {
"featuredParticipantAttribute": "",
"gridGap": 2,
"omitStoppedVideo": false,
"participantOrderAttribute": "",
"videoAspectRatio": "VIDEO",
"videoFillMode": ""
}
},
"stageArn": "arn:aws:ivs:ap-northeast-1:123456789012:stage/defgABCDabcd",
"startTime": "2023-10-16T23:24:00+00:00",
"state": "ACTIVE",
"tags": {}
}
}
```
Para ter mais informações, consulte [Gravação composta do IVS \$1 Streaming em tempo real](https://docs.aws.amazon.com/ivs/latest/RealTimeUserGuide/rt-composite-recording.html) no *Guia do usuário do Amazon Interactive Video Service*.
**Exemplo 2: obter uma composição com layout PiP**
O exemplo `get-composition` a seguir obtém a composição do ARN (Amazon Resource Name) especificado, usando o layout PiP.
```
aws ivs-realtime get-composition \
--arn "arn:aws:ivs:ap-northeast-1:123456789012:composition/wxyzWXYZpqrs"
```
Saída:
```
{
"composition": {
"arn": "arn:aws:ivs:ap-northeast-1:123456789012:composition/wxyzWXYZpqrs",
"destinations": [
{
"configuration": {
"channel": {
"channelArn": "arn:aws:ivs:ap-northeast-1:123456789012:channel/abcABCdefDEg",
"encoderConfigurationArn": "arn:aws:ivs:ap-northeast-1:123456789012:encoder-configuration/ABabCDcdEFef"
},
"name": ""
},
"id": "AabBCcdDEefF",
"startTime": "2023-10-16T23:26:00+00:00",
"state": "ACTIVE"
},
{
"configuration": {
"name": "",
"s3": {
"encoderConfigurationArns": [
"arn:aws:ivs:arn:aws:ivs:ap-northeast-1:123456789012:encoder-configuration/ABabCDcdEFef"
],
"recordingConfiguration": {
"format": "HLS",
"hlsConfiguration": {
"targetSegmentDurationSeconds": 2
}
},
"storageConfigurationArn": "arn:arn:aws:ivs:ap-northeast-1:123456789012:storage-configuration/FefABabCDcdE"
}
},
"detail": {
"s3": {
"recordingPrefix": "aBcDeFgHhGfE/AbCdEfGhHgFe/GHFabcgefABC/composite"
}
},
"id": "GHFabcgefABC",
"startTime": "2023-10-16T23:26:00+00:00",
"state": "STARTING"
}
],
"layout": {
"pip": {
"featuredParticipantAttribute": "abcdefg",
"gridGap": 0,
"omitStoppedVideo": false,
"participantOrderAttribute": "",
"pipBehavior": "STATIC",
"pipOffset": 0,
"pipParticipantAttribute": "",
"pipPosition": "BOTTOM_RIGHT",
"videoFillMode": "COVER"
}
},
"stageArn": "arn:aws:ivs:ap-northeast-1:123456789012:stage/defgABCDabcd",
"startTime": "2023-10-16T23:24:00+00:00",
"state": "ACTIVE",
"tags": {}
}
}
```
Para ter mais informações, consulte [Gravação composta do IVS \$1 Streaming em tempo real](https://docs.aws.amazon.com/ivs/latest/RealTimeUserGuide/rt-composite-recording.html) no *Guia do usuário do Amazon Interactive Video Service*.
**Exemplo 3: como obter uma composição com a gravação de miniatura habilitada**
O exemplo de `get-composition` a seguir obtém a composição para o ARN (nome do recurso da Amazon) especificado, que tem a gravação de miniatura habilitada com as configurações padrão.
```
aws ivs-realtime get-composition \
--arn "arn:aws:ivs:ap-northeast-1:123456789012:composition/abcdABCDefgh"
```
Saída:
```
{
"composition": {
"arn": "arn:aws:ivs:ap-northeast-1:123456789012:composition/abcdABCDefgh",
"destinations": [
{
"configuration": {
"channel": {
"channelArn": "arn:aws:ivs:ap-northeast-1:123456789012:channel/abcABCdefDEg",
"encoderConfigurationArn": "arn:aws:ivs:ap-northeast-1:123456789012:encoder-configuration/ABabCDcdEFef"
},
"name": ""
},
"id": "AabBCcdDEefF",
"startTime": "2023-10-16T23:26:00+00:00",
"state": "ACTIVE"
},
{
"configuration": {
"name": "",
"s3": {
"encoderConfigurationArns": [
"arn:aws:ivs:arn:aws:ivs:ap-northeast-1:123456789012:encoder-configuration/ABabCDcdEFef"
],
"recordingConfiguration": {
"format": "HLS",
"hlsConfiguration": {
"targetSegmentDurationSeconds": 2
}
},
"storageConfigurationArn": "arn:arn:aws:ivs:ap-northeast-1:123456789012:storage-configuration/FefABabCDcdE",
"thumbnailConfigurations": [
{
"targetIntervalSeconds": 60,
"storage": [
"SEQUENTIAL"
],
}
]
}
},
"detail": {
"s3": {
"recordingPrefix": "aBcDeFgHhGfE/AbCdEfGhHgFe/GHFabcgefABC/composite"
}
},
"id": "GHFabcgefABC",
"startTime": "2023-10-16T23:26:00+00:00",
"state": "STARTING"
}
],
"layout": {
"grid": {
"featuredParticipantAttribute": ""
"gridGap": 2,
"omitStoppedVideo": false,
"participantOrderAttribute": "",
"videoAspectRatio": "VIDEO",
"videoFillMode": "" }
},
"stageArn": "arn:aws:ivs:ap-northeast-1:123456789012:stage/defgABCDabcd",
"startTime": "2023-10-16T23:24:00+00:00",
"state": "ACTIVE",
"tags": {}
}
}
```
Para ter mais informações, consulte [Gravação composta do IVS \$1 Streaming em tempo real](https://docs.aws.amazon.com/ivs/latest/RealTimeUserGuide/rt-composite-recording.html) no *Guia do usuário do Amazon Interactive Video Service*.
+ Para obter detalhes da API, consulte [GetComposition](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ivs-realtime/get-composition.html)em *Referência de AWS CLI Comandos*.
### `get-encoder-configuration`
O código de exemplo a seguir mostra como usar `get-encoder-configuration`.
**AWS CLI**
**Para obter uma configuração de codificador de composição**
O exemplo `get-encoder-configuration` a seguir obtém a configuração do codificador de composição especificada pelo ARN (Amazon Resource Name) fornecido.
```
aws ivs-realtime get-encoder-configuration \
--arn "arn:aws:ivs:ap-northeast-1:123456789012:encoder-configuration/abcdABCDefgh"
```
Saída:
```
{
"encoderConfiguration": {
"arn": "arn:aws:ivs:ap-northeast-1:123456789012:encoder-configuration/abcdABCDefgh",
"name": "test-ec",
"tags": {},
"video": {
"bitrate": 3500000,
"framerate": 30,
"height": 1080,
"width": 1920
}
}
}
```
Para obter mais informações, consulte [Habilitar vários hosts em um stream do Amazon IVS](https://docs.aws.amazon.com/ivs/latest/LowLatencyUserGuide/multiple-hosts.html) e *Service Quotas do Amazon IVS*.
+ Para obter detalhes da API, consulte [GetEncoderConfiguration](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ivs-realtime/get-encoder-configuration.html)em *Referência de AWS CLI Comandos*.
### `get-ingest-configuration`
O código de exemplo a seguir mostra como usar `get-ingest-configuration`.
**AWS CLI**
**Como obter informações de configuração de ingestão**
O exemplo de `get-ingest-configuration` a seguir obtém a configuração de ingestão para um nome de recurso da Amazon (ARN) de configuração de ingestão especificado.
```
aws ivs-realtime get-ingest-configuration \
--arn arn:aws:ivs:us-west-2:123456789012:ingest-configuration/AbCdEfGh1234
```
Saída:
```
{
"ingestConfiguration": {
"name": "ingest1",
"arn": "arn:aws:ivs:us-west-2:123456789012:ingest-configuration/AbCdEfGh1234",
"ingestProtocol": "RTMPS",
"streamKey": "rt_123456789012_us-west-2_AbCdEfGh1234_abcd1234efgh5678ijkl9012MNOP34",
"stageArn": "",
"participantId": "xyZ654abC321",
"state": "INACTIVE",
"userId": "",
"tags": {}
}
}
```
Consulte mais informações em [Ingestão de streams do IVS \$1 Streaming em tempo real](https://docs.aws.amazon.com/ivs/latest/RealTimeUserGuide/rt-stream-ingest.html) no *Guia do usuário do Amazon Interactive Video Service*.
+ Para obter detalhes da API, consulte [GetIngestConfiguration](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ivs-realtime/get-ingest-configuration.html)em *Referência de AWS CLI Comandos*.
### `get-participant`
O código de exemplo a seguir mostra como usar `get-participant`.
**AWS CLI**
**Exemplo 1: obter um participante do palco**
O exemplo `get-participant` a seguir obtém o participante do palco para um ID de participante e ID de sessão especificados no ARN (Amazon Resource Name) especificado do estágio.
```
aws ivs-realtime get-participant \
--stage-arn arn:aws:ivs:us-west-2:123456789012:stage/abcdABCDefgh \
--session-id st-a1b2c3d4e5f6g \
--participant-id abCDEf12GHIj
```
Saída:
```
{
"participant": {
"browserName": "Google Chrome",
"browserVersion": "116",
"firstJoinTime": "2023-04-26T20:30:34+00:00",
"ispName": "Comcast",
"osName": "Microsoft Windows 10 Pro",
"osVersion": "10.0.19044",
"participantId": "abCDEf12GHIj",
"published": true,
"recordingS3BucketName": "bucket-name",
"recordingS3Prefix": "abcdABCDefgh/st-a1b2c3d4e5f6g/abCDEf12GHIj/1234567890",
"recordingState": "ACTIVE",
"sdkVersion": "",
"state": "CONNECTED",
"userId": ""
}
}
```
Para ter mais informações, consulte [Habilitação de vários hosts em uma transmissão do Amazon IVS](https://docs.aws.amazon.com/ivs/latest/LowLatencyUserGuide/multiple-hosts.html) no *Guia do usuário do streaming de baixa latência do Amazon IVS*.
**Exemplo 2: obter um participante do palco que foi replicado para outro palco**
O exemplo `get-participant` a seguir obtém o participante do palco para um ID de participante e ID de sessão especificados no nome do recurso da Amazon (ARN) especificado do palco, quando o participante também foi replicado para outro palco.
```
aws ivs-realtime get-participant \
--stage-arn arn:aws:ivs:us-west-2:123456789012:stage/abcdABCDefgh \
--session-id st-a1b2c3d4e5f6g \
--participant-id abCDEf12GHIj
```
Saída:
```
{
"participant": {
"browserName": "Google Chrome",
"browserVersion": "116",
"firstJoinTime": "2023-04-26T20:30:34+00:00",
"ispName": "Comcast",
"osName": "Microsoft Windows 10 Pro",
"osVersion": "10.0.19044",
"participantId": "abCDEf12GHIj",
"published": true,
"recordingS3BucketName": "bucket-name",
"recordingS3Prefix": "abcdABCDefgh/st-a1b2c3d4e5f6g/abCDEf12GHIj/1234567890",
"recordingState": "ACTIVE",
"replicationState": "ACTIVE",
"replicationType": "SOURCE",
"sdkVersion": "",
"state": "CONNECTED",
"userId": ""
}
}
```
Para ter mais informações, consulte [Habilitação de vários hosts em uma transmissão do Amazon IVS](https://docs.aws.amazon.com/ivs/latest/LowLatencyUserGuide/multiple-hosts.html) no *Guia do usuário do streaming de baixa latência do Amazon IVS*.
**Exemplo 3: obter um participante do palco que foi replicado para outro palco**
O exemplo `get-participant` a seguir obtém o participante do palco para um ID de participante e ID de sessão especificados no nome do recurso da Amazon (ARN) especificado do palco, quando o participante foi replicado de outro palco.
```
aws ivs-realtime get-participant \
--stage-arn arn:aws:ivs:us-west-2:123456789012:stage/abcdABCDefgh \
--session-id st-a1b2c3d4e5f6g \
--participant-id abCDEf12GHIj
```
Saída:
```
{
"participant": {
"browserName": "Google Chrome",
"browserVersion": "116",
"firstJoinTime": "2023-04-26T20:30:34+00:00",
"ispName": "Comcast",
"osName": "Microsoft Windows 10 Pro",
"osVersion": "10.0.19044",
"participantId": "abCDEf12GHIj",
"published": true,
"recordingS3BucketName": "bucket-name",
"recordingS3Prefix": "abcdABCDefgh/st-a1b2c3d4e5f6g/abCDEf12GHIj/1234567890",
"recordingState": "ACTIVE",
"replicationState": "ACTIVE",
"replicationType": "REPLICA",
"sdkVersion": "",
"state": "CONNECTED",
"userId": ""
}
}
```
Para ter mais informações, consulte [Habilitação de vários hosts em uma transmissão do Amazon IVS](https://docs.aws.amazon.com/ivs/latest/LowLatencyUserGuide/multiple-hosts.html) no *Guia do usuário do streaming de baixa latência do Amazon IVS*.
+ Para obter detalhes da API, consulte [GetParticipant](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ivs-realtime/get-participant.html)em *Referência de AWS CLI Comandos*.
### `get-public-key`
O código de exemplo a seguir mostra como usar `get-public-key`.
**AWS CLI**
**Para obter uma chave pública existente usada para assinar tokens de participantes do palco**
O exemplo `get-public-key` a seguir obtém uma chave pública especificada pelo ARN fornecido para assinar tokens de participantes do palco.
```
aws ivs-realtime get-public-key \
--arn arn:aws:ivs:us-west-2:123456789012:public-key/abcdABC1efg2
```
Saída:
```
{
"publicKey": {
"arn": "arn:aws:ivs:us-west-2:123456789012:public-key/abcdABC1efg2",
"name": "",
"publicKeyMaterial": "-----BEGIN PUBLIC KEY-----\nMHYwEAYHKoZIzj0CAQYFK4EEACIDYgAEqVWUtqs6EktQMR1sCYmEzGvRwtaycI16\n9pmzcpiWu/uhNStGlteJ5odRfRwVkoQUMnSZXTCcbn9bBTTmiWo4mJcFOOAzsthH\n0UAb8NdD4tUE0At4a9hYP9IETEXAMPLE\n-----END PUBLIC KEY-----",
"fingerprint": "12:a3:44:56:bc:7d:e8:9f:10:2g:34:hi:56:78:90:12",
"tags": {}
}
}
```
Para obter mais informações, consulte [Distribuir tokens de participantes](https://docs.aws.amazon.com/ivs/latest/RealTimeUserGuide/getting-started-distribute-tokens.html) no *Guia do usuário de streaming em tempo real do Amazon IVS*.
+ Para obter detalhes da API, consulte [GetPublicKey](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ivs-realtime/get-public-key.html)em *Referência de AWS CLI Comandos*.
### `get-stage-session`
O código de exemplo a seguir mostra como usar `get-stage-session`.
**AWS CLI**
**Para obter uma sessão de palco**
O exemplo `get-stage-session` a seguir obtém a sessão de palco para um ID de sessão especificados no ARN (Amazon Resource Name) do palco especificado.
```
aws ivs-realtime get-stage-session \
--stage-arn arn:aws:ivs:us-west-2:123456789012:stage/abcdABCDefgh \
--session-id st-a1b2c3d4e5f6g
```
Saída:
```
{
"stageSession": {
"endTime": "2023-04-26T20:36:29+00:00",
"sessionId": "st-a1b2c3d4e5f6g",
"startTime": "2023-04-26T20:30:29.602000+00:00"
}
}
```
Para obter mais informações, consulte [Habilitar vários hosts em um stream do Amazon IVS](https://docs.aws.amazon.com/ivs/latest/userguide/multiple-hosts.html) e *Service Quotas do Amazon IVS*.
+ Para obter detalhes da API, consulte [GetStageSession](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ivs-realtime/get-stage-session.html)em *Referência de AWS CLI Comandos*.
### `get-stage`
O código de exemplo a seguir mostra como usar `get-stage`.
**AWS CLI**
**Para obter as informações de configuração de um palco**
O exemplo `get-stage` a seguir obtém a configuração de palco para um ARN (Amazon Resource Name) especificado.
```
aws ivs-realtime get-stage \
--arn arn:aws:ivs:us-west-2:123456789012:stage/abcdABCDefgh
```
Saída:
```
{
"stage": {
"activeSessionId": "st-a1b2c3d4e5f6g",
"arn": "arn:aws:ivs:us-west-2:123456789012:stage/abcdABCDefgh",
"autoParticipantRecordingConfiguration": {
"storageConfigurationArn": "",
"mediaTypes": [
"AUDIO_VIDEO"
],
"thumbnailConfiguration": {
"targetIntervalSeconds": 60,
"storage": [
"SEQUENTIAL"
],
"recordingMode": "DISABLED"
},
"recordingReconnectWindowSeconds": 0,
"hlsConfiguration": {
"targetSegmentDurationSeconds": 6
},
"recordParticipantReplicas": true
},
"endpoints": {
"events": "wss://global.events.live-video.net",
"rtmp": "rtmp://9x0y8z7s6t5u.global-contribute-staging.live-video.net/app/",
"rtmps": "rtmps://9x0y8z7s6t5u.global-contribute-staging.live-video.net:443/app/",
"whip": "https://9x0y8z7s6t5u.global-bm.whip.live-video.net"
},
"name": "test",
"tags": {}
}
}
```
Para ter mais informações, consulte [Habilitação de vários hosts em uma transmissão do Amazon IVS](https://docs.aws.amazon.com/ivs/latest/LowLatencyUserGuide/multiple-hosts.html) no *Guia do usuário do streaming de baixa latência do Amazon IVS*.
+ Para obter detalhes da API, consulte [GetStage](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ivs-realtime/get-stage.html)em *Referência de AWS CLI Comandos*.
### `get-storage-configuration`
O código de exemplo a seguir mostra como usar `get-storage-configuration`.
**AWS CLI**
**Para obter uma configuração de armazenamento de composição**
O exemplo `get-storage-configuration` a seguir obtém a configuração de armazenamento da composição especificada pelo ARN (Amazon Resource Name) fornecido.
```
aws ivs-realtime get-storage-configuration \
--name arn "arn:aws:ivs:ap-northeast-1:123456789012:storage-configuration/abcdABCDefgh"
```
Saída:
```
{
"storageConfiguration": {
"arn": "arn:aws:ivs:ap-northeast-1:123456789012:storage-configuration/abcdABCDefgh",
"name": "test-sc",
"s3": {
"bucketName": "amzn-s3-demo-bucket"
},
"tags": {}
}
}
```
Para obter mais informações, consulte [Habilitar vários hosts em um stream do Amazon IVS](https://docs.aws.amazon.com/ivs/latest/LowLatencyUserGuide/multiple-hosts.html) e *Service Quotas do Amazon IVS*.
+ Para obter detalhes da API, consulte [GetStorageConfiguration](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ivs-realtime/get-storage-configuration.html)em *Referência de AWS CLI Comandos*.
### `import-public-key`
O código de exemplo a seguir mostra como usar `import-public-key`.
**AWS CLI**
**Para importar uma chave pública existente usada para assinar tokens de participantes do palco**
O exemplo `import-public-key` a seguir importa uma chave pública de um arquivo de material, para ser usada para assinar tokens de participantes do palco.
```
aws ivs-realtime import-public-key \
--public-key-material="`cat public.pem`"
```
Saída:
```
{
"publicKey": {
"arn": "arn:aws:ivs:us-west-2:123456789012:public-key/abcdABC1efg2",
"name": "",
"publicKeyMaterial": "-----BEGIN PUBLIC KEY-----\nMHYwEAYHKoZIzj0CAQYFK4EEACIDYgAEqVWUtqs6EktQMR1sCYmEzGvRwtaycI16\n9pmzcpiWu/uhNStGlteJ5odRfRwVkoQUMnSZXTCcbn9bBTTmiWo4mJcFOOAzsthH\n0UAb8NdD4tUE0At4a9hYP9IETEXAMPLE\n-----END PUBLIC KEY-----",
"fingerprint": "12:a3:44:56:bc:7d:e8:9f:10:2g:34:hi:56:78:90:12",
"tags": {}
}
}
```
Para obter mais informações, consulte [Distribuir tokens de participantes](https://docs.aws.amazon.com/ivs/latest/RealTimeUserGuide/getting-started-distribute-tokens.html) no *Guia do usuário de streaming em tempo real do Amazon IVS*.
+ Para obter detalhes da API, consulte [ImportPublicKey](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ivs-realtime/import-public-key.html)em *Referência de AWS CLI Comandos*.
### `list-compositions`
O código de exemplo a seguir mostra como usar `list-compositions`.
**AWS CLI**
**Para obter uma lista de composições**
A seguir, `list-compositions` listamos todas as composições AWS da sua conta, na AWS região em que a solicitação da API é processada.
```
aws ivs-realtime list-compositions
```
Saída:
```
{
"compositions": [
{
"arn": "arn:aws:ivs:ap-northeast-1:123456789012:composition/abcdABCDefgh",
"destinations": [
{
"id": "AabBCcdDEefF",
"startTime": "2023-10-16T23:25:23+00:00",
"state": "ACTIVE"
}
],
"stageArn": "arn:aws:ivs:ap-northeast-1:123456789012:stage/defgABCDabcd",
"startTime": "2023-10-16T23:25:21+00:00",
"state": "ACTIVE",
"tags": {}
},
{
"arn": "arn:aws:ivs:ap-northeast-1:123456789012:composition/ABcdabCDefgh",
"destinations": [
{
"endTime": "2023-10-16T23:25:00.786512+00:00",
"id": "aABbcCDdeEFf",
"startTime": "2023-10-16T23:24:01+00:00",
"state": "STOPPED"
},
{
"endTime": "2023-10-16T23:25:00.786512+00:00",
"id": "deEFfaABbcCD",
"startTime": "2023-10-16T23:24:01+00:00",
"state": "STOPPED"
}
],
"endTime": "2023-10-16T23:25:00+00:00",
"stageArn": "arn:aws:ivs:ap-northeast-1:123456789012:stage/efghabcdABCD",
"startTime": "2023-10-16T23:24:00+00:00",
"state": "STOPPED",
"tags": {}
}
]
}
```
Para obter mais informações, consulte [Habilitar vários hosts em um stream do Amazon IVS](https://docs.aws.amazon.com/ivs/latest/LowLatencyUserGuide/multiple-hosts.html) e *Service Quotas do Amazon IVS*.
+ Para obter detalhes da API, consulte [ListCompositions](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ivs-realtime/list-compositions.html)em *Referência de AWS CLI Comandos*.
### `list-encoder-configurations`
O código de exemplo a seguir mostra como usar `list-encoder-configurations`.
**AWS CLI**
**Para listar as configurações do codificador de composição**
Veja a seguir `list-encoder-configurations` todas as configurações do codificador de composição da sua AWS conta, na AWS região em que a solicitação da API é processada.
```
aws ivs-realtime list-encoder-configurations
```
Saída:
```
{
"encoderConfigurations": [
{
"arn": "arn:aws:ivs:ap-northeast-1:123456789012:encoder-configuration/abcdABCDefgh",
"name": "test-ec-1",
"tags": {}
},
{
"arn": "arn:aws:ivs:ap-northeast-1:123456789012:encoder-configuration/ABCefgEFGabc",
"name": "test-ec-2",
"tags": {}
}
]
}
```
Para obter mais informações, consulte [Habilitar vários hosts em um stream do Amazon IVS](https://docs.aws.amazon.com/ivs/latest/LowLatencyUserGuide/multiple-hosts.html) e *Service Quotas do Amazon IVS*.
+ Para obter detalhes da API, consulte [ListEncoderConfigurations](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ivs-realtime/list-encoder-configurations.html)em *Referência de AWS CLI Comandos*.
### `list-ingest-configurations`
O código de exemplo a seguir mostra como usar `list-ingest-configurations`.
**AWS CLI**
**Como obter informações de resumo sobre todas as configurações de ingestão**
O `list-ingest-configurations` exemplo a seguir lista todas as configurações de ingestão da sua AWS conta, na AWS região em que a solicitação da API é processada.
```
aws ivs-realtime list-ingest-configurations
```
Saída:
```
{
"ingestConfigurations": [
{
"name": "",
"arn": "arn:aws:ivs:us-west-2:123456789012:ingest-configuration/XYZuvwSt4567",
"ingestProtocol": "RTMPS",
"stageArn": "arn:aws:ivs:us-west-2:123456789012:stage/abcdABCDefgh",
"participnatId": "abC789Xyz456",
"state": "INACTIVE"
"userId": "",
}
]
}
```
Consulte mais informações em [Ingestão de streams do IVS \$1 Streaming em tempo real](https://docs.aws.amazon.com/ivs/latest/RealTimeUserGuide/rt-stream-ingest.html) no *Guia do usuário do Amazon Interactive Video Service*.
+ Para obter detalhes da API, consulte [ListIngestConfigurations](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ivs-realtime/list-ingest-configurations.html)em *Referência de AWS CLI Comandos*.
### `list-participant-events`
O código de exemplo a seguir mostra como usar `list-participant-events`.
**AWS CLI**
**Exemplo 1: obter uma lista de eventos de participantes do palco**
O exemplo `list-participant-events` a seguir lista todos os eventos de participantes para um ID de participante e ID de sessão especificados no ARN (Amazon Resource Name) especificado do estágio.
```
aws ivs-realtime list-participant-events \
--stage-arn arn:aws:ivs:us-west-2:123456789012:stage/abcdABCDefgh \
--session-id st-a1b2c3d4e5f6g \
--participant-id abCDEf12GHIj
```
Saída:
```
{
"events": [
{
"eventTime": "2023-04-26T20:36:28+00:00",
"name": "LEFT",
"participantId": "abCDEf12GHIj"
},
{
"eventTime": "2023-04-26T20:36:28+00:00",
"name": "PUBLISH_STOPPED",
"participantId": "abCDEf12GHIj"
},
{
"eventTime": "2023-04-26T20:30:34+00:00",
"name": "JOINED",
"participantId": "abCDEf12GHIj"
},
{
"eventTime": "2023-04-26T20:30:34+00:00",
"name": "PUBLISH_STARTED",
"participantId": "abCDEf12GHIj"
}
]
}
```
Para ter mais informações, consulte [Habilitação de vários hosts em uma transmissão do Amazon IVS](https://docs.aws.amazon.com/ivs/latest/LowLatencyUserGuide/multiple-hosts.html) no *Guia do usuário do streaming de baixa latência do Amazon IVS*.
**Exemplo 2: obter uma lista de eventos de participantes do palco, bem como interromper e iniciar a replicação de participantes**
O exemplo `list-participant-events` a seguir lista todos os eventos de participantes para um ID de sessão especificado do nome do recurso da Amazon (ARN) especificado do palco, em que um participante é replicado para outro palco.
```
aws ivs-realtime list-participant-events \
--stage-arn arn:aws:ivs:us-west-2:123456789012:stage/abcdABCDefgh \
--session-id st-a1b2c3d4e5f6g \
--participant-id abCDEf12GHIj
```
Saída:
```
{
"events": [
{
"eventTime": "2025-04-26T20:36:28+00:00",
"name": "LEFT",
"participantId": "abCDEf12GHIj"
},
{
"eventTime": "2025-04-26T20:36:28+00:00",
"name": "PUBLISH_STOPPED",
"participantId": "abCDEf12GHIj"
},
{
"eventTime": "2025-04-26T20:30:34+00:00",
"name": "JOINED",
"participantId": "abCDEf12GHIj"
},
{
"eventTime": "2025-04-26T20:30:34+00:00",
"name": "PUBLISH_STARTED",
"participantId": "abCDEf12GHIj"
},
{
"name": "REPLICATION_STARTED",
"participantId": "abCDEf12GHIj",
"eventTime": "2025-04-26T20:30:34+00:00",
"destinationStageArn": "arn:aws:ivs:us-west-2:12345678901:stage/ABCDabcdefgh",
"destinationSessionId": "st-b1c2d3e4f5g6a"
},
{
"name": "REPLICATION_STOPPED",
"participantId": "abCDEf12GHIj",
"eventTime": "2025-04-26T20:32:34+00:00",
"destinationStageArn": "arn:aws:ivs:us-west-2:12345678901:stage/ABCDabcdefgh",
"destinationSessionId": "st-b1c2d3e4f5g6a"
}
]
}
```
Para ter mais informações, consulte [Habilitação de vários hosts em uma transmissão do Amazon IVS](https://docs.aws.amazon.com/ivs/latest/LowLatencyUserGuide/multiple-hosts.html) no *Guia do usuário do streaming de baixa latência do Amazon IVS*.
+ Para obter detalhes da API, consulte [ListParticipantEvents](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ivs-realtime/list-participant-events.html)em *Referência de AWS CLI Comandos*.
### `list-participant-replicas`
O código de exemplo a seguir mostra como usar `list-participant-replicas`.
**AWS CLI**
**Como obter uma lista de réplicas de participantes do palco**
O exemplo `list-participant-replicas` a seguir lista todos os participantes do palco replicados do nome do recurso da Amazon (ARN) do palco de origem especificado para outro palco.
```
aws ivs-realtime list-participant-replicas \
--source-stage-arn arn:aws:ivs:us-west-2:123456789012:stage/abcdABCDefgh \
--participant-id abCDEf12GHIj
```
Saída:
```
{
"replicas": [
{
"sourceStageArn": "arn:aws:ivs:us-west-2:123456789012:stage/abcdABCDefgh",
"participantId": "abCDEf12GHIj",
"sourceSessionId": "st-a1b2c3d4e5f6g",
"destinationStageArn": "arn:aws:ivs:us-west-2:012345678901:stage/ABCDabcdefgh",
"destinationSessionId": "st-b1c2d3e4f5g6a",
"replicationState": "ACTIVE"
}
]
}
```
Para ter mais informações, consulte [Replicação de participantes do IVS](https://docs.aws.amazon.com/ivs/latest/RealTimeUserGuide/rt-participant-replication.html) no *Guia do usuário do streaming em tempo real do Amazon IVS*.
+ Para obter detalhes da API, consulte [ListParticipantReplicas](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ivs-realtime/list-participant-replicas.html)em *Referência de AWS CLI Comandos*.
### `list-participants`
O código de exemplo a seguir mostra como usar `list-participants`.
**AWS CLI**
**Exemplo 1: obter uma lista de participantes do palco**
O exemplo `list-participants` a seguir lista todos os participantes para um ID de sessão especificado no ARN (Amazon Resource Name) do palco especificado.
```
aws ivs-realtime list-participants \
--stage-arn arn:aws:ivs:us-west-2:123456789012:stage/abcdABCDefgh \
--session-id st-a1b2c3d4e5f6g
```
Saída:
```
{
"participants": [
{
"firstJoinTime": "2023-04-26T20:30:34+00:00",
"participantId": "abCDEf12GHIj",
"published": true,
"recordingState": "STOPPED",
"state": "DISCONNECTED",
"userId": ""
}
]
}
```
Para ter mais informações, consulte [Habilitação de vários hosts em uma transmissão do Amazon IVS](https://docs.aws.amazon.com/ivs/latest/LowLatencyUserGuide/multiple-hosts.html) no *Guia do usuário do streaming de baixa latência do Amazon IVS*.
**Exemplo 2: obter uma lista de participantes do palco, quando um participante foi replicado para outro palco**
O exemplo `list-participants` a seguir lista todos os participantes para um ID de sessão especificado de um nome do recurso da Amazon (ARN), quando um participante foi replicado para outro palco.
```
aws ivs-realtime list-participants \
--stage-arn arn:aws:ivs:us-west-2:123456789012:stage/abcdABCDefgh \
--session-id st-a1b2c3d4e5f6g
```
Saída:
```
{
"participants": [
{
"firstJoinTime": "2023-04-26T20:30:34+00:00",
"participantId": "abCDEf12GHIj",
"published": true,
"recordingState": "STOPPED",
"state": "DISCONNECTED",
"userId": "",
"replicationState": "ACTIVE",
"replicationType": "SOURCE",
"sourceStageArn": "",
"sourceSessionId": ""
}
]
}
```
Para ter mais informações, consulte [Habilitação de vários hosts em uma transmissão do Amazon IVS](https://docs.aws.amazon.com/ivs/latest/LowLatencyUserGuide/multiple-hosts.html) no *Guia do usuário do streaming de baixa latência do Amazon IVS*.
**Exemplo 3: obter uma lista de participantes do palco, quando um participante foi replicado de outro palco**
O exemplo `list-participants` a seguir lista todos os participantes para um ID de sessão especificado de um nome do recurso da Amazon (ARN), quando um participante foi replicado de outro palco.
```
aws ivs-realtime list-participants \
--stage-arn arn:aws:ivs:us-west-2:123456789012:stage/abcdABCDefgh \
--session-id st-a1b2c3d4e5f6g
```
Saída:
```
{
"participants": [
{
"firstJoinTime": "2023-04-26T20:30:34+00:00",
"participantId": "abCDEf12GHIj",
"published": true,
"recordingState": "STOPPED",
"state": "DISCONNECTED",
"userId": "",
"replicationState": "ACTIVE",
"replicationType": "REPLICA",
"sourceStageArn": "arn:aws:ivs:us-west-2:123456789012:stage/abcdABCDefgh",
"sourceSessionId": "st-a1b2c3d4e5f6g"
}
]
}
```
Para ter mais informações, consulte [Habilitação de vários hosts em uma transmissão do Amazon IVS](https://docs.aws.amazon.com/ivs/latest/LowLatencyUserGuide/multiple-hosts.html) no *Guia do usuário do streaming de baixa latência do Amazon IVS*.
+ Para obter detalhes da API, consulte [ListParticipants](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ivs-realtime/list-participants.html)em *Referência de AWS CLI Comandos*.
### `list-public-keys`
O código de exemplo a seguir mostra como usar `list-public-keys`.
**AWS CLI**
**Para listar chaves públicas existentes disponíveis para assinar tokens de participantes do palco**
O `list-public-keys` exemplo a seguir lista todas as chaves públicas disponíveis para os tokens dos participantes da fase de login, na AWS região em que a solicitação da API é processada.
```
aws ivs-realtime list-public-keys
```
Saída:
```
{
"publicKeys": [
{
"arn": "arn:aws:ivs:us-west-2:123456789012:public-key/abcdABC1efg2",
"name": "",
"tags": {}
},
{
"arn": "arn:aws:ivs:us-west-2:123456789012:public-key/3bcdABCDefg4",
"name": "",
"tags": {}
}
]
}
```
Para obter mais informações, consulte [Distribuir tokens de participantes](https://docs.aws.amazon.com/ivs/latest/RealTimeUserGuide/getting-started-distribute-tokens.html) no *Guia do usuário de streaming em tempo real do Amazon IVS*.
+ Para obter detalhes da API, consulte [ListPublicKeys](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ivs-realtime/list-public-keys.html)em *Referência de AWS CLI Comandos*.
### `list-stage-sessions`
O código de exemplo a seguir mostra como usar `list-stage-sessions`.
**AWS CLI**
**Para obter uma lista das sessões de palco**
O exemplo `list-stage-sessions` a seguir lista todas as sessões para o ARN (Amazon Resource Name) do palco especificado.
```
aws ivs-realtime list-stage-sessions \
--stage-arn arn:aws:ivs:us-west-2:123456789012:stage/abcdABCDefgh
```
Saída:
```
{
"stageSessions": [
{
"endTime": "2023-04-26T20:36:29+00:00",
"sessionId": "st-a1b2c3d4e5f6g",
"startTime": "2023-04-26T20:30:29.602000+00:00"
}
]
}
```
Para obter mais informações, consulte [Habilitar vários hosts em um stream do Amazon IVS](https://docs.aws.amazon.com/ivs/latest/userguide/multiple-hosts.html) e *Service Quotas do Amazon IVS*.
+ Para obter detalhes da API, consulte [ListStageSessions](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ivs-realtime/list-stage-sessions.html)em *Referência de AWS CLI Comandos*.
### `list-stages`
O código de exemplo a seguir mostra como usar `list-stages`.
**AWS CLI**
**Para obter informações resumidas sobre todos os palcos**
O `list-stages` exemplo a seguir lista todos os estágios AWS da sua conta, na AWS região em que a solicitação da API é processada.
```
aws ivs-realtime list-stages
```
Saída:
```
{
"stages": [
{
"activeSessionId": "st-a1b2c3d4e5f6g",
"arn": "arn:aws:ivs:us-west-2:123456789012:stage/abcdABCDefgh",
"name": "stage1",
"tags": {}
},
{
"activeSessionId": "st-a123bcd456efg",
"arn": "arn:aws:ivs:us-west-2:123456789012:stage/abcd1234ABCD",
"name": "stage2",
"tags": {}
},
{
"activeSessionId": "st-abcDEF1234ghi",
"arn": "arn:aws:ivs:us-west-2:123456789012:stage/ABCD1234efgh",
"name": "stage3",
"tags": {}
}
]
}
```
Para obter mais informações, consulte [Habilitar vários hosts em um stream do Amazon IVS](https://docs.aws.amazon.com/ivs/latest/LowLatencyUserGuide/multiple-hosts.html) e *Service Quotas do Amazon IVS*.
+ Para obter detalhes da API, consulte [ListStages](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ivs-realtime/list-stages.html)em *Referência de AWS CLI Comandos*.
### `list-storage-configurations`
O código de exemplo a seguir mostra como usar `list-storage-configurations`.
**AWS CLI**
**Para listar as configurações de armazenamento de composição**
A seguir, `list-storage-configurations` listamos todas as configurações de armazenamento de composição AWS da sua conta, na AWS região em que a solicitação da API é processada.
```
aws ivs-realtime list-storage-configurations
```
Saída:
```
{
"storageConfigurations": [
{
"arn": "arn:aws:ivs:ap-northeast-1:123456789012:storage-configuration/abcdABCDefgh",
"name": "test-sc-1",
"s3": {
"bucketName": "amzn-s3-demo-bucket-1"
},
"tags": {}
},
{
"arn": "arn:aws:ivs:ap-northeast-1:123456789012:storage-configuration/ABCefgEFGabc",
"name": "test-sc-2",
"s3": {
"bucketName": "amzn-s3-demo-bucket-2"
},
"tags": {}
}
]
}
```
Para obter mais informações, consulte [Habilitar vários hosts em um stream do Amazon IVS](https://docs.aws.amazon.com/ivs/latest/LowLatencyUserGuide/multiple-hosts.html) e *Service Quotas do Amazon IVS*.
+ Para obter detalhes da API, consulte [ListStorageConfigurations](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ivs-realtime/list-storage-configurations.html)em *Referência de AWS CLI Comandos*.
### `start-composition`
O código de exemplo a seguir mostra como usar `start-composition`.
**AWS CLI**
**Exemplo 1: iniciar uma composição com configurações de layout padrão**
O exemplo `start-composition` a seguir inicia uma composição para o palco especificado a ser transmitida para os locais especificados.
```
aws ivs-realtime start-composition \
--stage-arn arn:aws:ivs:ap-northeast-1:123456789012:stage/defgABCDabcd \
--destinations '[{"channel": {"channelArn": "arn:aws:ivs:ap-northeast-1:123456789012:channel/abcABCdefDEg", \
"encoderConfigurationArn": "arn:aws:ivs:ap-northeast-1:123456789012:encoder-configuration/ABabCDcdEFef"}}, \
{"s3":{"encoderConfigurationArns":["arn:aws:ivs:ap-northeast-1:123456789012:encoder-configuration/ABabCDcdEFef"], \
"recordingConfiguration": {"hlsConfiguration": {"targetSegmentDurationSeconds": 5}}, \
"storageConfigurationArn":"arn:aws:ivs:ap-northeast-1:123456789012:storage-configuration/FefABabCDcdE"}}]'
```
Saída:
```
{
"composition": {
"arn": "arn:aws:ivs:ap-northeast-1:123456789012:composition/abcdABCDefgh",
"destinations": [
{
"configuration": {
"channel": {
"channelArn": "arn:aws:ivs:ap-northeast-1:123456789012:channel/abcABCdefDEg",
"encoderConfigurationArn": "arn:aws:ivs:ap-northeast-1:123456789012:encoder-configuration/ABabCDcdEFef"
},
"name": ""
},
"id": "AabBCcdDEefF",
"state": "STARTING"
},
{
"configuration": {
"name": "",
"s3": {
"encoderConfigurationArns": [
"arn:aws:ivs:arn:aws:ivs:ap-northeast-1:123456789012:encoder-configuration/ABabCDcdEFef"
],
"recordingConfiguration": {
"format": "HLS",
"hlsConfiguration": {
"targetSegmentDurationSeconds": 5
}
},
"storageConfigurationArn": "arn:arn:aws:ivs:ap-northeast-1:123456789012:storage-configuration/FefABabCDcdE"
}
},
"detail": {
"s3": {
"recordingPrefix": "aBcDeFgHhGfE/AbCdEfGhHgFe/GHFabcgefABC/composite"
}
},
"id": "GHFabcgefABC",
"state": "STARTING"
}
],
"layout": {
"grid": {
"featuredParticipantAttribute": ""
"gridGap": 2,
"omitStoppedVideo": false,
"participantOrderAttribute": "",
"videoAspectRatio": "VIDEO",
"videoFillMode": ""
}
},
"stageArn": "arn:aws:ivs:ap-northeast-1:123456789012:stage/defgABCDabcd",
"startTime": "2023-10-16T23:24:00+00:00",
"state": "STARTING",
"tags": {}
}
}
```
Para ter mais informações, consulte [Gravação composta do IVS \$1 Streaming em tempo real](https://docs.aws.amazon.com/ivs/latest/RealTimeUserGuide/rt-composite-recording.html) no *Guia do usuário do Amazon Interactive Video Service*.
**Exemplo 2: iniciar uma composição com layout PiP**
O exemplo `start-composition` a seguir inicia uma composição para o palco especificado a ser transmitida para os locais especificados usando o layout PiP.
```
aws ivs-realtime start-composition \
--stage-arn arn:aws:ivs:ap-northeast-1:123456789012:stage/defgABCDabcd \
--destinations '[{"channel": {"channelArn": "arn:aws:ivs:ap-northeast-1:123456789012:channel/abcABCdefDEg", \
"encoderConfigurationArn": "arn:aws:ivs:ap-northeast-1:123456789012:encoder-configuration/ABabCDcdEFef"}}, \
{"s3":{"encoderConfigurationArns":["arn:aws:ivs:ap-northeast-1:123456789012:encoder-configuration/ABabCDcdEFef"], \
"storageConfigurationArn":"arn:aws:ivs:ap-northeast-1:123456789012:storage-configuration/FefABabCDcdE"}}]' \
--layout pip='{featuredParticipantAttribute="abcdefg"}'
```
Saída:
```
{
"composition": {
"arn": "arn:aws:ivs:ap-northeast-1:123456789012:composition/wxyzWXYZpqrs",
"destinations": [
{
"configuration": {
"channel": {
"channelArn": "arn:aws:ivs:ap-northeast-1:123456789012:channel/abcABCdefDEg",
"encoderConfigurationArn": "arn:aws:ivs:ap-northeast-1:123456789012:encoder-configuration/ABabCDcdEFef"
},
"name": ""
},
"id": "AabBCcdDEefF",
"state": "STARTING"
},
{
"configuration": {
"name": "",
"s3": {
"encoderConfigurationArns": [
"arn:aws:ivs:arn:aws:ivs:ap-northeast-1:123456789012:encoder-configuration/ABabCDcdEFef"
],
"recordingConfiguration": {
"format": "HLS",
"hlsConfiguration": {
"targetSegmentDurationSeconds": 2
}
},
"storageConfigurationArn": "arn:arn:aws:ivs:ap-northeast-1:123456789012:storage-configuration/FefABabCDcdE"
}
},
"detail": {
"s3": {
"recordingPrefix": "aBcDeFgHhGfE/AbCdEfGhHgFe/GHFabcgefABC/composite"
}
},
"id": "GHFabcgefABC",
"state": "STARTING"
}
],
"layout": {
"pip": {
"featuredParticipantAttribute": "abcdefg",
"gridGap": 0,
"omitStoppedVideo": false,
"participantOrderAttribute": "",
"pipBehavior": "STATIC",
"pipOffset": 0,
"pipParticipantAttribute": "",
"pipPosition": "BOTTOM_RIGHT",
"videoFillMode": "COVER"
}
},
"stageArn": "arn:aws:ivs:ap-northeast-1:123456789012:stage/defgABCDabcd",
"startTime": "2023-10-16T23:24:00+00:00",
"state": "STARTING",
"tags": {}
}
}
```
Para ter mais informações, consulte [Gravação composta do IVS \$1 Streaming em tempo real](https://docs.aws.amazon.com/ivs/latest/RealTimeUserGuide/rt-composite-recording.html) no *Guia do usuário do Amazon Interactive Video Service*.
**Exemplo 3: como iniciar uma composição com a gravação de miniatura habilitada**
O exemplo de `start-composition` a seguir inicia uma composição para o estágio especificado a ser transmitida para os locais especificados com a gravação de miniatura habilitada.
```
aws ivs-realtime start-composition \
--stage-arn arn:aws:ivs:ap-northeast-1:123456789012:stage/defgABCDabcd \
--destinations '[{"channel": {"channelArn": "arn:aws:ivs:ap-northeast-1:123456789012:channel/abcABCdefDEg", \
"encoderConfigurationArn": "arn:aws:ivs:ap-northeast-1:123456789012:encoder-configuration/ABabCDcdEFef"}}, \
{"s3": {"encoderConfigurationArns": ["arn:aws:ivs:ap-northeast-1:123456789012:encoder-configuration/ABabCDcdEFef"], \
"storageConfigurationArn": "arn:aws:ivs:ap-northeast-1:123456789012:storage-configuration/FefABabCDcdE", \
"thumbnailConfigurations": [{"storage": ["SEQUENTIAL"],"targetIntervalSeconds": 60}]}}]'
```
Saída:
```
{
"composition": {
"arn": "arn:aws:ivs:ap-northeast-1:123456789012:composition/abcdABCDefgh",
"destinations": [
{
"configuration": {
"channel": {
"channelArn": "arn:aws:ivs:ap-northeast-1:123456789012:channel/abcABCdefDEg",
"encoderConfigurationArn": "arn:aws:ivs:ap-northeast-1:123456789012:encoder-configuration/ABabCDcdEFef"
},
"name": ""
},
"id": "AabBCcdDEefF",
"state": "STARTING"
},
{
"configuration": {
"name": "",
"s3": {
"encoderConfigurationArns": [
"arn:aws:ivs:arn:aws:ivs:ap-northeast-1:123456789012:encoder-configuration/ABabCDcdEFef"
],
"recordingConfiguration": {
"format": "HLS",
"hlsConfiguration": {
"targetSegmentDurationSeconds": 2
}
},
"storageConfigurationArn": "arn:arn:aws:ivs:ap-northeast-1:123456789012:storage-configuration/FefABabCDcdE",
"thumbnailConfigurations": [
{
"targetIntervalSeconds": 60,
"storage": [
"SEQUENTIAL"
]
}
]
}
},
"detail": {
"s3": {
"recordingPrefix": "aBcDeFgHhGfE/AbCdEfGhHgFe/GHFabcgefABC/composite"
}
},
"id": "GHFabcgefABC",
"state": "STARTING"
}
],
"layout": {
"grid": {
"featuredParticipantAttribute": ""
"gridGap": 2,
"omitStoppedVideo": false,
"participantOrderAttribute": "",
"videoAspectRatio": "VIDEO",
"videoFillMode": ""
}
},
"stageArn": "arn:aws:ivs:ap-northeast-1:123456789012:stage/defgABCDabcd",
"startTime": "2023-10-16T23:24:00+00:00",
"state": "STARTING",
"tags": {}
}
}
```
Para obter mais informações, consulte [Gravação composta (streaming em tempo real)](https://docs.aws.amazon.com/ivs/latest/RealTimeUserGuide/rt-composite-recording.html) no *Guia do usuário do Amazon Interactive Video Service*.
**Exemplo 4: iniciar uma composição usando o layout de grade com a ordenação personalizada dos participantes**
O exemplo de `start-composition` a seguir inicia uma composição para o palco especificado a ser transmitida para os locais especificados usando o layout de grade com ordenação personalizada dos participantes.
```
aws ivs-realtime start-composition \
--stage-arn arn:aws:ivs:ap-northeast-1:123456789012:stage/defgABCDabcd \
--destinations '[{"channel": {"channelArn": "arn:aws:ivs:ap-northeast-1:123456789012:channel/abcABCdefDEg", \
"encoderConfigurationArn": "arn:aws:ivs:ap-northeast-1:123456789012:encoder-configuration/ABabCDcdEFef"}}, \
{"s3": {"encoderConfigurationArns": ["arn:aws:ivs:ap-northeast-1:123456789012:encoder-configuration/ABabCDcdEFef"], \
"storageConfigurationArn": "arn:aws:ivs:ap-northeast-1:123456789012:storage-configuration/FefABabCDcdE", \
"thumbnailConfigurations": [{"storage": ["SEQUENTIAL"],"targetIntervalSeconds": 60}]}}]' \
--layout grid='{participantOrderAttribute="abcdefg"}'
```
Saída:
```
{
"composition": {
"arn": "arn:aws:ivs:ap-northeast-1:123456789012:composition/abcdABCDefgh",
"destinations": [
{
"configuration": {
"channel": {
"channelArn": "arn:aws:ivs:ap-northeast-1:123456789012:channel/abcABCdefDEg",
"encoderConfigurationArn": "arn:aws:ivs:ap-northeast-1:123456789012:encoder-configuration/ABabCDcdEFef"
},
"name": ""
},
"id": "AabBCcdDEefF",
"state": "STARTING"
},
{
"configuration": {
"name": "",
"s3": {
"encoderConfigurationArns": [
"arn:aws:ivs:arn:aws:ivs:ap-northeast-1:123456789012:encoder-configuration/ABabCDcdEFef"
],
"recordingConfiguration": {
"format": "HLS",
"hlsConfiguration": {
"targetSegmentDurationSeconds": 2
}
},
"storageConfigurationArn": "arn:arn:aws:ivs:ap-northeast-1:123456789012:storage-configuration/FefABabCDcdE",
"thumbnailConfigurations": [
{
"targetIntervalSeconds": 60,
"storage": [
"SEQUENTIAL"
]
}
]
}
},
"detail": {
"s3": {
"recordingPrefix": "aBcDeFgHhGfE/AbCdEfGhHgFe/GHFabcgefABC/composite"
}
},
"id": "GHFabcgefABC",
"state": "STARTING"
}
],
"layout": {
"grid": {
"featuredParticipantAttribute": ""
"gridGap": 2,
"omitStoppedVideo": false,
"participantOrderAttribute": "abcdefg",
"videoAspectRatio": "VIDEO",
"videoFillMode": ""
}
},
"stageArn": "arn:aws:ivs:ap-northeast-1:123456789012:stage/defgABCDabcd",
"startTime": "2023-10-16T23:24:00+00:00",
"state": "STARTING",
"tags": {}
}
}
```
Para ter mais informações, consulte [Gravação composta do IVS \$1 Streaming em tempo real](https://docs.aws.amazon.com/ivs/latest/RealTimeUserGuide/rt-composite-recording.html) no *Guia do usuário do Amazon Interactive Video Service*.
+ Para obter detalhes da API, consulte [StartComposition](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ivs-realtime/start-composition.html)em *Referência de AWS CLI Comandos*.
### `start-participant-replication`
O código de exemplo a seguir mostra como usar `start-participant-replication`.
**AWS CLI**
**Como iniciar a replicação de um participante de um palco para outro**
O exemplo `start-participant-replication` a seguir replica um participante de um palco de origem para um palco de destino e cada palco é especificado pelo nome do recurso da Amazon (ARN) correspondente.
```
aws ivs-realtime start-participant-replication \
--source-stage-arn arn:aws:ivs:us-west-2:123456789012:stage/abcdABCDefgh \
--destination-stage-arn arn:aws:ivs:us-west-2:234567890123:stage/bcdABCDefghi \
--participant-id abCDEf12GHIj
```
Saída:
```
{
"accessControlAllowOrigin": "*",
"accessControlExposeHeaders": "Access-Control-Allow-Origin,Access-Control-Expose-Headers,Cache-Control,Content-Length, \
Content-Security-Policy,Content-Type,date,Strict-Transport-Security,x-amz-apigw-id,x-amzn-errormessage,x-amzn-errortype, \
x-amzn-requestid,x-amzn-trace-id,X-Content-Type-Options,X-Frame-Options",
"cacheControl": "no-store, no-cache",
"contentSecurityPolicy": "default-src 'self'; upgrade-insecure-requests;",
"strictTransportSecurity": "max-age:47304000; includeSubDomains",
"xContentTypeOptions": "nosniff",
"xFrameOptions": "DENY"
}
```
Para ter mais informações, consulte [Replicação de participantes do IVS](https://docs.aws.amazon.com/ivs/latest/RealTimeUserGuide/rt-participant-replication.html) no *Guia do usuário do streaming em tempo real do Amazon IVS*.
+ Para obter detalhes da API, consulte [StartParticipantReplication](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ivs-realtime/start-participant-replication.html)em *Referência de AWS CLI Comandos*.
### `stop-composition`
O código de exemplo a seguir mostra como usar `stop-composition`.
**AWS CLI**
**Como parar uma composição**
O seguinte `stop-composition` interrompe a composição especificada pelo ARN (Amazon Resource Name) fornecido.
```
aws ivs-realtime stop-composition \
--arn "arn:aws:ivs:ap-northeast-1:123456789012:composition/abcdABCDefgh"
```
Este comando não produz saída.
Para obter mais informações, consulte [Habilitar vários hosts em um stream do Amazon IVS](https://docs.aws.amazon.com/ivs/latest/LowLatencyUserGuide/multiple-hosts.html) e *Service Quotas do Amazon IVS*.
+ Para obter detalhes da API, consulte [StopComposition](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ivs-realtime/stop-composition.html)em *Referência de AWS CLI Comandos*.
### `stop-participant-replication`
O código de exemplo a seguir mostra como usar `stop-participant-replication`.
**AWS CLI**
**Como interromper a replicação de um participante de um palco para outro**
O exemplo `stop-participant-replication` a seguir interrompe a replicação de um participante de um palco de origem para um palco de destino e cada estágio é especificado pelo nome do recurso da Amazon (ARN) correspondente.
```
aws ivs-realtime stop-participant-replication \
--source-stage-arn arn:aws:ivs:us-west-2:123456789012:stage/abcdABCDefgh \
--destination-stage-arn arn:aws:ivs:us-west-2:234567890123:stage/bcdABCDefghi \
--participant-id abCDEf12GHIj
```
Saída:
```
{
"accessControlAllowOrigin": "*",
"accessControlExposeHeaders": "Access-Control-Allow-Origin,Access-Control-Expose-Headers,Cache-Control,Content-Length, \
Content-Security-Policy,Content-Type,date,Strict-Transport-Security,x-amz-apigw-id,x-amzn-errormessage,x-amzn-errortype, \
x-amzn-requestid,x-amzn-trace-id,X-Content-Type-Options,X-Frame-Options",
"cacheControl": "no-store, no-cache",
"contentSecurityPolicy": "default-src 'self'; upgrade-insecure-requests;",
"strictTransportSecurity": "max-age:47304000; includeSubDomains",
"xContentTypeOptions": "nosniff",
"xFrameOptions": "DENY"
}
```
Para ter mais informações, consulte [Replicação de participantes do IVS](https://docs.aws.amazon.com/ivs/latest/RealTimeUserGuide/rt-participant-replication.html) no *Guia do usuário do streaming em tempo real do Amazon IVS*.
+ Para obter detalhes da API, consulte [StopParticipantReplication](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ivs-realtime/stop-participant-replication.html)em *Referência de AWS CLI Comandos*.
### `update-ingest-configuration`
O código de exemplo a seguir mostra como usar `update-ingest-configuration`.
**AWS CLI**
**Como atualizar uma configuração de ingestão**
O exemplo de `update-inegst-configuration` a seguir atualiza uma configuração de ingestão para anexá-la a um estágio.
```
aws ivs-realtime update-ingest-configuration \
--arn arn:aws:ivs:us-west-2:123456789012:ingest-configuration/AbCdEfGh1234 \
--stage-arn arn:aws:ivs:us-west-2:123456789012:stage/abcdABCDefgh
```
Saída:
```
{
"ingestConfiguration": {
"name": "ingest1",
"arn": "arn:aws:ivs:us-west-2:123456789012:ingest-configuration/AbCdEfGh1234",
"ingestProtocol": "RTMPS",
"streamKey": "rt_123456789012_us-west-2_AbCdEfGh1234_abcd1234efgh5678ijkl9012MNOP34",
"stageArn": "arn:aws:ivs:us-west-2:123456789012:stage/abcdABCDefgh",
"participantId": "xyZ654abC321",
"state": "INACTIVE",
"userId": "",
"tags": {}
}
}
```
Consulte mais informações em [Ingestão de streams do IVS \$1 Streaming em tempo real](https://docs.aws.amazon.com/ivs/latest/RealTimeUserGuide/rt-stream-ingest.html) no *Guia do usuário do Amazon Interactive Video Service*.
+ Para obter detalhes da API, consulte [UpdateIngestConfiguration](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ivs-realtime/update-ingest-configuration.html)em *Referência de AWS CLI Comandos*.
### `update-stage`
O código de exemplo a seguir mostra como usar `update-stage`.
**AWS CLI**
**Exemplo 1: atualizar a configuração de um palco**
O exemplo de `update-stage` a seguir atualiza um estágio para um ARN de estágio especificado para atualizar o nome do estágio e configurar a gravação individual de participantes com a gravação de miniatura habilitada.
```
aws ivs-realtime update-stage \
--arn arn:aws:ivs:us-west-2:123456789012:stage/abcdABCDefgh \
--auto-participant-recording-configuration '{"mediaTypes": ["AUDIO_VIDEO"],"storageConfigurationArn": "arn:aws:ivs:us-west-2:123456789012:storage-configuration/abcdABCDefgh", "recordingReconnectWindowSeconds": 100, \
"thumbnailConfiguration": {"recordingMode": "INTERVAL","storage": ["SEQUENTIAL"],"targetIntervalSeconds": 60}} \
"hlsConfiguration": {"targetSegmentDurationSeconds": 5}}' \
--name stage1a
```
Saída:
```
{
"stage": {
"arn": "arn:aws:ivs:us-west-2:123456789012:stage/abcdABCDefgh",
"autoParticipantRecordingConfiguration": {
"mediaTypes": [
"AUDIO_VIDEO"
],
"storageConfigurationArn": "arn:aws:ivs:us-west-2:123456789012:storage-configuration/abcdABCDefgh",
"thumbnailConfiguration": {
"targetIntervalSeconds": 60,
"storage": [
"SEQUENTIAL"
],
"recordingMode": "INTERVAL"
},
"recordingReconnectWindowSeconds": 100,
"hlsConfiguration": {
"targetSegmentDurationSeconds": 5
},
"recordParticipantReplicas": true
},
"endpoints": {
"events": "wss://global.events.live-video.net",
"rtmp": "rtmp://9x0y8z7s6t5u.global-contribute-staging.live-video.net/app/",
"rtmps": "rtmps://9x0y8z7s6t5u.global-contribute-staging.live-video.net:443/app/",
"whip": "https://1a2b3c4d5e6f.global-bm.whip.live-video.net"
},
"name": "stage1a",
"tags": {}
}
}
```
Para ter mais informações, consulte [Habilitação de vários hosts em uma transmissão do Amazon IVS](https://docs.aws.amazon.com/ivs/latest/LowLatencyUserGuide/multiple-hosts.html) no *Guia do usuário do streaming de baixa latência do Amazon IVS*.
**Exemplo 2: atualizar a configuração de um palco, bem como desabilitar a gravação de réplicas de participantes**
O exemplo `update-stage` a seguir atualiza um palco para um ARN de palco especificado a fim de atualizar o nome do palco e configurar a gravação de participantes individuais com a gravação de miniatura habilitada e a gravação de réplicas de participantes desabilitada.
```
aws ivs-realtime update-stage \
--arn arn:aws:ivs:us-west-2:123456789012:stage/abcdABCDefgh \
--auto-participant-recording-configuration '{"mediaTypes": ["AUDIO_VIDEO"],"storageConfigurationArn": "arn:aws:ivs:us-west-2:123456789012:storage-configuration/abcdABCDefgh", "recordingReconnectWindowSeconds": 100, \
"thumbnailConfiguration": {"recordingMode": "INTERVAL","storage": ["SEQUENTIAL"],"targetIntervalSeconds": 60}, "recordParticipantReplicas":false} \
"hlsConfiguration": {"targetSegmentDurationSeconds": 5}}' \
--name stage1a
```
Saída:
```
{
"stage": {
"arn": "arn:aws:ivs:us-west-2:123456789012:stage/abcdABCDefgh",
"autoParticipantRecordingConfiguration": {
"mediaTypes": [
"AUDIO_VIDEO"
],
"storageConfigurationArn": "arn:aws:ivs:us-west-2:123456789012:storage-configuration/abcdABCDefgh",
"thumbnailConfiguration": {
"targetIntervalSeconds": 60,
"storage": [
"SEQUENTIAL"
],
"recordingMode": "INTERVAL"
},
"recordingReconnectWindowSeconds": 100,
"hlsConfiguration": {
"targetSegmentDurationSeconds": 5
},
"recordParticipantReplicas": false
},
"endpoints": {
"events": "wss://global.events.live-video.net",
"rtmp": "rtmp://9x0y8z7s6t5u.global-contribute-staging.live-video.net/app/",
"rtmps": "rtmps://9x0y8z7s6t5u.global-contribute-staging.live-video.net:443/app/",
"whip": "https://1a2b3c4d5e6f.global-bm.whip.live-video.net"
},
"name": "stage1a",
"tags": {}
}
}
```
Para ter mais informações, consulte [Habilitação de vários hosts em uma transmissão do Amazon IVS](https://docs.aws.amazon.com/ivs/latest/LowLatencyUserGuide/multiple-hosts.html) no *Guia do usuário do streaming de baixa latência do Amazon IVS*.
+ Para obter detalhes da API, consulte [UpdateStage](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ivs-realtime/update-stage.html)em *Referência de AWS CLI Comandos*.