DeleteCustomMetadata
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
Deletes custom metadata from the specified resource.
Request Syntax
DELETE /api/v1/resources/ResourceId/customMetadata?deleteAll=DeleteAll&keys=Keys&versionId=VersionId 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.
- DeleteAll
-
Flag to indicate removal of all custom metadata properties from the specified resource.
- Keys
-
List of properties to remove.
Array Members: Maximum number of 8 items.
Length Constraints: Minimum length of 1. Maximum length of 56.
Pattern:
[a-zA-Z0-9._+-/=][a-zA-Z0-9 ._+-/=]* - ResourceId
-
The ID of the resource, either a document or folder.
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 deleted from a document version.
Length Constraints: Minimum length of 1. Maximum length of 128.
Pattern:
[\w+-.@]+
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.
- 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:
