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

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

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

各例には完全なソースコードへのリンクが含まれており、コードの設定方法と実行方法に関する手順を確認できます。

トピック

アクション

アクション

次の例は、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 の詳細については、「AWS CLI コマンドリファレンス」の「CreateChatToken」を参照してください。

次の例は、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 の詳細については、「AWS CLI コマンドリファレンス」の「CreateLoggingConfiguration」を参照してください。

次の例は、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 の詳細については、「AWS CLI コマンドリファレンス」の「CreateRoom」を参照してください。

次の例は、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 の詳細については、「AWS CLI コマンドリファレンス」の「DeleteLoggingConfiguration」を参照してください。

次の例は、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 の詳細については、AWS CLI コマンドリファレンスの「DeleteMessage」を参照してください。

次の例は、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 の詳細については、「AWS CLI コマンドリファレンス」の「DeleteRoom」を参照してください。

次の例は、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 の詳細については、「AWS CLI コマンドリファレンス」の「DisconnectUser」を参照してください。

次の例は、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 の詳細については、「AWS CLI コマンドリファレンス」の「GetLoggingConfiguration」を参照してください。

次の例は、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 の詳細については、「AWS CLI コマンドリファレンス」の「GetRoom」を参照してください。

次の例は、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 の詳細については、「AWS CLI コマンドリファレンス」の「ListLoggingConfigurations」を参照してください。

次の例は、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 の詳細については、「AWS CLI コマンドリファレンス」の「ListRooms」を参照してください。

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

AWS CLI

AWS リソースのすべてのタグを一覧表示するには (例: Room)

次の 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 リファレンス」の「Tagging」を参照してください。

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

次の例は、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 の詳細については、「AWS CLI コマンドリファレンス」の「SendEvent」を参照してください。

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

AWS CLI

AWS リソースのタグを追加または更新するには (例: Room)

次の 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 リファレンス」の「Tagging」を参照してください。

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

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

AWS CLI

AWS リソースのタグを削除するには (例: Room)

次の 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 リファレンス」の「Tagging」を参照してください。

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

次の例は、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 の詳細については、「AWS CLI コマンドリファレンス」の「UpdateLoggingConfiguration」を参照してください。

次の例は、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 の詳細については、「AWS CLI コマンドリファレンス」の「UpdateRoom」を参照してください。

ブラウザで JavaScript が無効になっているか、使用できません。

AWS ドキュメントを使用するには、JavaScript を有効にする必要があります。手順については、使用するブラウザのヘルプページを参照してください。

ドキュメントの表記規則

Amazon IVS

Amazon IVS Real-Time Streaming