Amazon WorkDocs - API Reference · 2020. 8. 20. · structure, as well as allow for basic metadata...

Amazon WorkDocsAPI Reference

API Version 2016-05-01

Amazon WorkDocs API Reference

Amazon WorkDocs: API ReferenceCopyright © 2020 Amazon Web Services, Inc. and/or its affiliates. All rights reserved.

Amazon's trademarks and trade dress may not be used in connection with any product or service that is notAmazon's, in any manner that is likely to cause confusion among customers, or in any manner that disparages ordiscredits Amazon. All other trademarks not owned by Amazon are the property of their respective owners, who mayor may not be affiliated with, connected to, or sponsored by Amazon.


Table of ContentsWelcome .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1Actions .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2

AbortDocumentVersionUpload .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4URI Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4Request Body .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5

ActivateUser .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6URI Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6Request Body .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7

AddResourcePermissions .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9URI Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9Request Body .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11

CreateComment .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12URI Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12Request Body .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15

CreateCustomMetadata .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16URI Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16Request Body .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18

CreateFolder ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19URI Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19Request Body .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21

CreateLabels ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22URI Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22Request Body .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22

API Version 2016-05-01iii


Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23

CreateNotificationSubscription .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25URI Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25Request Body .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27

CreateUser .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28URI Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28Request Body .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31

DeactivateUser .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32URI Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32Request Body .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33

DeleteComment .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34URI Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34Request Body .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35

DeleteCustomMetadata .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37URI Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37Request Body .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38

DeleteDocument .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 40Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 40URI Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 40Request Body .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 40Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 40Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 40Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 40See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41

DeleteFolder ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 42Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 42URI Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 42Request Body .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 42Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 42

API Version 2016-05-01iv


Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 42Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 42See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 43

DeleteFolderContents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 44Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 44URI Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 44Request Body .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 44Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 44Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 44Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 44See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45

DeleteLabels ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 46Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 46URI Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 46Request Body .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 46Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 46Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 46Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 47See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 47

DeleteNotificationSubscription .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 48Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 48URI Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 48Request Body .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 48Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 48Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 48Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 48See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 49

DeleteUser .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 50Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 50URI Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 50Request Body .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 50Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 50Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 50Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 50See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 51

DescribeActivities ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 52Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 52URI Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 52Request Body .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 53Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 53Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 55Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 55See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 55

DescribeComments .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 57Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 57URI Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 57Request Body .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 57Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 58Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 58Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 59See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 59

DescribeDocumentVersions .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 60Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 60URI Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 60Request Body .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 61Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 61Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 61

API Version 2016-05-01v


Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 61See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 62

DescribeFolderContents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 63Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 63URI Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 63Request Body .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 64Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 64Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 65Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 65See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 66

DescribeGroups .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 67Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 67URI Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 67Request Body .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 67Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 68Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 68Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 68See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 69

DescribeNotificationSubscriptions .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 70Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 70URI Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 70Request Body .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 70Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 70Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 70Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 71See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 71

DescribeResourcePermissions .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 72Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 72URI Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 72Request Body .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 72Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 72Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 73Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 73See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 74

DescribeRootFolders ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 75Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 75URI Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 75Request Body .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 75Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 75Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 76Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 76See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 77

DescribeUsers ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 78Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 78URI Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 78Request Body .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 79Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 79Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 80Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 80See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 81

GetCurrentUser .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 82Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 82URI Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 82Request Body .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 82Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 82Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 83Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 83

API Version 2016-05-01vi


See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 83GetDocument .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 85

Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 85URI Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 85Request Body .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 85Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 85Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 86Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 86See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 87

GetDocumentPath .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 88Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 88URI Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 88Request Body .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 88Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 89Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 89Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 89See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 90

GetDocumentVersion .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 91Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 91URI Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 91Request Body .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 91Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 92Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 92Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 92See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 93

GetFolder ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 94Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 94URI Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 94Request Body .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 94Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 94Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 95Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 95See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 96

GetFolderPath .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 97Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 97URI Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 97Request Body .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 97Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 98Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 98Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 98See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 99

GetResources .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 100Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 100URI Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 100Request Body .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 100Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 100Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 101Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 102See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 102

InitiateDocumentVersionUpload .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 104Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 104URI Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 104Request Body .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 104Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 105Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 106Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 106See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 107

API Version 2016-05-01vii


RemoveAllResourcePermissions .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 109Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 109URI Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 109Request Body .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 109Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 109Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 109Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 109See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 110

RemoveResourcePermission .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 111Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 111URI Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 111Request Body .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 111Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 111Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 111Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 112See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 112

UpdateDocument .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 113Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 113URI Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 113Request Body .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 113Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 114Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 114Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 114See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 115

UpdateDocumentVersion .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 116Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 116URI Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 116Request Body .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 116Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 117Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 117Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 117See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 118

UpdateFolder ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 119Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 119URI Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 119Request Body .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 119Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 120Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 120Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 120See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 121

UpdateUser .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 122Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 122URI Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 122Request Body .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 122Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 123Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 124Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 124See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 125

Data Types .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 126Activity ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 127

Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 127See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 128

Comment .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 129Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 129See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 130

CommentMetadata .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 131Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 131

API Version 2016-05-01viii


See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 131DocumentMetadata .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 133

Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 133See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 134

DocumentVersionMetadata .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 135Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 135See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 137

FolderMetadata .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 138Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 138See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 139

GroupMetadata .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 141Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 141See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 141

NotificationOptions .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 142Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 142See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 142

Participants .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 143Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 143See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 143

PermissionInfo .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 144Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 144See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 144

Principal ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 145Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 145See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 145

ResourceMetadata .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 146Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 146See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 147

ResourcePath .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 148Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 148See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 148

ResourcePathComponent .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 149Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 149See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 149

SharePrincipal ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 150Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 150See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 150

ShareResult ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 151Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 151See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 152

StorageRuleType .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 153Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 153See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 153

Subscription .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 154Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 154See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 154

UploadMetadata .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 155Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 155See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 155

User .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 156Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 156See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 158

UserMetadata .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 159Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 159See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 160

UserStorageMetadata .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 161Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 161

API Version 2016-05-01ix


See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 161Common Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 162Common Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 164

API Version 2016-05-01x


WelcomeThe WorkDocs API is designed for the following use cases:

• File Migration: File migration applications are supported for users who want to migrate their filesfrom an on-premises or off-premises file system or service. Users can insert files into a user directorystructure, as well as allow for basic metadata changes, such as modifications to the permissions offiles.

• Security: Support security applications are supported for users who have additional security needs,such as antivirus or data loss prevention. The API actions, along with AWS CloudTrail, allow theseapplications to detect when changes occur in Amazon WorkDocs. Then, the application can take thenecessary actions and replace the target file. If the target file violates the policy, the application canalso choose to email the user.

• eDiscovery/Analytics: General administrative applications are supported, such as eDiscovery andanalytics. These applications can choose to mimic or record the actions in an Amazon WorkDocs site,along with AWS CloudTrail, to replicate data for eDiscovery, backup, or analytical applications.

All Amazon WorkDocs API actions are Amazon authenticated and certificate-signed. They not onlyrequire the use of the AWS SDK, but also allow for the exclusive use of IAM users and roles to helpfacilitate access, trust, and permission policies. By creating a role and allowing an IAM user to access theAmazon WorkDocs site, the IAM user gains full administrative visibility into the entire Amazon WorkDocssite (or as set in the IAM policy). This includes, but is not limited to, the ability to modify file permissionsand upload any file to any user. This allows developers to perform the three use cases above, as well asgive users the ability to grant access on a selective basis using the IAM model.

This document was last published on December 22, 2020.



ActionsThe following actions are supported:

• AbortDocumentVersionUpload (p. 4)• ActivateUser (p. 6)• AddResourcePermissions (p. 9)• CreateComment (p. 12)• CreateCustomMetadata (p. 16)• CreateFolder (p. 19)• CreateLabels (p. 22)• CreateNotificationSubscription (p. 25)• CreateUser (p. 28)• DeactivateUser (p. 32)• DeleteComment (p. 34)• DeleteCustomMetadata (p. 37)• DeleteDocument (p. 40)• DeleteFolder (p. 42)• DeleteFolderContents (p. 44)• DeleteLabels (p. 46)• DeleteNotificationSubscription (p. 48)• DeleteUser (p. 50)• DescribeActivities (p. 52)• DescribeComments (p. 57)• DescribeDocumentVersions (p. 60)• DescribeFolderContents (p. 63)• DescribeGroups (p. 67)• DescribeNotificationSubscriptions (p. 70)• DescribeResourcePermissions (p. 72)• DescribeRootFolders (p. 75)• DescribeUsers (p. 78)• GetCurrentUser (p. 82)• GetDocument (p. 85)• GetDocumentPath (p. 88)• GetDocumentVersion (p. 91)• GetFolder (p. 94)• GetFolderPath (p. 97)• GetResources (p. 100)• InitiateDocumentVersionUpload (p. 104)• RemoveAllResourcePermissions (p. 109)• RemoveResourcePermission (p. 111)• UpdateDocument (p. 113)• UpdateDocumentVersion (p. 116)• UpdateFolder (p. 119)



• UpdateUser (p. 122)


Amazon WorkDocs API ReferenceAbortDocumentVersionUpload

AbortDocumentVersionUploadAborts the upload of the specified document version that was previously initiated byInitiateDocumentVersionUpload (p. 104). The client should make this call only when it no longerintends to upload the document version, or fails to do so.

Request SyntaxDELETE /api/v1/documents/DocumentId/versions/VersionId HTTP/1.1Authentication: AuthenticationToken

URI Request ParametersThe request uses the following URI parameters.

AuthenticationToken (p. 4)

Amazon WorkDocs authentication token. Not required when using AWS administrator credentials toaccess the API.

Length Constraints: Minimum length of 1. Maximum length of 8199.DocumentId (p. 4)

The ID of the document.

Length Constraints: Minimum length of 1. Maximum length of 128.

Pattern: [\w+-.@]+

Required: YesVersionId (p. 4)

The ID of the version.


Pattern: [\w+-.@]+

Required: Yes

Request BodyThe request does not have a request body.

Response SyntaxHTTP/1.1 204

Response ElementsIf the action is successful, the service sends back an HTTP 204 response with an empty HTTP body.


Amazon WorkDocs API ReferenceErrors

ErrorsFor information about the errors that are common to all actions, see Common Errors (p. 164).

EntityNotExistsException

The resource does not exist.

HTTP Status Code: 404FailedDependencyException

The AWS Directory Service cannot reach an on-premises instance. Or a dependency under thecontrol of the organization is failing, such as a connected Active Directory.

HTTP Status Code: 424ProhibitedStateException

The specified document version is not in the INITIALIZED state.

HTTP Status Code: 409ServiceUnavailableException

One or more of the dependencies is unavailable.

HTTP Status Code: 503UnauthorizedOperationException

The operation is not permitted.

HTTP Status Code: 403UnauthorizedResourceAccessException

The caller does not have access to perform the action on the resource.

HTTP Status Code: 404

See AlsoFor more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS Command Line Interface• AWS SDK for .NET• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java V2• AWS SDK for JavaScript• AWS SDK for PHP V3• AWS SDK for Python• AWS SDK for Ruby V3


https://docs.aws.amazon.com/goto/aws-cli/workdocs-2016-05-01/AbortDocumentVersionUpload

https://docs.aws.amazon.com/goto/DotNetSDKV3/workdocs-2016-05-01/AbortDocumentVersionUpload

https://docs.aws.amazon.com/goto/SdkForCpp/workdocs-2016-05-01/AbortDocumentVersionUpload

https://docs.aws.amazon.com/goto/SdkForGoV1/workdocs-2016-05-01/AbortDocumentVersionUpload

https://docs.aws.amazon.com/goto/SdkForJavaV2/workdocs-2016-05-01/AbortDocumentVersionUpload

https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/workdocs-2016-05-01/AbortDocumentVersionUpload

https://docs.aws.amazon.com/goto/SdkForPHPV3/workdocs-2016-05-01/AbortDocumentVersionUpload

https://docs.aws.amazon.com/goto/boto3/workdocs-2016-05-01/AbortDocumentVersionUpload

https://docs.aws.amazon.com/goto/SdkForRubyV3/workdocs-2016-05-01/AbortDocumentVersionUpload

Amazon WorkDocs API ReferenceActivateUser

ActivateUserActivates the specified user. Only active users can access Amazon WorkDocs.

Request SyntaxPOST /api/v1/users/UserId/activation HTTP/1.1Authentication: AuthenticationToken




Length Constraints: Minimum length of 1. Maximum length of 8199.UserId (p. 6)

The ID of the user.


Pattern: [&\w+-.@]+

Required: Yes


Response SyntaxHTTP/1.1 200Content-type: application/json

{ "User": { "CreatedTimestamp": number, "EmailAddress": "string", "GivenName": "string", "Id": "string", "Locale": "string", "ModifiedTimestamp": number, "OrganizationId": "string", "RecycleBinFolderId": "string", "RootFolderId": "string", "Status": "string", "Storage": { "StorageRule": { "StorageAllocatedInBytes": number, "StorageType": "string" },


Amazon WorkDocs API ReferenceResponse Elements

"StorageUtilizedInBytes": number }, "Surname": "string", "TimeZoneId": "string", "Type": "string", "Username": "string" }}

Response ElementsIf the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

User (p. 6)

The user information.

Type: User (p. 156) object















Amazon WorkDocs API ReferenceSee Also



https://docs.aws.amazon.com/goto/aws-cli/workdocs-2016-05-01/ActivateUser

https://docs.aws.amazon.com/goto/DotNetSDKV3/workdocs-2016-05-01/ActivateUser

https://docs.aws.amazon.com/goto/SdkForCpp/workdocs-2016-05-01/ActivateUser

https://docs.aws.amazon.com/goto/SdkForGoV1/workdocs-2016-05-01/ActivateUser

https://docs.aws.amazon.com/goto/SdkForJavaV2/workdocs-2016-05-01/ActivateUser

https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/workdocs-2016-05-01/ActivateUser

https://docs.aws.amazon.com/goto/SdkForPHPV3/workdocs-2016-05-01/ActivateUser

https://docs.aws.amazon.com/goto/boto3/workdocs-2016-05-01/ActivateUser

https://docs.aws.amazon.com/goto/SdkForRubyV3/workdocs-2016-05-01/ActivateUser

Amazon WorkDocs API ReferenceAddResourcePermissions

AddResourcePermissionsCreates a set of permissions for the specified folder or document. The resource permissions areoverwritten if the principals already have different permissions.

Request SyntaxPOST /api/v1/resources/ResourceId/permissions HTTP/1.1Authentication: AuthenticationTokenContent-type: application/json

{ "NotificationOptions": { "EmailMessage": "string", "SendEmail": boolean }, "Principals": [ { "Id": "string", "Role": "string", "Type": "string" } ]}




Length Constraints: Minimum length of 1. Maximum length of 8199.ResourceId (p. 9)

The ID of the resource.


Pattern: [\w+-.@]+

Required: Yes

Request BodyThe request accepts the following data in JSON format.

NotificationOptions (p. 9)

The notification options.

Type: NotificationOptions (p. 142) object

Required: No


Amazon WorkDocs API ReferenceResponse Syntax

Principals (p. 9)

The users, groups, or organization being granted permission.

Type: Array of SharePrincipal (p. 150) objects

Required: Yes


{ "ShareResults": [ { "InviteePrincipalId": "string", "PrincipalId": "string", "Role": "string", "ShareId": "string", "Status": "string", "StatusMessage": "string" } ]}



ShareResults (p. 10)

The share results.

Type: Array of ShareResult (p. 151) objects


FailedDependencyException














https://docs.aws.amazon.com/goto/aws-cli/workdocs-2016-05-01/AddResourcePermissions

https://docs.aws.amazon.com/goto/DotNetSDKV3/workdocs-2016-05-01/AddResourcePermissions

https://docs.aws.amazon.com/goto/SdkForCpp/workdocs-2016-05-01/AddResourcePermissions

https://docs.aws.amazon.com/goto/SdkForGoV1/workdocs-2016-05-01/AddResourcePermissions

https://docs.aws.amazon.com/goto/SdkForJavaV2/workdocs-2016-05-01/AddResourcePermissions

https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/workdocs-2016-05-01/AddResourcePermissions

https://docs.aws.amazon.com/goto/SdkForPHPV3/workdocs-2016-05-01/AddResourcePermissions

https://docs.aws.amazon.com/goto/boto3/workdocs-2016-05-01/AddResourcePermissions

https://docs.aws.amazon.com/goto/SdkForRubyV3/workdocs-2016-05-01/AddResourcePermissions

Amazon WorkDocs API ReferenceCreateComment

CreateCommentAdds a new comment to the specified document version.

Request SyntaxPOST /api/v1/documents/DocumentId/versions/VersionId/comment HTTP/1.1Authentication: AuthenticationTokenContent-type: application/json

{ "NotifyCollaborators": boolean, "ParentId": "string", "Text": "string", "ThreadId": "string", "Visibility": "string"}







Pattern: [\w+-.@]+


The ID of the document version.


Pattern: [\w+-.@]+

Required: Yes


NotifyCollaborators (p. 12)

Set this parameter to TRUE to send an email out to the document collaborators after the commentis created.



Type: Boolean

Required: NoParentId (p. 12)

The ID of the parent comment.

Type: String


Pattern: [\w+-.@]+

Required: NoText (p. 12)

The text of the comment.

Type: String


Required: YesThreadId (p. 12)

The ID of the root comment in the thread.

Type: String


Pattern: [\w+-.@]+

Required: NoVisibility (p. 12)

The visibility of the comment. Options are either PRIVATE, where the comment is visible only to thecomment author and document owner and co-owners, or PUBLIC, where the comment is visible todocument owners, co-owners, and contributors.

Type: String

Valid Values: PUBLIC | PRIVATE

Required: No


{ "Comment": { "CommentId": "string", "Contributor": { "CreatedTimestamp": number, "EmailAddress": "string", "GivenName": "string", "Id": "string",



"Locale": "string", "ModifiedTimestamp": number, "OrganizationId": "string", "RecycleBinFolderId": "string", "RootFolderId": "string", "Status": "string", "Storage": { "StorageRule": { "StorageAllocatedInBytes": number, "StorageType": "string" }, "StorageUtilizedInBytes": number }, "Surname": "string", "TimeZoneId": "string", "Type": "string", "Username": "string" }, "CreatedTimestamp": number, "ParentId": "string", "RecipientId": "string", "Status": "string", "Text": "string", "ThreadId": "string", "Visibility": "string" }}



Comment (p. 13)

The comment that has been created.

Type: Comment (p. 129) object


DocumentLockedForCommentsException

This exception is thrown when the document is locked for comments and user tries to create ordelete a comment on that document.

HTTP Status Code: 409EntityNotExistsException






HTTP Status Code: 424InvalidCommentOperationException

The requested operation is not allowed on the specified comment object.













https://docs.aws.amazon.com/goto/aws-cli/workdocs-2016-05-01/CreateComment

https://docs.aws.amazon.com/goto/DotNetSDKV3/workdocs-2016-05-01/CreateComment

https://docs.aws.amazon.com/goto/SdkForCpp/workdocs-2016-05-01/CreateComment

https://docs.aws.amazon.com/goto/SdkForGoV1/workdocs-2016-05-01/CreateComment

https://docs.aws.amazon.com/goto/SdkForJavaV2/workdocs-2016-05-01/CreateComment

https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/workdocs-2016-05-01/CreateComment

https://docs.aws.amazon.com/goto/SdkForPHPV3/workdocs-2016-05-01/CreateComment

https://docs.aws.amazon.com/goto/boto3/workdocs-2016-05-01/CreateComment

https://docs.aws.amazon.com/goto/SdkForRubyV3/workdocs-2016-05-01/CreateComment

Amazon WorkDocs API ReferenceCreateCustomMetadata

CreateCustomMetadataAdds one or more custom properties to the specified resource (a folder, document, or version).

Request SyntaxPUT /api/v1/resources/ResourceId/customMetadata?versionid=VersionId HTTP/1.1Authentication: AuthenticationTokenContent-type: application/json

{ "CustomMetadata": { "string" : "string" }}







Pattern: [\w+-.@]+


The ID of the version, if the custom metadata is being added to a document version.


Pattern: [\w+-.@]+


CustomMetadata (p. 16)

Custom metadata in the form of name-value pairs.

Type: String to string map

Map Entries: Maximum number of 8 items.

Key Length Constraints: Minimum length of 1. Maximum length of 56.



Key Pattern: [a-zA-Z0-9._+-/=][a-zA-Z0-9 ._+-/=]*

Value Length Constraints: Minimum length of 1. Maximum length of 256.

Value Pattern: [a-zA-Z0-9._+-/=][a-zA-Z0-9 ._+-/=]*

Required: Yes




CustomMetadataLimitExceededException

The limit has been reached on the number of custom properties for the specified resource.



















https://docs.aws.amazon.com/goto/aws-cli/workdocs-2016-05-01/CreateCustomMetadata

https://docs.aws.amazon.com/goto/DotNetSDKV3/workdocs-2016-05-01/CreateCustomMetadata

https://docs.aws.amazon.com/goto/SdkForCpp/workdocs-2016-05-01/CreateCustomMetadata

https://docs.aws.amazon.com/goto/SdkForGoV1/workdocs-2016-05-01/CreateCustomMetadata

https://docs.aws.amazon.com/goto/SdkForJavaV2/workdocs-2016-05-01/CreateCustomMetadata

https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/workdocs-2016-05-01/CreateCustomMetadata

https://docs.aws.amazon.com/goto/SdkForPHPV3/workdocs-2016-05-01/CreateCustomMetadata

https://docs.aws.amazon.com/goto/boto3/workdocs-2016-05-01/CreateCustomMetadata

https://docs.aws.amazon.com/goto/SdkForRubyV3/workdocs-2016-05-01/CreateCustomMetadata

Amazon WorkDocs API ReferenceCreateFolder

CreateFolderCreates a folder with the specified name and parent folder.

Request SyntaxPOST /api/v1/folders HTTP/1.1Authentication: AuthenticationTokenContent-type: application/json

{ "Name": "string", "ParentFolderId": "string"}






Name (p. 19)

The name of the new folder.

Type: String


Pattern: [\u0020-\u202D\u202F-\uFFFF]+

Required: NoParentFolderId (p. 19)

The ID of the parent folder.

Type: String


Pattern: [\w+-.@]+

Required: Yes




Content-type: application/json

{ "Metadata": { "CreatedTimestamp": number, "CreatorId": "string", "Id": "string", "Labels": [ "string" ], "LatestVersionSize": number, "ModifiedTimestamp": number, "Name": "string", "ParentFolderId": "string", "ResourceState": "string", "Signature": "string", "Size": number }}



Metadata (p. 19)

The metadata of the folder.

Type: FolderMetadata (p. 138) object


ConcurrentModificationException

The resource hierarchy is changing.

HTTP Status Code: 409ConflictingOperationException

Another operation is in progress on the resource that conflicts with the current operation.

HTTP Status Code: 409EntityAlreadyExistsException

The resource already exists.







HTTP Status Code: 424LimitExceededException

The maximum of 100,000 files and folders under the parent folder has been exceeded.













https://docs.aws.amazon.com/goto/aws-cli/workdocs-2016-05-01/CreateFolder

https://docs.aws.amazon.com/goto/DotNetSDKV3/workdocs-2016-05-01/CreateFolder

https://docs.aws.amazon.com/goto/SdkForCpp/workdocs-2016-05-01/CreateFolder

https://docs.aws.amazon.com/goto/SdkForGoV1/workdocs-2016-05-01/CreateFolder

https://docs.aws.amazon.com/goto/SdkForJavaV2/workdocs-2016-05-01/CreateFolder

https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/workdocs-2016-05-01/CreateFolder

https://docs.aws.amazon.com/goto/SdkForPHPV3/workdocs-2016-05-01/CreateFolder

https://docs.aws.amazon.com/goto/boto3/workdocs-2016-05-01/CreateFolder

https://docs.aws.amazon.com/goto/SdkForRubyV3/workdocs-2016-05-01/CreateFolder

Amazon WorkDocs API ReferenceCreateLabels

CreateLabelsAdds the specified list of labels to the given resource (a document or folder)

Request SyntaxPUT /api/v1/resources/ResourceId/labels HTTP/1.1Authentication: AuthenticationTokenContent-type: application/json

{ "Labels": [ "string" ]}







Pattern: [\w+-.@]+

Required: Yes


Labels (p. 22)

List of labels to add to the resource.

Type: Array of strings

Array Members: Maximum number of 20 items.


Pattern: [a-zA-Z0-9._+-/=][a-zA-Z0-9 ._+-/=]*

Required: Yes












HTTP Status Code: 503TooManyLabelsException

The limit has been reached on the number of labels for the specified resource.









https://docs.aws.amazon.com/goto/aws-cli/workdocs-2016-05-01/CreateLabels

https://docs.aws.amazon.com/goto/DotNetSDKV3/workdocs-2016-05-01/CreateLabels

https://docs.aws.amazon.com/goto/SdkForCpp/workdocs-2016-05-01/CreateLabels

https://docs.aws.amazon.com/goto/SdkForGoV1/workdocs-2016-05-01/CreateLabels

https://docs.aws.amazon.com/goto/SdkForJavaV2/workdocs-2016-05-01/CreateLabels

https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/workdocs-2016-05-01/CreateLabels

https://docs.aws.amazon.com/goto/SdkForPHPV3/workdocs-2016-05-01/CreateLabels

https://docs.aws.amazon.com/goto/boto3/workdocs-2016-05-01/CreateLabels

https://docs.aws.amazon.com/goto/SdkForRubyV3/workdocs-2016-05-01/CreateLabels

Amazon WorkDocs API ReferenceCreateNotificationSubscription

CreateNotificationSubscriptionConfigure Amazon WorkDocs to use Amazon SNS notifications. The endpoint receives a confirmationmessage, and must confirm the subscription.

For more information, see Subscribe to Notifications in the Amazon WorkDocs Developer Guide.

Request SyntaxPOST /api/v1/organizations/OrganizationId/subscriptions HTTP/1.1Content-type: application/json

{ "Endpoint": "string", "Protocol": "string", "SubscriptionType": "string"}


OrganizationId (p. 25)

The ID of the organization.


Pattern: [&\w+-.@]+

Required: Yes


Endpoint (p. 25)

The endpoint to receive the notifications. If the protocol is HTTPS, the endpoint is a URL that beginswith https.

Type: String


Required: Yes

Protocol (p. 25)

The protocol to use. The supported value is https, which delivers JSON-encoded messages usingHTTPS POST.

Type: String

Valid Values: HTTPS


https://docs.aws.amazon.com/workdocs/latest/developerguide/subscribe-notifications.html


Required: YesSubscriptionType (p. 25)

The notification type.

Type: String

Valid Values: ALL

Required: Yes


{ "Subscription": { "EndPoint": "string", "Protocol": "string", "SubscriptionId": "string" }}



Subscription (p. 26)

The subscription.

Type: Subscription (p. 154) object


ServiceUnavailableException


HTTP Status Code: 503TooManySubscriptionsException

You've reached the limit on the number of subscriptions for the WorkDocs instance.









https://docs.aws.amazon.com/goto/aws-cli/workdocs-2016-05-01/CreateNotificationSubscription

https://docs.aws.amazon.com/goto/DotNetSDKV3/workdocs-2016-05-01/CreateNotificationSubscription

https://docs.aws.amazon.com/goto/SdkForCpp/workdocs-2016-05-01/CreateNotificationSubscription

https://docs.aws.amazon.com/goto/SdkForGoV1/workdocs-2016-05-01/CreateNotificationSubscription

https://docs.aws.amazon.com/goto/SdkForJavaV2/workdocs-2016-05-01/CreateNotificationSubscription

https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/workdocs-2016-05-01/CreateNotificationSubscription

https://docs.aws.amazon.com/goto/SdkForPHPV3/workdocs-2016-05-01/CreateNotificationSubscription

https://docs.aws.amazon.com/goto/boto3/workdocs-2016-05-01/CreateNotificationSubscription

https://docs.aws.amazon.com/goto/SdkForRubyV3/workdocs-2016-05-01/CreateNotificationSubscription

Amazon WorkDocs API ReferenceCreateUser

CreateUserCreates a user in a Simple AD or Microsoft AD directory. The status of a newly created user is "ACTIVE".New users can access Amazon WorkDocs.

Request SyntaxPOST /api/v1/users HTTP/1.1Authentication: AuthenticationTokenContent-type: application/json

{ "EmailAddress": "string", "GivenName": "string", "OrganizationId": "string", "Password": "string", "StorageRule": { "StorageAllocatedInBytes": number, "StorageType": "string" }, "Surname": "string", "TimeZoneId": "string", "Username": "string"}






EmailAddress (p. 28)

The email address of the user.

Type: String


Pattern: [a-zA-Z0-9._%+-]+@[a-zA-Z0-9.-]+\.[a-zA-Z]{2,}

Required: NoGivenName (p. 28)

The given name of the user.

Type: String


Amazon WorkDocs API ReferenceRequest Body


Required: YesOrganizationId (p. 28)


Type: String


Pattern: [&\w+-.@]+

Required: NoPassword (p. 28)

The password of the user.

Type: String


Pattern: [\u0020-\u00FF]+

Required: YesStorageRule (p. 28)

The amount of storage for the user.

Type: StorageRuleType (p. 153) object

Required: NoSurname (p. 28)

The surname of the user.

Type: String


Required: YesTimeZoneId (p. 28)

The time zone ID of the user.

Type: String


Required: NoUsername (p. 28)

The login name of the user.

Type: String


Pattern: [\w\-+.]+(@[a-zA-Z0-9.\-]+\.[a-zA-Z]+)?

Required: Yes




{ "User": { "CreatedTimestamp": number, "EmailAddress": "string", "GivenName": "string", "Id": "string", "Locale": "string", "ModifiedTimestamp": number, "OrganizationId": "string", "RecycleBinFolderId": "string", "RootFolderId": "string", "Status": "string", "Storage": { "StorageRule": { "StorageAllocatedInBytes": number, "StorageType": "string" }, "StorageUtilizedInBytes": number }, "Surname": "string", "TimeZoneId": "string", "Type": "string", "Username": "string" }}



User (p. 30)




EntityAlreadyExistsException

















https://docs.aws.amazon.com/goto/aws-cli/workdocs-2016-05-01/CreateUser

https://docs.aws.amazon.com/goto/DotNetSDKV3/workdocs-2016-05-01/CreateUser

https://docs.aws.amazon.com/goto/SdkForCpp/workdocs-2016-05-01/CreateUser

https://docs.aws.amazon.com/goto/SdkForGoV1/workdocs-2016-05-01/CreateUser

https://docs.aws.amazon.com/goto/SdkForJavaV2/workdocs-2016-05-01/CreateUser

https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/workdocs-2016-05-01/CreateUser

https://docs.aws.amazon.com/goto/SdkForPHPV3/workdocs-2016-05-01/CreateUser

https://docs.aws.amazon.com/goto/boto3/workdocs-2016-05-01/CreateUser

https://docs.aws.amazon.com/goto/SdkForRubyV3/workdocs-2016-05-01/CreateUser

Amazon WorkDocs API ReferenceDeactivateUser

DeactivateUserDeactivates the specified user, which revokes the user's access to Amazon WorkDocs.

Request SyntaxDELETE /api/v1/users/UserId/activation HTTP/1.1Authentication: AuthenticationToken





UserId (p. 32)

The ID of the user.


Pattern: [&\w+-.@]+

Required: Yes






















https://docs.aws.amazon.com/goto/aws-cli/workdocs-2016-05-01/DeactivateUser

https://docs.aws.amazon.com/goto/DotNetSDKV3/workdocs-2016-05-01/DeactivateUser

