# Ejemplos de Transmisión en tiempo real de Amazon IVS que utilizan la AWS CLI
En los siguientes ejemplos de código se muestra cómo realizar acciones e implementar escenarios comunes usando AWS Command Line Interface con Transmisión en tiempo real de Amazon IVS.
Las *acciones* son extractos de código de programas más grandes y deben ejecutarse en contexto. Mientras las acciones muestran cómo llamar a las distintas funciones de servicio, es posible ver las acciones en contexto en los escenarios relacionados.
En cada ejemplo se incluye un enlace al código de origen completo, con instrucciones de configuración y ejecución del código en el contexto.
**Topics**
+ [Acciones](#actions)
## Acciones
### `create-encoder-configuration`
En el siguiente ejemplo de código, se muestra cómo utilizar `create-encoder-configuration`.
**AWS CLI**
**Para crear una configuración de codificador de composición**
En el siguiente ejemplo de `create-encoder-configuration`, se crea una configuración de codificador de composición con las propiedades especificadas.
```
aws ivs-realtime create-encoder-configuration \
--name test-ec --video bitrate=3500000,framerate=30.0,height=1080,width=1920
```
Salida:
```
{
"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 obtener más información, consulte [Habilitación de varios hosts en una transmisión de Amazon IVS](https://docs.aws.amazon.com/ivs/latest/LowLatencyUserGuide/multiple-hosts.html) en la *Guía del usuario de Amazon IVS*.
+ Para obtener información sobre la API, consulte [CreateEncoderConfiguration](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ivs-realtime/create-encoder-configuration.html) en la *Referencia de comandos de la AWS CLI*.
### `create-ingest-configuration`
En el siguiente ejemplo de código, se muestra cómo utilizar `create-ingest-configuration`.
**AWS CLI**
**Creación de una configuración de ingesta**
En el siguiente ejemplo de `create-ingest-configuration`, se crea una configuración de ingesta mediante el protocolo RTMPS.
```
aws ivs-realtime create-ingest-configuration \
--name ingest1 \
--ingest-protocol rtmps
```
Salida:
```
{
"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": {}
}
}
```
Para obtener más información, consulte [Ingesta de transmisiones de IVS \$1 Transmisión en tiempo real](https://docs.aws.amazon.com/ivs/latest/RealTimeUserGuide/rt-stream-ingest.html) en la *Guía del usuario de Servicio de vídeos interactivos de Amazon*.
+ Para obtener información sobre la API, consulte [CreateIngestConfiguration](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ivs-realtime/create-ingest-configuration.html) en la *Referencia de comandos de la AWS CLI*.
### `create-participant-token`
En el siguiente ejemplo de código, se muestra cómo utilizar `create-participant-token`.
**AWS CLI**
**Para crear un token de participante de la fase**
En el siguiente ejemplo de `create-participant-token`, se crea un token de participante para la etapa especificada.
```
aws ivs-realtime create-participant-token \
--stage-arn arn:aws:ivs:us-west-2:123456789012:stage/abcdABCDefgh \
--user-id bob
```
Salida:
```
{
"participantToken": {
"expirationTime": "2023-03-07T09:47:43+00:00",
"participantId": "ABCDEfghij01234KLMN6789",
"token": "abcd1234defg5678"
}
}
```
Para obtener más información, consulte [Habilitación de varios hosts en una transmisión de Amazon IVS](https://docs.aws.amazon.com/ivs/latest/userguide/multiple-hosts.html) en la *Guía del usuario de Amazon IVS*.
+ Para obtener información sobre la API, consulte [CreateParticipantToken](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ivs-realtime/create-participant-token.html) en la *Referencia de comandos de la AWS CLI*.
### `create-stage`
En el siguiente ejemplo de código, se muestra cómo utilizar `create-stage`.
**AWS CLI**
**Ejemplo 1: crear un escenario**
En el siguiente ejemplo de `create-stage`, se crea un token de fase y un token de participante de la fase para un usuario especificado.
```
aws ivs-realtime create-stage \
--name stage1 \
--participant-token-configurations userId=alice
```
Salida:
```
{
"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 obtener más información, consulte [Habilitación de varios hosts en un flujo de Amazon IVS](https://docs.aws.amazon.com/ivs/latest/LowLatencyUserGuide/multiple-hosts.html) en la *Guía del usuario de Transmisión de baja latencia de Amazon IVS*.
**Ejemplo 2: Creación de una etapa y configuración de una grabación de participante individual**
En el siguiente ejemplo de `create-stage`, se crea una fase y se configura la grabación de cada participante individual.
```
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}}'
```
Salida:
```
{
"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 obtener más información, consulte [Habilitación de varios hosts en un flujo de Amazon IVS](https://docs.aws.amazon.com/ivs/latest/LowLatencyUserGuide/multiple-hosts.html) en la *Guía del usuario de Transmisión de baja latencia de Amazon IVS*.
**Ejemplo 3: Creación de una etapa y configuración de una grabación de participante individual con grabación de miniaturas habilitada**
En el siguiente ejemplo de `create-stage`, se crea una etapa y se configura la grabación de cada participante individual con grabación de miniaturas 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}}'
```
Salida:
```
{
"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 obtener más información, consulte [Habilitación de varios hosts en un flujo de Amazon IVS](https://docs.aws.amazon.com/ivs/latest/LowLatencyUserGuide/multiple-hosts.html) en la *Guía del usuario de Transmisión de baja latencia de Amazon IVS*.
+ Para obtener información sobre la API, consulte [CreateStage](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ivs-realtime/create-stage.html) en la *Referencia de comandos de la AWS CLI*.
### `create-storage-configuration`
En el siguiente ejemplo de código, se muestra cómo utilizar `create-storage-configuration`.
**AWS CLI**
**Para crear una configuración de almacenamiento de composición**
En el siguiente ejemplo de `create-storage-configuration`, se crea una configuración de almacenamiento de composición con las propiedades especificadas.
```
aws ivs-realtime create-storage-configuration \
--name "test-sc" --s3 "bucketName=amzn-s3-demo-bucket"
```
Salida:
```
{
"storageConfiguration": {
"arn": "arn:aws:ivs:ap-northeast-1:123456789012:storage-configuration/ABabCDcdEFef",
"name": "test-sc",
"s3": {
"bucketName": "amzn-s3-demo-bucket"
},
"tags": {}
}
}
```
Para obtener más información, consulte [Habilitación de varios hosts en una transmisión de Amazon IVS](https://docs.aws.amazon.com/ivs/latest/LowLatencyUserGuide/multiple-hosts.html) en la *Guía del usuario de Amazon IVS*.
+ Para obtener información sobre la API, consulte [CreateStorageConfiguration](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ivs-realtime/create-storage-configuration.html) en la *Referencia de comandos de la AWS CLI*.
### `delete-encoder-configuration`
En el siguiente ejemplo de código, se muestra cómo utilizar `delete-encoder-configuration`.
**AWS CLI**
**Para eliminar una configuración de codificador de composición**
En el siguiente ejemplo de `delete-encoder-configuration`, se elimina la configuración del codificador de composición especificada por el ARN (Nombre de recurso de Amazon) indicado.
```
aws ivs-realtime delete-encoder-configuration \
--arn "arn:aws:ivs:ap-northeast-1:123456789012:encoder-configuration/ABabCDcdEFef"
```
Este comando no genera ninguna salida.
Para obtener más información, consulte [Habilitación de varios hosts en una transmisión de Amazon IVS](https://docs.aws.amazon.com/ivs/latest/LowLatencyUserGuide/multiple-hosts.html) en la *Guía del usuario de Amazon IVS*.
+ Para obtener información sobre la API, consulte [DeleteEncoderConfiguration](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ivs-realtime/delete-encoder-configuration.html) en la *Referencia de comandos de la AWS CLI*.
### `delete-ingest-configuration`
En el siguiente ejemplo de código, se muestra cómo utilizar `delete-ingest-configuration`.
**AWS CLI**
**Ejemplo 1: eliminación de una configuración de ingesta inactiva**
En el siguiente ejemplo de `delete-ingest-configuration`, se elimina la configuración de ingesta inactiva para un nombre de recurso de Amazon (ARN) de configuración de ingesta especificado.
```
aws ivs-realtime delete-ingest-configuration \
--arn arn:aws:ivs:us-west-2:123456789012:ingest-configuration/AbCdEfGh1234
```
Este comando no genera ninguna salida.
Para obtener más información, consulte [Ingesta de transmisiones de IVS \$1 Transmisión en tiempo real](https://docs.aws.amazon.com/ivs/latest/RealTimeUserGuide/rt-stream-ingest.html) en la *Guía del usuario de Servicio de vídeos interactivos de Amazon*.
**Ejemplo 2: forzar la eliminación de una configuración de ingesta activa**
En el siguiente ejemplo de `delete-ingest-configuration`, se fuerza la eliminación de la configuración de ingesta activa para un nombre de recurso de Amazon (ARN) de configuración de ingesta especificado.
```
aws ivs-realtime delete-ingest-configuration \
--arn arn:aws:ivs:us-west-2:123456789012:ingest-configuration/AbCdEfGh1234 \
--force
```
Este comando no genera ninguna salida.
Para obtener más información, consulte [Ingesta de transmisiones de IVS \$1 Transmisión en tiempo real](https://docs.aws.amazon.com/ivs/latest/RealTimeUserGuide/rt-stream-ingest.html) en la *Guía del usuario de Servicio de vídeos interactivos de Amazon*.
+ Para obtener información sobre la API, consulte [DeleteIngestConfiguration](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ivs-realtime/delete-ingest-configuration.html) en la *Referencia de comandos de la AWS CLI*.
### `delete-public-key`
En el siguiente ejemplo de código, se muestra cómo utilizar `delete-public-key`.
**AWS CLI**
**Para eliminar una clave pública**
En el siguiente ejemplo de `delete-public-key`, se elimina la clave pública especificada.
```
aws ivs-realtime delete-public-key \
--arn arn:aws:ivs:us-west-2:123456789012:public-key/abcdABC1efg2
```
Este comando no genera ninguna salida.
Para obtener más información, consulte [Distribuir los tokens de participantes](https://docs.aws.amazon.com/ivs/latest/RealTimeUserGuide/getting-started-distribute-tokens.html) en la *Guía del usuario de Transmisión en tiempo real de Amazon IVS*.
+ Para obtener información sobre la API, consulte [DeletePublicKey](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ivs-realtime/delete-public-key.html) en la *Referencia de comandos de la AWS CLI*.
### `delete-stage`
En el siguiente ejemplo de código, se muestra cómo utilizar `delete-stage`.
**AWS CLI**
**Para eliminar un escenario**
En el siguiente ejemplo de `delete-stage`, se elimina la fase especificada.
```
aws ivs-realtime delete-stage \
--arn arn:aws:ivs:us-west-2:123456789012:stage/abcdABCDefgh
```
Este comando no genera ninguna salida.
Para obtener más información, consulte [Habilitación de varios hosts en una transmisión de Amazon IVS](https://docs.aws.amazon.com/ivs/latest/userguide/multiple-hosts.html) en la *Guía del usuario de Amazon IVS*.
+ Para obtener información sobre la API, consulte [DeleteStage](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ivs-realtime/delete-stage.html) en la *Referencia de comandos de la AWS CLI*.
### `delete-storage-configuration`
En el siguiente ejemplo de código, se muestra cómo utilizar `delete-storage-configuration`.
**AWS CLI**
**Para eliminar una configuración del almacenamiento de composición**
En el siguiente ejemplo de `delete-storage-configuration`, se elimina la configuración del almacenamiento de composición especificada por el ARN (Nombre de recurso de Amazon) indicado.
```
aws ivs-realtime delete-storage-configuration \
--arn "arn:aws:ivs:ap-northeast-1:123456789012:storage-configuration/ABabCDcdEFef"
```
Este comando no genera ninguna salida.
Para obtener más información, consulte [Habilitación de varios hosts en una transmisión de Amazon IVS](https://docs.aws.amazon.com/ivs/latest/LowLatencyUserGuide/multiple-hosts.html) en la *Guía del usuario de Amazon IVS*.
+ Para obtener información sobre la API, consulte [DeleteStorageConfiguration](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ivs-realtime/delete-storage-configuration.html) en la *Referencia de comandos de la AWS CLI*.
### `disconnect-participant`
En el siguiente ejemplo de código, se muestra cómo utilizar `disconnect-participant`.
**AWS CLI**
**Para desconectar a un participante de la fase**
En el siguiente ejemplo de `disconnect-participant`, se desconecta al participante especificado de la fase indicada.
```
aws ivs-realtime disconnect-participant \
--stage-arn arn:aws:ivs:us-west-2:123456789012:stage/abcdABCDefgh \
--participant-id ABCDEfghij01234KLMN5678
```
Este comando no genera ninguna salida.
Para obtener más información, consulte [Habilitación de varios hosts en una transmisión de Amazon IVS](https://docs.aws.amazon.com/ivs/latest/userguide/multiple-hosts.html) en la *Guía del usuario de Amazon IVS*.
+ Para obtener información sobre la API, consulte [DisconnectParticipant](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ivs-realtime/disconnect-participant.html) en la *Referencia de comandos de la AWS CLI*.
### `get-composition`
En el siguiente ejemplo de código, se muestra cómo utilizar `get-composition`.
**AWS CLI**
**Ejemplo 1: obtener una composición con los ajustes de diseño predeterminados**
En el siguiente ejemplo de `get-composition`, se obtiene la composición del ARN (Nombre de recurso de Amazon) especificado.
```
aws ivs-realtime get-composition \
--arn "arn:aws:ivs:ap-northeast-1:123456789012:composition/abcdABCDefgh"
```
Salida:
```
{
"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 obtener más información, consulte [Grabación compuesta de IVS \$1 Transmisión en tiempo real](https://docs.aws.amazon.com/ivs/latest/RealTimeUserGuide/rt-composite-recording.html) en la *Guía del usuario de Amazon Interactive Video Service*.
**Ejemplo 2: obtener una composición con los ajustes de diseño predeterminados**
En el siguiente ejemplo de `get-composition`, se obtiene la composición del ARN (Nombre de recurso de Amazon) especificado que usa el diseño predeterminado.
```
aws ivs-realtime get-composition \
--arn "arn:aws:ivs:ap-northeast-1:123456789012:composition/wxyzWXYZpqrs"
```
Salida:
```
{
"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 obtener más información, consulte [Grabación compuesta de IVS \$1 Transmisión en tiempo real](https://docs.aws.amazon.com/ivs/latest/RealTimeUserGuide/rt-composite-recording.html) en la *Guía del usuario de Amazon Interactive Video Service*.
**Ejemplo 3: obtención de una composición con la grabación de miniaturas habilitada**
En el siguiente ejemplo de `get-composition`, se obtiene la composición para el ARN (Nombre de recurso de Amazon) especificado, que tiene la grabación de miniaturas habilitada con la configuración predeterminada.
```
aws ivs-realtime get-composition \
--arn "arn:aws:ivs:ap-northeast-1:123456789012:composition/abcdABCDefgh"
```
Salida:
```
{
"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 obtener más información, consulte [Grabación compuesta de IVS \$1 Transmisión en tiempo real](https://docs.aws.amazon.com/ivs/latest/RealTimeUserGuide/rt-composite-recording.html) en la *Guía del usuario de Amazon Interactive Video Service*.
+ Para obtener información sobre la API, consulte [GetComposition](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ivs-realtime/get-composition.html) en la *Referencia de comandos de la AWS CLI*.
### `get-encoder-configuration`
En el siguiente ejemplo de código, se muestra cómo utilizar `get-encoder-configuration`.
**AWS CLI**
**Para eliminar una configuración de codificador de composición**
En el siguiente ejemplo de `get-encoder-configuration`, se obtiene la configuración del codificador de composición especificada por el ARN (Nombre de recurso de Amazon) indicado.
```
aws ivs-realtime get-encoder-configuration \
--arn "arn:aws:ivs:ap-northeast-1:123456789012:encoder-configuration/abcdABCDefgh"
```
Salida:
```
{
"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 obtener más información, consulte [Habilitación de varios hosts en una transmisión de Amazon IVS](https://docs.aws.amazon.com/ivs/latest/LowLatencyUserGuide/multiple-hosts.html) en la *Guía del usuario de Amazon IVS*.
+ Para obtener información sobre la API, consulte [GetEncoderConfiguration](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ivs-realtime/get-encoder-configuration.html) en la *Referencia de comandos de la AWS CLI*.
### `get-ingest-configuration`
En el siguiente ejemplo de código, se muestra cómo utilizar `get-ingest-configuration`.
**AWS CLI**
**Obtención de información de configuración de ingesta**
En el siguiente ejemplo de `get-ingest-configuration`, se obtiene la configuración de ingesta para un nombre de recurso de Amazon (ARN) de configuración de ingesta especificado.
```
aws ivs-realtime get-ingest-configuration \
--arn arn:aws:ivs:us-west-2:123456789012:ingest-configuration/AbCdEfGh1234
```
Salida:
```
{
"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": {}
}
}
```
Para obtener más información, consulte [Ingesta de transmisiones de IVS \$1 Transmisión en tiempo real](https://docs.aws.amazon.com/ivs/latest/RealTimeUserGuide/rt-stream-ingest.html) en la *Guía del usuario de Servicio de vídeos interactivos de Amazon*.
+ Para obtener información sobre la API, consulte [GetIngestConfiguration](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ivs-realtime/get-ingest-configuration.html) en la *Referencia de comandos de la AWS CLI*.
### `get-participant`
En el siguiente ejemplo de código, se muestra cómo utilizar `get-participant`.
**AWS CLI**
**Ejemplo 1: Obtención de un participante de la etapa**
En el siguiente ejemplo de `get-participant`, se obtiene al participante de la fase para un ID de participante y un ID de sesión específicos en el ARN (Nombre de recurso de Amazon) de la fase especificada.
```
aws ivs-realtime get-participant \
--stage-arn arn:aws:ivs:us-west-2:123456789012:stage/abcdABCDefgh \
--session-id st-a1b2c3d4e5f6g \
--participant-id abCDEf12GHIj
```
Salida:
```
{
"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 obtener más información, consulte [Habilitación de varios hosts en un flujo de Amazon IVS](https://docs.aws.amazon.com/ivs/latest/LowLatencyUserGuide/multiple-hosts.html) en la *Guía del usuario de Transmisión de baja latencia de Amazon IVS*.
**Ejemplo 2: Obtención de un participante de la etapa que se haya replicado en otra etapa**
En el siguiente ejemplo de `get-participant`, se obtiene al participante de la fase para un ID de participante y un ID de sesión específicos en el ARN (Nombre de recurso de Amazon) de la fase especificada, cuando se ha replicado al participante en otra etapa.
```
aws ivs-realtime get-participant \
--stage-arn arn:aws:ivs:us-west-2:123456789012:stage/abcdABCDefgh \
--session-id st-a1b2c3d4e5f6g \
--participant-id abCDEf12GHIj
```
Salida:
```
{
"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 obtener más información, consulte [Habilitación de varios hosts en un flujo de Amazon IVS](https://docs.aws.amazon.com/ivs/latest/LowLatencyUserGuide/multiple-hosts.html) en la *Guía del usuario de Transmisión de baja latencia de Amazon IVS*.
**Ejemplo 3: Obtención de un participante de la etapa que se haya replicado desde otra etapa**
En el siguiente ejemplo de `get-participant`, se obtiene al participante de la etapa para un ID de participante y un ID de sesión específicos en el ARN (Nombre de recurso de Amazon) de la etapa especificada, cuando se ha replicado al participante en otra etapa.
```
aws ivs-realtime get-participant \
--stage-arn arn:aws:ivs:us-west-2:123456789012:stage/abcdABCDefgh \
--session-id st-a1b2c3d4e5f6g \
--participant-id abCDEf12GHIj
```
Salida:
```
{
"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 obtener más información, consulte [Habilitación de varios hosts en un flujo de Amazon IVS](https://docs.aws.amazon.com/ivs/latest/LowLatencyUserGuide/multiple-hosts.html) en la *Guía del usuario de Transmisión de baja latencia de Amazon IVS*.
+ Para obtener información sobre la API, consulte [GetParticipant](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ivs-realtime/get-participant.html) en la *Referencia de comandos de la AWS CLI*.
### `get-public-key`
En el siguiente ejemplo de código, se muestra cómo utilizar `get-public-key`.
**AWS CLI**
**Para obtener una clave pública existente que se utilice para firmar los tokens de los participantes de la fase**
En el siguiente ejemplo de `get-public-key`, se obtiene una clave pública especificada por el ARN proporcionado para firmar los tokens de los participantes de la fase.
```
aws ivs-realtime get-public-key \
--arn arn:aws:ivs:us-west-2:123456789012:public-key/abcdABC1efg2
```
Salida:
```
{
"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 obtener más información, consulte [Distribuir los tokens de participantes](https://docs.aws.amazon.com/ivs/latest/RealTimeUserGuide/getting-started-distribute-tokens.html) en la *Guía del usuario de Transmisión en tiempo real de Amazon IVS*.
+ Para obtener información sobre la API, consulte [GetPublicKey](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ivs-realtime/get-public-key.html) en la *Referencia de comandos de la AWS CLI*.
### `get-stage-session`
En el siguiente ejemplo de código, se muestra cómo utilizar `get-stage-session`.
**AWS CLI**
**Para obtener una sesión de fase**
En el siguiente ejemplo de `get-stage-session`, se obtiene la sesión de fase para un ID de sesión especificado de un ARN (Nombre de recurso de Amazon) de fase indicada.
```
aws ivs-realtime get-stage-session \
--stage-arn arn:aws:ivs:us-west-2:123456789012:stage/abcdABCDefgh \
--session-id st-a1b2c3d4e5f6g
```
Salida:
```
{
"stageSession": {
"endTime": "2023-04-26T20:36:29+00:00",
"sessionId": "st-a1b2c3d4e5f6g",
"startTime": "2023-04-26T20:30:29.602000+00:00"
}
}
```
Para obtener más información, consulte [Habilitación de varios hosts en una transmisión de Amazon IVS](https://docs.aws.amazon.com/ivs/latest/userguide/multiple-hosts.html) en la *Guía del usuario de Amazon IVS*.
+ Para obtener información sobre la API, consulte [GetStageSession](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ivs-realtime/get-stage-session.html) en la *Referencia de comandos de la AWS CLI*.
### `get-stage`
En el siguiente ejemplo de código, se muestra cómo utilizar `get-stage`.
**AWS CLI**
**Para obtener la información de configuración de una fase**
En el siguiente ejemplo de `get-stage`, se obtiene la sesión de fase para un ARN (Nombre de recurso de Amazon) de fase especificado.
```
aws ivs-realtime get-stage \
--arn arn:aws:ivs:us-west-2:123456789012:stage/abcdABCDefgh
```
Salida:
```
{
"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 obtener más información, consulte [Habilitación de varios hosts en un flujo de Amazon IVS](https://docs.aws.amazon.com/ivs/latest/LowLatencyUserGuide/multiple-hosts.html) en la *Guía del usuario de Transmisión de baja latencia de Amazon IVS*.
+ Para obtener información sobre la API, consulte [GetStage](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ivs-realtime/get-stage.html) en la *Referencia de comandos de la AWS CLI*.
### `get-storage-configuration`
En el siguiente ejemplo de código, se muestra cómo utilizar `get-storage-configuration`.
**AWS CLI**
**Para obtener una configuración del almacenamiento de composición**
En el siguiente ejemplo de `get-storage-configuration`, se obtiene la configuración del almacenamiento de composición especificada por el ARN (Nombre de recurso de Amazon) indicado.
```
aws ivs-realtime get-storage-configuration \
--name arn "arn:aws:ivs:ap-northeast-1:123456789012:storage-configuration/abcdABCDefgh"
```
Salida:
```
{
"storageConfiguration": {
"arn": "arn:aws:ivs:ap-northeast-1:123456789012:storage-configuration/abcdABCDefgh",
"name": "test-sc",
"s3": {
"bucketName": "amzn-s3-demo-bucket"
},
"tags": {}
}
}
```
Para obtener más información, consulte [Habilitación de varios hosts en una transmisión de Amazon IVS](https://docs.aws.amazon.com/ivs/latest/LowLatencyUserGuide/multiple-hosts.html) en la *Guía del usuario de Amazon IVS*.
+ Para obtener información sobre la API, consulte [GetStorageConfiguration](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ivs-realtime/get-storage-configuration.html) en la *Referencia de comandos de la AWS CLI*.
### `import-public-key`
En el siguiente ejemplo de código, se muestra cómo utilizar `import-public-key`.
**AWS CLI**
**Para importar una clave pública existente que se utilice para firmar los tokens de los participantes de la fase**
En el siguiente ejemplo de `import-public-key`, se importa una clave pública de un archivo de material para utilizarla para firmar los tokens de los participantes de la fase.
```
aws ivs-realtime import-public-key \
--public-key-material="`cat public.pem`"
```
Salida:
```
{
"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 obtener más información, consulte [Distribuir los tokens de participantes](https://docs.aws.amazon.com/ivs/latest/RealTimeUserGuide/getting-started-distribute-tokens.html) en la *Guía del usuario de Transmisión en tiempo real de Amazon IVS*.
+ Para obtener información sobre la API, consulte [ImportPublicKey](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ivs-realtime/import-public-key.html) en la *Referencia de comandos de la AWS CLI*.
### `list-compositions`
En el siguiente ejemplo de código, se muestra cómo utilizar `list-compositions`.
**AWS CLI**
**Para obtener una lista de composiciones**
En el siguiente ejemplo de `list-compositions`, se enumeran todas las composiciones de la cuenta de AWS en la región de AWS en la que se procesa la solicitud de la API.
```
aws ivs-realtime list-compositions
```
Salida:
```
{
"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 obtener más información, consulte [Habilitación de varios hosts en una transmisión de Amazon IVS](https://docs.aws.amazon.com/ivs/latest/LowLatencyUserGuide/multiple-hosts.html) en la *Guía del usuario de Amazon IVS*.
+ Para obtener información sobre la API, consulte [ListCompositions](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ivs-realtime/list-compositions.html) en la *Referencia de comandos de la AWS CLI*.
### `list-encoder-configurations`
En el siguiente ejemplo de código, se muestra cómo utilizar `list-encoder-configurations`.
**AWS CLI**
**Para enumerar las configuraciones de los codificadores de composición**
En el siguiente ejemplo de `list-encoder-configurations`, se enumeran todas las composiciones del codificador de composición de AWS en la región de AWS en la que se procesa la solicitud de la API.
```
aws ivs-realtime list-encoder-configurations
```
Salida:
```
{
"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 obtener más información, consulte [Habilitación de varios hosts en una transmisión de Amazon IVS](https://docs.aws.amazon.com/ivs/latest/LowLatencyUserGuide/multiple-hosts.html) en la *Guía del usuario de Amazon IVS*.
+ Para obtener más información sobre la API, consulte [ListEncoderConfigurations](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ivs-realtime/list-encoder-configurations.html) en la *Referencia de comandos de la AWS CLI*.
### `list-ingest-configurations`
En el siguiente ejemplo de código, se muestra cómo utilizar `list-ingest-configurations`.
**AWS CLI**
**Obtención de información resumida sobre todas las configuraciones de ingesta**
En el siguiente ejemplo de `list-ingest-configurations`, se muestran todas las configuraciones de ingesta para la cuenta de AWS, en la región de AWS en la que se procesa la solicitud de la API.
```
aws ivs-realtime list-ingest-configurations
```
Salida:
```
{
"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": "",
}
]
}
```
Para obtener más información, consulte [Ingesta de transmisiones de IVS \$1 Transmisión en tiempo real](https://docs.aws.amazon.com/ivs/latest/RealTimeUserGuide/rt-stream-ingest.html) en la *Guía del usuario de Servicio de vídeos interactivos de Amazon*.
+ Para obtener información sobre la API, consulte [ListIngestConfigurations](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ivs-realtime/list-ingest-configurations.html) en la *Referencia de comandos de la AWS CLI*.
### `list-participant-events`
En el siguiente ejemplo de código, se muestra cómo utilizar `list-participant-events`.
**AWS CLI**
**Ejemplo 1: Obtención de una lista de los eventos de los participantes de la etapa**
En el siguiente ejemplo de `list-participant-events`, se enumeran todos los eventos de participantes de un ID de participante y un ID de sesión específicos de un ARN (Nombre de recurso de Amazon) de etapa especificado.
```
aws ivs-realtime list-participant-events \
--stage-arn arn:aws:ivs:us-west-2:123456789012:stage/abcdABCDefgh \
--session-id st-a1b2c3d4e5f6g \
--participant-id abCDEf12GHIj
```
Salida:
```
{
"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 obtener más información, consulte [Habilitación de varios hosts en un flujo de Amazon IVS](https://docs.aws.amazon.com/ivs/latest/LowLatencyUserGuide/multiple-hosts.html) en la *Guía del usuario de Transmisión de baja latencia de Amazon IVS*.
**Ejemplo 2: Obtención de una lista de los eventos de los participantes de la etapa, incluidos el inicio y la detención de la replicación de participantes**
En el siguiente ejemplo de `list-participant-events`, se muestran todos los eventos de participantes de un ID de sesión específico de un ARN (Nombre de recurso de Amazon) de etapa especificado, donde un participante se ha replicado en otra etapa.
```
aws ivs-realtime list-participant-events \
--stage-arn arn:aws:ivs:us-west-2:123456789012:stage/abcdABCDefgh \
--session-id st-a1b2c3d4e5f6g \
--participant-id abCDEf12GHIj
```
Salida:
```
{
"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 obtener más información, consulte [Habilitación de varios hosts en un flujo de Amazon IVS](https://docs.aws.amazon.com/ivs/latest/LowLatencyUserGuide/multiple-hosts.html) en la *Guía del usuario de Transmisión de baja latencia de Amazon IVS*.
+ Para obtener información sobre la API, consulte [ListParticipantEvents](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ivs-realtime/list-participant-events.html) en la *Referencia de comandos de la AWS CLI*.
### `list-participant-replicas`
En el siguiente ejemplo de código, se muestra cómo utilizar `list-participant-replicas`.
**AWS CLI**
**Obtención de una lista de réplicas de los participantes de la etapa**
En el siguiente ejemplo de `list-participant-replicas`, se muestran todos los participantes de la etapa replicados desde el ARN (Nombre de recurso de Amazon) de la etapa de origen especificado a otra etapa.
```
aws ivs-realtime list-participant-replicas \
--source-stage-arn arn:aws:ivs:us-west-2:123456789012:stage/abcdABCDefgh \
--participant-id abCDEf12GHIj
```
Salida:
```
{
"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 obtener más información, consulte [Replicación de participantes de IVS](https://docs.aws.amazon.com/ivs/latest/RealTimeUserGuide/rt-participant-replication.html) en la *Guía del usuario de Transmisión en tiempo real de Amazon IVS*.
+ Para obtener información sobre la API, consulte [ListParticipantReplicas](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ivs-realtime/list-participant-replicas.html) en la *Referencia de comandos de la AWS CLI*.
### `list-participants`
En el siguiente ejemplo de código, se muestra cómo utilizar `list-participants`.
**AWS CLI**
**Ejemplo 1: Obtención de una lista de los participantes de la etapa**
En el siguiente ejemplo de `list-participants`, se enumeran todos los participantes de un ID de sesión indicado de un ARN (Nombre de recurso de Amazon) de etapa especificado.
```
aws ivs-realtime list-participants \
--stage-arn arn:aws:ivs:us-west-2:123456789012:stage/abcdABCDefgh \
--session-id st-a1b2c3d4e5f6g
```
Salida:
```
{
"participants": [
{
"firstJoinTime": "2023-04-26T20:30:34+00:00",
"participantId": "abCDEf12GHIj",
"published": true,
"recordingState": "STOPPED",
"state": "DISCONNECTED",
"userId": ""
}
]
}
```
Para obtener más información, consulte [Habilitación de varios hosts en un flujo de Amazon IVS](https://docs.aws.amazon.com/ivs/latest/LowLatencyUserGuide/multiple-hosts.html) en la *Guía del usuario de Transmisión de baja latencia de Amazon IVS*.
**Ejemplo 2: Obtención de una lista de los participantes de la etapa, cuando un participante se ha replicado en otra etapa**
En el siguiente ejemplo de `list-participants`, se muestran todos los participantes de un ID de sesión específico de un ARN (Nombre de recurso de Amazon) de etapa especificado, cuando un participante se ha replicado en otra etapa.
```
aws ivs-realtime list-participants \
--stage-arn arn:aws:ivs:us-west-2:123456789012:stage/abcdABCDefgh \
--session-id st-a1b2c3d4e5f6g
```
Salida:
```
{
"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 obtener más información, consulte [Habilitación de varios hosts en un flujo de Amazon IVS](https://docs.aws.amazon.com/ivs/latest/LowLatencyUserGuide/multiple-hosts.html) en la *Guía del usuario de Transmisión de baja latencia de Amazon IVS*.
**Ejemplo 3: Obtención de una lista de los participantes de la etapa, cuando un participante se ha replicado desde otra etapa**
En el siguiente ejemplo de `list-participants`, se muestran todos los participantes de un ID de sesión específico de un ARN (Nombre de recurso de Amazon) de etapa especificado, cuando un participante se ha replicado desde otra etapa.
```
aws ivs-realtime list-participants \
--stage-arn arn:aws:ivs:us-west-2:123456789012:stage/abcdABCDefgh \
--session-id st-a1b2c3d4e5f6g
```
Salida:
```
{
"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 obtener más información, consulte [Habilitación de varios hosts en un flujo de Amazon IVS](https://docs.aws.amazon.com/ivs/latest/LowLatencyUserGuide/multiple-hosts.html) en la *Guía del usuario de Transmisión de baja latencia de Amazon IVS*.
+ Para obtener información sobre la API, consulte [ListParticipants](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ivs-realtime/list-participants.html) en la *Referencia de comandos de la AWS CLI*.
### `list-public-keys`
En el siguiente ejemplo de código, se muestra cómo utilizar `list-public-keys`.
**AWS CLI**
**Para enumerar las claves públicas existentes disponibles para firmar los tokens de los participantes de la fase**
En el siguiente ejemplo de `list-public-keys`, se enumeran todas las claves públicas disponibles para firmar los tokens de los participantes en la fase en la región de AWS donde se procesa la solicitud de la API.
```
aws ivs-realtime list-public-keys
```
Salida:
```
{
"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 obtener más información, consulte [Distribuir los tokens de participantes](https://docs.aws.amazon.com/ivs/latest/RealTimeUserGuide/getting-started-distribute-tokens.html) en la *Guía del usuario de Transmisión en tiempo real de Amazon IVS*.
+ Para obtener detalles de la API, consulte [ListPublicKeys](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ivs-realtime/list-public-keys.html) en la *Referencia de comandos de la AWS CLI*.
### `list-stage-sessions`
En el siguiente ejemplo de código, se muestra cómo utilizar `list-stage-sessions`.
**AWS CLI**
**Para obtener una lista de las sesiones de la fase**
En el siguiente ejemplo de `list-stage-sessions`, se enumeran todas las sesiones de un ARN (Nombre de recurso de Amazon) de etapa especificado.
```
aws ivs-realtime list-stage-sessions \
--stage-arn arn:aws:ivs:us-west-2:123456789012:stage/abcdABCDefgh
```
Salida:
```
{
"stageSessions": [
{
"endTime": "2023-04-26T20:36:29+00:00",
"sessionId": "st-a1b2c3d4e5f6g",
"startTime": "2023-04-26T20:30:29.602000+00:00"
}
]
}
```
Para obtener más información, consulte [Habilitación de varios hosts en una transmisión de Amazon IVS](https://docs.aws.amazon.com/ivs/latest/userguide/multiple-hosts.html) en la *Guía del usuario de Amazon IVS*.
+ Para obtener información sobre la API, consulte [ListStageSessions](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ivs-realtime/list-stage-sessions.html) en la *Referencia de comandos de la AWS CLI*.
### `list-stages`
En el siguiente ejemplo de código, se muestra cómo utilizar `list-stages`.
**AWS CLI**
**Para obtener información resumida sobre todas las fases**
En el siguiente ejemplo de `list-stages`, se enumeran todas las etapas de la cuenta de AWS en la región de AWS en la que se procesa la solicitud de la API.
```
aws ivs-realtime list-stages
```
Salida:
```
{
"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 obtener más información, consulte [Habilitación de varios hosts en una transmisión de Amazon IVS](https://docs.aws.amazon.com/ivs/latest/LowLatencyUserGuide/multiple-hosts.html) en la *Guía del usuario de Amazon IVS*.
+ Para obtener información sobre la API, consulte [ListStages](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ivs-realtime/list-stages.html) en la *Referencia de comandos de la AWS CLI*.
### `list-storage-configurations`
En el siguiente ejemplo de código, se muestra cómo utilizar `list-storage-configurations`.
**AWS CLI**
**Para enumerar las configuraciones de almacenamiento de composición**
En el siguiente ejemplo de `list-storage-configurations`, se enumeran todas las configuraciones del almacenamiento de composición de la cuenta de AWS en la región de AWS en la que se procesa la solicitud de la API.
```
aws ivs-realtime list-storage-configurations
```
Salida:
```
{
"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 obtener más información, consulte [Habilitación de varios hosts en una transmisión de Amazon IVS](https://docs.aws.amazon.com/ivs/latest/LowLatencyUserGuide/multiple-hosts.html) en la *Guía del usuario de Amazon IVS*.
+ Para obtener más información sobre la API, consulte [ListStorageConfigurations](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ivs-realtime/list-storage-configurations.html) en la *Referencia de comandos de la AWS CLI*.
### `start-composition`
En el siguiente ejemplo de código, se muestra cómo utilizar `start-composition`.
**AWS CLI**
**Ejemplo 1: iniciar una composición con los ajustes de diseño predeterminados**
En el siguiente ejemplo de `start-composition`, se inicia una composición para la etapa especificada que se va a transmitir a las ubicaciones indicadas.
```
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"}}]'
```
Salida:
```
{
"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 obtener más información, consulte [Grabación compuesta de IVS \$1 Transmisión en tiempo real](https://docs.aws.amazon.com/ivs/latest/RealTimeUserGuide/rt-composite-recording.html) en la *Guía del usuario de Amazon Interactive Video Service*.
**Ejemplo 2: iniciar una composición con los ajustes de diseño predeterminados**
En el siguiente ejemplo de `start-composition`, se inicia una composición para la etapa especificada que se va a transmitir a las ubicaciones indicadas con el diseño predeterminado.
```
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"}'
```
Salida:
```
{
"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 obtener más información, consulte [Grabación compuesta de IVS \$1 Transmisión en tiempo real](https://docs.aws.amazon.com/ivs/latest/RealTimeUserGuide/rt-composite-recording.html) en la *Guía del usuario de Amazon Interactive Video Service*.
**Ejemplo 3: inicio de una composición con la grabación de miniaturas habilitada**
En el siguiente ejemplo de `start-composition`, se inicia una composición para la etapa especificada que se va a transmitir a las ubicaciones indicadas con la grabación de miniaturas 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}]}}]'
```
Salida:
```
{
"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 obtener más información, consulte [Grabación compuesta de IVS \$1 Transmisión en tiempo real](https://docs.aws.amazon.com/ivs/latest/RealTimeUserGuide/rt-composite-recording.html) en la *Guía del usuario de Amazon Interactive Video Service*.
**Ejemplo 4: Para iniciar una composición mediante un diseño de cuadrícula con un orden personalizado de los participantes**
En el siguiente ejemplo de `start-composition`, se inicia una composición para la etapa especificada que se va a transmitir a las ubicaciones indicadas mediante el diseño de cuadrícula con el orden personalizado de los 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"}'
```
Salida:
```
{
"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 obtener más información, consulte [Grabación compuesta de IVS \$1 Transmisión en tiempo real](https://docs.aws.amazon.com/ivs/latest/RealTimeUserGuide/rt-composite-recording.html) en la *Guía del usuario de Amazon Interactive Video Service*.
+ Para obtener información sobre la API, consulte [StartComposition](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ivs-realtime/start-composition.html) en la *Referencia de comandos de la AWS CLI*.
### `start-participant-replication`
En el siguiente ejemplo de código, se muestra cómo utilizar `start-participant-replication`.
**AWS CLI**
**Inicio de la replicación de un participante de una etapa a otra**
El siguiente ejemplo de `start-participant-replication`, replica un participante de una etapa de origen a una etapa de destino, donde cada etapa se especifica mediante su ARN (Nombre de recurso de Amazon).
```
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
```
Salida:
```
{
"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 obtener más información, consulte [Replicación de participantes de IVS](https://docs.aws.amazon.com/ivs/latest/RealTimeUserGuide/rt-participant-replication.html) en la *Guía del usuario de Transmisión en tiempo real de Amazon IVS*.
+ Para obtener información sobre la API, consulte [StartParticipantReplication](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ivs-realtime/start-participant-replication.html) en la *Referencia de comandos de la AWS CLI*.
### `stop-composition`
En el siguiente ejemplo de código, se muestra cómo utilizar `stop-composition`.
**AWS CLI**
**Para detener una composición**
En el siguiente ejemplo de `stop-composition`, se detiene la composición especificada por el ARN (Nombre de recurso de Amazon) indicado.
```
aws ivs-realtime stop-composition \
--arn "arn:aws:ivs:ap-northeast-1:123456789012:composition/abcdABCDefgh"
```
Este comando no genera ninguna salida.
Para obtener más información, consulte [Habilitación de varios hosts en una transmisión de Amazon IVS](https://docs.aws.amazon.com/ivs/latest/LowLatencyUserGuide/multiple-hosts.html) en la *Guía del usuario de Amazon IVS*.
+ Para obtener información sobre la API, consulte [StopComposition](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ivs-realtime/stop-composition.html) en la *Referencia de comandos de la AWS CLI*.
### `stop-participant-replication`
En el siguiente ejemplo de código, se muestra cómo utilizar `stop-participant-replication`.
**AWS CLI**
**Detención de la replicación de un participante de una etapa a otra**
En el siguiente ejemplo de `stop-participant-replication`, se detiene la replicación de un participante desde una etapa de origen a una etapa de destino, donde cada etapa se especifica mediante su ARN (Nombre de recurso de Amazon).
```
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
```
Salida:
```
{
"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 obtener más información, consulte [Replicación de participantes de IVS](https://docs.aws.amazon.com/ivs/latest/RealTimeUserGuide/rt-participant-replication.html) en la *Guía del usuario de Transmisión en tiempo real de Amazon IVS*.
+ Para obtener información sobre la API, consulte [StopParticipantReplication](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ivs-realtime/stop-participant-replication.html) en la *Referencia de comandos de la AWS CLI*.
### `update-ingest-configuration`
En el siguiente ejemplo de código, se muestra cómo utilizar `update-ingest-configuration`.
**AWS CLI**
**Actualización de una configuración de ingesta**
En el siguiente ejemplo de `update-inegst-configuration`, se actualiza una configuración de ingesta para adjuntarla a una etapa.
```
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
```
Salida:
```
{
"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": {}
}
}
```
Para obtener más información, consulte [Ingesta de transmisiones de IVS \$1 Transmisión en tiempo real](https://docs.aws.amazon.com/ivs/latest/RealTimeUserGuide/rt-stream-ingest.html) en la *Guía del usuario de Servicio de vídeos interactivos de Amazon*.
+ Para obtener información sobre la API, consulte [UpdateIngestConfiguration](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ivs-realtime/update-ingest-configuration.html) en la *Referencia de comandos de la AWS CLI*.
### `update-stage`
En el siguiente ejemplo de código, se muestra cómo utilizar `update-stage`.
**AWS CLI**
**Ejemplo 1: Actualización de la configuración de una etapa**
En el siguiente ejemplo de `update-stage`, se actualiza una etapa para un ARN de etapa específico para actualizar el nombre de la etapa y configurar la grabación individual de los participantes con la grabación de miniaturas 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
```
Salida:
```
{
"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 obtener más información, consulte [Habilitación de varios hosts en un flujo de Amazon IVS](https://docs.aws.amazon.com/ivs/latest/LowLatencyUserGuide/multiple-hosts.html) en la *Guía del usuario de Transmisión de baja latencia de Amazon IVS*.
**Ejemplo 2: Actualización de la configuración de una etapa, incluida la desactivación de la grabación de réplicas de participantes**
En el siguiente ejemplo de `update-stage`, se actualiza una etapa para un ARN de etapa específico para actualizar el nombre de la etapa y configurar la grabación individual de los participantes con la grabación de miniaturas habilitada y la grabación de réplicas de participantes desactivada.
```
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
```
Salida:
```
{
"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 obtener más información, consulte [Habilitación de varios hosts en un flujo de Amazon IVS](https://docs.aws.amazon.com/ivs/latest/LowLatencyUserGuide/multiple-hosts.html) en la *Guía del usuario de Transmisión de baja latencia de Amazon IVS*.
+ Para obtener más información sobre la API, consulte [UpdateStage](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ivs-realtime/update-stage.html) en la *Referencia de comandos de la AWS CLI*.