を使用した Amazon IVS Chat の例 AWS CLI - AWS SDK コード例

Doc AWS SDK Examples リポジトリには、他にも SDK の例があります。 AWS GitHub

翻訳は機械翻訳により提供されています。提供された翻訳内容と英語版の間で齟齬、不一致または矛盾がある場合、英語版が優先します。

を使用した Amazon IVS Chat の例 AWS CLI

次のコード例は、Amazon IVS Chat AWS Command Line Interface で を使用してアクションを実行し、一般的なシナリオを実装する方法を示しています。

アクションはより大きなプログラムからのコードの抜粋であり、コンテキスト内で実行する必要があります。アクションは個々のサービス機能を呼び出す方法を示していますが、関連するシナリオやサービス間の例ではアクションのコンテキストが確認できます。

「シナリオ」は、同じサービス内で複数の関数を呼び出して、特定のタスクを実行する方法を示すコード例です。

各例には、 へのリンクが含まれています。このリンクには GitHub、コンテキスト内でコードをセットアップして実行する方法の手順が記載されています。

トピック

アクション

次の例は、create-chat-token を使用する方法を説明しています。

AWS CLI

チャットトークンを作成するには

次のcreate-chat-token例では、ルームへの個々の WebSocket 接続を確立するために使用される暗号化されたチャットトークンを作成します。トークンは 1 分間有効で、トークンで確立された接続 (セッション) は指定された期間有効です。

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

出力:

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

詳細については、「Amazon Interactive Video Service ユーザーガイド」の「ステップ 3: チャットクライアントを認証および承認する」を参照してください。

  • API の詳細については、「 コマンドリファレンスCreateChatToken」の「」を参照してください。 AWS CLI

次の例は、create-logging-configuration を使用する方法を説明しています。

AWS CLI

チャット LoggingConfiguration リソースを作成するには

次のcreate-logging-configuration例では、クライアントが送信されたメッセージを保存および記録できるようにする LoggingConfiguration リソースを作成します。

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

出力:

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

詳細については、「Amazon Interactive Video Service ユーザーガイド」の「Amazon IVS Chat の開始方法」を参照してください。

  • API の詳細については、「 コマンドリファレンスCreateLoggingConfiguration」の「」を参照してください。 AWS CLI

次の例は、create-room を使用する方法を説明しています。

AWS CLI

ルームを作成するには

次のcreate-room例では、新しいルームを作成します。

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

出力:

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

詳細については、「Amazon Interactive Video Service ユーザーガイド」の「ステップ 2: チャットルームを作成する」を参照してください。

  • API の詳細については、「 コマンドリファレンスCreateRoom」の「」を参照してください。 AWS CLI

次の例は、delete-logging-configuration を使用する方法を説明しています。

AWS CLI

チャット LoggingConfiguration リソースを削除するには

次のdelete-logging-configuration例では、指定された ARN LoggingConfiguration のリソースを削除します。

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

このコマンドでは何も出力されません。

詳細については、「Amazon Interactive Video Service ユーザーガイド」の「Amazon IVS Chat の開始方法」を参照してください。

  • API の詳細については、「 コマンドリファレンスDeleteLoggingConfiguration」の「」を参照してください。 AWS CLI

次の例は、delete-message を使用する方法を説明しています。

AWS CLI

指定したルームからメッセージを削除するには

次のdelete-message例では、指定したルームに 均等を送信し、指定したメッセージを削除するようにクライアントに指示します。つまり、表示からレンダリング解除してクライアントのチャット履歴から削除します。

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

出力:

{ "id": "12345689012" }

詳細については、「Amazon Interactive Video Service ユーザーガイド」の「Amazon IVS Chat の開始方法」を参照してください。

  • API の詳細については、「 コマンドリファレンスDeleteMessage」の「」を参照してください。 AWS CLI

次の例は、delete-room を使用する方法を説明しています。

AWS CLI

ルームを削除するには

次のdelete-room例では、指定されたルームを削除します。接続されたクライアントが切断されている。成功すると、空のレスポンス本文を持つ HTTP 204 が返されます。

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

このコマンドでは何も出力されません。

詳細については、「Amazon Interactive Video Service ユーザーガイド」の「Amazon IVS Chat の開始方法」を参照してください。

  • API の詳細については、「 コマンドリファレンスDeleteRoom」の「」を参照してください。 AWS CLI

次の例は、disconnect-user を使用する方法を説明しています。

AWS CLI

ユーザーをルームから切断するには

次のdisconnect-user例では、指定されたユーザーのすべての接続を指定されたルームから切断します。成功すると、空のレスポンス本文を持つ HTTP 200 が返されます。

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

このコマンドでは何も出力されません。

詳細については、「Amazon Interactive Video Service ユーザーガイド」の「Amazon IVS Chat の開始方法」を参照してください。

  • API の詳細については、「 コマンドリファレンスDisconnectUser」の「」を参照してください。 AWS CLI

次の例は、get-logging-configuration を使用する方法を説明しています。

AWS CLI

LoggingConfiguration リソースに関する情報を取得するには

