を使用した 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-id 1ab2345c-67de-8901-f23g-45h678901j2k \
    --e164-phone-number "+12065550100"

このコマンドでは何も出力されません。

詳細については、「Amazon Chime 管理ガイド」の「ユーザーの電話番号の管理」を参照してください。

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

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

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

次のコード例は、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 管理ガイド」の「ユーザーアクセスとアクセス許可の管理」を参照してください。

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

次のコード例は、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 ユーザーガイド」の「チャットルームの作成」を参照してください。

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

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

次のコード例は、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": []
}

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

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

次のコード例は、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 詳細については、「コマンドリファレンス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 エンタープライズアカウントのボットを作成します。


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 管理ガイド」の「電話番号の使用」を参照してください。

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

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

次の例は、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 ユーザーガイド」の「チャットルームの作成」を参照してください。

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

次のコード例は、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例では、指定された E メールアドレスの共有デバイスプロファイルを作成します。


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 グループの使用」を参照してください。

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

次のコード例は、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 Connector の使用」を参照してください。

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

次の例は、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 管理ガイド」の「電話番号の使用」を参照してください。

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

次のコード例は、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 デベロッパーガイド」の「プロキシ電話セッション」を参照してください。

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

次のコード例は、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 ユーザーガイド」の「チャットルームの作成」を参照してください。

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

次の例は、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

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

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

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

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

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

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

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

次の例は、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 管理ガイド」の「ユーザーの電話番号の管理」を参照してください。

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

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

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

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

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

次の例は、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 Connector の通話詳細レコードを保存するために使用される S3 バケット名を取得します。


aws chime get-global-settings

出力:


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

詳細については、「Amazon Chime 管理ガイド」の「グローバル設定の管理」を参照してください。

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

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

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

次の例は、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 デベロッパーガイド」の「プロキシ電話セッション」を参照してください。

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 グループの使用」を参照してください。

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

次の例は、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 にストリーミングする」を参照してください。

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

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

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

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

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

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

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

次の例は、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 詳細については、「コマンドリファレンス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 エンタープライズアカウントに関連付けられているボットを一覧表示します。


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 管理ガイド」の「電話番号の使用」を参照してください。

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

次の例は、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 デベロッパーガイド」の「プロキシ電話セッション」を参照してください。

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

次の例は、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 ユーザーガイド」の「チャットルームの作成」を参照してください。

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

次のコード例は、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 グループの使用」を参照してください。

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

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

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

次のコード例は、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 へのストリーミング」を参照してください。

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

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

次の例は、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 デベロッパーガイド」の「プロキシ電話セッション」を参照してください。

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

次のコード例は、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 へのストリーミング」を参照してください。

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

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

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

次のコード例は、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 デベロッパーガイド」の「チャットボットリクエストの認証」を参照してください。

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

次の例は、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 管理ガイド」の「電話番号の使用」を参照してください。

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

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

次のコード例は、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

このコマンドでは何も出力されません。

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

次の例は、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 Connector の通話詳細レコードを保存するために使用される S3 バケットを更新します。


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

このコマンドでは何も出力されません。

詳細については、「Amazon Chime 管理ガイド」の「グローバル設定の管理」を参照してください。

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

次のコード例は、update-phone-number-settings を使用する方法を示しています。

AWS CLI

発信通話名を更新するには

次のupdate-phone-number-settings例では、管理者の AWS アカウントのデフォルトの発信通話名を更新します。


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

このコマンドでは何も出力されません。

詳細については、「Amazon Chime 管理ガイド」の「電話番号の使用」を参照してください。

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

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

次のコード例は、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 デベロッパーガイド」の「プロキシ電話セッション」を参照してください。

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

次の例は、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 ユーザーガイド」の「チャットルームの作成」を参照してください。

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

次の例は、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 管理ガイド」の「ユーザーの電話番号の管理」を参照してください。

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

次のコード例は、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 グループの使用」を参照してください。

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

次のコード例は、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 Connector の使用」を参照してください。

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

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

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

ドキュメントの表記規則

AWS Budgets

クラウドコントロール API