Exemplos do Amazon Chime usando a AWS CLI

Os exemplos de código a seguir mostram como realizar ações e implementar cenários comuns usando a AWS Command Line Interface com o Amazon Chime.

Ações são trechos de código de programas maiores e devem ser executadas em contexto. Embora as ações mostrem como chamar perfis de serviço individuais, você pode ver as ações no contexto em seus cenários relacionados.

Cada exemplo inclui um link para o código-fonte completo, em que você pode encontrar instruções sobre como configurar e executar o código.

Tópicos

Ações

Ações

O código de exemplo a seguir mostra como usar associate-phone-number-with-user.

AWS CLI

Como associar um número de telefone a um usuário

O exemplo associate-phone-number-with-user a seguir associa o número de telefone especificado a um usuário.


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"

Este comando não produz saída.

Para obter mais informações, consulte Gerenciamento de números de telefone do usuário no Guia de administração do Amazon Chime.

Para ver detalhes da API, consulte AssociatePhoneNumberWithUser na Referência de comandos da AWS CLI.

O código de exemplo a seguir mostra como usar associate-phone-numbers-with-voice-connector-group.

AWS CLI

Como associar números de telefone a um grupo do Amazon Chime Voice Connector

O exemplo associate-phone-numbers-with-voice-connector-group a seguir associa os números de telefone especificados a um grupo do 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

Saída:


{
    "PhoneNumberErrors": []
}

Para obter mais informações, consulte Trabalhando com grupos do Amazon Chime Voice Connector no Guia de administração do Amazon Chime.

Para ver detalhes da API, consulte AssociatePhoneNumbersWithVoiceConnectorGroup na Referência de comandos da AWS CLI.

O código de exemplo a seguir mostra como usar associate-phone-numbers-with-voice-connector.

AWS CLI

Como associar números de telefone a um Amazon Chime Voice Connector

O exemplo associate-phone-numbers-with-voice-connector a seguir associa os números de telefone especificados a um Amazon Chime Voice Connector.


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

Saída:


{
    "PhoneNumberErrors": []
}

Para obter mais informações, consulte Trabalhar com Amazon Chime Voice Connectors no Guia de administração do Amazon Chime.

Para ver detalhes da API, consulte AssociatePhoneNumbersWithVoiceConnector na Referência de comandos da AWS CLI.

O código de exemplo a seguir mostra como usar associate-signin-delegate-groups-with-account.

AWS CLI

Como associar grupos delegados de login

O exemplo associate-signin-delegate-groups-with-account a seguir associa o grupo delegado de login especificado à conta especificada do Amazon Chime.


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

Este comando não produz saída.

Para obter mais informações, consulte Gerenciar as permissões e o acesso do usuário no Guia de administração do Amazon Chime.

Para ver detalhes da API, consulte AssociateSigninDelegateGroupsWithAccount na Referência de comandos da AWS CLI.

O código de exemplo a seguir mostra como usar batch-create-room-membership.

AWS CLI

Para criar várias associações de salas

O exemplo batch-create-room-membership a seguir adiciona vários usuários a uma sala de chat como membros da sala de chat. Ele também atribui perfis de administrador e membro aos usuários.


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"

Saída:


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

Para obter mais informações, consulte Criar uma sala de chat no Guia do usuário do Amazon Chime.

Para ver detalhes da API, consulte BatchCreateRoomMembership na Referência de comandos da AWS CLI.

O código de exemplo a seguir mostra como usar batch-delete-phone-number.

AWS CLI

Para excluir vários números de telefone

O exemplo batch-delete-phone-number a seguir exclui todos os números de telefone especificados.


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

Este comando não produz saída. Saída:


{
    "PhoneNumberErrors": []
}

Para obter mais informações, consulte Trabalhar com números de telefone no Guia de administração do Amazon Chime.

Para ver detalhes da API, consulte BatchDeletePhoneNumber na Referência de comandos da AWS CLI.

O código de exemplo a seguir mostra como usar batch-suspend-user.

AWS CLI

Como suspender vários usuários

O exemplo batch-suspend-user a seguir suspende os usuários listados da conta especificada do 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"

Saída:


{
    "UserErrors": []
}

Para ver detalhes da API, consulte BatchSuspendUser na Referência de comandos da AWS CLI.

O código de exemplo a seguir mostra como usar batch-unsuspend-user.

AWS CLI

Como cancelar a suspensão de vários usuários

O exemplo batch-unsuspend-user a seguir remove qualquer suspensão anterior dos usuários listados na conta especificada do 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"

Saída:


{
    "UserErrors": []
}

Para ver detalhes da API, consulte BatchUnsuspendUser na Referência de comandos da AWS CLI.

O código de exemplo a seguir mostra como usar batch-update-phone-number.

AWS CLI

Para atualizar vários tipos de produto de número de telefone ao mesmo tempo

O exemplo batch-update-phone-number a seguir atualiza os tipos de produtos de todos os números de telefone especificados.


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

Saída:


{
    "PhoneNumberErrors": []
}

Para atualizar vários nomes de chamadas de números de telefone ao mesmo tempo

O exemplo batch-update-phone-number a seguir atualiza os nomes de chamada de todos os números de telefone especificados.


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

Saída:


{
    "PhoneNumberErrors": []
}

Para obter mais informações, consulte Trabalhar com números de telefone no Guia de administração do Amazon Chime.

Para ver detalhes da API, consulte BatchUpdatePhoneNumber na Referência de comandos da AWS CLI.

O código de exemplo a seguir mostra como usar batch-update-user.

AWS CLI

Para atualizar vários usuários em um único comando

O exemplo batch-update-user a seguir atualiza o LicenseType em cada um dos usuários listados na conta especificada do 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"