https://docs.aws.amazon.com/goto/SdkForCpp/workdocs-2016-05-01/DeactivateUser

https://docs.aws.amazon.com/goto/SdkForGoV1/workdocs-2016-05-01/DeactivateUser

https://docs.aws.amazon.com/goto/SdkForJavaV2/workdocs-2016-05-01/DeactivateUser

https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/workdocs-2016-05-01/DeactivateUser

https://docs.aws.amazon.com/goto/SdkForPHPV3/workdocs-2016-05-01/DeactivateUser

https://docs.aws.amazon.com/goto/boto3/workdocs-2016-05-01/DeactivateUser

https://docs.aws.amazon.com/goto/SdkForRubyV3/workdocs-2016-05-01/DeactivateUser

Amazon WorkDocs API ReferenceDeleteComment

DeleteCommentDeletes the specified comment from the document version.

Request SyntaxDELETE /api/v1/documents/DocumentId/versions/VersionId/comment/CommentId HTTP/1.1Authentication: AuthenticationToken




Length Constraints: Minimum length of 1. Maximum length of 8199.CommentId (p. 34)

The ID of the comment.


Pattern: [\w+-.@]+

Required: YesDocumentId (p. 34)



Pattern: [\w+-.@]+




Pattern: [\w+-.@]+

Required: Yes







DocumentLockedForCommentsException

This exception is thrown when the document is locked for comments and user tries to create ordelete a comment on that document.















• AWS Command Line Interface• AWS SDK for .NET• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java V2


https://docs.aws.amazon.com/goto/aws-cli/workdocs-2016-05-01/DeleteComment

https://docs.aws.amazon.com/goto/DotNetSDKV3/workdocs-2016-05-01/DeleteComment

https://docs.aws.amazon.com/goto/SdkForCpp/workdocs-2016-05-01/DeleteComment

https://docs.aws.amazon.com/goto/SdkForGoV1/workdocs-2016-05-01/DeleteComment

https://docs.aws.amazon.com/goto/SdkForJavaV2/workdocs-2016-05-01/DeleteComment


• AWS SDK for JavaScript• AWS SDK for PHP V3• AWS SDK for Python• AWS SDK for Ruby V3


https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/workdocs-2016-05-01/DeleteComment

https://docs.aws.amazon.com/goto/SdkForPHPV3/workdocs-2016-05-01/DeleteComment

https://docs.aws.amazon.com/goto/boto3/workdocs-2016-05-01/DeleteComment

https://docs.aws.amazon.com/goto/SdkForRubyV3/workdocs-2016-05-01/DeleteComment

Amazon WorkDocs API ReferenceDeleteCustomMetadata

DeleteCustomMetadataDeletes custom metadata from the specified resource.

Request Syntax

DELETE /api/v1/resources/ResourceId/customMetadata?deleteAll=DeleteAll&keys=Keys&versionId=VersionId HTTP/1.1Authentication: AuthenticationToken





DeleteAll (p. 37)

Flag to indicate removal of all custom metadata properties from the specified resource.

Keys (p. 37)

List of properties to remove.




ResourceId (p. 37)

The ID of the resource, either a document or folder.


Pattern: [\w+-.@]+

Required: Yes

VersionId (p. 37)

The ID of the version, if the custom metadata is being deleted from a document version.


Pattern: [\w+-.@]+





















• AWS Command Line Interface• AWS SDK for .NET• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java V2


https://docs.aws.amazon.com/goto/aws-cli/workdocs-2016-05-01/DeleteCustomMetadata

https://docs.aws.amazon.com/goto/DotNetSDKV3/workdocs-2016-05-01/DeleteCustomMetadata

https://docs.aws.amazon.com/goto/SdkForCpp/workdocs-2016-05-01/DeleteCustomMetadata

https://docs.aws.amazon.com/goto/SdkForGoV1/workdocs-2016-05-01/DeleteCustomMetadata

https://docs.aws.amazon.com/goto/SdkForJavaV2/workdocs-2016-05-01/DeleteCustomMetadata


• AWS SDK for JavaScript• AWS SDK for PHP V3• AWS SDK for Python• AWS SDK for Ruby V3


https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/workdocs-2016-05-01/DeleteCustomMetadata

https://docs.aws.amazon.com/goto/SdkForPHPV3/workdocs-2016-05-01/DeleteCustomMetadata

https://docs.aws.amazon.com/goto/boto3/workdocs-2016-05-01/DeleteCustomMetadata

https://docs.aws.amazon.com/goto/SdkForRubyV3/workdocs-2016-05-01/DeleteCustomMetadata

Amazon WorkDocs API ReferenceDeleteDocument

DeleteDocumentPermanently deletes the specified document and its associated metadata.

Request SyntaxDELETE /api/v1/documents/DocumentId HTTP/1.1Authentication: AuthenticationToken





DocumentId (p. 40)



Pattern: [\w+-.@]+

Required: Yes










ConflictingOperationException


















https://docs.aws.amazon.com/goto/aws-cli/workdocs-2016-05-01/DeleteDocument

https://docs.aws.amazon.com/goto/DotNetSDKV3/workdocs-2016-05-01/DeleteDocument

https://docs.aws.amazon.com/goto/SdkForCpp/workdocs-2016-05-01/DeleteDocument

https://docs.aws.amazon.com/goto/SdkForGoV1/workdocs-2016-05-01/DeleteDocument

https://docs.aws.amazon.com/goto/SdkForJavaV2/workdocs-2016-05-01/DeleteDocument

https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/workdocs-2016-05-01/DeleteDocument

https://docs.aws.amazon.com/goto/SdkForPHPV3/workdocs-2016-05-01/DeleteDocument

https://docs.aws.amazon.com/goto/boto3/workdocs-2016-05-01/DeleteDocument

https://docs.aws.amazon.com/goto/SdkForRubyV3/workdocs-2016-05-01/DeleteDocument

Amazon WorkDocs API ReferenceDeleteFolder

DeleteFolderPermanently deletes the specified folder and its contents.

Request SyntaxDELETE /api/v1/folders/FolderId HTTP/1.1Authentication: AuthenticationToken





FolderId (p. 42)

The ID of the folder.


Pattern: [\w+-.@]+

Required: Yes




























https://docs.aws.amazon.com/goto/aws-cli/workdocs-2016-05-01/DeleteFolder

https://docs.aws.amazon.com/goto/DotNetSDKV3/workdocs-2016-05-01/DeleteFolder

https://docs.aws.amazon.com/goto/SdkForCpp/workdocs-2016-05-01/DeleteFolder

https://docs.aws.amazon.com/goto/SdkForGoV1/workdocs-2016-05-01/DeleteFolder

https://docs.aws.amazon.com/goto/SdkForJavaV2/workdocs-2016-05-01/DeleteFolder

https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/workdocs-2016-05-01/DeleteFolder

https://docs.aws.amazon.com/goto/SdkForPHPV3/workdocs-2016-05-01/DeleteFolder

https://docs.aws.amazon.com/goto/boto3/workdocs-2016-05-01/DeleteFolder

https://docs.aws.amazon.com/goto/SdkForRubyV3/workdocs-2016-05-01/DeleteFolder

Amazon WorkDocs API ReferenceDeleteFolderContents

DeleteFolderContentsDeletes the contents of the specified folder.

Request SyntaxDELETE /api/v1/folders/FolderId/contents HTTP/1.1Authentication: AuthenticationToken





FolderId (p. 44)



Pattern: [\w+-.@]+

Required: Yes


























https://docs.aws.amazon.com/goto/aws-cli/workdocs-2016-05-01/DeleteFolderContents

https://docs.aws.amazon.com/goto/DotNetSDKV3/workdocs-2016-05-01/DeleteFolderContents

https://docs.aws.amazon.com/goto/SdkForCpp/workdocs-2016-05-01/DeleteFolderContents

https://docs.aws.amazon.com/goto/SdkForGoV1/workdocs-2016-05-01/DeleteFolderContents

https://docs.aws.amazon.com/goto/SdkForJavaV2/workdocs-2016-05-01/DeleteFolderContents

https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/workdocs-2016-05-01/DeleteFolderContents

https://docs.aws.amazon.com/goto/SdkForPHPV3/workdocs-2016-05-01/DeleteFolderContents

https://docs.aws.amazon.com/goto/boto3/workdocs-2016-05-01/DeleteFolderContents

https://docs.aws.amazon.com/goto/SdkForRubyV3/workdocs-2016-05-01/DeleteFolderContents

Amazon WorkDocs API ReferenceDeleteLabels

DeleteLabelsDeletes the specified list of labels from a resource.

Request SyntaxDELETE /api/v1/resources/ResourceId/labels?deleteAll=DeleteAll&labels=Labels HTTP/1.1Authentication: AuthenticationToken




Length Constraints: Minimum length of 1. Maximum length of 8199.DeleteAll (p. 46)

Flag to request removal of all labels from the specified resource.Labels (p. 46)

List of labels to delete from the resource.



Pattern: [a-zA-Z0-9._+-/=][a-zA-Z0-9 ._+-/=]*ResourceId (p. 46)



Pattern: [\w+-.@]+

Required: Yes





















https://docs.aws.amazon.com/goto/aws-cli/workdocs-2016-05-01/DeleteLabels

https://docs.aws.amazon.com/goto/DotNetSDKV3/workdocs-2016-05-01/DeleteLabels

https://docs.aws.amazon.com/goto/SdkForCpp/workdocs-2016-05-01/DeleteLabels

https://docs.aws.amazon.com/goto/SdkForGoV1/workdocs-2016-05-01/DeleteLabels

https://docs.aws.amazon.com/goto/SdkForJavaV2/workdocs-2016-05-01/DeleteLabels

https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/workdocs-2016-05-01/DeleteLabels

https://docs.aws.amazon.com/goto/SdkForPHPV3/workdocs-2016-05-01/DeleteLabels

https://docs.aws.amazon.com/goto/boto3/workdocs-2016-05-01/DeleteLabels

https://docs.aws.amazon.com/goto/SdkForRubyV3/workdocs-2016-05-01/DeleteLabels

Amazon WorkDocs API ReferenceDeleteNotificationSubscription

DeleteNotificationSubscriptionDeletes the specified subscription from the specified organization.

Request SyntaxDELETE /api/v1/organizations/OrganizationId/subscriptions/SubscriptionId HTTP/1.1





Pattern: [&\w+-.@]+

Required: YesSubscriptionId (p. 48)

The ID of the subscription.


Pattern: [&\w+-.@]+

Required: Yes










ProhibitedStateException










https://docs.aws.amazon.com/goto/aws-cli/workdocs-2016-05-01/DeleteNotificationSubscription

https://docs.aws.amazon.com/goto/DotNetSDKV3/workdocs-2016-05-01/DeleteNotificationSubscription

https://docs.aws.amazon.com/goto/SdkForCpp/workdocs-2016-05-01/DeleteNotificationSubscription

https://docs.aws.amazon.com/goto/SdkForGoV1/workdocs-2016-05-01/DeleteNotificationSubscription

https://docs.aws.amazon.com/goto/SdkForJavaV2/workdocs-2016-05-01/DeleteNotificationSubscription

https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/workdocs-2016-05-01/DeleteNotificationSubscription

https://docs.aws.amazon.com/goto/SdkForPHPV3/workdocs-2016-05-01/DeleteNotificationSubscription

https://docs.aws.amazon.com/goto/boto3/workdocs-2016-05-01/DeleteNotificationSubscription

https://docs.aws.amazon.com/goto/SdkForRubyV3/workdocs-2016-05-01/DeleteNotificationSubscription

Amazon WorkDocs API ReferenceDeleteUser

DeleteUserDeletes the specified user from a Simple AD or Microsoft AD directory.

Request SyntaxDELETE /api/v1/users/UserId HTTP/1.1Authentication: AuthenticationToken



Amazon WorkDocs authentication token. Do not set this field when using administrative API actions,as in accessing the API using AWS credentials.


UserId (p. 50)

The ID of the user.


Pattern: [&\w+-.@]+

Required: Yes






















https://docs.aws.amazon.com/goto/aws-cli/workdocs-2016-05-01/DeleteUser

https://docs.aws.amazon.com/goto/DotNetSDKV3/workdocs-2016-05-01/DeleteUser

https://docs.aws.amazon.com/goto/SdkForCpp/workdocs-2016-05-01/DeleteUser

https://docs.aws.amazon.com/goto/SdkForGoV1/workdocs-2016-05-01/DeleteUser

https://docs.aws.amazon.com/goto/SdkForJavaV2/workdocs-2016-05-01/DeleteUser

https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/workdocs-2016-05-01/DeleteUser

https://docs.aws.amazon.com/goto/SdkForPHPV3/workdocs-2016-05-01/DeleteUser

https://docs.aws.amazon.com/goto/boto3/workdocs-2016-05-01/DeleteUser

https://docs.aws.amazon.com/goto/SdkForRubyV3/workdocs-2016-05-01/DeleteUser

Amazon WorkDocs API ReferenceDescribeActivities

DescribeActivitiesDescribes the user activities in a specified time period.

Request SyntaxGET /api/v1/activities?activityTypes=ActivityTypes&endTime=EndTime&includeIndirectActivities=IncludeIndirectActivities&limit=Limit&marker=Marker&organizationId=OrganizationId&resourceId=ResourceId&startTime=StartTime&userId=UserId HTTP/1.1Authentication: AuthenticationToken


ActivityTypes (p. 52)

Specifies which activity types to include in the response. If this field is left empty, all activity typesare returned.


Pattern: [\w,]+AuthenticationToken (p. 52)


Length Constraints: Minimum length of 1. Maximum length of 8199.EndTime (p. 52)

The timestamp that determines the end time of the activities. The response includes the activitiesperformed before the specified timestamp.

IncludeIndirectActivities (p. 52)

Includes indirect activities. An indirect activity results from a direct activity performed on a parentresource. For example, sharing a parent folder (the direct activity) shares all of the subfolders anddocuments within the parent folder (the indirect activity).

Limit (p. 52)

The maximum number of items to return.

Valid Range: Minimum value of 1. Maximum value of 999.Marker (p. 52)

The marker for the next set of results.


Pattern: [\u0000-\u00FF]+OrganizationId (p. 52)

The ID of the organization. This is a mandatory parameter when using administrative API (SigV4)requests.




Pattern: [&\w+-.@]+ResourceId (p. 52)

The document or folder ID for which to describe activity types.


Pattern: [&\w+-.@]+StartTime (p. 52)

The timestamp that determines the starting time of the activities. The response includes theactivities performed after the specified timestamp.

UserId (p. 52)

The ID of the user who performed the action. The response includes activities pertaining to this user.This is an optional parameter and is only applicable for administrative API (SigV4) requests.


Pattern: [&\w+-.@]+



{ "Marker": "string", "UserActivities": [ { "CommentMetadata": { "CommentId": "string", "CommentStatus": "string", "Contributor": { "CreatedTimestamp": number, "EmailAddress": "string", "GivenName": "string", "Id": "string", "Locale": "string", "ModifiedTimestamp": number, "OrganizationId": "string", "RecycleBinFolderId": "string", "RootFolderId": "string", "Status": "string", "Storage": { "StorageRule": { "StorageAllocatedInBytes": number, "StorageType": "string" }, "StorageUtilizedInBytes": number }, "Surname": "string", "TimeZoneId": "string",



"Type": "string", "Username": "string" }, "CreatedTimestamp": number, "RecipientId": "string" }, "Initiator": { "EmailAddress": "string", "GivenName": "string", "Id": "string", "Surname": "string", "Username": "string" }, "IsIndirectActivity": boolean, "OrganizationId": "string", "OriginalParent": { "Id": "string", "Name": "string", "OriginalName": "string", "Owner": { "EmailAddress": "string", "GivenName": "string", "Id": "string", "Surname": "string", "Username": "string" }, "ParentId": "string", "Type": "string", "VersionId": "string" }, "Participants": { "Groups": [ { "Id": "string", "Name": "string" } ], "Users": [ { "EmailAddress": "string", "GivenName": "string", "Id": "string", "Surname": "string", "Username": "string" } ] }, "ResourceMetadata": { "Id": "string", "Name": "string", "OriginalName": "string", "Owner": { "EmailAddress": "string", "GivenName": "string", "Id": "string", "Surname": "string", "Username": "string" }, "ParentId": "string", "Type": "string", "VersionId": "string" }, "TimeStamp": number, "Type": "string" } ]



}



