Network.AWS.CloudSearch.DescribeDomains

Gets information about the search domains owned by this account. Can be limited to specific domains. Shows all domains by default. To get the number of searchable documents in a domain, use the console or submit a matchall request to your domain's search endpoint: 'q=matchall&q.parser=structured&size=0'. For more information, see Getting Information about a Search Domain in the Amazon CloudSearch Developer Guide.

Creating a Request

describeDomains :: DescribeDomains

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

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

• ddDomainNames

data DescribeDomains

Container for the parameters to the DescribeDomains operation. By default shows the status of all domains. To restrict the response to particular domains, specify the names of the domains you want to describe.

See: describeDomains smart constructor.

Instances

Eq DescribeDomains

Methods

(==) :: DescribeDomains -> DescribeDomains -> Bool

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

Data DescribeDomains

Methods

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

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

toConstr :: DescribeDomains -> Constr

dataTypeOf :: DescribeDomains -> DataType

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

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

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

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

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

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

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

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

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

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

Read DescribeDomains

Methods

readsPrec :: Int -> ReadS DescribeDomains

readList :: ReadS [DescribeDomains]

readPrec :: ReadPrec DescribeDomains

readListPrec :: ReadPrec [DescribeDomains]

Show DescribeDomains

Methods

showsPrec :: Int -> DescribeDomains -> ShowS

show :: DescribeDomains -> String

showList :: [DescribeDomains] -> ShowS

Generic DescribeDomains

Associated Types

type Rep DescribeDomains :: * -> *

Methods

from :: DescribeDomains -> Rep DescribeDomains x

to :: Rep DescribeDomains x -> DescribeDomains

Hashable DescribeDomains

Methods

hashWithSalt :: Int -> DescribeDomains -> Int

hash :: DescribeDomains -> Int

NFData DescribeDomains

Methods

rnf :: DescribeDomains -> ()

AWSRequest DescribeDomains

Associated Types

type Rs DescribeDomains :: *

Methods

request :: DescribeDomains -> Request DescribeDomains

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

ToPath DescribeDomains

Methods

toPath :: DescribeDomains -> ByteString

ToHeaders DescribeDomains

Methods

toHeaders :: DescribeDomains -> [Header]

ToQuery DescribeDomains

Methods

toQuery :: DescribeDomains -> QueryString

type Rep DescribeDomains

type Rep DescribeDomains = D1 (MetaData "DescribeDomains" "Network.AWS.CloudSearch.DescribeDomains" "amazonka-cloudsearch-1.4.3-8jIA3omBRonH9H48gQAXGd" True) (C1 (MetaCons "DescribeDomains'" PrefixI True) (S1 (MetaSel (Just Symbol "_ddDomainNames") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe [Text]))))

type Rs DescribeDomains

type Rs DescribeDomains = DescribeDomainsResponse

Request Lenses

ddDomainNames :: Lens' DescribeDomains [Text]

The names of the domains you want to include in the response.

Destructuring the Response

describeDomainsResponse

Arguments

:: Int

ddsrsResponseStatus

-> DescribeDomainsResponse

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

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

• ddsrsResponseStatus
• ddsrsDomainStatusList

data DescribeDomainsResponse

The result of a DescribeDomains request. Contains the status of the domains specified in the request or all domains owned by the account.

See: describeDomainsResponse smart constructor.

Instances

Eq DescribeDomainsResponse

Methods

(==) :: DescribeDomainsResponse -> DescribeDomainsResponse -> Bool

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

Data DescribeDomainsResponse

Methods

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

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

toConstr :: DescribeDomainsResponse -> Constr

dataTypeOf :: DescribeDomainsResponse -> DataType

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

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

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

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

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

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

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

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

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

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

Read DescribeDomainsResponse

Methods

readsPrec :: Int -> ReadS DescribeDomainsResponse

readList :: ReadS [DescribeDomainsResponse]

readPrec :: ReadPrec DescribeDomainsResponse

readListPrec :: ReadPrec [DescribeDomainsResponse]

Show DescribeDomainsResponse

Methods

showsPrec :: Int -> DescribeDomainsResponse -> ShowS

show :: DescribeDomainsResponse -> String

showList :: [DescribeDomainsResponse] -> ShowS

Generic DescribeDomainsResponse

Associated Types

type Rep DescribeDomainsResponse :: * -> *

Methods

from :: DescribeDomainsResponse -> Rep DescribeDomainsResponse x

to :: Rep DescribeDomainsResponse x -> DescribeDomainsResponse

NFData DescribeDomainsResponse

Methods

rnf :: DescribeDomainsResponse -> ()

type Rep DescribeDomainsResponse

type Rep DescribeDomainsResponse = D1 (MetaData "DescribeDomainsResponse" "Network.AWS.CloudSearch.DescribeDomains" "amazonka-cloudsearch-1.4.3-8jIA3omBRonH9H48gQAXGd" False) (C1 (MetaCons "DescribeDomainsResponse'" PrefixI True) ((:*:) (S1 (MetaSel (Just Symbol "_ddsrsResponseStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Int)) (S1 (MetaSel (Just Symbol "_ddsrsDomainStatusList") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 [DomainStatus]))))

Response Lenses

ddsrsResponseStatus :: Lens' DescribeDomainsResponse Int

The response status code.

ddsrsDomainStatusList :: Lens' DescribeDomainsResponse [DomainStatus]

Undocumented member.