upgrade_domain ¶

def upgrade_domain(
    self,
    domain_name: "capo_opensearch.types.domain_name.DomainName",
    target_version: "capo_opensearch.types.version_string.VersionString",
    *,
    config_overrides: Optional[OpenSearchClientConfig] = None,
    perform_check_only: Optional["capo_opensearch.types.boolean.Boolean"] = None,
    advanced_options: Optional[
        "capo_opensearch.types.advanced_options.AdvancedOptions"
    ] = None,
) -> "capo_opensearch.types.upgrade_domain_response.UpgradeDomainResponse":
    """<p>Allows you to either upgrade your Amazon OpenSearch Service domain or perform an upgrade eligibility check to a compatible version of OpenSearch or Elasticsearch.</p>

    Args:
        domain_name: <p>Name of the OpenSearch Service domain that you want to upgrade.</p>
        target_version: <p>OpenSearch or Elasticsearch version to which you want to upgrade, in the format Opensearch_X.Y or Elasticsearch_X.Y.</p>
        perform_check_only: <p>When true, indicates that an upgrade eligibility check needs to be performed. Does not actually perform the upgrade.</p>
        advanced_options: <p>Only supports the <code>override_main_response_version</code> parameter and not other advanced options. You can only include this option when upgrading to an OpenSearch version. Specifies whether the domain reports its version as 7.10 so that it continues to work with Elasticsearch OSS clients and plugins.</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_already_exists_exception.ResourceAlreadyExistsException: <p>An exception for creating a resource that already exists.</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.
    """

    def _handler(
        req: "OperationRequest[capo_opensearch.types.upgrade_domain_request.UpgradeDomainRequest]",
    ) -> OperationResponse[
        "capo_opensearch.types.upgrade_domain_response.UpgradeDomainResponse"
    ]:
        import capo_opensearch._operations.amazon_open_search_service.upgrade_domain

        output, http_response = (
            capo_opensearch._operations.amazon_open_search_service.upgrade_domain.upgrade_domain(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("UpgradeDomain")
    )
    input_: capo_opensearch.types.upgrade_domain_request.UpgradeDomainRequest = {
        "domain_name": domain_name,
        "target_version": target_version,
    }
    if perform_check_only is not None:
        input_["perform_check_only"] = perform_check_only
    if advanced_options is not None:
        input_["advanced_options"] = advanced_options

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