Marker (p. 53)


Type: String


Pattern: [\u0000-\u00FF]+UserActivities (p. 53)

The list of activities for the specified user and time period.

Type: Array of Activity (p. 127) objects




HTTP Status Code: 424InvalidArgumentException

The pagination marker or limit fields are not valid.













https://docs.aws.amazon.com/goto/aws-cli/workdocs-2016-05-01/DescribeActivities

https://docs.aws.amazon.com/goto/DotNetSDKV3/workdocs-2016-05-01/DescribeActivities

https://docs.aws.amazon.com/goto/SdkForCpp/workdocs-2016-05-01/DescribeActivities

https://docs.aws.amazon.com/goto/SdkForGoV1/workdocs-2016-05-01/DescribeActivities

https://docs.aws.amazon.com/goto/SdkForJavaV2/workdocs-2016-05-01/DescribeActivities

https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/workdocs-2016-05-01/DescribeActivities

https://docs.aws.amazon.com/goto/SdkForPHPV3/workdocs-2016-05-01/DescribeActivities

https://docs.aws.amazon.com/goto/boto3/workdocs-2016-05-01/DescribeActivities

https://docs.aws.amazon.com/goto/SdkForRubyV3/workdocs-2016-05-01/DescribeActivities

Amazon WorkDocs API ReferenceDescribeComments

DescribeCommentsList all the comments for the specified document version.

Request SyntaxGET /api/v1/documents/DocumentId/versions/VersionId/comments?limit=Limit&marker=Marker HTTP/1.1Authentication: AuthenticationToken







Pattern: [\w+-.@]+

Required: YesLimit (p. 57)



The marker for the next set of results. This marker was received from a previous call.


Pattern: [\u0000-\u00FF]+VersionId (p. 57)



Pattern: [\w+-.@]+

Required: Yes





{ "Comments": [ { "CommentId": "string", "Contributor": { "CreatedTimestamp": number, "EmailAddress": "string", "GivenName": "string", "Id": "string", "Locale": "string", "ModifiedTimestamp": number, "OrganizationId": "string", "RecycleBinFolderId": "string", "RootFolderId": "string", "Status": "string", "Storage": { "StorageRule": { "StorageAllocatedInBytes": number, "StorageType": "string" }, "StorageUtilizedInBytes": number }, "Surname": "string", "TimeZoneId": "string", "Type": "string", "Username": "string" }, "CreatedTimestamp": number, "ParentId": "string", "RecipientId": "string", "Status": "string", "Text": "string", "ThreadId": "string", "Visibility": "string" } ], "Marker": "string"}



Comments (p. 58)

The list of comments for the specified document version.

Type: Array of Comment (p. 129) objectsMarker (p. 58)


Type: String






















https://docs.aws.amazon.com/goto/aws-cli/workdocs-2016-05-01/DescribeComments

https://docs.aws.amazon.com/goto/DotNetSDKV3/workdocs-2016-05-01/DescribeComments

https://docs.aws.amazon.com/goto/SdkForCpp/workdocs-2016-05-01/DescribeComments

https://docs.aws.amazon.com/goto/SdkForGoV1/workdocs-2016-05-01/DescribeComments

https://docs.aws.amazon.com/goto/SdkForJavaV2/workdocs-2016-05-01/DescribeComments

https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/workdocs-2016-05-01/DescribeComments

https://docs.aws.amazon.com/goto/SdkForPHPV3/workdocs-2016-05-01/DescribeComments

https://docs.aws.amazon.com/goto/boto3/workdocs-2016-05-01/DescribeComments

https://docs.aws.amazon.com/goto/SdkForRubyV3/workdocs-2016-05-01/DescribeComments

Amazon WorkDocs API ReferenceDescribeDocumentVersions

DescribeDocumentVersionsRetrieves the document versions for the specified document.

By default, only active versions are returned.

Request SyntaxGET /api/v1/documents/DocumentId/versions?fields=Fields&include=Include&limit=Limit&marker=Marker HTTP/1.1Authentication: AuthenticationToken







Pattern: [\w+-.@]+

Required: YesFields (p. 60)

Specify "SOURCE" to include initialized versions and a URL for the source document.


Pattern: [\w,]+Include (p. 60)

A comma-separated list of values. Specify "INITIALIZED" to include incomplete versions.


Pattern: [\w,]+Limit (p. 60)

The maximum number of versions to return with this call.


The marker for the next set of results. (You received this marker from a previous call.)






{ "DocumentVersions": [ { "ContentCreatedTimestamp": number, "ContentModifiedTimestamp": number, "ContentType": "string", "CreatedTimestamp": number, "CreatorId": "string", "Id": "string", "ModifiedTimestamp": number, "Name": "string", "Signature": "string", "Size": number, "Source": { "string" : "string" }, "Status": "string", "Thumbnail": { "string" : "string" } } ], "Marker": "string"}



DocumentVersions (p. 61)

The document versions.

Type: Array of DocumentVersionMetadata (p. 135) objectsMarker (p. 61)

The marker to use when requesting the next set of results. If there are no additional results, thestring is empty.

Type: String























https://docs.aws.amazon.com/goto/aws-cli/workdocs-2016-05-01/DescribeDocumentVersions

https://docs.aws.amazon.com/goto/DotNetSDKV3/workdocs-2016-05-01/DescribeDocumentVersions

https://docs.aws.amazon.com/goto/SdkForCpp/workdocs-2016-05-01/DescribeDocumentVersions

https://docs.aws.amazon.com/goto/SdkForGoV1/workdocs-2016-05-01/DescribeDocumentVersions

https://docs.aws.amazon.com/goto/SdkForJavaV2/workdocs-2016-05-01/DescribeDocumentVersions

https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/workdocs-2016-05-01/DescribeDocumentVersions

https://docs.aws.amazon.com/goto/SdkForPHPV3/workdocs-2016-05-01/DescribeDocumentVersions

https://docs.aws.amazon.com/goto/boto3/workdocs-2016-05-01/DescribeDocumentVersions

https://docs.aws.amazon.com/goto/SdkForRubyV3/workdocs-2016-05-01/DescribeDocumentVersions

Amazon WorkDocs API ReferenceDescribeFolderContents

DescribeFolderContentsDescribes the contents of the specified folder, including its documents and subfolders.

By default, Amazon WorkDocs returns the first 100 active document and folder metadata items. If thereare more results, the response includes a marker that you can use to request the next set of results. Youcan also request initialized documents.

Request SyntaxGET /api/v1/folders/FolderId/contents?include=Include&limit=Limit&marker=Marker&order=Order&sort=Sort&type=Type HTTP/1.1Authentication: AuthenticationToken




Length Constraints: Minimum length of 1. Maximum length of 8199.FolderId (p. 63)



Pattern: [\w+-.@]+

Required: YesInclude (p. 63)

The contents to include. Specify "INITIALIZED" to include initialized documents.



The maximum number of items to return with this call.



Length Constraints: Minimum length of 1. Maximum length of 2048.Order (p. 63)

The order for the contents of the folder.

Valid Values: ASCENDING | DESCENDING



Sort (p. 63)

The sorting criteria.

Valid Values: DATE | NAMEType (p. 63)

The type of items.

Valid Values: ALL | DOCUMENT | FOLDER



{ "Documents": [ { "CreatedTimestamp": number, "CreatorId": "string", "Id": "string", "Labels": [ "string" ], "LatestVersionMetadata": { "ContentCreatedTimestamp": number, "ContentModifiedTimestamp": number, "ContentType": "string", "CreatedTimestamp": number, "CreatorId": "string", "Id": "string", "ModifiedTimestamp": number, "Name": "string", "Signature": "string", "Size": number, "Source": { "string" : "string" }, "Status": "string", "Thumbnail": { "string" : "string" } }, "ModifiedTimestamp": number, "ParentFolderId": "string", "ResourceState": "string" } ], "Folders": [ { "CreatedTimestamp": number, "CreatorId": "string", "Id": "string", "Labels": [ "string" ], "LatestVersionSize": number, "ModifiedTimestamp": number, "Name": "string", "ParentFolderId": "string",



"ResourceState": "string", "Signature": "string", "Size": number } ], "Marker": "string"}



Documents (p. 64)

The documents in the specified folder.

Type: Array of DocumentMetadata (p. 133) objectsFolders (p. 64)

The subfolders in the specified folder.

Type: Array of FolderMetadata (p. 138) objectsMarker (p. 64)


Type: String






















https://docs.aws.amazon.com/goto/aws-cli/workdocs-2016-05-01/DescribeFolderContents

https://docs.aws.amazon.com/goto/DotNetSDKV3/workdocs-2016-05-01/DescribeFolderContents

https://docs.aws.amazon.com/goto/SdkForCpp/workdocs-2016-05-01/DescribeFolderContents

https://docs.aws.amazon.com/goto/SdkForGoV1/workdocs-2016-05-01/DescribeFolderContents

https://docs.aws.amazon.com/goto/SdkForJavaV2/workdocs-2016-05-01/DescribeFolderContents

https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/workdocs-2016-05-01/DescribeFolderContents

https://docs.aws.amazon.com/goto/SdkForPHPV3/workdocs-2016-05-01/DescribeFolderContents

https://docs.aws.amazon.com/goto/boto3/workdocs-2016-05-01/DescribeFolderContents

https://docs.aws.amazon.com/goto/SdkForRubyV3/workdocs-2016-05-01/DescribeFolderContents

Amazon WorkDocs API ReferenceDescribeGroups

DescribeGroupsDescribes the groups specified by the query. Groups are defined by the underlying Active Directory.

Request Syntax

GET /api/v1/groups?limit=Limit&marker=Marker&organizationId=OrganizationId&searchQuery=SearchQuery HTTP/1.1Authentication: AuthenticationToken





Limit (p. 67)


Valid Range: Minimum value of 1.

Marker (p. 67)







Pattern: [&\w+-.@]+

SearchQuery (p. 67)

A query to describe groups by group name.


Pattern: [\u0020-\uFFFF]+

Required: Yes





{ "Groups": [ { "Id": "string", "Name": "string" } ], "Marker": "string"}



Groups (p. 68)

The list of groups.

Type: Array of GroupMetadata (p. 141) objectsMarker (p. 68)


Type: String













UnauthorizedResourceAccessException






https://docs.aws.amazon.com/goto/aws-cli/workdocs-2016-05-01/DescribeGroups

https://docs.aws.amazon.com/goto/DotNetSDKV3/workdocs-2016-05-01/DescribeGroups

https://docs.aws.amazon.com/goto/SdkForCpp/workdocs-2016-05-01/DescribeGroups

https://docs.aws.amazon.com/goto/SdkForGoV1/workdocs-2016-05-01/DescribeGroups

https://docs.aws.amazon.com/goto/SdkForJavaV2/workdocs-2016-05-01/DescribeGroups

https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/workdocs-2016-05-01/DescribeGroups

https://docs.aws.amazon.com/goto/SdkForPHPV3/workdocs-2016-05-01/DescribeGroups

https://docs.aws.amazon.com/goto/boto3/workdocs-2016-05-01/DescribeGroups

https://docs.aws.amazon.com/goto/SdkForRubyV3/workdocs-2016-05-01/DescribeGroups

Amazon WorkDocs API ReferenceDescribeNotificationSubscriptions

DescribeNotificationSubscriptionsLists the specified notification subscriptions.

Request SyntaxGET /api/v1/organizations/OrganizationId/subscriptions?limit=Limit&marker=Marker HTTP/1.1


Limit (p. 70)




Length Constraints: Minimum length of 1. Maximum length of 2048.OrganizationId (p. 70)



Pattern: [&\w+-.@]+

Required: Yes



{ "Marker": "string", "Subscriptions": [ { "EndPoint": "string", "Protocol": "string", "SubscriptionId": "string" } ]}





Marker (p. 70)


Type: String

Length Constraints: Minimum length of 1. Maximum length of 2048.Subscriptions (p. 70)

The subscriptions.

Type: Array of Subscription (p. 154) objects













https://docs.aws.amazon.com/goto/aws-cli/workdocs-2016-05-01/DescribeNotificationSubscriptions

https://docs.aws.amazon.com/goto/DotNetSDKV3/workdocs-2016-05-01/DescribeNotificationSubscriptions

https://docs.aws.amazon.com/goto/SdkForCpp/workdocs-2016-05-01/DescribeNotificationSubscriptions

https://docs.aws.amazon.com/goto/SdkForGoV1/workdocs-2016-05-01/DescribeNotificationSubscriptions

https://docs.aws.amazon.com/goto/SdkForJavaV2/workdocs-2016-05-01/DescribeNotificationSubscriptions

https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/workdocs-2016-05-01/DescribeNotificationSubscriptions

https://docs.aws.amazon.com/goto/SdkForPHPV3/workdocs-2016-05-01/DescribeNotificationSubscriptions

https://docs.aws.amazon.com/goto/boto3/workdocs-2016-05-01/DescribeNotificationSubscriptions

https://docs.aws.amazon.com/goto/SdkForRubyV3/workdocs-2016-05-01/DescribeNotificationSubscriptions

Amazon WorkDocs API ReferenceDescribeResourcePermissions

DescribeResourcePermissionsDescribes the permissions of a specified resource.

Request SyntaxGET /api/v1/resources/ResourceId/permissions?limit=Limit&marker=Marker&principalId=PrincipalId HTTP/1.1Authentication: AuthenticationToken




Length Constraints: Minimum length of 1. Maximum length of 8199.Limit (p. 72)



The marker for the next set of results. (You received this marker from a previous call)

Length Constraints: Minimum length of 1. Maximum length of 2048.PrincipalId (p. 72)

The ID of the principal to filter permissions by.


Pattern: [&\w+-.@]+ResourceId (p. 72)



Pattern: [\w+-.@]+

Required: Yes





Content-type: application/json

{ "Marker": "string", "Principals": [ { "Id": "string", "Roles": [ { "Role": "string", "Type": "string" } ], "Type": "string" } ]}



Marker (p. 72)


Type: String

Length Constraints: Minimum length of 1. Maximum length of 2048.Principals (p. 72)

The principals.

Type: Array of Principal (p. 145) objects











UnauthorizedOperationException








https://docs.aws.amazon.com/goto/aws-cli/workdocs-2016-05-01/DescribeResourcePermissions

https://docs.aws.amazon.com/goto/DotNetSDKV3/workdocs-2016-05-01/DescribeResourcePermissions

https://docs.aws.amazon.com/goto/SdkForCpp/workdocs-2016-05-01/DescribeResourcePermissions

https://docs.aws.amazon.com/goto/SdkForGoV1/workdocs-2016-05-01/DescribeResourcePermissions

https://docs.aws.amazon.com/goto/SdkForJavaV2/workdocs-2016-05-01/DescribeResourcePermissions

https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/workdocs-2016-05-01/DescribeResourcePermissions

https://docs.aws.amazon.com/goto/SdkForPHPV3/workdocs-2016-05-01/DescribeResourcePermissions

https://docs.aws.amazon.com/goto/boto3/workdocs-2016-05-01/DescribeResourcePermissions

https://docs.aws.amazon.com/goto/SdkForRubyV3/workdocs-2016-05-01/DescribeResourcePermissions

Amazon WorkDocs API ReferenceDescribeRootFolders

