Beispiele für die Verwendung der AWS CLI mit Amazon IVS Chat

So erstellen Sie ein Token

Im folgenden Beispiel create-chat-token wird ein verschlüsseltes Chat-Token erstellt, das zum Herstellen einer individuellen WebSocket-Verbindung zu einem Raum verwendet wird. Das Token ist für eine Minute gültig, und eine mit dem Token hergestellte Verbindung (Sitzung) ist für die angegebene Dauer gültig.

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

Ausgabe:

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

Weitere Informationen finden Sie unter Schritt 3: Authentifizieren und Autorisieren von Chat-Clients im Benutzerhandbuch zu Amazon Interactive Video Service.

So erstellen Sie eine Chat-LoggingConfiguration-Ressource

Im folgenden create-logging-configuration-Beispiel wird eine LoggingConfiguration-Ressource erstellt, die es Clients ermöglicht, gesendete Nachrichten zu speichern und aufzuzeichnen.

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

Ausgabe:

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

Weitere Informationen finden Sie unter Erste Schritte mit Amazon IVS Chat im Benutzerhandbuch zu Amazon Interactive Video Service.

So erstellen Sie einen Raum

Im folgenden Beispiel für create-room wird ein neuer Raum erstellt.

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

Ausgabe:

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

Weitere Informationen finden Sie unter Schritt 2: Erstellen eines Chatrooms im Benutzerhandbuch zu Amazon Interactive Video Service.

So löschen Sie eine Chat-LoggingConfiguration-Ressource

Im folgenden Beispiel für delete-logging-configuration wird die LoggingConfiguration-Ressource für den angegebenen ARN gelöscht.

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

Mit diesem Befehl wird keine Ausgabe zurückgegeben.

Weitere Informationen finden Sie unter Erste Schritte mit Amazon IVS Chat im Benutzerhandbuch zu Amazon Interactive Video Service.

So löschen Sie Nachrichten aus einem bestimmten Raum

Im folgenden Beispiel für delete-message wird ein Ereignis an den angegebenen Raum gesendet, wodurch die Clients angewiesen werden, die angegebene Nachricht zu löschen, d. h. sie aus der Ansicht zu entfernen und sie aus dem Chat-Verlauf des Clients zu löschen.

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

Ausgabe:

{
    "id": "12345689012"
}

Weitere Informationen finden Sie unter Erste Schritte mit Amazon IVS Chat im Benutzerhandbuch zu Amazon Interactive Video Service.

So löschen Sie einen Raum

Im folgenden Beispiel für delete-room wird der angegebene Raum gelöscht. Verbundene Clients werden getrennt. Bei Erfolg wird HTTP 204 mit einem leeren Antworttext zurückgegeben.

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

Mit diesem Befehl wird keine Ausgabe zurückgegeben.

Weitere Informationen finden Sie unter Erste Schritte mit Amazon IVS Chat im Benutzerhandbuch zu Amazon Interactive Video Service.

So trennen Sie einen Benutzer von einem Raum

Im folgenden Beispiel für disconnect-user werden alle Verbindungen für den angegebenen Benutzer vom angegebenen Raum getrennt. Bei Erfolg wird HTTP 200 mit einem leeren Antworttext zurückgegeben.

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

Mit diesem Befehl wird keine Ausgabe zurückgegeben.

Weitere Informationen finden Sie unter Erste Schritte mit Amazon IVS Chat im Benutzerhandbuch zu Amazon Interactive Video Service.

So rufen Sie eine LoggingConfiguration-Ressource ab

Im folgenden Beispiel für get-logging-configuration werden Informationen zur LoggingConfiguration-Ressource für den angegebenen ARN abgerufen.

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

Ausgabe:

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

Weitere Informationen finden Sie unter Erste Schritte mit Amazon IVS Chat im Benutzerhandbuch zu Amazon Interactive Video Service.

So rufen Sie den angegebenen Raum ab

Im folgenden Beispiel für get-room werden Informationen zum angegebenen Raum abgerufen.

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

