使用 的 Amazon Chime 範例 AWS CLI - AWS Command Line Interface

本文為英文版的機器翻譯版本,如內容有任何歧義或不一致之處,概以英文版為準。

使用 的 Amazon Chime 範例 AWS CLI

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

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

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

主題

動作

下列程式碼範例示範如何使用 associate-phone-number-with-user

AWS CLI

將電話號碼與使用者建立關聯

下列associate-phone-number-with-user範例會將指定的電話號碼與使用者建立關聯。

aws chime associate-phone-number-with-user \ --account-id 12a3456b-7c89-012d-3456-78901e23fg45 \ --user-id 1ab2345c-67de-8901-f23g-45h678901j2k \ --e164-phone-number "+12065550100"

此命令不會產生輸出。

如需詳細資訊,請參閱 Amazon Chime 管理指南 中的管理使用者電話號碼

下列程式碼範例示範如何使用 associate-phone-numbers-with-voice-connector-group

AWS CLI

將電話號碼與 Amazon Chime Voice Connector 群組建立關聯

下列associate-phone-numbers-with-voice-connector-group範例會將指定的電話號碼與 Amazon Chime Voice Connector 群組建立關聯。

aws chime associate-phone-numbers-with-voice-connector-group \ --voice-connector-group-id 123a456b-c7d8-90e1-fg23-4h567jkl8901 \ --e164-phone-numbers "+12065550100" "+12065550101" \ --force-associate

輸出:

{ "PhoneNumberErrors": [] }

如需詳細資訊,請參閱Amazon Chime 管理指南中的使用 Amazon Chime Voice Connector 群組

下列程式碼範例示範如何使用 associate-phone-numbers-with-voice-connector

AWS CLI

將電話號碼與 Amazon Chime Voice Connector 建立關聯

下列associate-phone-numbers-with-voice-connector範例會將指定的電話號碼與 Amazon Chime Voice Connector 建立關聯。

aws chime associate-phone-numbers-with-voice-connector \ --voice-connector-id abcdef1ghij2klmno3pqr4 \ --e164-phone-numbers "+12065550100" "+12065550101" --force-associate

輸出:

{ "PhoneNumberErrors": [] }

如需詳細資訊,請參閱Amazon Chime 管理指南中的使用 Amazon Chime Voice Connectors

下列程式碼範例示範如何使用 associate-signin-delegate-groups-with-account

AWS CLI

建立登入委派群組的關聯

下列associate-signin-delegate-groups-with-account範例會將指定的登入委派群組與指定的 Amazon Chime 帳戶建立關聯。

aws chime associate-signin-delegate-groups-with-account \ --account-id 12a3456b-7c89-012d-3456-78901e23fg45 \ --signin-delegate-groups GroupName=my_users

此命令不會產生輸出。

如需詳細資訊,請參閱 Amazon Chime 管理指南 中的管理使用者存取和許可

下列程式碼範例示範如何使用 batch-create-room-membership

AWS CLI

若要建立多個房間成員資格

下列batch-create-room-membership範例會將多個使用者新增至聊天室,作為聊天室成員。它也會將管理員和成員角色指派給使用者。

aws chime batch-create-room-membership \ --account-id 12a3456b-7c89-012d-3456-78901e23fg45 \ --room-id abcd1e2d-3e45-6789-01f2-3g45h67i890j \ --membership-item-list "MemberId=1ab2345c-67de-8901-f23g-45h678901j2k,Role=Administrator" "MemberId=2ab2345c-67de-8901-f23g-45h678901j2k,Role=Member"

輸出:

{ "ResponseMetadata": { "RequestId": "169ba401-d886-475f-8b3f-e01eac6fadfb", "HTTPStatusCode": 201, "HTTPHeaders": { "x-amzn-requestid": "169ba401-d886-475f-8b3f-e01eac6fadfb", "content-type": "application/json", "content-length": "13", "date": "Mon, 02 Dec 2019 22:46:58 GMT", "connection": "keep-alive" }, "RetryAttempts": 0 }, "Errors": [] }

如需詳細資訊,請參閱Amazon Chime 使用者指南中的建立聊天室

下列程式碼範例示範如何使用 batch-delete-phone-number

AWS CLI

若要刪除多個電話號碼

下列batch-delete-phone-number範例會刪除所有指定的電話號碼。

aws chime batch-delete-phone-number \ --phone-number-ids "%2B12065550100" "%2B12065550101"

此命令不會產生輸出。輸出:

{ "PhoneNumberErrors": [] }

如需詳細資訊,請參閱Amazon Chime 管理指南中的使用電話號碼

下列程式碼範例示範如何使用 batch-suspend-user

AWS CLI

暫停多個使用者

下列batch-suspend-user範例會暫停列出的使用者來自指定的 Amazon Chime 帳戶。

aws chime batch-suspend-user \ --account-id a1b2c3d4-5678-90ab-cdef-11111EXAMPLE \ --user-id-list "a1b2c3d4-5678-90ab-cdef-22222EXAMPLE" "a1b2c3d4-5678-90ab-cdef-33333EXAMPLE" "a1b2c3d4-5678-90ab-cdef-44444EXAMPLE"

輸出:

{ "UserErrors": [] }
  • 如需API詳細資訊,請參閱 命令參考 BatchSuspendUser中的 。 AWS CLI

下列程式碼範例示範如何使用 batch-unsuspend-user

AWS CLI

若要取消暫停多個使用者

下列batch-unsuspend-user範例會移除指定 Amazon Chime 帳戶上列出的使用者之前的任何暫停。

aws chime batch-unsuspend-user \ --account-id a1b2c3d4-5678-90ab-cdef-11111EXAMPLE \ --user-id-list "a1b2c3d4-5678-90ab-cdef-22222EXAMPLE" "a1b2c3d4-5678-90ab-cdef-33333EXAMPLE" "a1b2c3d4-5678-90ab-cdef-44444EXAMPLE"

輸出:

{ "UserErrors": [] }

下列程式碼範例示範如何使用 batch-update-phone-number

AWS CLI

同時更新數個電話號碼產品類型

下列batch-update-phone-number範例會更新所有指定電話號碼的產品類型。

aws chime batch-update-phone-number \ --update-phone-number-request-items PhoneNumberId=%2B12065550100,ProductType=BusinessCalling PhoneNumberId=%2B12065550101,ProductType=BusinessCalling

輸出:

{ "PhoneNumberErrors": [] }

若要同時更新數個電話號碼呼叫名稱

下列batch-update-phone-number範例會更新所有指定電話號碼的呼叫名稱。

aws chime batch-update-phone-number \ --update-phone-number-request-items PhoneNumberId=%2B14013143874,CallingName=phonenumber1 PhoneNumberId=%2B14013144061,CallingName=phonenumber2

輸出:

{ "PhoneNumberErrors": [] }

如需詳細資訊,請參閱Amazon Chime 管理指南中的使用電話號碼

下列程式碼範例示範如何使用 batch-update-user

AWS CLI

在單一命令中更新多個使用者

下列batch-update-user範例會LicenseType為指定 Amazon Chime 帳戶中列出的每個使用者更新 。

aws chime batch-update-user \ --account-id a1b2c3d4-5678-90ab-cdef-11111EXAMPLE --update-user-request-items "UserId=a1b2c3d4-5678-90ab-cdef-22222EXAMPLE,LicenseType=Basic" "UserId=a1b2c3d4-5678-90ab-cdef-33333EXAMPLE,LicenseType=Basic"

輸出:

{ "UserErrors": [] }
  • 如需API詳細資訊,請參閱 命令參考 BatchUpdateUser中的 。 AWS CLI

下列程式碼範例示範如何使用 create-account

AWS CLI

建立帳戶

下列create-account範例會在管理員的帳戶下建立 Amazon Chime AWS 帳戶。

aws chime create-account \ --name MyChimeAccount

輸出:

{ "Account": { "AwsAccountId": "111122223333", "AccountId": "a1b2c3d4-5678-90ab-cdef-11111EXAMPLE", "Name": "MyChimeAccount", "AccountType": "Team", "CreatedTimestamp": "2019-01-04T17:11:22.003Z", "DefaultLicense": "Pro", "SupportedLicenses": [ "Basic", "Pro" ], "SigninDelegateGroups": [ { "GroupName": "myGroup" }, ] } }

如需詳細資訊,請參閱 Amazon Chime 管理指南 中的入門

  • 如需API詳細資訊,請參閱 命令參考 CreateAccount中的 。 AWS CLI

下列程式碼範例示範如何使用 create-bot

AWS CLI

建立 Amazon Chime 機器人

下列create-bot範例會為指定的 Amazon Chime Enterprise 帳戶建立機器人。

aws chime create-bot \ --account-id 12a3456b-7c89-012d-3456-78901e23fg45 \ --display-name "myBot" \ --domain "example.com"

輸出:

{ "Bot": { "BotId": "123abcd4-5ef6-789g-0h12-34j56789012k", "UserId": "123abcd4-5ef6-789g-0h12-34j56789012k", "DisplayName": "myBot (Bot)", "BotType": "ChatBot", "Disabled": false, "CreatedTimestamp": "2019-09-09T18:05:56.749Z", "UpdatedTimestamp": "2019-09-09T18:05:56.749Z", "BotEmail": "myBot-chimebot@example.com", "SecurityToken": "wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY" } }

如需詳細資訊,請參閱Amazon Chime 開發人員指南中的將聊天機器人與 Amazon Chime 整合

  • 如需API詳細資訊,請參閱 命令參考 CreateBot中的 。 AWS CLI

下列程式碼範例示範如何使用 create-phone-number-order

AWS CLI

建立電話號碼順序