DescribeRootFoldersDescribes the current user's special folders; the RootFolder and the RecycleBin. RootFolder is theroot of user's files and folders and RecycleBin is the root of recycled items. This is not a valid action forSigV4 (administrative API) clients.

This action requires an authentication token. To get an authentication token, register an application withAmazon WorkDocs. For more information, see Authentication and Access Control for User Applications inthe Amazon WorkDocs Developer Guide.

Request SyntaxGET /api/v1/me/root?limit=Limit&marker=Marker HTTP/1.1Authentication: AuthenticationToken



Amazon WorkDocs authentication token.









{ "Folders": [ { "CreatedTimestamp": number, "CreatorId": "string", "Id": "string", "Labels": [ "string" ], "LatestVersionSize": number,


https://docs.aws.amazon.com/workdocs/latest/developerguide/wd-auth-user.html


"ModifiedTimestamp": number, "Name": "string", "ParentFolderId": "string", "ResourceState": "string", "Signature": "string", "Size": number } ], "Marker": "string"}



Folders (p. 75)

The user's special folders.



Type: String



















https://docs.aws.amazon.com/goto/aws-cli/workdocs-2016-05-01/DescribeRootFolders

https://docs.aws.amazon.com/goto/DotNetSDKV3/workdocs-2016-05-01/DescribeRootFolders

https://docs.aws.amazon.com/goto/SdkForCpp/workdocs-2016-05-01/DescribeRootFolders

https://docs.aws.amazon.com/goto/SdkForGoV1/workdocs-2016-05-01/DescribeRootFolders

https://docs.aws.amazon.com/goto/SdkForJavaV2/workdocs-2016-05-01/DescribeRootFolders

https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/workdocs-2016-05-01/DescribeRootFolders

https://docs.aws.amazon.com/goto/SdkForPHPV3/workdocs-2016-05-01/DescribeRootFolders

https://docs.aws.amazon.com/goto/boto3/workdocs-2016-05-01/DescribeRootFolders

https://docs.aws.amazon.com/goto/SdkForRubyV3/workdocs-2016-05-01/DescribeRootFolders

Amazon WorkDocs API ReferenceDescribeUsers

DescribeUsersDescribes the specified users. You can describe all users or filter the results (for example, by status ororganization).

By default, Amazon WorkDocs returns the first 24 active or pending users. If there are more results, theresponse includes a marker that you can use to request the next set of results.

Request SyntaxGET /api/v1/users?fields=Fields&include=Include&limit=Limit&marker=Marker&order=Order&organizationId=OrganizationId&query=Query&sort=Sort&userIds=UserIds HTTP/1.1Authentication: AuthenticationToken




Length Constraints: Minimum length of 1. Maximum length of 8199.Fields (p. 78)

A comma-separated list of values. Specify "STORAGE_METADATA" to include the user storage quotaand utilization information.


Pattern: [\w,]+Include (p. 78)

The state of the users. Specify "ALL" to include inactive users.

Valid Values: ALL | ACTIVE_PENDINGLimit (p. 78)




Length Constraints: Minimum length of 1. Maximum length of 2048.Order (p. 78)

The order for the results.

Valid Values: ASCENDING | DESCENDINGOrganizationId (p. 78)





Pattern: [&\w+-.@]+Query (p. 78)

A query to filter users by user name.


Pattern: [\u0020-\uFFFF]+Sort (p. 78)

The sorting criteria.

Valid Values: USER_NAME | FULL_NAME | STORAGE_LIMIT | USER_STATUS |STORAGE_USED

UserIds (p. 78)

The IDs of the users.


Pattern: [&\w+-.@, ]+



{ "Marker": "string", "TotalNumberOfUsers": number, "Users": [ { "CreatedTimestamp": number, "EmailAddress": "string", "GivenName": "string", "Id": "string", "Locale": "string", "ModifiedTimestamp": number, "OrganizationId": "string", "RecycleBinFolderId": "string", "RootFolderId": "string", "Status": "string", "Storage": { "StorageRule": { "StorageAllocatedInBytes": number, "StorageType": "string" }, "StorageUtilizedInBytes": number }, "Surname": "string", "TimeZoneId": "string", "Type": "string", "Username": "string"



} ]}



Marker (p. 79)


Type: String

Length Constraints: Minimum length of 1. Maximum length of 2048.TotalNumberOfUsers (p. 79)

This parameter has been deprecated.

The total number of users included in the results.

Type: LongUsers (p. 79)

The users.

Type: Array of User (p. 156) objects








HTTP Status Code: 400RequestedEntityTooLargeException

The response is too large to return. The request must include a filter to reduce the size of theresponse.














https://docs.aws.amazon.com/goto/aws-cli/workdocs-2016-05-01/DescribeUsers

https://docs.aws.amazon.com/goto/DotNetSDKV3/workdocs-2016-05-01/DescribeUsers

https://docs.aws.amazon.com/goto/SdkForCpp/workdocs-2016-05-01/DescribeUsers

https://docs.aws.amazon.com/goto/SdkForGoV1/workdocs-2016-05-01/DescribeUsers

https://docs.aws.amazon.com/goto/SdkForJavaV2/workdocs-2016-05-01/DescribeUsers

https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/workdocs-2016-05-01/DescribeUsers

https://docs.aws.amazon.com/goto/SdkForPHPV3/workdocs-2016-05-01/DescribeUsers

https://docs.aws.amazon.com/goto/boto3/workdocs-2016-05-01/DescribeUsers

https://docs.aws.amazon.com/goto/SdkForRubyV3/workdocs-2016-05-01/DescribeUsers

Amazon WorkDocs API ReferenceGetCurrentUser

GetCurrentUserRetrieves details of the current user for whom the authentication token was generated. This is not a validaction for SigV4 (administrative API) clients.

This action requires an authentication token. To get an authentication token, register an application withAmazon WorkDocs. For more information, see Authentication and Access Control for User Applications inthe Amazon WorkDocs Developer Guide.

Request SyntaxGET /api/v1/me HTTP/1.1Authentication: AuthenticationToken



Amazon WorkDocs authentication token.


Required: Yes



{ "User": { "CreatedTimestamp": number, "EmailAddress": "string", "GivenName": "string", "Id": "string", "Locale": "string", "ModifiedTimestamp": number, "OrganizationId": "string", "RecycleBinFolderId": "string", "RootFolderId": "string", "Status": "string", "Storage": { "StorageRule": { "StorageAllocatedInBytes": number, "StorageType": "string" }, "StorageUtilizedInBytes": number }, "Surname": "string", "TimeZoneId": "string",


https://docs.aws.amazon.com/workdocs/latest/developerguide/wd-auth-user.html


"Type": "string", "Username": "string" }}



User (p. 82)

Metadata of the user.















• AWS Command Line Interface• AWS SDK for .NET• AWS SDK for C++


https://docs.aws.amazon.com/goto/aws-cli/workdocs-2016-05-01/GetCurrentUser

https://docs.aws.amazon.com/goto/DotNetSDKV3/workdocs-2016-05-01/GetCurrentUser

https://docs.aws.amazon.com/goto/SdkForCpp/workdocs-2016-05-01/GetCurrentUser


• AWS SDK for Go• AWS SDK for Java V2• AWS SDK for JavaScript• AWS SDK for PHP V3• AWS SDK for Python• AWS SDK for Ruby V3


https://docs.aws.amazon.com/goto/SdkForGoV1/workdocs-2016-05-01/GetCurrentUser

https://docs.aws.amazon.com/goto/SdkForJavaV2/workdocs-2016-05-01/GetCurrentUser

https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/workdocs-2016-05-01/GetCurrentUser

https://docs.aws.amazon.com/goto/SdkForPHPV3/workdocs-2016-05-01/GetCurrentUser

https://docs.aws.amazon.com/goto/boto3/workdocs-2016-05-01/GetCurrentUser

https://docs.aws.amazon.com/goto/SdkForRubyV3/workdocs-2016-05-01/GetCurrentUser

Amazon WorkDocs API ReferenceGetDocument

GetDocumentRetrieves details of a document.

Request SyntaxGET /api/v1/documents/DocumentId?includeCustomMetadata=IncludeCustomMetadata HTTP/1.1Authentication: AuthenticationToken







Pattern: [\w+-.@]+

Required: YesIncludeCustomMetadata (p. 85)

Set this to TRUE to include custom metadata in the response.



{ "CustomMetadata": { "string" : "string" }, "Metadata": { "CreatedTimestamp": number, "CreatorId": "string", "Id": "string", "Labels": [ "string" ], "LatestVersionMetadata": { "ContentCreatedTimestamp": number, "ContentModifiedTimestamp": number, "ContentType": "string", "CreatedTimestamp": number,



"CreatorId": "string", "Id": "string", "ModifiedTimestamp": number, "Name": "string", "Signature": "string", "Size": number, "Source": { "string" : "string" }, "Status": "string", "Thumbnail": { "string" : "string" } }, "ModifiedTimestamp": number, "ParentFolderId": "string", "ResourceState": "string" }}




The custom metadata on the document.






Value Pattern: [a-zA-Z0-9._+-/=][a-zA-Z0-9 ._+-/=]*Metadata (p. 85)

The metadata details of the document.

Type: DocumentMetadata (p. 133) object










HTTP Status Code: 400InvalidPasswordException

The password is invalid.











https://docs.aws.amazon.com/goto/aws-cli/workdocs-2016-05-01/GetDocument

https://docs.aws.amazon.com/goto/DotNetSDKV3/workdocs-2016-05-01/GetDocument

https://docs.aws.amazon.com/goto/SdkForCpp/workdocs-2016-05-01/GetDocument

https://docs.aws.amazon.com/goto/SdkForGoV1/workdocs-2016-05-01/GetDocument

https://docs.aws.amazon.com/goto/SdkForJavaV2/workdocs-2016-05-01/GetDocument

https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/workdocs-2016-05-01/GetDocument

https://docs.aws.amazon.com/goto/SdkForPHPV3/workdocs-2016-05-01/GetDocument

https://docs.aws.amazon.com/goto/boto3/workdocs-2016-05-01/GetDocument

https://docs.aws.amazon.com/goto/SdkForRubyV3/workdocs-2016-05-01/GetDocument

Amazon WorkDocs API ReferenceGetDocumentPath

GetDocumentPathRetrieves the path information (the hierarchy from the root folder) for the requested document.

By default, Amazon WorkDocs returns a maximum of 100 levels upwards from the requested documentand only includes the IDs of the parent folders in the path. You can limit the maximum number of levels.You can also request the names of the parent folders.

Request SyntaxGET /api/v1/documents/DocumentId/path?fields=Fields&limit=Limit&marker=Marker HTTP/1.1Authentication: AuthenticationToken







Pattern: [&\w+-.@]+

Required: YesFields (p. 88)

A comma-separated list of values. Specify NAME to include the names of the parent folders.



The maximum number of levels in the hierarchy to return.


This value is not supported.






{ "Path": { "Components": [ { "Id": "string", "Name": "string" } ] }}



Path (p. 89)

The path information.

Type: ResourcePath (p. 148) object


















https://docs.aws.amazon.com/goto/aws-cli/workdocs-2016-05-01/GetDocumentPath

https://docs.aws.amazon.com/goto/DotNetSDKV3/workdocs-2016-05-01/GetDocumentPath

https://docs.aws.amazon.com/goto/SdkForCpp/workdocs-2016-05-01/GetDocumentPath

https://docs.aws.amazon.com/goto/SdkForGoV1/workdocs-2016-05-01/GetDocumentPath

https://docs.aws.amazon.com/goto/SdkForJavaV2/workdocs-2016-05-01/GetDocumentPath

https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/workdocs-2016-05-01/GetDocumentPath

https://docs.aws.amazon.com/goto/SdkForPHPV3/workdocs-2016-05-01/GetDocumentPath

https://docs.aws.amazon.com/goto/boto3/workdocs-2016-05-01/GetDocumentPath

https://docs.aws.amazon.com/goto/SdkForRubyV3/workdocs-2016-05-01/GetDocumentPath

Amazon WorkDocs API ReferenceGetDocumentVersion

GetDocumentVersionRetrieves version metadata for the specified document.

Request Syntax

GET /api/v1/documents/DocumentId/versions/VersionId?fields=Fields&includeCustomMetadata=IncludeCustomMetadata HTTP/1.1Authentication: AuthenticationToken





DocumentId (p. 91)



Pattern: [\w+-.@]+

Required: Yes

Fields (p. 91)

A comma-separated list of values. Specify "SOURCE" to include a URL for the source document.


Pattern: [\w,]+

IncludeCustomMetadata (p. 91)

Set this to TRUE to include custom metadata in the response.

VersionId (p. 91)

The version ID of the document.


Pattern: [\w+-.@]+

Required: Yes





{ "CustomMetadata": { "string" : "string" }, "Metadata": { "ContentCreatedTimestamp": number, "ContentModifiedTimestamp": number, "ContentType": "string", "CreatedTimestamp": number, "CreatorId": "string", "Id": "string", "ModifiedTimestamp": number, "Name": "string", "Signature": "string", "Size": number, "Source": { "string" : "string" }, "Status": "string", "Thumbnail": { "string" : "string" } }}




The custom metadata on the document version.







The version metadata.

Type: DocumentVersionMetadata (p. 135) object








HTTP Status Code: 424InvalidPasswordException

The password is invalid.













https://docs.aws.amazon.com/goto/aws-cli/workdocs-2016-05-01/GetDocumentVersion

https://docs.aws.amazon.com/goto/DotNetSDKV3/workdocs-2016-05-01/GetDocumentVersion

https://docs.aws.amazon.com/goto/SdkForCpp/workdocs-2016-05-01/GetDocumentVersion

https://docs.aws.amazon.com/goto/SdkForGoV1/workdocs-2016-05-01/GetDocumentVersion

https://docs.aws.amazon.com/goto/SdkForJavaV2/workdocs-2016-05-01/GetDocumentVersion

https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/workdocs-2016-05-01/GetDocumentVersion

https://docs.aws.amazon.com/goto/SdkForPHPV3/workdocs-2016-05-01/GetDocumentVersion

https://docs.aws.amazon.com/goto/boto3/workdocs-2016-05-01/GetDocumentVersion

https://docs.aws.amazon.com/goto/SdkForRubyV3/workdocs-2016-05-01/GetDocumentVersion

Amazon WorkDocs API ReferenceGetFolder

GetFolderRetrieves the metadata of the specified folder.

Request SyntaxGET /api/v1/folders/FolderId?includeCustomMetadata=IncludeCustomMetadata HTTP/1.1Authentication: AuthenticationToken







Pattern: [\w+-.@]+

Required: YesIncludeCustomMetadata (p. 94)

Set to TRUE to include custom metadata in the response.



{ "CustomMetadata": { "string" : "string" }, "Metadata": { "CreatedTimestamp": number, "CreatorId": "string", "Id": "string", "Labels": [ "string" ], "LatestVersionSize": number, "ModifiedTimestamp": number, "Name": "string", "ParentFolderId": "string", "ResourceState": "string",



"Signature": "string", "Size": number }}




The custom metadata on the folder.







The metadata of the folder.

Type: FolderMetadata (p. 138) object























https://docs.aws.amazon.com/goto/aws-cli/workdocs-2016-05-01/GetFolder

https://docs.aws.amazon.com/goto/DotNetSDKV3/workdocs-2016-05-01/GetFolder

https://docs.aws.amazon.com/goto/SdkForCpp/workdocs-2016-05-01/GetFolder

https://docs.aws.amazon.com/goto/SdkForGoV1/workdocs-2016-05-01/GetFolder

https://docs.aws.amazon.com/goto/SdkForJavaV2/workdocs-2016-05-01/GetFolder

https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/workdocs-2016-05-01/GetFolder

https://docs.aws.amazon.com/goto/SdkForPHPV3/workdocs-2016-05-01/GetFolder

https://docs.aws.amazon.com/goto/boto3/workdocs-2016-05-01/GetFolder

https://docs.aws.amazon.com/goto/SdkForRubyV3/workdocs-2016-05-01/GetFolder

Amazon WorkDocs API ReferenceGetFolderPath

GetFolderPathRetrieves the path information (the hierarchy from the root folder) for the specified folder.

By default, Amazon WorkDocs returns a maximum of 100 levels upwards from the requested folder andonly includes the IDs of the parent folders in the path. You can limit the maximum number of levels. Youcan also request the parent folder names.

Request SyntaxGET /api/v1/folders/FolderId/path?fields=Fields&limit=Limit&marker=Marker HTTP/1.1Authentication: AuthenticationToken




Length Constraints: Minimum length of 1. Maximum length of 8199.Fields (p. 97)

A comma-separated list of values. Specify "NAME" to include the names of the parent folders.


Pattern: [\w,]+FolderId (p. 97)



Pattern: [&\w+-.@]+


The maximum number of levels in the hierarchy to return.


This value is not supported.






{ "Path": { "Components": [ { "Id": "string", "Name": "string" } ] }}



Path (p. 98)

The path information.

Type: ResourcePath (p. 148) object


















https://docs.aws.amazon.com/goto/aws-cli/workdocs-2016-05-01/GetFolderPath

https://docs.aws.amazon.com/goto/DotNetSDKV3/workdocs-2016-05-01/GetFolderPath

https://docs.aws.amazon.com/goto/SdkForCpp/workdocs-2016-05-01/GetFolderPath

https://docs.aws.amazon.com/goto/SdkForGoV1/workdocs-2016-05-01/GetFolderPath

https://docs.aws.amazon.com/goto/SdkForJavaV2/workdocs-2016-05-01/GetFolderPath

https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/workdocs-2016-05-01/GetFolderPath

https://docs.aws.amazon.com/goto/SdkForPHPV3/workdocs-2016-05-01/GetFolderPath

https://docs.aws.amazon.com/goto/boto3/workdocs-2016-05-01/GetFolderPath

https://docs.aws.amazon.com/goto/SdkForRubyV3/workdocs-2016-05-01/GetFolderPath

Amazon WorkDocs API ReferenceGetResources

GetResourcesRetrieves a collection of resources, including folders and documents. The only CollectionTypesupported is SHARED_WITH_ME.

Request SyntaxGET /api/v1/resources?collectionType=CollectionType&limit=Limit&marker=Marker&userId=UserId HTTP/1.1Authentication: AuthenticationToken



The Amazon WorkDocs authentication token. Not required when using AWS administratorcredentials to access the API.

Length Constraints: Minimum length of 1. Maximum length of 8199.CollectionType (p. 100)

The collection type.

Valid Values: SHARED_WITH_MELimit (p. 100)

The maximum number of resources to return.




The user ID for the resource collection. This is a required field for accessing the API operation usingIAM credentials.


Pattern: [&\w+-.@]+





{ "Documents": [ { "CreatedTimestamp": number, "CreatorId": "string", "Id": "string", "Labels": [ "string" ], "LatestVersionMetadata": { "ContentCreatedTimestamp": number, "ContentModifiedTimestamp": number, "ContentType": "string", "CreatedTimestamp": number, "CreatorId": "string", "Id": "string", "ModifiedTimestamp": number, "Name": "string", "Signature": "string", "Size": number, "Source": { "string" : "string" }, "Status": "string", "Thumbnail": { "string" : "string" } }, "ModifiedTimestamp": number, "ParentFolderId": "string", "ResourceState": "string" } ], "Folders": [ { "CreatedTimestamp": number, "CreatorId": "string", "Id": "string", "Labels": [ "string" ], "LatestVersionSize": number, "ModifiedTimestamp": number, "Name": "string", "ParentFolderId": "string", "ResourceState": "string", "Signature": "string", "Size": number } ], "Marker": "string"}



Documents (p. 100)

The documents in the specified collection.

Type: Array of DocumentMetadata (p. 133) objectsFolders (p. 100)

The folders in the specified folder.





Type: String

















https://docs.aws.amazon.com/goto/aws-cli/workdocs-2016-05-01/GetResources

https://docs.aws.amazon.com/goto/DotNetSDKV3/workdocs-2016-05-01/GetResources

https://docs.aws.amazon.com/goto/SdkForCpp/workdocs-2016-05-01/GetResources

https://docs.aws.amazon.com/goto/SdkForGoV1/workdocs-2016-05-01/GetResources

https://docs.aws.amazon.com/goto/SdkForJavaV2/workdocs-2016-05-01/GetResources

https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/workdocs-2016-05-01/GetResources

https://docs.aws.amazon.com/goto/SdkForPHPV3/workdocs-2016-05-01/GetResources

https://docs.aws.amazon.com/goto/boto3/workdocs-2016-05-01/GetResources

https://docs.aws.amazon.com/goto/SdkForRubyV3/workdocs-2016-05-01/GetResources

Amazon WorkDocs API ReferenceInitiateDocumentVersionUpload

InitiateDocumentVersionUploadCreates a new document object and version object.

The client specifies the parent folder ID and name of the document to upload. The ID is optionallyspecified when creating a new version of an existing document. This is the first step to uploada document. Next, upload the document to the URL returned from the call, and then callUpdateDocumentVersion (p. 116).

To cancel the document upload, call AbortDocumentVersionUpload (p. 4).

Request SyntaxPOST /api/v1/documents HTTP/1.1Authentication: AuthenticationTokenContent-type: application/json

{ "ContentCreatedTimestamp": number, "ContentModifiedTimestamp": number, "ContentType": "string", "DocumentSizeInBytes": number, "Id": "string", "Name": "string", "ParentFolderId": "string"}






ContentCreatedTimestamp (p. 104)

The timestamp when the content of the document was originally created.

Type: Timestamp

Required: NoContentModifiedTimestamp (p. 104)

The timestamp when the content of the document was modified.

Type: Timestamp

Required: No



ContentType (p. 104)

The content type of the document.

Type: String


Required: NoDocumentSizeInBytes (p. 104)

The size of the document, in bytes.

Type: Long

Required: NoId (p. 104)


Type: String


Pattern: [\w+-.@]+

Required: NoName (p. 104)

The name of the document.

Type: String





Type: String


Pattern: [\w+-.@]+

Required: Yes


{ "Metadata": { "CreatedTimestamp": number, "CreatorId": "string",



"Id": "string", "Labels": [ "string" ], "LatestVersionMetadata": { "ContentCreatedTimestamp": number, "ContentModifiedTimestamp": number, "ContentType": "string", "CreatedTimestamp": number, "CreatorId": "string", "Id": "string", "ModifiedTimestamp": number, "Name": "string", "Signature": "string", "Size": number, "Source": { "string" : "string" }, "Status": "string", "Thumbnail": { "string" : "string" } }, "ModifiedTimestamp": number, "ParentFolderId": "string", "ResourceState": "string" }, "UploadMetadata": { "SignedHeaders": { "string" : "string" }, "UploadUrl": "string" }}



Metadata (p. 105)

The document metadata.

Type: DocumentMetadata (p. 133) objectUploadMetadata (p. 105)

The upload metadata.

Type: UploadMetadata (p. 155) object


DraftUploadOutOfSyncException

This exception is thrown when a valid checkout ID is not presented on document version upload callsfor a document that has been checked out from Web client.




EntityAlreadyExistsException








HTTP Status Code: 409ResourceAlreadyCheckedOutException

The resource is already checked out.



HTTP Status Code: 503StorageLimitExceededException

The storage limit has been exceeded.

HTTP Status Code: 409StorageLimitWillExceedException

The storage limit will be exceeded.







• AWS Command Line Interface


https://docs.aws.amazon.com/goto/aws-cli/workdocs-2016-05-01/InitiateDocumentVersionUpload


• AWS SDK for .NET• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java V2• AWS SDK for JavaScript• AWS SDK for PHP V3• AWS SDK for Python• AWS SDK for Ruby V3


https://docs.aws.amazon.com/goto/DotNetSDKV3/workdocs-2016-05-01/InitiateDocumentVersionUpload

https://docs.aws.amazon.com/goto/SdkForCpp/workdocs-2016-05-01/InitiateDocumentVersionUpload

https://docs.aws.amazon.com/goto/SdkForGoV1/workdocs-2016-05-01/InitiateDocumentVersionUpload

https://docs.aws.amazon.com/goto/SdkForJavaV2/workdocs-2016-05-01/InitiateDocumentVersionUpload

https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/workdocs-2016-05-01/InitiateDocumentVersionUpload

https://docs.aws.amazon.com/goto/SdkForPHPV3/workdocs-2016-05-01/InitiateDocumentVersionUpload

https://docs.aws.amazon.com/goto/boto3/workdocs-2016-05-01/InitiateDocumentVersionUpload

https://docs.aws.amazon.com/goto/SdkForRubyV3/workdocs-2016-05-01/InitiateDocumentVersionUpload

Amazon WorkDocs API ReferenceRemoveAllResourcePermissions

RemoveAllResourcePermissionsRemoves all the permissions from the specified resource.

Request SyntaxDELETE /api/v1/resources/ResourceId/permissions HTTP/1.1Authentication: AuthenticationToken







Pattern: [\w+-.@]+

Required: Yes




















https://docs.aws.amazon.com/goto/aws-cli/workdocs-2016-05-01/RemoveAllResourcePermissions

https://docs.aws.amazon.com/goto/DotNetSDKV3/workdocs-2016-05-01/RemoveAllResourcePermissions

https://docs.aws.amazon.com/goto/SdkForCpp/workdocs-2016-05-01/RemoveAllResourcePermissions

https://docs.aws.amazon.com/goto/SdkForGoV1/workdocs-2016-05-01/RemoveAllResourcePermissions

https://docs.aws.amazon.com/goto/SdkForJavaV2/workdocs-2016-05-01/RemoveAllResourcePermissions

https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/workdocs-2016-05-01/RemoveAllResourcePermissions

https://docs.aws.amazon.com/goto/SdkForPHPV3/workdocs-2016-05-01/RemoveAllResourcePermissions

https://docs.aws.amazon.com/goto/boto3/workdocs-2016-05-01/RemoveAllResourcePermissions

https://docs.aws.amazon.com/goto/SdkForRubyV3/workdocs-2016-05-01/RemoveAllResourcePermissions

Amazon WorkDocs API ReferenceRemoveResourcePermission

RemoveResourcePermissionRemoves the permission for the specified principal from the specified resource.

Request SyntaxDELETE /api/v1/resources/ResourceId/permissions/PrincipalId?type=PrincipalType HTTP/1.1Authentication: AuthenticationToken




Length Constraints: Minimum length of 1. Maximum length of 8199.PrincipalId (p. 111)

The principal ID of the resource.


Pattern: [&\w+-.@]+

Required: YesPrincipalType (p. 111)

The principal type of the resource.

Valid Values: USER | GROUP | INVITE | ANONYMOUS | ORGANIZATIONResourceId (p. 111)



Pattern: [\w+-.@]+

Required: Yes



















https://docs.aws.amazon.com/goto/aws-cli/workdocs-2016-05-01/RemoveResourcePermission

https://docs.aws.amazon.com/goto/DotNetSDKV3/workdocs-2016-05-01/RemoveResourcePermission

https://docs.aws.amazon.com/goto/SdkForCpp/workdocs-2016-05-01/RemoveResourcePermission

https://docs.aws.amazon.com/goto/SdkForGoV1/workdocs-2016-05-01/RemoveResourcePermission

https://docs.aws.amazon.com/goto/SdkForJavaV2/workdocs-2016-05-01/RemoveResourcePermission

https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/workdocs-2016-05-01/RemoveResourcePermission

https://docs.aws.amazon.com/goto/SdkForPHPV3/workdocs-2016-05-01/RemoveResourcePermission

https://docs.aws.amazon.com/goto/boto3/workdocs-2016-05-01/RemoveResourcePermission

https://docs.aws.amazon.com/goto/SdkForRubyV3/workdocs-2016-05-01/RemoveResourcePermission

Amazon WorkDocs API ReferenceUpdateDocument

UpdateDocumentUpdates the specified attributes of a document. The user must have access to both the document and itsparent folder, if applicable.

Request SyntaxPATCH /api/v1/documents/DocumentId HTTP/1.1Authentication: AuthenticationTokenContent-type: application/json

{ "Name": "string", "ParentFolderId": "string", "ResourceState": "string"}







Pattern: [\w+-.@]+

Required: Yes


Name (p. 113)

The name of the document.

Type: String







Type: String


Pattern: [\w+-.@]+

Required: NoResourceState (p. 113)

The resource state of the document. Only ACTIVE and RECYCLED are supported.

Type: String

Valid Values: ACTIVE | RESTORING | RECYCLING | RECYCLED

Required: No

















LimitExceededException














https://docs.aws.amazon.com/goto/aws-cli/workdocs-2016-05-01/UpdateDocument

https://docs.aws.amazon.com/goto/DotNetSDKV3/workdocs-2016-05-01/UpdateDocument

https://docs.aws.amazon.com/goto/SdkForCpp/workdocs-2016-05-01/UpdateDocument

https://docs.aws.amazon.com/goto/SdkForGoV1/workdocs-2016-05-01/UpdateDocument

https://docs.aws.amazon.com/goto/SdkForJavaV2/workdocs-2016-05-01/UpdateDocument

https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/workdocs-2016-05-01/UpdateDocument

https://docs.aws.amazon.com/goto/SdkForPHPV3/workdocs-2016-05-01/UpdateDocument

https://docs.aws.amazon.com/goto/boto3/workdocs-2016-05-01/UpdateDocument

https://docs.aws.amazon.com/goto/SdkForRubyV3/workdocs-2016-05-01/UpdateDocument

Amazon WorkDocs API ReferenceUpdateDocumentVersion

UpdateDocumentVersionChanges the status of the document version to ACTIVE.

Amazon WorkDocs also sets its document container to ACTIVE. This is the last step in adocument upload, after the client uploads the document to an S3-presigned URL returned byInitiateDocumentVersionUpload (p. 104).

Request SyntaxPATCH /api/v1/documents/DocumentId/versions/VersionId HTTP/1.1Authentication: AuthenticationTokenContent-type: application/json

{ "VersionStatus": "string"}







Pattern: [\w+-.@]+


The version ID of the document.


Pattern: [\w+-.@]+

Required: Yes


VersionStatus (p. 116)

The status of the version.

Type: String



Valid Values: ACTIVE

Required: No










HTTP Status Code: 424InvalidOperationException

The operation is invalid.















https://docs.aws.amazon.com/goto/aws-cli/workdocs-2016-05-01/UpdateDocumentVersion

https://docs.aws.amazon.com/goto/DotNetSDKV3/workdocs-2016-05-01/UpdateDocumentVersion

https://docs.aws.amazon.com/goto/SdkForCpp/workdocs-2016-05-01/UpdateDocumentVersion

https://docs.aws.amazon.com/goto/SdkForGoV1/workdocs-2016-05-01/UpdateDocumentVersion

https://docs.aws.amazon.com/goto/SdkForJavaV2/workdocs-2016-05-01/UpdateDocumentVersion

https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/workdocs-2016-05-01/UpdateDocumentVersion

https://docs.aws.amazon.com/goto/SdkForPHPV3/workdocs-2016-05-01/UpdateDocumentVersion

https://docs.aws.amazon.com/goto/boto3/workdocs-2016-05-01/UpdateDocumentVersion

https://docs.aws.amazon.com/goto/SdkForRubyV3/workdocs-2016-05-01/UpdateDocumentVersion

Amazon WorkDocs API ReferenceUpdateFolder

UpdateFolderUpdates the specified attributes of the specified folder. The user must have access to both the folder andits parent folder, if applicable.

Request SyntaxPATCH /api/v1/folders/FolderId HTTP/1.1Authentication: AuthenticationTokenContent-type: application/json

