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

Class: Aws::WorkDocs::Types::UpdateFolderRequest

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

{
  authentication_token: "AuthenticationHeaderType",
  folder_id: "ResourceIdType", # required
  name: "ResourceNameType",
  parent_folder_id: "ResourceIdType",
  resource_state: "ACTIVE", # accepts ACTIVE, RESTORING, RECYCLING, RECYCLED
}

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)


2447
2448
2449
2450
2451
2452
2453
2454
# File 'gems/aws-sdk-workdocs/lib/aws-sdk-workdocs/types.rb', line 2447

class UpdateFolderRequest < Struct.new(
  :authentication_token,
  :folder_id,
  :name,
  :parent_folder_id,
  :resource_state)
  include Aws::Structure
end

#folder_idString

The ID of the folder.

Returns:

  • (String)


2447
2448
2449
2450
2451
2452
2453
2454
# File 'gems/aws-sdk-workdocs/lib/aws-sdk-workdocs/types.rb', line 2447

class UpdateFolderRequest < Struct.new(
  :authentication_token,
  :folder_id,
  :name,
  :parent_folder_id,
  :resource_state)
  include Aws::Structure
end

#nameString

The name of the folder.

Returns:

  • (String)


2447
2448
2449
2450
2451
2452
2453
2454
# File 'gems/aws-sdk-workdocs/lib/aws-sdk-workdocs/types.rb', line 2447

class UpdateFolderRequest < Struct.new(
  :authentication_token,
  :folder_id,
  :name,
  :parent_folder_id,
  :resource_state)
  include Aws::Structure
end

#parent_folder_idString

The ID of the parent folder.

Returns:

  • (String)


2447
2448
2449
2450
2451
2452
2453
2454
# File 'gems/aws-sdk-workdocs/lib/aws-sdk-workdocs/types.rb', line 2447

class UpdateFolderRequest < Struct.new(
  :authentication_token,
  :folder_id,
  :name,
  :parent_folder_id,
  :resource_state)
  include Aws::Structure
end

#resource_stateString

The resource state of the folder. Note that only ACTIVE and RECYCLED are accepted values from the API.

Returns:

  • (String)


2447
2448
2449
2450
2451
2452
2453
2454
# File 'gems/aws-sdk-workdocs/lib/aws-sdk-workdocs/types.rb', line 2447

class UpdateFolderRequest < Struct.new(
  :authentication_token,
  :folder_id,
  :name,
  :parent_folder_id,
  :resource_state)
  include Aws::Structure
end