下列create-phone-number-order範例會為指定的電話號碼建立電話號碼順序。

aws chime create-phone-number-order \ --product-type VoiceConnector \ --e164-phone-numbers "+12065550100" "+12065550101" "+12065550102"

輸出:

{ "PhoneNumberOrder": { "PhoneNumberOrderId": "abc12345-de67-89f0-123g-h45i678j9012", "ProductType": "VoiceConnector", "Status": "Processing", "OrderedPhoneNumbers": [ { "E164PhoneNumber": "+12065550100", "Status": "Processing" }, { "E164PhoneNumber": "+12065550101", "Status": "Processing" }, { "E164PhoneNumber": "+12065550102", "Status": "Processing" } ], "CreatedTimestamp": "2019-08-09T21:35:21.427Z", "UpdatedTimestamp": "2019-08-09T21:35:22.408Z" } }

如需詳細資訊,請參閱Amazon Chime 管理指南中的使用電話號碼

下列程式碼範例示範如何使用 create-proxy-session

AWS CLI

建立代理工作階段

下列create-proxy-session範例會建立具有語音和SMS功能的代理工作階段。

aws chime create-proxy-session \ --voice-connector-id abcdef1ghij2klmno3pqr4 \ --participant-phone-numbers "+14015550101" "+12065550100" \ --capabilities "Voice" "SMS"

輸出:

{ "ProxySession": { "VoiceConnectorId": "abcdef1ghij2klmno3pqr4", "ProxySessionId": "123a4bc5-67d8-901e-2f3g-h4ghjk56789l", "Status": "Open", "ExpiryMinutes": 60, "Capabilities": [ "SMS", "Voice" ], "CreatedTimestamp": "2020-04-15T16:10:10.288Z", "UpdatedTimestamp": "2020-04-15T16:10:10.288Z", "Participants": [ { "PhoneNumber": "+12065550100", "ProxyPhoneNumber": "+19135550199" }, { "PhoneNumber": "+14015550101", "ProxyPhoneNumber": "+19135550199" } ] } }

如需詳細資訊,請參閱 Amazon Chime 開發人員指南 中的 Proxy Phone Sessions

下列程式碼範例示範如何使用 create-room-membership

AWS CLI

若要建立房間成員資格

下列create-room-membership範例會將指定的使用者新增至聊天室,做為聊天室成員。

aws chime create-room-membership \ --account-id 12a3456b-7c89-012d-3456-78901e23fg45 \ --room-id abcd1e2d-3e45-6789-01f2-3g45h67i890j \ --member-id 1ab2345c-67de-8901-f23g-45h678901j2k

輸出:

{ "RoomMembership": { "RoomId": "abcd1e2d-3e45-6789-01f2-3g45h67i890j", "Member": { "MemberId": "1ab2345c-67de-8901-f23g-45h678901j2k", "MemberType": "User", "Email": "janed@example.com", "FullName": "Jane Doe", "AccountId": "12a3456b-7c89-012d-3456-78901e23fg45" }, "Role": "Member", "InvitedBy": "arn:aws:iam::111122223333:user/alejandro", "UpdatedTimestamp": "2019-12-02T22:36:41.969Z" } }

如需詳細資訊,請參閱Amazon Chime 使用者指南中的建立聊天室

下列程式碼範例示範如何使用 create-room

AWS CLI

若要建立聊天室

下列create-room範例會為指定的 Amazon Chime 帳戶建立聊天室。

aws chime create-room \ --account-id 12a3456b-7c89-012d-3456-78901e23fg45 \ --name chatRoom

輸出:

{ "Room": { "RoomId": "abcd1e2d-3e45-6789-01f2-3g45h67i890j", "Name": "chatRoom", "AccountId": "12a3456b-7c89-012d-3456-78901e23fg45", "CreatedBy": "arn:aws:iam::111122223333:user/alejandro", "CreatedTimestamp": "2019-12-02T22:29:31.549Z", "UpdatedTimestamp": "2019-12-02T22:29:31.549Z" } }

如需詳細資訊,請參閱Amazon Chime 使用者指南中的建立聊天室

  • 如需API詳細資訊,請參閱 命令參考 CreateRoom中的 。 AWS CLI

下列程式碼範例示範如何使用 create-user

AWS CLI

為共用裝置建立使用者設定檔

下列create-user範例會為指定的電子郵件地址建立共用裝置設定檔。

aws chime create-user \ --account-id 12a3456b-7c89-012d-3456-78901e23fg45 \ --email roomdevice@example.com \ --user-type SharedDevice

輸出:

{ "User": { "UserId": "1ab2345c-67de-8901-f23g-45h678901j2k", "AccountId": "12a3456b-7c89-012d-3456-78901e23fg45", "PrimaryEmail": "roomdevice@example.com", "DisplayName": "Room Device", "LicenseType": "Pro", "UserType": "SharedDevice", "UserRegistrationStatus": "Registered", "RegisteredOn": "2020-01-15T22:38:09.806Z", "AlexaForBusinessMetadata": { "IsAlexaForBusinessEnabled": false } } }

如需詳細資訊,請參閱 Amazon Chime 管理指南 中的準備設定

  • 如需API詳細資訊,請參閱 命令參考 CreateUser中的 。 AWS CLI

下列程式碼範例示範如何使用 create-voice-connector-group

AWS CLI

若要建立 Amazon Chime Voice Connector 群組

下列create-voice-connector-group範例會建立包含指定 Amazon Chime Voice Connector 的 Amazon Chime Voice Connector 群組。

aws chime create-voice-connector-group \ --name myGroup \ --voice-connector-items VoiceConnectorId=abcdef1ghij2klmno3pqr4,Priority=2

輸出:

{ "VoiceConnectorGroup": { "VoiceConnectorGroupId": "123a456b-c7d8-90e1-fg23-4h567jkl8901", "Name": "myGroup", "VoiceConnectorItems": [], "CreatedTimestamp": "2019-09-18T16:38:34.734Z", "UpdatedTimestamp": "2019-09-18T16:38:34.734Z" } }

如需詳細資訊,請參閱Amazon Chime 管理指南中的使用 Amazon Chime Voice Connector 群組

下列程式碼範例示範如何使用 create-voice-connector

AWS CLI

若要建立 Amazon Chime Voice Connector

下列create-voice-connector範例會在指定 AWS 區域中建立 Amazon Chime Voice Connector,並啟用加密。

aws chime create-voice-connector \ --name newVoiceConnector \ --aws-region us-west-2 \ --require-encryption

輸出:

{ "VoiceConnector": { "VoiceConnectorId": "abcdef1ghij2klmno3pqr4", "AwsRegion": "us-west-2", "Name": "newVoiceConnector", "OutboundHostName": "abcdef1ghij2klmno3pqr4.voiceconnector.chime.aws", "RequireEncryption": true, "CreatedTimestamp": "2019-09-18T20:34:01.352Z", "UpdatedTimestamp": "2019-09-18T20:34:01.352Z" } }

如需詳細資訊,請參閱Amazon Chime 管理指南中的使用 Amazon Chime Voice Connectors

下列程式碼範例示範如何使用 delete-account

AWS CLI

刪除帳戶

下列delete-account範例會刪除指定的帳戶。

aws chime delete-account --account-id a1b2c3d4-5678-90ab-cdef-11111EXAMPLE

此命令不會產生輸出。

如需詳細資訊,請參閱 Amazon Chime 管理指南 中的刪除您的帳戶

  • 如需API詳細資訊,請參閱 命令參考 DeleteAccount中的 。 AWS CLI

下列程式碼範例示範如何使用 delete-phone-number

AWS CLI

刪除電話號碼

下列delete-phone-number範例會將指定的電話號碼移至刪除佇列。

aws chime delete-phone-number \ --phone-number-id "+12065550100"

此命令不會產生輸出。

如需詳細資訊,請參閱Amazon Chime 管理指南中的使用電話號碼

下列程式碼範例示範如何使用 delete-proxy-session

AWS CLI

若要刪除代理工作階段

下列delete-proxy-session範例會刪除指定的代理工作階段。

aws chime delete-proxy-session \ --voice-connector-id abcdef1ghij2klmno3pqr4 \ --proxy-session-id 123a4bc5-67d8-901e-2f3g-h4ghjk56789l

此命令不會產生輸出。

如需詳細資訊,請參閱 Amazon Chime 開發人員指南 中的 Proxy Phone Sessions

下列程式碼範例示範如何使用 delete-room-membership

AWS CLI

移除使用者作為聊天室的成員

下列delete-room-membership範例會從指定的聊天室移除指定的成員。

aws chime delete-room-membership \ --account-id 12a3456b-7c89-012d-3456-78901e23fg45 \ --room-id abcd1e2d-3e45-6789-01f2-3g45h67i890j \ --member-id 1ab2345c-67de-8901-f23g-45h678901j2k

此命令不會產生輸出。

如需詳細資訊,請參閱Amazon Chime 使用者指南中的建立聊天室

下列程式碼範例示範如何使用 delete-room

AWS CLI

若要刪除聊天室

下列delete-room範例會刪除指定的聊天室,並移除聊天室成員資格。

aws chime delete-room \ --account-id 12a3456b-7c89-012d-3456-78901e23fg45 \ --room-id abcd1e2d-3e45-6789-01f2-3g45h67i890j

此命令不會產生輸出。

如需詳細資訊,請參閱Amazon Chime 使用者指南中的建立聊天室

  • 如需API詳細資訊,請參閱 命令參考 DeleteRoom中的 。 AWS CLI

下列程式碼範例示範如何使用 delete-voice-connector-group

AWS CLI

標題

