本文為英文版的機器翻譯版本,如內容有任何歧義或不一致之處,概以英文版為準。
使用 的 Amazon IVS Chat 範例 AWS CLI
下列程式碼範例示範如何搭配 Amazon IVS Chat AWS Command Line Interface 使用 來執行動作和實作常見案例。
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詳細資訊,請參閱 命令參考 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-length256
\ --maximum-message-rate-per-second5
輸出:
{ "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
範例會刪除指定 LoggingConfiguration 的資源ARN。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
範例會中斷指定使用者與指定機房的所有連線。成功時,傳回 200 HTTP 並包含空白回應內文。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
範例取得指定 LoggingConfiguration 資源的相關資訊ARN。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-results10
\ --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 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詳細資訊,請參閱 命令參考 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 Resource Name)。成功時,傳回 200 HTTP 並包含空白回應內文。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 Resource Name) 的指定標籤。成功時,傳回 200 HTTP 並包含空白回應內文。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-length256
\ --maximum-message-rate-per-second5
輸出:
{ "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
-