Returns 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.
-
deployed
(Optional[Boolean], default:
None
)
–
Whether to retrieve the latest configuration (which might be in a Processing state) or the current, active configuration. Defaults to false.
Raises:
Source code in docs_src/capo_cloudsearch/_services/cloud_search.py
| def describe_domain_endpoint_options(
self,
domain_name: "capo_cloudsearch.types.domain_name.DomainName",
*,
config_overrides: Optional[CloudSearchClientConfig] = None,
deployed: Optional["capo_cloudsearch.types.boolean.Boolean"] = None,
) -> "capo_cloudsearch.types.describe_domain_endpoint_options_response.DescribeDomainEndpointOptionsResponse":
"""<p>Returns 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>
deployed: <p>Whether to retrieve the latest configuration (which might be in a Processing state) or the current, active configuration. Defaults to <code>false</code>.</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.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.UnknownServiceError: The service returned an error code this client does not model.
"""
def _handler(
req: "OperationRequest[capo_cloudsearch.types.describe_domain_endpoint_options_request.DescribeDomainEndpointOptionsRequest]",
) -> OperationResponse[
"capo_cloudsearch.types.describe_domain_endpoint_options_response.DescribeDomainEndpointOptionsResponse"
]:
import capo_cloudsearch._operations.a9_search_cloud_config_service2013.describe_domain_endpoint_options
output, http_response = (
capo_cloudsearch._operations.a9_search_cloud_config_service2013.describe_domain_endpoint_options.describe_domain_endpoint_options(
req.options, req.input
)
)
return OperationResponse(output=output, response=http_response)
interceptors_, options_ = self.operation_options(
config_overrides, OperationLogging("DescribeDomainEndpointOptions")
)
input_: capo_cloudsearch.types.describe_domain_endpoint_options_request.DescribeDomainEndpointOptionsRequest = {
"domain_name": domain_name
}
if deployed is not None:
input_["deployed"] = deployed
response = execute_pipeline(
OperationRequest(input=input_, options=options_),
handler=_handler,
interceptors=list(interceptors_),
)
response.response.close()
return response.output
|