下列delete-voice-connector-group範例會刪除指定的 Amazon Chime Voice Connector 群組。

aws chime delete-voice-connector-group \ --voice-connector-group-id 123a456b-c7d8-90e1-fg23-4h567jkl8901

此命令不會產生輸出。

如需詳細資訊,請參閱Amazon Chime 管理指南中的使用 Amazon Chime Voice Connector 群組

下列程式碼範例示範如何使用 delete-voice-connector-origination

AWS CLI

若要刪除原始伺服器設定

下列delete-voice-connector-origination範例會從指定的 Amazon Chime Voice Connector 刪除原始主機、連接埠、通訊協定、優先順序和權重。

aws chime delete-voice-connector-origination \ --voice-connector-id abcdef1ghij2klmno3pqr4

此命令不會產生輸出。

如需詳細資訊,請參閱Amazon Chime 管理指南中的使用 Amazon Chime Voice Connectors

下列程式碼範例示範如何使用 delete-voice-connector-proxy

AWS CLI

刪除代理組態

下列delete-voice-connector-proxy範例會從 Amazon Chime Voice Connector 刪除代理組態。

aws chime delete-voice-connector-proxy \ --voice-connector-id abcdef1ghij2klmno3pqr4

此命令不會產生輸出。

如需詳細資訊,請參閱 Amazon Chime 開發人員指南 中的 Proxy Phone Sessions

下列程式碼範例示範如何使用 delete-voice-connector-streaming-configuration

AWS CLI

若要刪除串流組態

下列delete-voice-connector-streaming-configuration範例會刪除指定 Amazon Chime Voice Connector 的串流組態。

aws chime delete-voice-connector-streaming-configuration \ --voice-connector-id abcdef1ghij2klmno3pqr4

此命令不會產生輸出。

如需詳細資訊,請參閱 Amazon Chime 管理指南 中的將 Amazon Chime Voice Connector 資料串流至 Kinesis

下列程式碼範例示範如何使用 delete-voice-connector-termination-credentials

AWS CLI

若要刪除終止憑證

下列delete-voice-connector-termination-credentials範例會刪除指定使用者名稱和 Amazon Chime Voice Connector 的終止憑證。

aws chime delete-voice-connector-termination-credentials \ --voice-connector-id abcdef1ghij2klmno3pqr4 \ --usernames "jdoe"

此命令不會產生輸出。

如需詳細資訊,請參閱Amazon Chime 管理指南中的使用 Amazon Chime Voice Connectors

下列程式碼範例示範如何使用 delete-voice-connector-termination

AWS CLI

刪除終止設定

下列delete-voice-connector-termination範例會刪除指定 Amazon Chime Voice Connector 的終止設定。

aws chime delete-voice-connector-termination \ --voice-connector-id abcdef1ghij2klmno3pqr4

此命令不會產生輸出。

如需詳細資訊,請參閱Amazon Chime 管理指南中的使用 Amazon Chime Voice Connectors

下列程式碼範例示範如何使用 delete-voice-connector

AWS CLI

若要刪除 Amazon Chime Voice Connector

下列delete-voice-connector範例會執行此操作

aws chime delete-voice-connector \ --voice-connector-id abcdef1ghij2klmno3pqr4

此命令不會產生輸出。

如需詳細資訊,請參閱Amazon Chime 管理指南中的使用 Amazon Chime Voice Connectors

下列程式碼範例示範如何使用 disassociate-phone-number-from-user

AWS CLI

取消電話號碼與使用者的關聯

下列disassociate-phone-number-from-user範例會取消電話號碼與指定使用者的關聯。

aws chime disassociate-phone-number-from-user \ --account-id 12a3456b-7c89-012d-3456-78901e23fg45 \ --user-id 1ab2345c-67de-8901-f23g-45h678901j2k

此命令不會產生輸出。

如需詳細資訊,請參閱 Amazon Chime 管理指南 中的管理使用者電話號碼

下列程式碼範例示範如何使用 disassociate-phone-numbers-from-voice-connector-group

AWS CLI

取消電話號碼與 Amazon Chime Voice Connector 群組的關聯

下列disassociate-phone-numbers-from-voice-connector-group範例會將指定的電話號碼與 Amazon Chime Voice Connector 群組取消關聯。

aws chime disassociate-phone-numbers-from-voice-connector-group \ --voice-connector-group-id 123a456b-c7d8-90e1-fg23-4h567jkl8901 \ --e164-phone-numbers "+12065550100" "+12065550101"

輸出:

{ "PhoneNumberErrors": [] }

如需詳細資訊,請參閱Amazon Chime 管理指南中的使用 Amazon Chime Voice Connector 群組

下列程式碼範例示範如何使用 disassociate-phone-numbers-from-voice-connector

AWS CLI

取消電話號碼與 Amazon Chime Voice Connector 的關聯

下列disassociate-phone-numbers-from-voice-connector範例會將指定的電話號碼與 Amazon Chime Voice Connector 取消關聯。

aws chime disassociate-phone-numbers-from-voice-connector \ --voice-connector-id abcdef1ghij2klmno3pqr4 \ --e164-phone-numbers "+12065550100" "+12065550101"

輸出:

{ "PhoneNumberErrors": [] }

如需詳細資訊,請參閱Amazon Chime 管理指南中的使用 Amazon Chime Voice Connectors

下列程式碼範例示範如何使用 disassociate-signin-delegate-groups-from-account

AWS CLI

若要取消登入委派群組的關聯

下列disassociate-signin-delegate-groups-from-account範例會將指定的登入委派群組與指定的 Amazon Chime 帳戶取消關聯。

aws chime disassociate-signin-delegate-groups-from-account \ --account-id 12a3456b-7c89-012d-3456-78901e23fg45 \ --group-names "my_users"

此命令不會產生輸出。

如需詳細資訊,請參閱 Amazon Chime 管理指南 中的管理使用者存取和許可

下列程式碼範例示範如何使用 get-account-settings

AWS CLI

擷取 帳戶的設定

下列get-account-settings範例會擷取指定帳戶的帳戶設定。

aws chime get-account-settings --account-id a1b2c3d4-5678-90ab-cdef-11111EXAMPLE

輸出:

{ "AccountSettings": { "DisableRemoteControl": false, "EnableDialOut": false } }

如需詳細資訊,請參閱 Amazon Chime 管理指南 中的管理您的 Amazon Chime 帳戶

下列程式碼範例示範如何使用 get-account

AWS CLI

擷取 帳戶的詳細資訊

下列get-account範例會擷取指定 Amazon Chime 帳戶的詳細資訊。

aws chime get-account \ --account-id a1b2c3d4-5678-90ab-cdef-11111EXAMPLE

輸出:

{ "Account": { "AwsAccountId": "111122223333", "AccountId": "a1b2c3d4-5678-90ab-cdef-11111EXAMPLE", "Name": "EnterpriseDirectory", "AccountType": "EnterpriseDirectory", "CreatedTimestamp": "2018-12-20T18:38:02.181Z", "DefaultLicense": "Pro", "SupportedLicenses": [ "Basic", "Pro" ], "SigninDelegateGroups": [ { "GroupName": "myGroup" }, ] } }

如需詳細資訊,請參閱 Amazon Chime 管理指南 中的管理您的 Amazon Chime 帳戶

  • 如需API詳細資訊,請參閱 命令參考 GetAccount中的 。 AWS CLI

下列程式碼範例示範如何使用 get-bot

AWS CLI

擷取機器人的詳細資訊

下列get-bot範例顯示指定機器人的詳細資訊。

aws chime get-bot \ --account-id 12a3456b-7c89-012d-3456-78901e23fg45 \ --bot-id 123abcd4-5ef6-789g-0h12-34j56789012k

輸出:

{ "Bot": { "BotId": "123abcd4-5ef6-789g-0h12-34j56789012k", "UserId": "123abcd4-5ef6-789g-0h12-34j56789012k", "DisplayName": "myBot (Bot)", "BotType": "ChatBot", "Disabled": false, "CreatedTimestamp": "2019-09-09T18:05:56.749Z", "UpdatedTimestamp": "2019-09-09T18:05:56.749Z", "BotEmail": "myBot-chimebot@example.com", "SecurityToken": "wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY" } }

如需詳細資訊,請參閱 Amazon Chime 開發人員指南 中的更新聊天機器人

  • 如需API詳細資訊,請參閱 命令參考 GetBot中的 。 AWS CLI

下列程式碼範例示範如何使用 get-global-settings

AWS CLI

若要取得全域設定

下列get-global-settings範例會擷取用於儲存與管理員 AWS 帳戶相關聯之 Amazon Chime Business Calling 和 Amazon Chime Voice Connectors 的呼叫詳細資訊記錄的 S3 儲存貯體名稱。

aws chime get-global-settings

輸出:

{ "BusinessCalling": { "CdrBucket": "s3bucket" }, "VoiceConnector": { "CdrBucket": "s3bucket" } }

如需詳細資訊,請參閱 Amazon Chime 管理指南 中的管理全域設定

下列程式碼範例示範如何使用 get-phone-number-order

AWS CLI

取得電話號碼順序的詳細資訊

下列get-phone-number-order範例顯示指定電話號碼順序的詳細資訊。

aws chime get-phone-number-order \ --phone-number-order-id abc12345-de67-89f0-123g-h45i678j9012

輸出:

{ "PhoneNumberOrder": { "PhoneNumberOrderId": "abc12345-de67-89f0-123g-h45i678j9012", "ProductType": "VoiceConnector", "Status": "Partial", "OrderedPhoneNumbers": [ { "E164PhoneNumber": "+12065550100", "Status": "Acquired" }, { "E164PhoneNumber": "+12065550101", "Status": "Acquired" }, { "E164PhoneNumber": "+12065550102", "Status": "Failed" } ], "CreatedTimestamp": "2019-08-09T21:35:21.427Z", "UpdatedTimestamp": "2019-08-09T21:35:31.926Z" } }

