使用 Amazon Chime 示例 AWS CLI - AWS SDK代码示例
操作

AWS 文档 AWS SDK示例 GitHub 存储库中还有更多SDK示例。

本文属于机器翻译版本。若本译文内容与英语原文存在差异，则一律以英文原文为准。

使用 Amazon Chime 示例 AWS CLI

以下代码示例向您展示了如何使用 AWS Command Line Interface 与 Amazon Chime 搭配使用来执行操作和实现常见场景。

操作是大型程序的代码摘录，必须在上下文中运行。您可以通过操作了解如何调用单个服务函数，还可以通过函数相关场景的上下文查看操作。

每个示例都包含一个指向完整源代码的链接，您可以在其中找到有关如何在上下文中设置和运行代码的说明。

主题

操作

以下代码示例演示如何使用 associate-phone-number-with-user。

AWS CLI

将电话号码与用户关联

以下associate-phone-number-with-user示例将指定的电话号码与用户关联。

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

此命令不生成任何输出。

有关更多信息，请参阅 Amazon Chime 管理指南中的管理用户电话号码。

以下代码示例演示如何使用 associate-phone-numbers-with-voice-connector-group。

AWS CLI

将电话号码与 Amazon Chime 语音连接器群组关联

以下associate-phone-numbers-with-voice-connector-group示例将指定的电话号码与 Amazon Chime 语音连接器组相关联。

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": []
}

有关更多信息，请参阅《亚马逊 Chime 管理指南》中的 “使用亚马逊 Chime 语音连接器群组”。

以下代码示例演示如何使用 associate-phone-numbers-with-voice-connector。

AWS CLI

将电话号码与 Amazon Chime 语音连接器关联

以下associate-phone-numbers-with-voice-connector示例将指定的电话号码与 Amazon Chime 语音连接器相关联。

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

输出：

{
    "PhoneNumberErrors": []
}

有关更多信息，请参阅《亚马逊 Chime 管理指南》中的 “使用 Amaz on Chime 语音连接器”。

以下代码示例演示如何使用 associate-signin-delegate-groups-with-account。

AWS CLI

关联登录代表群组

以下associate-signin-delegate-groups-with-account示例将指定的登录委托群组与指定的 Amazon Chime 账户相关联。

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

此命令不生成任何输出。

有关更多信息，请参阅 Amazon Chime 管理指南中的管理用户访问和权限。

以下代码示例演示如何使用 batch-create-room-membership。

AWS CLI

创建多个房间成员资格

以下batch-create-room-membership示例将多个用户作为聊天室成员添加到聊天室。它还为用户分配管理员和成员角色。

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

输出：

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

有关更多信息，请参阅 Amazon Chime 用户指南中的创建聊天室。

以下代码示例演示如何使用 batch-delete-phone-number。

AWS CLI

删除多个电话号码

以下batch-delete-phone-number示例删除了所有指定的电话号码。

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

此命令不生成任何输出。输出：

{
    "PhoneNumberErrors": []
}

有关更多信息，请参阅 Amazon Chime 管理指南中的使用电话号码。

以下代码示例演示如何使用 batch-suspend-user。

AWS CLI

暂停多个用户

以下batch-suspend-user示例暂停列出的用户使用指定 Amazon Chime 账户。

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

输出：

{
    "UserErrors": []
}

以下代码示例演示如何使用 batch-unsuspend-user。

AWS CLI

取消暂停多个用户

以下batch-unsuspend-user示例取消了之前对指定 Amazon Chime 账户中列出的用户的任何暂停。

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

输出：

{
    "UserErrors": []
}

以下代码示例演示如何使用 batch-update-phone-number。

AWS CLI

同时更新多个电话号码产品类型

以下batch-update-phone-number示例更新了所有指定电话号码的产品类型。

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

输出：

{
    "PhoneNumberErrors": []
}

要同时更新多个电话号码呼叫姓名

以下batch-update-phone-number示例更新了所有指定电话号码的呼叫者姓名。

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

输出：

