Table Of Contents

Feedback

User Guide

First time using the AWS CLI? See the User Guide for help getting started.

[ aws . workdocs ]

delete-custom-metadata

Description

Deletes custom metadata from the specified resource.

See also: AWS API Documentation

Synopsis

  delete-custom-metadata
[--authentication-token <value>]
--resource-id <value>
[--version-id <value>]
[--keys <value>]
[--delete-all | --no-delete-all]
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]

Options

--authentication-token (string)

Amazon WorkDocs authentication token. This field should not be set when using administrative API actions, as in accessing the API using AWS credentials.

--resource-id (string)

The ID of the resource, either a document or folder.

--version-id (string)

The ID of the version, if the custom metadata is being deleted from a document version.

--keys (list)

List of properties to remove.

Syntax:

"string" "string" ...

--delete-all | --no-delete-all (boolean)

Flag to indicate removal of all custom metadata properties from the specified resource.

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI values will override the JSON-provided values.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

Output