使用的 Amazon IVS 聊天功能範例 AWS CLI

焦點模式

使用的 Amazon IVS 聊天功能範例 AWS CLI - AWS SDK 程式碼範例

動作

下列程式碼範例示範如何使用 AWS Command Line Interface 搭配 Amazon IVS Chat 來執行動作和實作常見案例。

Actions 是大型程式的程式碼摘錄，必須在內容中執行。雖然動作會告訴您如何呼叫個別服務函數，但您可以在其相關情境中查看內容中的動作。

每個範例都包含完整原始程式碼的連結，您可以在其中找到如何在內容中設定和執行程式碼的指示。

主題

動作

動作

下列程式碼範例示範如何使用 create-chat-token。

AWS CLI

建立聊天字符

下列create-chat-token範例會建立加密的聊天字符，用於建立與聊天室的個別 WebSocket 連線。字符有效期為一分鐘，而使用字符建立的連線（工作階段）在指定的持續時間內有效。


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-chat-token

下列程式碼範例示範如何使用 create-chat-token。

AWS CLI

建立聊天字符


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 聊天功能入門。

如需 API 詳細資訊，請參閱《 AWS CLI 命令參考》中的 CreateLoggingConfiguration。

create-logging-configuration

下列程式碼範例示範如何使用 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 聊天功能入門。

如需 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。

create-room

下列程式碼範例示範如何使用 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 聊天功能入門。

如需 API 詳細資訊，請參閱《 AWS CLI 命令參考》中的 DeleteLoggingConfiguration。

delete-logging-configuration

下列程式碼範例示範如何使用 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 聊天功能入門。

如需 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 聊天功能入門。

如需 API 詳細資訊，請參閱《 AWS CLI 命令參考》中的 DeleteMessage。

delete-message

下列程式碼範例示範如何使用 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 聊天功能入門。

如需 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 聊天功能入門。

如需 API 詳細資訊，請參閱《 AWS CLI 命令參考》中的 DeleteRoom。

delete-room

下列程式碼範例示範如何使用 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 聊天功能入門。

如需 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 聊天功能入門。

如需 API 詳細資訊，請參閱《 AWS CLI 命令參考》中的 DisconnectUser。

disconnect-user

下列程式碼範例示範如何使用 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 聊天功能入門。

如需 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 聊天功能入門。

如需 API 詳細資訊，請參閱《 AWS CLI 命令參考》中的 GetLoggingConfiguration。

get-logging-configuration

下列程式碼範例示範如何使用 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 聊天功能入門。

如需 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 聊天功能入門。

如需 API 詳細資訊，請參閱《 AWS CLI 命令參考》中的 GetRoom。

get-room

下列程式碼範例示範如何使用 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 聊天功能入門。

如需 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 聊天功能入門。

如需 API 詳細資訊，請參閱《 AWS CLI 命令參考》中的 ListLoggingConfigurations。

list-logging-configurations

下列程式碼範例示範如何使用 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 聊天功能入門。

如需 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 聊天功能入門。

如需 API 詳細資訊，請參閱《 AWS CLI 命令參考》中的 ListRooms。

list-rooms

下列程式碼範例示範如何使用 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 聊天功能入門。

如需 API 詳細資訊，請參閱《 AWS CLI 命令參考》中的 ListRooms。

下列程式碼範例示範如何使用 list-tags-for-resource。

AWS CLI

列出 AWS 資源的所有標籤（例如：房間）

下列list-tags-for-resource範例列出指定資源 ARN (Amazon Resource Name) 的所有標籤。


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 詳細資訊，請參閱《AWS CLI 命令參考》中的 ListTagsForResource。

list-tags-for-resource

下列程式碼範例示範如何使用 list-tags-for-resource。

AWS CLI

列出 AWS 資源的所有標籤（例如：房間）

下列list-tags-for-resource範例列出指定資源 ARN (Amazon Resource Name) 的所有標籤。


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 詳細資訊，請參閱《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 聊天功能入門。