如需詳細資訊,請參閱Amazon Chime 管理指南中的使用電話號碼

下列程式碼範例示範如何使用 get-phone-number-settings

AWS CLI

若要擷取傳出呼叫名稱

下列get-phone-number-settings範例會擷取呼叫使用者帳戶的預設外撥呼叫名稱 AWS 。

aws chime get-phone-number-settings

此命令不會產生輸出。輸出:

{ "CallingName": "myName", "CallingNameUpdatedTimestamp": "2019-10-28T18:56:42.911Z" }

如需詳細資訊,請參閱Amazon Chime 管理指南中的使用電話號碼

下列程式碼範例示範如何使用 get-phone-number

AWS CLI

若要取得電話號碼詳細資訊

下列get-phone-number範例顯示指定電話號碼的詳細資訊。

aws chime get-phone-number \ --phone-number-id +12065550100

輸出:

{ "PhoneNumber": { "PhoneNumberId": "%2B12065550100", "E164PhoneNumber": "+12065550100", "Type": "Local", "ProductType": "VoiceConnector", "Status": "Unassigned", "Capabilities": { "InboundCall": true, "OutboundCall": true, "InboundSMS": true, "OutboundSMS": true, "InboundMMS": true, "OutboundMMS": true }, "Associations": [ { "Value": "abcdef1ghij2klmno3pqr4", "Name": "VoiceConnectorId", "AssociatedTimestamp": "2019-10-28T18:40:37.453Z" } ], "CallingNameStatus": "UpdateInProgress", "CreatedTimestamp": "2019-08-09T21:35:21.445Z", "UpdatedTimestamp": "2019-08-09T21:35:31.745Z" } }

如需詳細資訊,請參閱Amazon Chime 管理指南中的使用電話號碼

  • 如需API詳細資訊,請參閱 命令參考 GetPhoneNumber中的 。 AWS CLI

下列程式碼範例示範如何使用 get-proxy-session

AWS CLI

若要取得代理工作階段詳細資訊

下列get-proxy-session範例列出指定代理工作階段的詳細資訊。

aws chime get-proxy-session \ --voice-connector-id abcdef1ghij2klmno3pqr4 \ --proxy-session-id 123a4bc5-67d8-901e-2f3g-h4ghjk56789l

輸出:

{ "ProxySession": { "VoiceConnectorId": "abcdef1ghij2klmno3pqr4", "ProxySessionId": "123a4bc5-67d8-901e-2f3g-h4ghjk56789l", "Status": "Open", "ExpiryMinutes": 60, "Capabilities": [ "SMS", "Voice" ], "CreatedTimestamp": "2020-04-15T16:10:10.288Z", "UpdatedTimestamp": "2020-04-15T16:10:10.288Z", "Participants": [ { "PhoneNumber": "+12065550100", "ProxyPhoneNumber": "+19135550199" }, { "PhoneNumber": "+14015550101", "ProxyPhoneNumber": "+19135550199" } ] } }

如需詳細資訊,請參閱 Amazon Chime 開發人員指南 中的 Proxy Phone Sessions

  • 如需API詳細資訊,請參閱 命令參考 GetProxySession中的 。 AWS CLI

下列程式碼範例示範如何使用 get-room

AWS CLI

若要取得聊天室的詳細資訊

下列get-room範例顯示指定聊天室的詳細資訊。

aws chime get-room \ --account-id 12a3456b-7c89-012d-3456-78901e23fg45 \ --room-id abcd1e2d-3e45-6789-01f2-3g45h67i890j

輸出:

{ "Room": { "RoomId": "abcd1e2d-3e45-6789-01f2-3g45h67i890j", "Name": "chatRoom", "AccountId": "12a3456b-7c89-012d-3456-78901e23fg45", "CreatedBy": "arn:aws:iam::111122223333:user/alejandro", "CreatedTimestamp": "2019-12-02T22:29:31.549Z", "UpdatedTimestamp": "2019-12-02T22:29:31.549Z" } }

如需詳細資訊,請參閱Amazon Chime 使用者指南中的建立聊天室

  • 如需API詳細資訊,請參閱 命令參考 GetRoom中的 。 AWS CLI

下列程式碼範例示範如何使用 get-user-settings

AWS CLI

擷取使用者設定

下列get-user-settings範例顯示指定的使用者設定。

aws chime get-user-settings \ --account-id 12a3456b-7c89-012d-3456-78901e23fg45 \ --user-id 1ab2345c-67de-8901-f23g-45h678901j2k

輸出:

{ "UserSettings": { "Telephony": { "InboundCalling": true, "OutboundCalling": true, "SMS": true } } }

如需詳細資訊,請參閱 Amazon Chime 管理指南 中的管理使用者電話號碼

  • 如需API詳細資訊,請參閱 命令參考 GetUserSettings中的 。 AWS CLI

下列程式碼範例示範如何使用 get-user

AWS CLI

若要取得使用者的詳細資訊

下列get-user範例會擷取指定使用者的詳細資訊。

aws chime get-user \ --account-id a1b2c3d4-5678-90ab-cdef-11111EXAMPLE \ --user-id a1b2c3d4-5678-90ab-cdef-22222EXAMPLE

輸出:

{ "User": { "UserId": "a1b2c3d4-5678-90ab-cdef-22222EXAMPLE", "AccountId": "a1b2c3d4-5678-90ab-cdef-11111EXAMPLE", "PrimaryEmail": "marthar@example.com", "DisplayName": "Martha Rivera", "LicenseType": "Pro", "UserRegistrationStatus": "Registered", "RegisteredOn": "2018-12-20T18:45:25.231Z", "InvitedOn": "2018-12-20T18:45:25.231Z", "AlexaForBusinessMetadata": { "IsAlexaForBusinessEnabled": False, "AlexaForBusinessRoomArn": "null" }, "PersonalPIN": "XXXXXXXXXX" } }

如需詳細資訊,請參閱 Amazon Chime 管理指南 中的管理使用者

  • 如需API詳細資訊,請參閱 命令參考 GetUser中的 。 AWS CLI

下列程式碼範例示範如何使用 get-voice-connector-group

AWS CLI

若要取得 Amazon Chime Voice Connector 群組的詳細資訊

下列get-voice-connector-group範例顯示指定 Amazon Chime Voice Connector 群組的詳細資訊。

aws chime get-voice-connector-group \ --voice-connector-group-id 123a456b-c7d8-90e1-fg23-4h567jkl8901

輸出:

{ "VoiceConnectorGroup": { "VoiceConnectorGroupId": "123a456b-c7d8-90e1-fg23-4h567jkl8901", "Name": "myGroup", "VoiceConnectorItems": [], "CreatedTimestamp": "2019-09-18T16:38:34.734Z", "UpdatedTimestamp": "2019-09-18T16:38:34.734Z" } }

如需詳細資訊,請參閱Amazon Chime 管理指南中的使用 Amazon Chime Voice Connector 群組

下列程式碼範例示範如何使用 get-voice-connector-logging-configuration

AWS CLI

若要取得記錄組態詳細資訊

下列get-voice-connector-logging-configuration範例會擷取指定 Amazon Chime Voice Connector 的記錄組態詳細資訊。

aws chime get-voice-connector-logging-configuration \ --voice-connector-id abcdef1ghij2klmno3pqr4

輸出:

{ "LoggingConfiguration": { "EnableSIPLogs": true } }

如需詳細資訊,請參閱 Amazon Chime 管理指南 中的將 Amazon Chime Voice Connector Media 串流至 Kinesis

下列程式碼範例示範如何使用 get-voice-connector-origination

AWS CLI

若要擷取原始伺服器設定

下列get-voice-connector-origination範例會擷取指定 Amazon Chime Voice Connector 的起始主機、連接埠、通訊協定、優先順序和權重。

aws chime get-voice-connector-origination \ --voice-connector-id abcdef1ghij2klmno3pqr4

輸出:

{ "Origination": { "Routes": [ { "Host": "10.24.34.0", "Port": 1234, "Protocol": "TCP", "Priority": 1, "Weight": 5 } ], "Disabled": false } }

如需詳細資訊,請參閱Amazon Chime 管理指南中的使用 Amazon Chime Voice Connectors

下列程式碼範例示範如何使用 get-voice-connector-proxy

AWS CLI

若要取得代理組態詳細資訊

下列get-voice-connector-proxy範例會取得 Amazon Chime Voice Connector 的代理組態詳細資訊。

aws chime get-voice-connector-proxy \ --voice-connector-id abcdef1ghij2klmno3pqr4

輸出:

{ "Proxy": { "DefaultSessionExpiryMinutes": 60, "Disabled": false, "PhoneNumberCountries": [ "US" ] } }

如需詳細資訊,請參閱 Amazon Chime 開發人員指南 中的 Proxy Phone Sessions

下列程式碼範例示範如何使用 get-voice-connector-streaming-configuration

AWS CLI

若要取得串流組態詳細資訊

下列get-voice-connector-streaming-configuration範例會取得指定 Amazon Chime Voice Connector 的串流組態詳細資訊。

aws chime get-voice-connector-streaming-configuration \ --voice-connector-id abcdef1ghij2klmno3pqr4

輸出:

{ "StreamingConfiguration": { "DataRetentionInHours": 24, "Disabled": false } }

如需詳細資訊,請參閱 Amazon Chime 管理指南 中的將 Amazon Chime Voice Connector 資料串流至 Kinesis

