Skip to content

cancel_domain_config_change async 

cancel_domain_config_change(
    domain_name: DomainName,
    *,
    config_overrides: Optional[AsyncOpenSearchClientConfig] = None,
    dry_run: Optional[DryRun] = None,
) -> CancelDomainConfigChangeResponse

Cancels a pending configuration change on an Amazon OpenSearch Service domain.

Parameters:

  • dry_run (Optional[DryRun], default: None ) –

    When set to True, returns the list of change IDs and properties that will be cancelled without actually cancelling the change.

Raises:

Source code in docs_src/capo_opensearch/_services/async_open_search.py 
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
async def cancel_domain_config_change(
    self,
    domain_name: "capo_opensearch.types.domain_name.DomainName",
    *,
    config_overrides: Optional[AsyncOpenSearchClientConfig] = None,
    dry_run: Optional["capo_opensearch.types.dry_run.DryRun"] = None,
) -> "capo_opensearch.types.cancel_domain_config_change_response.CancelDomainConfigChangeResponse":
    """<p>Cancels a pending configuration change on an Amazon OpenSearch Service domain.</p>

    Args:
        dry_run: <p>When set to <code>True</code>, returns the list of change IDs and properties that will be cancelled without actually cancelling the change.</p>

    Raises:
        capo_opensearch.errors.base_exception.BaseException: <p>An error occurred while processing the request.</p>
        capo_opensearch.errors.disabled_operation_exception.DisabledOperationException: <p>An error occured because the client wanted to access an unsupported operation.</p>
        capo_opensearch.errors.internal_exception.InternalException: <p>Request processing failed because of an unknown error, exception, or internal failure.</p>
        capo_opensearch.errors.resource_not_found_exception.ResourceNotFoundException: <p>An exception for accessing or deleting a resource that doesn't exist.</p>
        capo_opensearch.errors.validation_exception.ValidationException: <p>An exception for accessing or deleting a resource that doesn't exist.</p>
        capo_opensearch.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_opensearch.types.cancel_domain_config_change_request.CancelDomainConfigChangeRequest]",
    ) -> AsyncOperationResponse[
        "capo_opensearch.types.cancel_domain_config_change_response.CancelDomainConfigChangeResponse"
    ]:
        import capo_opensearch._operations.amazon_open_search_service.cancel_domain_config_change

        (
            output,
            http_response,
        ) = await capo_opensearch._operations.amazon_open_search_service.cancel_domain_config_change.async_cancel_domain_config_change(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("CancelDomainConfigChange")
    )
    input_: capo_opensearch.types.cancel_domain_config_change_request.CancelDomainConfigChangeRequest = {
        "domain_name": domain_name
    }
    if dry_run is not None:
        input_["dry_run"] = dry_run

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