如需 API 詳細資訊，請參閱《 AWS CLI 命令參考》中的 SendEvent。

send-event

下列程式碼範例示範如何使用 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 聊天功能入門。

如需 API 詳細資訊，請參閱《 AWS CLI 命令參考》中的 SendEvent。

下列程式碼範例示範如何使用 tag-resource。

AWS CLI

新增或更新 AWS 資源的標籤（例如：房間）

下列tag-resource範例會新增或更新指定資源 ARN (Amazon Resource Name) 的標籤。成功時，它會傳回具有空白回應內文的 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 詳細資訊，請參閱《AWS CLI 命令參考》中的 TagResource。

tag-resource

下列程式碼範例示範如何使用 tag-resource。

AWS CLI

新增或更新 AWS 資源的標籤（例如：房間）

下列tag-resource範例會新增或更新指定資源 ARN (Amazon Resource Name) 的標籤。成功時，它會傳回具有空白回應內文的 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 詳細資訊，請參閱《AWS CLI 命令參考》中的 TagResource。

下列程式碼範例示範如何使用 untag-resource。

AWS CLI

移除 AWS 資源的標籤（例如：房間）

下列untag-resource範例會移除指定資源 ARN (Amazon Resource Name) 的指定標籤。成功時，它會傳回具有空白回應內文的 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 詳細資訊，請參閱《AWS CLI 命令參考》中的 UntagResource。

untag-resource

下列程式碼範例示範如何使用 untag-resource。

AWS CLI

移除 AWS 資源的標籤（例如：房間）

下列untag-resource範例會移除指定資源 ARN (Amazon Resource Name) 的指定標籤。成功時，它會傳回具有空白回應內文的 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 詳細資訊，請參閱《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 聊天功能入門。

如需 API 詳細資訊，請參閱《 AWS CLI 命令參考》中的 UpdateLoggingConfiguration。

update-logging-configuration

下列程式碼範例示範如何使用 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 聊天功能入門。

如需 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 聊天功能入門。

如需 API 詳細資訊，請參閱《 AWS CLI 命令參考》中的 UpdateRoom。

update-room

下列程式碼範例示範如何使用 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 聊天功能入門。

如需 API 詳細資訊，請參閱《 AWS CLI 命令參考》中的 UpdateRoom。

您的瀏覽器已停用或無法使用 Javascript。

您必須啟用 Javascript，才能使用 AWS 文件。請參閱您的瀏覽器說明頁以取得說明。

文件慣用形式

Amazon IVS

Amazon IVS 即時串流

下一個主題：

Amazon IVS 即時串流

上一個主題：

Amazon IVS

需要協助？

在本頁面

此頁面是否有幫助？

提供意見回饋

隱私權網站條款 Cookie 偏好設定

選取您的 Cookie 偏好設定

自訂 Cookie 偏好設定

必要

效能

功能

廣告

無法儲存 Cookie 偏好設定

使用的 Amazon IVS 聊天功能範例 AWS CLI

主題

動作

create-chat-token

create-logging-configuration

create-room

delete-logging-configuration

delete-message

delete-room

disconnect-user

get-logging-configuration

get-room

list-logging-configurations

list-rooms

list-tags-for-resource

send-event

tag-resource

untag-resource

update-logging-configuration

update-room

下一個主題：

上一個主題：

需要協助？

在本頁面

此頁面是否有幫助？

選取您的 Cookie 偏好設定

使用 的 Amazon IVS 聊天功能範例 AWS CLI

主題

動作

create-chat-token

create-logging-configuration

create-room

delete-logging-configuration

delete-message

delete-room

disconnect-user

get-logging-configuration

get-room

list-logging-configurations

list-rooms

list-tags-for-resource

send-event

tag-resource

untag-resource

update-logging-configuration

update-room

下一個主題：

上一個主題：

需要協助？

在本頁面

此頁面是否有幫助？

使用的 Amazon IVS 聊天功能範例 AWS CLI