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.DescribeAvailabilityOptions

Description

Gets the availability options configured for a domain. By default, shows the configuration with any pending changes. Set the Deployed option to true to show the active configuration and exclude pending changes. For more information, see Configuring Availability Options in the Amazon CloudSearch Developer Guide.

Synopsis

Creating a Request

data DescribeAvailabilityOptions Source #

Container for the parameters to the DescribeAvailabilityOptions operation. Specifies 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: newDescribeAvailabilityOptions smart constructor.

Constructors

DescribeAvailabilityOptions' 

Fields

  • deployed :: Maybe Bool

    Whether to display the deployed configuration (true) or include any pending changes (false). Defaults to false.

  • domainName :: Text

    The name of the domain you want to describe.

Instances

Instances details
Eq DescribeAvailabilityOptions Source # 
Instance details

Defined in Amazonka.CloudSearch.DescribeAvailabilityOptions

Methods

(==) :: DescribeAvailabilityOptions -> DescribeAvailabilityOptions -> Bool #

(/=) :: DescribeAvailabilityOptions -> DescribeAvailabilityOptions -> Bool #

Read DescribeAvailabilityOptions Source # 
Instance details

Defined in Amazonka.CloudSearch.DescribeAvailabilityOptions

Methods

readsPrec :: Int -> ReadS DescribeAvailabilityOptions #

readList :: ReadS [DescribeAvailabilityOptions] #

readPrec :: ReadPrec DescribeAvailabilityOptions #

readListPrec :: ReadPrec [DescribeAvailabilityOptions] #

Show DescribeAvailabilityOptions Source # 
Instance details

Defined in Amazonka.CloudSearch.DescribeAvailabilityOptions

Methods

showsPrec :: Int -> DescribeAvailabilityOptions -> ShowS #

show :: DescribeAvailabilityOptions -> String #

showList :: [DescribeAvailabilityOptions] -> ShowS #

Generic DescribeAvailabilityOptions Source # 
Instance details

Defined in Amazonka.CloudSearch.DescribeAvailabilityOptions

Associated Types

type Rep DescribeAvailabilityOptions :: Type -> Type #

Methods

from :: DescribeAvailabilityOptions -> Rep DescribeAvailabilityOptions x #

to :: Rep DescribeAvailabilityOptions x -> DescribeAvailabilityOptions #

NFData DescribeAvailabilityOptions Source # 
Instance details

Defined in Amazonka.CloudSearch.DescribeAvailabilityOptions

Methods

rnf :: DescribeAvailabilityOptions -> () #

Hashable DescribeAvailabilityOptions Source # 
Instance details

Defined in Amazonka.CloudSearch.DescribeAvailabilityOptions

Methods

hashWithSalt :: Int -> DescribeAvailabilityOptions -> Int #

hash :: DescribeAvailabilityOptions -> Int #

AWSRequest DescribeAvailabilityOptions Source # 
Instance details

Defined in Amazonka.CloudSearch.DescribeAvailabilityOptions

Associated Types

type AWSResponse DescribeAvailabilityOptions #

Methods

request :: DescribeAvailabilityOptions -> Request DescribeAvailabilityOptions #

response :: MonadResource m => Logger -> Service -> Proxy DescribeAvailabilityOptions -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse DescribeAvailabilityOptions))) #

ToHeaders DescribeAvailabilityOptions Source # 
Instance details

Defined in Amazonka.CloudSearch.DescribeAvailabilityOptions

Methods

toHeaders :: DescribeAvailabilityOptions -> [Header] #

ToPath DescribeAvailabilityOptions Source # 
Instance details

Defined in Amazonka.CloudSearch.DescribeAvailabilityOptions

Methods

toPath :: DescribeAvailabilityOptions -> ByteString #

ToQuery DescribeAvailabilityOptions Source # 
Instance details

Defined in Amazonka.CloudSearch.DescribeAvailabilityOptions

Methods

toQuery :: DescribeAvailabilityOptions -> QueryString #

type Rep DescribeAvailabilityOptions Source # 
Instance details

Defined in Amazonka.CloudSearch.DescribeAvailabilityOptions

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

Defined in Amazonka.CloudSearch.DescribeAvailabilityOptions

type AWSResponse DescribeAvailabilityOptions = DescribeAvailabilityOptionsResponse

newDescribeAvailabilityOptions Source #

Arguments

:: Text

