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

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

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing DeleteLabelsRequest as input to an Aws::Client method, you can use a vanilla 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)

    Amazon WorkDocs authentication token.

#delete_allBoolean

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

Returns:

  • (Boolean)

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

#labelsArray<String>

List of labels to delete from the resource.

Returns:

  • (Array<String>)

    List of labels to delete from the resource.

#resource_idString

The ID of the resource.

Returns:

  • (String)

    The ID of the resource.