Exemples d'Amazon IVS Chat utilisant AWS CLI

Pour créer un jeton de chat

L'create-chat-tokenexemple suivant crée un jeton de chat crypté qui est utilisé pour établir une WebSocket connexion individuelle à un salon. Le jeton est valide pendant une minute et une connexion (session) établie avec le jeton est valide pendant la durée spécifiée.

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

Sortie :

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

Pour plus d’informations, consultez Étape 3 : authentifier et autoriser les clients de chat dans le Guide de l’utilisateur d’Amazon Interactive Video Service.

Pour créer une LoggingConfiguration ressource de chat

L'create-logging-configurationexemple suivant crée une LoggingConfiguration ressource qui permet aux clients de stocker et d'enregistrer les messages envoyés.

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

Sortie :

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

Pour plus d’informations, consultez Mise en route avec le chat Amazon IVS dans le Guide de l’utilisateur Amazon Interactive Video Service.

Pour créer une pièce

L’exemple create-room suivant crée une salle.

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

Sortie :

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

Pour plus d’informations, consultez Étape 2 : créer une salle de chat dans le Guide de l’utilisateur d’Amazon Interactive Video Service.

Pour supprimer une LoggingConfiguration ressource de chat

L'delete-logging-configurationexemple suivant supprime la LoggingConfiguration ressource pour l'ARN spécifié.

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

Cette commande ne produit aucune sortie.

Pour plus d’informations, consultez Mise en route avec le chat Amazon IVS dans le Guide de l’utilisateur Amazon Interactive Video Service.

Pour supprimer des messages d’une salle spécifiée

L’exemple delete-message suivant envoie un événement à la salle spécifiée, qui demande aux clients de supprimer le message spécifié, c’est-à-dire de le supprimer de la vue et de le supprimer de l’historique des chats du client.

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

Sortie :

{
    "id": "12345689012"
}

Pour plus d’informations, consultez Mise en route avec le chat Amazon IVS dans le Guide de l’utilisateur Amazon Interactive Video Service.

Pour supprimer une chambre

L’exemple delete-room suivant supprime la salle spécifiée. Les clients connectés sont déconnectés. En cas de réussite, il renvoie HTTP 204 avec un corps de réponse vide.

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

Cette commande ne produit aucune sortie.

Pour plus d’informations, consultez Mise en route avec le chat Amazon IVS dans le Guide de l’utilisateur Amazon Interactive Video Service.

Pour déconnecter un utilisateur d’une salle

L’exemple disconnect-user suivant déconnecte toutes les connexions de l’utilisateur spécifié de la salle spécifiée. En cas de réussite, il renvoie HTTP 200 avec un corps de réponse vide.

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

Cette commande ne produit aucune sortie.

Pour plus d’informations, consultez Mise en route avec le chat Amazon IVS dans le Guide de l’utilisateur Amazon Interactive Video Service.

Pour obtenir des informations sur une LoggingConfiguration ressource

L'get-logging-configurationexemple suivant permet d'obtenir des informations sur la LoggingConfiguration ressource pour l'ARN spécifié.

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

Sortie :

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

Pour plus d’informations, consultez Mise en route avec le chat Amazon IVS dans le Guide de l’utilisateur Amazon Interactive Video Service.

Pour obtenir la salle spécifiée

L’exemple get-room suivant affiche les informations sur la salle spécifiée.

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

Sortie :

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

Pour plus d’informations, consultez Mise en route avec le chat Amazon IVS dans le Guide de l’utilisateur Amazon Interactive Video Service.

Pour obtenir des informations récapitulatives sur toutes les configurations de journalisation pour l'utilisateur dans la AWS région où la demande d'API est traitée

L'list-logging-configurationsexemple suivant répertorie les informations relatives à toutes les LoggingConfiguration ressources destinées à l'utilisateur dans la AWS région où la demande d'API est traitée.

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

Sortie :

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

Pour plus d’informations, consultez Mise en route avec le chat Amazon IVS dans le Guide de l’utilisateur Amazon Interactive Video Service.

Pour obtenir les informations récapitulatives sur toutes vos salles dans la région actuelle

L'list-roomsexemple suivant permet d'obtenir des informations récapitulatives sur toutes les pièces de la AWS région où la demande est traitée. Les résultats sont triés dans l’ordre décroissant updateTime.

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

Sortie :

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

Pour plus d’informations, consultez Mise en route avec le chat Amazon IVS dans le Guide de l’utilisateur Amazon Interactive Video Service.

Pour répertorier tous les tags d'une AWS ressource (par exemple : Room)

L’exemple list-tags-for-resource suivant répertorie toutes les balises pour un ARN (Amazon Resource Name) de ressource spécifié.

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

Sortie :

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

Pour plus d’informations, consultez Ajout de balises dans la Référence des API d’Amazon Interactive Video Service.

Pour envoyer un événement à une salle

L’exemple send-event suivant envoie l’événement donné à la salle spécifiée.

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

Sortie :

{
    "id": "12345689012"
}

Pour plus d’informations, consultez Mise en route avec le chat Amazon IVS dans le Guide de l’utilisateur Amazon Interactive Video Service.

Pour ajouter ou mettre à jour des balises pour une AWS ressource (par exemple : Room)

L’exemple tag-resource suivant ajoute ou met à jour des balises pour un ARN (Amazon Resource Name) de ressource spécifié. En cas de réussite, il renvoie HTTP 200 avec un corps de réponse vide.

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

Cette commande ne produit aucune sortie.

Pour plus d’informations, consultez Ajout de balises dans la Référence des API d’Amazon Interactive Video Service.

Pour supprimer les balises d'une AWS ressource (par exemple : Room)

L’exemple untag-resource suivant supprime les balises spécifiées pour un ARN (Amazon Resource Name) de ressource spécifié. En cas de réussite, il renvoie HTTP 200 avec un corps de réponse vide.

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

Cette commande ne produit aucune sortie.

Pour plus d’informations, consultez Ajout de balises dans la Référence des API d’Amazon Interactive Video Service.

Pour mettre à jour la configuration de journalisation d’une salle

L'update-logging-configurationexemple suivant met à jour une LoggingConfiguration ressource avec les données données.

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"

Sortie :

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

Pour plus d’informations, consultez Mise en route avec le chat Amazon IVS dans le Guide de l’utilisateur Amazon Interactive Video Service.

Pour mettre à jour une configuration de salle

L’exemple update-room suivant met à jour la configuration de la salle spécifiée avec les données fournies.

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

Sortie :

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

Pour plus d’informations, consultez Mise en route avec le chat Amazon IVS dans le Guide de l’utilisateur Amazon Interactive Video Service.