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

Class: Aws::WorkDocs::Types::DeleteLabelsRequest

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

{
  resource_id: "ResourceIdType", # required
  authentication_token: "AuthenticationHeaderType",
  labels: ["Label"],
  delete_all: false,
}

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)


824
825
826
827
828
829
830
# File 'gems/aws-sdk-workdocs/lib/aws-sdk-workdocs/types.rb', line 824

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

#delete_allBoolean

Flag to request removal of all labels from the specified resource.

Returns:

  • (Boolean)


824
825
826
827
828
829
830
# File 'gems/aws-sdk-workdocs/lib/aws-sdk-workdocs/types.rb', line 824

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

#labelsArray<String>

List of labels to delete from the resource.

Returns:

  • (Array<String>)


824
825
826
827
828
829
830
# File 'gems/aws-sdk-workdocs/lib/aws-sdk-workdocs/types.rb', line 824

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

#resource_idString

The ID of the resource.

Returns:

  • (String)


824
825
826
827
828
829
830
# File 'gems/aws-sdk-workdocs/lib/aws-sdk-workdocs/types.rb', line 824

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