Skip to content

archive_wave

archive_wave(
    wave_id: WaveID,
    *,
    config_overrides: Optional[mgnClientConfig] = None,
    account_id: Optional[AccountID] = None,
) -> Wave

Archive wave.

Parameters:

Raises:

Source code in docs_src/capo_mgn/_services/mgn.py
def archive_wave(
    self,
    wave_id: "capo_mgn.types.wave_id.WaveID",
    *,
    config_overrides: Optional[mgnClientConfig] = None,
    account_id: Optional["capo_mgn.types.account_id.AccountID"] = None,
) -> "capo_mgn.types.wave.Wave":
    """<p>Archive wave.</p>

    Args:
        wave_id: <p>Wave ID.</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.service_quota_exceeded_exception.ServiceQuotaExceededException: <p>The request could not be completed because it exceeded the service quota.</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.
    """

    def _handler(
        req: "OperationRequest[capo_mgn.types.archive_wave_request.ArchiveWaveRequest]",
    ) -> OperationResponse["capo_mgn.types.wave.Wave"]:
        import capo_mgn._operations.application_migration_service.archive_wave

        output, http_response = (
            capo_mgn._operations.application_migration_service.archive_wave.archive_wave(
                req.options, req.input
            )
        )
        return OperationResponse(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("ArchiveWave", redact_output=_redact_output),
    )
    input_: capo_mgn.types.archive_wave_request.ArchiveWaveRequest = {
        "wave_id": wave_id
    }
    if account_id is not None:
        input_["account_id"] = account_id

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