{ "Name": "string", "ParentFolderId": "string", "ResourceState": "string"}







Pattern: [\w+-.@]+

Required: Yes


Name (p. 119)

The name of the folder.

Type: String







Type: String


Pattern: [\w+-.@]+

Required: NoResourceState (p. 119)

The resource state of the folder. Only ACTIVE and RECYCLED are accepted values from the API.

Type: String


Required: No

















LimitExceededException














https://docs.aws.amazon.com/goto/aws-cli/workdocs-2016-05-01/UpdateFolder

https://docs.aws.amazon.com/goto/DotNetSDKV3/workdocs-2016-05-01/UpdateFolder

https://docs.aws.amazon.com/goto/SdkForCpp/workdocs-2016-05-01/UpdateFolder

https://docs.aws.amazon.com/goto/SdkForGoV1/workdocs-2016-05-01/UpdateFolder

https://docs.aws.amazon.com/goto/SdkForJavaV2/workdocs-2016-05-01/UpdateFolder

https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/workdocs-2016-05-01/UpdateFolder

https://docs.aws.amazon.com/goto/SdkForPHPV3/workdocs-2016-05-01/UpdateFolder

https://docs.aws.amazon.com/goto/boto3/workdocs-2016-05-01/UpdateFolder

https://docs.aws.amazon.com/goto/SdkForRubyV3/workdocs-2016-05-01/UpdateFolder

Amazon WorkDocs API ReferenceUpdateUser

UpdateUserUpdates the specified attributes of the specified user, and grants or revokes administrative privileges tothe Amazon WorkDocs site.

Request SyntaxPATCH /api/v1/users/UserId HTTP/1.1Authentication: AuthenticationTokenContent-type: application/json

{ "GivenName": "string", "GrantPoweruserPrivileges": "string", "Locale": "string", "StorageRule": { "StorageAllocatedInBytes": number, "StorageType": "string" }, "Surname": "string", "TimeZoneId": "string", "Type": "string"}





The ID of the user.


Pattern: [&\w+-.@]+

Required: Yes


GivenName (p. 122)


Type: String


Required: No



{ "User": { "CreatedTimestamp": number, "EmailAddress": "string", "GivenName": "string", "Id": "string", "Locale": "string", "ModifiedTimestamp": number, "OrganizationId": "string", "RecycleBinFolderId": "string", "RootFolderId": "string", "Status": "string", "Storage": { "StorageRule": { "StorageAllocatedInBytes": number, "StorageType": "string" }, "StorageUtilizedInBytes": number }, "Surname": "string", "TimeZoneId": "string", "Type": "string", "Username": "string" }}



User (p. 123)




DeactivatingLastSystemUserException

The last user in the organization is being deactivated.








IllegalUserStateException

The user is undergoing transfer of ownership.













https://docs.aws.amazon.com/goto/aws-cli/workdocs-2016-05-01/UpdateUser

https://docs.aws.amazon.com/goto/DotNetSDKV3/workdocs-2016-05-01/UpdateUser

https://docs.aws.amazon.com/goto/SdkForCpp/workdocs-2016-05-01/UpdateUser

https://docs.aws.amazon.com/goto/SdkForGoV1/workdocs-2016-05-01/UpdateUser

https://docs.aws.amazon.com/goto/SdkForJavaV2/workdocs-2016-05-01/UpdateUser

https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/workdocs-2016-05-01/UpdateUser

https://docs.aws.amazon.com/goto/SdkForPHPV3/workdocs-2016-05-01/UpdateUser

https://docs.aws.amazon.com/goto/boto3/workdocs-2016-05-01/UpdateUser

https://docs.aws.amazon.com/goto/SdkForRubyV3/workdocs-2016-05-01/UpdateUser


Data TypesThe Amazon WorkDocs API contains several data types that various actions use. This section describeseach data type in detail.

NoteThe order of each element in a data type structure is not guaranteed. Applications should notassume a particular order.

The following data types are supported:

• Activity (p. 127)• Comment (p. 129)• CommentMetadata (p. 131)• DocumentMetadata (p. 133)• DocumentVersionMetadata (p. 135)• FolderMetadata (p. 138)• GroupMetadata (p. 141)• NotificationOptions (p. 142)• Participants (p. 143)• PermissionInfo (p. 144)• Principal (p. 145)• ResourceMetadata (p. 146)• ResourcePath (p. 148)• ResourcePathComponent (p. 149)• SharePrincipal (p. 150)• ShareResult (p. 151)• StorageRuleType (p. 153)• Subscription (p. 154)• UploadMetadata (p. 155)• User (p. 156)• UserMetadata (p. 159)• UserStorageMetadata (p. 161)


Amazon WorkDocs API ReferenceActivity

ActivityDescribes the activity information.

ContentsCommentMetadata

Metadata of the commenting activity. This is an optional field and is filled for commenting activities.

Type: CommentMetadata (p. 131) object

Required: NoInitiator

The user who performed the action.

Type: UserMetadata (p. 159) object

Required: NoIsIndirectActivity

Indicates whether an activity is indirect or direct. An indirect activity results from a direct activityperformed on a parent resource. For example, sharing a parent folder (the direct activity) shares allof the subfolders and documents within the parent folder (the indirect activity).

Type: Boolean

Required: NoOrganizationId


Type: String


Pattern: [&\w+-.@]+

Required: NoOriginalParent

The original parent of the resource. This is an optional field and is filled for move activities.

Type: ResourceMetadata (p. 146) object

Required: NoParticipants

The list of users or groups impacted by this action. This is an optional field and is filled for thefollowing sharing activities: DOCUMENT_SHARED, DOCUMENT_SHARED, DOCUMENT_UNSHARED,FOLDER_SHARED, FOLDER_UNSHARED.

Type: Participants (p. 143) object

Required: NoResourceMetadata

The metadata of the resource involved in the user action.


Amazon WorkDocs API ReferenceComment

CommentDescribes a comment.

ContentsCommentId


Type: String


Pattern: [\w+-.@]+

Required: YesContributor

The details of the user who made the comment.


Required: NoCreatedTimestamp

The time that the comment was created.

Type: Timestamp

Required: NoParentId

The ID of the parent comment.

Type: String


Pattern: [\w+-.@]+

Required: NoRecipientId

If the comment is a reply to another user's comment, this field contains the user ID of the user beingreplied to.

Type: String


Pattern: [&\w+-.@]+

Required: NoStatus

The status of the comment.

Type: String



Valid Values: DRAFT | PUBLISHED | DELETED

Required: NoText

The text of the comment.

Type: String


Required: NoThreadId

The ID of the root comment in the thread.

Type: String


Pattern: [\w+-.@]+

Required: NoVisibility

The visibility of the comment. Options are either PRIVATE, where the comment is visible only to thecomment author and document owner and co-owners, or PUBLIC, where the comment is visible todocument owners, co-owners, and contributors.

Type: String

Valid Values: PUBLIC | PRIVATE

Required: No




https://docs.aws.amazon.com/goto/SdkForCpp/workdocs-2016-05-01/Comment

https://docs.aws.amazon.com/goto/SdkForGoV1/workdocs-2016-05-01/Comment

https://docs.aws.amazon.com/goto/SdkForJavaV2/workdocs-2016-05-01/Comment

https://docs.aws.amazon.com/goto/SdkForRubyV3/workdocs-2016-05-01/Comment

Amazon WorkDocs API ReferenceCommentMetadata

CommentMetadataDescribes the metadata of a comment.

ContentsCommentId


Type: String


Pattern: [\w+-.@]+

Required: NoCommentStatus

The status of the comment.

Type: String

Valid Values: DRAFT | PUBLISHED | DELETED

Required: NoContributor

The user who made the comment.



The timestamp that the comment was created.

Type: Timestamp

Required: NoRecipientId

The ID of the user being replied to.

Type: String


Pattern: [&\w+-.@]+

Required: No


• AWS SDK for C++


https://docs.aws.amazon.com/goto/SdkForCpp/workdocs-2016-05-01/CommentMetadata


• AWS SDK for Go• AWS SDK for Java V2• AWS SDK for Ruby V3


https://docs.aws.amazon.com/goto/SdkForGoV1/workdocs-2016-05-01/CommentMetadata

https://docs.aws.amazon.com/goto/SdkForJavaV2/workdocs-2016-05-01/CommentMetadata

https://docs.aws.amazon.com/goto/SdkForRubyV3/workdocs-2016-05-01/CommentMetadata

Amazon WorkDocs API ReferenceDocumentMetadata

DocumentMetadataDescribes the document.

ContentsCreatedTimestamp

The time when the document was created.

Type: Timestamp

Required: NoCreatorId

The ID of the creator.

Type: String


Pattern: [&\w+-.@]+

Required: NoId


Type: String


Pattern: [\w+-.@]+

Required: NoLabels

List of labels on the document.





Required: NoLatestVersionMetadata

The latest version of the document.

Type: DocumentVersionMetadata (p. 135) object

Required: NoModifiedTimestamp

The time when the document was updated.



Type: Timestamp

Required: NoParentFolderId


Type: String


Pattern: [\w+-.@]+

Required: NoResourceState

The resource state.

Type: String


Required: No




https://docs.aws.amazon.com/goto/SdkForCpp/workdocs-2016-05-01/DocumentMetadata

https://docs.aws.amazon.com/goto/SdkForGoV1/workdocs-2016-05-01/DocumentMetadata

https://docs.aws.amazon.com/goto/SdkForJavaV2/workdocs-2016-05-01/DocumentMetadata

https://docs.aws.amazon.com/goto/SdkForRubyV3/workdocs-2016-05-01/DocumentMetadata

Amazon WorkDocs API ReferenceDocumentVersionMetadata

DocumentVersionMetadataDescribes a version of a document.

ContentsContentCreatedTimestamp

The timestamp when the content of the document was originally created.

Type: Timestamp

Required: NoContentModifiedTimestamp

The timestamp when the content of the document was modified.

Type: Timestamp

Required: NoContentType

The content type of the document.

Type: String



The timestamp when the document was first uploaded.

Type: Timestamp



Type: String


Pattern: [&\w+-.@]+

Required: NoId

The ID of the version.

Type: String


Pattern: [\w+-.@]+

Required: No


Amazon WorkDocs API ReferenceContents

ModifiedTimestamp

The timestamp when the document was last uploaded.

Type: Timestamp

Required: NoName

The name of the version.

Type: String



Required: NoSignature

The signature of the document.

Type: String


Pattern: [&\w+-.@]+

Required: NoSize

The size of the document, in bytes.

Type: Long

Required: NoSource

The source of the document.


Valid Keys: ORIGINAL | WITH_COMMENTS


Required: NoStatus

The status of the document.

Type: String

Valid Values: INITIALIZED | ACTIVE

Required: NoThumbnail

The thumbnail of the document.




Valid Keys: SMALL | SMALL_HQ | LARGE


Required: No




https://docs.aws.amazon.com/goto/SdkForCpp/workdocs-2016-05-01/DocumentVersionMetadata

https://docs.aws.amazon.com/goto/SdkForGoV1/workdocs-2016-05-01/DocumentVersionMetadata

https://docs.aws.amazon.com/goto/SdkForJavaV2/workdocs-2016-05-01/DocumentVersionMetadata

https://docs.aws.amazon.com/goto/SdkForRubyV3/workdocs-2016-05-01/DocumentVersionMetadata

Amazon WorkDocs API ReferenceFolderMetadata

FolderMetadataDescribes a folder.


The time when the folder was created.

Type: Timestamp



Type: String


Pattern: [&\w+-.@]+

Required: NoId


Type: String


Pattern: [\w+-.@]+

Required: NoLabels

List of labels on the folder.





Required: NoLatestVersionSize

The size of the latest version of the folder metadata.

Type: Long


The time when the folder was updated.



Type: Timestamp

Required: NoName

The name of the folder.

Type: String



Required: NoParentFolderId


Type: String


Pattern: [\w+-.@]+

Required: NoResourceState

The resource state of the folder.

Type: String


Required: NoSignature

The unique identifier created from the subfolders and documents of the folder.

Type: String


Pattern: [&\w+-.@]+

Required: NoSize

The size of the folder metadata.

Type: Long

Required: No


• AWS SDK for C++• AWS SDK for Go


https://docs.aws.amazon.com/goto/SdkForCpp/workdocs-2016-05-01/FolderMetadata

https://docs.aws.amazon.com/goto/SdkForGoV1/workdocs-2016-05-01/FolderMetadata


• AWS SDK for Java V2• AWS SDK for Ruby V3


https://docs.aws.amazon.com/goto/SdkForJavaV2/workdocs-2016-05-01/FolderMetadata

https://docs.aws.amazon.com/goto/SdkForRubyV3/workdocs-2016-05-01/FolderMetadata

Amazon WorkDocs API ReferenceGroupMetadata

GroupMetadataDescribes the metadata of a user group.

ContentsId

The ID of the user group.

Type: String


Pattern: [&\w+-.@]+

Required: NoName

The name of the group.

Type: String

Required: No




https://docs.aws.amazon.com/goto/SdkForCpp/workdocs-2016-05-01/GroupMetadata

https://docs.aws.amazon.com/goto/SdkForGoV1/workdocs-2016-05-01/GroupMetadata

https://docs.aws.amazon.com/goto/SdkForJavaV2/workdocs-2016-05-01/GroupMetadata

https://docs.aws.amazon.com/goto/SdkForRubyV3/workdocs-2016-05-01/GroupMetadata

Amazon WorkDocs API ReferenceNotificationOptions

NotificationOptionsSet of options which defines notification preferences of given action.

ContentsEmailMessage

Text value to be included in the email body.

Type: String


Required: NoSendEmail

Boolean value to indicate an email notification should be sent to the receipients.

Type: Boolean

Required: No




https://docs.aws.amazon.com/goto/SdkForCpp/workdocs-2016-05-01/NotificationOptions

https://docs.aws.amazon.com/goto/SdkForGoV1/workdocs-2016-05-01/NotificationOptions

https://docs.aws.amazon.com/goto/SdkForJavaV2/workdocs-2016-05-01/NotificationOptions

https://docs.aws.amazon.com/goto/SdkForRubyV3/workdocs-2016-05-01/NotificationOptions

Amazon WorkDocs API ReferenceParticipants

ParticipantsDescribes the users or user groups.

ContentsGroups

The list of user groups.

Type: Array of GroupMetadata (p. 141) objects

Required: NoUsers

The list of users.

Type: Array of UserMetadata (p. 159) objects

Required: No




https://docs.aws.amazon.com/goto/SdkForCpp/workdocs-2016-05-01/Participants

https://docs.aws.amazon.com/goto/SdkForGoV1/workdocs-2016-05-01/Participants

https://docs.aws.amazon.com/goto/SdkForJavaV2/workdocs-2016-05-01/Participants

https://docs.aws.amazon.com/goto/SdkForRubyV3/workdocs-2016-05-01/Participants

Amazon WorkDocs API ReferencePermissionInfo

PermissionInfoDescribes the permissions.

ContentsRole

The role of the user.

Type: String

Valid Values: VIEWER | CONTRIBUTOR | OWNER | COOWNER

Required: NoType

The type of permissions.

Type: String

Valid Values: DIRECT | INHERITED

Required: No




https://docs.aws.amazon.com/goto/SdkForCpp/workdocs-2016-05-01/PermissionInfo

https://docs.aws.amazon.com/goto/SdkForGoV1/workdocs-2016-05-01/PermissionInfo

https://docs.aws.amazon.com/goto/SdkForJavaV2/workdocs-2016-05-01/PermissionInfo

https://docs.aws.amazon.com/goto/SdkForRubyV3/workdocs-2016-05-01/PermissionInfo

Amazon WorkDocs API ReferencePrincipal

PrincipalDescribes a resource.

ContentsId


Type: String


Pattern: [&\w+-.@]+

Required: NoRoles

The permission information for the resource.