Saída:


{
    "UserErrors": []
}

Para ver detalhes da API, consulte BatchUpdateUser na Referência de comandos da AWS CLI.

O código de exemplo a seguir mostra como usar create-account.

AWS CLI

Para criar uma conta

O exemplo create-account a seguir cria uma conta do Amazon Chime na conta do administrador da AWS.


aws chime create-account \
    --name MyChimeAccount

Saída:


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

Para obter mais informações, consulte Conceitos básicos no Guia de administração do Amazon Chime.

Para obter detalhes da API, consulte CreateAccount na Referência de comandos da AWS CLI.

O código de exemplo a seguir mostra como usar create-bot.

AWS CLI

Para criar um bot do Amazon Chime

O exemplo create-bot a seguir cria um bot para a conta específica do Amazon Chime Enterprise.


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

Saída:


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

Para obter mais informações, consulte Integrar um bot de chat com o Amazon Chime no Guia do desenvolvedor do Amazon Chime.

Para ver detalhes da API, consulte CreateBot na Referência de comandos da AWS CLI.

O código de exemplo a seguir mostra como usar create-phone-number-order.

AWS CLI

Para criar um pedido de número de telefone

O exemplo create-phone-number-order a seguir cria um pedido de número de telefone para os números de telefone especificados.


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

Saída:


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

Para obter mais informações, consulte Trabalhar com números de telefone no Guia de administração do Amazon Chime.

Para ver detalhes da API, consulte CreatePhoneNumberOrder na Referência de comandos da AWS CLI.

O código de exemplo a seguir mostra como usar create-proxy-session.

AWS CLI

Para criar uma sessão de proxy

O exemplo create-proxy-session a seguir cria uma sessão de proxy com recursos de voz e SMS.


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

Saída:


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

Para obter mais informações, consulte Sessões de telefone de proxy no Guia do desenvolvedor do Amazon Chime.

Para ver detalhes da API, consulte CreateProxySession na Referência de comandos da AWS CLI.

O código de exemplo a seguir mostra como usar create-room-membership.

AWS CLI

Para criar uma associação de sala

O exemplo create-room-membership a seguir adiciona o usuário especificado à sala de chat como membro da sala de chat.


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

Saída:


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

Para obter mais informações, consulte Criar uma sala de chat no Guia do usuário do Amazon Chime.

Para ver detalhes da API, consulte CreateRoomMembership na Referência de comandos da AWS CLI.

O código de exemplo a seguir mostra como usar create-room.

AWS CLI

Para criar uma sala de chat

O exemplo create-room a seguir cria uma sala de chat para a conta especificada do Amazon Chime.


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

Saída:


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

Para obter mais informações, consulte Criar uma sala de chat no Guia do usuário do Amazon Chime.

Para ver detalhes da API, consulte CreateRoom na Referência de comandos da AWS CLI.

O código de exemplo a seguir mostra como usar create-user.

AWS CLI

Para criar um perfil de usuário para um dispositivo compartilhado

O exemplo create-user a seguir cria um perfil de dispositivo compartilhado para o endereço de e-mail especificado.


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

Saída:


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

Para obter mais informações, consulte Preparar para a configuração no Guia de administração do Amazon Chime.

Para obter detalhes da API, consulte CreateUser na Referência de comandos da AWS CLI.

O código de exemplo a seguir mostra como usar create-voice-connector-group.

AWS CLI

Para criar um grupo do Amazon Chime Voice Connector

O exemplo create-voice-connector-group a seguir cria um grupo de Amazon Chime Voice Connector que inclui o conector de voz especificado do Amazon Chime.


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

Saída:


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

Para obter mais informações, consulte Trabalhando com grupos do Amazon Chime Voice Connector no Guia de administração do Amazon Chime.

Para ver detalhes da API, consulte CreateVoiceConnectorGroup na Referência de comandos da AWS CLI.

O código de exemplo a seguir mostra como usar create-voice-connector.

AWS CLI

Para criar um Amazon Chime Voice Connector

O exemplo create-voice-connector a seguir cria um Amazon Chime Voice Connector na região da AWS especificada, com a criptografia habilitada.


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

Saída:


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

Para obter mais informações, consulte Trabalhar com Amazon Chime Voice Connectors no Guia de administração do Amazon Chime.

Para ver detalhes da API, consulte CreateVoiceConnector na Referência de comandos da AWS CLI.

O código de exemplo a seguir mostra como usar delete-account.

AWS CLI

Para excluir uma conta

O exemplo delete-account a seguir exclui a conta especificada.


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

Este comando não produz saída.

Para obter mais informações, consulte Excluir sua conta no Guia de administração do Amazon Chime.

Para ver detalhes da API, consulte DeleteAccount na Referência de comandos da AWS CLI.

O código de exemplo a seguir mostra como usar delete-phone-number.

AWS CLI

Para excluir um número de telefone

O exemplo delete-phone-number a seguir move o número de telefone especificado para a fila de exclusão.


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

Este comando não produz saída.

Para obter mais informações, consulte Trabalhar com números de telefone no Guia de administração do Amazon Chime.

Para ver detalhes da API, consulte DeletePhoneNumber na Referência de comandos da AWS CLI.

O código de exemplo a seguir mostra como usar delete-proxy-session.

AWS CLI

Para excluir uma sessão de proxy

O exemplo delete-proxy-session a seguir exclui a sessão de proxy especificada.


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

Este comando não produz saída.

Para obter mais informações, consulte Sessões de telefone de proxy no Guia do desenvolvedor do Amazon Chime.

Para ver detalhes da API, consulte DeleteProxySession na Referência de comandos da AWS CLI.

O código de exemplo a seguir mostra como usar delete-room-membership.

AWS CLI

