Ejemplos de Amazon IVS Chat que utilizan AWS CLI

Para crear un token de chat

En el siguiente create-chat-token ejemplo, se 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 y 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 paso 3: Autenticar y autorizar los clientes de chat 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 a Amazon IVS Chat en la Guía del usuario de Amazon Interactive Video Service.

Para crear una habitación

En el create-room ejemplo siguiente se crea una habitación nueva.

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 el 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 especificadoARN.

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

Para eliminar mensajes de una sala específica

En el siguiente delete-message ejemplo, se envía un par 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 a Amazon IVS Chat en la Guía del usuario de Amazon Interactive Video Service.

Para eliminar una habitación

En el siguiente delete-room ejemplo, se elimina la habitación especificada. Los clientes conectados están desconectados. En caso de éxito, devuelve HTTP 204 con el 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 a Amazon IVS Chat en la Guía del usuario de Amazon Interactive Video Service.

Para desconectar a un usuario de una sala

El siguiente disconnect-user ejemplo desconecta todas las conexiones del usuario especificado de la sala especificada. En caso de éxito, devuelve HTTP 200 con el 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 a Amazon IVS Chat 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 especificadoARN.

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

Para obtener la habitación especificada

En el get-room ejemplo siguiente se obtiene información sobre la habitación 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 a Amazon IVS Chat en la Guía del usuario de Amazon Interactive Video Service.

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

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 API solicitud.

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

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

En el siguiente list-rooms ejemplo, se obtiene información resumida sobre todas las habitaciones de la AWS región en la que se procesa la solicitud. Los resultados se ordenan en orden descendente deupdateTime.

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

Para enumerar todas las etiquetas de un AWS recurso (por ejemplo: Habitación)

En el siguiente list-tags-for-resource ejemplo, se enumeran todas las etiquetas de un recurso específico ARN (Amazon Resource Name).

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 Etiquetado en la APIreferencia de Amazon Interactive Video Service.

Para enviar un evento a una sala

El siguiente send-event ejemplo 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 a Amazon IVS Chat 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 tag-resource ejemplo, se añaden o actualizan las etiquetas de un recurso específico ARN (Amazon Resource Name). En caso de éxito, devuelve HTTP 200 con el 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 Etiquetado en la APIreferencia de Amazon Interactive Video Service.

Para eliminar las etiquetas de un AWS recurso (por ejemplo: Room)

En el siguiente untag-resource ejemplo, se eliminan las etiquetas especificadas para un recurso específico ARN (Amazon Resource Name). En caso de éxito, devuelve HTTP 200 con el 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 Etiquetado en la APIreferencia de Amazon Interactive Video Service.

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

Para actualizar la configuración de una habitación

El siguiente update-room ejemplo actualiza la configuración de la habitación especificada con los datos proporcionados.

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