Les traductions sont fournies par des outils de traduction automatique. En cas de conflit entre le contenu d'une traduction et celui de la version originale en anglais, la version anglaise prévaudra.
Exemples d'Amazon IVS Chat utilisant AWS CLI
Les exemples de code suivants vous montrent comment effectuer des actions et implémenter des scénarios courants à l' AWS Command Line Interface aide d'Amazon IVS Chat.
Les actions sont des extraits de code de programmes plus larges et doivent être exécutées dans leur contexte. Les actions vous indiquent comment appeler des fonctions de service individuelles, mais vous pouvez les visualiser dans leur contexte dans les scénarios correspondants.
Chaque exemple inclut un lien vers le code source complet, où vous trouverez des instructions sur la façon de configurer et d'exécuter le code en contexte.
Rubriques
Actions
L'exemple de code suivant montre comment utilisercreate-chat-token
.
- AWS CLI
-
Pour créer un jeton de chat
L'
create-chat-token
exemple 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 API plus de détails, voir CreateChatToken
la section Référence des AWS CLI commandes.
-
L'exemple de code suivant montre comment utilisercreate-logging-configuration
.
- AWS CLI
-
Pour créer une LoggingConfiguration ressource de chat
L'
create-logging-configuration
exemple 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 Getting Started with Amazon IVS Chat dans le guide de l'utilisateur d'Amazon Interactive Video Service.
-
Pour API plus de détails, voir CreateLoggingConfiguration
la section Référence des AWS CLI commandes.
-
L'exemple de code suivant montre comment utilisercreate-room
.
- AWS CLI
-
Pour créer une pièce
L'
create-room
exemple suivant crée une nouvelle pièce.aws ivschat create-room \ --name
"test-room-1"
\ --logging-configuration-identifiers"arn:aws:ivschat:us-west-2:123456789012:logging-configuration/ABcdef34ghIJ"
\ --maximum-message-length256
\ --maximum-message-rate-per-second5
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 l'étape 2 : créer un salon de discussion dans le guide de l'utilisateur d'Amazon Interactive Video Service.
-
Pour API plus de détails, voir CreateRoom
la section Référence des AWS CLI commandes.
-
L'exemple de code suivant montre comment utiliserdelete-logging-configuration
.
- AWS CLI
-
Pour supprimer une LoggingConfiguration ressource de chat
L'
delete-logging-configuration
exemple suivant supprime la LoggingConfiguration ressource pour la ressource spécifiéeARN.aws ivschat delete-logging-configuration \ --identifier
"arn:aws:ivschat:us-west-2:123456789012:logging-configuration/ABcdef34ghIJ"
Cette commande ne produit aucun résultat.
Pour plus d'informations, consultez Getting Started with Amazon IVS Chat dans le guide de l'utilisateur d'Amazon Interactive Video Service.
-
Pour API plus de détails, voir DeleteLoggingConfiguration
la section Référence des AWS CLI commandes.
-
L'exemple de code suivant montre comment utiliserdelete-message
.
- AWS CLI
-
Pour supprimer des messages d'une pièce spécifiée
L'
delete-message
exemple 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 discussions 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 Getting Started with Amazon IVS Chat dans le guide de l'utilisateur d'Amazon Interactive Video Service.
-
Pour API plus de détails, voir DeleteMessage
la section Référence des AWS CLI commandes.
-
L'exemple de code suivant montre comment utiliserdelete-room
.
- AWS CLI
-
Pour supprimer une chambre
L'
delete-room
exemple suivant supprime la pièce spécifiée. Les clients connectés sont déconnectés. En cas de succès, elle 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 aucun résultat.
Pour plus d'informations, consultez Getting Started with Amazon IVS Chat dans le guide de l'utilisateur d'Amazon Interactive Video Service.
-
Pour API plus de détails, voir DeleteRoom
la section Référence des AWS CLI commandes.
-
L'exemple de code suivant montre comment utiliserdisconnect-user
.
- AWS CLI
-
Pour déconnecter un utilisateur d'une salle
L'
disconnect-user
exemple suivant déconnecte toutes les connexions de l'utilisateur spécifié à partir de la pièce spécifiée. En cas de succès, 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 aucun résultat.
Pour plus d'informations, consultez Getting Started with Amazon IVS Chat dans le guide de l'utilisateur d'Amazon Interactive Video Service.
-
Pour API plus de détails, voir DisconnectUser
la section Référence des AWS CLI commandes.
-
L'exemple de code suivant montre comment utiliserget-logging-configuration
.
- AWS CLI
-
Pour obtenir des informations sur une LoggingConfiguration ressource
L'
get-logging-configuration
exemple suivant permet d'obtenir des informations sur la LoggingConfiguration ressource spécifiéeARN.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 Getting Started with Amazon IVS Chat dans le guide de l'utilisateur d'Amazon Interactive Video Service.
-
Pour API plus de détails, voir GetLoggingConfiguration
la section Référence des AWS CLI commandes.
-
L'exemple de code suivant montre comment utiliserget-room
.
- AWS CLI
-
Pour obtenir la chambre spécifiée
L'
get-room
exemple suivant permet d'obtenir des informations sur la pièce 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 Getting Started with Amazon IVS Chat dans le guide de l'utilisateur d'Amazon Interactive Video Service.
-
Pour API plus de détails, voir GetRoom
la section Référence des AWS CLI commandes.
-
L'exemple de code suivant montre comment utiliserlist-logging-configurations
.
- AWS CLI
-
Pour obtenir des informations récapitulatives sur toutes les configurations de journalisation pour l'utilisateur dans la AWS région où la API demande est traitée
L'
list-logging-configurations
exemple suivant répertorie les informations relatives à toutes les LoggingConfiguration ressources destinées à l'utilisateur dans la AWS région où la API demande 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 Getting Started with Amazon IVS Chat dans le guide de l'utilisateur d'Amazon Interactive Video Service.
-
Pour API plus de détails, voir ListLoggingConfigurations
la section Référence des AWS CLI commandes.
-
L'exemple de code suivant montre comment utiliserlist-rooms
.
- AWS CLI
-
Pour obtenir des informations récapitulatives sur toutes vos chambres dans la région actuelle
L'
list-rooms
exemple 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 par ordre décroissant de. updateTimeaws ivschat list-rooms \ --logging-configuration-identifier
"arn:aws:ivschat:us-west-2:123456789012:logging-configuration/ABcdef34ghIJ"
\ --max-results10
\ --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 Getting Started with Amazon IVS Chat dans le guide de l'utilisateur d'Amazon Interactive Video Service.
-
Pour API plus de détails, voir ListRooms
la section Référence des AWS CLI commandes.
-
L'exemple de code suivant montre comment utiliserlist-tags-for-resource
.
- AWS CLI
-
Pour répertorier tous les tags d'une AWS ressource (par exemple : Room)
L'
list-tags-for-resource
exemple suivant répertorie toutes les balises pour une ressource spécifiée ARN (Amazon Resource Name).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 la section Balisage dans le manuel Amazon Interactive Video Service API Reference.
-
Pour API plus de détails, voir ListTagsForResource
la section Référence des AWS CLI commandes.
-
L'exemple de code suivant montre comment utilisersend-event
.
- AWS CLI
-
Pour envoyer un événement dans une salle
L'
send-event
exemple 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 Getting Started with Amazon IVS Chat dans le guide de l'utilisateur d'Amazon Interactive Video Service.
-
Pour API plus de détails, voir SendEvent
la section Référence des AWS CLI commandes.
-
L'exemple de code suivant montre comment utilisertag-resource
.
- AWS CLI
-
Pour ajouter ou mettre à jour des balises pour une AWS ressource (par exemple : Room)
L'
tag-resource
exemple suivant ajoute ou met à jour des balises pour une ressource spécifiée ARN (Amazon Resource Name). En cas de succès, 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 aucun résultat.
Pour plus d'informations, consultez la section Balisage dans le manuel Amazon Interactive Video Service API Reference.
-
Pour API plus de détails, voir TagResource
la section Référence des AWS CLI commandes.
-
L'exemple de code suivant montre comment utiliseruntag-resource
.
- AWS CLI
-
Pour supprimer les balises d'une AWS ressource (par exemple : Room)
L'
untag-resource
exemple suivant supprime les balises spécifiées pour une ressource spécifiée ARN (Amazon Resource Name). En cas de succès, 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 aucun résultat.
Pour plus d'informations, consultez la section Balisage dans le manuel Amazon Interactive Video Service API Reference.
-
Pour API plus de détails, voir UntagResource
la section Référence des AWS CLI commandes.
-
L'exemple de code suivant montre comment utiliserupdate-logging-configuration
.
- AWS CLI
-
Pour mettre à jour la configuration de journalisation d'une salle
L'
update-logging-configuration
exemple 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 Getting Started with Amazon IVS Chat dans le guide de l'utilisateur d'Amazon Interactive Video Service.
-
Pour API plus de détails, voir UpdateLoggingConfiguration
la section Référence des AWS CLI commandes.
-
L'exemple de code suivant montre comment utiliserupdate-room
.
- AWS CLI
-
Pour mettre à jour la configuration d'une pièce
L'
update-room
exemple suivant met à jour la configuration de la pièce spécifiée avec les données données.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-length256
\ --maximum-message-rate-per-second5
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 Getting Started with Amazon IVS Chat dans le guide de l'utilisateur d'Amazon Interactive Video Service.
-
Pour API plus de détails, voir UpdateRoom
la section Référence des AWS CLI commandes.
-