Skip to content

update_wave async

update_wave(
    wave_id: WaveID,
    *,
    config_overrides: Optional[AsyncmgnClientConfig] = None,
    name: Optional[WaveName] = None,
    description: Optional[WaveDescription] = None,
    account_id: Optional[AccountID] = None,
) -> Wave

Update wave.

Parameters:

Raises:

Source code in docs_src/capo_mgn/_services/async_mgn.py
async def update_wave(
    self,
    wave_id: "capo_mgn.types.wave_id.WaveID",
    *,
    config_overrides: Optional[AsyncmgnClientConfig] = None,
    name: Optional["capo_mgn.types.wave_name.WaveName"] = None,
    description: Optional["capo_mgn.types.wave_description.WaveDescription"] = None,
    account_id: Optional["capo_mgn.types.account_id.AccountID"] = None,
) -> "capo_mgn.types.wave.Wave":
    """<p>Update wave.</p>

    Args:
        wave_id: <p>Wave ID.</p>
        name: <p>Wave name.</p>
        description: <p>Wave description.</p>
        account_id: <p>Account ID.</p>

    Raises:
        capo_mgn.errors.conflict_exception.ConflictException: <p>The request could not be completed due to a conflict with the current state of the target resource.</p>
        capo_mgn.errors.resource_not_found_exception.ResourceNotFoundException: <p>Resource not found exception.</p>
        capo_mgn.errors.uninitialized_account_exception.UninitializedAccountException: <p>Uninitialized account exception.</p>
        capo_mgn.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_mgn.types.update_wave_request.UpdateWaveRequest]",
    ) -> AsyncOperationResponse["capo_mgn.types.wave.Wave"]:
        import capo_mgn._operations.application_migration_service.update_wave

        (
            output,
            http_response,
        ) = await capo_mgn._operations.application_migration_service.update_wave.async_update_wave(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    def _redact_output(output: "capo_mgn.types.wave.Wave") -> dict[str, Any]:
        import capo_mgn.types.wave

        return capo_mgn.types.wave.redact_sensitive(output)

    interceptors_, options_ = self.operation_options(
        config_overrides,
        OperationLogging("UpdateWave", redact_output=_redact_output),
    )
    input_: capo_mgn.types.update_wave_request.UpdateWaveRequest = {
        "wave_id": wave_id
    }
    if name is not None:
        input_["name"] = name
    if description is not None:
        input_["description"] = description
    if account_id is not None:
        input_["account_id"] = account_id

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