Network.AWS.CloudSearch.DescribeAvailabilityOptions

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 .

Creating a Request

describeAvailabilityOptions

Arguments

:: Text

daoDomainName

-> DescribeAvailabilityOptions

Creates a value of DescribeAvailabilityOptions with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• daoDeployed - Whether to display the deployed configuration (true ) or include any pending changes (false ). Defaults to false .
• daoDomainName - The name of the domain you want to describe.

data DescribeAvailabilityOptions

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: describeAvailabilityOptions smart constructor.

Instances

Eq DescribeAvailabilityOptions

Methods

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

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

Data DescribeAvailabilityOptions

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> DescribeAvailabilityOptions -> c DescribeAvailabilityOptions

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c DescribeAvailabilityOptions

toConstr :: DescribeAvailabilityOptions -> Constr

dataTypeOf :: DescribeAvailabilityOptions -> DataType

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c DescribeAvailabilityOptions)

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c DescribeAvailabilityOptions)

gmapT :: (forall b. Data b => b -> b) -> DescribeAvailabilityOptions -> DescribeAvailabilityOptions

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> DescribeAvailabilityOptions -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> DescribeAvailabilityOptions -> r

gmapQ :: (forall d. Data d => d -> u) -> DescribeAvailabilityOptions -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> DescribeAvailabilityOptions -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> DescribeAvailabilityOptions -> m DescribeAvailabilityOptions

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> DescribeAvailabilityOptions -> m DescribeAvailabilityOptions

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> DescribeAvailabilityOptions -> m DescribeAvailabilityOptions

Read DescribeAvailabilityOptions

Methods

readsPrec :: Int -> ReadS DescribeAvailabilityOptions

readList :: ReadS [DescribeAvailabilityOptions]

readPrec :: ReadPrec DescribeAvailabilityOptions

readListPrec :: ReadPrec [DescribeAvailabilityOptions]

Show DescribeAvailabilityOptions

Methods

showsPrec :: Int -> DescribeAvailabilityOptions -> ShowS

show :: DescribeAvailabilityOptions -> String

showList :: [DescribeAvailabilityOptions] -> ShowS

Generic DescribeAvailabilityOptions

Associated Types

type Rep DescribeAvailabilityOptions :: * -> *

Methods

from :: DescribeAvailabilityOptions -> Rep DescribeAvailabilityOptions x

to :: Rep DescribeAvailabilityOptions x -> DescribeAvailabilityOptions

Hashable DescribeAvailabilityOptions

Methods

hashWithSalt :: Int -> DescribeAvailabilityOptions -> Int

hash :: DescribeAvailabilityOptions -> Int

NFData DescribeAvailabilityOptions

Methods

rnf :: DescribeAvailabilityOptions -> ()

AWSRequest DescribeAvailabilityOptions

Associated Types

type Rs DescribeAvailabilityOptions :: *

Methods

request :: DescribeAvailabilityOptions -> Request DescribeAvailabilityOptions

response :: MonadResource m => Logger -> Service -> Proxy * DescribeAvailabilityOptions -> ClientResponse -> m (Response DescribeAvailabilityOptions)

ToPath DescribeAvailabilityOptions

Methods

toPath :: DescribeAvailabilityOptions -> ByteString

ToHeaders DescribeAvailabilityOptions

Methods

toHeaders :: DescribeAvailabilityOptions -> [Header]

ToQuery DescribeAvailabilityOptions

Methods

toQuery :: DescribeAvailabilityOptions -> QueryString

type Rep DescribeAvailabilityOptions

