Skip to content

update_storage_virtual_machine async

update_storage_virtual_machine(
    *,
    config_overrides: Optional[AsyncFSxClientConfig] = None,
    active_directory_configuration: Optional[
        UpdateSvmActiveDirectoryConfiguration
    ] = None,
    client_request_token: Optional[ClientRequestToken] = None,
    storage_virtual_machine_id: Optional[StorageVirtualMachineId] = None,
    svm_admin_password: Optional[AdminPassword] = None,
) -> UpdateStorageVirtualMachineResponse

Updates an FSx for ONTAP storage virtual machine (SVM).

Parameters:

Raises:

  • BadRequest –

    A generic error indicating a failure with a client request.

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

  • StorageVirtualMachineNotFound –

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

  • UnsupportedOperation –

    The requested operation is not supported for this resource or API.

  • UnknownServiceError –

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

Source code in docs_src/capo_fsx/_services/async_f_sx.py
async def update_storage_virtual_machine(
    self,
    *,
    config_overrides: Optional[AsyncFSxClientConfig] = None,
    active_directory_configuration: Optional[
        "capo_fsx.types.update_svm_active_directory_configuration.UpdateSvmActiveDirectoryConfiguration"
    ] = None,
    client_request_token: Optional[
        "capo_fsx.types.client_request_token.ClientRequestToken"
    ] = None,
    storage_virtual_machine_id: Optional[
        "capo_fsx.types.storage_virtual_machine_id.StorageVirtualMachineId"
    ] = None,
    svm_admin_password: Optional[
        "capo_fsx.types.admin_password.AdminPassword"
    ] = None,
) -> "capo_fsx.types.update_storage_virtual_machine_response.UpdateStorageVirtualMachineResponse":
    """<p>Updates an FSx for ONTAP storage virtual machine (SVM).</p>

    Args:
        active_directory_configuration: <p>Specifies updates to an SVM's Microsoft Active Directory (AD) configuration.</p>
        storage_virtual_machine_id: <p>The ID of the SVM that you want to update, in the format <code>svm-0123456789abcdef0</code>.</p>
        svm_admin_password: <p>Specifies a new SvmAdminPassword.</p>

    Raises:
        capo_fsx.errors.bad_request.BadRequest: <p>A generic error indicating a failure with a client request.</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.storage_virtual_machine_not_found.StorageVirtualMachineNotFound: <p>No FSx for ONTAP SVMs were found based upon the supplied parameters.</p>
        capo_fsx.errors.unsupported_operation.UnsupportedOperation: <p>The requested operation is not supported for this resource or API.</p>
        capo_fsx.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_fsx.types.update_storage_virtual_machine_request.UpdateStorageVirtualMachineRequest]",
    ) -> AsyncOperationResponse[
        "capo_fsx.types.update_storage_virtual_machine_response.UpdateStorageVirtualMachineResponse"
    ]:
        import capo_fsx._operations.aws_simba_api_service_v20180301.update_storage_virtual_machine

        (
            output,
            http_response,
        ) = await capo_fsx._operations.aws_simba_api_service_v20180301.update_storage_virtual_machine.async_update_storage_virtual_machine(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    def _redact_input(
        input_: "capo_fsx.types.update_storage_virtual_machine_request.UpdateStorageVirtualMachineRequest",
    ) -> dict[str, Any]:
        import capo_fsx.types.update_storage_virtual_machine_request

        return (
            capo_fsx.types.update_storage_virtual_machine_request.redact_sensitive(
                input_
            )
        )

    interceptors_, options_ = self.operation_options(
        config_overrides,
        OperationLogging("UpdateStorageVirtualMachine", redact_input=_redact_input),
    )
    input_: capo_fsx.types.update_storage_virtual_machine_request.UpdateStorageVirtualMachineRequest = {}
    if active_directory_configuration is not None:
        input_["active_directory_configuration"] = active_directory_configuration
    if client_request_token is None:
        client_request_token = str(uuid.uuid4())
    input_["client_request_token"] = client_request_token
    if storage_virtual_machine_id is not None:
        input_["storage_virtual_machine_id"] = storage_virtual_machine_id
    if svm_admin_password is not None:
        input_["svm_admin_password"] = svm_admin_password

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