"documentation":"<p>Aborts the upload of the specified document version that was previously initiated by <a>InitiateDocumentVersionUpload</a>. The client should make this call only when it no longer intends to upload the document version, or fails to do so.</p>"
},
"ActivateUser":{
"name":"ActivateUser",
"http":{
"method":"POST",
"requestUri":"/api/v1/users/{UserId}/activation",
"responseCode":200
},
"input":{"shape":"ActivateUserRequest"},
"output":{"shape":"ActivateUserResponse"},
"errors":[
{"shape":"EntityNotExistsException"},
{"shape":"UnauthorizedOperationException"},
{"shape":"UnauthorizedResourceAccessException"},
{"shape":"FailedDependencyException"},
{"shape":"ServiceUnavailableException"}
],
"documentation":"<p>Activates the specified user. Only active users can access Amazon WorkDocs.</p>"
"documentation":"<p>Creates a set of permissions for the specified folder or document. The resource permissions are overwritten if the principals already have different permissions.</p>"
"documentation":"<p>Configure WorkDocs to use Amazon SNS notifications.</p> <p>The endpoint receives a confirmation message, and must confirm the subscription. For more information, see <a href=\"http://docs.aws.amazon.com/sns/latest/dg/SendMessageToHttp.html#SendMessageToHttp.confirm\">Confirm the Subscription</a> in the <i>Amazon Simple Notification Service Developer Guide</i>.</p>"
},
"CreateUser":{
"name":"CreateUser",
"http":{
"method":"POST",
"requestUri":"/api/v1/users",
"responseCode":201
},
"input":{"shape":"CreateUserRequest"},
"output":{"shape":"CreateUserResponse"},
"errors":[
{"shape":"EntityAlreadyExistsException"},
{"shape":"UnauthorizedOperationException"},
{"shape":"UnauthorizedResourceAccessException"},
{"shape":"FailedDependencyException"},
{"shape":"ServiceUnavailableException"}
],
"documentation":"<p>Creates 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.</p>"
},
"DeactivateUser":{
"name":"DeactivateUser",
"http":{
"method":"DELETE",
"requestUri":"/api/v1/users/{UserId}/activation",
"responseCode":204
},
"input":{"shape":"DeactivateUserRequest"},
"errors":[
{"shape":"EntityNotExistsException"},
{"shape":"UnauthorizedOperationException"},
{"shape":"UnauthorizedResourceAccessException"},
{"shape":"FailedDependencyException"},
{"shape":"ServiceUnavailableException"}
],
"documentation":"<p>Deactivates the specified user, which revokes the user's access to Amazon WorkDocs.</p>"
"documentation":"<p>Describes the contents of the specified folder, including its documents and subfolders.</p> <p>By default, Amazon WorkDocs returns the first 100 active document and folder metadata items. If there are more results, the response includes a marker that you can use to request the next set of results. You can also request initialized documents.</p>"
"documentation":"<p>Describes the current user's special folders; the <code>RootFolder</code> and the <code>RecycleBin</code>. <code>RootFolder</code> is the root of user's files and folders and <code>RecycleBin</code> is the root of recycled items. This is not a valid action for SigV4 (administrative API) clients.</p>"
"documentation":"<p>Describes the specified users. You can describe all users or filter the results (for example, by status or organization).</p> <p>By default, Amazon WorkDocs returns the first 24 active or pending users. If there are more results, the response includes a marker that you can use to request the next set of results.</p>"
},
"GetCurrentUser":{
"name":"GetCurrentUser",
"http":{
"method":"GET",
"requestUri":"/api/v1/me",
"responseCode":200
},
"input":{"shape":"GetCurrentUserRequest"},
"output":{"shape":"GetCurrentUserResponse"},
"errors":[
{"shape":"EntityNotExistsException"},
{"shape":"UnauthorizedOperationException"},
{"shape":"UnauthorizedResourceAccessException"},
{"shape":"FailedDependencyException"},
{"shape":"ServiceUnavailableException"}
],
"documentation":"<p>Retrieves details of the current user for whom the authentication token was generated. This is not a valid action for SigV4 (administrative API) clients.</p>"
"documentation":"<p>Retrieves the path information (the hierarchy from the root folder) for the requested document.</p> <p>By default, Amazon WorkDocs returns a maximum of 100 levels upwards from the requested document and 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.</p>"
"documentation":"<p>Retrieves version metadata for the specified document.</p>"
},
"GetFolder":{
"name":"GetFolder",
"http":{
"method":"GET",
"requestUri":"/api/v1/folders/{FolderId}",
"responseCode":200
},
"input":{"shape":"GetFolderRequest"},
"output":{"shape":"GetFolderResponse"},
"errors":[
{"shape":"EntityNotExistsException"},
{"shape":"UnauthorizedOperationException"},
{"shape":"UnauthorizedResourceAccessException"},
{"shape":"InvalidArgumentException"},
{"shape":"FailedDependencyException"},
{"shape":"ServiceUnavailableException"},
{"shape":"ProhibitedStateException"}
],
"documentation":"<p>Retrieves the metadata of the specified folder.</p>"
},
"GetFolderPath":{
"name":"GetFolderPath",
"http":{
"method":"GET",
"requestUri":"/api/v1/folders/{FolderId}/path",
"responseCode":200
},
"input":{"shape":"GetFolderPathRequest"},
"output":{"shape":"GetFolderPathResponse"},
"errors":[
{"shape":"EntityNotExistsException"},
{"shape":"UnauthorizedOperationException"},
{"shape":"UnauthorizedResourceAccessException"},
{"shape":"FailedDependencyException"},
{"shape":"ServiceUnavailableException"}
],
"documentation":"<p>Retrieves the path information (the hierarchy from the root folder) for the specified folder.</p> <p>By default, Amazon WorkDocs returns a maximum of 100 levels upwards from the requested folder and only includes the IDs of the parent folders in the path. You can limit the maximum number of levels. You can also request the parent folder names.</p>"
"documentation":"<p>Creates a new document object and version object.</p> <p>The client specifies the parent folder ID and name of the document to upload. The ID is optionally specified when creating a new version of an existing document. This is the first step to upload a document. Next, upload the document to the URL returned from the call, and then call <a>UpdateDocumentVersion</a>.</p> <p>To cancel the document upload, call <a>AbortDocumentVersionUpload</a>.</p>"
"documentation":"<p>Removes the permission for the specified principal from the specified resource.</p>"
},
"UpdateDocument":{
"name":"UpdateDocument",
"http":{
"method":"PATCH",
"requestUri":"/api/v1/documents/{DocumentId}",
"responseCode":200
},
"input":{"shape":"UpdateDocumentRequest"},
"errors":[
{"shape":"EntityNotExistsException"},
{"shape":"EntityAlreadyExistsException"},
{"shape":"LimitExceededException"},
{"shape":"ProhibitedStateException"},
{"shape":"ConcurrentModificationException"},
{"shape":"UnauthorizedOperationException"},
{"shape":"UnauthorizedResourceAccessException"},
{"shape":"FailedDependencyException"},
{"shape":"ServiceUnavailableException"}
],
"documentation":"<p>Updates the specified attributes of a document. The user must have access to both the document and its parent folder, if applicable.</p>"
"documentation":"<p>Changes the status of the document version to ACTIVE. </p> <p>Amazon WorkDocs also sets its document container to ACTIVE. This is the last step in a document upload, after the client uploads the document to an S3-presigned URL returned by <a>InitiateDocumentVersionUpload</a>. </p>"
},
"UpdateFolder":{
"name":"UpdateFolder",
"http":{
"method":"PATCH",
"requestUri":"/api/v1/folders/{FolderId}",
"responseCode":200
},
"input":{"shape":"UpdateFolderRequest"},
"errors":[
{"shape":"EntityNotExistsException"},
{"shape":"EntityAlreadyExistsException"},
{"shape":"ProhibitedStateException"},
{"shape":"ConcurrentModificationException"},
{"shape":"LimitExceededException"},
{"shape":"UnauthorizedOperationException"},
{"shape":"UnauthorizedResourceAccessException"},
{"shape":"FailedDependencyException"},
{"shape":"ServiceUnavailableException"}
],
"documentation":"<p>Updates the specified attributes of the specified folder. The user must have access to both the folder and its parent folder, if applicable.</p>"
"documentation":"<p>Updates the specified attributes of the specified user, and grants or revokes administrative privileges to the Amazon WorkDocs site.</p>"
"documentation":"<p>Amazon WorkDocs authentication token. Do not set this field when using administrative API actions, as in accessing the API using AWS credentials.</p>",
"documentation":"<p>Amazon WorkDocs authentication token. Do not set this field when using administrative API actions, as in accessing the API using AWS credentials.</p>",
"documentation":"<p>The timestamp when the action was performed.</p>"
},
"OrganizationId":{
"shape":"IdType",
"documentation":"<p>The ID of the organization.</p>"
},
"Initiator":{
"shape":"UserMetadata",
"documentation":"<p>The user who performed the action.</p>"
},
"Participants":{
"shape":"Participants",
"documentation":"<p>The list of users or groups impacted by this action. This is an optional field and is filled for the following sharing activities: DOCUMENT_SHARED, DOCUMENT_SHARED, DOCUMENT_UNSHARED, FOLDER_SHARED, FOLDER_UNSHARED.</p>"
},
"ResourceMetadata":{
"shape":"ResourceMetadata",
"documentation":"<p>The metadata of the resource involved in the user action.</p>"
},
"OriginalParent":{
"shape":"ResourceMetadata",
"documentation":"<p>The original parent of the resource. This is an optional field and is filled for move activities.</p>"
},
"CommentMetadata":{
"shape":"CommentMetadata",
"documentation":"<p>Metadata of the commenting activity. This is an optional field and is filled for commenting activities.</p>"
}
},
"documentation":"<p>Describes the activity information.</p>"
"documentation":"<p>Amazon WorkDocs authentication token. Do not set this field when using administrative API actions, as in accessing the API using AWS credentials.</p>",
"documentation":"<p>The ID of the parent comment.</p>"
},
"ThreadId":{
"shape":"CommentIdType",
"documentation":"<p>The ID of the root comment in the thread.</p>"
},
"Text":{
"shape":"CommentTextType",
"documentation":"<p>The text of the comment.</p>"
},
"Contributor":{
"shape":"User",
"documentation":"<p>The details of the user who made the comment.</p>"
},
"CreatedTimestamp":{
"shape":"TimestampType",
"documentation":"<p>The time that the comment was created.</p>"
},
"Status":{
"shape":"CommentStatusType",
"documentation":"<p>The status of the comment.</p>"
},
"Visibility":{
"shape":"CommentVisibilityType",
"documentation":"<p>The visibility of the comment. Options are either PRIVATE, where the comment is visible only to the comment author and document owner and co-owners, or PUBLIC, where the comment is visible to document owners, co-owners, and contributors.</p>"
},
"RecipientId":{
"shape":"IdType",
"documentation":"<p>If the comment is a reply to another user's comment, this field contains the user ID of the user being replied to.</p>"
}
},
"documentation":"<p>Describes a comment.</p>"
},
"CommentIdType":{
"type":"string",
"max":128,
"min":1,
"pattern":"[\\w+-.@]+"
},
"CommentList":{
"type":"list",
"member":{"shape":"Comment"}
},
"CommentMetadata":{
"type":"structure",
"members":{
"CommentId":{
"shape":"CommentIdType",
"documentation":"<p>The ID of the comment.</p>"
},
"Contributor":{
"shape":"User",
"documentation":"<p>The user who made the comment.</p>"
"documentation":"<p>Amazon WorkDocs authentication token. Do not set this field when using administrative API actions, as in accessing the API using AWS credentials.</p>",
"documentation":"<p>The ID of the document version.</p>",
"location":"uri",
"locationName":"VersionId"
},
"ParentId":{
"shape":"CommentIdType",
"documentation":"<p>The ID of the parent comment.</p>"
},
"ThreadId":{
"shape":"CommentIdType",
"documentation":"<p>The ID of the root comment in the thread.</p>"
},
"Text":{
"shape":"CommentTextType",
"documentation":"<p>The text of the comment.</p>"
},
"Visibility":{
"shape":"CommentVisibilityType",
"documentation":"<p>The visibility of the comment. Options are either PRIVATE, where the comment is visible only to the comment author and document owner and co-owners, or PUBLIC, where the comment is visible to document owners, co-owners, and contributors.</p>"
},
"NotifyCollaborators":{
"shape":"BooleanType",
"documentation":"<p>Set this parameter to TRUE to send an email out to the document collaborators after the comment is created.</p>"
}
}
},
"CreateCommentResponse":{
"type":"structure",
"members":{
"Comment":{
"shape":"Comment",
"documentation":"<p>The comment that has been created.</p>"
"documentation":"<p>Amazon WorkDocs authentication token. Do not set this field when using administrative API actions, as in accessing the API using AWS credentials.</p>",
"documentation":"<p>Amazon WorkDocs authentication token. Do not set this field when using administrative API actions, as in accessing the API using AWS credentials.</p>",
"documentation":"<p>Amazon WorkDocs authentication token. Do not set this field when using administrative API actions, as in accessing the API using AWS credentials.</p>",
"documentation":"<p>Amazon WorkDocs authentication token. Do not set this field when using administrative API actions, as in accessing the API using AWS credentials.</p>",
"documentation":"<p>Amazon WorkDocs authentication token. Do not set this field when using administrative API actions, as in accessing the API using AWS credentials.</p>",
"documentation":"<p>Amazon WorkDocs authentication token. Do not set this field when using administrative API actions, as in accessing the API using AWS credentials.</p>",
"documentation":"<p>Amazon WorkDocs authentication token. Do not set this field when using administrative API actions, as in accessing the API using AWS credentials.</p>",
"documentation":"<p>Amazon WorkDocs authentication token. Do not set this field when using administrative API actions, as in accessing the API using AWS credentials.</p>",
"documentation":"<p>Amazon WorkDocs authentication token. Do not set this field when using administrative API actions, as in accessing the API using AWS credentials.</p>",
"documentation":"<p>Amazon WorkDocs authentication token. Do not set this field when using administrative API actions, as in accessing the API using AWS credentials.</p>",
"documentation":"<p>Amazon WorkDocs authentication token. Do not set this field when using administrative API actions, as in accessing the API using AWS credentials.</p>",
"documentation":"<p>Amazon WorkDocs authentication token. Do not set this field when using administrative API actions, as in accessing the API using AWS credentials.</p>",
"documentation":"<p>Amazon WorkDocs authentication token. Do not set this field when using administrative API actions, as in accessing the API using AWS credentials.</p>",
"documentation":"<p>The timestamp that determines the starting time of the activities. The response includes the activities performed after the specified timestamp.</p>",
"documentation":"<p>The timestamp that determines the end time of the activities. The response includes the activities performed before the specified timestamp.</p>",
"documentation":"<p>The ID of the organization. This is a mandatory parameter when using administrative API (SigV4) requests.</p>",
"location":"querystring",
"locationName":"organizationId"
},
"UserId":{
"shape":"IdType",
"documentation":"<p>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.</p>",
"location":"querystring",
"locationName":"userId"
},
"Limit":{
"shape":"LimitType",
"documentation":"<p>The maximum number of items to return.</p>",
"documentation":"<p>Amazon WorkDocs authentication token. Do not set this field when using administrative API actions, as in accessing the API using AWS credentials.</p>",
"documentation":"<p>Amazon WorkDocs authentication token. Do not set this field when using administrative API actions, as in accessing the API using AWS credentials.</p>",
"documentation":"<p>Amazon WorkDocs authentication token. Do not set this field when using administrative API actions, as in accessing the API using AWS credentials.</p>",
"documentation":"<p>Amazon WorkDocs authentication token. Do not set this field when using administrative API actions, as in accessing the API using AWS credentials.</p>",
"location":"header",
"locationName":"Authentication"
},
"SearchQuery":{
"shape":"SearchQueryType",
"documentation":"<p>A query to describe groups by group name.</p>",
"location":"querystring",
"locationName":"searchQuery"
},
"OrganizationId":{
"shape":"IdType",
"documentation":"<p>The ID of the organization.</p>",
"location":"querystring",
"locationName":"organizationId"
},
"Marker":{
"shape":"MarkerType",
"documentation":"<p>The marker for the next set of results. (You received this marker from a previous call.)</p>",
"location":"querystring",
"locationName":"marker"
},
"Limit":{
"shape":"PositiveIntegerType",
"documentation":"<p>The maximum number of items to return with this call.</p>",
"location":"querystring",
"locationName":"limit"
}
}
},
"DescribeGroupsResponse":{
"type":"structure",
"members":{
"Groups":{
"shape":"GroupMetadataList",
"documentation":"<p>The list of groups.</p>"
},
"Marker":{
"shape":"MarkerType",
"documentation":"<p>The marker to use when requesting the next set of results. If there are no additional results, the string is empty.</p>"
"documentation":"<p>Amazon WorkDocs authentication token. Do not set this field when using administrative API actions, as in accessing the API using AWS credentials.</p>",
"documentation":"<p>Amazon WorkDocs authentication token. Do not set this field when using administrative API actions, as in accessing the API using AWS credentials.</p>",
"documentation":"<p>Amazon WorkDocs authentication token. Do not set this field when using administrative API actions, as in accessing the API using AWS credentials.</p>",
"documentation":"<p>The ID of the organization.</p>",
"location":"querystring",
"locationName":"organizationId"
},
"UserIds":{
"shape":"UserIdsType",
"documentation":"<p>The IDs of the users.</p>",
"location":"querystring",
"locationName":"userIds"
},
"Query":{
"shape":"SearchQueryType",
"documentation":"<p>A query to filter users by user name.</p>",
"location":"querystring",
"locationName":"query"
},
"Include":{
"shape":"UserFilterType",
"documentation":"<p>The state of the users. Specify \"ALL\" to include inactive users.</p>",
"location":"querystring",
"locationName":"include"
},
"Order":{
"shape":"OrderType",
"documentation":"<p>The order for the results.</p>",
"location":"querystring",
"locationName":"order"
},
"Sort":{
"shape":"UserSortType",
"documentation":"<p>The sorting criteria.</p>",
"location":"querystring",
"locationName":"sort"
},
"Marker":{
"shape":"PageMarkerType",
"documentation":"<p>The marker for the next set of results. (You received this marker from a previous call.)</p>",
"location":"querystring",
"locationName":"marker"
},
"Limit":{
"shape":"LimitType",
"documentation":"<p>The maximum number of items to return.</p>",
"location":"querystring",
"locationName":"limit"
},
"Fields":{
"shape":"FieldNamesType",
"documentation":"<p>A comma-separated list of values. Specify \"STORAGE_METADATA\" to include the user storage quota and utilization information.</p>",
"documentation":"<p>The marker to use when requesting the next set of results. If there are no additional results, the string is empty.</p>"
}
}
},
"DocumentContentType":{
"type":"string",
"max":128,
"min":1
},
"DocumentLockedForCommentsException":{
"type":"structure",
"members":{
"Message":{"shape":"ErrorMessageType"}
},
"documentation":"<p>This exception is thrown when the document is locked for comments and user tries to create or delete a comment on that document.</p>",
"error":{"httpStatusCode":409},
"exception":true
},
"DocumentMetadata":{
"type":"structure",
"members":{
"Id":{
"shape":"ResourceIdType",
"documentation":"<p>The ID of the document.</p>"
},
"CreatorId":{
"shape":"IdType",
"documentation":"<p>The ID of the creator.</p>"
},
"ParentFolderId":{
"shape":"ResourceIdType",
"documentation":"<p>The ID of the parent folder.</p>"
},
"CreatedTimestamp":{
"shape":"TimestampType",
"documentation":"<p>The time when the document was created.</p>"
},
"ModifiedTimestamp":{
"shape":"TimestampType",
"documentation":"<p>The time when the document was updated.</p>"
},
"LatestVersionMetadata":{
"shape":"DocumentVersionMetadata",
"documentation":"<p>The latest version of the document.</p>"
"documentation":"<p>The thumbnail of the document.</p>"
},
"Source":{
"shape":"DocumentSourceUrlMap",
"documentation":"<p>The source of the document.</p>"
}
},
"documentation":"<p>Describes a version of a document.</p>"
},
"DocumentVersionMetadataList":{
"type":"list",
"member":{"shape":"DocumentVersionMetadata"}
},
"DocumentVersionStatus":{
"type":"string",
"enum":["ACTIVE"]
},
"DraftUploadOutOfSyncException":{
"type":"structure",
"members":{
"Message":{"shape":"ErrorMessageType"}
},
"documentation":"<p>This exception is thrown when a valid checkout ID is not presented on document version upload calls for a document that has been checked out from Web client.</p>",
"documentation":"<p>The AWS Directory Service cannot reach an on-premises instance. Or a dependency under the control of the organization is failing, such as a connected Active Directory.</p>",
"documentation":"<p>Amazon WorkDocs authentication token. Do not set this field when using administrative API actions, as in accessing the API using AWS credentials.</p>",
"documentation":"<p>Amazon WorkDocs authentication token. Do not set this field when using administrative API actions, as in accessing the API using AWS credentials.</p>",
"documentation":"<p>Amazon WorkDocs authentication token. Do not set this field when using administrative API actions, as in accessing the API using AWS credentials.</p>",
"documentation":"<p>Amazon WorkDocs authentication token. Do not set this field when using administrative API actions, as in accessing the API using AWS credentials.</p>",
"documentation":"<p>Amazon WorkDocs authentication token. Do not set this field when using administrative API actions, as in accessing the API using AWS credentials.</p>",
"documentation":"<p>Amazon WorkDocs authentication token. Do not set this field when using administrative API actions, as in accessing the API using AWS credentials.</p>",
"documentation":"<p>Amazon WorkDocs authentication token. Do not set this field when using administrative API actions, as in accessing the API using AWS credentials.</p>",
"documentation":"<p>Amazon WorkDocs authentication token. Do not set this field when using administrative API actions, as in accessing the API using AWS credentials.</p>",
"documentation":"<p>Amazon WorkDocs authentication token. Do not set this field when using administrative API actions, as in accessing the API using AWS credentials.</p>",
"documentation":"<p>Amazon WorkDocs authentication token. Do not set this field when using administrative API actions, as in accessing the API using AWS credentials.</p>",
"documentation":"<p>Amazon WorkDocs authentication token. Do not set this field when using administrative API actions, as in accessing the API using AWS credentials.</p>",
"documentation":"<p>Amazon WorkDocs authentication token. Do not set this field when using administrative API actions, as in accessing the API using AWS credentials.</p>",
"documentation":"<p>Amazon WorkDocs authentication token. Do not set this field when using administrative API actions, as in accessing the API using AWS credentials.</p>",
"documentation":"<p>The WorkDocs API is designed for the following use cases:</p> <ul> <li> <p>File Migration: File migration applications are supported for users who want to migrate their files from an on-premises or off-premises file system or service. Users can insert files into a user directory structure, as well as allow for basic metadata changes, such as modifications to the permissions of files.</p> </li> <li> <p>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 these applications to detect when changes occur in Amazon WorkDocs. Then, the application can take the necessary actions and replace the target file. If the target file violates the policy, the application can also choose to email the user.</p> </li> <li> <p>eDiscovery/Analytics: General administrative applications are supported, such as eDiscovery and analytics. 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.</p> </li> </ul> <p>All Amazon WorkDocs API actions are Amazon authenticated and certificate-signed. They not only require the use of the AWS SDK, but also allow for the exclusive use of IAM users and roles to help facilitate access, trust, and permission policies. By creating a role and allowing an IAM user to access the Amazon WorkDocs site, the IAM user gains full administrative visibility into the entire Amazon WorkDocs site (or as set in the IAM policy). This includes, but is not limited to, the ability to modify file permissions and upload any file to any user. This allows developers to perform the three use cases above, as well as give users the ability to grant access on a selective basis using the IAM model.</p>"