DeleteNotificationSubscription
Deletes the specified subscription from the specified organization.
Request Syntax
DELETE /api/v1/organizations/OrganizationId/subscriptions/SubscriptionId HTTP/1.1
URI Request Parameters
The request uses the following URI parameters.
OrganizationId (p. 48) The ID of the organization.
Length Constraints: Minimum length of 1. Maximum length of 256.
Pattern: [&\w+-.@]+
Required: Yes SubscriptionId (p. 48)
The ID of the subscription.
Length Constraints: Minimum length of 1. Maximum length of 256.
Pattern: [&\w+-.@]+
Required: Yes
Request Body
The request does not have a request body.
Response Syntax
HTTP/1.1 200
Response Elements
If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.
Errors
For information about the errors that are common to all actions, see Common Errors (p. 164).
EntityNotExistsException The resource does not exist.
HTTP Status Code: 404
See Also
ProhibitedStateException
The specified document version is not in the INITIALIZED state.
HTTP Status Code: 409 ServiceUnavailableException
One or more of the dependencies is unavailable.
HTTP Status Code: 503
UnauthorizedResourceAccessException
The caller does not have access to perform the action on the resource.
HTTP Status Code: 404
See Also
For 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
DeleteUser
DeleteUser
Deletes the specified user from a Simple AD or Microsoft AD directory.
Request Syntax
DELETE /api/v1/users/UserId HTTP/1.1 Authentication: AuthenticationToken
URI Request Parameters
The request uses the following URI parameters.
AuthenticationToken (p. 50)
Amazon WorkDocs authentication token. Do not set this field when using administrative API actions, as in accessing the API using AWS credentials.
Length Constraints: Minimum length of 1. Maximum length of 8199.
UserId (p. 50)
The ID of the user.
Length Constraints: Minimum length of 1. Maximum length of 256.
Pattern: [&\w+-.@]+
Required: Yes
Request Body
The request does not have a request body.
Response Syntax
HTTP/1.1 204
Response Elements
If the action is successful, the service sends back an HTTP 204 response with an empty HTTP body.
Errors
For information about the errors that are common to all actions, see Common Errors (p. 164).
EntityNotExistsException The resource does not exist.
HTTP Status Code: 404
See Also
FailedDependencyException
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.
HTTP Status Code: 424 ServiceUnavailableException
One or more of the dependencies is unavailable.
HTTP Status Code: 503 UnauthorizedOperationException
The operation is not permitted.
HTTP Status Code: 403
UnauthorizedResourceAccessException
The caller does not have access to perform the action on the resource.
HTTP Status Code: 404
See Also
For 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
DescribeActivities
DescribeActivities
Describes the user activities in a specified time period.
Request Syntax
GET /api/v1/activities?
activityTypes=ActivityTypes&endTime=EndTime&includeIndirectActivities=IncludeIndirectActivities&limit=Limit&marker=Marker&organizationId=OrganizationId&resourceId=ResourceId&startTime=StartTime&userId=UserId HTTP/1.1
Authentication: AuthenticationToken
URI Request Parameters
The request uses the following URI parameters.
ActivityTypes (p. 52)
Specifies which activity types to include in the response. If this field is left empty, all activity types are returned.
Length Constraints: Minimum length of 1. Maximum length of 1024.
Pattern: [\w,]+
AuthenticationToken (p. 52)
Amazon WorkDocs authentication token. Not required when using AWS administrator credentials to access the API.
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 activities performed before the specified timestamp.
IncludeIndirectActivities (p. 52)
Includes indirect activities. An indirect activity results from a direct activity performed on a parent resource. For example, sharing a parent folder (the direct activity) shares all of the subfolders and documents 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.
Length Constraints: Minimum length of 1. Maximum length of 2048.
Pattern: [\u0000-\u00FF]+
OrganizationId (p. 52)
The ID of the organization. This is a mandatory parameter when using administrative API (SigV4) requests.
Request Body
Length Constraints: Minimum length of 1. Maximum length of 256.
Pattern: [&\w+-.@]+
ResourceId (p. 52)
The document or folder ID for which to describe activity types.
Length Constraints: Minimum length of 1. Maximum length of 256.
Pattern: [&\w+-.@]+
StartTime (p. 52)
The timestamp that determines the starting time of the activities. The response includes the activities 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.
Length Constraints: Minimum length of 1. Maximum length of 256.
Pattern: [&\w+-.@]+
Request Body
The request does not have a request body.
Response Syntax
HTTP/1.1 200
Content-type: application/json { "Marker": "string",
"UserActivities": [ {
Response Syntax
Response Elements
}
Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
Marker (p. 53)
The marker for the next set of results.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 2048.
Pattern: [\u0000-\u00FF]+
UserActivities (p. 53)
The list of activities for the specified user and time period.
Type: Array of Activity (p. 127) objects
Errors
For information about the errors that are common to all actions, see Common Errors (p. 164).
FailedDependencyException
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.
HTTP Status Code: 424 InvalidArgumentException
The pagination marker or limit fields are not valid.
HTTP Status Code: 400 ServiceUnavailableException
One or more of the dependencies is unavailable.
HTTP Status Code: 503 UnauthorizedOperationException
The operation is not permitted.
HTTP Status Code: 403
UnauthorizedResourceAccessException
The caller does not have access to perform the action on the resource.
HTTP Status Code: 404
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
See Also
• 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
DescribeComments
DescribeComments
List all the comments for the specified document version.
Request Syntax
GET /api/v1/documents/DocumentId/versions/VersionId/comments?limit=Limit&marker=Marker HTTP/1.1
Authentication: AuthenticationToken
URI Request Parameters
The request uses the following URI parameters.
AuthenticationToken (p. 57)
Amazon WorkDocs authentication token. Not required when using AWS administrator credentials to access the API.
Length Constraints: Minimum length of 1. Maximum length of 8199.
DocumentId (p. 57)
The ID of the document.
Length Constraints: Minimum length of 1. Maximum length of 128.
Pattern: [\w+-.@]+
Required: Yes Limit (p. 57)
The maximum number of items to return.
Valid Range: Minimum value of 1. Maximum value of 999.
Marker (p. 57)
The marker for the next set of results. This marker was received from a previous call.
Length Constraints: Minimum length of 1. Maximum length of 2048.
Pattern: [\u0000-\u00FF]+
VersionId (p. 57)
The ID of the document version.
Length Constraints: Minimum length of 1. Maximum length of 128.
Pattern: [\w+-.@]+
Required: Yes
Request Body
The request does not have a request body.
Response Syntax
"Marker": "string"
}
Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
Comments (p. 58)
The list of comments for the specified document version.
Type: Array of Comment (p. 129) objects Marker (p. 58)
The marker for the next set of results. This marker was received from a previous call.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 2048.
Errors
Pattern: [\u0000-\u00FF]+
Errors
For information about the errors that are common to all actions, see Common Errors (p. 164).
EntityNotExistsException The resource does not exist.
HTTP Status Code: 404 FailedDependencyException
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.
HTTP Status Code: 424 ProhibitedStateException
The specified document version is not in the INITIALIZED state.
HTTP Status Code: 409 ServiceUnavailableException
One or more of the dependencies is unavailable.
HTTP Status Code: 503 UnauthorizedOperationException
The operation is not permitted.
HTTP Status Code: 403
UnauthorizedResourceAccessException
The caller does not have access to perform the action on the resource.
HTTP Status Code: 404
See Also
For 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
DescribeDocumentVersions
DescribeDocumentVersions
Retrieves the document versions for the specified document.
By default, only active versions are returned.
Request Syntax
GET /api/v1/documents/DocumentId/versions?
fields=Fields&include=Include&limit=Limit&marker=Marker HTTP/1.1 Authentication: AuthenticationToken
URI Request Parameters
The request uses the following URI parameters.
AuthenticationToken (p. 60)
Amazon WorkDocs authentication token. Not required when using AWS administrator credentials to access the API.
Length Constraints: Minimum length of 1. Maximum length of 8199.
DocumentId (p. 60)
The ID of the document.
Length Constraints: Minimum length of 1. Maximum length of 128.
Pattern: [\w+-.@]+
Required: Yes Fields (p. 60)
Specify "SOURCE" to include initialized versions and a URL for the source document.
Length Constraints: Minimum length of 1. Maximum length of 256.
Pattern: [\w,]+
Include (p. 60)
A comma-separated list of values. Specify "INITIALIZED" to include incomplete versions.
Length Constraints: Minimum length of 1. Maximum length of 256.
Pattern: [\w,]+
Limit (p. 60)
The maximum number of versions to return with this call.
Valid Range: Minimum value of 1. Maximum value of 999.
Marker (p. 60)
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.
Request Body
Request Body
The request does not have a request body.
Response Syntax
HTTP/1.1 200
Content-type: application/json { "DocumentVersions": [ {
"ContentCreatedTimestamp": number, "ContentModifiedTimestamp": number, "ContentType": "string",
"Marker": "string"
}
Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
DocumentVersions (p. 61) The document versions.
Type: Array of DocumentVersionMetadata (p. 135) objects Marker (p. 61)
The marker to use when requesting the next set of results. If there are no additional results, the string is empty.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 2048.
Errors
For information about the errors that are common to all actions, see Common Errors (p. 164).
See Also
EntityNotExistsException The resource does not exist.
HTTP Status Code: 404 FailedDependencyException
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.
HTTP Status Code: 424 InvalidArgumentException
The pagination marker or limit fields are not valid.
HTTP Status Code: 400 ProhibitedStateException
The specified document version is not in the INITIALIZED state.
HTTP Status Code: 409 ServiceUnavailableException
One or more of the dependencies is unavailable.
HTTP Status Code: 503 UnauthorizedOperationException
The operation is not permitted.
HTTP Status Code: 403
UnauthorizedResourceAccessException
The caller does not have access to perform the action on the resource.
HTTP Status Code: 404
See Also
For 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
DescribeFolderContents
DescribeFolderContents
Describes 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 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.
Request Syntax
GET /api/v1/folders/FolderId/contents?
include=Include&limit=Limit&marker=Marker&order=Order&sort=Sort&type=Type HTTP/1.1 Authentication: AuthenticationToken
URI Request Parameters
The request uses the following URI parameters.
AuthenticationToken (p. 63)
Amazon WorkDocs authentication token. Not required when using AWS administrator credentials to access the API.
Length Constraints: Minimum length of 1. Maximum length of 8199.
FolderId (p. 63)
The ID of the folder.
Length Constraints: Minimum length of 1. Maximum length of 128.
Pattern: [\w+-.@]+
Required: Yes Include (p. 63)
The contents to include. Specify "INITIALIZED" to include initialized documents.
Length Constraints: Minimum length of 1. Maximum length of 256.
Pattern: [\w,]+
Limit (p. 63)
The maximum number of items to return with this call.
Valid Range: Minimum value of 1. Maximum value of 999.
Marker (p. 63)
The marker for the next set of results. This marker was received from a previous 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
Request Body
Sort (p. 63)
The sorting criteria.
Valid Values: DATE | NAME Type (p. 63)
The type of items.
Valid Values: ALL | DOCUMENT | FOLDER
Request Body
The request does not have a request body.
Response Syntax
Response Elements
"Marker": "string"
}
Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
Documents (p. 64)
The documents in the specified folder.
Type: Array of DocumentMetadata (p. 133) objects Folders (p. 64)
The subfolders in the specified folder.
Type: Array of FolderMetadata (p. 138) objects Marker (p. 64)
The marker to use when requesting the next set of results. If there are no additional results, the string is empty.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 2048.
Errors
For information about the errors that are common to all actions, see Common Errors (p. 164).
EntityNotExistsException The resource does not exist.
HTTP Status Code: 404 FailedDependencyException
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.
HTTP Status Code: 424 InvalidArgumentException
The pagination marker or limit fields are not valid.
HTTP Status Code: 400 ProhibitedStateException
The specified document version is not in the INITIALIZED state.
HTTP Status Code: 409
See Also
ServiceUnavailableException
One or more of the dependencies is unavailable.
HTTP Status Code: 503
UnauthorizedResourceAccessException
The caller does not have access to perform the action on the resource.
HTTP Status Code: 404
See Also
For 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
DescribeGroups
DescribeGroups
Describes 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.1 Authentication: AuthenticationToken
URI Request Parameters
The request uses the following URI parameters.
AuthenticationToken (p. 67)
Amazon WorkDocs authentication token. Not required when using AWS administrator credentials to access the API.
Length Constraints: Minimum length of 1. Maximum length of 8199.
Limit (p. 67)
The maximum number of items to return with this call.
Valid Range: Minimum value of 1.
Marker (p. 67)
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.
Pattern: [\u0000-\u00FF]+
OrganizationId (p. 67) The ID of the organization.
Length Constraints: Minimum length of 1. Maximum length of 256.
Pattern: [&\w+-.@]+
SearchQuery (p. 67)
A query to describe groups by group name.
Length Constraints: Minimum length of 1. Maximum length of 512.
Pattern: [\u0020-\uFFFF]+
Required: Yes
Request Body
The request does not have a request body.
Response Syntax
"Marker": "string"
}
Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
Groups (p. 68) The list of groups.
Type: Array of GroupMetadata (p. 141) objects Marker (p. 68)
The marker to use when requesting the next set of results. If there are no additional results, the string is empty.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 2048.
Pattern: [\u0000-\u00FF]+
Errors
For information about the errors that are common to all actions, see Common Errors (p. 164).
FailedDependencyException
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.
HTTP Status Code: 424 ServiceUnavailableException
One or more of the dependencies is unavailable.
HTTP Status Code: 503 UnauthorizedOperationException
The operation is not permitted.
HTTP Status Code: 403
See Also
UnauthorizedResourceAccessException
The caller does not have access to perform the action on the resource.
HTTP Status Code: 404
See Also
For 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