# Ejemplos de Amazon WorkMail que utilizan la AWS CLI
En los siguientes ejemplos de código, se muestra cómo realizar acciones e implementar escenarios comunes usando AWS Command Line Interface con Amazon WorkMail.
Las *acciones* son extractos de código de programas más grandes y deben ejecutarse en contexto. Mientras las acciones muestran cómo llamar a las distintas funciones de servicio, es posible ver las acciones en contexto en los escenarios relacionados.
En cada ejemplo se incluye un enlace al código de origen completo, con instrucciones de configuración y ejecución del código en el contexto.
**Topics**
+ [Acciones](#actions)
## Acciones
### `associate-delegate-to-resource`
En el siguiente ejemplo de código, se muestra cómo utilizar `associate-delegate-to-resource`.
**AWS CLI**
**Para añadir un delegado a un recurso**
El siguiente comando `associate-delegate-to-resource` agrega un delegado a un 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 no genera ninguna salida.
+ Para obtener información sobre la API, consulte [AssociateDelegateToResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/workmail/associate-delegate-to-resource.html) en la *Referencia de comandos de la AWS CLI*.
### `associate-member-to-group`
En el siguiente ejemplo de código, se muestra cómo utilizar `associate-member-to-group`.
**AWS CLI**
**Para agregar un miembro a un grupo**
El siguiente comando `associate-member-to-group` agrega el miembro especificado a un 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 no genera ninguna salida.
+ Para obtener información sobre la API, consulte [AssociateMemberToGroup](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/workmail/associate-member-to-group.html) en la *Referencia de comandos de la AWS CLI*.
### `create-alias`
En el siguiente ejemplo de código, se muestra cómo utilizar `create-alias`.
**AWS CLI**
**Para crear un alias**
El siguiente comando `create-alias` crea un alias para la entidad especificada (usuario o 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 no genera ninguna salida.
+ Para ver los detalles de la API, consulte [CreateAlias](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/workmail/create-alias.html) en la *Referencia de comandos de la AWS CLI*.
### `create-group`
En el siguiente ejemplo de código, se muestra cómo utilizar `create-group`.
**AWS CLI**
**Para crear un grupo nuevo**
El siguiente comando `create-group` crea un nuevo grupo en la organización especificada.
```
aws workmail create-group \
--organization-id m-d281d0a2fd824be5b6cd3d3ce909fd27 \
--name exampleGroup1
```
Salida:
```
{
"GroupId": "S-1-1-11-1122222222-2222233333-3333334444-4444"
}
```
+ Para obtener información sobre la API, consulte [CreateGroup](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/workmail/create-group.html) en la *Referencia de comandos de la AWS CLI*.
### `create-resource`
En el siguiente ejemplo de código, se muestra cómo utilizar `create-resource`.
**AWS CLI**
**Para crear un nuevo recurso**
El siguiente comando `create-resource` crea un nuevo recurso (sala de reuniones) para la organización especificada.
```
aws workmail create-resource \
--organization-id m-d281d0a2fd824be5b6cd3d3ce909fd27 \
--name exampleRoom1 \
--type ROOM
```
Salida:
```
{
"ResourceId": "r-7afe0efbade843a58cdc10251fce992c"
}
```
+ Para obtener información sobre la API, consulte [CreateResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/workmail/create-resource.html) en la *Referencia de comandos de la AWS CLI*.
### `create-user`
En el siguiente ejemplo de código, se muestra cómo utilizar `create-user`.
**AWS CLI**
**Para crear un nuevo usuario**
El siguiente comando `create-user` crea un nuevo usuario.
```
aws workmail create-user \
--organization-id m-d281d0a2fd824be5b6cd3d3ce909fd27 \
--name exampleName \
--display-name exampleDisplayName \
--password examplePa$$w0rd
```
Salida:
```
{
"UserId": "S-1-1-11-1111111111-2222222222-3333333333-3333"
}
```
+ Para obtener información sobre la API, consulte [CreateUser](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/workmail/create-user.html) en la *Referencia de comandos de la AWS CLI*.
### `delete-access-control-rule`
En el siguiente ejemplo de código, se muestra cómo utilizar `delete-access-control-rule`.
**AWS CLI**
**Para eliminar una regla de control de acceso**
En el siguiente ejemplo de `delete-access-control-rule`, se elimina la regla de control de acceso especificada de la organización de Amazon WorkMail indicada.
```
aws workmail delete-access-control-rule \
--organization-id m-n1pq2345678r901st2u3vx45x6789yza \
--name "myRule"
```
Este comando no genera ninguna salida.
Para obtener más información, consulte [Working with Access Control Rules](https://docs.aws.amazon.com/workmail/latest/adminguide/access-rules.html) en la *Guía del administrador de Amazon WorkMail*.
+ Para obtener información sobre la API, consulte [DeleteAccessControlRule](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/workmail/delete-access-control-rule.html) en la *Referencia de comandos de la AWS CLI*.
### `delete-alias`
En el siguiente ejemplo de código, se muestra cómo utilizar `delete-alias`.
**AWS CLI**
**Para eliminar un alias**
El siguiente comando `delete-alias` elimina un alias para la entidad especificada (usuario o 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 no genera ninguna salida.
+ Para ver los detalles de la API, consulte [DeleteTopic](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/workmail/delete-alias.html) en la *Referencia de comandos de la AWS CLI*.
### `delete-group`
En el siguiente ejemplo de código, se muestra cómo utilizar `delete-group`.
**AWS CLI**
**Para eliminar un grupo existente**
El siguiente comando `delete-group` elimina un grupo existente de Amazon WorkMail.
```
aws workmail delete-group \
--organization-id m-d281d0a2fd824be5b6cd3d3ce909fd27 \
--group-id S-1-1-11-1122222222-2222233333-3333334444-4444
```
Este comando no genera ninguna salida.
+ Para obtener información sobre la API, consulte [DeleteGroup](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/workmail/delete-group.html) en la *Referencia de comandos de la AWS CLI*.
### `delete-mailbox-permissions`
En el siguiente ejemplo de código, se muestra cómo utilizar `delete-mailbox-permissions`.
**AWS CLI**
**Para eliminar los permisos del buzón de correo**
El siguiente comando `delete-mailbox-permissions` elimina los permisos de buzón de correo que se han concedido anteriormente a un usuario o grupo. La entidad representa al usuario propietario del buzón de correo y el concesionario representa al usuario o grupo para el que se van a eliminar los permisos.
```
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 no genera ninguna salida.
+ Para obtener información sobre la API, consulte [DeleteMailboxPermissions](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/workmail/delete-mailbox-permissions.html) en la *Referencia de comandos de la AWS CLI*.
### `delete-resource`
En el siguiente ejemplo de código, se muestra cómo utilizar `delete-resource`.
**AWS CLI**
**Para eliminar un recurso existente**
El siguiente comando `delete-resource` elimina un recurso existente de Amazon WorkMail.
```
aws workmail delete-resource \
--organization-id m-d281d0a2fd824be5b6cd3d3ce909fd27 \
--resource-id r-7afe0efbade843a58cdc10251fce992c
```
Este comando no genera ninguna salida.
+ Para obtener información sobre la API, consulte [DeleteResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/workmail/delete-resource.html) en la *Referencia de comandos de la AWS CLI*.
### `delete-user`
En el siguiente ejemplo de código, se muestra cómo utilizar `delete-user`.
**AWS CLI**
**Cómo eliminar un usuario**
El siguiente comando `delete-user` elimina el usuario especificado de Amazon WorkMail y de todos los sistemas posteriores.
```
aws workmail delete-user \
--organization-id m-d281d0a2fd824be5b6cd3d3ce909fd27 \
--user-id S-1-1-11-1111111111-2222222222-3333333333-3333
```
Este comando no genera ninguna salida.
+ Para obtener información sobre la API, consulte [DeleteUser](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/workmail/delete-user.html) en la *Referencia de comandos de la AWS CLI*.
### `deregister-from-work-mail`
En el siguiente ejemplo de código, se muestra cómo utilizar `deregister-from-work-mail`.
**AWS CLI**
**Para deshabilitar una entidad existente**
El siguiente comando `deregister-from-work-mail` impide que una entidad existente (usuario, grupo o recurso) utilice Amazon WorkMail.
```
aws workmail deregister-from-work-mail \
--organization-id m-d281d0a2fd824be5b6cd3d3ce909fd27 \
--entity-id S-1-1-11-1111111111-2222222222-3333333333-3333
```
Este comando no genera ninguna salida.
+ Para obtener información sobre la API, consulte [DeregisterFromWorkMail](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/workmail/deregister-from-work-mail.html) en la *Referencia de comandos de la AWS CLI*.
### `describe-group`
En el siguiente ejemplo de código, se muestra cómo utilizar `describe-group`.
**AWS CLI**
**Para recuperar información de un grupo**
El siguiente comando `describe-group` recupera información acerca del grupo especificado.
```
aws workmail describe-group \
--organization-id m-d281d0a2fd824be5b6cd3d3ce909fd27 \
--group-id S-1-1-11-1122222222-2222233333-3333334444-4444
```
Salida:
```
{
"GroupId": "S-1-1-11-1122222222-2222233333-3333334444-4444",
"Name": "exampleGroup1",
"State": "ENABLED"
}
```
+ Para obtener información sobre la API, consulte [DescribeGroup](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/workmail/describe-group.html) en la *Referencia de comandos de la AWS CLI*.
### `describe-organization`
En el siguiente ejemplo de código, se muestra cómo utilizar `describe-organization`.
**AWS CLI**
**Para recuperar la información de una organización**
El siguiente comando `describe-organization` recupera información de la organización de Amazon WorkMail especificada.
```
aws workmail describe-organization \
--organization-id m-d281d0a2fd824be5b6cd3d3ce909fd27
```
Salida:
```
{
"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 obtener más información, consulte [Working with Organizations](https://docs.aws.amazon.com/workmail/latest/adminguide/organizations_overview.html) en la *Guía del administrador de Amazon WorkMail*.
+ Para obtener información sobre la API, consulte [DescribeOrganization](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/workmail/describe-organization.html) en la *Referencia de comandos de la AWS CLI*.
### `describe-resource`
En el siguiente ejemplo de código, se muestra cómo utilizar `describe-resource`.
**AWS CLI**
**Para recuperar información de un recurso**
El siguiente comando `describe-resource` recupera información acerca del recurso especificado.
```
aws workmail describe-resource \
--organization-id m-d281d0a2fd824be5b6cd3d3ce909fd27 \
--resource-id r-7afe0efbade843a58cdc10251fce992c
```
Salida:
```
{
"ResourceId": "r-7afe0efbade843a58cdc10251fce992c",
"Name": "exampleRoom1",
"Type": "ROOM",
"BookingOptions": {
"AutoAcceptRequests": true,
"AutoDeclineRecurringRequests": false,
"AutoDeclineConflictingRequests": true
},
"State": "ENABLED"
}
```
+ Para obtener información sobre la API, consulte [DescribeResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/workmail/describe-resource.html) en la *Referencia de comandos de la AWS CLI*.
### `describe-user`
En el siguiente ejemplo de código, se muestra cómo utilizar `describe-user`.
**AWS CLI**
**Para recuperar información del usuario**
El siguiente comando `describe-user` recupera información acerca del usuario especificado.
```
aws workmail describe-user \
--organization-id m-d281d0a2fd824be5b6cd3d3ce909fd27 \
--user-id S-1-1-11-1111111111-2222222222-3333333333-3333
```
Salida:
```
{
"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 obtener detalles sobre la API, consulte [DescribeUser](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/workmail/describe-user.html) en la *Referencia de comandos de la AWS CLI*.
### `disassociate-delegate-from-resource`
En el siguiente ejemplo de código, se muestra cómo utilizar `disassociate-delegate-from-resource`.
**AWS CLI**
**Para eliminar un miembro de un recurso**
El siguiente comando `disassociate-delegate-from-resource` elimina el miembro especificado de un 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 no genera ninguna salida.
+ Para obtener información sobre la API, consulte [DisassociateDelegateFromResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/workmail/disassociate-delegate-from-resource.html) en la *Referencia de comandos de la AWS CLI*.
### `disassociate-member-from-group`
En el siguiente ejemplo de código, se muestra cómo utilizar `disassociate-member-from-group`.
**AWS CLI**
**Para eliminar un miembro de un grupo**
El siguiente comando `disassociate-member-from-group` elimina el miembro especificado de un 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 no genera ninguna salida.
+ Para obtener información sobre la API, consulte [DisassociateMemberFromGroup](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/workmail/disassociate-member-from-group.html) en la *Referencia de comandos de la AWS CLI*.
### `get-access-control-effect`
En el siguiente ejemplo de código, se muestra cómo utilizar `get-access-control-effect`.
**AWS CLI**
**Para obtener el efecto de las reglas de control de acceso**
En el siguiente ejemplo de `get-access-control-effect`, se recupera el efecto de las reglas de control de acceso de la organización de Amazon WorkMail especificadas para la dirección IP, la acción de protocolo de acceso y el ID de usuario especificados.
```
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"
```
Salida:
```
{
"Effect": "DENY",
"MatchedRules": [
"myRule"
]
}
```
Para obtener más información, consulte [Working with Access Control Rules](https://docs.aws.amazon.com/workmail/latest/adminguide/access-rules.html) en la *Guía del administrador de Amazon WorkMail*.
+ Para obtener más información sobre la API, consulte [GetAccessControlEffect](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/workmail/get-access-control-effect.html) en la *Referencia de comandos de la AWS CLI*.
### `get-mailbox-details`
En el siguiente ejemplo de código, se muestra cómo utilizar `get-mailbox-details`.
**AWS CLI**
**Para obtener los detalles del buzón de correo de un usuario**
El siguiente comando `get-mailbox-details` recupera detalles acerca del buzón de correo del usuario especificado.
```
aws workmail get-mailbox-details \
--organization-id m-n1pq2345678r901st2u3vx45x6789yza \
--user-id S-1-1-11-1111111111-2222222222-3333333333-3333
```
Salida:
```
{
"MailboxQuota": 51200,
"MailboxSize": 0.03890800476074219
}
```
Para obtener más información, consulte [Managing User Accounts](https://docs.aws.amazon.com/workmail/latest/adminguide/manage-users.html) en la *Guía del administrador de Amazon WorkMail*.
+ Para obtener información sobre la API, consulte [GetMailboxDetails](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/workmail/get-mailbox-details.html) en la *Referencia de comandos de la AWS CLI*.
### `list-access-control-rules`
En el siguiente ejemplo de código, se muestra cómo utilizar `list-access-control-rules`.
**AWS CLI**
**Para enumerar las reglas de control de acceso**
En el siguiente ejemplo de `list-access-control-rules`, se enumeran las reglas de control de acceso especificadas para la organización de Amazon WorkMail indicada.
```
aws workmail list-access-control-rules \
--organization-id m-n1pq2345678r901st2u3vx45x6789yza
```
Salida:
```
{
"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 obtener más información, consulte [Working with Access Control Rules](https://docs.aws.amazon.com/workmail/latest/adminguide/access-rules.html) en la *Guía del administrador de Amazon WorkMail*.
+ Para obtener información sobre la API, consulte [ListAccessControlRules](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/workmail/list-access-control-rules.html) en la *Referencia de comandos de la AWS CLI*.
### `list-aliases`
En el siguiente ejemplo de código, se muestra cómo utilizar `list-aliases`.
**AWS CLI**
**Para enumerar los alias de un miembro**
El siguiente comando `list-aliases` enumera los alias para el miembro especificado (usuario o grupo).
```
aws workmail list-aliases \
--organization-id m-d281d0a2fd824be5b6cd3d3ce909fd27 \
--entity-id S-1-1-11-1111111111-2222222222-3333333333-3333
```
Salida:
```
{
"Aliases": [
"exampleAlias@site.awsapps.com",
"exampleAlias1@site.awsapps.com"
]
}
```
+ Para ver los detalles de la API, consulte [ListAliases](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/workmail/list-aliases.html) en la *Referencia de comandos de la AWS CLI*.
### `list-group-members`
En el siguiente ejemplo de código, se muestra cómo utilizar `list-group-members`.
**AWS CLI**
**Para ver una lista de los miembros del grupo**
El siguiente comando `list-group-members` enumera los miembros del grupo especificado.
```
aws workmail list-group-members \
--organization-id m-d281d0a2fd824be5b6cd3d3ce909fd27 \
--group-id S-1-1-11-1122222222-2222233333-3333334444-4444
```
Salida:
```
{
"Members": [
{
"Id": "S-1-1-11-1111111111-2222222222-3333333333-3333",
"Name": "exampleUser1",
"Type": "USER",
"State": "ENABLED",
"EnabledDate": 1532459261.827
}
]
}
```
+ Para obtener información sobre la API, consulte [ListGroupMembers](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/workmail/list-group-members.html) en la *Referencia de comandos de la AWS CLI*.
### `list-groups`
En el siguiente ejemplo de código, se muestra cómo utilizar `list-groups`.
**AWS CLI**
**Para recuperar una lista de grupos**
El siguiente comando `list-groups` recupera los resúmenes de los grupos de la organización especificada.
```
aws workmail list-groups \
--organization-id m-d281d0a2fd824be5b6cd3d3ce909fd27
```
Salida:
```
{
"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"
}
]
}
```
+ Para obtener información sobre la API, consulte [ListGroups](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/workmail/list-groups.html) en la *Referencia de comandos de la AWS CLI*.
### `list-mailbox-permissions`
En el siguiente ejemplo de código, se muestra cómo utilizar `list-mailbox-permissions`.
**AWS CLI**
**Para recuperar permisos de buzón de correo**
El siguiente comando `list-mailbox-permissions` recupera los permisos de buzón de correo asociados al buzón de correo de la entidad especificada.
```
aws workmail list-mailbox-permissions \
--organization-id m-d281d0a2fd824be5b6cd3d3ce909fd27 \
--entity-id S-1-1-11-1111111111-2222222222-3333333333-3333
```
Salida:
```
{
"Permissions": [
{
"GranteeId": "S-1-1-11-1122222222-2222233333-3333334444-4444",
"GranteeType": "USER",
"PermissionValues": [
"FULL_ACCESS"
]
}
]
}
```
+ Para obtener información sobre la API, consulte [ListMailboxPermissions](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/workmail/list-mailbox-permissions.html) en la *Referencia de comandos de la AWS CLI*.
### `list-organizations`
En el siguiente ejemplo de código, se muestra cómo utilizar `list-organizations`.
**AWS CLI**
**Para recuperar una lista de organizaciones**
El siguiente comando `list-organizations` recupera los resúmenes de las organizaciones del cliente.
```
aws workmail list-organizations
```
Salida:
```
{
"OrganizationSummaries": [
{
"OrganizationId": "m-d281d0a2fd824be5b6cd3d3ce909fd27",
"Alias": "exampleAlias",
"State": "Active"
}
]
}
```
+ Para obtener información sobre la API, consulte [ListOrganizations](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/workmail/list-organizations.html) en la *Referencia de comandos de la AWS CLI*.
### `list-resource-delegates`
En el siguiente ejemplo de código, se muestra cómo utilizar `list-resource-delegates`.
**AWS CLI**
**Para enumerar los delegados de un recurso**
El siguiente comando `list-resource-delegates` recupera los delegados asociados al rol especificado.
```
aws workmail list-resource-delegates \
--organization-id m-d281d0a2fd824be5b6cd3d3ce909fd27 \
--resource-id r-68bf2d3b1c0244aab7264c24b9217443
```
Salida:
```
{
"Delegates": [
{
"Id": "S-1-1-11-1111111111-2222222222-3333333333-3333",
"Type": "USER"
}
]
}
```
+ Para obtener información sobre la API, consulte [ListResourceDelegates](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/workmail/list-resource-delegates.html) en la *Referencia de comandos de la AWS CLI*.
### `list-resources`
En el siguiente ejemplo de código, se muestra cómo utilizar `list-resources`.
**AWS CLI**
**Para recuperar una lista de recursos**
El siguiente comando `list-resources` recupera los resúmenes de los recursos de la organización especificada.
```
aws workmail list-resources \
--organization-id m-d281d0a2fd824be5b6cd3d3ce909fd27
```
Salida:
```
{
"Resources": [
{
"Id": "r-7afe0efbade843a58cdc10251fce992c",
"Name": "exampleRoom1",
"Type": "ROOM",
"State": "ENABLED"
}
]
}
```
+ Para obtener más información sobre la API, consulte [ListResources](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/workmail/list-resources.html) en la *Referencia de comandos de la AWS CLI*.
### `list-tags-for-resource`
En el siguiente ejemplo de código, se muestra cómo utilizar `list-tags-for-resource`.
**AWS CLI**
**Para enumerar las etiquetas de un recurso**
En el siguiente ejemplo de `list-tags-for-resource`, se enumeran las etiquetas para la organización de Amazon WorkMail indicada.
```
aws workmail list-tags-for-resource \
--resource-arn arn:aws:workmail:us-west-2:111122223333:organization/m-n1pq2345678r901st2u3vx45x6789yza
```
Salida:
```
{
"Tags": [
{
"Key": "priority",
"Value": "1"
}
]
}
```
Para obtener más información, consulte [Tagging an Organization](https://docs.aws.amazon.com/workmail/latest/adminguide/org-tag.html) en la *Guía del administrador de Amazon WorkMail*.
+ Para ver los detalles de la API, consulte [ListTagsForResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/workmail/list-tags-for-resource.html) en la *Referencia de comandos de la AWS CLI*.
### `list-users`
En el siguiente ejemplo de código, se muestra cómo utilizar `list-users`.
**AWS CLI**
**Para recuperar una lista de usuarios**
El siguiente comando `list-users` recupera los resúmenes de los usuarios de la organización especificada.
```
aws workmail list-users \
--organization-id m-d281d0a2fd824be5b6cd3d3ce909fd27
```
Salida:
```
{
"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"
}
]
}
```
+ Para obtener información sobre la API, consulte [ListUsers](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/workmail/list-users.html) en la *Referencia de comandos de la AWS CLI*.
### `put-access-control-rule`
En el siguiente ejemplo de código, se muestra cómo utilizar `put-access-control-rule`.
**AWS CLI**
**Para crear una nueva regla de control de acceso**
En el siguiente ejemplo de `put-access-control-rule`, se rechaza el acceso de usuario especificado de la organización de Amazon WorkMail indicada.
```
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 no genera ninguna salida.
Para obtener más información, consulte [Working with Access Control Rules](https://docs.aws.amazon.com/workmail/latest/adminguide/access-rules.html) en la *Guía del administrador de Amazon WorkMail*.
+ Para obtener información sobre la API, consulte [PutAccessControlRule](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/workmail/put-access-control-rule.html) en la *Referencia de comandos de la AWS CLI*.
### `put-mailbox-permissions`
En el siguiente ejemplo de código, se muestra cómo utilizar `put-mailbox-permissions`.
**AWS CLI**
**Para definir permisos de buzón de correo**
El siguiente comando `put-mailbox-permissions` establece los permisos de acceso total para el concesionario especificado (usuario o grupo). La entidad representa al propietario del buzón de correo.
```
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 no genera ninguna salida.
+ Para obtener información sobre la API, consulte [PutMailboxPermissions](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/workmail/put-mailbox-permissions.html) en la *Referencia de comandos de la AWS CLI*.
### `register-to-work-mail`
En el siguiente ejemplo de código, se muestra cómo utilizar `register-to-work-mail`.
**AWS CLI**
**Para registrar una entidad existente o deshabilitada**
El siguiente comando `register-to-work-mail` permite que la entidad existente especificada (usuario, grupo o recurso) utilice 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 no genera ninguna salida.
+ Para obtener información sobre la API, consulte [RegisterToWorkMail](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/workmail/register-to-work-mail.html) en la *Referencia de comandos de la AWS CLI*.
### `reset-password`
En el siguiente ejemplo de código, se muestra cómo utilizar `reset-password`.
**AWS CLI**
**Para restablecer la contraseña de un usuario**
El siguiente comando `reset-password` restablece la contraseña del usuario especificado.
```
aws workmail reset-password \
--organization-id m-d281d0a2fd824be5b6cd3d3ce909fd27 \
--user-id S-1-1-11-1111111111-2222222222-3333333333-3333 \
--password examplePa$$w0rd
```
Este comando no genera ninguna salida.
+ Para obtener información sobre la API, consulte [ResetPassword](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/workmail/reset-password.html) en la *Referencia de comandos de la AWS CLI*.
### `tag-resource`
En el siguiente ejemplo de código, se muestra cómo utilizar `tag-resource`.
**AWS CLI**
**Para aplicar una etiqueta a un recurso**
En el siguiente ejemplo de `tag-resource`, se aplica una etiqueta con la clave priority y el valor 1 a la organización de Amazon WorkMail especificada.
```
aws workmail tag-resource \
--resource-arn arn:aws:workmail:us-west-2:111122223333:organization/m-n1pq2345678r901st2u3vx45x6789yza \
--tags "Key=priority,Value=1"
```
Este comando no genera ninguna salida.
Para obtener más información, consulte [Tagging an Organization](https://docs.aws.amazon.com/workmail/latest/adminguide/org-tag.html) en la *Guía del administrador de Amazon WorkMail*.
+ Para ver los detalles de la API, consulte [TagResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/workmail/tag-resource.html) en la *Referencia de comandos de la AWS CLI*.
### `untag-resource`
En el siguiente ejemplo de código, se muestra cómo utilizar `untag-resource`.
**AWS CLI**
**Para retirar la etiqueta de un recurso**
En el siguiente ejemplo de `untag-resource`, se rechaza la etiqueta especificada de la organización de Amazon WorkMail indicada.
```
aws workmail untag-resource \
--resource-arn arn:aws:workmail:us-west-2:111122223333:organization/m-n1pq2345678r901st2u3vx45x6789yza \
--tag-keys "priority"
```
Este comando no genera ninguna salida.
Para obtener más información, consulte [Tagging an Organization](https://docs.aws.amazon.com/workmail/latest/adminguide/org-tag.html) en la *Guía del administrador de Amazon WorkMail*.
+ Para ver los detalles de la API, consulte [UntagResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/workmail/untag-resource.html) en la *Referencia de comandos de la AWS CLI*.
### `update-mailbox-quota`
En el siguiente ejemplo de código, se muestra cómo utilizar `update-mailbox-quota`.
**AWS CLI**
**Para actualizar la cuota de buzón de correo de un usuario**
El siguiente comando `update-mailbox-quota` cambia la cuota de buzón de correo del usuario 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 no genera ninguna salida.
Para obtener más información, consulte [Managing User Accounts](https://docs.aws.amazon.com/workmail/latest/adminguide/manage-users.html) en la *Guía del administrador de Amazon WorkMail*.
+ Para obtener información acerca de la API, consulte [UpdateMailboxQuota](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/workmail/update-mailbox-quota.html) en la *Referencia de comandos de la AWS CLI*.
### `update-primary-email-address`
En el siguiente ejemplo de código, se muestra cómo utilizar `update-primary-email-address`.
**AWS CLI**
**Para actualizar una dirección de correo electrónico principal**
El siguiente comando `update-primary-email-address` actualiza la dirección de correo electrónico principal de la entidad especificada (usuario, grupo o 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 no genera ninguna salida.
+ Para obtener información sobre la API, consulte [UpdatePrimaryEmailAddress](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/workmail/update-primary-email-address.html) en la *Referencia de comandos de la AWS CLI*.
### `update-resource`
En el siguiente ejemplo de código, se muestra cómo utilizar `update-resource`.
**AWS CLI**
**Para actualizar un recurso**
El siguiente comando `update-resource` actualiza el nombre del recurso especificado.
```
aws workmail update-resource \
--organization-id m-d281d0a2fd824be5b6cd3d3ce909fd27 \
--resource-id r-7afe0efbade843a58cdc10251fce992c \
--name exampleRoom2
```
Este comando no genera ninguna salida.
+ Para obtener información sobre la API, consulte [UpdateResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/workmail/update-resource.html) en la *Referencia de comandos de la AWS CLI*.