You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Class: Aws::WorkDocs::Types::DeleteCustomMetadataRequest

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing DeleteCustomMetadataRequest as input to an Aws::Client method, you can use a vanilla Hash:

{
  authentication_token: "AuthenticationHeaderType",
  resource_id: "ResourceIdType", # required
  version_id: "DocumentVersionIdType",
  keys: ["CustomMetadataKeyType"],
  delete_all: false,
}

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#authentication_token ⇒ String

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

Returns:

  • (String) —

    Amazon WorkDocs authentication token.

#delete_all ⇒ Boolean

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

Returns:

  • (Boolean) —

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

#keys ⇒ Array<String>

List of properties to remove.

Returns:

  • (Array<String>) —

    List of properties to remove.

#resource_id ⇒ String

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

Returns:

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

Returns:

  • (String) —

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