Para remover um usuário como membro de uma sala de chat

O exemplo delete-room-membership a seguir remove o membro especificado da sala de chat especificada.


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

Este comando não produz saída.

Para obter mais informações, consulte Criar uma sala de chat no Guia do usuário do Amazon Chime.

Para ver detalhes da API, consulte DeleteRoomMembership na Referência de comandos da AWS CLI.

O código de exemplo a seguir mostra como usar delete-room.

AWS CLI

Para excluir uma sala de bate-papo

O exemplo delete-room a seguir exclui a sala de chat especificada e remove as associações da sala de chat.


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

Este comando não produz saída.

Para obter mais informações, consulte Criar uma sala de chat no Guia do usuário do Amazon Chime.

Para ver detalhes da API, consulte DeleteRoom na Referência de comandos da AWS CLI.

O código de exemplo a seguir mostra como usar delete-voice-connector-group.

AWS CLI

title

O exemplo delete-voice-connector-group a seguir exclui o grupo do Amazon Chime Voice Connector.


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

Este comando não produz saída.

Para obter mais informações, consulte Trabalhando com grupos do Amazon Chime Voice Connector no Guia de administração do Amazon Chime.

Para ver detalhes da API, consulte DeleteVoiceConnectorGroup na Referência de comandos da AWS CLI.

O código de exemplo a seguir mostra como usar delete-voice-connector-origination.

AWS CLI

Para excluir as configurações de geração

O exemplo delete-voice-connector-origination a seguir exclui o host, a porta, o protocolo, a prioridade e o peso de geração do Amazon Chime Voice Connector especificado.


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

Este comando não produz saída.

Para obter mais informações, consulte Trabalhar com Amazon Chime Voice Connectors no Guia de administração do Amazon Chime.

Para ver detalhes da API, consulte DeleteVoiceConnectorOrigination na Referência de comandos da AWS CLI.

O código de exemplo a seguir mostra como usar delete-voice-connector-proxy.

AWS CLI

Para excluir uma configuração de proxy

O exemplo delete-voice-connector-proxy a seguir exclui a configuração de proxy do seu Amazon Chime Voice Connector.


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

Este comando não produz saída.

Para obter mais informações, consulte Sessões de telefone de proxy no Guia do desenvolvedor do Amazon Chime.

Para ver detalhes da API, consulte DeleteVoiceConnectorProxy na Referência de comandos da AWS CLI.

O código de exemplo a seguir mostra como usar delete-voice-connector-streaming-configuration.

AWS CLI

Para excluir uma configuração de streaming

O exemplo delete-voice-connector-streaming-configuration a seguir exclui a configuração de streaming do Amazon Chime Voice Connector.


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

Este comando não produz saída.

Para obter mais informações, consulte Fluxo de dados do Amazon Chime Voice Connector para o Kinesis no Guia do administrador do Amazon Chime.

Para ver detalhes da API, consulte DeleteVoiceConnectorStreamingConfiguration na Referência de comandos da AWS CLI.

O código de exemplo a seguir mostra como usar delete-voice-connector-termination-credentials.

AWS CLI

Para excluir as credenciais de encerramento

O exemplo delete-voice-connector-termination-credentials a seguir exclui as credenciais de encerramento do nome de usuário especificado e do Amazon Chime Voice Connector.


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

Este comando não produz saída.

Para obter mais informações, consulte Trabalhar com Amazon Chime Voice Connectors no Guia de administração do Amazon Chime.

Para ver detalhes da API, consulte DeleteVoiceConnectorTerminationCredentials na Referência de comandos da AWS CLI.

O código de exemplo a seguir mostra como usar delete-voice-connector-termination.

AWS CLI

Para excluir as configurações de encerramento

O exemplo delete-voice-connector-termination a seguir exclui as configurações de encerramento do Amazon Chime Voice Connector.


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

Este comando não produz saída.

Para obter mais informações, consulte Trabalhar com Amazon Chime Voice Connectors no Guia de administração do Amazon Chime.

Para ver detalhes da API, consulte DeleteVoiceConnectorTermination na Referência de comandos da AWS CLI.

O código de exemplo a seguir mostra como usar delete-voice-connector.

AWS CLI

Para excluir um Amazon Chime Voice Connector

O exemplo delete-voice-connector a seguir faz isso


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

Este comando não produz saída.

Para obter mais informações, consulte Trabalhar com Amazon Chime Voice Connectors no Guia de administração do Amazon Chime.

Para ver detalhes da API, consulte DeleteVoiceConnector na Referência de comandos da AWS CLI.

O código de exemplo a seguir mostra como usar disassociate-phone-number-from-user.

AWS CLI

Como desassociar um número de telefone de um usuário

O exemplo disassociate-phone-number-from-user a seguir desassocia um número de telefone do usuário especificado.


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

Este comando não produz saída.

Para obter mais informações, consulte Gerenciamento de números de telefone do usuário no Guia de administração do Amazon Chime.

Para ver detalhes da API, consulte DisassociatePhoneNumberFromUser na Referência de comandos da AWS CLI.

O código de exemplo a seguir mostra como usar disassociate-phone-numbers-from-voice-connector-group.

AWS CLI

Como desassociar números de telefone de um grupo do Amazon Chime Voice Connector

O exemplo disassociate-phone-numbers-from-voice-connector-group a seguir desassocia os números de telefone especificados de um grupo do 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"

Saída:


{
    "PhoneNumberErrors": []
}

Para obter mais informações, consulte Trabalhando com grupos do Amazon Chime Voice Connector no Guia de administração do Amazon Chime.

Para ver detalhes da API, consulte DisassociatePhoneNumbersFromVoiceConnectorGroup na Referência de comandos da AWS CLI.

