Esempi di Amazon IVS Chat con AWS CLI - AWS Command Line Interface
Azioni

Questa documentazione è valida AWS CLI solo per la versione 1. Per la documentazione relativa alla versione 2 di AWS CLI, consulta la Guida per l'utente della versione 2.

Le traduzioni sono generate tramite traduzione automatica. In caso di conflitto tra il contenuto di una traduzione e la versione originale in Inglese, quest'ultima prevarrà.

Esempi di Amazon IVS Chat con AWS CLI

I seguenti esempi di codice mostrano come eseguire azioni e implementare scenari comuni utilizzando la chat AWS Command Line Interface con Amazon IVS.

Le azioni sono estratti di codice da programmi più grandi e devono essere eseguite nel contesto. Sebbene le azioni mostrino come richiamare le singole funzioni del servizio, è possibile visualizzarle contestualizzate negli scenari correlati.

Ogni esempio include un link al codice sorgente completo, in cui vengono fornite le istruzioni su come configurare ed eseguire il codice nel contesto.

Argomenti

Azioni

Il seguente esempio di codice mostra come usarecreate-chat-token.

AWS CLI

Come creare un token di chat

L'create-chat-tokenesempio seguente crea un token di chat crittografato che viene utilizzato per stabilire una WebSocket connessione individuale a una stanza. Il token è valido per un minuto e una connessione (sessione) stabilita con il token è valida per la durata specificata.

aws ivschat create-chat-token \
    --roomIdentifier "arn:aws:ivschat:us-west-2:12345689012:room/g1H2I3j4k5L6", \
    --userId" "11231234" \
    --capabilities "SEND_MESSAGE", \
    --sessionDurationInMinutes" 30

Output:

{
    "token": "ACEGmnoq#1rstu2...BDFH3vxwy!4hlm!#5",
    "sessionExpirationTime": "2022-03-16T04:44:09+00:00"
    "state": "CREATING",
    "tokenExpirationTime": "2022-03-16T03:45:09+00:00"
}

Per ulteriori informazioni, consulta Passaggio 3: autenticare e autorizzare i client di chat nella Guida per l’utente del Servizio video interattivo Amazon (Amazon IVS).

Il seguente esempio di codice mostra come utilizzarecreate-logging-configuration.

AWS CLI

Per creare una LoggingConfiguration risorsa di chat

L'create-logging-configurationesempio seguente crea una LoggingConfiguration risorsa che consente ai client di archiviare e registrare i messaggi inviati.

aws ivschat create-logging-configuration \
    --destination-configuration s3={bucketName=demo-logging-bucket} \
    --name "test-logging-config" \
    --tags "key1=value1, key2=value2"

Output:

{
    "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"
}

Per ulteriori informazioni, consulta Guida introduttiva alla Chat Amazon IVS nella Guida per l’utente del Servizio video interattivo Amazon (Amazon IVS).

Il seguente esempio di codice mostra come utilizzarecreate-room.

AWS CLI

Come creare una stanza

L’esempio create-room seguente crea una nuova stanza.

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

Output:

{
    "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"
}

Per ulteriori informazioni, consulta Passaggio 2: creare una chat room nella Guida per l’utente del Servizio video interattivo Amazon (Amazon IVS).

Il seguente esempio di codice mostra come utilizzaredelete-logging-configuration.

AWS CLI

Per eliminare una LoggingConfiguration risorsa di chat

L'delete-logging-configurationesempio seguente elimina la LoggingConfiguration risorsa per l'ARN specificato.

aws ivschat delete-logging-configuration \
    --identifier "arn:aws:ivschat:us-west-2:123456789012:logging-configuration/ABcdef34ghIJ"

Questo comando non produce alcun output.

Per ulteriori informazioni, consulta Guida introduttiva alla Chat Amazon IVS nella Guida per l’utente del Servizio video interattivo Amazon (Amazon IVS).

Il seguente esempio di codice mostra come utilizzaredelete-message.

AWS CLI

Come eliminare messaggi da una stanza specificata

L’esempio delete-message seguente invia un evento alla stanza specificata, che ordina ai client di eliminare il messaggio specificato, ovvero di annullarne la visualizzazione ed eliminarlo dalla cronologia chat del client.

