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

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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-workdocs/lib/aws-sdk-workdocs/types.rb

Overview

Note:

When making an API call, you may pass DeleteCustomMetadataRequest data as a hash:

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

Instance Attribute Summary collapse

Instance Attribute Details

#authentication_tokenString

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

Returns:

  • (String)


703
704
705
706
707
708
709
710
# File 'gems/aws-sdk-workdocs/lib/aws-sdk-workdocs/types.rb', line 703

class DeleteCustomMetadataRequest < Struct.new(
  :authentication_token,
  :resource_id,
  :version_id,
  :keys,
  :delete_all)
  include Aws::Structure
end

#delete_allBoolean

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

Returns:

  • (Boolean)


703
704
705
706
707
708
709
710
# File 'gems/aws-sdk-workdocs/lib/aws-sdk-workdocs/types.rb', line 703

class DeleteCustomMetadataRequest < Struct.new(
  :authentication_token,
  :resource_id,
  :version_id,
  :keys,
  :delete_all)
  include Aws::Structure
end

#keysArray<String>

List of properties to remove.

Returns:

  • (Array<String>)


703
704
705
706
707
708
709
710
# File 'gems/aws-sdk-workdocs/lib/aws-sdk-workdocs/types.rb', line 703

class DeleteCustomMetadataRequest < Struct.new(
  :authentication_token,
  :resource_id,
  :version_id,
  :keys,
  :delete_all)
  include Aws::Structure
end

#resource_idString

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

Returns:

  • (String)


703
704
705
706
707
708
709
710
# File 'gems/aws-sdk-workdocs/lib/aws-sdk-workdocs/types.rb', line 703

class DeleteCustomMetadataRequest < Struct.new(
  :authentication_token,
  :resource_id,
  :version_id,
  :keys,
  :delete_all)
  include Aws::Structure
end

#version_idString

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

Returns:

  • (String)


703
704
705
706
707
708
709
710
# File 'gems/aws-sdk-workdocs/lib/aws-sdk-workdocs/types.rb', line 703

class DeleteCustomMetadataRequest < Struct.new(
  :authentication_token,
  :resource_id,
  :version_id,
  :keys,
  :delete_all)
  include Aws::Structure
end