Important
Notice: New customer sign-ups and account upgrades are no longer available for Amazon WorkDocs.
Learn about migration steps here:
How to migrate data from Amazon WorkDocs
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
-
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
-
The ID of the folder.
Length Constraints: Minimum length of 1. Maximum length of 128.
Pattern:
[\w+-.@]+Required: Yes
- Include
-
The contents to include. Specify "INITIALIZED" to include initialized documents.
Length Constraints: Minimum length of 1. Maximum length of 256.
Pattern:
[\w,]+ - Limit
-
The maximum number of items to return with this call.
Valid Range: Minimum value of 1. Maximum value of 999.
- Marker
-
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
-
The order for the contents of the folder.
Valid Values:
ASCENDING | DESCENDING - Sort
-
The sorting criteria.
Valid Values:
DATE | NAME - Type
-
The type of items.
Valid Values:
ALL | DOCUMENT | FOLDER
Request Body
The request does not have a request body.
Response Syntax
HTTP/1.1 200
Content-type: application/json
{
"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"
}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
-
The documents in the specified folder.
Type: Array of DocumentMetadata objects
- Folders
-
The subfolders in the specified folder.
Type: Array of FolderMetadata objects
- Marker
-
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.
- 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
- 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:
