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

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

Constructors

DescribeDomains'

Fields

• domainNames :: Maybe [Text]

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

Instances

ToHeaders DescribeDomains

Defined in Amazonka.CloudSearch.DescribeDomains

Methods

toHeaders :: DescribeDomains -> [Header]

ToPath DescribeDomains

Defined in Amazonka.CloudSearch.DescribeDomains

Methods

toPath :: DescribeDomains -> ByteString

ToQuery DescribeDomains

Defined in Amazonka.CloudSearch.DescribeDomains

Methods

toQuery :: DescribeDomains -> QueryString

AWSRequest DescribeDomains

Defined in Amazonka.CloudSearch.DescribeDomains

Associated Types

type AWSResponse DescribeDomains

Methods

request :: (Service -> Service) -> DescribeDomains -> Request DescribeDomains

response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy DescribeDomains -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse DescribeDomains)))

Generic DescribeDomains

Defined in Amazonka.CloudSearch.DescribeDomains

Associated Types

type Rep DescribeDomains :: Type -> Type

Methods

from :: DescribeDomains -> Rep DescribeDomains x

to :: Rep DescribeDomains x -> DescribeDomains

Read DescribeDomains

Defined in Amazonka.CloudSearch.DescribeDomains

Methods

readsPrec :: Int -> ReadS DescribeDomains

readList :: ReadS [DescribeDomains]

readPrec :: ReadPrec DescribeDomains

readListPrec :: ReadPrec [DescribeDomains]

Show DescribeDomains

Defined in Amazonka.CloudSearch.DescribeDomains

Methods

showsPrec :: Int -> DescribeDomains -> ShowS

show :: DescribeDomains -> String

showList :: [DescribeDomains] -> ShowS

NFData DescribeDomains

Defined in Amazonka.CloudSearch.DescribeDomains

Methods

rnf :: DescribeDomains -> ()

Eq DescribeDomains

Defined in Amazonka.CloudSearch.DescribeDomains

Methods

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

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

Hashable DescribeDomains

Defined in Amazonka.CloudSearch.DescribeDomains

Methods

hashWithSalt :: Int -> DescribeDomains -> Int

hash :: DescribeDomains -> Int

type AWSResponse DescribeDomains

Defined in Amazonka.CloudSearch.DescribeDomains

type AWSResponse DescribeDomains = DescribeDomainsResponse

type Rep DescribeDomains

Defined in Amazonka.CloudSearch.DescribeDomains

type Rep DescribeDomains = D1 ('MetaData "DescribeDomains" "Amazonka.CloudSearch.DescribeDomains" "amazonka-cloudsearch-2.0-A2SXRDW2ivUDvdOgQgoVJQ" 'False) (C1 ('MetaCons "DescribeDomains'" 'PrefixI 'True) (S1 ('MetaSel ('Just "domainNames") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text]))))

newDescribeDomains :: DescribeDomains

Create a value of DescribeDomains 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:domainNames:DescribeDomains', describeDomains_domainNames - The names of the domains you want to include in the response.

Request Lenses

describeDomains_domainNames :: Lens' DescribeDomains (Maybe [Text])

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

Destructuring the Response

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

Constructors

DescribeDomainsResponse'

Fields

• httpStatus :: Int

  The response's http status code.

• domainStatusList :: [DomainStatus]

Instances

Generic DescribeDomainsResponse

Defined in Amazonka.CloudSearch.DescribeDomains

Associated Types

type Rep DescribeDomainsResponse :: Type -> Type

Methods

from :: DescribeDomainsResponse -> Rep DescribeDomainsResponse x

to :: Rep DescribeDomainsResponse x -> DescribeDomainsResponse

Read DescribeDomainsResponse

Defined in Amazonka.CloudSearch.DescribeDomains

Methods

readsPrec :: Int -> ReadS DescribeDomainsResponse

readList :: ReadS [DescribeDomainsResponse]

readPrec :: ReadPrec DescribeDomainsResponse

readListPrec :: ReadPrec [DescribeDomainsResponse]

Show DescribeDomainsResponse

Defined in Amazonka.CloudSearch.DescribeDomains

Methods

showsPrec :: Int -> DescribeDomainsResponse -> ShowS

show :: DescribeDomainsResponse -> String

showList :: [DescribeDomainsResponse] -> ShowS

NFData DescribeDomainsResponse

Defined in Amazonka.CloudSearch.DescribeDomains

Methods

rnf :: DescribeDomainsResponse -> ()

Eq DescribeDomainsResponse

Defined in Amazonka.CloudSearch.DescribeDomains

Methods

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

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

type Rep DescribeDomainsResponse

Defined in Amazonka.CloudSearch.DescribeDomains

type Rep DescribeDomainsResponse = D1 ('MetaData "DescribeDomainsResponse" "Amazonka.CloudSearch.DescribeDomains" "amazonka-cloudsearch-2.0-A2SXRDW2ivUDvdOgQgoVJQ" 'False) (C1 ('MetaCons "DescribeDomainsResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int) :*: S1 ('MetaSel ('Just "domainStatusList") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [DomainStatus])))

newDescribeDomainsResponse

Arguments

:: Int

$sel:httpStatus:DescribeDomainsResponse'

-> DescribeDomainsResponse

Create a value of DescribeDomainsResponse 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:httpStatus:DescribeDomainsResponse', describeDomainsResponse_httpStatus - The response's http status code.

$sel:domainStatusList:DescribeDomainsResponse', describeDomainsResponse_domainStatusList - Undocumented member.

Response Lenses

describeDomainsResponse_httpStatus :: Lens' DescribeDomainsResponse Int

The response's http status code.

describeDomainsResponse_domainStatusList :: Lens' DescribeDomainsResponse [DomainStatus]

Undocumented member.