# 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.
**Topics**
+ [Ações](#actions)
## Ações
### `associate-phone-number-with-user`
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](https://docs.aws.amazon.com/chime/latest/ag/user-phone.html) no *Guia de administração do Amazon Chime*.
+ Para ver detalhes da API, consulte [AssociatePhoneNumberWithUser](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/chime/associate-phone-number-with-user.html) na *Referência de comandos da AWS CLI*.
### `associate-signin-delegate-groups-with-account`
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](https://docs.aws.amazon.com/chime/latest/ag/manage-access.html) no *Guia de administração do Amazon Chime*.
+ Para ver detalhes da API, consulte [AssociateSigninDelegateGroupsWithAccount](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/chime/associate-signin-delegate-groups-with-account.html) na *Referência de comandos da AWS CLI*.
### `batch-create-room-membership`
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"
```
Resultado:
```
{
"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](https://docs.aws.amazon.com/chime/latest/ug/chime-chat-room.html) no *Guia do usuário do Amazon Chime*.
+ Para ver detalhes da API, consulte [BatchCreateRoomMembership](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/chime/batch-create-room-membership.html) na *Referência de comandos da AWS CLI*.
### `batch-delete-phone-number`
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. Resultado:
```
{
"PhoneNumberErrors": []
}
```
Para obter mais informações, consulte [Trabalhar com números de telefone](https://docs.aws.amazon.com/chime/latest/ag/phone-numbers.html) no *Guia de administração do Amazon Chime*.
+ Para ver detalhes da API, consulte [BatchDeletePhoneNumber](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/chime/batch-delete-phone-number.html) na *Referência de comandos da AWS CLI*.
### `batch-suspend-user`
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"
```
Resultado:
```
{
"UserErrors": []
}
```
+ Para ver detalhes da API, consulte [BatchSuspendUser](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/chime/batch-suspend-user.html) na *Referência de comandos da AWS CLI*.
### `batch-unsuspend-user`
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"
```
Resultado:
```
{
"UserErrors": []
}
```
+ Para ver detalhes da API, consulte [BatchUnsuspendUser](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/chime/batch-unsuspend-user.html) na *Referência de comandos da AWS CLI*.
### `batch-update-phone-number`
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
```
Resultado:
```
{
"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
```
Resultado:
```
{
"PhoneNumberErrors": []
}
```
Para obter mais informações, consulte [Trabalhar com números de telefone](https://docs.aws.amazon.com/chime/latest/ag/phone-numbers.html) no *Guia de administração do Amazon Chime*.
+ Para ver detalhes da API, consulte [BatchUpdatePhoneNumber](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/chime/batch-update-phone-number.html) na *Referência de comandos da AWS CLI*.
### `batch-update-user`
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"
```
Resultado:
```
{
"UserErrors": []
}
```
+ Para ver detalhes da API, consulte [BatchUpdateUser](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/chime/batch-update-user.html) na *Referência de comandos da AWS CLI*.
### `create-account`
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
```
Resultado:
```
{
"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](https://docs.aws.amazon.com/chime/latest/ag/getting-started.html) no *Guia de administração do Amazon Chime*.
+ Consulte detalhes da API em [CreateAccount](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/chime/create-account.html) na *Referência de comandos da AWS CLI*.
### `create-bot`
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"
```
Resultado:
```
{
"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](https://docs.aws.amazon.com/chime/latest/dg/integrate-bots.html) no *Guia do desenvolvedor do Amazon Chime*.
+ Para ver detalhes da API, consulte [CreateBot](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/chime/create-bot.html) na *Referência de comandos da AWS CLI*.
### `create-phone-number-order`
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"
```
Resultado:
```
{
"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](https://docs.aws.amazon.com/chime/latest/ag/phone-numbers.html) no *Guia de administração do Amazon Chime*.
+ Para ver detalhes da API, consulte [CreatePhoneNumberOrder](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/chime/create-phone-number-order.html) na *Referência de comandos da AWS CLI*.
### `create-room-membership`
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
```
Resultado:
```
{
"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](https://docs.aws.amazon.com/chime/latest/ug/chime-chat-room.html) no *Guia do usuário do Amazon Chime*.
+ Para ver detalhes da API, consulte [CreateRoomMembership](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/chime/create-room-membership.html) na *Referência de comandos da AWS CLI*.
### `create-room`
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
```
Resultado:
```
{
"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](https://docs.aws.amazon.com/chime/latest/ug/chime-chat-room.html) no *Guia do usuário do Amazon Chime*.
+ Para ver detalhes da API, consulte [CreateRoom](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/chime/create-room.html) na *Referência de comandos da AWS CLI*.
### `create-user`
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
```
Resultado:
```
{
"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](https://docs.aws.amazon.com/chime/latest/ag/prepare-setup.html) no *Guia de administração do Amazon Chime*.
+ Consulte detalhes da API em [CreateUser](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/chime/create-user.html) na *Referência de comandos da AWS CLI*.
### `delete-account`
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](https://docs.aws.amazon.com/chime/latest/ag/enterprise-account.html) no *Guia de administração do Amazon Chime*.
+ Para ver detalhes da API, consulte [DeleteAccount](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/chime/delete-account.html) na *Referência de comandos da AWS CLI*.
### `delete-phone-number`
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](https://docs.aws.amazon.com/chime/latest/ag/phone-numbers.html) no *Guia de administração do Amazon Chime*.
+ Para ver detalhes da API, consulte [DeletePhoneNumber](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/chime/delete-phone-number.html) na *Referência de comandos da AWS CLI*.
### `delete-room-membership`
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](https://docs.aws.amazon.com/chime/latest/ug/chime-chat-room.html) no *Guia do usuário do Amazon Chime*.
+ Para ver detalhes da API, consulte [DeleteRoomMembership](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/chime/delete-room-membership.html) na *Referência de comandos da AWS CLI*.
### `delete-room`
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](https://docs.aws.amazon.com/chime/latest/ug/chime-chat-room.html) no *Guia do usuário do Amazon Chime*.
+ Para ver detalhes da API, consulte [DeleteRoom](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/chime/delete-room.html) na *Referência de comandos da AWS CLI*.
### `disassociate-phone-number-from-user`
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](https://docs.aws.amazon.com/chime/latest/ag/user-phone.html) no *Guia de administração do Amazon Chime*.
+ Para ver detalhes da API, consulte [DisassociatePhoneNumberFromUser](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/chime/disassociate-phone-number-from-user.html) na *Referência de comandos da AWS CLI*.
### `disassociate-signin-delegate-groups-from-account`
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](https://docs.aws.amazon.com/chime/latest/ag/manage-access.html) no *Guia de administração do Amazon Chime*.
+ Para ver detalhes da API, consulte [DisassociateSigninDelegateGroupsFromAccount](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/chime/disassociate-signin-delegate-groups-from-account.html) na *Referência de comandos da AWS CLI*.
### `get-account-settings`
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
```
Resultado:
```
{
"AccountSettings": {
"DisableRemoteControl": false,
"EnableDialOut": false
}
}
```
Para obter mais informações, consulte [Gerenciar suas contas do Amazon Chime](https://docs.aws.amazon.com/chime/latest/ag/manage-chime-account.html) no *Guia de administração do Amazon Chime*.
+ Consulte detalhes da API em [GetAccountSettings](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/chime/get-account-settings.html) na *Referência de comandos da AWS CLI*.
### `get-account`
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
```
Resultado:
```
{
"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](https://docs.aws.amazon.com/chime/latest/ag/manage-chime-account.html) no *Guia de administração do Amazon Chime*.
+ Para ver detalhes da API, consulte [GetAccount](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/chime/get-account.html) na *Referência de comandos da AWS CLI*.
### `get-bot`
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
```
Resultado:
```
{
"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](https://docs.aws.amazon.com/chime/latest/dg/update-bots.html) no *Guia do desenvolvedor do Amazon Chime*.
+ Para ver detalhes da API, consulte [GetBot](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/chime/get-bot.html) na *Referência de comandos da AWS CLI*.
### `get-global-settings`
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
```
Resultado:
```
{
"BusinessCalling": {
"CdrBucket": "s3bucket"
},
"VoiceConnector": {
"CdrBucket": "s3bucket"
}
}
```
Para obter mais informações, consulte [Gerenciar as configurações globais](https://docs.aws.amazon.com/chime/latest/ag/manage-global.html) no *Guia do administrador do Amazon Chime*.
+ Para ver detalhes da API, consulte [GetGlobalSettings](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/chime/get-global-settings.html) na *Referência de comandos da AWS CLI*.
### `get-phone-number-order`
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
```
Resultado:
```
{
"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](https://docs.aws.amazon.com/chime/latest/ag/phone-numbers.html) no *Guia de administração do Amazon Chime*.
+ Para receber detalhes da API, consulte [GetPhoneNumberOrder](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/chime/get-phone-number-order.html) na *Referência de comandos da AWS CLI*.
### `get-phone-number-settings`
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. Resultado:
```
{
"CallingName": "myName",
"CallingNameUpdatedTimestamp": "2019-10-28T18:56:42.911Z"
}
```
Para obter mais informações, consulte [Trabalhar com números de telefone](https://docs.aws.amazon.com/chime/latest/ag/phone-numbers.html) no *Guia de administração do Amazon Chime*.
+ Para ver detalhes da API, consulte [GetPhoneNumberSettings](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/chime/get-phone-number-settings.html) na *Referência de comandos da AWS CLI*.
### `get-phone-number`
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
```
Resultado:
```
{
"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](https://docs.aws.amazon.com/chime/latest/ag/phone-numbers.html) no *Guia de administração do Amazon Chime*.
+ Para ver detalhes da API, consulte [GetPhoneNumber](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/chime/get-phone-number.html) na *Referência de comandos da AWS CLI*.
### `get-room`
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
```
Resultado:
```
{
"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](https://docs.aws.amazon.com/chime/latest/ug/chime-chat-room.html) no *Guia do usuário do Amazon Chime*.
+ Para ver detalhes da API, consulte [GetRoom](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/chime/get-room.html) na *Referência de comandos da AWS CLI*.
### `get-user-settings`
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
```
Resultado:
```
{
"UserSettings": {
"Telephony": {
"InboundCalling": true,
"OutboundCalling": true,
"SMS": true
}
}
}
```
Para obter mais informações, consulte [Gerenciamento de números de telefone do usuário](https://docs.aws.amazon.com/chime/latest/ag/user-phone.html) no *Guia de administração do Amazon Chime*.
+ Para ver detalhes da API, consulte [GetUserSettings](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/chime/get-user-settings.html) na *Referência de comandos da AWS CLI*.
### `get-user`
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
```
Resultado:
```
{
"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](https://docs.aws.amazon.com/chime/latest/ag/manage-users.html) no *Guia de administração do Amazon Chime*.
+ Consulte detalhes da API em [GetUser](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/chime/get-user.html) na *Referência de comandos da AWS CLI*.
### `invite-users`
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"
```
Resultado:
```
{
"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](https://docs.aws.amazon.com/chime/latest/ag/manage-access.html#invite-users-team) no *Guia de administração do Amazon Chime*.
+ Para ver detalhes da API, consulte [InviteUsers](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/chime/invite-users.html) na *Referência de comandos da AWS CLI*.
### `list-accounts`
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
```
Resultado:
```
{
"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](https://docs.aws.amazon.com/chime/latest/ag/manage-chime-account.html) no *Guia de administração do Amazon Chime*.
+ Consulte detalhes da API em [ListAccounts](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/chime/list-accounts.html) na *Referência de comandos da AWS CLI*.
### `list-bots`
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
```
Resultado:
```
{
"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](https://docs.aws.amazon.com/chime/latest/dg/use-bots.html) no *Guia do desenvolvedor do Amazon Chime*.
+ Para ver detalhes da API, consulte [ListBots](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/chime/list-bots.html) na *Referência de comandos da AWS CLI*.
### `list-phone-number-orders`
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
```
Resultado:
```
{
"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](https://docs.aws.amazon.com/chime/latest/ag/phone-numbers.html) no *Guia de administração do Amazon Chime*.
+ Para ver detalhes da API, consulte [ListPhoneNumberOrders](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/chime/list-phone-number-orders.html) na *Referência de comandos da AWS CLI*.
### `list-phone-numbers`
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. Resultado:
```
{
"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](https://docs.aws.amazon.com/chime/latest/ag/phone-numbers.html) no *Guia de administração do Amazon Chime*.
+ Para ver detalhes da API, consulte [ListPhoneNumbers](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/chime/list-phone-numbers.html) na *Referência de comandos da AWS CLI*.
### `list-room-memberships`
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
```
Resultado:
```
{
"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](https://docs.aws.amazon.com/chime/latest/ug/chime-chat-room.html) no *Guia do usuário do Amazon Chime*.
+ Para ver detalhes da API, consulte [ListRoomMemberships](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/chime/list-room-memberships.html) na *Referência de comandos da AWS CLI*.
### `list-rooms`
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
```
Resultado:
```
{
"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](https://docs.aws.amazon.com/chime/latest/ug/chime-chat-room.html) no *Guia do usuário do Amazon Chime*.
+ Para ver detalhes da API, consulte [ListRooms](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/chime/list-rooms.html) na *Referência de comandos da AWS CLI*.
### `list-users`
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
```
Resultado:
```
{
"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](https://docs.aws.amazon.com/chime/latest/ag/manage-users.html) no *Guia de administração do Amazon Chime*.
+ Consulte detalhes da API em [ListUsers](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/chime/list-users.html) na *Referência de comandos da AWS CLI*.
### `logout-user`
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](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/chime/logout-user.html) na *Referência de comandos da AWS CLI*.
### `regenerate-security-token`
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
```
Resultado:
```
{
"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](https://docs.aws.amazon.com/chime/latest/dg/auth-bots.html) no *Guia do desenvolvedor do Amazon Chime*.
+ Para ver detalhes da API, consulte [RegenerateSecurityToken](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/chime/regenerate-security-token.html) na *Referência de comandos da AWS CLI*.
### `reset-personal-pin`
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
```
Resultado:
```
{
"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](https://docs.aws.amazon.com/chime/latest/ag/change-PINs.html) no *Guia de administração do Amazon Chime*.
+ Para ver detalhes da API, consulte [ResetPersonalPin](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/chime/reset-personal-pin.html) na *Referência de comandos da AWS CLI*.
### `restore-phone-number`
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"
```
Resultado:
```
{
"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](https://docs.aws.amazon.com/chime/latest/ag/phone-numbers.html) no *Guia de administração do Amazon Chime*.
+ Para ver detalhes da API, consulte [RestorePhoneNumber](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/chime/restore-phone-number.html) na *Referência de comandos da AWS CLI*.
### `search-available-phone-numbers`
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"
```
Resultado:
```
{
"E164PhoneNumbers": [
"+12065550100",
"+12065550101",
"+12065550102",
"+12065550103",
"+12065550104",
"+12065550105",
"+12065550106",
"+12065550107",
"+12065550108",
"+12065550109",
]
}
```
Para obter mais informações, consulte [Trabalhar com números de telefone](https://docs.aws.amazon.com/chime/latest/ag/phone-numbers.html) no *Guia de administração do Amazon Chime*.
+ Para ver detalhes da API, consulte [SearchAvailablePhoneNumbers](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/chime/search-available-phone-numbers.html) na *Referência de comandos da AWS CLI*.
### `update-account-settings`
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](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/chime/update-account-settings.html) na *Referência de comandos da AWS CLI*.
### `update-account`
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
```
Resultado:
```
{
"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](https://docs.aws.amazon.com/chime/latest/ag/rename-account.html) no *Guia de administração do Amazon Chime*.
+ Para ver detalhes da API, consulte [UpdateAccount](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/chime/update-account.html) na *Referência de comandos da AWS CLI*.
### `update-bot`
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
```
Resultado:
```
{
"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](https://docs.aws.amazon.com/chime/latest/dg/update-bots.html) no *Guia do desenvolvedor do Amazon Chime*.
+ Para ver detalhes da API, consulte [UpdateBot](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/chime/update-bot.html) na *Referência de comandos da AWS CLI*.
### `update-global-settings`
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](https://docs.aws.amazon.com/chime/latest/ag/manage-global.html) no *Guia do administrador do Amazon Chime*.
+ Para ver detalhes da API, consulte [UpdateGlobalSettings](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/chime/update-global-settings.html) na *Referência de comandos da AWS CLI*.
### `update-phone-number-settings`
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](https://docs.aws.amazon.com/chime/latest/ag/phone-numbers.html) no *Guia de administração do Amazon Chime*.
+ Para ver detalhes da API, consulte [UpdatePhoneNumberSettings](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/chime/update-phone-number-settings.html) na *Referência de comandos da AWS CLI*.
### `update-phone-number`
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"
```
Resultado:
```
{
"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 "\$112065550100" --calling-name "phonenumber2"
Resultado:
```
{
"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](https://docs.aws.amazon.com/chime/latest/ag/phone-numbers.html) no *Guia de administração do Amazon Chime*.
+ Para ver detalhes da API, consulte [UpdatePhoneNumber](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/chime/update-phone-number.html) na *Referência de comandos da AWS CLI*.
### `update-room-membership`
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
```
Resultado:
```
{
"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](https://docs.aws.amazon.com/chime/latest/ug/chime-chat-room.html) no *Guia do usuário do Amazon Chime*.
+ Para ver detalhes da API, consulte [UpdateRoomMembership](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/chime/update-room-membership.html) na *Referência de comandos da AWS CLI*.
### `update-room`
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
```
Resultado:
```
{
"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](https://docs.aws.amazon.com/chime/latest/ug/chime-chat-room.html) no *Guia do usuário do Amazon Chime*.
+ Para ver detalhes da API, consulte [UpdateRoom](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/chime/update-room.html) na *Referência de comandos da AWS CLI*.
### `update-user-settings`
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](https://docs.aws.amazon.com/chime/latest/ag/user-phone.html) no *Guia de administração do Amazon Chime*.
+ Para ver detalhes da API, consulte [UpdateUserSettings](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/chime/update-user-settings.html) na *Referência de comandos da AWS CLI*.
### `update-user`
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"
```
Resultado:
```
{
"User": {
"UserId": "a1b2c3d4-5678-90ab-cdef-22222EXAMPLE"
}
}
```
+ Consulte detalhes da API em [UpdateUser](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/chime/update-user.html) na *Referência de comandos da AWS CLI*.