Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

CreateFolder

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.

Creates a folder with the specified name and parent folder.

Request Syntax


POST /api/v1/folders HTTP/1.1
Authentication: AuthenticationToken
Content-type: application/json

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

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.

Request Body

The request accepts the following data in JSON format.

Name

The name of the new folder.

Type: String

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

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

Required: No

ParentFolderId

The ID of the parent folder.

Type: String

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

Pattern: [\w+-.@]+

Required: Yes

Response Syntax


HTTP/1.1 201
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
   }
}

Response Elements

If the action is successful, the service sends back an HTTP 201 response.

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

Metadata

The metadata of the folder.

Type: FolderMetadata object

Errors

For information about the errors that are common to all actions, see Common Errors.

ConcurrentModificationException

The resource hierarchy is changing.

HTTP Status Code: 409

ConflictingOperationException

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

HTTP Status Code: 409

EntityAlreadyExistsException

The resource already exists.

HTTP Status Code: 409

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

LimitExceededException

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

HTTP Status Code: 409

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