type Rep DescribeAvailabilityOptions = D1 (MetaData "DescribeAvailabilityOptions" "Network.AWS.CloudSearch.DescribeAvailabilityOptions" "amazonka-cloudsearch-1.4.5-FwBzBMhivTNEcvPuglpy35" False) (C1 (MetaCons "DescribeAvailabilityOptions'" PrefixI True) ((:*:) (S1 (MetaSel (Just Symbol "_daoDeployed") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Bool))) (S1 (MetaSel (Just Symbol "_daoDomainName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text))))

type Rs DescribeAvailabilityOptions

type Rs DescribeAvailabilityOptions = DescribeAvailabilityOptionsResponse

Request Lenses

daoDeployed :: Lens' DescribeAvailabilityOptions (Maybe Bool)

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

daoDomainName :: Lens' DescribeAvailabilityOptions Text

The name of the domain you want to describe.

Destructuring the Response

describeAvailabilityOptionsResponse

Arguments

:: Int

daorsResponseStatus

-> DescribeAvailabilityOptionsResponse

Creates a value of DescribeAvailabilityOptionsResponse with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• daorsAvailabilityOptions - The availability options configured for the domain. Indicates whether Multi-AZ is enabled for the domain.
• daorsResponseStatus - -- | The response status code.

data DescribeAvailabilityOptionsResponse

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

See: describeAvailabilityOptionsResponse smart constructor.

Instances

Eq DescribeAvailabilityOptionsResponse

Methods

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

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

Data DescribeAvailabilityOptionsResponse

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> DescribeAvailabilityOptionsResponse -> c DescribeAvailabilityOptionsResponse

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c DescribeAvailabilityOptionsResponse

toConstr :: DescribeAvailabilityOptionsResponse -> Constr

dataTypeOf :: DescribeAvailabilityOptionsResponse -> DataType

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c DescribeAvailabilityOptionsResponse)

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c DescribeAvailabilityOptionsResponse)

gmapT :: (forall b. Data b => b -> b) -> DescribeAvailabilityOptionsResponse -> DescribeAvailabilityOptionsResponse

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> DescribeAvailabilityOptionsResponse -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> DescribeAvailabilityOptionsResponse -> r

gmapQ :: (forall d. Data d => d -> u) -> DescribeAvailabilityOptionsResponse -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> DescribeAvailabilityOptionsResponse -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> DescribeAvailabilityOptionsResponse -> m DescribeAvailabilityOptionsResponse

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> DescribeAvailabilityOptionsResponse -> m DescribeAvailabilityOptionsResponse

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> DescribeAvailabilityOptionsResponse -> m DescribeAvailabilityOptionsResponse

Read DescribeAvailabilityOptionsResponse

Methods

readsPrec :: Int -> ReadS DescribeAvailabilityOptionsResponse

readList :: ReadS [DescribeAvailabilityOptionsResponse]

readPrec :: ReadPrec DescribeAvailabilityOptionsResponse

readListPrec :: ReadPrec [DescribeAvailabilityOptionsResponse]

Show DescribeAvailabilityOptionsResponse

Methods

showsPrec :: Int -> DescribeAvailabilityOptionsResponse -> ShowS

show :: DescribeAvailabilityOptionsResponse -> String

showList :: [DescribeAvailabilityOptionsResponse] -> ShowS

Generic DescribeAvailabilityOptionsResponse

Associated Types

type Rep DescribeAvailabilityOptionsResponse :: * -> *

Methods

from :: DescribeAvailabilityOptionsResponse -> Rep DescribeAvailabilityOptionsResponse x

to :: Rep DescribeAvailabilityOptionsResponse x -> DescribeAvailabilityOptionsResponse

NFData DescribeAvailabilityOptionsResponse

Methods

rnf :: DescribeAvailabilityOptionsResponse -> ()

type Rep DescribeAvailabilityOptionsResponse

type Rep DescribeAvailabilityOptionsResponse = D1 (MetaData "DescribeAvailabilityOptionsResponse" "Network.AWS.CloudSearch.DescribeAvailabilityOptions" "amazonka-cloudsearch-1.4.5-FwBzBMhivTNEcvPuglpy35" False) (C1 (MetaCons "DescribeAvailabilityOptionsResponse'" PrefixI True) ((:*:) (S1 (MetaSel (Just Symbol "_daorsAvailabilityOptions") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe AvailabilityOptionsStatus))) (S1 (MetaSel (Just Symbol "_daorsResponseStatus") NoSourceUnpackedness SourceStrict DecidedUnpack) (Rec0 Int))))

Response Lenses

daorsAvailabilityOptions :: Lens' DescribeAvailabilityOptionsResponse (Maybe AvailabilityOptionsStatus)

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

daorsResponseStatus :: Lens' DescribeAvailabilityOptionsResponse Int

• - | The response status code.