$sel:domainName:DescribeAvailabilityOptions'

-> DescribeAvailabilityOptions 

Create a value of DescribeAvailabilityOptions 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:DescribeAvailabilityOptions', describeAvailabilityOptions_deployed - Whether to display the deployed configuration (true) or include any pending changes (false). Defaults to false.

$sel:domainName:DescribeAvailabilityOptions', describeAvailabilityOptions_domainName - The name of the domain you want to describe.

Request Lenses

describeAvailabilityOptions_deployed :: Lens' DescribeAvailabilityOptions (Maybe Bool) Source #

Whether to display the deployed configuration (true) or include any pending changes (false). Defaults to false.

describeAvailabilityOptions_domainName :: Lens' DescribeAvailabilityOptions Text Source #

The name of the domain you want to describe.

Destructuring the Response

data DescribeAvailabilityOptionsResponse Source #

The result of a DescribeAvailabilityOptions request. Indicates whether or not the Multi-AZ option is enabled for the domain specified in the request.

See: newDescribeAvailabilityOptionsResponse smart constructor.

Constructors

DescribeAvailabilityOptionsResponse' 

Fields

Instances

Instances details
Eq DescribeAvailabilityOptionsResponse Source # 
Instance details

Defined in Amazonka.CloudSearch.DescribeAvailabilityOptions

Methods

(==) :: DescribeAvailabilityOptionsResponse -> DescribeAvailabilityOptionsResponse -> Bool #

(/=) :: DescribeAvailabilityOptionsResponse -> DescribeAvailabilityOptionsResponse -> Bool #

Read DescribeAvailabilityOptionsResponse Source # 
Instance details

Defined in Amazonka.CloudSearch.DescribeAvailabilityOptions

Methods

readsPrec :: Int -> ReadS DescribeAvailabilityOptionsResponse #

readList :: ReadS [DescribeAvailabilityOptionsResponse] #

readPrec :: ReadPrec DescribeAvailabilityOptionsResponse #

readListPrec :: ReadPrec [DescribeAvailabilityOptionsResponse] #

Show DescribeAvailabilityOptionsResponse Source # 
Instance details

Defined in Amazonka.CloudSearch.DescribeAvailabilityOptions

Methods

showsPrec :: Int -> DescribeAvailabilityOptionsResponse -> ShowS #

show :: DescribeAvailabilityOptionsResponse -> String #

showList :: [DescribeAvailabilityOptionsResponse] -> ShowS #

Generic DescribeAvailabilityOptionsResponse Source # 
Instance details

Defined in Amazonka.CloudSearch.DescribeAvailabilityOptions

Associated Types

type Rep DescribeAvailabilityOptionsResponse :: Type -> Type #

Methods

from :: DescribeAvailabilityOptionsResponse -> Rep DescribeAvailabilityOptionsResponse x #

to :: Rep DescribeAvailabilityOptionsResponse x -> DescribeAvailabilityOptionsResponse #

NFData DescribeAvailabilityOptionsResponse Source # 
Instance details

Defined in Amazonka.CloudSearch.DescribeAvailabilityOptions

Methods

rnf :: DescribeAvailabilityOptionsResponse -> () #

type Rep DescribeAvailabilityOptionsResponse Source # 
Instance details

Defined in Amazonka.CloudSearch.DescribeAvailabilityOptions

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

newDescribeAvailabilityOptionsResponse Source #

Arguments

:: Int

$sel:httpStatus:DescribeAvailabilityOptionsResponse'

-> DescribeAvailabilityOptionsResponse 

Create a value of DescribeAvailabilityOptionsResponse 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:availabilityOptions:DescribeAvailabilityOptionsResponse', describeAvailabilityOptionsResponse_availabilityOptions - The availability options configured for the domain. Indicates whether Multi-AZ is enabled for the domain.

$sel:httpStatus:DescribeAvailabilityOptionsResponse', describeAvailabilityOptionsResponse_httpStatus - The response's http status code.

Response Lenses

describeAvailabilityOptionsResponse_availabilityOptions :: Lens' DescribeAvailabilityOptionsResponse (Maybe AvailabilityOptionsStatus) Source #

The availability options configured for the domain. Indicates whether Multi-AZ is enabled for the domain.

describeAvailabilityOptionsResponse_httpStatus :: Lens' DescribeAvailabilityOptionsResponse Int Source #

The response's http status code.