{
    "PhoneNumberErrors": []
}

有关更多信息，请参阅 Amazon Chime 管理指南中的使用电话号码。

以下代码示例演示如何使用 batch-update-user。

AWS CLI

使用单个命令更新多个用户

以下batch-update-user示例更新了LicenseType指定 Amazon Chime 账户中列出的每位用户的。

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

输出：

{
    "UserErrors": []
}

以下代码示例演示如何使用 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 管理指南》中的入门指南。

以下代码示例演示如何使用 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"
    }
}

有关更多信息，请参阅《亚马逊 Chime 开发者指南》中的将聊天机器人与 Ama zon Chime 集成。

以下代码示例演示如何使用 create-phone-number-order。

AWS CLI

创建电话号码订单

以下create-phone-number-order示例为指定的电话号码创建电话号码顺序。

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

输出：

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

有关更多信息，请参阅 Amazon Chime 管理指南中的使用电话号码。

以下代码示例演示如何使用 create-proxy-session。

AWS CLI

创建代理会话

以下create-proxy-session示例创建了一个具有语音和SMS功能的代理会话。

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

输出：

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

有关更多信息，请参阅 Amazon Chime 开发者指南中的代理电话会话。

以下代码示例演示如何使用 create-room-membership。

AWS CLI

创建聊天室成员资格

以下create-room-membership示例将指定用户作为聊天室成员添加到聊天室。

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

输出：

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

有关更多信息，请参阅 Amazon Chime 用户指南中的创建聊天室。

以下代码示例演示如何使用 create-room。

AWS CLI

创建聊天室

以下create-room示例为指定的 Amazon Chime 账户创建聊天室。

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

输出：

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

有关更多信息，请参阅 Amazon Chime 用户指南中的创建聊天室。

以下代码示例演示如何使用 create-user。

AWS CLI

为共享设备创建用户配置文件

以下create-user示例为指定的电子邮件地址创建共享设备配置文件。

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

输出：

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

有关更多信息，请参阅《Amazon Chime 管理指南》中的 “准备安装”。

以下代码示例演示如何使用 create-voice-connector-group。

AWS CLI

创建 Amazon Chime 语音连接器群组

以下create-voice-connector-group示例创建了一个 Amazon Chime 语音连接器组，其中包括指定的 Amazon Chime 语音连接器。

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"
    }
}

有关更多信息，请参阅《亚马逊 Chime 管理指南》中的 “使用亚马逊 Chime 语音连接器组”。

以下代码示例演示如何使用 create-voice-connector。

AWS CLI

创建 Amazon Chime 语音连接器

以下create-voice-connector示例在指定 AWS 区域创建启用加密的 Amazon Chime 语音连接器。

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"
    }
}

有关更多信息，请参阅《亚马逊 Chime 管理指南》中的 “使用 Amaz on Chime 语音连接器”。

以下代码示例演示如何使用 delete-account。

AWS CLI

删除账户

以下delete-account示例删除了指定的账户。

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

此命令不生成任何输出。

有关更多信息，请参阅《Amazon Chime 管理指南》中的 “删除您的账户”。

以下代码示例演示如何使用 delete-phone-number。

AWS CLI

删除电话号码

以下delete-phone-number示例将指定的电话号码移入删除队列。

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

此命令不生成任何输出。

有关更多信息，请参阅 Amazon Chime 管理指南中的使用电话号码。

以下代码示例演示如何使用 delete-proxy-session。

AWS CLI

删除代理会话

以下delete-proxy-session示例删除了指定的代理会话。

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

此命令不生成任何输出。

有关更多信息，请参阅 Amazon Chime 开发者指南中的代理电话会话。

以下代码示例演示如何使用 delete-room-membership。

AWS CLI

删除聊天室成员的用户

以下delete-room-membership示例将指定成员从指定的聊天室中移除。

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

此命令不生成任何输出。

有关更多信息，请参阅 Amazon Chime 用户指南中的创建聊天室。

以下代码示例演示如何使用 delete-room。

AWS CLI

