# Ejemplos de Chat 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 Chat 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-chat-token`
En el siguiente ejemplo de código, se muestra cómo utilizar `create-chat-token`.
**AWS CLI**
**Para crear un token de chat**
En el siguiente ejemplo de `create-chat-token`, se crea un token de chat cifrado que se utiliza para establecer una conexión WebSocket individual a una sala. El token es válido durante un minuto. Una conexión (sesión) establecida con el token es válida durante el tiempo especificado.
```
aws ivschat create-chat-token \
--roomIdentifier "arn:aws:ivschat:us-west-2:12345689012:room/g1H2I3j4k5L6", \
--userId" "11231234" \
--capabilities "SEND_MESSAGE", \
--sessionDurationInMinutes" 30
```
Salida:
```
{
"token": "ACEGmnoq#1rstu2...BDFH3vxwy!4hlm!#5",
"sessionExpirationTime": "2022-03-16T04:44:09+00:00"
"state": "CREATING",
"tokenExpirationTime": "2022-03-16T03:45:09+00:00"
}
```
Para obtener más información, consulte el [Step 3: Authenticate and Authorize Chat Clients](https://docs.aws.amazon.com/ivs/latest/userguide/getting-started-chat.html) en la *Guía del usuario de Amazon Interactive Video Service*.
+ Para obtener información sobre la API, consulte [CreateChatToken](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ivschat/create-chat-token.html) en la *Referencia de comandos de la AWS CLI*.
### `create-logging-configuration`
En el siguiente ejemplo de código, se muestra cómo utilizar `create-logging-configuration`.
**AWS CLI**
**Para crear un recurso LoggingConfiguration de chat**
En el siguiente ejemplo de `create-logging-configuration`, se crea un recurso LoggingConfiguration que permite a los clientes almacenar y registrar los mensajes enviados.
```
aws ivschat create-logging-configuration \
--destination-configuration s3={bucketName=demo-logging-bucket} \
--name "test-logging-config" \
--tags "key1=value1, key2=value2"
```
Salida:
```
{
"arn": "arn:aws:ivschat:us-west-2:123456789012:logging-configuration/ABcdef34ghIJ",
"createTime": "2022-09-14T17:48:00.653000+00:00",
"destinationConfiguration": {
"s3": {
"bucketName": "demo-logging-bucket"
}
},
"id": "ABcdef34ghIJ",
"name": "test-logging-config",
"state": "ACTIVE",
"tags": { "key1" : "value1", "key2" : "value2" },
"updateTime": "2022-09-14T17:48:01.104000+00:00"
}
```
Para obtener más información, consulte [Introducción al Chat de Amazon IVS](https://docs.aws.amazon.com/ivs/latest/userguide/getting-started-chat.html) en la *Guía del usuario de Amazon Interactive Video Service*.
+ Para obtener información sobre la API, consulte [CreateLoggingConfiguration](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ivschat/create-logging-configuration.html) en la *Referencia de comandos de la AWS CLI*.
### `create-room`
En el siguiente ejemplo de código, se muestra cómo utilizar `create-room`.
**AWS CLI**
Para crear una sala
En el siguiente ejemplo de `create-room`, se crea una nueva sala.
```
aws ivschat create-room \
--name "test-room-1" \
--logging-configuration-identifiers "arn:aws:ivschat:us-west-2:123456789012:logging-configuration/ABcdef34ghIJ" \
--maximum-message-length 256 \
--maximum-message-rate-per-second 5
```
Salida:
```
{
"arn": "arn:aws:ivschat:us-west-2:12345689012:room/g1H2I3j4k5L6",
"id": "g1H2I3j4k5L6",
"createTime": "2022-03-16T04:44:09+00:00",
"loggingConfigurationIdentifiers": ["arn:aws:ivschat:us-west-2:123456789012:logging-configuration/ABcdef34ghIJ"],
"maximumMessageLength": 256,
"maximumMessageRatePerSecond": 5,
"name": "test-room-1",
"tags": {}
"updateTime": "2022-03-16T07:22:09+00:00"
}
```
Para obtener más información, consulte [Paso 2: crear una sala de chat](https://docs.aws.amazon.com/ivs/latest/userguide/getting-started-chat.html) en la *Guía del usuario de Amazon Interactive Video Service*.
+ Para obtener información sobre la API, consulte [CreateRoom](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ivschat/create-room.html) en la *Referencia de comandos de la AWS CLI*.
### `delete-logging-configuration`
En el siguiente ejemplo de código, se muestra cómo utilizar `delete-logging-configuration`.
**AWS CLI**
**Para eliminar un recurso LoggingConfiguration de chat**
En el siguiente ejemplo de `delete-logging-configuration`, se elimina el recurso LoggingConfiguration del ARN especificado.
```
aws ivschat delete-logging-configuration \
--identifier "arn:aws:ivschat:us-west-2:123456789012:logging-configuration/ABcdef34ghIJ"
```
Este comando no genera ninguna salida.
Para obtener más información, consulte [Introducción al Chat de Amazon IVS](https://docs.aws.amazon.com/ivs/latest/userguide/getting-started-chat.html) en la *Guía del usuario de Amazon Interactive Video Service*.
+ Para obtener información sobre la API, consulte [DeleteLoggingConfiguration](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ivschat/delete-logging-configuration.html) en la *Referencia de comandos de la AWS CLI*.
### `delete-message`
En el siguiente ejemplo de código, se muestra cómo utilizar `delete-message`.
**AWS CLI**
**Para eliminar mensajes de una sala específica**
En el siguiente ejemplo de `delete-message`, se envía un evento a la sala especificada, que indica a los clientes que eliminen el mensaje especificado, es decir, que lo retiren de la vista y que lo eliminen del historial de chat del cliente.
```
aws ivschat delete-message \
--roomIdentifier "arn:aws:ivschat:us-west-2:12345689012:room/g1H2I3j4k5L6" \
--id "ABC123def456" \
--reason "Message contains profanity"
```
Salida:
```
{
"id": "12345689012"
}
```
Para obtener más información, consulte [Introducción al Chat de Amazon IVS](https://docs.aws.amazon.com/ivs/latest/userguide/getting-started-chat.html) en la *Guía del usuario de Amazon Interactive Video Service*.
+ Para obtener información sobre la API, consulte [DeleteMessage](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ivschat/delete-message.html) en la *Referencia de comandos de la AWS CLI*.
### `delete-room`
En el siguiente ejemplo de código, se muestra cómo utilizar `delete-room`.
**AWS CLI**
**Para eliminar una sala**
En el siguiente ejemplo de `delete-room`, se elimina la sala especificada. Los clientes que están conectados a la sala se desconectarán. Si se ejecuta correctamente, devuelve HTTP 204 con un cuerpo de respuesta vacío.
```
aws ivschat delete-room \
--identifier "arn:aws:ivschat:us-west-2:12345689012:room/g1H2I3j4k5L6"
```
Este comando no genera ninguna salida.
Para obtener más información, consulte [Introducción al Chat de Amazon IVS](https://docs.aws.amazon.com/ivs/latest/userguide/getting-started-chat.html) en la *Guía del usuario de Amazon Interactive Video Service*.
+ Para obtener información sobre la API, consulte [DeleteRoom](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ivschat/delete-room.html) en la *Referencia de comandos de la AWS CLI*.
### `disconnect-user`
En el siguiente ejemplo de código, se muestra cómo utilizar `disconnect-user`.
**AWS CLI**
**Para desconectar a un usuario de una sala**
En el siguiente ejemplo de `disconnect-user`, se desconectan todas las conexiones del usuario especificado de la sala indicada. Si se ejecuta correctamente, devuelve HTTP 200 con un cuerpo de respuesta vacío.
```
aws ivschat disconnect-user \
--roomIdentifier "arn:aws:ivschat:us-west-2:12345689012:room/g1H2I3j4k5L6" \
--userId "ABC123def456" \
--reason "Violated terms of service"
```
Este comando no genera ninguna salida.
Para obtener más información, consulte [Introducción al Chat de Amazon IVS](https://docs.aws.amazon.com/ivs/latest/userguide/getting-started-chat.html) en la *Guía del usuario de Amazon Interactive Video Service*.
+ Para obtener más información sobre la API, consulte [DisconnectUser](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ivschat/disconnect-user.html) en la *Referencia de comandos de la AWS CLI*.
### `get-logging-configuration`
En el siguiente ejemplo de código, se muestra cómo utilizar `get-logging-configuration`.
**AWS CLI**
**Para obtener información sobre un recurso LoggingConfiguration**
En el siguiente ejemplo de `get-logging-configuration`, se obtiene información del recurso LoggingConfiguration del ARN especificado.
```
aws ivschat get-logging-configuration \
--identifier "arn:aws:ivschat:us-west-2:123456789012:logging-configuration/ABcdef34ghIJ"
```
Salida:
```
{
"arn": "arn:aws:ivschat:us-west-2:123456789012:logging-configuration/ABcdef34ghIJ",
"createTime": "2022-09-14T17:48:00.653000+00:00",
"destinationConfiguration": {
"s3": {
"bucketName": "demo-logging-bucket"
}
},
"id": "ABcdef34ghIJ",
"name": "test-logging-config",
"state": "ACTIVE",
"tags": { "key1" : "value1", "key2" : "value2" },
"updateTime": "2022-09-14T17:48:01.104000+00:00"
}
```
Para obtener más información, consulte [Introducción al Chat de Amazon IVS](https://docs.aws.amazon.com/ivs/latest/userguide/getting-started-chat.html) en la *Guía del usuario de Amazon Interactive Video Service*.
+ Para obtener información sobre la API, consulte [GetLoggingConfiguration](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ivschat/get-logging-configuration.html) en la *Referencia de comandos de la AWS CLI*.
### `get-room`
En el siguiente ejemplo de código, se muestra cómo utilizar `get-room`.
**AWS CLI**
**Para obtener la sala especificada**
En el siguiente ejemplo de `get-room`, se obtiene información de la sala especificada.
```
aws ivschat get-room \
--identifier "arn:aws:ivschat:us-west-2:12345689012:room/g1H2I3j4k5L6"
```
Salida:
```
{
"arn": "arn:aws:ivschat:us-west-2:12345689012:room/g1H2I3j4k5L6",
"createTime": "2022-03-16T04:44:09+00:00",
"id": "g1H2I3j4k5L6",
"loggingConfigurationIdentifiers": ["arn:aws:ivschat:us-west-2:123456789012:logging-configuration/ABcdef34ghIJ"],
"maximumMessageLength": 256,
"maximumMessageRatePerSecond": 5,
"name": "test-room-1",
"tags": {},
"updateTime": "2022-03-16T07:22:09+00:00"
}
```
Para obtener más información, consulte [Introducción al Chat de Amazon IVS](https://docs.aws.amazon.com/ivs/latest/userguide/getting-started-chat.html) en la *Guía del usuario de Amazon Interactive Video Service*.
+ Para obtener información sobre la API, consulte [GetRoom](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ivschat/get-room.html) en la *Referencia de comandos de la AWS CLI*.
### `list-logging-configurations`
En el siguiente ejemplo de código, se muestra cómo utilizar `list-logging-configurations`.
**AWS CLI**
**Para obtener información resumida sobre todas las configuraciones de registro del usuario en la región de AWS en la que se procesa la solicitud de la API**
En el siguiente ejemplo de `list-logging-configurations`, se enumera información sobre todos los recursos LoggingConfiguration para el usuario en la región de AWS en la que se procesa la solicitud de la API.
```
aws ivschat list-logging-configurations \
--max-results 2 \
--next-token ""
```
Salida:
```
{
"nextToken": "set-2",
"loggingConfigurations": [
{
"arn": "arn:aws:ivschat:us-west-2:123456789012:logging-configuration/ABcdef34ghIJ",
"createTime": "2022-09-14T17:48:00.653000+00:00",
"destinationConfiguration": {
"s3": {
"bucketName": "demo-logging-bucket"
}
},
"id": "ABcdef34ghIJ",
"name": "test-logging-config",
"state": "ACTIVE",
"tags": { "key1" : "value1", "key2" : "value2" },
"updateTime": "2022-09-14T17:48:01.104000+00:00"
}
...
]
}
```
Para obtener más información, consulte [Introducción al Chat de Amazon IVS](https://docs.aws.amazon.com/ivs/latest/userguide/getting-started-chat.html) en la *Guía del usuario de Amazon Interactive Video Service*.
+ Para obtener más información sobre la API, consulte [ListLoggingConfigurations](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ivschat/list-logging-configurations.html) en la *Referencia de comandos de la AWS CLI*.
### `list-rooms`
En el siguiente ejemplo de código, se muestra cómo utilizar `list-rooms`.
**AWS CLI**
**Para obtener información resumida sobre todas las salas de la región actual**
En el siguiente ejemplo de `list-rooms`, se obtiene información resumida sobre todas las salas de la región de AWS en la que se procesa la solicitud. Los resultados se muestran en orden descendente de updateTime.
```
aws ivschat list-rooms \
--logging-configuration-identifier "arn:aws:ivschat:us-west-2:123456789012:logging-configuration/ABcdef34ghIJ" \
--max-results 10 \
--next-token ""
```
Salida:
```
{
"nextToken": "page3",
"rooms": [
{
"arn:aws:ivschat:us-west-2:12345689012:room/g1H2I3j4k5L6",
"createTime": "2022-03-16T04:44:09+00:00",
"id": "g1H2I3j4k5L6",
"loggingConfigurationIdentifiers": ["arn:aws:ivschat:us-west-2:123456789012:logging-configuration/ABcdef34ghIJ"],
"name": "test-room-1",
"tags": {},
"updateTime": "2022-03-16T07:22:09+00:00"
}
]
}
```
Para obtener más información, consulte [Introducción al Chat de Amazon IVS](https://docs.aws.amazon.com/ivs/latest/userguide/getting-started-chat.html) en la *Guía del usuario de Amazon Interactive Video Service*.
+ Para obtener información sobre la API, consulte [ListRooms](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ivschat/list-rooms.html) en la *Referencia de comandos de la AWS CLI*.
### `list-tags-for-resource`
En el siguiente ejemplo de código, se muestra cómo utilizar `list-tags-for-resource`.
**AWS CLI**
**Para enumerar todas las etiquetas de un recurso de AWS (por ejemplo, Room)**
En el siguiente ejemplo de `list-tags-for-resource`, se enumeran todas las etiquetas de un ARN (Nombre de recurso de Amazon) de recurso específico.
```
aws ivschat list-tags-for-resource \
--resource-arn arn:aws:ivschat:us-west-2:12345689012:room/g1H2I3j4k5L6
```
Salida:
```
{
"tags":
{
"key1": "value1",
"key2": "value2"
}
}
```
Para obtener más información, consulte [Tagging](https://docs.aws.amazon.com/ivs/latest/APIReference/Welcome.html) en la *Referencia de la API de Amazon Interactive Video Service*.
+ Para ver los detalles de la API, consulte [ListTagsForResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ivschat/list-tags-for-resource.html) en la *Referencia de comandos de la AWS CLI*.
### `send-event`
En el siguiente ejemplo de código, se muestra cómo utilizar `send-event`.
**AWS CLI**
**Para enviar un evento a una sala**
En el siguiente ejemplo de `send-event`, se envía el evento dado a la sala especificada.
```
aws ivschat send-event \
--roomIdentifier "arn:aws:ivschat:us-west-2:12345689012:room/g1H2I3j4k5L6" \
--eventName "SystemMessage" \
--attributes \
"msgType"="user-notification", \
"msgText"="This chat room will close in 15 minutes."
```
Salida:
```
{
"id": "12345689012"
}
```
Para obtener más información, consulte [Introducción al Chat de Amazon IVS](https://docs.aws.amazon.com/ivs/latest/userguide/getting-started-chat.html) en la *Guía del usuario de Amazon Interactive Video Service*.
+ Para obtener más información sobre la API, consulte [SendEvent](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ivschat/send-event.html) en la *Referencia de comandos de la AWS CLI*.
### `tag-resource`
En el siguiente ejemplo de código, se muestra cómo utilizar `tag-resource`.
**AWS CLI**
**Para agregar o actualizar todas las etiquetas de un recurso de AWS (por ejemplo, Room)**
En el siguiente ejemplo de `tag-resource`, se agregan o actualizan las etiquetas de un ARN (Nombre de recurso de Amazon) de recurso específico. Si se ejecuta correctamente, devuelve HTTP 200 con un cuerpo de respuesta vacío.
```
aws ivschat tag-resource \
--resource-arn arn:aws:ivschat:us-west-2:12345689012:room/g1H2I3j4k5L6 \
--tags "tagkey1=tagkeyvalue1, tagkey2=tagkeyvalue2"
```
Este comando no genera ninguna salida.
Para obtener más información, consulte [Tagging](https://docs.aws.amazon.com/ivs/latest/APIReference/Welcome.html) en la *Referencia de la API de Amazon Interactive Video Service*.
+ Para ver los detalles de la API, consulte [TagResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ivschat/tag-resource.html) en la *Referencia de comandos de la AWS CLI*.
### `untag-resource`
En el siguiente ejemplo de código, se muestra cómo utilizar `untag-resource`.
**AWS CLI**
**Para eliminar las etiquetas de un recurso de AWS (por ejemplo, Room)**
En el siguiente ejemplo de `untag-resource`, se eliminan etiquetas específicas de un ARN (Nombre de recurso de Amazon) de recurso específico. Si se ejecuta correctamente, devuelve HTTP 200 con un cuerpo de respuesta vacío.
```
aws ivschat untag-resource \
--resource-arn arn:aws:ivschat:us-west-2:12345689012:room/g1H2I3j4k5L6 \
--tag-keys "tagkey1, tagkey2"
```
Este comando no genera ninguna salida.
Para obtener más información, consulte [Tagging](https://docs.aws.amazon.com/ivs/latest/APIReference/Welcome.html) en la *Referencia de la API de Amazon Interactive Video Service*.
+ Para ver los detalles de la API, consulte [UntagResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ivschat/untag-resource.html) en la *Referencia de comandos de la AWS CLI*.
### `update-logging-configuration`
En el siguiente ejemplo de código, se muestra cómo utilizar `update-logging-configuration`.
**AWS CLI**
**Para actualizar una configuración de registro de una sala**
En el siguiente ejemplo de `update-logging-configuration`, se actualiza un recurso LoggingConfiguration con los datos proporcionados.
```
aws ivschat update-logging-configuration \
--destination-configuration s3={bucketName=demo-logging-bucket} \
--identifier "arn:aws:ivschat:us-west-2:123456789012:logging-configuration/ABcdef34ghIJ" \
--name "test-logging-config"
```
Salida:
```
{
"arn": "arn:aws:ivschat:us-west-2:123456789012:logging-configuration/ABcdef34ghIJ",
"createTime": "2022-09-14T17:48:00.653000+00:00",
"destinationConfiguration": {
"s3": {
"bucketName": "demo-logging-bucket"
}
},
"id": "ABcdef34ghIJ",
"name": "test-logging-config",
"state": "ACTIVE",
"tags": { "key1" : "value1", "key2" : "value2" },
"updateTime": "2022-09-14T17:48:01.104000+00:00"
}
```
Para obtener más información, consulte [Introducción al Chat de Amazon IVS](https://docs.aws.amazon.com/ivs/latest/userguide/getting-started-chat.html) en la *Guía del usuario de Amazon Interactive Video Service*.
+ Para obtener información acerca de la API, consulte [UpdateLoggingConfiguration](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ivschat/update-logging-configuration.html) en la *Referencia de comandos de la AWS CLI*.
### `update-room`
En el siguiente ejemplo de código, se muestra cómo utilizar `update-room`.
**AWS CLI**
**Para actualizar la configuración de una sala**
En el siguiente de ejemplo de `update-room`, se actualiza la configuración de la sala indicada para los datos especificados.
```
aws ivschat update-room \
--identifier "arn:aws:ivschat:us-west-2:12345689012:room/g1H2I3j4k5L6" \
--logging-configuration-identifiers "arn:aws:ivschat:us-west-2:123456789012:logging-configuration/ABcdef34ghIJ" \
--name "chat-room-a" \
--maximum-message-length 256 \
--maximum-message-rate-per-second 5
```
Salida:
```
{
"arn": "arn:aws:ivschat:us-west-2:12345689012:room/g1H2I3j4k5L6",
"createTime": "2022-03-16T04:44:09+00:00",
"id": "g1H2I3j4k5L6",
"loggingConfigurationIdentifiers": ["arn:aws:ivschat:us-west-2:123456789012:logging-configuration/ABcdef34ghIJ"],
"maximumMessageLength": 256,
"maximumMessageRatePerSecond": 5,
"name": "chat-room-a",
"tags": {},
"updateTime": "2022-03-16T07:22:09+00:00"
}
```
Para obtener más información, consulte [Introducción al Chat de Amazon IVS](https://docs.aws.amazon.com/ivs/latest/userguide/getting-started-chat.html) en la *Guía del usuario de Amazon Interactive Video Service*.
+ Para obtener información sobre la API, consulte [UpdateRoom](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ivschat/update-room.html) en la *Referencia de comandos de la AWS CLI*.