下列程式碼範例示範如何使用 get-voice-connector-termination-health

AWS CLI

若要擷取終止運作狀態詳細資訊

下列get-voice-connector-termination-health範例會擷取指定 Amazon Chime Voice Connector 的終止運作狀態詳細資訊。

aws chime get-voice-connector-termination-health \ --voice-connector-id abcdef1ghij2klmno3pqr4

輸出:

{ "TerminationHealth": { "Timestamp": "Fri Aug 23 16:45:55 UTC 2019", "Source": "10.24.34.0" } }

如需詳細資訊,請參閱Amazon Chime 管理指南中的使用 Amazon Chime Voice Connectors

下列程式碼範例示範如何使用 get-voice-connector-termination

AWS CLI

擷取終止設定

下列get-voice-connector-termination範例會擷取指定 Amazon Chime Voice Connector 的終止設定。

aws chime get-voice-connector-termination \ --voice-connector-id abcdef1ghij2klmno3pqr4

此命令不會產生輸出。輸出:

{ "Termination": { "CpsLimit": 1, "DefaultPhoneNumber": "+12065550100", "CallingRegions": [ "US" ], "CidrAllowedList": [ "10.24.34.0/23" ], "Disabled": false } }

如需詳細資訊,請參閱Amazon Chime 管理指南中的使用 Amazon Chime Voice Connectors

下列程式碼範例示範如何使用 get-voice-connector

AWS CLI

若要取得 Amazon Chime Voice Connector 的詳細資訊

下列get-voice-connector範例顯示指定 Amazon Chime Voice Connector 的詳細資訊。

aws chime get-voice-connector \ --voice-connector-id abcdef1ghij2klmno3pqr4

輸出:

{ "VoiceConnector": { "VoiceConnectorId": "abcdef1ghij2klmno3pqr4", "AwsRegion": "us-west-2", "Name": "newVoiceConnector", "OutboundHostName": "abcdef1ghij2klmno3pqr4.voiceconnector.chime.aws", "RequireEncryption": true, "CreatedTimestamp": "2019-09-18T20:34:01.352Z", "UpdatedTimestamp": "2019-09-18T20:34:01.352Z" } }

如需詳細資訊,請參閱Amazon Chime 管理指南中的使用 Amazon Chime Voice Connectors

下列程式碼範例示範如何使用 invite-users

AWS CLI

邀請使用者加入 Amazon Chime

下列invite-users範例會傳送電子郵件,邀請使用者至指定的 Amazon Chime 帳戶。

aws chime invite-users \ --account-id a1b2c3d4-5678-90ab-cdef-11111EXAMPLE \ --user-email-list "alejandror@example.com" "janed@example.com"

輸出:

{ "Invites": [ { "InviteId": "a1b2c3d4-5678-90ab-cdef-22222EXAMPLE", "Status": "Pending", "EmailAddress": "alejandror@example.com", "EmailStatus": "Sent" } { "InviteId": "a1b2c3d4-5678-90ab-cdef-33333EXAMPLE", "Status": "Pending", "EmailAddress": "janed@example.com", "EmailStatus": "Sent" } ] }

如需詳細資訊,請參閱 Amazon Chime 管理指南 中的邀請和暫停使用者

  • 如需API詳細資訊,請參閱 命令參考 InviteUsers中的 。 AWS CLI

下列程式碼範例示範如何使用 list-accounts

AWS CLI

若要取得帳戶清單

下列list-accounts範例會擷取管理員帳戶中 Amazon Chime AWS 帳戶的清單。

aws chime list-accounts

輸出:

{ "Accounts": [ { "AwsAccountId": "111122223333", "AccountId": "a1b2c3d4-5678-90ab-cdef-11111EXAMPLE", "Name": "First Chime Account", "AccountType": "EnterpriseDirectory", "CreatedTimestamp": "2018-12-20T18:38:02.181Z", "DefaultLicense": "Pro", "SupportedLicenses": [ "Basic", "Pro" ], "SigninDelegateGroups": [ { "GroupName": "myGroup" }, ] }, { "AwsAccountId": "111122223333", "AccountId": "a1b2c3d4-5678-90ab-cdef-22222EXAMPLE", "Name": "Second Chime Account", "AccountType": "Team", "CreatedTimestamp": "2018-09-04T21:44:22.292Z", "DefaultLicense": "Pro", "SupportedLicenses": [ "Basic", "Pro" ], "SigninDelegateGroups": [ { "GroupName": "myGroup" }, ] } ] }

如需詳細資訊,請參閱 Amazon Chime 管理指南 中的管理您的 Amazon Chime 帳戶

  • 如需API詳細資訊,請參閱 命令參考 ListAccounts中的 。 AWS CLI

下列程式碼範例示範如何使用 list-bots

AWS CLI

擷取機器人清單

下列list-bots範例列出與指定 Amazon Chime Enterprise 帳戶相關聯的機器人。

aws chime list-bots \ --account-id 12a3456b-7c89-012d-3456-78901e23fg45

輸出:

{ "Bot": { "BotId": "123abcd4-5ef6-789g-0h12-34j56789012k", "UserId": "123abcd4-5ef6-789g-0h12-34j56789012k", "DisplayName": "myBot (Bot)", "BotType": "ChatBot", "Disabled": false, "CreatedTimestamp": "2019-09-09T18:05:56.749Z", "UpdatedTimestamp": "2019-09-09T18:05:56.749Z", "BotEmail": "myBot-chimebot@example.com", "SecurityToken": "wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY" } }

如需詳細資訊,請參閱 Amazon Chime 開發人員指南 中的將聊天機器人與 Amazon Chime 搭配使用。

  • 如需API詳細資訊,請參閱 命令參考 ListBots中的 。 AWS CLI

下列程式碼範例示範如何使用 list-phone-number-orders

AWS CLI

列出電話號碼順序

下列list-phone-number-orders範例列出與 Amazon Chime 管理員帳戶相關聯的電話號碼順序。

aws chime list-phone-number-orders

輸出:

{ "PhoneNumberOrders": [ { "PhoneNumberOrderId": "abc12345-de67-89f0-123g-h45i678j9012", "ProductType": "VoiceConnector", "Status": "Partial", "OrderedPhoneNumbers": [ { "E164PhoneNumber": "+12065550100", "Status": "Acquired" }, { "E164PhoneNumber": "+12065550101", "Status": "Acquired" }, { "E164PhoneNumber": "+12065550102", "Status": "Failed" } ], "CreatedTimestamp": "2019-08-09T21:35:21.427Z", "UpdatedTimestamp": "2019-08-09T21:35:31.926Z" } { "PhoneNumberOrderId": "cba54321-ed76-09f5-321g-h54i876j2109", "ProductType": "BusinessCalling", "Status": "Partial", "OrderedPhoneNumbers": [ { "E164PhoneNumber": "+12065550103", "Status": "Acquired" }, { "E164PhoneNumber": "+12065550104", "Status": "Acquired" }, { "E164PhoneNumber": "+12065550105", "Status": "Failed" } ], "CreatedTimestamp": "2019-08-09T21:35:21.427Z", "UpdatedTimestamp": "2019-08-09T21:35:31.926Z" } ] }

如需詳細資訊,請參閱Amazon Chime 管理指南中的使用電話號碼

下列程式碼範例示範如何使用 list-phone-numbers

AWS CLI

列出 Amazon Chime 帳戶的電話號碼

下列list-phone-numbers範例列出與管理員 Amazon Chime 帳戶相關聯的電話號碼。

aws chime list-phone-numbers

此命令不會產生輸出。輸出:

{ "PhoneNumbers": [ { "PhoneNumberId": "%2B12065550100", "E164PhoneNumber": "+12065550100", "Type": "Local", "ProductType": "VoiceConnector", "Status": "Assigned", "Capabilities": { "InboundCall": true, "OutboundCall": true, "InboundSMS": true, "OutboundSMS": true, "InboundMMS": true, "OutboundMMS": true }, "Associations": [ { "Value": "abcdef1ghij2klmno3pqr4", "Name": "VoiceConnectorId", "AssociatedTimestamp": "2019-10-28T18:40:37.453Z" } ], "CallingNameStatus": "UpdateInProgress", "CreatedTimestamp": "2019-08-12T22:10:20.521Z", "UpdatedTimestamp": "2019-10-28T18:42:07.964Z" }, { "PhoneNumberId": "%2B12065550101", "E164PhoneNumber": "+12065550101", "Type": "Local", "ProductType": "VoiceConnector", "Status": "Assigned", "Capabilities": { "InboundCall": true, "OutboundCall": true, "InboundSMS": true, "OutboundSMS": true, "InboundMMS": true, "OutboundMMS": true }, "Associations": [ { "Value": "abcdef1ghij2klmno3pqr4", "Name": "VoiceConnectorId", "AssociatedTimestamp": "2019-10-28T18:40:37.511Z" } ], "CallingNameStatus": "UpdateInProgress", "CreatedTimestamp": "2019-08-12T22:10:20.521Z", "UpdatedTimestamp": "2019-10-28T18:42:07.960Z" } ] }

如需詳細資訊,請參閱Amazon Chime 管理指南中的使用電話號碼

  • 如需API詳細資訊,請參閱 命令參考 ListPhoneNumbers中的 。 AWS CLI

下列程式碼範例示範如何使用 list-proxy-sessions

AWS CLI

列出代理工作階段

下列list-proxy-sessions範例列出 Amazon Chime Voice Connector 的代理工作階段。

aws chime list-proxy-sessions \ --voice-connector-id abcdef1ghij2klmno3pqr4

輸出:

