Hay más ejemplos de AWS SDK disponibles en el GitHub repositorio de [ejemplos de AWS Doc SDK](https://github.com/awsdocs/aws-doc-sdk-examples).
Las traducciones son generadas a través de traducción automática. En caso de conflicto entre la traducción y la version original de inglés, prevalecerá la version en inglés.
# WorkDocs ejemplos que utilizan AWS CLI
Los siguientes ejemplos de código muestran cómo realizar acciones e implementar escenarios comunes mediante el uso del AWS Command Line Interface with WorkDocs.
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
### `abort-document-version-upload`
En el siguiente ejemplo de código, se muestra cómo utilizar `abort-document-version-upload`.
**AWS CLI**
**Para detener la carga de una versión de documento**
En este ejemplo se detiene la carga de una versión de documento iniciada anteriormente.
Comando:
```
aws workdocs abort-document-version-upload --document-id feaba64d4efdf271c2521b60a2a44a8f057e84beaabbe22f01267313209835f2 --version-id 1536773972914-ddb67663e782e7ce8455ebc962217cf9f9e47b5a9a702e5c84dcccd417da9313
```
Salida:
```
None
```
+ Para obtener más información sobre la API, consulte [AbortDocumentVersionUpload](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/workdocs/abort-document-version-upload.html)la *Referencia de AWS CLI comandos*.
### `activate-user`
En el siguiente ejemplo de código, se muestra cómo utilizar `activate-user`.
**AWS CLI**
**Para activar un usuario**
En este ejemplo, se activa un usuario inactivo.
Comando:
```
aws workdocs activate-user --user-id "S-1-1-11-1111111111-2222222222-3333333333-3333&d-926726012c"
```
Salida:
```
{
"User": {
"Id": "S-1-1-11-1111111111-2222222222-3333333333-3333&d-926726012c",
"Username": "exampleUser",
"EmailAddress": "exampleUser@site.awsapps.com",
"GivenName": "Example",
"Surname": "User",
"OrganizationId": "d-926726012c",
"RootFolderId": "75f67c183aa1217409ac87576a45c03a5df5e6d8c51c35c01669970538e86cd0",
"RecycleBinFolderId": "642b7dd3e60b14204534f3df7b1959e01b5d170f8c2707f410e40a8149120a57",
"Status": "ACTIVE",
"Type": "MINIMALUSER",
"CreatedTimestamp": 1521226107.747,
"ModifiedTimestamp": 1525297406.462,
"Storage": {
"StorageUtilizedInBytes": 0,
"StorageRule": {
"StorageAllocatedInBytes": 0,
"StorageType": "QUOTA"
}
}
}
}
```
+ Para obtener más información sobre la API, consulte [ActivateUser](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/workdocs/activate-user.html)la *Referencia de AWS CLI comandos*.
### `add-resource-permissions`
En el siguiente ejemplo de código, se muestra cómo utilizar `add-resource-permissions`.
**AWS CLI**
**Para añadir permisos a un recurso**
En este ejemplo, se agregan permisos al recurso para las entidades principales especificadas.
Comando:
```
aws workdocs add-resource-permissions --resource-id d90d93c1fe44bad0c8471e973ebaab339090401a95e777cffa58e977d2983b65 --principals Id=anonymous,Type=ANONYMOUS,Role=VIEWER
```
Salida:
```
{
"ShareResults": [
{
"PrincipalId": "anonymous",
"Role": "VIEWER",
"Status": "SUCCESS",
"ShareId": "d90d93c1fe44bad0c8471e973ebaab339090401a95e777cffa58e977d2983b65",
"StatusMessage": ""
}
]
}
```
+ Para obtener más información sobre la API, consulte [AddResourcePermissions](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/workdocs/add-resource-permissions.html)la *Referencia de AWS CLI comandos*.
### `create-comment`
En el siguiente ejemplo de código, se muestra cómo utilizar `create-comment`.
**AWS CLI**
**Para agregar un comentario nuevo**
En este ejemplo, se agrega un nuevo comentario a la versión del documento especificada.
Comando:
```
aws workdocs create-comment --document-id 15df51e0335cfcc6a2e4de9dd8be9f22ee40545ad9176f54758dcf903be982d3 --version-id 1521672507741-9f7df0ea5dd0b121c4f3564a0c7c0b4da95cd12c635d3c442af337a88e297920 --text "This is a comment."
```
Salida:
```
{
"Comment": {
"CommentId": "1534799058197-c7f5c84de9115875bbca93e0367bbebac609541d461636b760849b88b1609dd5",
"ThreadId": "1534799058197-c7f5c84de9115875bbca93e0367bbebac609541d461636b760849b88b1609dd5",
"Text": "This is a comment.",
"Contributor": {
"Id": "arn:aws:iam::123456789123:user/exampleUser",
"Username": "exampleUser",
"GivenName": "Example",
"Surname": "User",
"Status": "ACTIVE"
},
"CreatedTimestamp": 1534799058.197,
"Status": "PUBLISHED",
"Visibility": "PUBLIC"
}
}
```
+ Para obtener más información sobre la API, consulte [CreateComment](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/workdocs/create-comment.html)la *Referencia de AWS CLI comandos*.
### `create-custom-metadata`
En el siguiente ejemplo de código, se muestra cómo utilizar `create-custom-metadata`.
**AWS CLI**
**Para crear metadatos personalizados**
En este ejemplo, se crean metadatos personalizados para el documento especificado.
Comando:
```
aws workdocs create-custom-metadata --resource-id d90d93c1fe44bad0c8471e973ebaab339090401a95e777cffa58e977d2983b65 --custom-metadata KeyName1=example,KeyName2=example2
```
Salida:
```
None
```
+ Para obtener más información sobre la API, consulte [CreateCustomMetadata](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/workdocs/create-custom-metadata.html)la *Referencia de AWS CLI comandos*.
### `create-folder`
En el siguiente ejemplo de código, se muestra cómo utilizar `create-folder`.
**AWS CLI**
**Para crear una carpeta**
En este ejemplo, se crea una carpeta.
Comando:
```
aws workdocs create-folder --name documents --parent-folder-id 1ece93e5fe75315c7407c4967918b4fd9da87ddb2a588e67b7fdaf4a98fde678
```
Salida:
```
{
"Metadata": {
"Id": "50893c0af679524d1a0e0651130ed6d073e1a05f95bd12c42dcde5d35634ed08",
"Name": "documents",
"CreatorId": "S-1-1-11-1111111111-2222222222-3333333333-3333&d-926726012c",
"ParentFolderId": "1ece93e5fe75315c7407c4967918b4fd9da87ddb2a588e67b7fdaf4a98fde678",
"CreatedTimestamp": 1534450467.622,
"ModifiedTimestamp": 1534450467.622,
"ResourceState": "ACTIVE",
"Signature": "",
"Size": 0,
"LatestVersionSize": 0
}
}
```
+ Para obtener más información sobre la API, consulte [CreateFolder](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/workdocs/create-folder.html)la *Referencia de AWS CLI comandos*.
### `create-labels`
En el siguiente ejemplo de código, se muestra cómo utilizar `create-labels`.
**AWS CLI**
**Para crear etiquetas**
En este ejemplo, se crea una serie de etiquetas para un documento.
Comando:
```
aws workdocs create-labels --resource-id d90d93c1fe44bad0c8471e973ebaab339090401a95e777cffa58e977d2983b65 --labels "documents" "examples" "my_documents"
```
Salida:
```
None
```
+ Para obtener más información sobre la API, consulte [CreateLabels](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/workdocs/create-labels.html)la *Referencia de AWS CLI comandos*.
### `create-notification-subscription`
En el siguiente ejemplo de código, se muestra cómo utilizar `create-notification-subscription`.
**AWS CLI**
**Para crear una suscripción de notificaciones**
El siguiente `create-notification-subscription` ejemplo configura una suscripción de notificaciones para la WorkDocs organización de Amazon especificada.
```
aws workdocs create-notification-subscription \
--organization-id d-123456789c \
--protocol HTTPS \
--subscription-type ALL \
--notification-endpoint "https://example.com/example"
```
Salida:
```
{
"Subscription": {
"SubscriptionId": "123ab4c5-678d-901e-f23g-45h6789j0123",
"EndPoint": "https://example.com/example",
"Protocol": "HTTPS"
}
}
```
Para obtener más información, consulta [Suscríbete a las notificaciones](https://docs.aws.amazon.com/workdocs/latest/developerguide/subscribe-notifications.html) en la *Guía para WorkDocs desarrolladores de Amazon*.
+ Para obtener más información sobre la API, consulte [CreateNotificationSubscription](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/workdocs/create-notification-subscription.html)la *Referencia de AWS CLI comandos*.
### `create-user`
En el siguiente ejemplo de código, se muestra cómo utilizar `create-user`.
**AWS CLI**
**Para crear un nuevo usuario**
En este ejemplo, se crea un nuevo usuario en un directorio de Simple AD o de Microsoft AD.
Comando:
```
aws workdocs create-user --organization-id d-926726012c --username exampleUser2 --email-address exampleUser2@site.awsapps.com --given-name example2Name --surname example2Surname --password examplePa$$w0rd
```
Salida:
```
{
"User": {
"Id": "S-1-1-11-1111111111-2222222222-3333333333-3333&d-926726012c",
"Username": "exampleUser2",
"EmailAddress": "exampleUser2@site.awsapps.com",
"GivenName": "example2Name",
"Surname": "example2Surname",
"OrganizationId": "d-926726012c",
"RootFolderId": "35b886cb17198cbd547655e58b025dff0cf34aaed638be52009567e23dc67390",
"RecycleBinFolderId": "9858c3e9ed4c2460dde9aadb4c69fde998070dd46e5e985bd08ec6169ea249ff",
"Status": "ACTIVE",
"Type": "MINIMALUSER",
"CreatedTimestamp": 1535478836.584,
"ModifiedTimestamp": 1535478836.584,
"Storage": {
"StorageUtilizedInBytes": 0,
"StorageRule": {
"StorageAllocatedInBytes": 0,
"StorageType": "QUOTA"
}
}
}
}
```
+ Para obtener más información sobre la API, consulte [CreateUser](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/workdocs/create-user.html)la *Referencia de AWS CLI comandos*.
### `deactivate-user`
En el siguiente ejemplo de código, se muestra cómo utilizar `deactivate-user`.
**AWS CLI**
**Para desactivar un usuario**
En este ejemplo, se desactiva un usuario activo.
Comando:
```
aws workdocs deactivate-user --user-id "S-1-1-11-1111111111-2222222222-3333333333-3333&d-926726012c"
```
Salida:
```
None
```
+ Para obtener más información sobre la API, consulte [DeactivateUser](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/workdocs/deactivate-user.html)la *Referencia de AWS CLI comandos*.
### `delete-comment`
En el siguiente ejemplo de código, se muestra cómo utilizar `delete-comment`.
**AWS CLI**
**Para eliminar un comentario específico de la versión de un documento**
En este ejemplo, se elimina el comentario especificado de la versión del documento indicada.
Comando:
```
aws workdocs delete-comment --document-id 15df51e0335cfcc6a2e4de9dd8be9f22ee40545ad9176f54758dcf903be982d3 --version-id 1521672507741-9f7df0ea5dd0b121c4f3564a0c7c0b4da95cd12c635d3c442af337a88e297920 --comment-id 1534799058197-c7f5c84de9115875bbca93e0367bbebac609541d461636b760849b88b1609dd5
```
Salida:
```
None
```
+ Para obtener más información sobre la API, consulte [DeleteComment](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/workdocs/delete-comment.html)la *Referencia de AWS CLI comandos*.
### `delete-custom-metadata`
En el siguiente ejemplo de código, se muestra cómo utilizar `delete-custom-metadata`.
**AWS CLI**
**Para eliminar los metadatos personalizados de un recurso**
En este ejemplo, se eliminan todos los metadatos personalizados del recurso especificado.
Comando:
```
aws workdocs delete-custom-metadata --resource-id d90d93c1fe44bad0c8471e973ebaab339090401a95e777cffa58e977d2983b65 --delete-all
```
Salida:
```
None
```
+ Para obtener más información sobre la API, consulte [DeleteCustomMetadata](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/workdocs/delete-custom-metadata.html)la *Referencia de AWS CLI comandos*.
### `delete-document`
En el siguiente ejemplo de código, se muestra cómo utilizar `delete-document`.
**AWS CLI**
**Eliminación de un documento**
En este ejemplo, se elimina el documento especificado.
Comando:
```
aws workdocs delete-document --document-id b83ed5e5b167b65ef69de9d597627ff1a0d4f07a45e67f1fab7d26b54427de0a
```
Salida:
```
None
```
+ Para obtener más información sobre la API, consulte [DeleteDocument](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/workdocs/delete-document.html)la *Referencia de AWS CLI comandos*.
### `delete-folder-contents`
En el siguiente ejemplo de código, se muestra cómo utilizar `delete-folder-contents`.
**AWS CLI**
**Para eliminar el contenido de una carpeta**
En este ejemplo, se elimina el contenido de la carpeta especificada.
Comando:
```
aws workdocs delete-folder-contents --folder-id 26fa8aa4ba2071447c194f7b150b07149dbdb9e1c8a301872dcd93a4735ce65d
```
Salida:
```
None
```
+ Para obtener más información sobre la API, consulte [DeleteFolderContents](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/workdocs/delete-folder-contents.html)la *Referencia de AWS CLI comandos*.
### `delete-folder`
En el siguiente ejemplo de código, se muestra cómo utilizar `delete-folder`.
**AWS CLI**
**Para eliminar una carpeta**
En este ejemplo, se elimina la carpeta especificada.
Comando:
```
aws workdocs delete-folder --folder-id 26fa8aa4ba2071447c194f7b150b07149dbdb9e1c8a301872dcd93a4735ce65d
```
Salida:
```
None
```
+ Para obtener más información sobre la API, consulte [DeleteFolder](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/workdocs/delete-folder.html)la *Referencia de AWS CLI comandos*.
### `delete-labels`
En el siguiente ejemplo de código, se muestra cómo utilizar `delete-labels`.
**AWS CLI**
**Para eliminar etiquetas**
En este ejemplo, se eliminan las etiquetas especificadas de un documento.
Comando:
```
aws workdocs delete-labels --resource-id d90d93c1fe44bad0c8471e973ebaab339090401a95e777cffa58e977d2983b65 --labels "documents" "examples"
```
Salida:
```
None
```
+ Para obtener más información sobre la API, consulte [DeleteLabels](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/workdocs/delete-labels.html)la *Referencia de AWS CLI comandos*.
### `delete-notification-subscription`
En el siguiente ejemplo de código, se muestra cómo utilizar `delete-notification-subscription`.
**AWS CLI**
**Para eliminar una suscripción a notificaciones**
En el siguiente ejemplo de `delete-notification-subscription`, se elimina la suscripción a las notificaciones especificada.
```
aws workdocs delete-notification-subscription \
--subscription-id 123ab4c5-678d-901e-f23g-45h6789j0123 \
--organization-id d-123456789c
```
Este comando no genera ninguna salida.
Para obtener más información, consulta [Suscríbete a las notificaciones](https://docs.aws.amazon.com/workdocs/latest/developerguide/subscribe-notifications.html) en la *Guía para WorkDocs desarrolladores de Amazon*.
+ Para obtener más información sobre la API, consulte [DeleteNotificationSubscription](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/workdocs/delete-notification-subscription.html)la *Referencia de AWS CLI comandos*.
### `delete-user`
En el siguiente ejemplo de código, se muestra cómo utilizar `delete-user`.
**AWS CLI**
**Para eliminar un usuario**
En este ejemplo se elimina un usuario.
Comando:
```
aws workdocs delete-user --user-id "S-1-1-11-1111111111-2222222222-3333333333-3333&d-926726012c"
```
Salida:
```
None
```
+ Para obtener más información sobre la API, consulte [DeleteUser](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/workdocs/delete-user.html)la *Referencia de AWS CLI comandos*.
### `describe-activities`
En el siguiente ejemplo de código, se muestra cómo utilizar `describe-activities`.
**AWS CLI**
**Para obtener una lista de las actividades de los usuarios**
En este ejemplo, se devuelve una lista de las últimas actividades de los usuarios de la organización especificada, con un límite establecido a las dos últimas actividades.
Comando:
```
aws workdocs describe-activities --organization-id d-926726012c --limit 2
```
Salida:
```
{
"UserActivities": [
{
"Type": "DOCUMENT_VERSION_DOWNLOADED",
"TimeStamp": 1534800122.17,
"Initiator": {
"Id": "arn:aws:iam::123456789123:user/exampleUser"
},
"ResourceMetadata": {
"Type": "document",
"Name": "updatedDoc",
"Id": "15df51e0335cfcc6a2e4de9dd8be9f22ee40545ad9176f54758dcf903be982d3",
"Owner": {
"Id": "S-1-1-11-1111111111-2222222222-3333333333-3333&d-926726012c",
"GivenName": "exampleName",
"Surname": "exampleSurname"
}
}
},
{
"Type": "DOCUMENT_VERSION_VIEWED",
"TimeStamp": 1534799079.207,
"Initiator": {
"Id": "S-1-1-11-1111111111-2222222222-3333333333-3333&d-926726012c",
"GivenName": "exampleName",
"Surname": "exampleSurname"
},
"ResourceMetadata": {
"Type": "document",
"Name": "updatedDoc",
"Id": "15df51e0335cfcc6a2e4de9dd8be9f22ee40545ad9176f54758dcf903be982d3",
"Owner": {
"Id": "S-1-1-11-1111111111-2222222222-3333333333-3333&d-926726012c",
"GivenName": "exampleName",
"Surname": "exampleSurname"
}
}
}
],
"Marker": "DnF1ZXJ5VGhlbkZldGNoAgAAAAAAAAS7FmlTaU1OdlFTU1h1UU00VVFIbDlRWHcAAAAAAAAJTRY3bWh5eUgzaVF1ZXN2RUE5Wm8tTTdR"
}
```
+ Para obtener más información sobre la API, consulte [DescribeActivities](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/workdocs/describe-activities.html)la *Referencia de AWS CLI comandos*.
### `describe-comments`
En el siguiente ejemplo de código, se muestra cómo utilizar `describe-comments`.
**AWS CLI**
**Para obtener una lista de todos los comentarios de la versión del documento especificada**
En este ejemplo, se enumeran todos los comentarios de la versión del documento especificada.
Comando:
```
aws workdocs describe-comments --document-id 15df51e0335cfcc6a2e4de9dd8be9f22ee40545ad9176f54758dcf903be982d3 --version-id 1521672507741-9f7df0ea5dd0b121c4f3564a0c7c0b4da95cd12c635d3c442af337a88e297920
```
Salida:
```
{
"Comments": [
{
"CommentId": "1534799058197-c7f5c84de9115875bbca93e0367bbebac609541d461636b760849b88b1609dd5",
"ThreadId": "1534799058197-c7f5c84de9115875bbca93e0367bbebac609541d461636b760849b88b1609dd5",
"Text": "This is a comment.",
"Contributor": {
"Username": "arn:aws:iam::123456789123:user/exampleUser",
"Type": "USER"
},
"CreatedTimestamp": 1534799058.197,
"Status": "PUBLISHED",
"Visibility": "PUBLIC"
}
]
}
```
+ Para obtener más información sobre la API, consulte [DescribeComments](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/workdocs/describe-comments.html)la *Referencia de AWS CLI comandos*.
### `describe-document-versions`
En el siguiente ejemplo de código, se muestra cómo utilizar `describe-document-versions`.
**AWS CLI**
**Para recuperar las versiones de un documento**
En este ejemplo, se recuperan las versiones del documento especificado, incluidas las versiones inicializadas y una URL del documento de origen.
Comando:
```
aws workdocs describe-document-versions --document-id d90d93c1fe44bad0c8471e973ebaab339090401a95e777cffa58e977d2983b65 --fields SOURCE
```
Salida:
```
{
"DocumentVersions": [
{
"Id": "1534452029587-15e129dfc187505c407588df255be83de2920d733859f1d2762411d22a83e3ef",
"Name": "exampleDoc.docx",
"ContentType": "application/vnd.openxmlformats-officedocument.wordprocessingml.document",
"Size": 13922,
"Signature": "1a23456b78901c23d4ef56gh7EXAMPLE",
"Status": "ACTIVE",
"CreatedTimestamp": 1534452029.587,
"ModifiedTimestamp": 1534452029.849,
"CreatorId": "S-1-1-11-1111111111-2222222222-3333333333-3333&d-926726012c",
"Source": {
"ORIGINAL": "https://gb-us-west-2-prod-doc-source.s3.us-west-2.amazonaws.com/d90d93c1fe44bad0c8471e973ebaab339090401a95e777cffa58e977d2983b65/1534452029587-15e129dfc187505c407588df255be83de2920d733859f1d2762411d22a83e3ef?response-content-disposition=attachment%3B%20filename%2A%3DUTF-8%27%27exampleDoc29.docx&X-Amz-Algorithm=AWS1-ABCD-EFG234&X-Amz-Date=20180816T204149Z&X-Amz-SignedHeaders=host&X-Amz-Expires=900&X-Amz-Credential=AKIAIOSFODNN7EXAMPLE%2F20180816%2Fus-west-2%2Fs3%2Faws1_request&X-Amz-Signature=01Ab2c34d567e8f90123g456hi78j901k2345678l901234mno56pqr78EXAMPLE"
}
},
{
"Id": "1529005196082-bb75fa19abc287699cb07147f75816dce43a53a10f28dc001bf61ef2fab01c59",
"Name": "exampleDoc.pdf",
"ContentType": "application/pdf",
"Size": 425916,
"Signature": "1a23456b78901c23d4ef56gh7EXAMPLE",
"Status": "ACTIVE",
"CreatedTimestamp": 1529005196.082,
"ModifiedTimestamp": 1529005196.796,
"CreatorId": "S-1-1-11-1111111111-2222222222-3333333333-3333&d-926726012c",
"Source": {
"ORIGINAL": "https://gb-us-west-2-prod-doc-source.s3.us-west-2.amazonaws.com/d90d93c1fe44bad0c8471e973ebaab339090401a95e777cffa58e977d2983b65/1529005196082-bb75fa19abc287699cb07147f75816dce43a53a10f28dc001bf61ef2fab01c59?response-content-disposition=attachment%3B%20filename%2A%3DUTF-8%27%27exampleDoc29.pdf&X-Amz-Algorithm=AWS1-ABCD-EFG234&X-Amz-Date=20180816T204149Z&X-Amz-SignedHeaders=host&X-Amz-Expires=900&X-Amz-Credential=AKIAIOSFODNN7EXAMPLE%2F20180816%2Fus-west-2%2Fs3%2Faws1_request&X-Amz-Signature=01Ab2c34d567e8f90123g456hi78j901k2345678l901234mno56pqr78EXAMPLE"
}
}
]
}
```
+ Para obtener más información sobre la API, consulte [DescribeDocumentVersions](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/workdocs/describe-document-versions.html)la *Referencia de AWS CLI comandos*.
### `describe-folder-contents`
En el siguiente ejemplo de código, se muestra cómo utilizar `describe-folder-contents`.
**AWS CLI**
**Para describir el contenido de una carpeta**
En este ejemplo, se describe todo el contenido activo de la carpeta especificada, incluidos sus documentos y subcarpetas, ordenados por fecha en orden ascendente.
Comando:
```
aws workdocs describe-folder-contents --folder-id 1ece93e5fe75315c7407c4967918b4fd9da87ddb2a588e67b7fdaf4a98fde678 --sort DATE --order ASCENDING --type ALL
```
Salida:
```
{
"Folders": [
{
"Id": "50893c0af679524d1a0e0651130ed6d073e1a05f95bd12c42dcde5d35634ed08",
"Name": "testing",
"CreatorId": "S-1-1-11-1111111111-2222222222-3333333333-3333&d-926726012c",
"ParentFolderId": "1ece93e5fe75315c7407c4967918b4fd9da87ddb2a588e67b7fdaf4a98fde678",
"CreatedTimestamp": 1534450467.622,
"ModifiedTimestamp": 1534451113.504,
"ResourceState": "ACTIVE",
"Signature": "1a23456b78901c23d4ef56gh7EXAMPLE",
"Size": 23019,
"LatestVersionSize": 11537
}
],
"Documents": [
{
"Id": "d90d93c1fe44bad0c8471e973ebaab339090401a95e777cffa58e977d2983b65",
"CreatorId": "S-1-1-11-1111111111-2222222222-3333333333-3333&d-926726012c",
"ParentFolderId": "1ece93e5fe75315c7407c4967918b4fd9da87ddb2a588e67b7fdaf4a98fde678",
"CreatedTimestamp": 1529005196.082,
"ModifiedTimestamp": 1534452483.01,
"LatestVersionMetadata": {
"Id": "1534452029587-15e129dfc187505c407588df255be83de2920d733859f1d2762411d22a83e3ef",
"Name": "exampleDoc.docx",
"ContentType": "application/vnd.openxmlformats-officedocument.wordprocessingml.document",
"Size": 13922,
"Signature": "1a23456b78901c23d4ef56gh7EXAMPLE",
"Status": "ACTIVE",
"CreatedTimestamp": 1534452029.587,
"ModifiedTimestamp": 1534452029.587,
"CreatorId": "S-1-1-11-1111111111-2222222222-3333333333-3333&d-926726012c"
},
"ResourceState": "ACTIVE"
}
]
}
```
+ Para obtener más información sobre la API, consulte [DescribeFolderContents](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/workdocs/describe-folder-contents.html)la *Referencia de AWS CLI comandos*.
### `describe-groups`
En el siguiente ejemplo de código, se muestra cómo utilizar `describe-groups`.
**AWS CLI**
**Para recuperar una lista de grupos**
El siguiente `describe-groups` ejemplo muestra los grupos asociados a la WorkDocs organización de Amazon especificada.
```
aws workdocs describe-groups \
--search-query "e" \
--organization-id d-123456789c
```
Salida:
```
{
"Groups": [
{
"Id": "S-1-1-11-1122222222-2222233333-3333334444-4444&d-123456789c",
"Name": "Example Group 1"
},
{
"Id": "S-1-1-11-1122222222-2222233333-3333334444-5555&d-123456789c",
"Name": "Example Group 2"
}
]
}
```
Para obtener más información, consulta [Cómo empezar con Amazon WorkDocs](https://docs.aws.amazon.com/workdocs/latest/adminguide/getting_started.html) en la *Guía de WorkDocs administración de Amazon*.
+ Para obtener más información sobre la API, consulte [DescribeGroups](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/workdocs/describe-groups.html)la *Referencia de AWS CLI comandos*.
### `describe-notification-subscriptions`
En el siguiente ejemplo de código, se muestra cómo utilizar `describe-notification-subscriptions`.
**AWS CLI**
**Para recuperar una lista de suscripciones de notificaciones**
En el siguiente `describe-notification-subscriptions` ejemplo, se recuperan las suscripciones de notificaciones de la WorkDocs organización de Amazon especificada.
```
aws workdocs describe-notification-subscriptions \
--organization-id d-123456789c
```
Salida:
```
{
"Subscriptions": [
{
"SubscriptionId": "123ab4c5-678d-901e-f23g-45h6789j0123",
"EndPoint": "https://example.com/example",
"Protocol": "HTTPS"
}
]
}
```
Para obtener más información, consulta [Suscríbete a las notificaciones](https://docs.aws.amazon.com/workdocs/latest/developerguide/subscribe-notifications.html) en la *Guía para WorkDocs desarrolladores de Amazon*.
+ Para obtener más información sobre la API, consulte [DescribeNotificationSubscriptions](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/workdocs/describe-notification-subscriptions.html)la *Referencia de AWS CLI comandos*.
### `describe-resource-permissions`
En el siguiente ejemplo de código, se muestra cómo utilizar `describe-resource-permissions`.
**AWS CLI**
**Para obtener una lista de permisos para un recurso**
En este ejemplo, se devuelve una lista de los permisos del recurso (documento o carpeta) especificado.
Comando:
```
aws workdocs describe-resource-permissions --resource-id 15df51e0335cfcc6a2e4de9dd8be9f22ee40545ad9176f54758dcf903be982d3
```
Salida:
```
{
"Principals": [
{
"Id": "anonymous",
"Type": "ANONYMOUS",
"Roles": [
{
"Role": "VIEWER",
"Type": "DIRECT"
}
]
},
{
"Id": "S-1-1-11-1111111111-2222222222-3333333333-3333&d-926726012c",
"Type": "USER",
"Roles": [
{
"Role": "OWNER",
"Type": "DIRECT"
}
]
},
{
"Id": "d-926726012c",
"Type": "ORGANIZATION",
"Roles": [
{
"Role": "VIEWER",
"Type": "INHERITED"
}
]
}
]
}
```
+ Para obtener más información sobre la API, consulte [DescribeResourcePermissions](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/workdocs/describe-resource-permissions.html)la *Referencia de AWS CLI comandos*.
### `describe-users`
En el siguiente ejemplo de código, se muestra cómo utilizar `describe-users`.
**AWS CLI**
**Para recuperar los detalles de los usuarios especificados**
En este ejemplo, se recuperan los detalles de todos los usuarios de la organización especificada.
Comando:
```
aws workdocs describe-users --organization-id d-926726012c
```
Salida:
```
{
"Users": [
{
"Id": "S-1-1-11-1111111111-2222222222-3333333333-3333&d-926726012c",
"Username": "example1User",
"OrganizationId": "d-926726012c",
"RootFolderId": "3c0e3f849dd20a9771d937b9bbcc97e18796150ae56c26d64a4fa0320a2dedc9",
"RecycleBinFolderId": "c277f4c4d647be1f5147b3184ffa96e1e2bf708278b696cacba68ba13b91f4fe",
"Status": "INACTIVE",
"Type": "USER",
"CreatedTimestamp": 1535478999.452,
"ModifiedTimestamp": 1535478999.452
},
{
"Id": "S-1-1-11-1111111111-2222222222-3333333333-4444&d-926726012c",
"Username": "example2User",
"EmailAddress": "example2User@site.awsapps.com",
"GivenName": "example2Name",
"Surname": "example2Surname",
"OrganizationId": "d-926726012c",
"RootFolderId": "35b886cb17198cbd547655e58b025dff0cf34aaed638be52009567e23dc67390",
"RecycleBinFolderId": "9858c3e9ed4c2460dde9aadb4c69fde998070dd46e5e985bd08ec6169ea249ff",
"Status": "ACTIVE",
"Type": "MINIMALUSER",
"CreatedTimestamp": 1535478836.584,
"ModifiedTimestamp": 1535478836.584
}
]
}
```
+ Para obtener más información sobre la API, consulte [DescribeUsers](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/workdocs/describe-users.html)la *Referencia de AWS CLI comandos*.
### `get-document-path`
En el siguiente ejemplo de código, se muestra cómo utilizar `get-document-path`.
**AWS CLI**
**Para recuperar la información de la ruta de un documento**
En este ejemplo, se recupera la información de ruta (jerarquía de la carpeta raíz) del documento especificado e incluye los nombres de las carpetas principales.
Comando:
```
aws workdocs get-document-path --document-id d90d93c1fe44bad0c8471e973ebaab339090401a95e777cffa58e977d2983b65 --fields NAME
```
Salida:
```
{
"Path": {
"Components": [
{
"Id": "a43d29cbb8e7c4d25cfee8b803a504b0dc63e760b55ad0c611c6b87691eb6ff3",
"Name": "/"
},
{
"Id": "1ece93e5fe75315c7407c4967918b4fd9da87ddb2a588e67b7fdaf4a98fde678",
"Name": "Top Level Folder"
},
{
"Id": "d90d93c1fe44bad0c8471e973ebaab339090401a95e777cffa58e977d2983b65",
"Name": "exampleDoc.docx"
}
]
}
}
```
+ Para obtener más información sobre la API, consulte [GetDocumentPath](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/workdocs/get-document-path.html)la *Referencia de AWS CLI comandos*.
### `get-document-version`
En el siguiente ejemplo de código, se muestra cómo utilizar `get-document-version`.
**AWS CLI**
**Para recuperar los metadatos de la versión del documento especificado**
En este ejemplo, se recuperan los metadatos de la versión del documento especificado, incluida la URL de origen y los metadatos personalizados.
Comando:
```
aws workdocs get-document-version --document-id 15df51e0335cfcc6a2e4de9dd8be9f22ee40545ad9176f54758dcf903be982d3 --version-id 1521672507741-9f7df0ea5dd0b121c4f3564a0c7c0b4da95cd12c635d3c442af337a88e297920 --fields SOURCE --include-custom-metadata
```
Salida:
```
{
"Metadata": {
"Id": "1521672507741-9f7df0ea5dd0b121c4f3564a0c7c0b4da95cd12c635d3c442af337a88e297920",
"Name": "exampleDoc",
"ContentType": "application/vnd.openxmlformats-officedocument.wordprocessingml.document",
"Size": 11537,
"Signature": "1a23456b78901c23d4ef56gh7EXAMPLE",
"Status": "ACTIVE",
"CreatedTimestamp": 1521672507.741,
"ModifiedTimestamp": 1534451113.504,
"CreatorId": "S-1-1-11-1111111111-2222222222-3333333333-3333&d-926726012c",
"Source": {
"ORIGINAL": "https://gb-us-west-2-prod-doc-source.s3.us-west-2.amazonaws.com/15df51e0335cfcc6a2e4de9dd8be9f22ee40545ad9176f54758dcf903be982d3/1521672507741-9f7df0ea5dd0b121c4f3564a0c7c0b4da95cd12c635d3c442af337a88e297920?response-content-disposition=attachment%3B%20filename%2A%3DUTF-8%27%27exampleDoc&X-Amz-Algorithm=AWS1-ABCD-EFG234&X-Amz-Date=20180820T212202Z&X-Amz-SignedHeaders=host&X-Amz-Expires=900&X-Amz-Credential=AKIAIOSFODNN7EXAMPLE%2F20180820%2Fus-west-2%2Fs3%2Faws1_request&X-Amz-Signature=01Ab2c34d567e8f90123g456hi78j901k2345678l901234mno56pqr78EXAMPLE"
}
}
}
```
+ Para obtener más información sobre la API, consulte [GetDocumentVersion](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/workdocs/get-document-version.html)la *Referencia de AWS CLI comandos*.
### `get-document`
En el siguiente ejemplo de código, se muestra cómo utilizar `get-document`.
**AWS CLI**
**Para recuperar los detalles del documento**
En este ejemplo, se recuperan los detalles del documento especificado.
Comando:
```
aws workdocs get-document --document-id d90d93c1fe44bad0c8471e973ebaab339090401a95e777cffa58e977d2983b65
```
Salida:
```
{
"Metadata": {
"Id": "d90d93c1fe44bad0c8471e973ebaab339090401a95e777cffa58e977d2983b65",
"CreatorId": "S-1-1-11-1111111111-2222222222-3333333333-3333&d-926726012c",
"ParentFolderId": "1ece93e5fe75315c7407c4967918b4fd9da87ddb2a588e67b7fdaf4a98fde678",
"CreatedTimestamp": 1529005196.082,
"ModifiedTimestamp": 1534452483.01,
"LatestVersionMetadata": {
"Id": "1534452029587-15e129dfc187505c407588df255be83de2920d733859f1d2762411d22a83e3ef",
"Name": "exampleDoc.docx",
"ContentType": "application/vnd.openxmlformats-officedocument.wordprocessingml.document",
"Size": 13922,
"Signature": "1a23456b78901c23d4ef56gh7EXAMPLE",
"Status": "ACTIVE",
"CreatedTimestamp": 1534452029.587,
"ModifiedTimestamp": 1534452029.587,
"CreatorId": "S-1-1-11-1111111111-2222222222-3333333333-3333&d-926726012c"
},
"ResourceState": "ACTIVE"
}
}
```
+ Para obtener más información sobre la API, consulte [GetDocument](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/workdocs/get-document.html)la *Referencia de AWS CLI comandos*.
### `get-folder-path`
En el siguiente ejemplo de código, se muestra cómo utilizar `get-folder-path`.
**AWS CLI**
**Para recuperar la información de la ruta de una carpeta**
En este ejemplo, se recupera la información de ruta (jerarquía de la carpeta raíz) de la carpeta especificada e incluye los nombres de las carpetas principales.
Comando:
```
aws workdocs get-folder-path --folder-id 50893c0af679524d1a0e0651130ed6d073e1a05f95bd12c42dcde5d35634ed08 --fields NAME
```
Salida:
```
{
"Path": {
"Components": [
{
"Id": "a43d29cbb8e7c4d25cfee8b803a504b0dc63e760b55ad0c611c6b87691eb6ff3",
"Name": "/"
},
{
"Id": "1ece93e5fe75315c7407c4967918b4fd9da87ddb2a588e67b7fdaf4a98fde678",
"Name": "Top Level Folder"
},
{
"Id": "50893c0af679524d1a0e0651130ed6d073e1a05f95bd12c42dcde5d35634ed08",
"Name": "Sublevel Folder"
}
]
}
}
```
+ Para obtener más información sobre la API, consulte [GetFolderPath](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/workdocs/get-folder-path.html)la *Referencia de AWS CLI comandos*.
### `get-folder`
En el siguiente ejemplo de código, se muestra cómo utilizar `get-folder`.
**AWS CLI**
**Para recuperar los metadatos de una carpeta**
En este ejemplo, se recuperan los metadatos de la carpeta especificada.
Comando:
```
aws workdocs get-folder --folder-id 50893c0af679524d1a0e0651130ed6d073e1a05f95bd12c42dcde5d35634ed08
```
Salida:
```
{
"Metadata": {
"Id": "50893c0af679524d1a0e0651130ed6d073e1a05f95bd12c42dcde5d35634ed08",
"Name": "exampleFolder",
"CreatorId": "S-1-1-11-1111111111-2222222222-3333333333-3333&d-926726012c",
"ParentFolderId": "1ece93e5fe75315c7407c4967918b4fd9da87ddb2a588e67b7fdaf4a98fde678",
"CreatedTimestamp": 1534450467.622,
"ModifiedTimestamp": 1534451113.504,
"ResourceState": "ACTIVE",
"Signature": "1a23456b78901c23d4ef56gh7EXAMPLE",
"Size": 23019,
"LatestVersionSize": 11537
}
}
```
+ Para obtener más información sobre la API, consulte [GetFolder](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/workdocs/get-folder.html)la *Referencia de AWS CLI comandos*.
### `get-resources`
En el siguiente ejemplo de código, se muestra cómo utilizar `get-resources`.
**AWS CLI**
**Para recuperar los recursos compartidos**
El siguiente `get-resources` ejemplo recupera los recursos compartidos con el WorkDocs usuario de Amazon especificado.
```
aws workdocs get-resources \
--user-id "S-1-1-11-1111111111-2222222222-3333333333-3333" \
--collection-type SHARED_WITH_ME
```
Salida:
```
{
"Folders": [],
"Documents": []
}
```
Para obtener más información, consulta [Compartir archivos y carpetas](https://docs.aws.amazon.com/workdocs/latest/userguide/share-docs.html) en la *Guía del WorkDocs usuario de Amazon*.
+ Para obtener más información sobre la API, consulte [GetResources](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/workdocs/get-resources.html)la *Referencia de AWS CLI comandos*.
### `initiate-document-version-upload`
En el siguiente ejemplo de código, se muestra cómo utilizar `initiate-document-version-upload`.
**AWS CLI**
**Para iniciar la carga de una versión de un documento**
En el siguiente ejemplo de `initiate-document-upload`, se crea un nuevo objeto de documento y objeto de versión.
```
aws workdocs initiate-document-version-upload \
--name exampledocname \
--parent-folder-id eacd546d952531c633452ed67cac23161aa0d5df2e8061223a59e8f67e7b6189
```
Salida:
```
{
"Metadata": {
"Id": "feaba64d4efdf271c2521b60a2a44a8f057e84beaabbe22f01267313209835f2",
"CreatorId": "S-1-1-11-1111111111-2222222222-3333333333-3333&d-926726012c",
"ParentFolderId": "eacd546d952531c633452ed67cac23161aa0d5df2e8061223a59e8f67e7b6189",
"CreatedTimestamp": 1536773972.914,
"ModifiedTimestamp": 1536773972.914,
"LatestVersionMetadata": {
"Id": "1536773972914-ddb67663e782e7ce8455ebc962217cf9f9e47b5a9a702e5c84dcccd417da9313",
"Name": "exampledocname",
"ContentType": "application/octet-stream",
"Size": 0,
"Status": "INITIALIZED",
"CreatedTimestamp": 1536773972.914,
"ModifiedTimestamp": 1536773972.914,
"CreatorId": "arn:aws:iam::123456789123:user/EXAMPLE"
},
"ResourceState": "ACTIVE"
},
"UploadMetadata": {
"UploadUrl": "https://gb-us-west-2-prod-doc-source.s3.us-west-2.amazonaws.com/feaba64d4efdf271c2521b60a2a44a8f057e84beaabbe22f01267313209835f2/1536773972914-ddb67663e782e7ce8455ebc962217cf9f9e47b5a9a702e5c84dcccd417da9313?X-Amz-Algorithm=AWS1-ABCD-EFG234&X-Amz-Date=20180912T173932Z&X-Amz-SignedHeaders=content-type%3Bhost%3Bx-amz-server-side-encryption&X-Amz-Expires=899&X-Amz-Credential=AKIAIOSFODNN7EXAMPLE%2F20180912%2Fus-west-2%2Fs3%2Faws1_request&X-Amz-Signature=01Ab2c34d567e8f90123g456hi78j901k2345678l901234mno56pqr78EXAMPLE",
"SignedHeaders": {
"Content-Type": "application/octet-stream",
"x-amz-server-side-encryption": "ABC123"
}
}
}
```
+ Para obtener más información sobre la API, consulte [InitiateDocumentVersionUpload](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/workdocs/initiate-document-version-upload.html)la *Referencia de AWS CLI comandos*.
### `remove-all-resource-permissions`
En el siguiente ejemplo de código, se muestra cómo utilizar `remove-all-resource-permissions`.
**AWS CLI**
**Para eliminar todos los permisos de un recurso especificado**
En este ejemplo, se eliminan todos los permisos del recurso especificado.
Comando:
```
aws workdocs remove-all-resource-permissions --resource-id 1ece93e5fe75315c7407c4967918b4fd9da87ddb2a588e67b7fdaf4a98fde678
```
Salida:
```
None
```
+ Para obtener más información sobre la API, consulte [RemoveAllResourcePermissions](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/workdocs/remove-all-resource-permissions.html)la *Referencia de AWS CLI comandos*.
### `remove-resource-permission`
En el siguiente ejemplo de código, se muestra cómo utilizar `remove-resource-permission`.
**AWS CLI**
**Para retirar permisos de un recurso**
En este ejemplo, se eliminan todos los permisos del recurso de la entidad principal especificada.
Comando:
```
aws workdocs remove-resource-permission --resource-id 1ece93e5fe75315c7407c4967918b4fd9da87ddb2a588e67b7fdaf4a98fde678 --principal-id anonymous
```
Salida:
```
None
```
+ Para obtener más información sobre la API, consulte [RemoveResourcePermission](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/workdocs/remove-resource-permission.html)la *Referencia de AWS CLI comandos*.
### `update-document-version`
En el siguiente ejemplo de código, se muestra cómo utilizar `update-document-version`.
**AWS CLI**
**Para cambiar el estado de la versión de un documento a Active**
En este ejemplo, se cambia el estado de la versión del documento a ACTIVE.
Comando:
```
aws workdocs update-document-version --document-id 15df51e0335cfcc6a2e4de9dd8be9f22ee40545ad9176f54758dcf903be982d3 --version-id 1521672507741-9f7df0ea5dd0b121c4f3564a0c7c0b4da95cd12c635d3c442af337a88e297920 --version-status ACTIVE
```
Salida:
```
None
```
+ Para obtener más información sobre la API, consulte [UpdateDocumentVersion](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/workdocs/update-document-version.html)la *Referencia de AWS CLI comandos*.
### `update-document`
En el siguiente ejemplo de código, se muestra cómo utilizar `update-document`.
**AWS CLI**
**Para actualizar un documento**
En este ejemplo, se actualizan el nombre y la carpeta principal de un documento.
Comando:
```
aws workdocs update-document --document-id 15df51e0335cfcc6a2e4de9dd8be9f22ee40545ad9176f54758dcf903be982d3 --name updatedDoc --parent-folder-id 50893c0af679524d1a0e0651130ed6d073e1a05f95bd12c42dcde5d35634ed08
```
Salida:
```
None
```
+ Para obtener más información sobre la API, consulte [UpdateDocument](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/workdocs/update-document.html)la *Referencia de AWS CLI comandos*.
### `update-folder`
En el siguiente ejemplo de código, se muestra cómo utilizar `update-folder`.
**AWS CLI**
**Para actualizar una carpeta**
En este ejemplo, se actualiza la carpeta principal y el nombre de una carpeta.
Comando:
```
aws workdocs update-folder --folder-id 50893c0af679524d1a0e0651130ed6d073e1a05f95bd12c42dcde5d35634ed08 --name exampleFolder1 --parent-folder-id 1ece93e5fe75315c7407c4967918b4fd9da87ddb2a588e67b7fdaf4a98fde678
```
Salida:
```
None
```
+ Para obtener más información sobre la API, consulte [UpdateFolder](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/workdocs/update-folder.html)la *Referencia de AWS CLI comandos*.
### `update-user`
En el siguiente ejemplo de código, se muestra cómo utilizar `update-user`.
**AWS CLI**
**Para actualizar un usuario**
En este ejemplo, se actualiza la zona horaria del usuario especificado.
Comando:
```
aws workdocs update-user --user-id "S-1-1-11-1111111111-2222222222-3333333333-3333&d-926726012c" --time-zone-id "America/Los_Angeles"
```
Salida:
```
{
"User": {
"Id": "S-1-1-11-1111111111-2222222222-3333333333-3333&d-926726012c",
"Username": "exampleUser",
"EmailAddress": "exampleUser@site.awsapps.com",
"GivenName": "Example",
"Surname": "User",
"OrganizationId": "d-926726012c",
"RootFolderId": "c5eceb5e1a2d1d460c9d1af8330ae117fc8d39bb1d3ed6acd0992d5ff192d986",
"RecycleBinFolderId": "6ca20102926ad15f04b1d248d6d6e44f2449944eda5c758f9a1e9df6a6b7fa66",
"Status": "ACTIVE",
"Type": "USER",
"TimeZoneId": "America/Los_Angeles",
"Storage": {
"StorageUtilizedInBytes": 0,
"StorageRule": {
"StorageAllocatedInBytes": 53687091200,
"StorageType": "QUOTA"
}
}
}
}
```
+ Para obtener más información sobre la API, consulte [UpdateUser](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/workdocs/update-user.html)la *Referencia de AWS CLI comandos*.