Skip to content

update_location_fsx_ontap async

update_location_fsx_ontap(
    location_arn: LocationArn,
    *,
    config_overrides: Optional[AsyncDataSyncClientConfig] = None,
    protocol: Optional[FsxUpdateProtocol] = None,
    subdirectory: Optional[FsxOntapSubdirectory] = None,
) -> UpdateLocationFsxOntapResponse

Modifies the following configuration parameters of the Amazon FSx for NetApp ONTAP transfer location that you're using with DataSync.

For more information, see Configuring DataSync transfers with FSx for ONTAP.

Parameters:

  • location_arn (LocationArn) –

    Specifies the Amazon Resource Name (ARN) of the FSx for ONTAP transfer location that you're updating.

  • protocol (Optional[FsxUpdateProtocol], default: None ) –

    Specifies the data transfer protocol that DataSync uses to access your Amazon FSx file system.

  • subdirectory (Optional[FsxOntapSubdirectory], default: None ) –

    Specifies a path to the file share in the storage virtual machine (SVM) where you want to transfer data to or from.

    You can specify a junction path (also known as a mount point), qtree path (for NFS file shares), or share name (for SMB file shares). For example, your mount path might be /vol1, /vol1/tree1, or /share1.

    Don't specify a junction path in the SVM's root volume. For more information, see Managing FSx for ONTAP storage virtual machines in the Amazon FSx for NetApp ONTAP User Guide.

Raises:

Source code in docs_src/capo_datasync/_services/async_data_sync.py
async def update_location_fsx_ontap(
    self,
    location_arn: "capo_datasync.types.location_arn.LocationArn",
    *,
    config_overrides: Optional[AsyncDataSyncClientConfig] = None,
    protocol: Optional[
        "capo_datasync.types.fsx_update_protocol.FsxUpdateProtocol"
    ] = None,
    subdirectory: Optional[
        "capo_datasync.types.fsx_ontap_subdirectory.FsxOntapSubdirectory"
    ] = None,
) -> "capo_datasync.types.update_location_fsx_ontap_response.UpdateLocationFsxOntapResponse":
    """<p>Modifies the following configuration parameters of the Amazon FSx for NetApp ONTAP transfer location that you're using with DataSync.</p> <p>For more information, see <a href="https://docs.aws.amazon.com/datasync/latest/userguide/create-ontap-location.html">Configuring DataSync transfers with FSx for ONTAP</a>.</p>

    Args:
        location_arn: <p>Specifies the Amazon Resource Name (ARN) of the FSx for ONTAP transfer location that you're updating.</p>
        protocol: <p>Specifies the data transfer protocol that DataSync uses to access your Amazon FSx file system.</p>
        subdirectory: <p>Specifies a path to the file share in the storage virtual machine (SVM) where you want to transfer data to or from.</p> <p>You can specify a junction path (also known as a mount point), qtree path (for NFS file shares), or share name (for SMB file shares). For example, your mount path might be <code>/vol1</code>, <code>/vol1/tree1</code>, or <code>/share1</code>.</p> <note> <p>Don't specify a junction path in the SVM's root volume. For more information, see <a href="https://docs.aws.amazon.com/fsx/latest/ONTAPGuide/managing-svms.html">Managing FSx for ONTAP storage virtual machines</a> in the <i>Amazon FSx for NetApp ONTAP User Guide</i>.</p> </note>

    Raises:
        capo_datasync.errors.internal_exception.InternalException: <p>This exception is thrown when an error occurs in the DataSync service.</p>
        capo_datasync.errors.invalid_request_exception.InvalidRequestException: <p>This exception is thrown when the client submits a malformed request.</p>
        capo_datasync.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_datasync.types.update_location_fsx_ontap_request.UpdateLocationFsxOntapRequest]",
    ) -> AsyncOperationResponse[
        "capo_datasync.types.update_location_fsx_ontap_response.UpdateLocationFsxOntapResponse"
    ]:
        import capo_datasync._operations.fmrs_service.update_location_fsx_ontap

        (
            output,
            http_response,
        ) = await capo_datasync._operations.fmrs_service.update_location_fsx_ontap.async_update_location_fsx_ontap(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    def _redact_input(
        input_: "capo_datasync.types.update_location_fsx_ontap_request.UpdateLocationFsxOntapRequest",
    ) -> dict[str, Any]:
        import capo_datasync.types.update_location_fsx_ontap_request

        return (
            capo_datasync.types.update_location_fsx_ontap_request.redact_sensitive(
                input_
            )
        )

    interceptors_, options_ = self.operation_options(
        config_overrides,
        OperationLogging("UpdateLocationFsxOntap", redact_input=_redact_input),
    )
    input_: capo_datasync.types.update_location_fsx_ontap_request.UpdateLocationFsxOntapRequest = {
        "location_arn": location_arn
    }
    if protocol is not None:
        input_["protocol"] = protocol
    if subdirectory is not None:
        input_["subdirectory"] = subdirectory

    response = await aexecute_pipeline(
        AsyncOperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    await response.response.aclose()
    return response.output