Doc AWS SDK Examples GitHub リポジトリには、他にも SDK の例があります。 AWS
翻訳は機械翻訳により提供されています。提供された翻訳内容と英語版の間で齟齬、不一致または矛盾がある場合、英語版が優先します。
を使用した Amazon Chime の例 AWS CLI
次のコード例は、Amazon Chime AWS Command Line Interface で を使用してアクションを実行し、一般的なシナリオを実装する方法を示しています。
アクションはより大きなプログラムからのコードの抜粋であり、コンテキスト内で実行する必要があります。アクションは個々のサービス機能を呼び出す方法を示していますが、コンテキスト内のアクションは、関連するシナリオで確認できます。
各例には、完全なソースコードへのリンクが含まれており、そこからコンテキストにおけるコードの設定方法と実行方法についての手順を確認できます。
トピック
アクション
次のコード例では、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-id1ab2345c-67de-8901-f23g-45h678901j2k
\ --e164-phone-number"+12065550100"
このコマンドでは何も出力されません。
詳細については、「Amazon Chime管理ガイド」の「ユーザーの電話番号の管理」を参照してください。
-
API の詳細については、「AWS CLI コマンドリファレンス」の「AssociatePhoneNumberWithUser
」を参照してください。
-
次のコード例では、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 グループの使用方法」を参照してください。
-
API の詳細については、 「AWS CLI コマンドリファレンス」の「AssociatePhoneNumbersWithVoiceConnectorGroup
」を参照してください。
-
次のコード例では、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 Connector の使用方法」を参照してください。
-
API の詳細については、 「AWS CLI コマンドリファレンス」の「AssociatePhoneNumbersWithVoiceConnector
」を参照してください。
-
次のコード例では、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-groupsGroupName=my_users
このコマンドでは何も出力されません。
詳細については、「Amazon Chime管理ガイド」の「ユーザーアクセスと許可の管理」を参照してください。
-
API の詳細については、「AWS CLI コマンドリファレンス」の「AssociateSigninDelegateGroupsWithAccount
」を参照してください。
-
次のコード例では、batch-create-room-membership
を使用する方法を示しています。
- AWS CLI
-
複数のルームメンバーシップを作成する方法
次の
batch-create-room-membership
の例では、チャットルームのメンバーとしてチャットルームに複数のユーザーを追加します。また、管理者ロールとメンバーロールをユーザーに割り当てます。aws chime batch-create-room-membership \ --account-id
12a3456b-7c89-012d-3456-78901e23fg45
\ --room-idabcd1e2d-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 ユーザーガイド」の「チャットルームの作成」を参照してください。
-
API の詳細については、「AWS CLI コマンドリファレンス」の「BatchCreateRoomMembership
」を参照してください。
-
次のコード例では、batch-delete-phone-number
を使用する方法を示しています。
- AWS CLI
-
複数の電話番号を削除する方法
次の
batch-delete-phone-number
の例では、指定された電話番号をすべて削除します。aws chime batch-delete-phone-number \ --phone-number-ids
"%2B12065550100"
"%2B12065550101"
このコマンドでは何も出力されません。出力:
{ "PhoneNumberErrors": [] }
詳細については、「Amazon Chime管理ガイド」の「電話番号の使用方法」を参照してください。
-
API の詳細については、「AWS CLI コマンドリファレンス」の「BatchDeletePhoneNumber
」を参照してください。
-
次のコード例では、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 の詳細については、「AWS CLI コマンドリファレンス」の「BatchSuspendUser
」を参照してください。
-
次のコード例では、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": [] }
-
API の詳細については、「AWS CLI コマンドリファレンス」の「BatchUnsuspendUser
」を参照してください。
-
次のコード例では、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管理ガイド」の「電話番号の使用方法」を参照してください。
-
API の詳細については、「AWS CLI コマンドリファレンス」の「BatchUpdatePhoneNumber
」を参照してください。
-
次のコード例では、batch-update-user
を使用する方法を示しています。
- AWS CLI
-
1 つのコマンドで複数のユーザーを更新する方法
次の
batch-update-user
の例では、指定された Amazon Chime アカウント内のリストされた各ユーザーのLicenseType
を更新します。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 の詳細については、「AWS CLI コマンドリファレンス」の「BatchUpdateUser
」を参照してください。
-
次のコード例では、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 の詳細については、AWS CLI コマンドリファレンスの「CreateAccount
」を参照してください。
-
次のコード例では、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 の詳細については、「AWS CLI コマンドリファレンス」の「CreateBot
」を参照してください。
-
次のコード例では、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 管理ガイド」の「電話番号の使用方法」を参照してください。
-
API の詳細については、「AWS CLI コマンドリファレンス」の「CreatePhoneNumberOrder
」を参照してください。
-
次のコード例では、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 デベロッパーガイド」の「プロキシ電話セッション」を参照してください。
-
API の詳細については、「AWS CLI コマンドリファレンス」の「CreateProxySession
」を参照してください。
-
次のコード例では、create-room-membership
を使用する方法を示しています。
- AWS CLI
-
ルームメンバーシップを作成する方法
次の
create-room-membership
の例では、指定されたユーザーをチャットルームメンバーとしてチャットルームに追加します。aws chime create-room-membership \ --account-id
12a3456b-7c89-012d-3456-78901e23fg45
\ --room-idabcd1e2d-3e45-6789-01f2-3g45h67i890j
\ --member-id1ab2345c-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 ユーザーガイド」の「チャットルームの作成」を参照してください。
-
API の詳細については、「AWS CLI コマンドリファレンス」の「CreateRoomMembership
」を参照してください。
-
次のコード例では、create-room
を使用する方法を示しています。
- AWS CLI
-
チャットルームを作成するには
次の
create-room
の例では、指定された Amazon Chime アカウントのチャットルームを作成します。aws chime create-room \ --account-id
12a3456b-7c89-012d-3456-78901e23fg45
\ --namechatRoom
出力:
{ "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 の詳細については、「AWS CLI コマンドリファレンス」の「CreateRoom
」を参照してください。
-
次のコード例では、create-user
を使用する方法を示しています。
- AWS CLI
-
共有デバイスのユーザープロファイルを作成する方法
次の
create-user
の例では、指定された E メールアドレスの共有デバイスプロファイルを作成します。aws chime create-user \ --account-id
12a3456b-7c89-012d-3456-78901e23fg45
\ --emailroomdevice@example.com
\ --user-typeSharedDevice
出力:
{ "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 の詳細については、「AWS CLI コマンドリファレンス」の「CreateUser
」を参照してください。
-
次のコード例では、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-itemsVoiceConnectorId=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 グループの使用方法」を参照してください。
-
API の詳細については、「AWS CLI コマンドリファレンス」の「CreateVoiceConnectorGroup
」を参照してください。
-
次のコード例では、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-regionus-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 Connector の使用方法」を参照してください。
-
API の詳細については、「AWS CLI コマンドリファレンス」の「CreateVoiceConnector
」を参照してください。
-
次のコード例では、delete-account
を使用する方法を示しています。
- AWS CLI
-
アカウントを削除する方法
次の
delete-account
の例では、指定されたアカウントを削除します。aws chime delete-account --account-id
a1b2c3d4-5678-90ab-cdef-11111EXAMPLE
このコマンドでは何も出力されません。
詳細については、「Amazon Chime 管理ガイド」の「アカウントの削除」を参照してください。
-
API の詳細については、「AWS CLI コマンドリファレンス」の「DeleteAccount
」を参照してください。
-
次のコード例では、delete-phone-number
を使用する方法を示しています。
- AWS CLI
-
電話番号を削除する方法
次の
delete-phone-number
の例では、指定された電話番号を削除キューに移動します。aws chime delete-phone-number \ --phone-number-id
"+12065550100"
このコマンドでは何も出力されません。
詳細については、「Amazon Chime 管理ガイド」の「電話番号の使用方法」を参照してください。
-
API の詳細については、「AWS CLI コマンドリファレンス」の「DeletePhoneNumber
」を参照してください。
-
次のコード例では、delete-proxy-session
を使用する方法を示しています。
- AWS CLI
-
プロキシセッションを削除する方法
次の
delete-proxy-session
の例では、指定されたスタックを削除します。aws chime delete-proxy-session \ --voice-connector-id
abcdef1ghij2klmno3pqr4
\ --proxy-session-id123a4bc5-67d8-901e-2f3g-h4ghjk56789l
このコマンドでは何も出力されません。
詳細については、「Amazon Chime デベロッパーガイド」の「プロキシ電話セッション」を参照してください。
-
API の詳細については、「AWS CLI コマンドリファレンス」の「DeleteProxySession
」を参照してください。
-
次のコード例では、delete-room-membership
を使用する方法を示しています。
- AWS CLI
-
チャットルームのメンバーとしてユーザーを削除する方法
次の
delete-room-membership
の例では、指定されたチャットルームから指定されたメンバーを削除します。aws chime delete-room-membership \ --account-id
12a3456b-7c89-012d-3456-78901e23fg45
\ --room-idabcd1e2d-3e45-6789-01f2-3g45h67i890j
\ --member-id1ab2345c-67de-8901-f23g-45h678901j2k
このコマンドでは何も出力されません。
詳細については、「Amazon Chime ユーザーガイド」の「チャットルームの作成」を参照してください。
-
API の詳細については、「AWS CLI コマンドリファレンス」の「DeleteRoomMembership
」を参照してください。
-
次のコード例では、delete-room
を使用する方法を示しています。
- AWS CLI
-
チャットルームを削除する方法
次の
delete-room
の例では、指定されたチャットルームを削除し、チャットルームメンバーシップを削除します。aws chime delete-room \ --account-id
12a3456b-7c89-012d-3456-78901e23fg45
\ --room-idabcd1e2d-3e45-6789-01f2-3g45h67i890j
このコマンドでは何も出力されません。
詳細については、「Amazon Chime ユーザーガイド」の「チャットルームの作成」を参照してください。
-
API の詳細については、「AWS CLI コマンドリファレンス」の「DeleteRoom
」を参照してください。
-
次のコード例では、delete-voice-connector-group
を使用する方法を示しています。
- AWS CLI
-
title
次の
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 グループの使用方法」を参照してください。
-
API の詳細については、「AWS CLI コマンドリファレンス」の「DeleteVoiceConnectorGroup
」を参照してください。
-
次のコード例では、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 Connector の使用方法」を参照してください。
-
API の詳細については、「AWS CLI コマンドリファレンス」の「DeleteVoiceConnectorOrigination
」を参照してください。
-
次のコード例では、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 デベロッパーガイド」の「プロキシ電話セッション」を参照してください。
-
API の詳細については、「AWS CLI コマンドリファレンス」の「DeleteVoiceConnectorProxy
」を参照してください。
-
次のコード例では、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 にストリーミングする」を参照してください。
-
API の詳細については、「AWS CLI コマンド リファレンス」の「DeleteVoiceConnectorStreamingConfiguration
」を参照してください。
-
次のコード例では、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 Connector の使用方法」を参照してください。
-
API の詳細については、「AWS CLI コマンド リファレンス」の「DeleteVoiceConnectorTerminationCredentials
」を参照してください。
-
次のコード例では、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 Connector の使用方法」を参照してください。
-
API の詳細については、「AWS CLI コマンドリファレンス」の「DeleteVoiceConnectorTermination
」を参照してください。
-
次のコード例では、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 Connector の使用方法」を参照してください。
-
API の詳細については、「AWS CLI コマンドリファレンス」の「DeleteVoiceConnector
」を参照してください。
-
次のコード例では、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-id1ab2345c-67de-8901-f23g-45h678901j2k
このコマンドでは何も出力されません。
詳細については、「Amazon Chime管理ガイド」の「ユーザーの電話番号の管理」を参照してください。
-
API の詳細については、「AWS CLI コマンドリファレンス」の「DisassociatePhoneNumberFromUser
」を参照してください。
-
次のコード例では、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 グループの使用方法」を参照してください。
-
API の詳細については、「AWS CLI コマンドリファレンス」の「DisassociatePhoneNumbersFromVoiceConnectorGroup
」を参照してください。
-
次のコード例では、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 Connector の使用方法」を参照してください。
-
API の詳細については、「AWS CLI コマンドリファレンス」の「DisassociatePhoneNumbersFromVoiceConnector
」を参照してください。
-
次のコード例では、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管理ガイド」の「ユーザーアクセスと許可の管理」を参照してください。
-
API の詳細については、「AWS CLI コマンドリファレンス」の「DisassociateSigninDelegateGroupsFromAccount
」を参照してください。
-
次のコード例では、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 アカウントの管理」を参照してください。
-
API の詳細については、「AWS CLI コマンドリファレンス」の「GetAccountSettings
」を参照してください。
-
次のコード例では、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 の詳細については、「AWS CLI コマンドリファレンス」の「GetAccount
」を参照してください。
-
次のコード例では、get-bot
を使用する方法を示しています。
- AWS CLI
-
ボットの詳細を取得する方法
次の
get-bot
の例では、指定されたポリシーの詳細を表示します。aws chime get-bot \ --account-id
12a3456b-7c89-012d-3456-78901e23fg45
\ --bot-id123abcd4-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 の詳細については、「AWS CLI コマンドリファレンス」の「GetBot
」を参照してください。
-
次のコード例では、get-global-settings
を使用する方法を示しています。
- AWS CLI
-
グローバル設定を取得する方法
次の の
get-global-settings
例では、管理者の AWS アカウントに関連付けられた Amazon Chime Business Calling と Amazon Chime Voice Connector の通話詳細レコードを保存するために使用される S3 バケット名を取得します。aws chime get-global-settings
出力:
{ "BusinessCalling": { "CdrBucket": "s3bucket" }, "VoiceConnector": { "CdrBucket": "s3bucket" } }
詳細については、「Amazon Chime 管理ガイド」の「グローバル設定の管理」を参照してください。
-
API の詳細については、「AWS CLI コマンドリファレンス」の「GetGlobalSettings
」を参照してください。
-
次のコード例では、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 管理ガイド」の「電話番号の使用方法」を参照してください。
-
API の詳細については、「AWS CLI コマンドリファレンス」の「GetPhoneNumberOrder
」を参照してください。
-
次のコード例では、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 管理ガイド」の「電話番号の使用方法」を参照してください。
-
API の詳細については、「AWS CLI コマンドリファレンス」の「GetPhoneNumberSettings
」を参照してください。
-
次のコード例では、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 の詳細については、「AWS CLI コマンドリファレンス」の「GetPhoneNumber
」を参照してください。
-
次のコード例では、get-proxy-session
を使用する方法を示しています。
- AWS CLI
-
プロキシセッションの詳細を取得する方法
次の
get-proxy-session
の例では、指定されたプロキシセッションの詳細を一覧表示します。aws chime get-proxy-session \ --voice-connector-id
abcdef1ghij2klmno3pqr4
\ --proxy-session-id123a4bc5-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 デベロッパーガイド」の「プロキシ電話セッション」を参照してください。
-
API の詳細については、「AWS CLI コマンドリファレンス」の「GetProxySession
」を参照してください。
-
次のコード例では、get-room
を使用する方法を示しています。
- AWS CLI
-
チャットルームの詳細を取得する方法
次の
get-room
の例では、指定されたチャットルームの詳細を表示します。aws chime get-room \ --account-id
12a3456b-7c89-012d-3456-78901e23fg45
\ --room-idabcd1e2d-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 の詳細については、「AWS CLI コマンドリファレンス」の「GetRoom
」を参照してください。
-
次のコード例では、get-user-settings
を使用する方法を示しています。
- AWS CLI
-
ユーザー設定を取得する方法
次の
get-user-settings
の例では、指定されたユーザー設定を表示します。aws chime get-user-settings \ --account-id
12a3456b-7c89-012d-3456-78901e23fg45
\ --user-id1ab2345c-67de-8901-f23g-45h678901j2k
出力:
{ "UserSettings": { "Telephony": { "InboundCalling": true, "OutboundCalling": true, "SMS": true } } }
詳細については、「Amazon Chime 管理ガイド」の「ユーザーの電話番号の管理」を参照してください。
-
API の詳細については、「AWS CLI コマンドリファレンス」の「GetUserSettings
」を参照してください。
-
次のコード例では、get-user
を使用する方法を示しています。
- AWS CLI
-
ポリシーの詳細を取得する方法
次の
get-user
の例では、指定されたユーザーの詳細を取得します。aws chime get-user \ --account-id
a1b2c3d4-5678-90ab-cdef-11111EXAMPLE
\ --user-ida1b2c3d4-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 の詳細については、「AWS CLI コマンドリファレンス」の「GetUser
」を参照してください。
-
次のコード例では、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 グループの使用方法」を参照してください。
-
API の詳細については、「AWS CLI コマンドリファレンス」の「GetVoiceConnectorGroup
」を参照してください。
-
次のコード例では、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 メディアを Kinesis にストリーミングする」を参照してください。
-
API の詳細については、「AWS CLI コマンドリファレンス」の「GetVoiceConnectorLoggingConfiguration
」を参照してください。
-
次のコード例では、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 Connector の使用方法」を参照してください。
-
API の詳細については、「AWS CLI コマンドリファレンス」の「GetVoiceConnectorOrigination
」を参照してください。
-
次のコード例では、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 デベロッパーガイド」の「プロキシ電話セッション」を参照してください。
-
API の詳細については、「AWS CLI コマンドリファレンス」の「GetVoiceConnectorProxy
」を参照してください。
-
次のコード例では、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 にストリーミングする」を参照してください。
-
API の詳細については、「AWS CLI コマンドリファレンス」の「GetVoiceConnectorStreamingConfiguration
」を参照してください。
-
次のコード例では、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 Connector の使用方法」を参照してください。
-
API の詳細については、「AWS CLI コマンドリファレンス」の「GetVoiceConnectorTerminationHealth
」を参照してください。
-
次のコード例では、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 Connector の使用方法」を参照してください。
-
API の詳細については、「AWS CLI コマンドリファレンス」の「GetVoiceConnectorTermination
」を参照してください。
-
次のコード例では、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 Connector の使用方法」を参照してください。
-
API の詳細については、「AWS CLI コマンドリファレンス」の「GetVoiceConnector
」を参照してください。
-
次のコード例では、invite-users
を使用する方法を示しています。
- AWS CLI
-
Amazon Chime に参加するようにユーザーを招待する方法
次の
invite-users
の例では、指定された Amazon Chime アカウントにユーザーを招待する E メールを送信します。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 の詳細については、「AWS CLI コマンドリファレンス」の「InviteUsers
」を参照してください。
-
次のコード例では、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 の詳細については、AWS CLI コマンドリファレンスの「ListAccounts
」を参照してください。
-
次のコード例では、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 の詳細については、「AWS CLI コマンドリファレンス」の「ListBots
」を参照してください。
-
次のコード例では、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 管理ガイド」の「電話番号の使用方法」を参照してください。
-
API の詳細については、「AWS CLI コマンドリファレンス」の「ListPhoneNumberOrders
」を参照してください。
-
次のコード例では、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 の詳細については、「AWS CLI コマンドリファレンス」の「ListPhoneNumbers
」を参照してください。
-
次のコード例では、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 デベロッパーガイド」の「プロキシ電話セッション」を参照してください。
-
API の詳細については、「AWS CLI コマンドリファレンス」の「ListProxySessions
」を参照してください。
-
次のコード例では、list-room-memberships
を使用する方法を示しています。
- AWS CLI
-
ルームメンバーシップを一覧表示する方法
次の
list-room-memberships
の例では、指定されたチャットルームのメンバーシップの詳細を一覧表示します。aws chime list-room-memberships \ --account-id
12a3456b-7c89-012d-3456-78901e23fg45
\ --room-idabcd1e2d-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 ユーザーガイド」の「チャットルームの作成」を参照してください。
-
API の詳細については、「AWS CLI コマンドリファレンス」の「ListRoomMemberships
」を参照してください。
-
次のコード例では、list-rooms
を使用する方法を示しています。
- AWS CLI
-
チャットルームを一覧表示する方法
次の
list-rooms
の例では、指定されたアカウントのチャットルームを一覧表示します。一覧は、指定されたメンバーが属するチャットルームにのみフィルタリングされます。aws chime list-rooms \ --account-id
12a3456b-7c89-012d-3456-78901e23fg45
\ --member-id1ab2345c-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 の詳細については、「AWS CLI コマンドリファレンス」の「ListRooms
」を参照してください。
-
次のコード例では、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 の詳細については、「AWS CLI コマンドリファレンス」の「ListUsers
」を参照してください。
-
次のコード例では、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 グループの使用方法」を参照してください。
-
API の詳細については、「AWS CLI コマンドリファレンス」の「ListVoiceConnectorGroups
」を参照してください。
-
次のコード例では、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 Connector の使用方法」を参照してください。
-
API の詳細については、「AWS CLI コマンドリファレンス」の「ListVoiceConnectorTerminationCredentials
」を参照してください。
-
次のコード例では、list-voice-connectors
を使用する方法を示しています。
- AWS CLI
-
アカウントの Amazon Chime Voice Connector を一覧表示する方法
次の
list-voice-connectors
の例では、呼び出し側のアカウントに関連付けられた Amazon Chime Voice Connector を一覧表示します。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 Connector の使用方法」を参照してください。
-
API の詳細については、「AWS CLI コマンドリファレンス」の「ListVoiceConnectors
」を参照してください。
-
次のコード例では、logout-user
を使用する方法を示しています。
- AWS CLI
-
ユーザーをログアウトさせる方法
次の
logout-user
の例では、指定されたユーザーをログアウトさせます。aws chime logout-user \ --account-id
a1b2c3d4-5678-90ab-cdef-11111EXAMPLE
\ --user-ida1b2c3d4-5678-90ab-cdef-22222EXAMPLE
このコマンドでは何も出力されません。
-
API の詳細については、「AWS CLI コマンドリファレンス」の「LogoutUser
」を参照してください。
-
次のコード例では、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-configurationEnableSIPLogs=true
出力:
{ "LoggingConfiguration": { "EnableSIPLogs": true } }
詳細については、「Amazon Chime 管理ガイド」の「Amazon Chime Voice Connector メディアを Kinesis にストリーミングする」を参照してください。
-
API の詳細については、「AWS CLI コマンドリファレンス」の「PutVoiceConnectorLoggingConfiguration
」を参照してください。
-
次のコード例では、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 Connector の使用方法」を参照してください。
-
API の詳細については、「AWS CLI コマンドリファレンス」の「PutVoiceConnectorOrigination
」を参照してください。
-
次のコード例では、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-minutes60
\ --phone-number-pool-countries"US"
出力:
{ "Proxy": { "DefaultSessionExpiryMinutes": 60, "Disabled": false, "PhoneNumberCountries": [ "US" ] } }
詳細については、「Amazon Chime デベロッパーガイド」の「プロキシ電話セッション」を参照してください。
-
API の詳細については、「AWS CLI コマンドリファレンス」の「PutVoiceConnectorProxy
」を参照してください。
-
次のコード例では、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-configurationDataRetentionInHours=24,Disabled=false
出力:
{ "StreamingConfiguration": { "DataRetentionInHours": 24, "Disabled": false } }
詳細については、「Amazon Chime 管理ガイド」の「Amazon Chime Voice Connector データを Kinesis にストリーミングする」を参照してください。
-
API の詳細については、「AWS CLI コマンドリファレンス」の「PutVoiceConnectorStreamingConfiguration
」を参照してください。
-
次のコード例では、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 Connector の使用方法」を参照してください。
-
API の詳細については、「AWS CLI コマンドリファレンス」の「PutVoiceConnectorTerminationCredentials
」を参照してください。
-
次のコード例では、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 Connector の使用方法」を参照してください。
-
API の詳細については、「AWS CLI コマンドリファレンス」の「PutVoiceConnectorTermination
」を参照してください。
-
次のコード例では、regenerate-security-token
を使用する方法を示しています。
- AWS CLI
-
セキュリティトークンを再生成する方法
次の
regenerate-security-token
の例では、指定されたボットのセキュリティトークンを再生成します。aws chime regenerate-security-token \ --account-id
12a3456b-7c89-012d-3456-78901e23fg45
\ --bot-id123abcd4-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 デベロッパーガイド」の「認証チャットボットのリクエスト」を参照してください。
-
API の詳細については、「AWS CLI コマンドリファレンス」の「RegenerateSecurityToken
」を参照してください。
-
次のコード例では、reset-personal-pin
を使用する方法を示しています。
- AWS CLI
-
ユーザーの個人用会議 PIN をリセットする方法
次の
reset-personal-pin
の例では、指定されたユーザーの個人用会議 PIN をリセットします。aws chime reset-personal-pin \ --account-id
a1b2c3d4-5678-90ab-cdef-11111EXAMPLE
--user-ida1b2c3d4-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 管理ガイド」の「個人用会議 PIN の変更」を参照してください。
-
API の詳細については、「AWS CLI コマンドリファレンス」の「ResetPersonalPin
」を参照してください。
-
次のコード例では、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 管理ガイド」の「電話番号の使用方法」を参照してください。
-
API の詳細については、「AWS CLI コマンドリファレンス」の「RestorePhoneNumber
」を参照してください。
-
次のコード例では、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 管理ガイド」の「電話番号の使用方法」を参照してください。
-
API の詳細については、 「AWS CLI コマンドリファレンス」の「SearchAvailablePhoneNumbers
」を参照してください。
-
次のコード例では、update-account-settings
を使用する方法を示しています。
- AWS CLI
-
アカウントの設定を更新する方法
次の
update-account-settings
の例では、指定された Amazon Chime アカウントの共有画面のリモートコントロールを無効にします。aws chime update-account-settings \ --account-id
a1b2c3d4-5678-90ab-cdef-11111EXAMPLE
\ --account-settingsDisableRemoteControl=true
このコマンドでは何も出力されません。
-
API の詳細については、「AWS CLI コマンドリファレンス」の「UpdateAccountSettings
」を参照してください。
-
次のコード例では、update-account
を使用する方法を示しています。
- AWS CLI
-
アカウントを更新する方法
次の
update-account
の例では、指定されたアカウント名を更新します。aws chime update-account \ --account-id
a1b2c3d4-5678-90ab-cdef-11111EXAMPLE
\ --nameMyAccountName
出力:
{ "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 の詳細については、「AWS CLI コマンドリファレンス」の「UpdateAccount
」を参照してください。
-
次のコード例では、update-bot
を使用する方法を示しています。
- AWS CLI
-
ボットを更新する方法
次の
update-bot
の例では、指定されたボットのステータスを更新して、実行を停止します。aws chime update-bot \ --account-id
12a3456b-7c89-012d-3456-78901e23fg45
\ --bot-id123abcd4-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 の詳細については、「AWS CLI コマンドリファレンス」の「UpdateBot
」を参照してください。
-
次のコード例では、update-global-settings
を使用する方法を示しています。
- AWS CLI
-
グローバル設定を更新する方法
次の の
update-global-settings
例では、管理者の AWS アカウントに関連付けられた Amazon Chime Business Calling および Amazon Chime Voice Connector の通話詳細レコードを保存するために使用される S3 バケットを更新します。aws chime update-global-settings \ --business-calling CdrBucket="s3bucket" \ --voice-connector CdrBucket="s3bucket"
このコマンドでは何も出力されません。
詳細については、「Amazon Chime 管理ガイド」の「グローバル設定の管理」を参照してください。
-
API の詳細については、「AWS CLI コマンドリファレンス」の「UpdateGlobalSettings
」を参照してください。
-
次のコード例では、update-phone-number-settings
を使用する方法を示しています。
- AWS CLI
-
アウトバウンド呼び出し名を更新する方法
次の の
update-phone-number-settings
例では、管理者の AWS アカウントのデフォルトのアウトバウンド呼び出し名を更新します。aws chime update-phone-number-settings \ --calling-name
"myName"
このコマンドでは何も出力されません。
詳細については、「Amazon Chime 管理ガイド」の「電話番号の使用方法」を参照してください。
-
API の詳細については、「AWS CLI コマンドリファレンス」の「UpdatePhoneNumberSettings
」を参照してください。
-
次のコード例では、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 管理ガイド」の「電話番号の使用方法」を参照してください。
-
API の詳細については、「AWS CLI コマンドリファレンス」の「UpdatePhoneNumber
」を参照してください。
-
次のコード例では、update-proxy-session
を使用する方法を示しています。
- AWS CLI
-
プロキシセッションを更新する方法
次の
update-proxy-session
の例では、プロキシセッション機能を更新します。aws chime update-proxy-session \ --voice-connector-id
abcdef1ghij2klmno3pqr4
\ --proxy-session-id123a4bc5-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 デベロッパーガイド」の「プロキシ電話セッション」を参照してください。
-
API の詳細については、「AWS CLI コマンドリファレンス」の「UpdateProxySession
」を参照してください。
-
次のコード例では、update-room-membership
を使用する方法を示しています。
- AWS CLI
-
ルームメンバーシップを更新する方法
次の
update-room-membership
の例では、指定されたチャットルームメンバーのロールをAdministrator
に変更します。aws chime update-room-membership \ --account-id
12a3456b-7c89-012d-3456-78901e23fg45
\ --room-idabcd1e2d-3e45-6789-01f2-3g45h67i890j
\ --member-id1ab2345c-67de-8901-f23g-45h678901j2k
\ --roleAdministrator
出力:
{ "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 ユーザーガイド」の「チャットルームの作成」を参照してください。
-
API の詳細については、「AWS CLI コマンドリファレンス」の「UpdateRoomMembership
」を参照してください。
-
次のコード例では、update-room
を使用する方法を示しています。
- AWS CLI
-
チャットルームを更新する方法
次の
update-room
の例では、指定されたチャットルームの名前を変更します。aws chime update-room \ --account-id
12a3456b-7c89-012d-3456-78901e23fg45
\ --room-idabcd1e2d-3e45-6789-01f2-3g45h67i890j
\ --nameteamRoom
出力:
{ "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 の詳細については、「AWS CLI コマンドリファレンス」の「UpdateRoom
」を参照してください。
-
次のコード例では、update-user-settings
を使用する方法を示しています。
- AWS CLI
-
ユーザー設定を更新する方法
次の
update-user-settings
の例では、指定されたユーザーがインバウンドコールとアウトバウンドコールを行い、SMS メッセージを送受信できるようにします。aws chime update-user-settings \ --account-id
12a3456b-7c89-012d-3456-78901e23fg45
\ --user-id1ab2345c-67de-8901-f23g-45h678901j2k
\ --user-settings"Telephony={InboundCalling=true,OutboundCalling=true,SMS=true}"
このコマンドでは何も出力されません。
詳細については、「Amazon Chime 管理ガイド」の「ユーザーの電話番号の管理」を参照してください。
-
API の詳細については、「AWS CLI コマンドリファレンス」の「UpdateUserSettings
」を参照してください。
-
次のコード例では、update-user
を使用する方法を示しています。
- AWS CLI
-
ユーザーの詳細を更新する方法
この例では、指定されたユーザーの指定された詳細を更新します。
コマンド:
aws chime update-user \ --account-id
a1b2c3d4-5678-90ab-cdef-11111EXAMPLE
\ --user-ida1b2c3d4-5678-90ab-cdef-22222EXAMPLE
\ --license-type"Basic"
出力:
{ "User": { "UserId": "a1b2c3d4-5678-90ab-cdef-22222EXAMPLE" } }
-
API の詳細については、「AWS CLI コマンドリファレンス」の「UpdateUser
」を参照してください。
-
次のコード例では、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-itemsVoiceConnectorId=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 グループの使用方法」を参照してください。
-
API の詳細については、「AWS CLI コマンドリファレンス」の「UpdateVoiceConnectorGroup
」を参照してください。
-
次のコード例では、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
\ --namenewName
\ --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 Connector の使用方法」を参照してください。
-
API の詳細については、「AWS CLI コマンドリファレンス」の「UpdateVoiceConnector
」を参照してください。
-