O código de exemplo a seguir mostra como usar disassociate-phone-numbers-from-voice-connector.

AWS CLI

Como desassociar números de telefone de um Amazon Chime Voice Connector

O exemplo disassociate-phone-numbers-from-voice-connector a seguir desassocia os números de telefone especificados de um Amazon Chime Voice Connector.


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

Saída:


{
    "PhoneNumberErrors": []
}

Para obter mais informações, consulte Trabalhar com Amazon Chime Voice Connectors no Guia de administração do Amazon Chime.

Para ver detalhes da API, consulte DisassociatePhoneNumbersFromVoiceConnector na Referência de comandos da AWS CLI.

O código de exemplo a seguir mostra como usar disassociate-signin-delegate-groups-from-account.

AWS CLI

Como desassociar grupos delegados de login

O exemplo disassociate-signin-delegate-groups-from-account a seguir desassocia o grupo delegado de login especificado da conta especificada do Amazon Chime.


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

Este comando não produz saída.

Para obter mais informações, consulte Gerenciar as permissões e o acesso do usuário no Guia de administração do Amazon Chime.

Para ver detalhes da API, consulte DisassociateSigninDelegateGroupsFromAccount na Referência de comandos da AWS CLI.

O código de exemplo a seguir mostra como usar get-account-settings.

AWS CLI

Para recuperar as configurações de uma conta

O exemplo get-account-settings a seguir recupera as configurações da conta na conta especificada.


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

Saída:


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

Para obter mais informações, consulte Gerenciar suas contas do Amazon Chime no Guia de administração do Amazon Chime.

Para obter detalhes da API, consulte GetAccountSettings na Referência de comandos da AWS CLI.

O código de exemplo a seguir mostra como usar get-account.

AWS CLI

Para recuperar os detalhes de uma conta

O exemplo get-account a seguir recupera os detalhes da conta do Amazon Chime especificada.


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

Saída:


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

Para obter mais informações, consulte Gerenciar suas contas do Amazon Chime no Guia de administração do Amazon Chime.

Para ver detalhes da API, consulte GetAccount na Referência de comandos da AWS CLI.

O código de exemplo a seguir mostra como usar get-bot.

AWS CLI

Para recuperar detalhes de um bot

O exemplo get-bot a seguir exibe os detalhes do bot especificado.


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

Saída:


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

Para obter mais informações, consulte Atualizar bots de chat no Guia do desenvolvedor do Amazon Chime.

Para ver detalhes da API, consulte GetBot na Referência de comandos da AWS CLI.

O código de exemplo a seguir mostra como usar get-global-settings.

AWS CLI

Para obter configurações globais

O exemplo get-global-settings a seguir recupera os nomes de bucket do S3 usados para armazenar registros de detalhes de chamadas para o Amazon Chime Business Calling e Amazon Chime Voice Connectors associados à conta da AWS do administrador.


aws chime get-global-settings

Saída:


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

Para obter mais informações, consulte Gerenciar as configurações globais no Guia do administrador do Amazon Chime.

Para ver detalhes da API, consulte GetGlobalSettings na Referência de comandos da AWS CLI.

O código de exemplo a seguir mostra como usar get-phone-number-order.

AWS CLI

Para obter detalhes de um pedido de número de telefone

O exemplo get-phone-number-order a seguir exibe os detalhes do pedido de número de telefone especificado.


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

Saída:


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

Para obter mais informações, consulte Trabalhar com números de telefone no Guia de administração do Amazon Chime.

Para receber detalhes da API, consulte GetPhoneNumberOrder na Referência de comandos da AWS CLI.

O código de exemplo a seguir mostra como usar get-phone-number-settings.

AWS CLI

Para recuperar um nome de chamada de saída

O exemplo get-phone-number-settings a seguir recupera o nome padrão da chamada de saída para a conta da AWS do usuário da chamada.


aws chime get-phone-number-settings

Este comando não produz saída. Saída:


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

Para obter mais informações, consulte Trabalhar com números de telefone no Guia de administração do Amazon Chime.

Para ver detalhes da API, consulte GetPhoneNumberSettings na Referência de comandos da AWS CLI.

O código de exemplo a seguir mostra como usar get-phone-number.

AWS CLI

Para obter detalhes dos números de telefone

O exemplo get-phone-number a seguir exibe os detalhes do número de telefone especificado.


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

Saída:


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

Para obter mais informações, consulte Trabalhar com números de telefone no Guia de administração do Amazon Chime.

Para ver detalhes da API, consulte GetPhoneNumber na Referência de comandos da AWS CLI.

O código de exemplo a seguir mostra como usar get-proxy-session.

AWS CLI

Para obter detalhes da sessão de proxy

O exemplo get-proxy-session a seguir lista os detalhes da sessão de proxy especificada.


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

Saída:


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

Para obter mais informações, consulte Sessões de telefone de proxy no Guia do desenvolvedor do Amazon Chime.

Para ver detalhes da API, consulte GetProxySession na Referência de comandos da AWS CLI.

O código de exemplo a seguir mostra como usar get-room.

AWS CLI

Para obter os detalhes sobre uma sala de chat

O exemplo get-room a seguir exibe os detalhes da sala de chat especificada.


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

Saída:


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

Para obter mais informações, consulte Criar uma sala de chat no Guia do usuário do Amazon Chime.

Para ver detalhes da API, consulte GetRoom na Referência de comandos da AWS CLI.

O código de exemplo a seguir mostra como usar get-user-settings.

AWS CLI

Para recuperar as configurações do usuário

O exemplo get-user-settings a seguir exibe as configurações do usuário especificadas.


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

Saída:


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

Para obter mais informações, consulte Gerenciamento de números de telefone do usuário no Guia de administração do Amazon Chime.

