# Exemplos do Amazon WorkMail 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 WorkMail.
*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-delegate-to-resource`
O código de exemplo a seguir mostra como usar `associate-delegate-to-resource`.
**AWS CLI**
**Para adicionar um delegado a um recurso**
O comando `associate-delegate-to-resource` a seguir adiciona um delegado a um recurso.
```
aws workmail associate-delegate-to-resource \
--organization-id m-d281d0a2fd824be5b6cd3d3ce909fd27 \
--resource-id r-68bf2d3b1c0244aab7264c24b9217443 \
--entity-id S-1-1-11-1111111111-2222222222-3333333333-3333
```
Este comando não produz saída.
+ Para ver detalhes da API, consulte [AssociateDelegateToResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/workmail/associate-delegate-to-resource.html) na *Referência de comandos da AWS CLI*.
### `associate-member-to-group`
O código de exemplo a seguir mostra como usar `associate-member-to-group`.
**AWS CLI**
**Para adicionar um membro a um grupo**
O comando `associate-member-to-group` a seguir adiciona o membro especificado a um grupo.
```
aws workmail associate-member-to-group \
--organization-id m-d281d0a2fd824be5b6cd3d3ce909fd27 \
--group-id S-1-1-11-1122222222-2222233333-3333334444-4444 \
--member-id S-1-1-11-1111111111-2222222222-3333333333-3333
```
Este comando não produz saída.
+ Para ver detalhes da API, consulte [AssociateMemberToGroup](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/workmail/associate-member-to-group.html) na *Referência de comandos da AWS CLI*.
### `create-alias`
O código de exemplo a seguir mostra como usar `create-alias`.
**AWS CLI**
**Para criar um alias**
O comando `create-alias` a seguir cria um alias para a entidade especificada (usuário ou grupo).
```
aws workmail create-alias \
--organization-id m-d281d0a2fd824be5b6cd3d3ce909fd27 \
--entity-id S-1-1-11-1122222222-2222233333-3333334444-4444 \
--alias exampleAlias@site.awsapps.com
```
Este comando não produz saída.
+ Consulte detalhes da API em [CreateAlias](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/workmail/create-alias.html) na *Referência de comandos da AWS CLI*.
### `create-group`
O código de exemplo a seguir mostra como usar `create-group`.
**AWS CLI**
**Para criar um novo grupo**
O comando `create-group` a seguir cria um novo grupo para a organização especificada.
```
aws workmail create-group \
--organization-id m-d281d0a2fd824be5b6cd3d3ce909fd27 \
--name exampleGroup1
```
Resultado:
```
{
"GroupId": "S-1-1-11-1122222222-2222233333-3333334444-4444"
}
```
+ Consulte detalhes da API em [CreateGroup](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/workmail/create-group.html) na *Referência de comandos da AWS CLI*.
### `create-resource`
O código de exemplo a seguir mostra como usar `create-resource`.
**AWS CLI**
**Para criar um novo recurso**
O comando `create-resource` a seguir cria um novo recurso (sala de reuniões) para a organização especificada.
```
aws workmail create-resource \
--organization-id m-d281d0a2fd824be5b6cd3d3ce909fd27 \
--name exampleRoom1 \
--type ROOM
```
Resultado:
```
{
"ResourceId": "r-7afe0efbade843a58cdc10251fce992c"
}
```
+ Consulte detalhes da API em [CreateResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/workmail/create-resource.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 novo usuário**
O comando `create-user` a seguir cria um novo usuário.
```
aws workmail create-user \
--organization-id m-d281d0a2fd824be5b6cd3d3ce909fd27 \
--name exampleName \
--display-name exampleDisplayName \
--password examplePa$$w0rd
```
Resultado:
```
{
"UserId": "S-1-1-11-1111111111-2222222222-3333333333-3333"
}
```
+ Consulte detalhes da API em [CreateUser](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/workmail/create-user.html) na *Referência de comandos da AWS CLI*.
### `delete-access-control-rule`
O código de exemplo a seguir mostra como usar `delete-access-control-rule`.
**AWS CLI**
**Para excluir uma regra de controle de acesso**
O exemplo `delete-access-control-rule` a seguir exclui a regra de controle de acesso especificada da organização especificada do Amazon WorkMail.
```
aws workmail delete-access-control-rule \
--organization-id m-n1pq2345678r901st2u3vx45x6789yza \
--name "myRule"
```
Este comando não produz saída.
Para obter mais informações, consulte [Trabalhar com regras de controle de acesso](https://docs.aws.amazon.com/workmail/latest/adminguide/access-rules.html) no *Guia do administrador do Amazon WorkMail*.
+ Para ver detalhes da API, consulte [DeleteAccessControlRule](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/workmail/delete-access-control-rule.html) na *Referência de comandos da AWS CLI*.
### `delete-alias`
O código de exemplo a seguir mostra como usar `delete-alias`.
**AWS CLI**
**Para excluir um alias**
O comando `delete-alias` a seguir exclui o alias da entidade especificada (usuário ou grupo).
```
aws workmail delete-alias \
--organization-id m-d281d0a2fd824be5b6cd3d3ce909fd27 \
--entity-id S-1-1-11-1122222222-2222233333-3333334444-4444 \
--alias exampleAlias@site.awsapps.com
```
Este comando não produz saída.
+ Consulte detalhes da API em [DeleteAlias](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/workmail/delete-alias.html) na *Referência de comandos da AWS CLI*.
### `delete-group`
O código de exemplo a seguir mostra como usar `delete-group`.
**AWS CLI**
**Para excluir um grupo existente**
O comando `delete-group` a seguir exclui um grupo existente do Amazon WorkMail.
```
aws workmail delete-group \
--organization-id m-d281d0a2fd824be5b6cd3d3ce909fd27 \
--group-id S-1-1-11-1122222222-2222233333-3333334444-4444
```
Este comando não produz saída.
+ Consulte detalhes da API em [DeleteGroup](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/workmail/delete-group.html) na *Referência de comandos da AWS CLI*.
### `delete-mailbox-permissions`
O código de exemplo a seguir mostra como usar `delete-mailbox-permissions`.
**AWS CLI**
**Para excluir permissões de caixa de correio**
O comando `delete-mailbox-permissions` a seguir exclui as permissões de caixa de correio que foram concedidas anteriormente a um usuário ou grupo. A entidade representa o usuário que possui a caixa de correio, e o beneficiário representa o usuário ou grupo cujas permissões serão excluídas.
```
aws workmail delete-mailbox-permissions \
--organization-id m-d281d0a2fd824be5b6cd3d3ce909fd27 \
--entity-id S-1-1-11-1122222222-2222233333-3333334444-4444 \
--grantee-id S-1-1-11-1111111111-2222222222-3333333333-3333
```
Este comando não produz saída.
+ Para ver detalhes da API, consulte [DeleteMailboxPermissions](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/workmail/delete-mailbox-permissions.html) na *Referência de comandos da AWS CLI*.
### `delete-resource`
O código de exemplo a seguir mostra como usar `delete-resource`.
**AWS CLI**
**Para excluir um recurso existente**
O comando `delete-resource` a seguir exclui um recurso existente do Amazon WorkMail.
```
aws workmail delete-resource \
--organization-id m-d281d0a2fd824be5b6cd3d3ce909fd27 \
--resource-id r-7afe0efbade843a58cdc10251fce992c
```
Este comando não produz saída.
+ Para ver detalhes da API, consulte [DeleteResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/workmail/delete-resource.html) na *Referência de comandos da AWS CLI*.
### `delete-user`
O código de exemplo a seguir mostra como usar `delete-user`.
**AWS CLI**
**Para excluir um usuário**
O comando `delete-user` a seguir exclui o usuário especificado do Amazon WorkMail e de todos os sistemas subsequentes.
```
aws workmail delete-user \
--organization-id m-d281d0a2fd824be5b6cd3d3ce909fd27 \
--user-id S-1-1-11-1111111111-2222222222-3333333333-3333
```
Este comando não produz saída.
+ Consulte detalhes da API em [DeleteUser](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/workmail/delete-user.html) na *Referência de comandos da AWS CLI*.
### `deregister-from-work-mail`
O código de exemplo a seguir mostra como usar `deregister-from-work-mail`.
**AWS CLI**
**Para desativar uma entidade existente**
O comando `deregister-from-work-mail` a seguir impede que uma entidade existente (usuário, grupo ou recurso) use o Amazon WorkMail.
```
aws workmail deregister-from-work-mail \
--organization-id m-d281d0a2fd824be5b6cd3d3ce909fd27 \
--entity-id S-1-1-11-1111111111-2222222222-3333333333-3333
```
Este comando não produz saída.
+ Para ver detalhes da API, consulte [DeregisterFromWorkMail](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/workmail/deregister-from-work-mail.html) na *Referência de comandos da AWS CLI*.
### `describe-group`
O código de exemplo a seguir mostra como usar `describe-group`.
**AWS CLI**
**Para recuperar informações de um grupo**
O comando `describe-group` a seguir recupera informações sobre o grupo especificado.
```
aws workmail describe-group \
--organization-id m-d281d0a2fd824be5b6cd3d3ce909fd27 \
--group-id S-1-1-11-1122222222-2222233333-3333334444-4444
```
Resultado:
```
{
"GroupId": "S-1-1-11-1122222222-2222233333-3333334444-4444",
"Name": "exampleGroup1",
"State": "ENABLED"
}
```
+ Para ver detalhes da API, consulte [DescribeGroup](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/workmail/describe-group.html) na *Referência de comandos da AWS CLI*.
### `describe-organization`
O código de exemplo a seguir mostra como usar `describe-organization`.
**AWS CLI**
**Para recuperar as informações de uma organização**
O comando `describe-organization` a seguir recupera informações para a organização especificada do Amazon WorkMail.
```
aws workmail describe-organization \
--organization-id m-d281d0a2fd824be5b6cd3d3ce909fd27
```
Resultado:
```
{
"OrganizationId": "m-d281d0a2fd824be5b6cd3d3ce909fd27",
"Alias": "alias",
"State": "Active",
"DirectoryId": "d-926726012c",
"DirectoryType": "VpcDirectory",
"DefaultMailDomain": "site.awsapps.com",
"CompletedDate": 1522693605.468,
"ARN": "arn:aws:workmail:us-west-2:111122223333:organization/m-n1pq2345678r901st2u3vx45x6789yza"
}
```
Para obter mais informações, consulte [Trabalhar com organizações](https://docs.aws.amazon.com/workmail/latest/adminguide/organizations_overview.html) no *Guia do administrador do Amazon WorkMail*.
+ Para ver detalhes da API, consulte [DescribeOrganization](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/workmail/describe-organization.html) na *Referência de comandos da AWS CLI*.
### `describe-resource`
O código de exemplo a seguir mostra como usar `describe-resource`.
**AWS CLI**
**Para recuperar informações de um recurso**
O comando `describe-resource` a seguir recupera informações sobre o recurso especificado.
```
aws workmail describe-resource \
--organization-id m-d281d0a2fd824be5b6cd3d3ce909fd27 \
--resource-id r-7afe0efbade843a58cdc10251fce992c
```
Resultado:
```
{
"ResourceId": "r-7afe0efbade843a58cdc10251fce992c",
"Name": "exampleRoom1",
"Type": "ROOM",
"BookingOptions": {
"AutoAcceptRequests": true,
"AutoDeclineRecurringRequests": false,
"AutoDeclineConflictingRequests": true
},
"State": "ENABLED"
}
```
+ Para ver detalhes da API, consulte [DescribeResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/workmail/describe-resource.html) na *Referência de comandos da AWS CLI*.
### `describe-user`
O código de exemplo a seguir mostra como usar `describe-user`.
**AWS CLI**
**Para recuperar informações do usuário**
O comando `describe-user` a seguir recupera informações sobre o usuário especificado.
```
aws workmail describe-user \
--organization-id m-d281d0a2fd824be5b6cd3d3ce909fd27 \
--user-id S-1-1-11-1111111111-2222222222-3333333333-3333
```
Resultado:
```
{
"UserId": "S-1-1-11-1111111111-2222222222-3333333333-3333",
"Name": "exampleUser1",
"Email": "exampleUser1@site.awsapps.com",
"DisplayName": "",
"State": "ENABLED",
"UserRole": "USER",
"EnabledDate": 1532459261.827
}
```
+ Para ver detalhes da API, consulte [DescribeUser](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/workmail/describe-user.html) na *Referência de comandos da AWS CLI*.
### `disassociate-delegate-from-resource`
O código de exemplo a seguir mostra como usar `disassociate-delegate-from-resource`.
**AWS CLI**
**Para remover um membro de um recurso**
O comando `disassociate-delegate-from-resource` a seguir remove o membro especificado de um recurso.
```
ws workmail disassociate-delegate-from-resource \
--organization-id m-d281d0a2fd824be5b6cd3d3ce909fd27 \
--resource-id r-68bf2d3b1c0244aab7264c24b9217443 \
--entity-id S-1-1-11-1111111111-2222222222-3333333333-3333
```
Este comando não produz saída.
+ Para ver detalhes da API, consulte [DisassociateDelegateFromResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/workmail/disassociate-delegate-from-resource.html) na *Referência de comandos da AWS CLI*.
### `disassociate-member-from-group`
O código de exemplo a seguir mostra como usar `disassociate-member-from-group`.
**AWS CLI**
**Para remover um membro de um grupo**
O comando `disassociate-member-from-group` a seguir remove o membro especificado de um grupo.
```
aws workmail disassociate-member-from-group \
--organization-id m-d281d0a2fd824be5b6cd3d3ce909fd27 \
--group-id S-1-1-11-1122222222-2222233333-3333334444-4444 \
--member-id S-1-1-11-1111111111-2222222222-3333333333-3333
```
Este comando não produz saída.
+ Para ver detalhes da API, consulte [DisassociateMemberFromGroup](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/workmail/disassociate-member-from-group.html) na *Referência de comandos da AWS CLI*.
### `get-access-control-effect`
O código de exemplo a seguir mostra como usar `get-access-control-effect`.
**AWS CLI**
**Para obter o efeito das regras de controle de acesso**
O exemplo `get-access-control-effect` a seguir recupera o efeito das regras de controle de acesso da organização especificada do Amazon WorkMail para o endereço IP especificado, ação de protocolo de acesso e ID de usuário.
```
aws workmail get-access-control-effect \
--organization-id m-n1pq2345678r901st2u3vx45x6789yza \
--ip-address "192.0.2.0" \
--action "WindowsOutlook" \
--user-id "S-1-1-11-1111111111-2222222222-3333333333-3333"
```
Resultado:
```
{
"Effect": "DENY",
"MatchedRules": [
"myRule"
]
}
```
Para obter mais informações, consulte [Trabalhar com regras de controle de acesso](https://docs.aws.amazon.com/workmail/latest/adminguide/access-rules.html) no *Guia do administrador do Amazon WorkMail*.
+ Para ver detalhes da API, consulte [GetAccessControlEffect](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/workmail/get-access-control-effect.html) na *Referência de comandos da AWS CLI*.
### `get-mailbox-details`
O código de exemplo a seguir mostra como usar `get-mailbox-details`.
**AWS CLI**
**Para obter os detalhes da caixa de correio de um usuário**
O comando `get-mailbox-details` a seguir recupera detalhes da caixa de correio do usuário especificado.
```
aws workmail get-mailbox-details \
--organization-id m-n1pq2345678r901st2u3vx45x6789yza \
--user-id S-1-1-11-1111111111-2222222222-3333333333-3333
```
Resultado:
```
{
"MailboxQuota": 51200,
"MailboxSize": 0.03890800476074219
}
```
Para obter mais informações, consulte [Gerenciar contas de usuários](https://docs.aws.amazon.com/workmail/latest/adminguide/manage-users.html) no *Guia do administrador do Amazon WorkMail*.
+ Para ver detalhes da API, consulte [GetMailboxDetails](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/workmail/get-mailbox-details.html) na *Referência de comandos da AWS CLI*.
### `list-access-control-rules`
O código de exemplo a seguir mostra como usar `list-access-control-rules`.
**AWS CLI**
**Para listar as regras de controle de acesso**
O exemplo `list-access-control-rules` a seguir lista as regras de controle de acesso para a organização especificada do Amazon WorkMail.
```
aws workmail list-access-control-rules \
--organization-id m-n1pq2345678r901st2u3vx45x6789yza
```
Resultado:
```
{
"Rules": [
{
"Name": "default",
"Effect": "ALLOW",
"Description": "Default WorkMail Rule",
"DateCreated": 0.0,
"DateModified": 0.0
},
{
"Name": "myRule",
"Effect": "DENY",
"Description": "my rule",
"UserIds": [
"S-1-1-11-1111111111-2222222222-3333333333-3333"
],
"DateCreated": 1581635628.0,
"DateModified": 1581635628.0
}
]
}
```
Para obter mais informações, consulte [Trabalhar com regras de controle de acesso](https://docs.aws.amazon.com/workmail/latest/adminguide/access-rules.html) no *Guia do administrador do Amazon WorkMail*.
+ Para ver detalhes da API, consulte [ListAccessControlRules](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/workmail/list-access-control-rules.html) na *Referência de comandos da AWS CLI*.
### `list-aliases`
O código de exemplo a seguir mostra como usar `list-aliases`.
**AWS CLI**
**Para listar aliases para um membro**
O comando `list-aliases` a seguir lista aliases do membro especificado (usuário ou grupo).
```
aws workmail list-aliases \
--organization-id m-d281d0a2fd824be5b6cd3d3ce909fd27 \
--entity-id S-1-1-11-1111111111-2222222222-3333333333-3333
```
Resultado:
```
{
"Aliases": [
"exampleAlias@site.awsapps.com",
"exampleAlias1@site.awsapps.com"
]
}
```
+ Consulte detalhes da API em [ListAliases](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/workmail/list-aliases.html) na *Referência de comandos da AWS CLI*.
### `list-group-members`
O código de exemplo a seguir mostra como usar `list-group-members`.
**AWS CLI**
**Para listar membros do grupo**
O comando `list-group-members` a seguir lista os membros do grupo especificado.
```
aws workmail list-group-members \
--organization-id m-d281d0a2fd824be5b6cd3d3ce909fd27 \
--group-id S-1-1-11-1122222222-2222233333-3333334444-4444
```
Resultado:
```
{
"Members": [
{
"Id": "S-1-1-11-1111111111-2222222222-3333333333-3333",
"Name": "exampleUser1",
"Type": "USER",
"State": "ENABLED",
"EnabledDate": 1532459261.827
}
]
}
```
+ Para ver detalhes da API, consulte [ListGroupMembers](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/workmail/list-group-members.html) na *Referência de comandos da AWS CLI*.
### `list-groups`
O código de exemplo a seguir mostra como usar `list-groups`.
**AWS CLI**
**Para recuperar uma lista de grupos**
O comando `list-groups` a seguir recupera resumos dos grupos na organização especificada.
```
aws workmail list-groups \
--organization-id m-d281d0a2fd824be5b6cd3d3ce909fd27
```
Resultado:
```
{
"Groups": [
{
"Id": "S-1-1-11-1122222222-2222233333-3333334444-4444",
"Name": "exampleGroup1",
"State": "DISABLED"
},
{
"Id": "S-4-4-44-1122222222-2222233333-3333334444-4444",
"Name": "exampleGroup2",
"State": "ENABLED"
}
]
}
```
+ Consulte detalhes da API em [ListGroups](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/workmail/list-groups.html) na *Referência de comandos da AWS CLI*.
### `list-mailbox-permissions`
O código de exemplo a seguir mostra como usar `list-mailbox-permissions`.
**AWS CLI**
**Para recuperar permissões de caixa de correio**
O comando `list-mailbox-permissions` a seguir recupera as permissões de caixa de correio associadas à caixa de correio da entidade especificada.
```
aws workmail list-mailbox-permissions \
--organization-id m-d281d0a2fd824be5b6cd3d3ce909fd27 \
--entity-id S-1-1-11-1111111111-2222222222-3333333333-3333
```
Resultado:
```
{
"Permissions": [
{
"GranteeId": "S-1-1-11-1122222222-2222233333-3333334444-4444",
"GranteeType": "USER",
"PermissionValues": [
"FULL_ACCESS"
]
}
]
}
```
+ Para ver detalhes da API, consulte [ListMailboxPermissions](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/workmail/list-mailbox-permissions.html) na *Referência de comandos da AWS CLI*.
### `list-organizations`
O código de exemplo a seguir mostra como usar `list-organizations`.
**AWS CLI**
**Para recuperar uma lista de organizações**
O comando `list-organizations` a seguir recupera resumos das organizações do cliente.
```
aws workmail list-organizations
```
Resultado:
```
{
"OrganizationSummaries": [
{
"OrganizationId": "m-d281d0a2fd824be5b6cd3d3ce909fd27",
"Alias": "exampleAlias",
"State": "Active"
}
]
}
```
+ Para ver detalhes da API, consulte [ListOrganizations](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/workmail/list-organizations.html) na *Referência de comandos da AWS CLI*.
### `list-resource-delegates`
O código de exemplo a seguir mostra como usar `list-resource-delegates`.
**AWS CLI**
**Para listar os delegados de um recurso**
O comando `list-resource-delegates` a seguir recupera os delegados associados ao recurso especificado.
```
aws workmail list-resource-delegates \
--organization-id m-d281d0a2fd824be5b6cd3d3ce909fd27 \
--resource-id r-68bf2d3b1c0244aab7264c24b9217443
```
Resultado:
```
{
"Delegates": [
{
"Id": "S-1-1-11-1111111111-2222222222-3333333333-3333",
"Type": "USER"
}
]
}
```
+ Para ver detalhes da API, consulte [ListResourceDelegates](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/workmail/list-resource-delegates.html) na *Referência de comandos da AWS CLI*.
### `list-resources`
O código de exemplo a seguir mostra como usar `list-resources`.
**AWS CLI**
**Para recuperar uma lista de recursos**
O comando `list-resources` a seguir recupera resumos dos recursos da organização especificada.
```
aws workmail list-resources \
--organization-id m-d281d0a2fd824be5b6cd3d3ce909fd27
```
Resultado:
```
{
"Resources": [
{
"Id": "r-7afe0efbade843a58cdc10251fce992c",
"Name": "exampleRoom1",
"Type": "ROOM",
"State": "ENABLED"
}
]
}
```
+ Para ver detalhes da API, consulte [ListResources](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/workmail/list-resources.html) na *Referência de comandos da AWS CLI*.
### `list-tags-for-resource`
O código de exemplo a seguir mostra como usar `list-tags-for-resource`.
**AWS CLI**
**Para listar as tags de um recurso**
O exemplo `list-tags-for-resource` a seguir lista as tags para a organização especificada do Amazon WorkMail.
```
aws workmail list-tags-for-resource \
--resource-arn arn:aws:workmail:us-west-2:111122223333:organization/m-n1pq2345678r901st2u3vx45x6789yza
```
Resultado:
```
{
"Tags": [
{
"Key": "priority",
"Value": "1"
}
]
}
```
Para obter mais informações, consulte [Marcar uma organização](https://docs.aws.amazon.com/workmail/latest/adminguide/org-tag.html) no *Guia do administrador do Amazon WorkMail*.
+ Para obter detalhes sobre a API, consulte [ListTagsForResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/workmail/list-tags-for-resource.html) na *AWS CLI Command Reference*.
### `list-users`
O código de exemplo a seguir mostra como usar `list-users`.
**AWS CLI**
**Para recuperar uma lista de usuários**
O comando `list-users` a seguir recupera resumos dos usuários na organização especificada.
```
aws workmail list-users \
--organization-id m-d281d0a2fd824be5b6cd3d3ce909fd27
```
Resultado:
```
{
"Users": [
{
"Id": "S-1-1-11-1111111111-2222222222-3333333333-3333",
"Email": "exampleUser1@site.awsapps.com",
"Name": "exampleUser1",
"State": "ENABLED",
"UserRole": "USER",
"EnabledDate": 1532459261.827
},
{
"Id": "S-1-1-11-1122222222-2222233333-3333334444-4444",
"Name": "exampleGuestUser",
"State": "DISABLED",
"UserRole": "SYSTEM_USER"
}
]
}
```
+ Consulte detalhes da API em [ListUsers](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/workmail/list-users.html) na *Referência de comandos da AWS CLI*.
### `put-access-control-rule`
O código de exemplo a seguir mostra como usar `put-access-control-rule`.
**AWS CLI**
**Como definir uma regra de controle de acesso**
O exemplo `put-access-control-rule` a seguir nega ao usuário especificado o acesso à organização especificada do Amazon WorkMail.
```
aws workmail put-access-control-rule \
--name "myRule" \
--effect "DENY" \
--description "my rule" \
--user-ids "S-1-1-11-1111111111-2222222222-3333333333-3333" \
--organization-id m-n1pq2345678r901st2u3vx45x6789yza
```
Este comando não produz saída.
Para obter mais informações, consulte [Trabalhar com regras de controle de acesso](https://docs.aws.amazon.com/workmail/latest/adminguide/access-rules.html) no *Guia do administrador do Amazon WorkMail*.
+ Para ver detalhes da API, consulte [PutAccessControlRule](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/workmail/put-access-control-rule.html) na *Referência de comandos da AWS CLI*.
### `put-mailbox-permissions`
O código de exemplo a seguir mostra como usar `put-mailbox-permissions`.
**AWS CLI**
**Como definir permissões de caixa de correio**
O comando `put-mailbox-permissions` a seguir define permissões de acesso total para o beneficiário especificado (usuário ou grupo). A entidade representa o proprietário da caixa de correio.
```
aws workmail put-mailbox-permissions \
--organization-id m-d281d0a2fd824be5b6cd3d3ce909fd27 \
--entity-id S-1-1-11-1111111111-2222222222-3333333333-3333 \
--grantee-id S-1-1-11-1122222222-2222233333-3333334444-4444 \
--permission-values FULL_ACCESS
```
Este comando não produz saída.
+ Consulte detalhes da API em [PutMailboxPermissions](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/workmail/put-mailbox-permissions.html) na *Referência de comandos da AWS CLI*.
### `register-to-work-mail`
O código de exemplo a seguir mostra como usar `register-to-work-mail`.
**AWS CLI**
**Para registrar uma entidade existente ou desabilitada**
O comando `register-to-work-mail` a seguir permite que a entidade existente especificada (usuário, grupo ou recurso) use o Amazon WorkMail.
```
aws workmail register-to-work-mail \
--organization-id m-d281d0a2fd824be5b6cd3d3ce909fd27 \
--entity-id S-1-1-11-1122222222-2222233333-3333334444-4444 \
--email exampleGroup1@site.awsapps.com
```
Este comando não produz saída.
+ Para ver detalhes da API, consulte [RegisterToWorkMail](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/workmail/register-to-work-mail.html) na *Referência de comandos da AWS CLI*.
### `reset-password`
O código de exemplo a seguir mostra como usar `reset-password`.
**AWS CLI**
**Como redefinir a senha de um usuário**
O comando `reset-password` a seguir redefine a senha do usuário especificado.
```
aws workmail reset-password \
--organization-id m-d281d0a2fd824be5b6cd3d3ce909fd27 \
--user-id S-1-1-11-1111111111-2222222222-3333333333-3333 \
--password examplePa$$w0rd
```
Este comando não produz saída.
+ Para ver detalhes da API, consulte [ResetPassword](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/workmail/reset-password.html) na *Referência de comandos da AWS CLI*.
### `tag-resource`
O código de exemplo a seguir mostra como usar `tag-resource`.
**AWS CLI**
**Como aplicar uma tag a um recurso**
O exemplo `tag-resource` a seguir aplica uma tag com a chave “prioridade” e valor “1” à organização especificada do Amazon WorkMail.
```
aws workmail tag-resource \
--resource-arn arn:aws:workmail:us-west-2:111122223333:organization/m-n1pq2345678r901st2u3vx45x6789yza \
--tags "Key=priority,Value=1"
```
Este comando não produz saída.
Para obter mais informações, consulte [Marcar uma organização](https://docs.aws.amazon.com/workmail/latest/adminguide/org-tag.html) no *Guia do administrador do Amazon WorkMail*.
+ Consulte detalhes da API em [TagResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/workmail/tag-resource.html) na *Referência de comandos da AWS CLI*.
### `untag-resource`
O código de exemplo a seguir mostra como usar `untag-resource`.
**AWS CLI**
**Como desmarcar um recurso**
O exemplo `untag-resource` a seguir remove a tag especificada da organização especificada do Amazon WorkMail.
```
aws workmail untag-resource \
--resource-arn arn:aws:workmail:us-west-2:111122223333:organization/m-n1pq2345678r901st2u3vx45x6789yza \
--tag-keys "priority"
```
Este comando não produz saída.
Para obter mais informações, consulte [Marcar uma organização](https://docs.aws.amazon.com/workmail/latest/adminguide/org-tag.html) no *Guia do administrador do Amazon WorkMail*.
+ Para obter detalhes sobre a API, consulte [UntagResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/workmail/untag-resource.html) na *Referência de comandos da AWS CLI*.
### `update-mailbox-quota`
O código de exemplo a seguir mostra como usar `update-mailbox-quota`.
**AWS CLI**
**Para atualizar a cota da caixa de correio de um usuário**
O comando `update-mailbox-quota` a seguir altera a cota da caixa de correio do usuário especificado.
```
aws workmail update-mailbox-quota \
--organization-id m-n1pq2345678r901st2u3vx45x6789yza \
--user-id S-1-1-11-1111111111-2222222222-3333333333-3333 \
--mailbox-quota 40000
```
Este comando não produz saída.
Para obter mais informações, consulte [Gerenciar contas de usuários](https://docs.aws.amazon.com/workmail/latest/adminguide/manage-users.html) no *Guia do administrador do Amazon WorkMail*.
+ Para ver detalhes da API, consulte [UpdateMailboxQuota](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/workmail/update-mailbox-quota.html) na *Referência de comandos da AWS CLI*.
### `update-primary-email-address`
O código de exemplo a seguir mostra como usar `update-primary-email-address`.
**AWS CLI**
**Para atualizar um endereço de e-mail principal**
O comando `update-primary-email-address` a seguir atualiza o endereço de e-mail principal da entidade especificada (usuário, grupo ou recurso).
```
aws workmail update-primary-email-address \
--organization-id m-d281d0a2fd824be5b6cd3d3ce909fd27 \
--entity-id S-1-1-11-1111111111-2222222222-3333333333-3333 \
--email exampleUser2@site.awsapps.com
```
Este comando não produz saída.
+ Para ver detalhes da API, consulte [UpdatePrimaryEmailAddress](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/workmail/update-primary-email-address.html) na *Referência de comandos da AWS CLI*.
### `update-resource`
O código de exemplo a seguir mostra como usar `update-resource`.
**AWS CLI**
**Para atualizar um recurso**
O comando `update-resource` a seguir atualiza o nome do recurso especificado.
```
aws workmail update-resource \
--organization-id m-d281d0a2fd824be5b6cd3d3ce909fd27 \
--resource-id r-7afe0efbade843a58cdc10251fce992c \
--name exampleRoom2
```
Este comando não produz saída.
+ Para ver detalhes da API, consulte [UpdateResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/workmail/update-resource.html) na *Referência de comandos da AWS CLI*.