Skip to content

create_volume_from_backup

create_volume_from_backup(
    *,
    config_overrides: Optional[FSxClientConfig] = None,
    backup_id: Optional[BackupId] = None,
    client_request_token: Optional[ClientRequestToken] = None,
    name: Optional[VolumeName] = None,
    ontap_configuration: Optional[CreateOntapVolumeConfiguration] = None,
    tags: Optional[Tags] = None,
) -> CreateVolumeFromBackupResponse

Creates a new Amazon FSx for NetApp ONTAP volume from an existing Amazon FSx volume backup.

Parameters:

Raises:

  • BackupNotFound –

    No Amazon FSx backups were found based upon the supplied parameters.

  • BadRequest –

    A generic error indicating a failure with a client request.

  • FileSystemNotFound –

    No Amazon FSx file systems were found based upon supplied parameters.

  • IncompatibleParameterError –

    The error returned when a second request is received with the same client request token but different parameters settings. A client request token should always uniquely identify a single request.

  • InternalServerError –

    A generic error indicating a server-side failure.

  • MissingVolumeConfiguration –

    A volume configuration is required for this operation.

  • ServiceLimitExceeded –

    An error indicating that a particular service limit was exceeded. You can increase some service limits by contacting Amazon Web Services Support.

  • StorageVirtualMachineNotFound –

    No FSx for ONTAP SVMs were found based upon the supplied parameters.

  • UnknownServiceError –

    The service returned an error code this client does not model.

Source code in docs_src/capo_fsx/_services/f_sx.py
def create_volume_from_backup(
    self,
    *,
    config_overrides: Optional[FSxClientConfig] = None,
    backup_id: Optional["capo_fsx.types.backup_id.BackupId"] = None,
    client_request_token: Optional[
        "capo_fsx.types.client_request_token.ClientRequestToken"
    ] = None,
    name: Optional["capo_fsx.types.volume_name.VolumeName"] = None,
    ontap_configuration: Optional[
        "capo_fsx.types.create_ontap_volume_configuration.CreateOntapVolumeConfiguration"
    ] = None,
    tags: Optional["capo_fsx.types.tags.Tags"] = None,
) -> "capo_fsx.types.create_volume_from_backup_response.CreateVolumeFromBackupResponse":
    """<p>Creates a new Amazon FSx for NetApp ONTAP volume from an existing Amazon FSx volume backup.</p>

    Args:
        name: <p>The name of the new volume you're creating.</p>
        ontap_configuration: <p>Specifies the configuration of the ONTAP volume that you are creating.</p>

    Raises:
        capo_fsx.errors.backup_not_found.BackupNotFound: <p>No Amazon FSx backups were found based upon the supplied parameters.</p>
        capo_fsx.errors.bad_request.BadRequest: <p>A generic error indicating a failure with a client request.</p>
        capo_fsx.errors.file_system_not_found.FileSystemNotFound: <p>No Amazon FSx file systems were found based upon supplied parameters.</p>
        capo_fsx.errors.incompatible_parameter_error.IncompatibleParameterError: <p>The error returned when a second request is received with the same client request token but different parameters settings. A client request token should always uniquely identify a single request.</p>
        capo_fsx.errors.internal_server_error.InternalServerError: <p>A generic error indicating a server-side failure.</p>
        capo_fsx.errors.missing_volume_configuration.MissingVolumeConfiguration: <p>A volume configuration is required for this operation.</p>
        capo_fsx.errors.service_limit_exceeded.ServiceLimitExceeded: <p>An error indicating that a particular service limit was exceeded. You can increase some service limits by contacting Amazon Web Services Support.</p>
        capo_fsx.errors.storage_virtual_machine_not_found.StorageVirtualMachineNotFound: <p>No FSx for ONTAP SVMs were found based upon the supplied parameters.</p>
        capo_fsx.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_fsx.types.create_volume_from_backup_request.CreateVolumeFromBackupRequest]",
    ) -> OperationResponse[
        "capo_fsx.types.create_volume_from_backup_response.CreateVolumeFromBackupResponse"
    ]:
        import capo_fsx._operations.aws_simba_api_service_v20180301.create_volume_from_backup

        output, http_response = (
            capo_fsx._operations.aws_simba_api_service_v20180301.create_volume_from_backup.create_volume_from_backup(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    def _redact_output(
        output: "capo_fsx.types.create_volume_from_backup_response.CreateVolumeFromBackupResponse",
    ) -> dict[str, Any]:
        import capo_fsx.types.create_volume_from_backup_response

        return capo_fsx.types.create_volume_from_backup_response.redact_sensitive(
            output
        )

    interceptors_, options_ = self.operation_options(
        config_overrides,
        OperationLogging("CreateVolumeFromBackup", redact_output=_redact_output),
    )
    input_: capo_fsx.types.create_volume_from_backup_request.CreateVolumeFromBackupRequest = {}
    if backup_id is not None:
        input_["backup_id"] = backup_id
    if client_request_token is None:
        client_request_token = str(uuid.uuid4())
    input_["client_request_token"] = client_request_token
    if name is not None:
        input_["name"] = name
    if ontap_configuration is not None:
        input_["ontap_configuration"] = ontap_configuration
    if tags is not None:
        input_["tags"] = tags

    response = execute_pipeline(
        OperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    response.response.close()
    return response.output