Para ver detalhes da API, consulte GetUserSettings na Referência de comandos da AWS CLI.

O código de exemplo a seguir mostra como usar get-user.

AWS CLI

Para obter detalhes de um usuário

O exemplo get-user a seguir recupera os detalhes do usuário especificado.


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

Saída:


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

Para obter mais informações, consulte Gerenciar usuários no Guia de administração do Amazon Chime.

Para obter detalhes da API, consulte GetUser na Referência de comandos da AWS CLI.

O código de exemplo a seguir mostra como usar get-voice-connector-group.

AWS CLI

Para obter detalhes de um grupo do Amazon Chime Voice Connector

O exemplo get-voice-connector-group a seguir exibe detalhes do grupo do Amazon Chime Voice Connector.


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

Saída:


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

Para obter mais informações, consulte Trabalhando com grupos do Amazon Chime Voice Connector no Guia de administração do Amazon Chime.

Para ver detalhes da API, consulte GetVoiceConnectorGroup na Referência de comandos da AWS CLI.

O código de exemplo a seguir mostra como usar get-voice-connector-logging-configuration.

AWS CLI

Para obter detalhes da configuração de registro em log

O exemplo get-voice-connector-logging-configuration a seguir recupera os detalhes da configuração de registro em log do Amazon Chime Voice Connector especificado.


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

Saída:


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

Para obter mais informações, consulte Streaming de mídia do Amazon Chime Voice Connector para o Kinesis no Guia do administrador do Amazon Chime.

Para ver detalhes da API, consulte GetVoiceConnectorLoggingConfiguration na Referência de comandos da AWS CLI.

O código de exemplo a seguir mostra como usar get-voice-connector-origination.

AWS CLI

Para recuperar as configurações de geração

O exemplo get-voice-connector-origination a seguir recupera o host, a porta, o protocolo, a prioridade e o peso de geração para o Amazon Chime Voice Connector especificado.


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

Saída:


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

Para obter mais informações, consulte Trabalhar com Amazon Chime Voice Connectors no Guia de administração do Amazon Chime.

Para ver detalhes da API, consulte GetVoiceConnectorOrigination na Referência de comandos da AWS CLI.

O código de exemplo a seguir mostra como usar get-voice-connector-proxy.

AWS CLI

Para obter detalhes da configuração do proxy

O exemplo get-voice-connector-proxy a seguir obtém os detalhes da configuração de proxy do seu Amazon Chime Voice Connector.


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

Saída:


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

Para obter mais informações, consulte Sessões de telefone de proxy no Guia do desenvolvedor do Amazon Chime.

Para ver detalhes da API, consulte GetVoiceConnectorProxy na Referência de comandos da AWS CLI.

O código de exemplo a seguir mostra como usar get-voice-connector-streaming-configuration.

AWS CLI

Para obter detalhes da configuração de streaming

O exemplo get-voice-connector-streaming-configuration a seguir obtém os detalhes da configuração de streaming do Amazon Chime Voice Connector.


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

Saída:


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

Para obter mais informações, consulte Fluxo de dados do Amazon Chime Voice Connector para o Kinesis no Guia do administrador do Amazon Chime.

Para ver detalhes da API, consulte GetVoiceConnectorStreamingConfiguration na Referência de comandos da AWS CLI.

O código de exemplo a seguir mostra como usar get-voice-connector-termination-health.

AWS CLI

Para recuperar detalhes de integridade do encerramento

O exemplo get-voice-connector-termination-health a seguir recupera os detalhes de integridade do encerramento do Amazon Chime Voice Connector especificado.


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

Saída:


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

Para obter mais informações, consulte Trabalhar com Amazon Chime Voice Connectors no Guia de administração do Amazon Chime.

Para ver detalhes da API, consulte GetVoiceConnectorTerminationHealth na Referência de comandos da AWS CLI.

O código de exemplo a seguir mostra como usar get-voice-connector-termination.

AWS CLI

Para recuperar as configurações de encerramento

O exemplo get-voice-connector-termination a seguir recupera as configurações de encerramento do Amazon Chime Voice Connector.


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

Este comando não produz saída. Saída:


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

Para obter mais informações, consulte Trabalhar com Amazon Chime Voice Connectors no Guia de administração do Amazon Chime.

Para ver detalhes da API, consulte GetVoiceConnectorTermination na Referência de comandos da AWS CLI.

O código de exemplo a seguir mostra como usar get-voice-connector.

AWS CLI

Para obter detalhes de um Amazon Chime Voice Connector

O exemplo get-voice-connector a seguir exibe os detalhes do Amazon Chime Voice Connector especificado.


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

Saída:


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

Para obter mais informações, consulte Trabalhar com Amazon Chime Voice Connectors no Guia de administração do Amazon Chime.

Para ver detalhes da API, consulte GetVoiceConnector na Referência de comandos da AWS CLI.

O código de exemplo a seguir mostra como usar invite-users.

AWS CLI

Como convidar usuários a participarem do Amazon Chime

O exemplo invite-users a seguir envia um e-mail para convidar um usuário para a conta especificada do Amazon Chime.


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

Saída:


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

Para obter mais informações, consulte Convidar e suspender usuários no Guia de administração do Amazon Chime.

Para ver detalhes da API, consulte InviteUsers na Referência de comandos da AWS CLI.

O código de exemplo a seguir mostra como usar list-accounts.

AWS CLI

Para obter uma lista de contas

O exemplo list-accounts a seguir recupera uma lista das contas do Amazon Chime na conta da AWS do administrador.


aws chime list-accounts

Saída:


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

Para obter mais informações, consulte Gerenciar suas contas do Amazon Chime no Guia de administração do Amazon Chime.