删除聊天室

以下delete-room示例删除了指定的聊天室并删除了聊天室成员资格。

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

此命令不生成任何输出。

有关更多信息，请参阅 Amazon Chime 用户指南中的创建聊天室。

以下代码示例演示如何使用 delete-voice-connector-group。

AWS CLI

title

以下delete-voice-connector-group示例删除指定的 Amazon Chime 语音连接器组。

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

此命令不生成任何输出。

有关更多信息，请参阅《亚马逊 Chime 管理指南》中的 “使用亚马逊 Chime 语音连接器组”。

以下代码示例演示如何使用 delete-voice-connector-origination。

AWS CLI

删除起源设置

以下delete-voice-connector-origination示例从指定的 Amazon Chime 语音连接器中删除源主机、端口、协议、优先级和权重。

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

此命令不生成任何输出。

有关更多信息，请参阅《亚马逊 Chime 管理指南》中的 “使用 Amaz on Chime 语音连接器”。

以下代码示例演示如何使用 delete-voice-connector-proxy。

AWS CLI

删除代理配置

以下delete-voice-connector-proxy示例从您的 Amazon Chime 语音连接器中删除代理配置。

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

此命令不生成任何输出。

有关更多信息，请参阅 Amazon Chime 开发者指南中的代理电话会话。

以下代码示例演示如何使用 delete-voice-connector-streaming-configuration。

AWS CLI

删除直播配置

以下delete-voice-connector-streaming-configuration示例删除了指定 Amazon Chime 语音连接器的直播配置。

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

此命令不生成任何输出。

有关更多信息，请参阅《亚马逊 Chime 管理指南》中的将 Amazon Chime 语音连接器数据流式传输到 Kinesis。

以下代码示例演示如何使用 delete-voice-connector-termination-credentials。

AWS CLI

删除终止凭证

以下delete-voice-connector-termination-credentials示例删除了指定用户名和 Amazon Chime Voice Connector 的终止凭证。

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

此命令不生成任何输出。

有关更多信息，请参阅《亚马逊 Chime 管理指南》中的 “使用 Amaz on Chime 语音连接器”。

以下代码示例演示如何使用 delete-voice-connector-termination。

AWS CLI

删除终止设置

以下delete-voice-connector-termination示例删除了指定 Amazon Chime 语音连接器的终止设置。

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

此命令不生成任何输出。

有关更多信息，请参阅《亚马逊 Chime 管理指南》中的 “使用 Amaz on Chime 语音连接器”。

以下代码示例演示如何使用 delete-voice-connector。

AWS CLI

删除 Amazon Chime 语音连接器

以下delete-voice-connector示例就是这样做的

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

此命令不生成任何输出。

有关更多信息，请参阅《亚马逊 Chime 管理指南》中的 “使用 Amaz on Chime 语音连接器”。

以下代码示例演示如何使用 disassociate-phone-number-from-user。

AWS CLI

取消电话号码与用户的关联

以下disassociate-phone-number-from-user示例取消电话号码与指定用户的关联。

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

此命令不生成任何输出。

有关更多信息，请参阅 Amazon Chime 管理指南中的管理用户电话号码。

以下代码示例演示如何使用 disassociate-phone-numbers-from-voice-connector-group。

AWS CLI

取消电话号码与 Amazon Chime 语音连接器群组的关联

以下disassociate-phone-numbers-from-voice-connector-group示例取消指定电话号码与 Amazon Chime 语音连接器群组的关联。

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

输出：

{
    "PhoneNumberErrors": []
}

有关更多信息，请参阅《亚马逊 Chime 管理指南》中的 “使用亚马逊 Chime 语音连接器组”。

以下代码示例演示如何使用 disassociate-phone-numbers-from-voice-connector。

AWS CLI

取消电话号码与 Amazon Chime 语音连接器的关联

以下disassociate-phone-numbers-from-voice-connector示例取消指定电话号码与 Amazon Chime 语音连接器的关联。

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

输出：

{
    "PhoneNumberErrors": []
}

