CloudSearch / Client / describe_domain_endpoint_options

describe_domain_endpoint_options#

CloudSearch.Client.describe_domain_endpoint_options(**kwargs)#

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.

See also: AWS API Documentation

Request Syntax

response = client.describe_domain_endpoint_options(
    DomainName='string',
    Deployed=True|False
)
Parameters:

  • DomainName (string) –

    [REQUIRED]

    A string that represents the name of a domain.

  • Deployed (boolean) – Whether to retrieve the latest configuration (which might be in a Processing state) or the current, active configuration. Defaults to false.

Return type:

dict

Returns:

Response Syntax

{
    'DomainEndpointOptions': {
        'Options': {
            'EnforceHTTPS': True|False,
            'TLSSecurityPolicy': 'Policy-Min-TLS-1-0-2019-07'|'Policy-Min-TLS-1-2-2019-07'
        },
        'Status': {
            'CreationDate': datetime(2015, 1, 1),
            'UpdateDate': datetime(2015, 1, 1),
            'UpdateVersion': 123,
            'State': 'RequiresIndexDocuments'|'Processing'|'Active'|'FailedToValidate',
            'PendingDeletion': True|False
        }
    }
}

Response Structure

  • (dict) –

    The result of a DescribeDomainEndpointOptions request. Contains the status and configuration of a search domain’s endpoint options.

    • DomainEndpointOptions (dict) –

      The status and configuration of a search domain’s endpoint options.

      • Options (dict) –

        The domain endpoint options configured for the domain.

        • EnforceHTTPS (boolean) –

          Whether the domain is HTTPS only enabled.

        • TLSSecurityPolicy (string) –

          The minimum required TLS version

      • Status (dict) –

        The status of the configured domain endpoint options.

        • CreationDate (datetime) –

          A timestamp for when this option was created.

        • UpdateDate (datetime) –

          A timestamp for when this option was last updated.

        • UpdateVersion (integer) –

          A unique integer that indicates when this option was last updated.

        • State (string) –

          The state of processing a change to an option. Possible values:

          • RequiresIndexDocuments: the option’s latest value will not be deployed until IndexDocuments has been called and indexing is complete.

          • Processing: the option’s latest value is in the process of being activated.

          • Active: the option’s latest value is completely deployed.

          • FailedToValidate: the option value is not compatible with the domain’s data and cannot be used to index the data. You must either modify the option value or update or remove the incompatible documents.

        • PendingDeletion (boolean) –

          Indicates that the option will be deleted once processing is complete.

Exceptions