Para obter detalhes da API, consulte ListAccounts na Referência de comandos da AWS CLI.

O código de exemplo a seguir mostra como usar list-bots.

AWS CLI

Para recuperar uma lista de bots

O exemplo list-bots a seguir lista os bots associados à conta especificada do Amazon Chime.


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

Saída:


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

Para obter mais informações, consulte Usar bots de chat com o Amazon Chime no Guia do desenvolvedor do Amazon Chime.

Para ver detalhes da API, consulte ListBots na Referência de comandos da AWS CLI.

O código de exemplo a seguir mostra como usar list-phone-number-orders.

AWS CLI

Para listar pedidos de números de telefone

O exemplo list-phone-number-orders a seguir lista os pedidos de números de telefone associados à conta do administrador do Amazon Chime.


aws chime list-phone-number-orders

Saída:


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

Para obter mais informações, consulte Trabalhar com números de telefone no Guia de administração do Amazon Chime.

Para ver detalhes da API, consulte ListPhoneNumberOrders na Referência de comandos da AWS CLI.

O código de exemplo a seguir mostra como usar list-phone-numbers.

AWS CLI

Para listar números de telefone em uma conta do Amazon Chime

O exemplo list-phone-numbers a seguir lista os números de telefone associados à conta do Amazon Chime do administrador.


aws chime list-phone-numbers

Este comando não produz saída. Saída:


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

Para obter mais informações, consulte Trabalhar com números de telefone no Guia de administração do Amazon Chime.

Para ver detalhes da API, consulte ListPhoneNumbers na Referência de comandos da AWS CLI.

O código de exemplo a seguir mostra como usar list-proxy-sessions.

AWS CLI

Para listar sessões de proxy

O exemplo list-proxy-sessions a seguir lista as sessões de proxy do seu Amazon Chime Voice Connector.


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

Saída:


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

Para obter mais informações, consulte Sessões de telefone de proxy no Guia do desenvolvedor do Amazon Chime.

Para ver detalhes da API, consulte ListProxySessions na Referência de comandos da AWS CLI.

O código de exemplo a seguir mostra como usar list-room-memberships.

AWS CLI

Para listar associações de salas

O exemplo list-room-memberships a seguir exibe uma lista dos detalhes da associação da sala de chat especificada.


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

Saída:


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

Para obter mais informações, consulte Criar uma sala de chat no Guia do usuário do Amazon Chime.

Para ver detalhes da API, consulte ListRoomMemberships na Referência de comandos da AWS CLI.

O código de exemplo a seguir mostra como usar list-rooms.

AWS CLI

Para listar salas de chat

O exemplo list-rooms a seguir exibe uma lista de salas de chat na conta especificada. A lista é filtrada somente para as salas de chat às quais o membro especificado pertence.


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

Saída:


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

Para obter mais informações, consulte Criar uma sala de chat no Guia do usuário do Amazon Chime.

Para ver detalhes da API, consulte ListRooms na Referência de comandos da AWS CLI.

O código de exemplo a seguir mostra como usar list-users.

AWS CLI

Para listar os usuários em uma conta

O exemplo list-users a seguir lista os usuários da conta especificada do Amazon Chime.


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

Saída:


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

Para obter mais informações, consulte Gerenciar usuários no Guia de administração do Amazon Chime.

Para obter detalhes da API, consulte ListUsers na Referência de comandos da AWS CLI.

O código de exemplo a seguir mostra como usar list-voice-connector-groups.

AWS CLI

Para listar grupos do Amazon Chime Voice Connector em uma conta do Amazon Chime

O exemplo list-voice-connector-groups a seguir lista os grupos do Amazon Chime Voice Connector associados à conta do Amazon Chime do administrador.


aws chime list-voice-connector-groups

Saída:


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

Para obter mais informações, consulte Trabalhando com grupos do Amazon Chime Voice Connector no Guia de administração do Amazon Chime.

Para ver detalhes da API, consulte ListVoiceConnectorGroups na Referência de comandos da AWS CLI.

O código de exemplo a seguir mostra como usar list-voice-connector-termination-credentials.

AWS CLI

Para recuperar uma lista de credenciais de encerramento

O exemplo list-voice-connector-termination-credentials a seguir recupera uma lista das credenciais de encerramento do Amazon Chime Voice Connector especificado.


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

Este comando não produz saída. Saída:


{
    "Usernames": [
        "jdoe"
    ]
}

Para obter mais informações, consulte Trabalhar com Amazon Chime Voice Connectors no Guia de administração do Amazon Chime.

Para ver detalhes da API, consulte ListVoiceConnectorTerminationCredentials na Referência de comandos da AWS CLI.

O código de exemplo a seguir mostra como usar list-voice-connectors.

AWS CLI

Para listar Amazon Chime Voice Connectors para uma conta

O exemplo list-voice-connectors a seguir lista os Amazon Chime Voice Connectors associados à conta da chamada.


aws chime list-voice-connectors

Saída:


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

Para obter mais informações, consulte Trabalhar com Amazon Chime Voice Connectors no Guia de administração do Amazon Chime.

Para ver detalhes da API, consulte ListVoiceConnectors na Referência de comandos da AWS CLI.

O código de exemplo a seguir mostra como usar logout-user.

AWS CLI

Como fazer o logoff de um usuário

O exemplo logout-user a seguir desconecta o usuário especificado.


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

Este comando não produz saída.

Para ver detalhes da API, consulte LogoutUser na Referência de comandos da AWS CLI.

O código de exemplo a seguir mostra como usar put-voice-connector-logging-configuration.

AWS CLI

Para adicionar uma configuração de registro em log ao Amazon Chime Voice Connector