有关更多信息，请参阅《亚马逊 Chime 管理指南》中的 “使用 Amaz on Chime 语音连接器”。

以下代码示例演示如何使用 disassociate-signin-delegate-groups-from-account。

AWS CLI

取消关联登录代表群组

以下disassociate-signin-delegate-groups-from-account示例取消指定登录委托群组与指定的 Amazon Chime 账户的关联。

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

此命令不生成任何输出。

有关更多信息，请参阅 Amazon Chime 管理指南中的管理用户访问和权限。

以下代码示例演示如何使用 get-account-settings。

AWS CLI

检索账户的设置

以下get-account-settings示例检索指定账户的账户设置。

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

输出：

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

有关更多信息，请参阅《亚马逊 Chime 管理指南》中的 “管理您的亚马逊 Chime 账户”。

以下代码示例演示如何使用 get-account。

AWS CLI

检索账户的详细信息

以下get-account示例检索指定的 Amazon Chime 账户的详细信息。

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

输出：

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

有关更多信息，请参阅《亚马逊 Chime 管理指南》中的 “管理您的亚马逊 Chime 账户”。

以下代码示例演示如何使用 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示例检索用于存储与管理员账户关联的 Amazon Chime Business Calling 和 Amazon Chime 语音连接器的通话详细记录的 S3 存储桶名称。 AWS 

aws chime get-global-settings

输出：

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

有关更多信息，请参阅 Amazon Chime 管理指南中的管理全局设置。

以下代码示例演示如何使用 get-phone-number-order。

AWS CLI

要获取电话号码订单的详细信息

以下get-phone-number-order示例显示了指定电话号码顺序的详细信息。

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

输出：

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

有关更多信息，请参阅 Amazon Chime 管理指南中的使用电话号码。

以下代码示例演示如何使用 get-phone-number-settings。

AWS CLI

检索出站呼叫者姓名

以下get-phone-number-settings示例检索主叫用户 AWS 账户的默认出站呼叫名称。

aws chime get-phone-number-settings

此命令不生成任何输出。输出：

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

有关更多信息，请参阅 Amazon Chime 管理指南中的使用电话号码。

以下代码示例演示如何使用 get-phone-number。

AWS CLI

获取电话号码详情

以下get-phone-number示例显示了指定电话号码的详细信息。

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

输出：

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

有关更多信息，请参阅 Amazon Chime 管理指南中的使用电话号码。

以下代码示例演示如何使用 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 开发者指南中的代理电话会话。

以下代码示例演示如何使用 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 用户指南中的创建聊天室。

以下代码示例演示如何使用 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 管理指南中的管理用户电话号码。

以下代码示例演示如何使用 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 管理指南中的管理用户。

以下代码示例演示如何使用 get-voice-connector-group。

AWS CLI

要获取 Amazon Chime Voice Connector 群组的详细信息

以下get-voice-connector-group示例显示了指定 Amazon Chime 语音连接器组的详细信息。

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"
    }
}

有关更多信息，请参阅《亚马逊 Chime 管理指南》中的 “使用亚马逊 Chime 语音连接器组”。

以下代码示例演示如何使用 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
    }
}

有关更多信息，请参阅《亚马逊 Chime 管理指南》中的 “将 Amazon Chime 语音连接器媒体流式传输到 Kinesis”。

以下代码示例演示如何使用 get-voice-connector-origination。

AWS CLI

检索起源设置

以下get-voice-connector-origination示例检索指定 Amazon Chime Voice Connector 的源主机、端口、协议、优先级和权重。

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

输出：

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

有关更多信息，请参阅《亚马逊 Chime 管理指南》中的 “使用 Amaz on Chime 语音连接器”。

以下代码示例演示如何使用 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 开发者指南中的代理电话会话。

以下代码示例演示如何使用 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
    }
}

有关更多信息，请参阅《亚马逊 Chime 管理指南》中的将 Amazon Chime 语音连接器数据流式传输到 Kinesis。

以下代码示例演示如何使用 get-voice-connector-termination-health。

