[ aws . workdocs ]

delete-custom-metadata

Description

Deletes custom metadata from the specified resource.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

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

Options

--authentication-token (string)

Amazon WorkDocs authentication token. Not required when using AWS administrator credentials to access the API.

--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.

(string)

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 | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--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. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

--cli-auto-prompt (boolean) Automatically prompt for CLI input parameters.

See ‘aws help’ for descriptions of global parameters.

Examples

To delete custom metadata from a resource

This example deletes all custom metadata from the specified resource.

Command:

aws workdocs delete-custom-metadata --resource-id d90d93c1fe44bad0c8471e973ebaab339090401a95e777cffa58e977d2983b65 --delete-all

Output:

None

Output

None