次のget-logging-configuration例では、指定された ARN の LoggingConfiguration リソースに関する情報を取得します。

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

出力:

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

詳細については、「Amazon Interactive Video Service ユーザーガイド」の「Amazon IVS Chat の開始方法」を参照してください。

  • API の詳細については、「 コマンドリファレンスGetLoggingConfiguration」の「」を参照してください。 AWS CLI

次の例は、get-room を使用する方法を説明しています。

AWS CLI

指定されたルームを取得するには

次のget-room例では、指定されたルームに関する情報を取得します。

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

出力:

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

詳細については、「Amazon Interactive Video Service ユーザーガイド」の「Amazon IVS Chat の開始方法」を参照してください。

  • API の詳細については、「 コマンドリファレンスGetRoom」の「」を参照してください。 AWS CLI

次の例は、list-logging-configurations を使用する方法を説明しています。

AWS CLI

API リクエストが処理される AWS リージョンのユーザーのすべてのログ記録設定に関する概要情報を取得するには

次のlist-logging-configurations例では、API リクエストが処理される AWS リージョンのユーザーのすべての LoggingConfiguration リソースに関する情報を一覧表示します。

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

出力:

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

詳細については、「Amazon Interactive Video Service ユーザーガイド」の「Amazon IVS Chat の開始方法」を参照してください。

  • API の詳細については、「 コマンドリファレンスListLoggingConfigurations」の「」を参照してください。 AWS CLI

次の例は、list-rooms を使用する方法を説明しています。

AWS CLI

現在のリージョンのすべてのルームに関する概要情報を取得するには

次のlist-rooms例では、リクエストが処理される AWS リージョン内のすべてのルームに関する概要情報を取得します。結果は updateTime の降順でソートされます。

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

出力:

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

詳細については、「Amazon Interactive Video Service ユーザーガイド」の「Amazon IVS Chat の開始方法」を参照してください。

  • API の詳細については、「 コマンドリファレンスListRooms」の「」を参照してください。 AWS CLI

次の例は、list-tags-for-resource を使用する方法を説明しています。

AWS CLI

AWS リソース (ルームなど) のすべてのタグを一覧表示するには

次のlist-tags-for-resource例では、指定されたリソース ARN (Amazon リソースネーム) のすべてのタグを一覧表示します。

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

出力:

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

詳細については、Amazon Interactive Video Service API リファレンス「タグ付け」を参照してください。

  • API の詳細については、「 コマンドリファレンスListTagsForResource」の「」を参照してください。 AWS CLI

次の例は、send-event を使用する方法を説明しています。

AWS CLI

イベントをルームに送信するには

次のsend-event例では、指定されたイベントを指定されたルームに送信します。

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

出力:

{ "id": "12345689012" }

詳細については、「Amazon Interactive Video Service ユーザーガイド」の「Amazon IVS Chat の開始方法」を参照してください。

  • API の詳細については、「 コマンドリファレンスSendEvent」の「」を参照してください。 AWS CLI

次の例は、tag-resource を使用する方法を説明しています。

AWS CLI

AWS リソース (ルームなど) のタグを追加または更新するには

次のtag-resource例では、指定されたリソース ARN (Amazon リソースネーム) のタグを追加または更新します。成功すると、空のレスポンス本文を持つ HTTP 200 が返されます。

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

このコマンドでは何も出力されません。

詳細については、Amazon Interactive Video Service API リファレンス「タグ付け」を参照してください。

  • API の詳細については、「 コマンドリファレンスTagResource」の「」を参照してください。 AWS CLI

次の例は、untag-resource を使用する方法を説明しています。

AWS CLI

AWS リソース (ルームなど) のタグを削除するには

次のuntag-resource例では、指定されたリソース ARN (Amazon リソースネーム) の指定されたタグを削除します。成功すると、空のレスポンス本文を持つ HTTP 200 が返されます。

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

このコマンドでは何も出力されません。

詳細については、Amazon Interactive Video Service API リファレンス「タグ付け」を参照してください。

  • API の詳細については、「 コマンドリファレンスUntagResource」の「」を参照してください。 AWS CLI

次の例は、update-logging-configuration を使用する方法を説明しています。

AWS CLI

ルームのログ記録設定を更新するには

次のupdate-logging-configuration例では、指定されたデータで LoggingConfiguration リソースを更新します。

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"

出力:

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

詳細については、「Amazon Interactive Video Service ユーザーガイド」の「Amazon IVS Chat の開始方法」を参照してください。

  • API の詳細については、「 コマンドリファレンスUpdateLoggingConfiguration」の「」を参照してください。 AWS CLI

次の例は、update-room を使用する方法を説明しています。

AWS CLI

ルームの設定を更新するには

次のupdate-room例では、指定されたデータで指定されたルームの設定を更新します。

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

出力:

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

詳細については、「Amazon Interactive Video Service ユーザーガイド」の「Amazon IVS Chat の開始方法」を参照してください。

  • API の詳細については、「 コマンドリファレンスUpdateRoom」の「」を参照してください。 AWS CLI