AWS CLI

检索终止健康状况详细信息

以下get-voice-connector-termination-health示例检索指定 Amazon Chime 语音连接器的终止运行状况详情。

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"
    }
}

有关更多信息，请参阅《亚马逊 Chime 管理指南》中的 “使用 Amaz on Chime 语音连接器”。

以下代码示例演示如何使用 get-voice-connector-termination。

AWS CLI

检索终止设置

以下get-voice-connector-termination示例检索指定 Amazon Chime 语音连接器的终止设置。

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
    }
}

有关更多信息，请参阅《亚马逊 Chime 管理指南》中的 “使用 Amaz on Chime 语音连接器”。

以下代码示例演示如何使用 get-voice-connector。

AWS CLI

要获取 Amazon Chime 语音连接器的详细信息

以下get-voice-connector示例显示了指定 Amazon Chime 语音连接器的详细信息。

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"
    }
}

有关更多信息，请参阅《亚马逊 Chime 管理指南》中的 “使用 Amaz on Chime 语音连接器”。

以下代码示例演示如何使用 invite-users。

AWS CLI

邀请用户加入 Amazon Chime

以下invite-users示例发送一封电子邮件邀请用户使用指定的 Amazon Chime 账户。

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

输出：

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

有关更多信息，请参阅 Amazon Chime 管理指南中的邀请和暂停用户。

以下代码示例演示如何使用 list-accounts。

AWS CLI

获取账户列表

以下list-accounts示例检索管理员 AWS 账户中的 Amazon Chime 账户列表。

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"
                },
            ]
        }
    ]
}

有关更多信息，请参阅《亚马逊 Chime 管理指南》中的 “管理您的亚马逊 Chime 账户”。

以下代码示例演示如何使用 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"
    }
}

有关更多信息，请参阅《亚马逊 Chime 开发者指南》中的将聊天机器人与 Amaz on Chime 配合使用。

以下代码示例演示如何使用 list-phone-number-orders。

AWS CLI

列出电话号码订单

以下list-phone-number-orders示例列出了与 Amazon Chime 管理员账户关联的电话号码订单。

aws chime list-phone-number-orders

输出：

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

有关更多信息，请参阅 Amazon Chime 管理指南中的使用电话号码。

以下代码示例演示如何使用 list-phone-numbers。

AWS CLI

列出 Amazon Chime 账户的电话号码

以下list-phone-numbers示例列出了与管理员的 Amazon Chime 账户关联的电话号码。

aws chime list-phone-numbers

此命令不生成任何输出。输出：

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

有关更多信息，请参阅 Amazon Chime 管理指南中的使用电话号码。

以下代码示例演示如何使用 list-proxy-sessions。

AWS CLI

列出代理会话

以下list-proxy-sessions示例列出了您的 Amazon Chime 语音连接器的代理会话。

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 开发者指南中的代理电话会话。

以下代码示例演示如何使用 list-room-memberships。

AWS CLI

列出房间成员资格

以下list-room-memberships示例显示了指定聊天室的成员资格详细信息列表。

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

输出：

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

有关更多信息，请参阅 Amazon Chime 用户指南中的创建聊天室。

以下代码示例演示如何使用 list-rooms。

AWS CLI

列出聊天室

以下list-rooms示例显示了指定账户中的聊天室列表。列表仅筛选到指定成员所属的聊天室。

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

输出：

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

有关更多信息，请参阅 Amazon Chime 用户指南中的创建聊天室。

以下代码示例演示如何使用 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 管理指南中的管理用户。

以下代码示例演示如何使用 list-voice-connector-groups。

AWS CLI

列出亚马逊 Chime 账户的亚马逊 Chime 语音连接器群组

以下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"
        }
    ]
}

有关更多信息，请参阅《亚马逊 Chime 管理指南》中的 “使用亚马逊 Chime 语音连接器群组”。

以下代码示例演示如何使用 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"
    ]
}

有关更多信息，请参阅《亚马逊 Chime 管理指南》中的 “使用 Amaz on Chime 语音连接器”。

