Skip to content

AdministrativeAction

Source code in docs_src/capo_fsx/types/administrative_action.py
class AdministrativeAction(TypedDict, closed=True):
    administrative_action_type: NotRequired[
        "capo_fsx.types.administrative_action_type.AdministrativeActionType"
    ]
    progress_percent: NotRequired["capo_fsx.types.progress_percent.ProgressPercent"]
    """<p>The percentage-complete status of a <code>STORAGE_OPTIMIZATION</code> or <code>DOWNLOAD_DATA_FROM_BACKUP</code> administrative action. Does not apply to any other administrative action type.</p>"""
    request_time: NotRequired["capo_fsx.types.request_time.RequestTime"]
    """<p>The time that the administrative action request was received.</p>"""
    status: NotRequired["capo_fsx.types.status.Status"]
    """<p>The status of the administrative action, as follows:</p> <ul> <li> <p> <code>FAILED</code> - Amazon FSx failed to process the administrative action successfully.</p> </li> <li> <p> <code>IN_PROGRESS</code> - Amazon FSx is processing the administrative action.</p> </li> <li> <p> <code>PENDING</code> - Amazon FSx is waiting to process the administrative action.</p> </li> <li> <p> <code>COMPLETED</code> - Amazon FSx has finished processing the administrative task.</p> <p>For a backup restore to a second-generation FSx for ONTAP file system, indicates that all data has been downloaded to the volume, and clients now have read-write access to volume.</p> </li> <li> <p> <code>UPDATED_OPTIMIZING</code> - 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.</p> </li> <li> <p> <code>PENDING</code> - For a backup restore to a second-generation FSx for ONTAP file system, indicates that the file metadata is being downloaded onto the volume. The volume's Lifecycle state is CREATING.</p> </li> <li> <p> <code>IN_PROGRESS</code> - For a backup restore to a second-generation FSx for ONTAP file system, indicates that all metadata has been downloaded to the new volume and client can access data with read-only access while Amazon FSx downloads the file data to the volume. Track the progress of this process with the <code>ProgressPercent</code> element.</p> </li> </ul>"""
    target_file_system_values: NotRequired["capo_fsx.types.file_system.FileSystem"]
    """<p>The target value for the administration action, provided in the <code>UpdateFileSystem</code> operation. Returned for <code>FILE_SYSTEM_UPDATE</code> administrative actions. </p>"""
    failure_details: NotRequired[
        "capo_fsx.types.administrative_action_failure_details.AdministrativeActionFailureDetails"
    ]
    target_volume_values: NotRequired["capo_fsx.types.volume.Volume"]
    target_snapshot_values: NotRequired["capo_fsx.types.snapshot.Snapshot"]
    total_transfer_bytes: NotRequired[
        "capo_fsx.types.total_transfer_bytes.TotalTransferBytes"
    ]
    """<p>The number of bytes that have transferred for the FSx for OpenZFS snapshot that you're copying.</p>"""
    remaining_transfer_bytes: NotRequired[
        "capo_fsx.types.remaining_transfer_bytes.RemainingTransferBytes"
    ]
    """<p>The remaining bytes to transfer for the FSx for OpenZFS snapshot that you're copying.</p>"""
    message: NotRequired["capo_fsx.types.error_message.ErrorMessage"]

administrative_action_type instance-attribute

administrative_action_type: NotRequired[AdministrativeActionType]

failure_details instance-attribute

failure_details: NotRequired[AdministrativeActionFailureDetails]

message instance-attribute

message: NotRequired[ErrorMessage]

progress_percent instance-attribute

progress_percent: NotRequired[ProgressPercent]

The percentage-complete status of a STORAGE_OPTIMIZATION or DOWNLOAD_DATA_FROM_BACKUP administrative action. Does not apply to any other administrative action type.

remaining_transfer_bytes instance-attribute

remaining_transfer_bytes: NotRequired[RemainingTransferBytes]

The remaining bytes to transfer for the FSx for OpenZFS snapshot that you're copying.

request_time instance-attribute

request_time: NotRequired[RequestTime]

The time that the administrative action request was received.

status instance-attribute

status: NotRequired[Status]

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.

    For a backup restore to a second-generation FSx for ONTAP file system, indicates that all data has been downloaded to the volume, and clients now have read-write access to volume.

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

  • PENDING - For a backup restore to a second-generation FSx for ONTAP file system, indicates that the file metadata is being downloaded onto the volume. The volume's Lifecycle state is CREATING.

  • IN_PROGRESS - For a backup restore to a second-generation FSx for ONTAP file system, indicates that all metadata has been downloaded to the new volume and client can access data with read-only access while Amazon FSx downloads the file data to the volume. Track the progress of this process with the ProgressPercent element.

target_file_system_values instance-attribute

target_file_system_values: NotRequired[FileSystem]

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

target_snapshot_values instance-attribute

target_snapshot_values: NotRequired[Snapshot]

target_volume_values instance-attribute

target_volume_values: NotRequired[Volume]

total_transfer_bytes instance-attribute

total_transfer_bytes: NotRequired[TotalTransferBytes]

The number of bytes that have transferred for the FSx for OpenZFS snapshot that you're copying.