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

CreateCustomMetadata

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.

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

Request Syntax


PUT /api/v1/resources/ResourceId/customMetadata?versionid=VersionId HTTP/1.1
Authentication: AuthenticationToken
Content-type: application/json

{
   "CustomMetadata": { 
      "string" : "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.

ResourceId

The ID of the resource.

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

Pattern: [\w+-.@]+

Required: Yes

VersionId

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

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

Pattern: [\w+-.@]+

Request Body

The request accepts the following data in JSON format.

CustomMetadata

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

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.

CustomMetadataLimitExceededException

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

HTTP Status Code: 429

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