aws ivschat delete-message \
    --roomIdentifier "arn:aws:ivschat:us-west-2:12345689012:room/g1H2I3j4k5L6" \
    --id "ABC123def456" \
    --reason "Message contains profanity"

Output:

{
    "id": "12345689012"
}

Per ulteriori informazioni, consulta Guida introduttiva alla Chat Amazon IVS nella Guida per l’utente del Servizio video interattivo Amazon (Amazon IVS).

Il seguente esempio di codice mostra come utilizzaredelete-room.

AWS CLI

Come eliminare una stanza

L’esempio delete-room seguente elimina la stanza specificata. I client connessi vengono disconnessi. In caso di successo, restituisce HTTP 204 con un corpo di risposta vuoto.

aws ivschat delete-room \
    --identifier "arn:aws:ivschat:us-west-2:12345689012:room/g1H2I3j4k5L6"

Questo comando non produce alcun output.

Per ulteriori informazioni, consulta Guida introduttiva alla Chat Amazon IVS nella Guida per l’utente del Servizio video interattivo Amazon (Amazon IVS).

Il seguente esempio di codice mostra come utilizzaredisconnect-user.

AWS CLI

Come disconnettere un utente da una stanza

L’esempio disconnect-user seguente disconnette tutte le connessioni dell’utente specificato dalla stanza specificata. In caso di successo, restituisce HTTP 200 con un corpo di risposta vuoto.

aws ivschat disconnect-user \
    --roomIdentifier "arn:aws:ivschat:us-west-2:12345689012:room/g1H2I3j4k5L6" \
    --userId "ABC123def456" \
    --reason "Violated terms of service"

Questo comando non produce alcun output.

Per ulteriori informazioni, consulta Guida introduttiva alla Chat Amazon IVS nella Guida per l’utente del Servizio video interattivo Amazon (Amazon IVS).

Il seguente esempio di codice mostra come utilizzareget-logging-configuration.

AWS CLI

Per ottenere informazioni su una LoggingConfiguration risorsa

L'get-logging-configurationesempio seguente ottiene informazioni sulla LoggingConfiguration risorsa per l'ARN specificato.

aws ivschat get-logging-configuration \
    --identifier "arn:aws:ivschat:us-west-2:123456789012:logging-configuration/ABcdef34ghIJ"

Output:

{
    "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"
}

Per ulteriori informazioni, consulta Guida introduttiva alla Chat Amazon IVS nella Guida per l’utente del Servizio video interattivo Amazon (Amazon IVS).

Il seguente esempio di codice mostra come utilizzareget-room.

AWS CLI

Come ottenere la stanza specificata

L’esempio get-room seguente ottiene informazioni sulla stanza specificata.

aws ivschat get-room \
    --identifier "arn:aws:ivschat:us-west-2:12345689012:room/g1H2I3j4k5L6"

Output:

{
    "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"
}

Per ulteriori informazioni, consulta Guida introduttiva alla Chat Amazon IVS nella Guida per l’utente del Servizio video interattivo Amazon (Amazon IVS).

Il seguente esempio di codice mostra come utilizzarelist-logging-configurations.

AWS CLI

Per ottenere informazioni di riepilogo su tutte le configurazioni di registrazione per l'utente nella AWS regione in cui viene elaborata la richiesta API

L'list-logging-configurationsesempio seguente elenca le informazioni su tutte le LoggingConfiguration risorse per l'utente nella AWS regione in cui viene elaborata la richiesta API.

aws ivschat list-logging-configurations \
    --max-results 2 \
    --next-token ""

Output:

{
    "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"
        }
        ...
    ]
}

Per ulteriori informazioni, consulta Guida introduttiva alla Chat Amazon IVS nella Guida per l’utente del Servizio video interattivo Amazon (Amazon IVS).

Il seguente esempio di codice mostra come utilizzarelist-rooms.

AWS CLI

Come ottenere informazioni di riepilogo su tutte le tue stanze nella Regione corrente

L'list-roomsesempio seguente ottiene informazioni di riepilogo su tutte le sale della AWS regione in cui viene elaborata la richiesta. I risultati sono ordinati in ordine decrescente di updateTime.