{ "ProxySession": { "VoiceConnectorId": "abcdef1ghij2klmno3pqr4", "ProxySessionId": "123a4bc5-67d8-901e-2f3g-h4ghjk56789l", "Status": "Open", "ExpiryMinutes": 60, "Capabilities": [ "SMS", "Voice" ], "CreatedTimestamp": "2020-04-15T16:10:10.288Z", "UpdatedTimestamp": "2020-04-15T16:10:10.288Z", "Participants": [ { "PhoneNumber": "+12065550100", "ProxyPhoneNumber": "+19135550199" }, { "PhoneNumber": "+14015550101", "ProxyPhoneNumber": "+19135550199" } ] } }

如需詳細資訊,請參閱 Amazon Chime 開發人員指南 中的 Proxy Phone Sessions

下列程式碼範例示範如何使用 list-room-memberships

AWS CLI

列出房間成員資格

下列list-room-memberships範例顯示指定聊天室的成員資格詳細資訊清單。

aws chime list-room-memberships \ --account-id 12a3456b-7c89-012d-3456-78901e23fg45 \ --room-id abcd1e2d-3e45-6789-01f2-3g45h67i890j

輸出:

{ "RoomMemberships": [ { "RoomId": "abcd1e2d-3e45-6789-01f2-3g45h67i890j", "Member": { "MemberId": "2ab2345c-67de-8901-f23g-45h678901j2k", "MemberType": "User", "Email": "zhangw@example.com", "FullName": "Zhang Wei", "AccountId": "12a3456b-7c89-012d-3456-78901e23fg45" }, "Role": "Member", "InvitedBy": "arn:aws:iam::111122223333:user/alejandro", "UpdatedTimestamp": "2019-12-02T22:46:58.532Z" }, { "RoomId": "abcd1e2d-3e45-6789-01f2-3g45h67i890j", "Member": { "MemberId": "1ab2345c-67de-8901-f23g-45h678901j2k", "MemberType": "User", "Email": "janed@example.com", "FullName": "Jane Doe", "AccountId": "12a3456b-7c89-012d-3456-78901e23fg45" }, "Role": "Administrator", "InvitedBy": "arn:aws:iam::111122223333:user/alejandro", "UpdatedTimestamp": "2019-12-02T22:46:58.532Z" } ] }

如需詳細資訊,請參閱Amazon Chime 使用者指南中的建立聊天室

下列程式碼範例示範如何使用 list-rooms

AWS CLI

列出聊天室

下列list-rooms範例顯示指定帳戶中聊天室的清單。清單只會篩選至指定成員所屬的聊天室。

aws chime list-rooms \ --account-id 12a3456b-7c89-012d-3456-78901e23fg45 \ --member-id 1ab2345c-67de-8901-f23g-45h678901j2k

輸出:

{ "Room": { "RoomId": "abcd1e2d-3e45-6789-01f2-3g45h67i890j", "Name": "teamRoom", "AccountId": "12a3456b-7c89-012d-3456-78901e23fg45", "CreatedBy": "arn:aws:iam::111122223333:user/alejandro", "CreatedTimestamp": "2019-12-02T22:29:31.549Z", "UpdatedTimestamp": "2019-12-02T22:33:19.310Z" } }

如需詳細資訊,請參閱Amazon Chime 使用者指南中的建立聊天室

  • 如需API詳細資訊,請參閱 命令參考 ListRooms中的 。 AWS CLI

下列程式碼範例示範如何使用 list-users

AWS CLI

列出帳戶中的使用者

下列list-users範例列出指定 Amazon Chime 帳戶的使用者。

aws chime list-users --account-id a1b2c3d4-5678-90ab-cdef-11111EXAMPLE

輸出:

{ "Users": [ { "UserId": "a1b2c3d4-5678-90ab-cdef-22222EXAMPLE", "AccountId": "a1b2c3d4-5678-90ab-cdef-11111EXAMPLE", "PrimaryEmail": "mariag@example.com", "DisplayName": "Maria Garcia", "LicenseType": "Pro", "UserType": "PrivateUser", "UserRegistrationStatus": "Registered", "RegisteredOn": "2018-12-20T18:45:25.231Z" "AlexaForBusinessMetadata": { "IsAlexaForBusinessEnabled": false } }, { "UserId": "a1b2c3d4-5678-90ab-cdef-33333EXAMPLE", "AccountId": "a1b2c3d4-5678-90ab-cdef-11111EXAMPLE", "PrimaryEmail": "richardr@example.com", "DisplayName": "Richard Roe", "LicenseType": "Pro", "UserType": "PrivateUser", "UserRegistrationStatus": "Registered", "RegisteredOn": "2018-12-20T18:45:45.415Z" "AlexaForBusinessMetadata": { "IsAlexaForBusinessEnabled": false } }, { "UserId": "a1b2c3d4-5678-90ab-cdef-44444EXAMPLE", "AccountId": "a1b2c3d4-5678-90ab-cdef-11111EXAMPLE", "PrimaryEmail": "saanvis@example.com", "DisplayName": "Saanvi Sarkar", "LicenseType": "Basic", "UserType": "PrivateUser", "UserRegistrationStatus": "Registered", "RegisteredOn": "2018-12-20T18:46:57.747Z" "AlexaForBusinessMetadata": { "IsAlexaForBusinessEnabled": false } }, { "UserId": "a1b2c3d4-5678-90ab-cdef-55555EXAMPLE", "AccountId": "a1b2c3d4-5678-90ab-cdef-11111EXAMPLE", "PrimaryEmail": "wxiulan@example.com", "DisplayName": "Wang Xiulan", "LicenseType": "Basic", "UserType": "PrivateUser", "UserRegistrationStatus": "Registered", "RegisteredOn": "2018-12-20T18:47:15.390Z" "AlexaForBusinessMetadata": { "IsAlexaForBusinessEnabled": false } } ] }

如需詳細資訊,請參閱 Amazon Chime 管理指南 中的管理使用者

  • 如需API詳細資訊,請參閱 命令參考 ListUsers中的 。 AWS CLI

下列程式碼範例示範如何使用 list-voice-connector-groups

AWS CLI

列出 Amazon Chime 帳戶的 Amazon Chime Voice Connector 群組

下列list-voice-connector-groups範例列出與管理員的 Amazon Chime 帳戶相關聯的 Amazon Chime Voice Connector 群組。

aws chime list-voice-connector-groups

輸出:

{ "VoiceConnectorGroups": [ { "VoiceConnectorGroupId": "123a456b-c7d8-90e1-fg23-4h567jkl8901", "Name": "myGroup", "VoiceConnectorItems": [], "CreatedTimestamp": "2019-09-18T16:38:34.734Z", "UpdatedTimestamp": "2019-09-18T16:38:34.734Z" } ] }

如需詳細資訊,請參閱Amazon Chime 管理指南中的使用 Amazon Chime Voice Connector 群組

下列程式碼範例示範如何使用 list-voice-connector-termination-credentials

AWS CLI

擷取終止憑證清單

下列list-voice-connector-termination-credentials範例會擷取指定 Amazon Chime Voice Connector 的終止憑證清單。

aws chime list-voice-connector-termination-credentials \ --voice-connector-id abcdef1ghij2klmno3pqr4

此命令不會產生輸出。輸出:

{ "Usernames": [ "jdoe" ] }

如需詳細資訊,請參閱Amazon Chime 管理指南中的使用 Amazon Chime Voice Connectors

下列程式碼範例示範如何使用 list-voice-connectors

AWS CLI

列出 帳戶的 Amazon Chime Voice Connectors

下列list-voice-connectors範例列出與來電者帳戶相關聯的 Amazon Chime Voice Connectors。

aws chime list-voice-connectors

輸出:

{ "VoiceConnectors": [ { "VoiceConnectorId": "abcdef1ghij2klmno3pqr4", "AwsRegion": "us-east-1", "Name": "MyVoiceConnector", "OutboundHostName": "abcdef1ghij2klmno3pqr4.voiceconnector.chime.aws", "RequireEncryption": true, "CreatedTimestamp": "2019-06-04T18:46:56.508Z", "UpdatedTimestamp": "2019-09-18T16:33:00.806Z" }, { "VoiceConnectorId": "cbadef1ghij2klmno3pqr5", "AwsRegion": "us-west-2", "Name": "newVoiceConnector", "OutboundHostName": "cbadef1ghij2klmno3pqr5.voiceconnector.chime.aws", "RequireEncryption": true, "CreatedTimestamp": "2019-09-18T20:34:01.352Z", "UpdatedTimestamp": "2019-09-18T20:34:01.352Z" } ] }

如需詳細資訊,請參閱Amazon Chime 管理指南中的使用 Amazon Chime Voice Connectors

下列程式碼範例示範如何使用 logout-user

AWS CLI

若要登出使用者

下列logout-user範例會將指定的使用者登出。

aws chime logout-user \ --account-id a1b2c3d4-5678-90ab-cdef-11111EXAMPLE \ --user-id a1b2c3d4-5678-90ab-cdef-22222EXAMPLE

此命令不會產生輸出。

  • 如需API詳細資訊,請參閱 命令參考 LogoutUser中的 。 AWS CLI

下列程式碼範例示範如何使用 put-voice-connector-logging-configuration

AWS CLI

新增 Amazon Chime Voice Connector 的記錄組態

下列put-voice-connector-logging-configuration範例會開啟指定 Amazon Chime Voice Connector 的記錄SIP組態。

aws chime put-voice-connector-logging-configuration \ --voice-connector-id abcdef1ghij2klmno3pqr4 \ --logging-configuration EnableSIPLogs=true

輸出:

{ "LoggingConfiguration": { "EnableSIPLogs": true } }