以下代码示例演示如何使用 list-voice-connectors。

AWS CLI

列出账户的 Amazon Chime 语音连接器

以下list-voice-connectors示例列出了与来电者账户关联的 Amazon Chime 语音连接器。

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"
        }
    ]
}

有关更多信息，请参阅《亚马逊 Chime 管理指南》中的 “使用 Amaz on Chime 语音连接器”。

以下代码示例演示如何使用 logout-user。

AWS CLI

注销用户

以下logout-user示例注销了指定的用户。

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

此命令不生成任何输出。

以下代码示例演示如何使用 put-voice-connector-logging-configuration。

AWS CLI

为 Amazon Chime 语音连接器添加日志配置

以下put-voice-connector-logging-configuration示例为指定的 Amazon Chime 语音连接器开启SIP日志配置。

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

输出：

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

有关更多信息，请参阅《亚马逊 Chime 管理指南》中的 “将 Amazon Chime 语音连接器媒体流式传输到 Kinesis”。

以下代码示例演示如何使用 put-voice-connector-origination。

AWS CLI

要设置起源设置

以下put-voice-connector-origination示例为指定的 Amazon Chime 语音连接器设置源主机、端口、协议、优先级和权重。

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
    }
}

有关更多信息，请参阅《亚马逊 Chime 管理指南》中的 “使用 Amaz on Chime 语音连接器”。

以下代码示例演示如何使用 put-voice-connector-proxy。

AWS CLI

放置代理配置

以下put-voice-connector-proxy示例为您的 Amazon Chime 语音连接器设置代理配置。

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 开发者指南中的代理电话会话。

以下代码示例演示如何使用 put-voice-connector-streaming-configuration。

AWS CLI

创建直播配置

以下put-voice-connector-streaming-configuration示例为指定的 Amazon Chime 语音连接器创建直播配置。它支持将媒体从 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
    }
}

有关更多信息，请参阅《亚马逊 Chime 管理指南》中的将 Amazon Chime 语音连接器数据流式传输到 Kinesis。

以下代码示例演示如何使用 put-voice-connector-termination-credentials。

AWS CLI

设置终止凭证

以下put-voice-connector-termination-credentials示例为指定的 Amazon Chime 语音连接器设置终止凭证。

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

此命令不生成任何输出。

有关更多信息，请参阅《亚马逊 Chime 管理指南》中的 “使用 Amaz on Chime 语音连接器”。

以下代码示例演示如何使用 put-voice-connector-termination。

AWS CLI

要设置终止设置

以下put-voice-connector-termination示例为指定的 Amazon Chime 语音连接器设置呼叫区域和允许的 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
    }
}

有关更多信息，请参阅《亚马逊 Chime 管理指南》中的 “使用 Amaz on Chime 语音连接器”。

以下代码示例演示如何使用 regenerate-security-token。

AWS CLI

重新生成安全令牌

以下regenerate-security-token示例为指定的机器人重新生成安全令牌。

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

输出：

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

有关更多信息，请参阅 Amazon Chime 开发者指南中的验证聊天机器人请求。

以下代码示例演示如何使用 reset-personal-pin。

AWS CLI

重置用户的个人会议 PIN

以下reset-personal-pin示例重置了指定用户的个人会议PIN。

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

输出：

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

有关更多信息，请参阅 Amazon Chime 管理指南PINs中的更改个人会议。

以下代码示例演示如何使用 restore-phone-number。

AWS CLI

恢复电话号码

以下restore-phone-number示例从删除队列中恢复指定的电话号码。

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

输出：

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

有关更多信息，请参阅 Amazon Chime 管理指南中的使用电话号码。

以下代码示例演示如何使用 search-available-phone-numbers。

AWS CLI

搜索可用的电话号码

以下search-available-phone-numbers示例按区号搜索可用的电话号码。

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

输出：

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

有关更多信息，请参阅 Amazon Chime 管理指南中的使用电话号码。

以下代码示例演示如何使用 update-account-settings。

