Esempi per Chat Amazon IVS con AWS CLI

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

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

Ogni esempio include un link al codice sorgente completo, dove è possibile trovare le istruzioni su come configurare ed eseguire il codice nel contesto.

Argomenti

Operazioni

Operazioni

L’esempio di codice seguente mostra come utilizzare create-chat-token.

AWS CLI

Come creare un token di chat

Nell’esempio seguente create-chat-token crea un token di chat crittografato utilizzato per stabilire una connessione WebSocket 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 Step 3: Authenticate and Authorize Chat Clients nella Guida per l’utente del Servizio video interattivo Amazon.

Per informazioni dettagliate sull’API, consulta CreateChatToken in AWS CLI Command Reference.

L’esempio di codice seguente mostra come utilizzare create-logging-configuration.

AWS CLI

Come creare una risorsa di chat LoggingConfiguration

Nell’esempio seguente create-logging-configuration crea una risorsa LoggingConfiguration 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.

Per informazioni dettagliate sull’API, consulta CreateLoggingConfiguration in AWS CLI Command Reference.

L’esempio di codice seguente mostra come utilizzare create-room.

AWS CLI

Come creare una stanza

Nell’esempio seguente create-room 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 Step 2: Create a Chat Room nella Guida per l’utente del Servizio video interattivo Amazon.

Per informazioni dettagliate sull’API, consulta CreateRoom in AWS CLI Command Reference.

L’esempio di codice seguente mostra come utilizzare delete-logging-configuration.

AWS CLI

Come eliminare una risorsa di chat LoggingConfiguration

L’esempio delete-logging-configuration seguente elimina la risorsa LoggingConfiguration 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.

Per informazioni dettagliate sull’API, consulta DeleteLoggingConfiguration in AWS CLI Command Reference.

L’esempio di codice seguente mostra come utilizzare delete-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.

Per informazioni dettagliate sull’API, consulta DeleteMessage in AWS CLI Command Reference.

L’esempio di codice seguente mostra come utilizzare delete-room.

AWS CLI

Come eliminare una stanza

Nell’esempio seguente delete-room 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.

Per informazioni dettagliate sull’API, consulta DeleteRoom in AWS CLI Command Reference.

L’esempio di codice seguente mostra come utilizzare disconnect-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.

Per informazioni dettagliate sull’API, consulta DisconnectUser in AWS CLI Command Reference.

L’esempio di codice seguente mostra come utilizzare get-logging-configuration.

AWS CLI

Come ottenere informazioni su una risorsa LoggingConfiguration

L’esempio get-logging-configuration seguente ottiene informazioni sulla risorsa LoggingConfiguration 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.

Per informazioni dettagliate sull’API, consulta GetLoggingConfiguration in AWS CLI Command Reference.

L’esempio di codice seguente mostra come utilizzare get-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.

Per informazioni dettagliate sull’API, consulta GetRoom in AWS CLI Command Reference.

L’esempio di codice seguente mostra come utilizzare list-logging-configurations.

AWS CLI

Come ottenere informazioni di riepilogo su tutte le configurazioni della registrazione di log per l’utente nella Regione AWS in cui viene elaborata la richiesta API

L’esempio list-logging-configurations seguente elenca le informazioni su tutte le risorse LoggingConfiguration per l’utente nella Regione AWS 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.

Per informazioni dettagliate sull’API, consulta ListLoggingConfigurations in AWS CLI Command Reference.

L’esempio di codice seguente mostra come utilizzare list-rooms.

AWS CLI

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

L’esempio list-rooms seguente ottiene informazioni di riepilogo su tutte le stanze della Regione AWS 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.

Per informazioni dettagliate sull’API, consulta ListRooms in AWS CLI Command Reference.

L’esempio di codice seguente mostra come utilizzare list-tags-for-resource.

AWS CLI

Come elencare tutti i tag di una risorsa AWS (ad esempio: stanza)

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.

Per informazioni dettagliate sull'API, consulta ListTagsForResource nella Documentazione di riferimento dei comandi della AWS CLI.

L’esempio di codice seguente mostra come utilizzare send-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.

Per informazioni dettagliate sull’API, consulta SendEvent in AWS CLI Command Reference.

L’esempio di codice seguente mostra come utilizzare tag-resource.

AWS CLI

Come aggiungere o aggiornare i tag per una risorsa AWS (ad esempio: stanza)

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.

Per informazioni dettagliate sulle API, consulta TagResource nel Riferimento ai comandi AWS CLI.

L’esempio di codice seguente mostra come utilizzare untag-resource.

AWS CLI

Come rimuovere i tag per una risorsa AWS (ad esempio: stanza)

L’esempio untag-resource seguente rimuove i tag specificati 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.

Per i dettagli dell'API, consulta UntagResource in Riferimento ai comandi della AWS CLI.

L’esempio di codice seguente mostra come utilizzare update-logging-configuration.

AWS CLI

Come aggiornare una configurazione di registrazione di log

L’esempio update-logging-configuration seguente aggiorna una risorsa LoggingConfiguration 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.

Per informazioni dettagliate sull’API, consulta UpdateLoggingConfiguration in AWS CLI Command Reference.

L’esempio di codice seguente mostra come utilizzare update-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.

Per informazioni dettagliate sull’API, consulta UpdateRoom in AWS CLI Command Reference.

Avvertimento JavaScript è disabilitato o non è disponibile nel tuo browser.

Per usare la documentazione AWS, JavaScript deve essere abilitato. Consulta le pagine della guida del browser per le istruzioni.

Convenzioni dei documenti

Amazon IVS

Streaming in tempo reale di Amazon IVS