如需詳細資訊,請參閱Amazon Chime 管理指南中的將 Amazon Chime Voice Connector Media 串流至 Kinesis

下列程式碼範例示範如何使用 put-voice-connector-origination

AWS CLI

若要設定原始伺服器設定

下列put-voice-connector-origination範例會設定指定 Amazon Chime Voice Connector 的起始主機、連接埠、通訊協定、優先順序和權重。

aws chime put-voice-connector-origination \ --voice-connector-id abcdef1ghij2klmno3pqr4 \ --origination Routes=[{Host="10.24.34.0",Port=1234,Protocol="TCP",Priority=1,Weight=5}],Disabled=false

輸出:

{ "Origination": { "Routes": [ { "Host": "10.24.34.0", "Port": 1234, "Protocol": "TCP", "Priority": 1, "Weight": 5 } ], "Disabled": false } }

如需詳細資訊,請參閱Amazon Chime 管理指南中的使用 Amazon Chime Voice Connectors

下列程式碼範例示範如何使用 put-voice-connector-proxy

AWS CLI

放置代理組態

下列put-voice-connector-proxy範例會將代理組態設定為您的 Amazon Chime Voice Connector。

aws chime put-voice-connector-proxy \ --voice-connector-id abcdef1ghij2klmno3pqr4 \ --default-session-expiry-minutes 60 \ --phone-number-pool-countries "US"

輸出:

{ "Proxy": { "DefaultSessionExpiryMinutes": 60, "Disabled": false, "PhoneNumberCountries": [ "US" ] } }

如需詳細資訊,請參閱 Amazon Chime 開發人員指南 中的 Proxy Phone Sessions

下列程式碼範例示範如何使用 put-voice-connector-streaming-configuration

AWS CLI

建立串流組態

下列put-voice-connector-streaming-configuration範例會為指定的 Amazon Chime Voice Connector 建立串流組態。它啟用從 Amazon Chime Voice Connector 到 Amazon Kinesis 的媒體串流,並將資料保留期設定為 24 小時。

aws chime put-voice-connector-streaming-configuration \ --voice-connector-id abcdef1ghij2klmno3pqr4 \ --streaming-configuration DataRetentionInHours=24,Disabled=false

輸出:

{ "StreamingConfiguration": { "DataRetentionInHours": 24, "Disabled": false } }

如需詳細資訊,請參閱 Amazon Chime 管理指南 中的將 Amazon Chime Voice Connector 資料串流至 Kinesis

下列程式碼範例示範如何使用 put-voice-connector-termination-credentials

AWS CLI

若要設定終止憑證

下列put-voice-connector-termination-credentials範例會設定指定 Amazon Chime Voice Connector 的終止憑證。

aws chime put-voice-connector-termination-credentials \ --voice-connector-id abcdef1ghij2klmno3pqr4 \ --credentials Username="jdoe",Password="XXXXXXXX"

此命令不會產生輸出。

如需詳細資訊,請參閱Amazon Chime 管理指南中的使用 Amazon Chime Voice Connectors

下列程式碼範例示範如何使用 put-voice-connector-termination

AWS CLI

設定終止設定

下列put-voice-connector-termination範例會設定指定 Amazon Chime Voice Connector 的呼叫區域和允許的 IP 主機終止設定。

aws chime put-voice-connector-termination \ --voice-connector-id abcdef1ghij2klmno3pqr4 \ --termination CallingRegions="US",CidrAllowedList="10.24.34.0/23",Disabled=false

輸出:

{ "Termination": { "CpsLimit": 0, "CallingRegions": [ "US" ], "CidrAllowedList": [ "10.24.34.0/23" ], "Disabled": false } }

如需詳細資訊,請參閱Amazon Chime 管理指南中的使用 Amazon Chime Voice Connectors

下列程式碼範例示範如何使用 regenerate-security-token

AWS CLI

若要重新產生安全權杖

下列regenerate-security-token範例會為指定的機器人註冊安全權杖。

aws chime regenerate-security-token \ --account-id 12a3456b-7c89-012d-3456-78901e23fg45 \ --bot-id 123abcd4-5ef6-789g-0h12-34j56789012k

輸出:

{ "Bot": { "BotId": "123abcd4-5ef6-789g-0h12-34j56789012k", "UserId": "123abcd4-5ef6-789g-0h12-34j56789012k", "DisplayName": "myBot (Bot)", "BotType": "ChatBot", "Disabled": false, "CreatedTimestamp": "2019-09-09T18:05:56.749Z", "UpdatedTimestamp": "2019-09-09T18:05:56.749Z", "BotEmail": "myBot-chimebot@example.com", "SecurityToken": "je7MtGbClwBF/2Zp9Utk/h3yCo8nvbEXAMPLEKEY" } }

如需詳細資訊,請參閱Amazon Chime 開發人員指南中的驗證聊天機器人請求

下列程式碼範例示範如何使用 reset-personal-pin

AWS CLI

重設使用者的個人會議 PIN

下列reset-personal-pin範例會重設指定使用者的個人會議 PIN。

aws chime reset-personal-pin \ --account-id a1b2c3d4-5678-90ab-cdef-11111EXAMPLE --user-id a1b2c3d4-5678-90ab-cdef-22222EXAMPLE

輸出:

{ "User": { "UserId": "a1b2c3d4-5678-90ab-cdef-22222EXAMPLE", "AccountId": "a1b2c3d4-5678-90ab-cdef-11111EXAMPLE", "PrimaryEmail": "mateo@example.com", "DisplayName": "Mateo Jackson", "LicenseType": "Pro", "UserType": "PrivateUser", "UserRegistrationStatus": "Registered", "RegisteredOn": "2018-12-20T18:45:25.231Z", "AlexaForBusinessMetadata": { "IsAlexaForBusinessEnabled": False, "AlexaForBusinessRoomArn": "null" }, "PersonalPIN": "XXXXXXXXXX" } }

如需詳細資訊,請參閱 Amazon Chime 管理指南 中的變更個人會議PINs

  • 如需API詳細資訊,請參閱 命令參考 ResetPersonalPin中的 。 AWS CLI

下列程式碼範例示範如何使用 restore-phone-number

AWS CLI

還原電話號碼

下列restore-phone-number範例會從刪除佇列還原指定的電話號碼。

aws chime restore-phone-number \ --phone-number-id "+12065550100"

輸出:

{ "PhoneNumber": { "PhoneNumberId": "%2B12065550100", "E164PhoneNumber": "+12065550100", "Type": "Local", "ProductType": "BusinessCalling", "Status": "Unassigned", "Capabilities": { "InboundCall": true, "OutboundCall": true, "InboundSMS": true, "OutboundSMS": true, "InboundMMS": true, "OutboundMMS": true }, "Associations": [], "CreatedTimestamp": "2019-08-09T21:35:21.445Z", "UpdatedTimestamp": "2019-08-12T22:06:36.355Z" } }

如需詳細資訊,請參閱Amazon Chime 管理指南中的使用電話號碼

下列程式碼範例示範如何使用 search-available-phone-numbers

AWS CLI

搜尋可用的電話號碼

下列search-available-phone-numbers範例會依區域碼搜尋可用的電話號碼。

aws chime search-available-phone-numbers \ --area-code "206"

輸出:

{ "E164PhoneNumbers": [ "+12065550100", "+12065550101", "+12065550102", "+12065550103", "+12065550104", "+12065550105", "+12065550106", "+12065550107", "+12065550108", "+12065550109", ] }

如需詳細資訊,請參閱Amazon Chime 管理指南中的使用電話號碼

下列程式碼範例示範如何使用 update-account-settings

AWS CLI

更新帳戶的設定

下列update-account-settings範例會停用指定 Amazon Chime 帳戶的共用螢幕的遠端控制。

aws chime update-account-settings \ --account-id a1b2c3d4-5678-90ab-cdef-11111EXAMPLE \ --account-settings DisableRemoteControl=true

此命令不會產生輸出。

下列程式碼範例示範如何使用 update-account

AWS CLI

更新帳戶

下列update-account範例會更新指定的帳戶名稱。

aws chime update-account \ --account-id a1b2c3d4-5678-90ab-cdef-11111EXAMPLE \ --name MyAccountName

輸出:

{ "Account": { "AwsAccountId": "111122223333", "AccountId": "a1b2c3d4-5678-90ab-cdef-11111EXAMPLE", "Name": "MyAccountName", "AccountType": "Team", "CreatedTimestamp": "2018-09-04T21:44:22.292Z", "DefaultLicense": "Pro", "SupportedLicenses": [ "Basic", "Pro" ], "SigninDelegateGroups": [ { "GroupName": "myGroup" }, ] } }

如需詳細資訊,請參閱 Amazon Chime 管理指南 中的重新命名您的帳戶

  • 如需API詳細資訊,請參閱 命令參考 UpdateAccount中的 。 AWS CLI

下列程式碼範例示範如何使用 update-bot

AWS CLI

更新機器人

下列update-bot範例會更新指定機器人的狀態,使其停止執行。

aws chime update-bot \ --account-id 12a3456b-7c89-012d-3456-78901e23fg45 \ --bot-id 123abcd4-5ef6-789g-0h12-34j56789012k \ --disabled

輸出:

{ "Bot": { "BotId": "123abcd4-5ef6-789g-0h12-34j56789012k", "UserId": "123abcd4-5ef6-789g-0h12-34j56789012k", "DisplayName": "myBot (Bot)", "BotType": "ChatBot", "Disabled": true, "CreatedTimestamp": "2019-09-09T18:05:56.749Z", "UpdatedTimestamp": "2019-09-09T18:05:56.749Z", "BotEmail": "myBot-chimebot@example.com", "SecurityToken": "je7MtGbClwBF/2Zp9Utk/h3yCo8nvbEXAMPLEKEY" } }

