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

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
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",
  },
}

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#authentication_token ⇒ String

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

Returns:

  • (String) 


400
401
402
403
404
405
406
 
# File 'lib/aws-sdk-workdocs/types.rb', line 400

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

#custom_metadata ⇒ Hash<String,String>

Custom metadata in the form of name-value pairs.

Returns:

  • (Hash<String,String>) 


400
401
402
403
404
405
406
 
# File 'lib/aws-sdk-workdocs/types.rb', line 400

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

#resource_id ⇒ String

The ID of the resource.

Returns:

  • (String) 


400
401
402
403
404
405
406
 
# File 'lib/aws-sdk-workdocs/types.rb', line 400

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

#version_id ⇒ String

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

Returns:

  • (String) 


400
401
402
403
404
405
406
 
# File 'lib/aws-sdk-workdocs/types.rb', line 400

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