O exemplo put-voice-connector-logging-configuration a seguir ativa a configuração de registro em log do SIP do Amazon Chime Voice Connector especificado.


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

Saída:


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

Para obter mais informações, consulte Streaming de mídia do Amazon Chime Voice Connector para o Kinesis no Guia do administrador do Amazon Chime.

Para ver detalhes da API, consulte PutVoiceConnectorLoggingConfiguration na Referência de comandos da AWS CLI.

O código de exemplo a seguir mostra como usar put-voice-connector-origination.

AWS CLI

Como definir configurações de geração

O exemplo put-voice-connector-origination a seguir configura o host, a porta, o protocolo, a prioridade e o peso de geração para o Amazon Chime Voice Connector especificado.


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

Saída:


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

Para obter mais informações, consulte Trabalhar com Amazon Chime Voice Connectors no Guia de administração do Amazon Chime.

Para ver detalhes da API, consulte PutVoiceConnectorOrigination na Referência de comandos da AWS CLI.

O código de exemplo a seguir mostra como usar put-voice-connector-proxy.

AWS CLI

Como definir uma configuração de proxy

O exemplo put-voice-connector-proxy a seguir define uma configuração de proxy no Amazon Chime Voice Connector.


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

Saída:


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

Para obter mais informações, consulte Sessões de telefone de proxy no Guia do desenvolvedor do Amazon Chime.

Para ver detalhes da API, consulte PutVoiceConnectorProxy na Referência de comandos da AWS CLI.

O código de exemplo a seguir mostra como usar put-voice-connector-streaming-configuration.

AWS CLI

Para criar uma configuração de streaming

O exemplo put-voice-connector-streaming-configuration a seguir cria uma configuração de streaming no Amazon Chime Voice Connector. Ele permite o streaming de mídia do Amazon Chime Voice Connector para o Amazon Kinesis e define o período de retenção de dados como 24 horas.


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

Saída:


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

Para obter mais informações, consulte Fluxo de dados do Amazon Chime Voice Connector para o Kinesis no Guia do administrador do Amazon Chime.

Para ver detalhes da API, consulte PutVoiceConnectorStreamingConfiguration na Referência de comandos da AWS CLI.

O código de exemplo a seguir mostra como usar put-voice-connector-termination-credentials.

AWS CLI

Como configurar as credenciais de encerramento

O exemplo put-voice-connector-termination-credentials a seguir define as credenciais de encerramento do Amazon Chime Voice Connector especificado.


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

Este comando não produz saída.

Para obter mais informações, consulte Trabalhar com Amazon Chime Voice Connectors no Guia de administração do Amazon Chime.

Para ver detalhes da API, consulte PutVoiceConnectorTerminationCredentials na Referência de comandos da AWS CLI.

O código de exemplo a seguir mostra como usar put-voice-connector-termination.

AWS CLI

Como definir as configurações de encerramento

O exemplo put-voice-connector-termination a seguir define as regiões de chamada e as configurações de encerramento de host de IP permitidas do Amazon Chime Voice Connector especificado.


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

Saída:


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

Para obter mais informações, consulte Trabalhar com Amazon Chime Voice Connectors no Guia de administração do Amazon Chime.

Para ver detalhes da API, consulte PutVoiceConnectorTermination na Referência de comandos da AWS CLI.

O código de exemplo a seguir mostra como usar regenerate-security-token.

AWS CLI

Como regenerar um token de segurança

O exemplo regenerate-security-token a seguir gera o token de segurança do bot especificado.


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

Saída:


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

Para obter mais informações, consulte Autenticar solicitações de bot de chat no Guia do desenvolvedor do Amazon Chime.

Para ver detalhes da API, consulte RegenerateSecurityToken na Referência de comandos da AWS CLI.

O código de exemplo a seguir mostra como usar reset-personal-pin.

AWS CLI

Como redefinir o PIN de reunião pessoal de um usuário

O exemplo reset-personal-pin a seguir redefine o PIN de reunião pessoal de um usuário especificado.


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

Saída:


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

Para obter mais informações, consulte Alteração de PINs de reuniões pessoais no Guia de administração do Amazon Chime.

Para ver detalhes da API, consulte ResetPersonalPin na Referência de comandos da AWS CLI.

O código de exemplo a seguir mostra como usar restore-phone-number.

AWS CLI

Como restaurar um número de telefone

O exemplo restore-phone-number a seguir restaura o número de telefone especificado da fila de exclusão.


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

Saída:


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

Para obter mais informações, consulte Trabalhar com números de telefone no Guia de administração do Amazon Chime.

Para ver detalhes da API, consulte RestorePhoneNumber na Referência de comandos da AWS CLI.

O código de exemplo a seguir mostra como usar search-available-phone-numbers.

AWS CLI

Como pesquisar números de telefone disponíveis

O exemplo search-available-phone-numbers a seguir pesquisa os números de telefone disponíveis por código de área.


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

Saída:


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

Para obter mais informações, consulte Trabalhar com números de telefone no Guia de administração do Amazon Chime.

Para ver detalhes da API, consulte SearchAvailablePhoneNumbers na Referência de comandos da AWS CLI.

O código de exemplo a seguir mostra como usar update-account-settings.

AWS CLI

Para atualizar as configurações da sua conta

O exemplo update-account-settings a seguir desabilita o controle remoto de telas compartilhadas na conta especificada do Amazon Chime.


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

Este comando não produz saída.

Para ver detalhes da API, consulte UpdateAccountSettings na Referência de comandos da AWS CLI.

O código de exemplo a seguir mostra como usar update-account.

AWS CLI

Para atualizar uma conta

O exemplo update-account a seguir atualiza o nome da conta especificada.


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

Saída:


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

Para obter mais informações, consulte Renomear sua conta no Guia de administração do Amazon Chime.

