Skip to content

get_upgrade_status

get_upgrade_status(
    domain_name: DomainName,
    *,
    config_overrides: Optional[ElasticsearchServiceClientConfig] = None,
) -> GetUpgradeStatusResponse

Retrieves the latest status of the last upgrade or upgrade eligibility check that was performed on the domain.

Raises:

  • BaseException –

    An error occurred while processing the request.

  • DisabledOperationException –

    An error occured because the client wanted to access a not supported operation. Gives http status code of 409.

  • InternalException –

    The request processing has failed because of an unknown error, exception or failure (the failure is internal to the service) . Gives http status code of 500.

  • ResourceNotFoundException –

    An exception for accessing or deleting a resource that does not exist. Gives http status code of 400.

  • ValidationException –

    An exception for missing / invalid input fields. Gives http status code of 400.

  • UnknownServiceError –

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

Source code in docs_src/capo_elasticsearch_service/_services/elasticsearch_service.py
def get_upgrade_status(
    self,
    domain_name: "capo_elasticsearch_service.types.domain_name.DomainName",
    *,
    config_overrides: Optional[ElasticsearchServiceClientConfig] = None,
) -> "capo_elasticsearch_service.types.get_upgrade_status_response.GetUpgradeStatusResponse":
    """<p>Retrieves the latest status of the last upgrade or upgrade eligibility check that was performed on the domain.</p>

    Raises:
        capo_elasticsearch_service.errors.base_exception.BaseException: <p>An error occurred while processing the request.</p>
        capo_elasticsearch_service.errors.disabled_operation_exception.DisabledOperationException: <p>An error occured because the client wanted to access a not supported operation. Gives http status code of 409.</p>
        capo_elasticsearch_service.errors.internal_exception.InternalException: <p>The request processing has failed because of an unknown error, exception or failure (the failure is internal to the service) . Gives http status code of 500.</p>
        capo_elasticsearch_service.errors.resource_not_found_exception.ResourceNotFoundException: <p>An exception for accessing or deleting a resource that does not exist. Gives http status code of 400.</p>
        capo_elasticsearch_service.errors.validation_exception.ValidationException: <p>An exception for missing / invalid input fields. Gives http status code of 400.</p>
        capo_elasticsearch_service.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_elasticsearch_service.types.get_upgrade_status_request.GetUpgradeStatusRequest]",
    ) -> OperationResponse[
        "capo_elasticsearch_service.types.get_upgrade_status_response.GetUpgradeStatusResponse"
    ]:
        import capo_elasticsearch_service._operations.amazon_elasticsearch_service2015.get_upgrade_status

        output, http_response = (
            capo_elasticsearch_service._operations.amazon_elasticsearch_service2015.get_upgrade_status.get_upgrade_status(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("GetUpgradeStatus")
    )
    input_: capo_elasticsearch_service.types.get_upgrade_status_request.GetUpgradeStatusRequest = {
        "domain_name": domain_name
    }

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