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

Class: Aws::WorkDocs::Types::CreateLabelsRequest

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

{
  resource_id: "ResourceIdType", # required
  labels: ["SharedLabel"], # required
  authentication_token: "AuthenticationHeaderType",
}

Instance Attribute Summary collapse

Instance Attribute Details

#authentication_tokenString

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

Returns:

  • (String)


471
472
473
474
475
476
# File 'gems/aws-sdk-workdocs/lib/aws-sdk-workdocs/types.rb', line 471

class CreateLabelsRequest < Struct.new(
  :resource_id,
  :labels,
  :authentication_token)
  include Aws::Structure
end

#labelsArray<String>

List of labels to add to the resource.

Returns:

  • (Array<String>)


471
472
473
474
475
476
# File 'gems/aws-sdk-workdocs/lib/aws-sdk-workdocs/types.rb', line 471

class CreateLabelsRequest < Struct.new(
  :resource_id,
  :labels,
  :authentication_token)
  include Aws::Structure
end

#resource_idString

The ID of the resource.

Returns:

  • (String)


471
472
473
474
475
476
# File 'gems/aws-sdk-workdocs/lib/aws-sdk-workdocs/types.rb', line 471

class CreateLabelsRequest < Struct.new(
  :resource_id,
  :labels,
  :authentication_token)
  include Aws::Structure
end