Skip to content

update_domain_endpoint_options async

update_domain_endpoint_options(
    domain_name: DomainName,
    domain_endpoint_options: DomainEndpointOptions,
    *,
    config_overrides: Optional[AsyncCloudSearchClientConfig] = None,
) -> UpdateDomainEndpointOptionsResponse

Updates the domain's endpoint options, specifically whether all requests to the domain must arrive over HTTPS. For more information, see Configuring Domain Endpoint Options in the Amazon CloudSearch Developer Guide.

Parameters:

  • domain_name (DomainName) –

    A string that represents the name of a domain.

  • domain_endpoint_options (DomainEndpointOptions) –

    Whether to require that all requests to the domain arrive over HTTPS. We recommend Policy-Min-TLS-1-2-2019-07 for TLSSecurityPolicy. For compatibility with older clients, the default is Policy-Min-TLS-1-0-2019-07.

Raises:

Source code in docs_src/capo_cloudsearch/_services/async_cloud_search.py
async def update_domain_endpoint_options(
    self,
    domain_name: "capo_cloudsearch.types.domain_name.DomainName",
    domain_endpoint_options: "capo_cloudsearch.types.domain_endpoint_options.DomainEndpointOptions",
    *,
    config_overrides: Optional[AsyncCloudSearchClientConfig] = None,
) -> "capo_cloudsearch.types.update_domain_endpoint_options_response.UpdateDomainEndpointOptionsResponse":
    """<p>Updates the domain's endpoint options, specifically whether all requests to the domain must arrive over HTTPS. For more information, see <a href="http://docs.aws.amazon.com/cloudsearch/latest/developerguide/configuring-domain-endpoint-options.html" target="_blank">Configuring Domain Endpoint Options</a> in the <i>Amazon CloudSearch Developer Guide</i>.</p>

    Args:
        domain_name: <p>A string that represents the name of a domain.</p>
        domain_endpoint_options: <p>Whether to require that all requests to the domain arrive over HTTPS. We recommend Policy-Min-TLS-1-2-2019-07 for TLSSecurityPolicy. For compatibility with older clients, the default is Policy-Min-TLS-1-0-2019-07. </p>

    Raises:
        capo_cloudsearch.errors.base_exception.BaseException: <p>An error occurred while processing the request.</p>
        capo_cloudsearch.errors.disabled_operation_exception.DisabledOperationException: <p>The request was rejected because it attempted an operation which is not enabled.</p>
        capo_cloudsearch.errors.internal_exception.InternalException: <p>An internal error occurred while processing the request. If this problem persists, report an issue from the <a href="http://status.aws.amazon.com/" target="_blank">Service Health Dashboard</a>.</p>
        capo_cloudsearch.errors.invalid_type_exception.InvalidTypeException: <p>The request was rejected because it specified an invalid type definition.</p>
        capo_cloudsearch.errors.limit_exceeded_exception.LimitExceededException: <p>The request was rejected because a resource limit has already been met.</p>
        capo_cloudsearch.errors.resource_not_found_exception.ResourceNotFoundException: <p>The request was rejected because it attempted to reference a resource that does not exist.</p>
        capo_cloudsearch.errors.validation_exception.ValidationException: <p>The request was rejected because it has invalid parameters.</p>
        capo_cloudsearch.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_cloudsearch.types.update_domain_endpoint_options_request.UpdateDomainEndpointOptionsRequest]",
    ) -> AsyncOperationResponse[
        "capo_cloudsearch.types.update_domain_endpoint_options_response.UpdateDomainEndpointOptionsResponse"
    ]:
        import capo_cloudsearch._operations.a9_search_cloud_config_service2013.update_domain_endpoint_options

        (
            output,
            http_response,
        ) = await capo_cloudsearch._operations.a9_search_cloud_config_service2013.update_domain_endpoint_options.async_update_domain_endpoint_options(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("UpdateDomainEndpointOptions")
    )
    input_: capo_cloudsearch.types.update_domain_endpoint_options_request.UpdateDomainEndpointOptionsRequest = {
        "domain_name": domain_name,
        "domain_endpoint_options": domain_endpoint_options,
    }

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