Ausgabe:

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

Weitere Informationen finden Sie unter Erste Schritte mit Amazon IVS Chat im Benutzerhandbuch zu Amazon Interactive Video Service.

So rufen Sie zusammenfassende Informationen zu allen Protokollierungskonfigurationen für den Benutzer in der AWS-Region ab, in der die API-Anforderung verarbeitet wird

Das folgende list-logging-configurations Beispiel listet Informationen zu allen LoggingConfiguration-Ressourcen für den Benutzer in der AWS-Region auf, in der die API-Anfrage verarbeitet wird.

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

Ausgabe:

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

Weitere Informationen finden Sie unter Erste Schritte mit Amazon IVS Chat im Benutzerhandbuch zu Amazon Interactive Video Service.

So rufen Sie zusammenfassende Informationen zu all Ihren Räumen in der aktuellen Region ab

Im folgenden Beispiel für list-rooms werden zusammenfassende Informationen zu allen Räumen in der AWS- Region abgerufen, in der die Anforderung verarbeitet wird. Die Ergebnisse sind in absteigender Reihenfolge von updateTime sortiert.

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

Ausgabe:

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

Weitere Informationen finden Sie unter Erste Schritte mit Amazon IVS Chat im Benutzerhandbuch zu Amazon Interactive Video Service.

So listen Sie alle Tags für eine AWS-Ressource auf (zum Beispiel: Raum)

Im folgenden Beispiel für list-tags-for-resource werden alle Tags für einen angegebenen Ressourcen-ARN (Amazon Resource Name) aufgelistet.

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

Ausgabe:

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

Weitere Informationen finden Sie unter Tags in der API-Referenz zum Amazon Interactive Video Service.

So senden Sie ein Ereignis an einen Raum

Im folgenden Beispiel send-event wird das angegebene Ereignis an den angegebenen Raum gesendet.

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

Ausgabe:

{
    "id": "12345689012"
}

Weitere Informationen finden Sie unter Erste Schritte mit Amazon IVS Chat im Benutzerhandbuch zu Amazon Interactive Video Service.

So fügen Sie Tags für eine AWS Ressource hinzu oder aktualisieren sie (zum Beispiel: Raum)

Im folgenden Beispiel für tag-resource werden Tags für einen angegebenen Ressourcen-ARN (Amazon Resource Name) hinzugefügt oder aktualisiert. Bei Erfolg wird HTTP 200 mit einem leeren Antworttext zurückgegeben.

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

Mit diesem Befehl wird keine Ausgabe zurückgegeben.

Weitere Informationen finden Sie unter Tags in der API-Referenz zum Amazon Interactive Video Service.

So entfernen Sie Tags für eine AWS-Ressource (zum Beispiel: Raum)

Im folgenden Beispiel für untag-resource werden die angegebenen Tags für eine angegebene Ressourcen-ARN (Amazon Resource Name) entfernt. Bei Erfolg wird HTTP 200 mit einem leeren Antworttext zurückgegeben.

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

Mit diesem Befehl wird keine Ausgabe zurückgegeben.

Weitere Informationen finden Sie unter Tags in der API-Referenz zum Amazon Interactive Video Service.

So aktualisieren Sie die Protokollierungskonfiguration eines Raums

Im folgenden Beispiel für update-logging-configuration Beispiel wird eine LoggingConfiguration-Ressource mit den angegebenen Daten aktualisiert.

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"

Ausgabe:

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

Weitere Informationen finden Sie unter Erste Schritte mit Amazon IVS Chat im Benutzerhandbuch zu Amazon Interactive Video Service.

So aktualisieren Sie die Konfiguration eines Raums

Im folgenden Beispiel für update-room wird die Konfiguration des angegebenen Raums mit den angegebenen Daten aktualisiert.

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

Ausgabe:

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

Weitere Informationen finden Sie unter Erste Schritte mit Amazon IVS Chat im Benutzerhandbuch zu Amazon Interactive Video Service.