Para ver detalhes da API, consulte UpdateAccount na Referência de comandos da AWS CLI.

O código de exemplo a seguir mostra como usar update-bot.

AWS CLI

Para atualizar um bot

O exemplo update-bot a seguir atualiza o status do bot especificado para impedir sua execução.


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

Saída:


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

Para obter mais informações, consulte Atualizar bots de chat no Guia do desenvolvedor do Amazon Chime.

Para ver detalhes da API, consulte UpdateBot na Referência de comandos da AWS CLI.

O código de exemplo a seguir mostra como usar update-global-settings.

AWS CLI

Para atualizar configurações globais

O exemplo update-global-settings a seguir atualiza o bucket do S3 usado para armazenar registros de detalhes de chamadas para o Amazon Chime Business Calling e Amazon Chime Voice Connectors associados à conta da AWS do administrador.


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

Este comando não produz saída.

Para obter mais informações, consulte Gerenciar as configurações globais no Guia do administrador do Amazon Chime.

Para ver detalhes da API, consulte UpdateGlobalSettings na Referência de comandos da AWS CLI.

O código de exemplo a seguir mostra como usar update-phone-number-settings.

AWS CLI

Para atualizar o nome de uma chamada de saída

O exemplo update-phone-number-settings a seguir atualiza o nome padrão da chamada de saída para a conta da AWS do administrador.


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

Este comando não produz saída.

Para obter mais informações, consulte Trabalhar com números de telefone no Guia de administração do Amazon Chime.

Para ver detalhes da API, consulte UpdatePhoneNumberSettings na Referência de comandos da AWS CLI.

O código de exemplo a seguir mostra como usar update-phone-number.

AWS CLI

Exemplo 1: atualizar o tipo de produto de um número de telefone

O exemplo update-phone-number a seguir atualiza o tipo de produto do número de telefone especificado.


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

Saída:


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

Exemplo 2: atualizar o nome da chamada de saída de um número de telefone

O exemplo update-phone-number a seguir atualiza o nome da chamada de saída no número de telefone especificado.

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

Saída:


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

Para obter mais informações, consulte Trabalhar com números de telefone no Guia de administração do Amazon Chime.

Para ver detalhes da API, consulte UpdatePhoneNumber na Referência de comandos da AWS CLI.

O código de exemplo a seguir mostra como usar update-proxy-session.

AWS CLI

Para atualizar uma sessão de proxy

O exemplo update-proxy-session a seguir atualiza os recursos da sessão de proxy.


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

Saída:


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

Para obter mais informações, consulte Sessões de telefone de proxy no Guia do desenvolvedor do Amazon Chime.

Para ver detalhes da API, consulte UpdateProxySession na Referência de comandos da AWS CLI.

O código de exemplo a seguir mostra como usar update-room-membership.

AWS CLI

Para atualizar a associação de uma sala

O exemplo update-room-membership a seguir modifica a função do membro da sala de chat especificado para 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

Saída:


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

Para obter mais informações, consulte Criar uma sala de chat no Guia do usuário do Amazon Chime.

Para ver detalhes da API, consulte UpdateRoomMembership na Referência de comandos da AWS CLI.

O código de exemplo a seguir mostra como usar update-room.

AWS CLI

Para atualizar uma sala de chat

O exemplo update-room a seguir modifica o nome da sala de chat especificada.


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

Saída:


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

Para obter mais informações, consulte Criar uma sala de chat no Guia do usuário do Amazon Chime.

Para ver detalhes da API, consulte UpdateRoom na Referência de comandos da AWS CLI.

O código de exemplo a seguir mostra como usar update-user-settings.

AWS CLI

Para atualizar as configurações do usuário

O exemplo update-user-settings a seguir permite que o usuário especificado faça chamadas de entrada e saída e envie e receba mensagens 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}"

Este comando não produz saída.

Para obter mais informações, consulte Gerenciamento de números de telefone do usuário no Guia de administração do Amazon Chime.

Para ver detalhes da API, consulte UpdateUserSettings na Referência de comandos da AWS CLI.

O código de exemplo a seguir mostra como usar update-user.

AWS CLI

Para atualizar os detalhes do usuário

Este exemplo atualiza os detalhes especificados do usuário especificado.

Comando:


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

Saída:


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

Para obter detalhes da API, consulte UpdateUser na Referência de comandos da AWS CLI.

O código de exemplo a seguir mostra como usar update-voice-connector-group.

AWS CLI

Para atualizar os detalhes de um grupo do Amazon Chime Voice Connector

O exemplo update-voice-connector-group a seguir atualiza os detalhes do grupo do Amazon Chime Voice Connector especificado.


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

Saída:


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

Para obter mais informações, consulte Trabalhando com grupos do Amazon Chime Voice Connector no Guia de administração do Amazon Chime.

Para ver detalhes da API, consulte UpdateVoiceConnectorGroup na Referência de comandos da AWS CLI.

O código de exemplo a seguir mostra como usar update-voice-connector.

AWS CLI

Para atualizar os detalhes de um Amazon Chime Voice Connector

O exemplo update-voice-connector a seguir atualiza o nome do Amazon Chime Voice Connector especificado.


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

Saída:


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

Para obter mais informações, consulte Trabalhar com Amazon Chime Voice Connectors no Guia de administração do Amazon Chime.

Para ver detalhes da API, consulte UpdateVoiceConnector na Referência de comandos da AWS CLI.

Atenção O Javascript está desativado ou não está disponível no seu navegador.

Para usar a documentação da AWS, o Javascript deve estar ativado. Consulte as páginas de Ajuda do navegador para obter instruções.

Convenções do documento

AWS Budgets

API de Controle da Nuvem