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
}

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)


3029
3030
3031
3032
3033
3034
3035
3036
3037
# File 'gems/aws-sdk-workdocs/lib/aws-sdk-workdocs/types.rb', line 3029

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

#folder_idString

The ID of the folder.

Returns:

  • (String)


3029
3030
3031
3032
3033
3034
3035
3036
3037
# File 'gems/aws-sdk-workdocs/lib/aws-sdk-workdocs/types.rb', line 3029

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

#nameString

The name of the folder.

Returns:

  • (String)


3029
3030
3031
3032
3033
3034
3035
3036
3037
# File 'gems/aws-sdk-workdocs/lib/aws-sdk-workdocs/types.rb', line 3029

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

#parent_folder_idString

The ID of the parent folder.

Returns:

  • (String)


3029
3030
3031
3032
3033
3034
3035
3036
3037
# File 'gems/aws-sdk-workdocs/lib/aws-sdk-workdocs/types.rb', line 3029

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

#resource_stateString

The resource state of the folder. Only ACTIVE and RECYCLED are accepted values from the API.

Returns:

  • (String)


3029
3030
3031
3032
3033
3034
3035
3036
3037
# File 'gems/aws-sdk-workdocs/lib/aws-sdk-workdocs/types.rb', line 3029

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