libZSservicesZSamazonka-cloudsearchZSamazonka-cloudsearch
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

Amazonka.CloudSearch.DescribeDomainEndpointOptions

Description

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.

Synopsis

Creating a Request

data DescribeDomainEndpointOptions Source #

Container for the parameters to the DescribeDomainEndpointOptions operation. Specify the name of the domain you want to describe. To show the active configuration and exclude any pending changes, set the Deployed option to true.

See: newDescribeDomainEndpointOptions smart constructor.

Constructors

DescribeDomainEndpointOptions' 

Fields

  • deployed :: Maybe Bool

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

  • domainName :: Text

    A string that represents the name of a domain.

Instances

Instances details
Eq DescribeDomainEndpointOptions Source # 
Instance details

Defined in Amazonka.CloudSearch.DescribeDomainEndpointOptions

Read DescribeDomainEndpointOptions Source # 
Instance details

Defined in Amazonka.CloudSearch.DescribeDomainEndpointOptions

Show DescribeDomainEndpointOptions Source # 
Instance details

Defined in Amazonka.CloudSearch.DescribeDomainEndpointOptions

Generic DescribeDomainEndpointOptions Source # 
Instance details

Defined in Amazonka.CloudSearch.DescribeDomainEndpointOptions

Associated Types

type Rep DescribeDomainEndpointOptions :: Type -> Type #

NFData DescribeDomainEndpointOptions Source # 
Instance details

Defined in Amazonka.CloudSearch.DescribeDomainEndpointOptions

Hashable DescribeDomainEndpointOptions Source # 
Instance details

Defined in Amazonka.CloudSearch.DescribeDomainEndpointOptions

AWSRequest DescribeDomainEndpointOptions Source # 
Instance details

Defined in Amazonka.CloudSearch.DescribeDomainEndpointOptions

ToHeaders DescribeDomainEndpointOptions Source # 
Instance details

Defined in Amazonka.CloudSearch.DescribeDomainEndpointOptions

ToPath DescribeDomainEndpointOptions Source # 
Instance details

Defined in Amazonka.CloudSearch.DescribeDomainEndpointOptions

ToQuery DescribeDomainEndpointOptions Source # 
Instance details

Defined in Amazonka.CloudSearch.DescribeDomainEndpointOptions

type Rep DescribeDomainEndpointOptions Source # 
Instance details

Defined in Amazonka.CloudSearch.DescribeDomainEndpointOptions

type Rep DescribeDomainEndpointOptions = D1 ('MetaData "DescribeDomainEndpointOptions" "Amazonka.CloudSearch.DescribeDomainEndpointOptions" "libZSservicesZSamazonka-cloudsearchZSamazonka-cloudsearch" 'False) (C1 ('MetaCons "DescribeDomainEndpointOptions'" 'PrefixI 'True) (S1 ('MetaSel ('Just "deployed") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: S1 ('MetaSel ('Just "domainName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))
type AWSResponse DescribeDomainEndpointOptions Source # 
Instance details

Defined in Amazonka.CloudSearch.DescribeDomainEndpointOptions

newDescribeDomainEndpointOptions Source #

Create a value of DescribeDomainEndpointOptions with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:deployed:DescribeDomainEndpointOptions', describeDomainEndpointOptions_deployed - Whether to retrieve the latest configuration (which might be in a Processing state) or the current, active configuration. Defaults to false.

$sel:domainName:DescribeDomainEndpointOptions', describeDomainEndpointOptions_domainName - A string that represents the name of a domain.

Request Lenses

describeDomainEndpointOptions_deployed :: Lens' DescribeDomainEndpointOptions (Maybe Bool) Source #

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

Destructuring the Response

data DescribeDomainEndpointOptionsResponse Source #

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

See: newDescribeDomainEndpointOptionsResponse smart constructor.

Constructors

DescribeDomainEndpointOptionsResponse' 

Fields

Instances

Instances details
Eq DescribeDomainEndpointOptionsResponse Source # 
Instance details

Defined in Amazonka.CloudSearch.DescribeDomainEndpointOptions

Read DescribeDomainEndpointOptionsResponse Source # 
Instance details

Defined in Amazonka.CloudSearch.DescribeDomainEndpointOptions

Show DescribeDomainEndpointOptionsResponse Source # 
Instance details

Defined in Amazonka.CloudSearch.DescribeDomainEndpointOptions

Generic DescribeDomainEndpointOptionsResponse Source # 
Instance details

Defined in Amazonka.CloudSearch.DescribeDomainEndpointOptions

NFData DescribeDomainEndpointOptionsResponse Source # 
Instance details

Defined in Amazonka.CloudSearch.DescribeDomainEndpointOptions

type Rep DescribeDomainEndpointOptionsResponse Source # 
Instance details

Defined in Amazonka.CloudSearch.DescribeDomainEndpointOptions

type Rep DescribeDomainEndpointOptionsResponse = D1 ('MetaData "DescribeDomainEndpointOptionsResponse" "Amazonka.CloudSearch.DescribeDomainEndpointOptions" "libZSservicesZSamazonka-cloudsearchZSamazonka-cloudsearch" 'False) (C1 ('MetaCons "DescribeDomainEndpointOptionsResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "domainEndpointOptions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe DomainEndpointOptionsStatus)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newDescribeDomainEndpointOptionsResponse Source #

Create a value of DescribeDomainEndpointOptionsResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:domainEndpointOptions:DescribeDomainEndpointOptionsResponse', describeDomainEndpointOptionsResponse_domainEndpointOptions - The status and configuration of a search domain's endpoint options.

$sel:httpStatus:DescribeDomainEndpointOptionsResponse', describeDomainEndpointOptionsResponse_httpStatus - The response's http status code.

Response Lenses