Amazon IVS Chat-Beispiele mit AWS CLI

Um ein Chat-Token zu erstellen

Im folgenden create-chat-token Beispiel wird ein verschlüsseltes Chat-Token erstellt, das verwendet wird, um eine individuelle WebSocket Verbindung zu einem Raum herzustellen. 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: Chat-Clients authentifizieren und autorisieren im Amazon Interactive Video Service-Benutzerhandbuch.

Um eine LoggingConfiguration Chat-Ressource zu erstellen

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 Amazon Interactive Video Service-Benutzerhandbuch.

Um einen Raum zu erstellen

Das folgende create-room Beispiel erstellt einen neuen Raum.

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: Einen Chatroom erstellen im Amazon Interactive Video Service-Benutzerhandbuch.

Um eine LoggingConfiguration Chat-Ressource zu löschen

Im folgenden delete-logging-configuration Beispiel 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 Amazon Interactive Video Service-Benutzerhandbuch.

Um Nachrichten aus einem bestimmten Raum zu löschen

Im folgenden delete-message Beispiel 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 rückgängig zu machen 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 Amazon Interactive Video Service-Benutzerhandbuch.

Um einen Raum zu löschen

Im folgenden delete-room Beispiel wird der angegebene Raum gelöscht. Verbundene Clients sind getrennt. Bei Erfolg gibt es HTTP 204 mit einem leeren Antworttext zurück.

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 Amazon Interactive Video Service-Benutzerhandbuch.

Um einen Benutzer von einem Raum zu trennen

Im folgenden disconnect-user Beispiel werden alle Verbindungen für den angegebenen Benutzer mit dem 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 Amazon Interactive Video Service-Benutzerhandbuch.

Um Informationen über eine LoggingConfiguration Ressource zu erhalten

Im folgenden get-logging-configuration Beispiel werden Informationen über die 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 Amazon Interactive Video Service-Benutzerhandbuch.

Um das angegebene Zimmer zu erhalten

Im folgenden get-room Beispiel werden Informationen über den 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 Amazon Interactive Video Service-Benutzerhandbuch.

Um zusammenfassende Informationen zu allen Protokollierungskonfigurationen für den Benutzer in der AWS Region zu erhalten, in der die API-Anfrage 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 Amazon Interactive Video Service-Benutzerhandbuch.

Um zusammenfassende Informationen zu all Ihren Zimmern in der aktuellen Region zu erhalten

Im folgenden list-rooms Beispiel werden zusammenfassende Informationen zu allen Räumen in der AWS Region abgerufen, in der die Anfrage bearbeitet wird. Die Ergebnisse werden 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 Amazon Interactive Video Service-Benutzerhandbuch.

Um alle Tags für eine AWS Ressource aufzulisten (zum Beispiel: Raum)

Das folgende list-tags-for-resource Beispiel listet alle Tags für einen angegebenen Ressourcen-ARN (Amazon Resource Name) auf.

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 Tagging in der Amazon Interactive Video Service API-Referenz.

Um ein Ereignis in einen Raum zu senden

Im folgenden send-event Beispiel wird das angegebene Ereignis in 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 Amazon Interactive Video Service-Benutzerhandbuch.

Um Tags für eine AWS Ressource hinzuzufügen oder zu aktualisieren (zum Beispiel: Raum)

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

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 Tagging in der Amazon Interactive Video Service API-Referenz.

Um Tags für eine AWS Ressource zu entfernen (zum Beispiel: Raum)

Im folgenden untag-resource Beispiel werden die angegebenen Tags für einen angegebenen Ressourcen-ARN (Amazon Resource Name) entfernt. Bei Erfolg gibt es HTTP 200 mit einem leeren Antworttext zurück.

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 Tagging in der Amazon Interactive Video Service API-Referenz.

Um die Logging-Konfiguration eines Raums zu aktualisieren

Das folgende update-logging-configuration Beispiel aktualisiert eine LoggingConfiguration Ressource mit den angegebenen Daten.

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 Amazon Interactive Video Service-Benutzerhandbuch.

Um die Konfiguration eines Raums zu aktualisieren

Das folgende update-room Beispiel aktualisiert die Konfiguration des angegebenen Raums mit den angegebenen Daten.

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 Amazon Interactive Video Service-Benutzerhandbuch.