Ejemplos de chat de Amazon IVS que utilizan AWS CLI

Para crear un token de chat

El siguiente create-chat-token ejemplo crea un token de chat cifrado que se utiliza para establecer una WebSocket conexión individual con 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 en la Guía del usuario de Amazon Interactive Video Service.

Para crear un LoggingConfiguration recurso de chat

El siguiente create-logging-configuration ejemplo crea un LoggingConfiguration recurso que permite a los clientes almacenar y grabar 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 en la Guía del usuario de Amazon Interactive Video Service.

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 en la Guía del usuario de Amazon Interactive Video Service.

Para eliminar un LoggingConfiguration recurso de chat

En el siguiente delete-logging-configuration ejemplo, se elimina el LoggingConfiguration recurso 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 en la Guía del usuario de Amazon Interactive Video Service.

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 en la Guía del usuario de Amazon Interactive Video Service.

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 en la Guía del usuario de Amazon Interactive Video Service.

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 en la Guía del usuario de Amazon Interactive Video Service.

Para obtener información sobre un LoggingConfiguration recurso

En el siguiente get-logging-configuration ejemplo, se obtiene información sobre el LoggingConfiguration recurso 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 en la Guía del usuario de Amazon Interactive Video Service.

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 en la Guía del usuario de Amazon Interactive Video Service.

Para obtener información resumida sobre todas las configuraciones de registro del usuario en la AWS región en la que se procesa la solicitud de API

En el siguiente list-logging-configurations ejemplo, se muestra información sobre todos LoggingConfiguration los recursos del usuario en la AWS región en la que se procesa la solicitud de 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 en la Guía del usuario de Amazon Interactive Video Service.

Para obtener información resumida sobre todas las salas de la región actual

En el siguiente list-rooms ejemplo, se obtiene información resumida sobre todas las salas de la AWS región 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 en la Guía del usuario de Amazon Interactive Video Service.

Para enumerar todas las etiquetas de un AWS recurso (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 en la Referencia de la API de Amazon Interactive Video Service.

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 en la Guía del usuario de Amazon Interactive Video Service.

Para añadir o actualizar las etiquetas de un AWS recurso (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 en la Referencia de la API de Amazon Interactive Video Service.

Para eliminar las etiquetas de un AWS recurso (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 en la Referencia de la API de Amazon Interactive Video Service.

Para actualizar una configuración de registro de una sala

En el siguiente update-logging-configuration ejemplo, se actualiza un LoggingConfiguration recurso 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 en la Guía del usuario de Amazon Interactive Video Service.

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 en la Guía del usuario de Amazon Interactive Video Service.