Type: Array of PermissionInfo (p. 144) objects

Required: NoType

The type of resource.

Type: String

Valid Values: USER | GROUP | INVITE | ANONYMOUS | ORGANIZATION

Required: No




https://docs.aws.amazon.com/goto/SdkForCpp/workdocs-2016-05-01/Principal

https://docs.aws.amazon.com/goto/SdkForGoV1/workdocs-2016-05-01/Principal

https://docs.aws.amazon.com/goto/SdkForJavaV2/workdocs-2016-05-01/Principal

https://docs.aws.amazon.com/goto/SdkForRubyV3/workdocs-2016-05-01/Principal

Amazon WorkDocs API ReferenceResourceMetadata

ResourceMetadataDescribes the metadata of a resource.

ContentsId


Type: String


Pattern: [\w+-.@]+

Required: NoName

The name of the resource.

Type: String



Required: NoOriginalName

The original name of the resource before a rename operation.

Type: String



Required: NoOwner

The owner of the resource.

Type: UserMetadata (p. 159) object

Required: NoParentId

The parent ID of the resource before a rename operation.

Type: String


Pattern: [\w+-.@]+

Required: No



Type

The type of resource.

Type: String

Valid Values: FOLDER | DOCUMENT

Required: NoVersionId

The version ID of the resource. This is an optional field and is filled for action on document version.

Type: String


Pattern: [\w+-.@]+

Required: No




https://docs.aws.amazon.com/goto/SdkForCpp/workdocs-2016-05-01/ResourceMetadata

https://docs.aws.amazon.com/goto/SdkForGoV1/workdocs-2016-05-01/ResourceMetadata

https://docs.aws.amazon.com/goto/SdkForJavaV2/workdocs-2016-05-01/ResourceMetadata

https://docs.aws.amazon.com/goto/SdkForRubyV3/workdocs-2016-05-01/ResourceMetadata

Amazon WorkDocs API ReferenceResourcePath

ResourcePathDescribes the path information of a resource.

ContentsComponents

The components of the resource path.

Type: Array of ResourcePathComponent (p. 149) objects

Required: No




https://docs.aws.amazon.com/goto/SdkForCpp/workdocs-2016-05-01/ResourcePath

https://docs.aws.amazon.com/goto/SdkForGoV1/workdocs-2016-05-01/ResourcePath

https://docs.aws.amazon.com/goto/SdkForJavaV2/workdocs-2016-05-01/ResourcePath

https://docs.aws.amazon.com/goto/SdkForRubyV3/workdocs-2016-05-01/ResourcePath

Amazon WorkDocs API ReferenceResourcePathComponent

ResourcePathComponentDescribes the resource path.

ContentsId

The ID of the resource path.

Type: String


Pattern: [&\w+-.@]+

Required: NoName

The name of the resource path.

Type: String



Required: No




https://docs.aws.amazon.com/goto/SdkForCpp/workdocs-2016-05-01/ResourcePathComponent

https://docs.aws.amazon.com/goto/SdkForGoV1/workdocs-2016-05-01/ResourcePathComponent

https://docs.aws.amazon.com/goto/SdkForJavaV2/workdocs-2016-05-01/ResourcePathComponent

https://docs.aws.amazon.com/goto/SdkForRubyV3/workdocs-2016-05-01/ResourcePathComponent

Amazon WorkDocs API ReferenceSharePrincipal

SharePrincipalDescribes the recipient type and ID, if available.

ContentsId

The ID of the recipient.

Type: String


Pattern: [&\w+-.@]+

Required: YesRole

The role of the recipient.

Type: String


Required: YesType

The type of the recipient.

Type: String

Valid Values: USER | GROUP | INVITE | ANONYMOUS | ORGANIZATION

Required: Yes




https://docs.aws.amazon.com/goto/SdkForCpp/workdocs-2016-05-01/SharePrincipal

https://docs.aws.amazon.com/goto/SdkForGoV1/workdocs-2016-05-01/SharePrincipal

https://docs.aws.amazon.com/goto/SdkForJavaV2/workdocs-2016-05-01/SharePrincipal

https://docs.aws.amazon.com/goto/SdkForRubyV3/workdocs-2016-05-01/SharePrincipal

Amazon WorkDocs API ReferenceShareResult

ShareResultDescribes the share results of a resource.

ContentsInviteePrincipalId

The ID of the invited user.

Type: String


Pattern: [&\w+-.@]+

Required: NoPrincipalId

The ID of the principal.

Type: String


Pattern: [&\w+-.@]+

Required: NoRole

The role.

Type: String


Required: NoShareId

The ID of the resource that was shared.

Type: String


Pattern: [\w+-.@]+

Required: NoStatus

The status.

Type: String

Valid Values: SUCCESS | FAILURE

Required: No



StatusMessage

The status message.

Type: String


Required: No




https://docs.aws.amazon.com/goto/SdkForCpp/workdocs-2016-05-01/ShareResult

https://docs.aws.amazon.com/goto/SdkForGoV1/workdocs-2016-05-01/ShareResult

https://docs.aws.amazon.com/goto/SdkForJavaV2/workdocs-2016-05-01/ShareResult

https://docs.aws.amazon.com/goto/SdkForRubyV3/workdocs-2016-05-01/ShareResult

Amazon WorkDocs API ReferenceStorageRuleType

StorageRuleTypeDescribes the storage for a user.

ContentsStorageAllocatedInBytes

The amount of storage allocated, in bytes.

Type: Long

Valid Range: Minimum value of 0.

Required: NoStorageType

The type of storage.

Type: String

Valid Values: UNLIMITED | QUOTA

Required: No




https://docs.aws.amazon.com/goto/SdkForCpp/workdocs-2016-05-01/StorageRuleType

https://docs.aws.amazon.com/goto/SdkForGoV1/workdocs-2016-05-01/StorageRuleType

https://docs.aws.amazon.com/goto/SdkForJavaV2/workdocs-2016-05-01/StorageRuleType

https://docs.aws.amazon.com/goto/SdkForRubyV3/workdocs-2016-05-01/StorageRuleType

Amazon WorkDocs API ReferenceSubscription

SubscriptionDescribes a subscription.

ContentsEndPoint

The endpoint of the subscription.

Type: String


Required: NoProtocol

The protocol of the subscription.

Type: String

Valid Values: HTTPS

Required: NoSubscriptionId

The ID of the subscription.

Type: String


Pattern: [&\w+-.@]+

Required: No




https://docs.aws.amazon.com/goto/SdkForCpp/workdocs-2016-05-01/Subscription

https://docs.aws.amazon.com/goto/SdkForGoV1/workdocs-2016-05-01/Subscription

https://docs.aws.amazon.com/goto/SdkForJavaV2/workdocs-2016-05-01/Subscription

https://docs.aws.amazon.com/goto/SdkForRubyV3/workdocs-2016-05-01/Subscription

Amazon WorkDocs API ReferenceUploadMetadata

UploadMetadataDescribes the upload.

ContentsSignedHeaders

The signed headers.



Key Pattern: [\w-]+


Required: NoUploadUrl

The URL of the upload.

Type: String


Required: No




https://docs.aws.amazon.com/goto/SdkForCpp/workdocs-2016-05-01/UploadMetadata

https://docs.aws.amazon.com/goto/SdkForGoV1/workdocs-2016-05-01/UploadMetadata

https://docs.aws.amazon.com/goto/SdkForJavaV2/workdocs-2016-05-01/UploadMetadata

https://docs.aws.amazon.com/goto/SdkForRubyV3/workdocs-2016-05-01/UploadMetadata

Amazon WorkDocs API ReferenceUser

UserDescribes a user.


The time when the user was created.

Type: Timestamp

Required: NoEmailAddress


Type: String



Required: NoGivenName


Type: String


Required: NoId

The ID of the user.

Type: String


Pattern: [&\w+-.@]+

Required: NoLocale

The locale of the user.

Type: String

Valid Values: en | fr | ko | de | es | ja | ru | zh_CN | zh_TW | pt_BR |default


The time when the user was modified.


Amazon WorkDocs API ReferenceContents

Type: Timestamp

Required: NoOrganizationId


Type: String


Pattern: [&\w+-.@]+

Required: NoRecycleBinFolderId

The ID of the recycle bin folder.

Type: String


Pattern: [\w+-.@]+

Required: NoRootFolderId

The ID of the root folder.

Type: String


Pattern: [\w+-.@]+

Required: NoStatus

The status of the user.

Type: String

Valid Values: ACTIVE | INACTIVE | PENDING

Required: NoStorage

The storage for the user.

Type: UserStorageMetadata (p. 161) object

Required: NoSurname


Type: String


Required: No



TimeZoneId


Type: String


Required: NoType

The type of user.

Type: String

Valid Values: USER | ADMIN | POWERUSER | MINIMALUSER | WORKSPACESUSER

Required: NoUsername

The login name of the user.

Type: String



Required: No




https://docs.aws.amazon.com/goto/SdkForCpp/workdocs-2016-05-01/User

https://docs.aws.amazon.com/goto/SdkForGoV1/workdocs-2016-05-01/User

https://docs.aws.amazon.com/goto/SdkForJavaV2/workdocs-2016-05-01/User

https://docs.aws.amazon.com/goto/SdkForRubyV3/workdocs-2016-05-01/User

Amazon WorkDocs API ReferenceUserMetadata

UserMetadataDescribes the metadata of the user.

ContentsEmailAddress


Type: String



Required: NoGivenName

The given name of the user before a rename operation.

Type: String


Required: NoId

The ID of the user.

Type: String


Pattern: [&\w+-.@]+

Required: NoSurname


Type: String


Required: NoUsername

The name of the user.

Type: String



Required: No






https://docs.aws.amazon.com/goto/SdkForCpp/workdocs-2016-05-01/UserMetadata

https://docs.aws.amazon.com/goto/SdkForGoV1/workdocs-2016-05-01/UserMetadata

https://docs.aws.amazon.com/goto/SdkForJavaV2/workdocs-2016-05-01/UserMetadata

https://docs.aws.amazon.com/goto/SdkForRubyV3/workdocs-2016-05-01/UserMetadata

Amazon WorkDocs API ReferenceUserStorageMetadata

UserStorageMetadataDescribes the storage for a user.

ContentsStorageRule

The storage for a user.


Required: NoStorageUtilizedInBytes

The amount of storage used, in bytes.

Type: Long

Required: No




https://docs.aws.amazon.com/goto/SdkForCpp/workdocs-2016-05-01/UserStorageMetadata

https://docs.aws.amazon.com/goto/SdkForGoV1/workdocs-2016-05-01/UserStorageMetadata

https://docs.aws.amazon.com/goto/SdkForJavaV2/workdocs-2016-05-01/UserStorageMetadata

https://docs.aws.amazon.com/goto/SdkForRubyV3/workdocs-2016-05-01/UserStorageMetadata


Common ParametersThe following list contains the parameters that all actions use for signing Signature Version 4 requestswith a query string. Any action-specific parameters are listed in the topic for that action. For moreinformation about Signature Version 4, see Signature Version 4 Signing Process in the Amazon WebServices General Reference.

Action

The action to be performed.

Type: string

Required: YesVersion

The API version that the request is written for, expressed in the format YYYY-MM-DD.

Type: string

Required: YesX-Amz-Algorithm

The hash algorithm that you used to create the request signature.

Condition: Specify this parameter when you include authentication information in a query stringinstead of in the HTTP authorization header.

Type: string

Valid Values: AWS4-HMAC-SHA256

Required: ConditionalX-Amz-Credential

The credential scope value, which is a string that includes your access key, the date, the region youare targeting, the service you are requesting, and a termination string ("aws4_request"). The value isexpressed in the following format: access_key/YYYYMMDD/region/service/aws4_request.

For more information, see Task 2: Create a String to Sign for Signature Version 4 in the Amazon WebServices General Reference.


Type: string

Required: ConditionalX-Amz-Date

The date that is used to create the signature. The format must be ISO 8601 basic format(YYYYMMDD'T'HHMMSS'Z'). For example, the following date time is a valid X-Amz-Date value:20120325T120000Z.

Condition: X-Amz-Date is optional for all requests; it can be used to override the date used forsigning requests. If the Date header is specified in the ISO 8601 basic format, X-Amz-Date is


http://docs.aws.amazon.com/general/latest/gr/signature-version-4.html

http://docs.aws.amazon.com/general/latest/gr/sigv4-create-string-to-sign.html


not required. When X-Amz-Date is used, it always overrides the value of the Date header. Formore information, see Handling Dates in Signature Version 4 in the Amazon Web Services GeneralReference.

Type: string

Required: ConditionalX-Amz-Security-Token

The temporary security token that was obtained through a call to AWS Security Token Service (AWSSTS). For a list of services that support temporary security credentials from AWS Security TokenService, go to AWS Services That Work with IAM in the IAM User Guide.

Condition: If you're using temporary security credentials from the AWS Security Token Service, youmust include the security token.

Type: string

Required: ConditionalX-Amz-Signature

Specifies the hex-encoded signature that was calculated from the string to sign and the derivedsigning key.


Type: string

Required: ConditionalX-Amz-SignedHeaders

Specifies all the HTTP headers that were included as part of the canonical request. For moreinformation about specifying signed headers, see Task 1: Create a Canonical Request For SignatureVersion 4 in the Amazon Web Services General Reference.


Type: string

Required: Conditional


http://docs.aws.amazon.com/general/latest/gr/sigv4-date-handling.html

http://docs.aws.amazon.com/IAM/latest/UserGuide/reference_aws-services-that-work-with-iam.html

http://docs.aws.amazon.com/general/latest/gr/sigv4-create-canonical-request.html

http://docs.aws.amazon.com/general/latest/gr/sigv4-create-canonical-request.html


Common ErrorsThis section lists the errors common to the API actions of all AWS services. For errors specific to an APIaction for this service, see the topic for that API action.

AccessDeniedException

You do not have sufficient access to perform this action.

HTTP Status Code: 400IncompleteSignature

The request signature does not conform to AWS standards.

HTTP Status Code: 400InternalFailure

The request processing has failed because of an unknown error, exception or failure.

HTTP Status Code: 500InvalidAction

The action or operation requested is invalid. Verify that the action is typed correctly.

HTTP Status Code: 400InvalidClientTokenId

The X.509 certificate or AWS access key ID provided does not exist in our records.

HTTP Status Code: 403InvalidParameterCombination

Parameters that must not be used together were used together.

HTTP Status Code: 400InvalidParameterValue

An invalid or out-of-range value was supplied for the input parameter.

HTTP Status Code: 400InvalidQueryParameter

The AWS query string is malformed or does not adhere to AWS standards.

HTTP Status Code: 400MalformedQueryString

The query string contains a syntax error.

HTTP Status Code: 404MissingAction

The request is missing an action or a required parameter.




MissingAuthenticationToken

The request must contain either a valid (registered) AWS access key ID or X.509 certificate.

HTTP Status Code: 403MissingParameter

A required parameter for the specified action is not supplied.

HTTP Status Code: 400NotAuthorized

You do not have permission to perform this action.

HTTP Status Code: 400OptInRequired

The AWS access key ID needs a subscription for the service.

HTTP Status Code: 403RequestExpired

The request reached the service more than 15 minutes after the date stamp on the request or morethan 15 minutes after the request expiration date (such as for pre-signed URLs), or the date stampon the request is more than 15 minutes in the future.

HTTP Status Code: 400ServiceUnavailable

The request has failed due to a temporary failure of the server.

HTTP Status Code: 503ThrottlingException

The request was denied due to request throttling.

HTTP Status Code: 400ValidationError

The input fails to satisfy the constraints specified by an AWS service.



Amazon WorkDocs - API Reference · 2020. 8. 20. · structure, as well as allow for basic metadata...

Documents

Transcript of Amazon WorkDocs - API Reference · 2020. 8. 20. · structure, as well as allow for basic metadata...