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

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

Overview

Constant Summary collapse

SENSITIVE =
[:authentication_token]

Instance Attribute Summary collapse

Instance Attribute Details

#authentication_tokenString

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

Returns:

  • (String)


668
669
670
671
672
673
674
675
676
# File 'gems/aws-sdk-workdocs/lib/aws-sdk-workdocs/types.rb', line 668

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

#delete_allBoolean

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

Returns:

  • (Boolean)


668
669
670
671
672
673
674
675
676
# File 'gems/aws-sdk-workdocs/lib/aws-sdk-workdocs/types.rb', line 668

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

#keysArray<String>

List of properties to remove.

Returns:

  • (Array<String>)


668
669
670
671
672
673
674
675
676
# File 'gems/aws-sdk-workdocs/lib/aws-sdk-workdocs/types.rb', line 668

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

#resource_idString

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

Returns:

  • (String)


668
669
670
671
672
673
674
675
676
# File 'gems/aws-sdk-workdocs/lib/aws-sdk-workdocs/types.rb', line 668

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

#version_idString

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

Returns:

  • (String)


668
669
670
671
672
673
674
675
676
# File 'gems/aws-sdk-workdocs/lib/aws-sdk-workdocs/types.rb', line 668

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