如需詳細資訊,請參閱Amazon Chime 開發人員指南中的更新聊天機器人

  • 如需API詳細資訊,請參閱 命令參考 UpdateBot中的 。 AWS CLI

下列程式碼範例示範如何使用 update-global-settings

AWS CLI

更新全域設定

下列update-global-settings範例會更新用於儲存與管理員 AWS 帳戶相關聯之 Amazon Chime Business Calling 和 Amazon Chime Voice Connectors 的呼叫詳細資訊記錄的 S3 儲存貯體。

aws chime update-global-settings \ --business-calling CdrBucket="s3bucket" \ --voice-connector CdrBucket="s3bucket"

此命令不會產生輸出。

如需詳細資訊,請參閱 Amazon Chime 管理指南 中的管理全域設定

下列程式碼範例示範如何使用 update-phone-number-settings

AWS CLI

若要更新傳出呼叫名稱

下列update-phone-number-settings範例會更新管理員 AWS 帳戶的預設外撥呼叫名稱。

aws chime update-phone-number-settings \ --calling-name "myName"

此命令不會產生輸出。

如需詳細資訊,請參閱Amazon Chime 管理指南中的使用電話號碼

下列程式碼範例示範如何使用 update-phone-number

AWS CLI

範例 1:更新電話號碼的產品類型

下列update-phone-number範例會更新指定電話號碼的產品類型。

aws chime update-phone-number \ --phone-number-id "+12065550100" \ --product-type "BusinessCalling"

輸出:

{ "PhoneNumber": { "PhoneNumberId": "%2B12065550100", "E164PhoneNumber": "+12065550100", "Type": "Local", "ProductType": "BusinessCalling", "Status": "Unassigned", "Capabilities": { "InboundCall": true, "OutboundCall": true, "InboundSMS": true, "OutboundSMS": true, "InboundMMS": true, "OutboundMMS": true }, "Associations": [], "CallingName": "phonenumber1", "CreatedTimestamp": "2019-08-09T21:35:21.445Z", "UpdatedTimestamp": "2019-08-12T21:44:07.591Z" } }

範例 2:更新電話號碼的撥出電話名稱

下列update-phone-number範例會更新指定電話號碼的撥出呼叫名稱。

aws chime update-phone-number --phone-number-id "+12065550100" --calling-name "phonenumber2"

輸出:

{ "PhoneNumber": { "PhoneNumberId": "%2B12065550100", "E164PhoneNumber": "+12065550100", "Type": "Local", "ProductType": "BusinessCalling", "Status": "Unassigned", "Capabilities": { "InboundCall": true, "OutboundCall": true, "InboundSMS": true, "OutboundSMS": true, "InboundMMS": true, "OutboundMMS": true }, "Associations": [], "CallingName": "phonenumber2", "CreatedTimestamp": "2019-08-09T21:35:21.445Z", "UpdatedTimestamp": "2019-08-12T21:44:07.591Z" } }

如需詳細資訊,請參閱Amazon Chime 管理指南中的使用電話號碼

下列程式碼範例示範如何使用 update-proxy-session

AWS CLI

若要更新代理工作階段

下列update-proxy-session範例會更新代理工作階段功能。

aws chime update-proxy-session \ --voice-connector-id abcdef1ghij2klmno3pqr4 \ --proxy-session-id 123a4bc5-67d8-901e-2f3g-h4ghjk56789l \ --capabilities "Voice"

輸出:

{ "ProxySession": { "VoiceConnectorId": "abcdef1ghij2klmno3pqr4", "ProxySessionId": "123a4bc5-67d8-901e-2f3g-h4ghjk56789l", "Status": "Open", "ExpiryMinutes": 60, "Capabilities": [ "Voice" ], "CreatedTimestamp": "2020-04-15T16:10:10.288Z", "UpdatedTimestamp": "2020-04-15T16:10:10.288Z", "Participants": [ { "PhoneNumber": "+12065550100", "ProxyPhoneNumber": "+19135550199" }, { "PhoneNumber": "+14015550101", "ProxyPhoneNumber": "+19135550199" } ] } }

如需詳細資訊,請參閱 Amazon Chime 開發人員指南 中的 Proxy Phone Sessions

下列程式碼範例示範如何使用 update-room-membership

AWS CLI

更新房間成員資格

下列update-room-membership範例會將指定聊天室成員的角色修改為 Administrator

aws chime update-room-membership \ --account-id 12a3456b-7c89-012d-3456-78901e23fg45 \ --room-id abcd1e2d-3e45-6789-01f2-3g45h67i890j \ --member-id 1ab2345c-67de-8901-f23g-45h678901j2k \ --role Administrator

輸出:

{ "RoomMembership": { "RoomId": "abcd1e2d-3e45-6789-01f2-3g45h67i890j", "Member": { "MemberId": "1ab2345c-67de-8901-f23g-45h678901j2k", "MemberType": "User", "Email": "sofiamartinez@example.com", "FullName": "Sofia Martinez", "AccountId": "12a3456b-7c89-012d-3456-78901e23fg45" }, "Role": "Administrator", "InvitedBy": "arn:aws:iam::111122223333:user/admin", "UpdatedTimestamp": "2019-12-02T22:40:22.931Z" } }

如需詳細資訊,請參閱Amazon Chime 使用者指南中的建立聊天室

下列程式碼範例示範如何使用 update-room

AWS CLI

若要更新聊天室

下列update-room範例會修改指定聊天室的名稱。

aws chime update-room \ --account-id 12a3456b-7c89-012d-3456-78901e23fg45 \ --room-id abcd1e2d-3e45-6789-01f2-3g45h67i890j \ --name teamRoom

輸出:

{ "Room": { "RoomId": "abcd1e2d-3e45-6789-01f2-3g45h67i890j", "Name": "teamRoom", "AccountId": "12a3456b-7c89-012d-3456-78901e23fg45", "CreatedBy": "arn:aws:iam::111122223333:user/alejandro", "CreatedTimestamp": "2019-12-02T22:29:31.549Z", "UpdatedTimestamp": "2019-12-02T22:33:19.310Z" } }

如需詳細資訊,請參閱Amazon Chime 使用者指南中的建立聊天室

  • 如需API詳細資訊,請參閱 命令參考 UpdateRoom中的 。 AWS CLI

下列程式碼範例示範如何使用 update-user-settings

AWS CLI

更新使用者設定

下列update-user-settings範例可讓指定的使用者進行傳入和傳出呼叫,以及傳送和接收SMS訊息。

aws chime update-user-settings \ --account-id 12a3456b-7c89-012d-3456-78901e23fg45 \ --user-id 1ab2345c-67de-8901-f23g-45h678901j2k \ --user-settings "Telephony={InboundCalling=true,OutboundCalling=true,SMS=true}"

此命令不會產生輸出。

如需詳細資訊,請參閱 Amazon Chime 管理指南 中的管理使用者電話號碼

下列程式碼範例示範如何使用 update-user

AWS CLI

更新使用者詳細資訊

此範例會更新指定使用者的指定詳細資訊。

命令:

aws chime update-user \ --account-id a1b2c3d4-5678-90ab-cdef-11111EXAMPLE \ --user-id a1b2c3d4-5678-90ab-cdef-22222EXAMPLE \ --license-type "Basic"

輸出:

{ "User": { "UserId": "a1b2c3d4-5678-90ab-cdef-22222EXAMPLE" } }
  • 如需API詳細資訊,請參閱 命令參考 UpdateUser中的 。 AWS CLI

下列程式碼範例示範如何使用 update-voice-connector-group

AWS CLI

更新 Amazon Chime Voice Connector 群組的詳細資訊

下列update-voice-connector-group範例會更新指定 Amazon Chime Voice Connector 群組的詳細資訊。

aws chime update-voice-connector-group \ --voice-connector-group-id 123a456b-c7d8-90e1-fg23-4h567jkl8901 \ --name "newGroupName" \ --voice-connector-items VoiceConnectorId=abcdef1ghij2klmno3pqr4,Priority=1

輸出:

{ "VoiceConnectorGroup": { "VoiceConnectorGroupId": "123a456b-c7d8-90e1-fg23-4h567jkl8901", "Name": "newGroupName", "VoiceConnectorItems": [ { "VoiceConnectorId": "abcdef1ghij2klmno3pqr4", "Priority": 1 } ], "CreatedTimestamp": "2019-09-18T16:38:34.734Z", "UpdatedTimestamp": "2019-10-28T19:00:57.081Z" } }

如需詳細資訊,請參閱Amazon Chime 管理指南中的使用 Amazon Chime Voice Connector 群組

下列程式碼範例示範如何使用 update-voice-connector

AWS CLI

更新 Amazon Chime Voice Connector 的詳細資訊

下列update-voice-connector範例會更新指定 Amazon Chime Voice Connector 的名稱。

aws chime update-voice-connector \ --voice-connector-id abcdef1ghij2klmno3pqr4 \ --name newName \ --require-encryption

輸出:

{ "VoiceConnector": { "VoiceConnectorId": "abcdef1ghij2klmno3pqr4", "AwsRegion": "us-west-2", "Name": "newName", "OutboundHostName": "abcdef1ghij2klmno3pqr4.voiceconnector.chime.aws", "RequireEncryption": true, "CreatedTimestamp": "2019-09-18T20:34:01.352Z", "UpdatedTimestamp": "2019-09-18T20:40:52.895Z" } }

如需詳細資訊,請參閱Amazon Chime 管理指南中的使用 Amazon Chime Voice Connectors