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

Class: Aws::FSx::Types::AdministrativeAction

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

Overview

Describes a specific Amazon FSx Administrative Action for the current Windows file system.

Instance Attribute Summary collapse

Instance Attribute Details

#administrative_action_typeString

Describes the type of administrative action, as follows:

  • FILE_SYSTEM_UPDATE - A file system update administrative action initiated by the user from the Amazon FSx console, API (UpdateFileSystem), or CLI (update-file-system). A

  • STORAGE_OPTIMIZATION - Once the FILE_SYSTEM_UPDATE task to increase a file system's storage capacity completes successfully, a STORAGE_OPTIMIZATION task starts. Storage optimization is the process of migrating the file system data to the new, larger disks. You can track the storage migration progress using the ProgressPercent property. When STORAGE_OPTIMIZATION completes successfully, the parent FILE_SYSTEM_UPDATE action status changes to COMPLETED. For more information, see Managing Storage Capacity.

Possible values:

  • FILE_SYSTEM_UPDATE
  • STORAGE_OPTIMIZATION

Returns:

  • (String)

    Describes the type of administrative action, as follows:

    • FILE_SYSTEM_UPDATE - A file system update administrative action initiated by the user from the Amazon FSx console, API (UpdateFileSystem), or CLI (update-file-system).

#failure_detailsTypes::AdministrativeActionFailureDetails

Provides information about a failed administrative action.

Returns:

#progress_percentInteger

Provides the percent complete of a STORAGE_OPTIMIZATION administrative action.

Returns:

  • (Integer)

    Provides the percent complete of a STORAGE_OPTIMIZATION administrative action.

#request_timeTime

Time that the administrative action request was received.

Returns:

  • (Time)

    Time that the administrative action request was received.

#statusString

Describes the status of the administrative action, as follows:

  • FAILED - Amazon FSx failed to process the administrative action successfully.

  • IN_PROGRESS - Amazon FSx is processing the administrative action.

  • PENDING - Amazon FSx is waiting to process the administrative action.

  • COMPLETED - Amazon FSx has finished processing the administrative task.

  • UPDATED_OPTIMIZING - For a storage capacity increase update, Amazon FSx has updated the file system with the new storage capacity, and is now performing the storage optimization process. For more information, see Managing Storage Capacity.

Returns:

  • (String)

    Describes the status of the administrative action, as follows:.

#target_file_system_valuesTypes::FileSystem

Describes the target StorageCapacity or ThroughputCapacity value provided in the UpdateFileSystem operation. Returned for FILE_SYSTEM_UPDATE administrative actions.

Returns:

  • (Types::FileSystem)

    Describes the target StorageCapacity or ThroughputCapacity value provided in the UpdateFileSystem operation.