AWS CLI

更新您的账户设置

以下update-account-settings示例禁用了指定 Amazon Chime 账户对共享屏幕的远程控制。

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

此命令不生成任何输出。

以下代码示例演示如何使用 update-account。

AWS CLI

更新账户

以下update-account示例更新了指定的账户名。

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

输出：

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

有关更多信息，请参阅 Amazon Chime 管理指南中的重命名您的账户。

以下代码示例演示如何使用 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 开发者指南中的更新聊天机器人。

以下代码示例演示如何使用 update-global-settings。

AWS CLI

更新全局设置

以下update-global-settings示例更新了用于存储与管理员账户关联的 Amazon Chime 商务通话和 Amazon Chime 语音连接器的通话详细记录的 S3 存储桶。 AWS 

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

此命令不生成任何输出。

有关更多信息，请参阅 Amazon Chime 管理指南中的管理全局设置。

以下代码示例演示如何使用 update-phone-number-settings。

AWS CLI

更新出站呼叫姓名

以下update-phone-number-settings示例更新了管理员 AWS 账户的默认出站呼叫名称。

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

此命令不生成任何输出。

有关更多信息，请参阅 Amazon Chime 管理指南中的使用电话号码。

以下代码示例演示如何使用 update-phone-number。

AWS CLI

示例 1：更新电话号码的产品类型

以下update-phone-number示例更新了指定电话号码的产品类型。

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

输出：

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

示例 2：更新电话号码的出站呼叫名称

以下update-phone-number示例更新指定电话号码的出站呼叫名称。

aws chime — phone-number-id “+12065550100” — calling update-phone-number-name “phonenumber2”

输出：

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

有关更多信息，请参阅 Amazon Chime 管理指南中的使用电话号码。

以下代码示例演示如何使用 update-proxy-session。

AWS CLI

更新代理会话

以下update-proxy-session示例更新了代理会话功能。

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

输出：

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

有关更多信息，请参阅 Amazon Chime 开发者指南中的代理电话会话。

以下代码示例演示如何使用 update-room-membership。

AWS CLI

更新聊天室成员资格

以下update-room-membership示例将指定聊天室成员的角色修改为。Administrator

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

输出：

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

有关更多信息，请参阅 Amazon Chime 用户指南中的创建聊天室。

以下代码示例演示如何使用 update-room。

AWS CLI

更新聊天室

以下update-room示例修改了指定聊天室的名称。

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

输出：

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

有关更多信息，请参阅 Amazon Chime 用户指南中的创建聊天室。

  • 有关API详细信息，请参阅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-id 1ab2345c-67de-8901-f23g-45h678901j2k \
    --user-settings "Telephony={InboundCalling=true,OutboundCalling=true,SMS=true}"

此命令不生成任何输出。

有关更多信息，请参阅 Amazon Chime 管理指南中的管理用户电话号码。

以下代码示例演示如何使用 update-user。

AWS CLI

更新用户详细信息

此示例更新了指定用户的指定详细信息。

命令:

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

输出：

{
    "User": {
        "UserId": "a1b2c3d4-5678-90ab-cdef-22222EXAMPLE"
    }
}

  • 有关API详细信息，请参阅AWS CLI 命令参考UpdateUser中的。

以下代码示例演示如何使用 update-voice-connector-group。

AWS CLI

更新 Amazon Chime Voice Connector 群组的详细信息

以下update-voice-connector-group示例更新了指定 Amazon Chime 语音连接器组的详细信息。

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"
    }
}

有关更多信息，请参阅《亚马逊 Chime 管理指南》中的 “使用亚马逊 Chime 语音连接器组”。

以下代码示例演示如何使用 update-voice-connector。

AWS CLI

更新 Amazon Chime 语音连接器的详细信息

以下update-voice-connector示例更新了指定的 Amazon Chime 语音连接器的名称。

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"
    }
}

有关更多信息，请参阅《亚马逊 Chime 管理指南》中的 “使用 Amaz on Chime 语音连接器”。