aws ivschat list-rooms \
    --logging-configuration-identifier "arn:aws:ivschat:us-west-2:123456789012:logging-configuration/ABcdef34ghIJ" \
    --max-results 10 \
    --next-token ""

Output:

{
    "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"
        }
    ]
}

Per ulteriori informazioni, consulta Guida introduttiva alla Chat Amazon IVS nella Guida per l’utente del Servizio video interattivo Amazon (Amazon IVS).

Il seguente esempio di codice mostra come utilizzarelist-tags-for-resource.

AWS CLI

Per elencare tutti i tag di una AWS risorsa (ad esempio: Room)

L’esempio list-tags-for-resource seguente elenca tutti i tag per un nome della risorsa Amazon (ARN) specificato per la risorsa.

aws ivschat list-tags-for-resource \
    --resource-arn arn:aws:ivschat:us-west-2:12345689012:room/g1H2I3j4k5L6

Output:

{
    "tags":
    {
        "key1": "value1",
        "key2": "value2"
    }
}

Per ulteriori informazioni, consulta Tagging nella Guida di riferimento all’API del Servizio video interattivo Amazon (Amazon IVS).

Il seguente esempio di codice mostra come utilizzaresend-event.

AWS CLI

Come inviare un evento a una stanza

L’esempio send-event seguente invia l’evento specificato alla stanza specificata.

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."

Output:

{
    "id": "12345689012"
}

Per ulteriori informazioni, consulta Guida introduttiva alla Chat Amazon IVS nella Guida per l’utente del Servizio video interattivo Amazon (Amazon IVS).

Il seguente esempio di codice mostra come utilizzaretag-resource.

AWS CLI

Per aggiungere o aggiornare i tag per una AWS risorsa (ad esempio: Room)

L’esempio tag-resource seguente aggiunge o aggiorna i tag per un nome della risorsa Amazon (ARN) specificato per la risorsa. In caso di successo, restituisce HTTP 200 con un corpo di risposta vuoto.

aws ivschat tag-resource \
    --resource-arn arn:aws:ivschat:us-west-2:12345689012:room/g1H2I3j4k5L6 \
    --tags "tagkey1=tagkeyvalue1, tagkey2=tagkeyvalue2"

Questo comando non produce alcun output.

Per ulteriori informazioni, consulta Tagging nella Guida di riferimento all’API del Servizio video interattivo Amazon (Amazon IVS).

Il seguente esempio di codice mostra come utilizzareuntag-resource.

AWS CLI

Per rimuovere i tag da una AWS risorsa (ad esempio: Room)

L’esempio untag-resource seguente rimuove i tag per un nome della risorsa Amazon (ARN) specificato per la risorsa. In caso di successo, restituisce HTTP 200 con un corpo di risposta vuoto.

aws ivschat untag-resource \
    --resource-arn arn:aws:ivschat:us-west-2:12345689012:room/g1H2I3j4k5L6 \
    --tag-keys "tagkey1, tagkey2"

Questo comando non produce alcun output.

Per ulteriori informazioni, consulta Tagging nella Guida di riferimento all’API del Servizio video interattivo Amazon (Amazon IVS).

Il seguente esempio di codice mostra come utilizzareupdate-logging-configuration.

AWS CLI

Come aggiornare una configurazione di registrazione di log

L'update-logging-configurationesempio seguente aggiorna una LoggingConfiguration risorsa con i dati forniti.

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"

Output:

{
    "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"
}

Per ulteriori informazioni, consulta Guida introduttiva alla Chat Amazon IVS nella Guida per l’utente del Servizio video interattivo Amazon (Amazon IVS).

Il seguente esempio di codice mostra come utilizzareupdate-room.

AWS CLI

Come aggiornare una configurazione di sincronizzazione

L’esempio update-room seguente aggiorna la configurazione della stanza specificata con i dati forniti.

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

Output:

{
    "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"
}

Per ulteriori informazioni, consulta Guida introduttiva alla Chat Amazon IVS nella Guida per l’utente del Servizio video interattivo Amazon (Amazon IVS).