update_location_fsx_windows ¶

def update_location_fsx_windows(
    self,
    location_arn: "capo_datasync.types.location_arn.LocationArn",
    *,
    config_overrides: Optional[DataSyncClientConfig] = None,
    subdirectory: Optional[
        "capo_datasync.types.fsx_windows_subdirectory.FsxWindowsSubdirectory"
    ] = None,
    domain: Optional[
        "capo_datasync.types.update_smb_domain.UpdateSmbDomain"
    ] = None,
    user: Optional["capo_datasync.types.smb_user.SmbUser"] = None,
    password: Optional["capo_datasync.types.smb_password.SmbPassword"] = None,
    cmk_secret_config: Optional[
        "capo_datasync.types.cmk_secret_config.CmkSecretConfig"
    ] = None,
    custom_secret_config: Optional[
        "capo_datasync.types.custom_secret_config.CustomSecretConfig"
    ] = None,
) -> "capo_datasync.types.update_location_fsx_windows_response.UpdateLocationFsxWindowsResponse":
    """<p>Modifies the following configuration parameters of the Amazon FSx for Windows File Server 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-fsx-location.html">Configuring DataSync transfers with FSx for Windows File Server</a>.</p>

    Args:
        location_arn: <p>Specifies the ARN of the FSx for Windows File Server transfer location that you're updating.</p>
        subdirectory: <p>Specifies a mount path for your file system using forward slashes. DataSync uses this subdirectory to read or write data (depending on whether the file system is a source or destination location).</p>
        domain: <p>Specifies the name of the Windows domain that your FSx for Windows File Server file system belongs to.</p> <p>If you have multiple Active Directory domains in your environment, configuring this parameter makes sure that DataSync connects to the right file system.</p>
        user: <p>Specifies the user with the permissions to mount and access the files, folders, and file metadata in your FSx for Windows File Server file system.</p> <p>For information about choosing a user with the right level of access for your transfer, see <a href="https://docs.aws.amazon.com/datasync/latest/userguide/create-fsx-location.html#create-fsx-windows-location-permissions">required permissions</a> for FSx for Windows File Server locations.</p>
        password: <p>Specifies the password of the user with the permissions to mount and access the files, folders, and file metadata in your FSx for Windows File Server file system.</p>
        cmk_secret_config: <p>Specifies configuration information for a DataSync-managed secret, such as a <code>Password</code> or set of credentials that DataSync uses to access a specific transfer location, and a customer-managed KMS key.</p>
        custom_secret_config: <p>Specifies configuration information for a customer-managed secret, such as a <code>Password</code> or set of credentials that DataSync uses to access a specific transfer location, and a customer-managed Identity and Access Management (IAM) role that provides access to the secret.</p>

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

    def _handler(
        req: "OperationRequest[capo_datasync.types.update_location_fsx_windows_request.UpdateLocationFsxWindowsRequest]",
    ) -> OperationResponse[
        "capo_datasync.types.update_location_fsx_windows_response.UpdateLocationFsxWindowsResponse"
    ]:
        import capo_datasync._operations.fmrs_service.update_location_fsx_windows

        output, http_response = (
            capo_datasync._operations.fmrs_service.update_location_fsx_windows.update_location_fsx_windows(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

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

        return capo_datasync.types.update_location_fsx_windows_request.redact_sensitive(
            input_
        )

    interceptors_, options_ = self.operation_options(
        config_overrides,
        OperationLogging("UpdateLocationFsxWindows", redact_input=_redact_input),
    )
    input_: capo_datasync.types.update_location_fsx_windows_request.UpdateLocationFsxWindowsRequest = {
        "location_arn": location_arn
    }
    if subdirectory is not None:
        input_["subdirectory"] = subdirectory
    if domain is not None:
        input_["domain"] = domain
    if user is not None:
        input_["user"] = user
    if password is not None:
        input_["password"] = password
    if cmk_secret_config is not None:
        input_["cmk_secret_config"] = cmk_secret_config
    if custom_secret_config is not None:
        input_["custom_secret_config"] = custom_secret_config

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