AdministrativeAction - Amazon FSx

AdministrativeAction

Describes a specific Amazon FSx administrative action for the current Windows or Lustre file system.

Contents

AdministrativeActionType

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).

  • STORAGE_OPTIMIZATION - Once the FILE_SYSTEM_UPDATE task to increase a file system's storage capacity completes successfully, a STORAGE_OPTIMIZATION task starts.

    • For Windows, storage optimization is the process of migrating the file system data to the new, larger disks.

    • For Lustre, storage optimization consists of rebalancing the data across the existing and newly added file servers.

    You can track the storage optimization 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 in the Amazon FSx for Windows File Server User Guide and Managing storage and throughput capacity in the Amazon FSx for Lustre User Guide.

  • FILE_SYSTEM_ALIAS_ASSOCIATION - A file system update to associate a new DNS alias with the file system. For more information, see AssociateFileSystemAliases.

  • FILE_SYSTEM_ALIAS_DISASSOCIATION - A file system update to disassociate a DNS alias from the file system. For more information, see DisassociateFileSystemAliases.

Type: String

Valid Values: FILE_SYSTEM_UPDATE | STORAGE_OPTIMIZATION | FILE_SYSTEM_ALIAS_ASSOCIATION | FILE_SYSTEM_ALIAS_DISASSOCIATION

Required: No

FailureDetails

Provides information about a failed administrative action.

Type: AdministrativeActionFailureDetails object

Required: No

ProgressPercent

Provides the percent complete of a STORAGE_OPTIMIZATION administrative action. Does not apply to any other administrative action type.

Type: Integer

Valid Range: Minimum value of 0. Maximum value of 100.

Required: No

RequestTime

Time that the administrative action request was received.

Type: Timestamp

Required: No

Status

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 in the Amazon FSx for Windows File Server User Guide and Managing storage and throughput capacity in the Amazon FSx for Lustre User Guide.

Type: String

Valid Values: FAILED | IN_PROGRESS | PENDING | COMPLETED | UPDATED_OPTIMIZING

Required: No

TargetFileSystemValues

Describes the target value for the administration action, provided in the UpdateFileSystem operation. Returned for FILE_SYSTEM_UPDATE administrative actions.

Type: FileSystem object

Required: No

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: