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: ["SharedLabel"],
  delete_all: false,
}

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)


902
903
904
905
906
907
908
909
# File 'gems/aws-sdk-workdocs/lib/aws-sdk-workdocs/types.rb', line 902

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

#delete_allBoolean

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

Returns:

  • (Boolean)


902
903
904
905
906
907
908
909
# File 'gems/aws-sdk-workdocs/lib/aws-sdk-workdocs/types.rb', line 902

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

#labelsArray<String>

List of labels to delete from the resource.

Returns:

  • (Array<String>)


902
903
904
905
906
907
908
909
# File 'gems/aws-sdk-workdocs/lib/aws-sdk-workdocs/types.rb', line 902

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

#resource_idString

The ID of the resource.

Returns:

  • (String)


902
903
904
905
906
907
908
909
# File 'gems/aws-sdk-workdocs/lib/aws-sdk-workdocs/types.rb', line 902

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