Há mais exemplos de AWS SDK disponíveis no repositório AWS Doc SDK Examples
As traduções são geradas por tradução automática. Em caso de conflito entre o conteúdo da tradução e da versão original em inglês, a versão em inglês prevalecerá.
WorkDocs Exemplos da Amazon usando AWS CLI
Os exemplos de código a seguir mostram como realizar ações e implementar cenários comuns usando o AWS Command Line Interface com a Amazon WorkDocs.
Ações são trechos de código de programas maiores e devem ser executadas em contexto. Embora as ações mostrem como chamar perfis de serviço individuais, você pode ver as ações no contexto em seus cenários relacionados.
Cada exemplo inclui um link para o código-fonte completo, em que você pode encontrar instruções sobre como configurar e executar o código.
Tópicos
Ações
O código de exemplo a seguir mostra como usar abort-document-version-upload
.
- AWS CLI
-
Como interromper o upload de uma versão do documento
Este exemplo interrompe o upload de uma versão de documento iniciada anteriormente.
Comando:
aws workdocs abort-document-version-upload --document-id
feaba64d4efdf271c2521b60a2a44a8f057e84beaabbe22f01267313209835f2
--version-id1536773972914-ddb67663e782e7ce8455ebc962217cf9f9e47b5a9a702e5c84dcccd417da9313
Saída:
None
-
Para obter detalhes da API, consulte AbortDocumentVersionUpload
em Referência de AWS CLI Comandos.
-
O código de exemplo a seguir mostra como usar activate-user
.
- AWS CLI
-
Como ativar um usuário
Este exemplo ativa um usuário inativo.
Comando:
aws workdocs activate-user --user-id
"S-1-1-11-1111111111-2222222222-3333333333-3333&d-926726012c"
Saída:
{ "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 obter detalhes da API, consulte ActivateUser
em Referência de AWS CLI Comandos.
-
O código de exemplo a seguir mostra como usar add-resource-permissions
.
- AWS CLI
-
Para adicionar permissões para um recurso
Este exemplo adiciona permissões ao recurso para as entidades principais especificadas.
Comando:
aws workdocs add-resource-permissions --resource-id
d90d93c1fe44bad0c8471e973ebaab339090401a95e777cffa58e977d2983b65
--principalsId=anonymous,Type=ANONYMOUS,Role=VIEWER
Saída:
{ "ShareResults": [ { "PrincipalId": "anonymous", "Role": "VIEWER", "Status": "SUCCESS", "ShareId": "d90d93c1fe44bad0c8471e973ebaab339090401a95e777cffa58e977d2983b65", "StatusMessage": "" } ] }
-
Para obter detalhes da API, consulte AddResourcePermissions
em Referência de AWS CLI Comandos.
-
O código de exemplo a seguir mostra como usar create-comment
.
- AWS CLI
-
Para adicionar um novo comentário
Este exemplo adiciona um novo comentário à versão do documento especificada.
Comando:
aws workdocs create-comment --document-id
15df51e0335cfcc6a2e4de9dd8be9f22ee40545ad9176f54758dcf903be982d3
--version-id1521672507741-9f7df0ea5dd0b121c4f3564a0c7c0b4da95cd12c635d3c442af337a88e297920
--text"This is a comment."
Saída:
{ "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 obter detalhes da API, consulte CreateComment
em Referência de AWS CLI Comandos.
-
O código de exemplo a seguir mostra como usar create-custom-metadata
.
- AWS CLI
-
Para criar metadados personalizados
Este exemplo cria metadados personalizados para o documento especificado.
Comando:
aws workdocs create-custom-metadata --resource-id
d90d93c1fe44bad0c8471e973ebaab339090401a95e777cffa58e977d2983b65
--custom-metadataKeyName1=example,KeyName2=example2
Saída:
None
-
Para obter detalhes da API, consulte CreateCustomMetadata
em Referência de AWS CLI Comandos.
-
O código de exemplo a seguir mostra como usar create-folder
.
- AWS CLI
-
Para criar uma pasta
Este exemplo cria uma pasta.
Comando:
aws workdocs create-folder --name
documents
--parent-folder-id1ece93e5fe75315c7407c4967918b4fd9da87ddb2a588e67b7fdaf4a98fde678
Saída:
{ "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 obter detalhes da API, consulte CreateFolder
em Referência de AWS CLI Comandos.
-
O código de exemplo a seguir mostra como usar create-labels
.
- AWS CLI
-
Para criar rótulos
Este exemplo cria uma série de rótulos para um documento.
Comando:
aws workdocs create-labels --resource-id
d90d93c1fe44bad0c8471e973ebaab339090401a95e777cffa58e977d2983b65
--labels"documents"
"examples"
"my_documents"
Saída:
None
-
Para obter detalhes da API, consulte CreateLabels
em Referência de AWS CLI Comandos.
-
O código de exemplo a seguir mostra como usar create-notification-subscription
.
- AWS CLI
-
Para criar uma assinatura de notificação
O
create-notification-subscription
exemplo a seguir configura uma assinatura de notificação para a WorkDocs organização especificada da Amazon.aws workdocs create-notification-subscription \ --organization-id
d-123456789c
\ --protocolHTTPS
\ --subscription-typeALL
\ --notification-endpoint"https://example.com/example"
Saída:
{ "Subscription": { "SubscriptionId": "123ab4c5-678d-901e-f23g-45h6789j0123", "EndPoint": "https://example.com/example", "Protocol": "HTTPS" } }
Para obter mais informações, consulte Inscrever-se para receber notificações no Amazon WorkDocs Developer Guide.
-
Para obter detalhes da API, consulte CreateNotificationSubscription
em Referência de AWS CLI Comandos.
-
O código de exemplo a seguir mostra como usar create-user
.
- AWS CLI
-
Para criar um novo usuário
Este exemplo cria um novo usuário em um diretório do Simple AD ou do Microsoft AD.
Comando:
aws workdocs create-user --organization-id
d-926726012c
--usernameexampleUser2
--email-addressexampleUser2@site.awsapps.com
--given-nameexample2Name
--surnameexample2Surname
--passwordexamplePa$$w0rd
Saída:
{ "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 obter detalhes da API, consulte CreateUser
em Referência de AWS CLI Comandos.
-
O código de exemplo a seguir mostra como usar deactivate-user
.
- AWS CLI
-
Para desativar um usuário
Este exemplo desativa um usuário ativo.
Comando:
aws workdocs deactivate-user --user-id
"S-1-1-11-1111111111-2222222222-3333333333-3333&d-926726012c"
Saída:
None
-
Para obter detalhes da API, consulte DeactivateUser
em Referência de AWS CLI Comandos.
-
O código de exemplo a seguir mostra como usar delete-comment
.
- AWS CLI
-
Para excluir um comentário especificado de uma versão do documento
Este exemplo exclui o comentário especificado da versão do documento especificada.
Comando:
aws workdocs delete-comment --document-id
15df51e0335cfcc6a2e4de9dd8be9f22ee40545ad9176f54758dcf903be982d3
--version-id1521672507741-9f7df0ea5dd0b121c4f3564a0c7c0b4da95cd12c635d3c442af337a88e297920
--comment-id1534799058197-c7f5c84de9115875bbca93e0367bbebac609541d461636b760849b88b1609dd5
Saída:
None
-
Para obter detalhes da API, consulte DeleteComment
em Referência de AWS CLI Comandos.
-
O código de exemplo a seguir mostra como usar delete-custom-metadata
.
- AWS CLI
-
Para excluir metadados personalizados de um recurso
Este exemplo exclui todos os metadados personalizados do recurso especificado.
Comando:
aws workdocs delete-custom-metadata --resource-id
d90d93c1fe44bad0c8471e973ebaab339090401a95e777cffa58e977d2983b65
--delete-allSaída:
None
-
Para obter detalhes da API, consulte DeleteCustomMetadata
em Referência de AWS CLI Comandos.
-
O código de exemplo a seguir mostra como usar delete-document
.
- AWS CLI
-
Para excluir um documento
Este exemplo exclui o documento especificado.
Comando:
aws workdocs delete-document --document-id
b83ed5e5b167b65ef69de9d597627ff1a0d4f07a45e67f1fab7d26b54427de0a
Saída:
None
-
Para obter detalhes da API, consulte DeleteDocument
em Referência de AWS CLI Comandos.
-
O código de exemplo a seguir mostra como usar delete-folder-contents
.
- AWS CLI
-
Para excluir o conteúdo de uma pasta
Este exemplo exclui o conteúdo da pasta especificada.
Comando:
aws workdocs delete-folder-contents --folder-id
26fa8aa4ba2071447c194f7b150b07149dbdb9e1c8a301872dcd93a4735ce65d
Saída:
None
-
Para obter detalhes da API, consulte DeleteFolderContents
em Referência de AWS CLI Comandos.
-
O código de exemplo a seguir mostra como usar delete-folder
.
- AWS CLI
-
Para excluir uma pasta
Este exemplo exclui a pasta especificada.
Comando:
aws workdocs delete-folder --folder-id
26fa8aa4ba2071447c194f7b150b07149dbdb9e1c8a301872dcd93a4735ce65d
Saída:
None
-
Para obter detalhes da API, consulte DeleteFolder
em Referência de AWS CLI Comandos.
-
O código de exemplo a seguir mostra como usar delete-labels
.
- AWS CLI
-
Para excluir rótulos
Este exemplo exclui os rótulos especificados de um documento.
Comando:
aws workdocs delete-labels --resource-id
d90d93c1fe44bad0c8471e973ebaab339090401a95e777cffa58e977d2983b65
--labels"documents"
"examples"
Saída:
None
-
Para obter detalhes da API, consulte DeleteLabels
em Referência de AWS CLI Comandos.
-
O código de exemplo a seguir mostra como usar delete-notification-subscription
.
- AWS CLI
-
Para excluir uma assinatura de notificação
O exemplo
delete-notification-subscription
a seguir exclui a assinatura de notificação especificada.aws workdocs delete-notification-subscription \ --subscription-id
123ab4c5-678d-901e-f23g-45h6789j0123
\ --organization-idd-123456789c
Este comando não produz saída.
Para obter mais informações, consulte Inscrever-se para receber notificações no Amazon WorkDocs Developer Guide.
-
Para obter detalhes da API, consulte DeleteNotificationSubscription
em Referência de AWS CLI Comandos.
-
O código de exemplo a seguir mostra como usar delete-user
.
- AWS CLI
-
Como excluir um usuário
Este exemplo exclui um usuário.
Comando:
aws workdocs delete-user --user-id
"S-1-1-11-1111111111-2222222222-3333333333-3333&d-926726012c"
Saída:
None
-
Para obter detalhes da API, consulte DeleteUser
em Referência de AWS CLI Comandos.
-
O código de exemplo a seguir mostra como usar describe-activities
.
- AWS CLI
-
Para obter uma lista das atividades do usuário
Este exemplo retorna uma lista das atividades mais recentes do usuário para a organização especificada, com um limite definido para as duas últimas atividades.
Comando:
aws workdocs describe-activities --organization-id
d-926726012c
--limit2
Saída:
{ "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 obter detalhes da API, consulte DescribeActivities
em Referência de AWS CLI Comandos.
-
O código de exemplo a seguir mostra como usar describe-comments
.
- AWS CLI
-
Para listar todos os comentários de uma versão do documento especificada
Este exemplo lista todos os comentários da versão do documento especificada.
Comando:
aws workdocs describe-comments --document-id
15df51e0335cfcc6a2e4de9dd8be9f22ee40545ad9176f54758dcf903be982d3
--version-id1521672507741-9f7df0ea5dd0b121c4f3564a0c7c0b4da95cd12c635d3c442af337a88e297920
Saída:
{ "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 obter detalhes da API, consulte DescribeComments
em Referência de AWS CLI Comandos.
-
O código de exemplo a seguir mostra como usar describe-document-versions
.
- AWS CLI
-
Para recuperar as versões de um documento
Este exemplo recupera as versões do documento especificado, incluindo as versões inicializadas e um URL para o documento de origem.
Comando:
aws workdocs describe-document-versions --document-id
d90d93c1fe44bad0c8471e973ebaab339090401a95e777cffa58e977d2983b65
--fieldsSOURCE
Saída:
{ "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 obter detalhes da API, consulte DescribeDocumentVersions
em Referência de AWS CLI Comandos.
-
O código de exemplo a seguir mostra como usar describe-folder-contents
.
- AWS CLI
-
Para descrever o conteúdo de uma pasta
Este exemplo descreve todo o conteúdo ativo da pasta especificada incluindo seus documentos e subpastas ordenados por data em ordem crescente.
Comando:
aws workdocs describe-folder-contents --folder-id
1ece93e5fe75315c7407c4967918b4fd9da87ddb2a588e67b7fdaf4a98fde678
--sortDATE
--orderASCENDING
--typeALL
Saída:
{ "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 obter detalhes da API, consulte DescribeFolderContents
em Referência de AWS CLI Comandos.
-
O código de exemplo a seguir mostra como usar describe-groups
.
- AWS CLI
-
Para recuperar uma lista de grupos
O
describe-groups
exemplo a seguir lista os grupos associados à WorkDocs organização especificada da Amazon.aws workdocs d
e
scribe-groups \ --search-query "e" \ --organization-idd-123456789c
Saída:
{ "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 obter mais informações, consulte Getting Started with Amazon WorkDocs no Guia de WorkDocs administração da Amazon.
-
Para obter detalhes da API, consulte DescribeGroups
em Referência de AWS CLI Comandos.
-
O código de exemplo a seguir mostra como usar describe-notification-subscriptions
.
- AWS CLI
-
Para recuperar uma lista de assinaturas de notificação
O
describe-notification-subscriptions
exemplo a seguir recupera as assinaturas de notificação para a organização especificada da Amazon. WorkDocsaws workdocs describe-notification-subscriptions \ --organization-id
d-123456789c
Saída:
{ "Subscriptions": [ { "SubscriptionId": "123ab4c5-678d-901e-f23g-45h6789j0123", "EndPoint": "https://example.com/example", "Protocol": "HTTPS" } ] }
Para obter mais informações, consulte Inscrever-se para receber notificações no Amazon WorkDocs Developer Guide.
-
Para obter detalhes da API, consulte DescribeNotificationSubscriptions
em Referência de AWS CLI Comandos.
-
O código de exemplo a seguir mostra como usar describe-resource-permissions
.
- AWS CLI
-
Para obter uma lista de permissões de um recurso
Este exemplo retorna uma lista das permissões para o recurso especificado (documento ou pasta).
Comando:
aws workdocs describe-resource-permissions --resource-id
15df51e0335cfcc6a2e4de9dd8be9f22ee40545ad9176f54758dcf903be982d3
Saída:
{ "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 obter detalhes da API, consulte DescribeResourcePermissions
em Referência de AWS CLI Comandos.
-
O código de exemplo a seguir mostra como usar describe-users
.
- AWS CLI
-
Para recuperar detalhes de usuários especificados
Este exemplo recupera detalhes de todos os usuários na organização especificada.
Comando:
aws workdocs describe-users --organization-id
d-926726012c
Saída:
{ "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 obter detalhes da API, consulte DescribeUsers
em Referência de AWS CLI Comandos.
-
O código de exemplo a seguir mostra como usar get-document-path
.
- AWS CLI
-
Para recuperar as informações do caminho de um documento
Este exemplo recupera as informações de caminho (hierarquia da pasta raiz) para o documento especificado e inclui os nomes das pastas principais.
Comando:
aws workdocs get-document-path --document-id
d90d93c1fe44bad0c8471e973ebaab339090401a95e777cffa58e977d2983b65
--fieldsNAME
Saída:
{ "Path": { "Components": [ { "Id": "a43d29cbb8e7c4d25cfee8b803a504b0dc63e760b55ad0c611c6b87691eb6ff3", "Name": "/" }, { "Id": "1ece93e5fe75315c7407c4967918b4fd9da87ddb2a588e67b7fdaf4a98fde678", "Name": "Top Level Folder" }, { "Id": "d90d93c1fe44bad0c8471e973ebaab339090401a95e777cffa58e977d2983b65", "Name": "exampleDoc.docx" } ] } }
-
Para obter detalhes da API, consulte GetDocumentPath
em Referência de AWS CLI Comandos.
-
O código de exemplo a seguir mostra como usar get-document-version
.
- AWS CLI
-
Para recuperar os metadados da versão de um documento especificado
Este exemplo recupera os metadados da versão do documento especificado, incluindo um URL de origem e metadados personalizados.
Comando:
aws workdocs get-document-version --document-id
15df51e0335cfcc6a2e4de9dd8be9f22ee40545ad9176f54758dcf903be982d3
--version-id1521672507741-9f7df0ea5dd0b121c4f3564a0c7c0b4da95cd12c635d3c442af337a88e297920
--fieldsSOURCE
--include-custom-metadataSaída:
{ "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 obter detalhes da API, consulte GetDocumentVersion
em Referência de AWS CLI Comandos.
-
O código de exemplo a seguir mostra como usar get-document
.
- AWS CLI
-
Para recuperar detalhes do documento
Este exemplo recupera os detalhes do documento especificado.
Comando:
aws workdocs get-document --document-id
d90d93c1fe44bad0c8471e973ebaab339090401a95e777cffa58e977d2983b65
Saída:
{ "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 obter detalhes da API, consulte GetDocument
em Referência de AWS CLI Comandos.
-
O código de exemplo a seguir mostra como usar get-folder-path
.
- AWS CLI
-
Para recuperar informações de caminho para uma pasta
Este exemplo recupera as informações de caminho (hierarquia da pasta raiz) para a pasta especificada e inclui os nomes das pastas principais.
Comando:
aws workdocs get-folder-path --folder-id
50893c0af679524d1a0e0651130ed6d073e1a05f95bd12c42dcde5d35634ed08
--fieldsNAME
Saída:
{ "Path": { "Components": [ { "Id": "a43d29cbb8e7c4d25cfee8b803a504b0dc63e760b55ad0c611c6b87691eb6ff3", "Name": "/" }, { "Id": "1ece93e5fe75315c7407c4967918b4fd9da87ddb2a588e67b7fdaf4a98fde678", "Name": "Top Level Folder" }, { "Id": "50893c0af679524d1a0e0651130ed6d073e1a05f95bd12c42dcde5d35634ed08", "Name": "Sublevel Folder" } ] } }
-
Para obter detalhes da API, consulte GetFolderPath
em Referência de AWS CLI Comandos.
-
O código de exemplo a seguir mostra como usar get-folder
.
- AWS CLI
-
Para recuperar os metadados de uma pasta
Este exemplo recupera os metadados para a pasta especificada.
Comando:
aws workdocs get-folder --folder-id
50893c0af679524d1a0e0651130ed6d073e1a05f95bd12c42dcde5d35634ed08
Saída:
{ "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 obter detalhes da API, consulte GetFolder
em Referência de AWS CLI Comandos.
-
O código de exemplo a seguir mostra como usar get-resources
.
- AWS CLI
-
Para recuperar recursos compartilhados
O
get-resources
exemplo a seguir recupera os recursos compartilhados com o WorkDocs usuário especificado da Amazon.aws workdocs get-resources \ --user-id
"S-1-1-11-1111111111-2222222222-3333333333-3333"
\ --collection-typeSHARED_WITH_ME
Saída:
{ "Folders": [], "Documents": [] }
Para obter mais informações, consulte Compartilhamento de arquivos e pastas no Guia WorkDocs do usuário da Amazon.
-
Para obter detalhes da API, consulte GetResources
em Referência de AWS CLI Comandos.
-
O código de exemplo a seguir mostra como usar initiate-document-version-upload
.
- AWS CLI
-
Para iniciar o upload de uma versão do documento
O exemplo
initiate-document-upload
a seguir cria um novo objeto de documento e o objeto de versão.aws workdocs initiate-document-version-upload \ --name
exampledocname
\ --parent-folder-ideacd546d952531c633452ed67cac23161aa0d5df2e8061223a59e8f67e7b6189
Saída:
{ "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 obter detalhes da API, consulte InitiateDocumentVersionUpload
em Referência de AWS CLI Comandos.
-
O código de exemplo a seguir mostra como usar remove-all-resource-permissions
.
- AWS CLI
-
Para remover todas as permissões de um recurso especificado
Este exemplo remove todas as permissões do recurso especificado.
Comando:
aws workdocs remove-all-resource-permissions --resource-id
1ece93e5fe75315c7407c4967918b4fd9da87ddb2a588e67b7fdaf4a98fde678
Saída:
None
-
Para obter detalhes da API, consulte RemoveAllResourcePermissions
em Referência de AWS CLI Comandos.
-
O código de exemplo a seguir mostra como usar remove-resource-permission
.
- AWS CLI
-
Para remover permissões de um recurso
Este exemplo remove as permissões do recurso para a entidade principal especificada.
Comando:
aws workdocs remove-resource-permission --resource-id
1ece93e5fe75315c7407c4967918b4fd9da87ddb2a588e67b7fdaf4a98fde678
--principal-idanonymous
Saída:
None
-
Para obter detalhes da API, consulte RemoveResourcePermission
em Referência de AWS CLI Comandos.
-
O código de exemplo a seguir mostra como usar update-document-version
.
- AWS CLI
-
Para alterar o status da versão de um documento para Ativo
Este exemplo altera o status da versão do documento para Ativo.
Comando:
aws workdocs update-document-version --document-id
15df51e0335cfcc6a2e4de9dd8be9f22ee40545ad9176f54758dcf903be982d3
--version-id1521672507741-9f7df0ea5dd0b121c4f3564a0c7c0b4da95cd12c635d3c442af337a88e297920
--version-statusACTIVE
Saída:
None
-
Para obter detalhes da API, consulte UpdateDocumentVersion
em Referência de AWS CLI Comandos.
-
O código de exemplo a seguir mostra como usar update-document
.
- AWS CLI
-
Para atualizar um documento
Este exemplo atualiza o nome e a pasta principal de um documento.
Comando:
aws workdocs update-document --document-id
15df51e0335cfcc6a2e4de9dd8be9f22ee40545ad9176f54758dcf903be982d3
--nameupdatedDoc
--parent-folder-id50893c0af679524d1a0e0651130ed6d073e1a05f95bd12c42dcde5d35634ed08
Saída:
None
-
Para obter detalhes da API, consulte UpdateDocument
em Referência de AWS CLI Comandos.
-
O código de exemplo a seguir mostra como usar update-folder
.
- AWS CLI
-
Para atualizar uma pasta
Este exemplo atualiza o nome e a pasta principal de uma pasta.
Comando:
aws workdocs update-folder --folder-id
50893c0af679524d1a0e0651130ed6d073e1a05f95bd12c42dcde5d35634ed08
--nameexampleFolder1
--parent-folder-id1ece93e5fe75315c7407c4967918b4fd9da87ddb2a588e67b7fdaf4a98fde678
Saída:
None
-
Para obter detalhes da API, consulte UpdateFolder
em Referência de AWS CLI Comandos.
-
O código de exemplo a seguir mostra como usar update-user
.
- AWS CLI
-
Para atualizar um usuário
Este exemplo atualiza o fuso horário para o usuário especificado.
Comando:
aws workdocs update-user --user-id
"S-1-1-11-1111111111-2222222222-3333333333-3333&d-926726012c"
--time-zone-id"America/Los_Angeles"
Saída:
{ "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 obter detalhes da API, consulte UpdateUser
em Referência de AWS CLI Comandos.
-