Class: Aws::WorkDocs::Types::CreateCustomMetadataRequest

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 CreateCustomMetadataRequest data as a hash:

{
  authentication_token: "AuthenticationHeaderType",
  resource_id: "ResourceIdType", # required
  version_id: "DocumentVersionIdType",
  custom_metadata: { # required
    "CustomMetadataKeyType" => "CustomMetadataValueType",
  },
}

Constant Summary collapse

SENSITIVE =
[:authentication_token]

Instance Attribute Summary collapse

Instance Attribute Details

#authentication_tokenString

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

Returns:

  • (String)


434
435
436
437
438
439
440
441
# File 'gems/aws-sdk-workdocs/lib/aws-sdk-workdocs/types.rb', line 434

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

#custom_metadataHash<String,String>

Custom metadata in the form of name-value pairs.

Returns:

  • (Hash<String,String>)


434
435
436
437
438
439
440
441
# File 'gems/aws-sdk-workdocs/lib/aws-sdk-workdocs/types.rb', line 434

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

#resource_idString

The ID of the resource.

Returns:

  • (String)


434
435
436
437
438
439
440
441
# File 'gems/aws-sdk-workdocs/lib/aws-sdk-workdocs/types.rb', line 434

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

#version_idString

The ID of the version, if the custom metadata is being added to a document version.

Returns:

  • (String)


434
435
436
437
438
439
440
441
# File 'gems/aws-sdk-workdocs/lib/aws-sdk-workdocs/types.rb', line 434

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