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

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",
  },
}

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)


380
381
382
383
384
385
386
# File 'gems/aws-sdk-workdocs/lib/aws-sdk-workdocs/types.rb', line 380

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

#custom_metadataHash<String,String>

Custom metadata in the form of name-value pairs.

Returns:

  • (Hash<String,String>)


380
381
382
383
384
385
386
# File 'gems/aws-sdk-workdocs/lib/aws-sdk-workdocs/types.rb', line 380

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

#resource_idString

The ID of the resource.

Returns:

  • (String)


380
381
382
383
384
385
386
# File 'gems/aws-sdk-workdocs/lib/aws-sdk-workdocs/types.rb', line 380

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

#version_idString

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

Returns:

  • (String)


380
381
382
383
384
385
386
# File 'gems/aws-sdk-workdocs/lib/aws-sdk-workdocs/types.rb', line 380

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