Copyright	(c) 2013-2021 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None

Amazonka.CloudSearch.Types.DomainStatus

Description

Synopsis

data DomainStatus = DomainStatus' {
- searchInstanceCount :: Maybe Natural
- searchInstanceType :: Maybe Text
- docService :: Maybe ServiceEndpoint
- arn :: Maybe Text
- created :: Maybe Bool
- searchService :: Maybe ServiceEndpoint
- limits :: Maybe Limits
- searchPartitionCount :: Maybe Natural
- deleted :: Maybe Bool
- processing :: Maybe Bool
- domainId :: Text
- domainName :: Text
- requiresIndexDocuments :: Bool
}
newDomainStatus :: Text -> Text -> Bool -> DomainStatus
domainStatus_searchInstanceCount :: Lens' DomainStatus (Maybe Natural)
domainStatus_searchInstanceType :: Lens' DomainStatus (Maybe Text)
domainStatus_docService :: Lens' DomainStatus (Maybe ServiceEndpoint)
domainStatus_arn :: Lens' DomainStatus (Maybe Text)
domainStatus_created :: Lens' DomainStatus (Maybe Bool)
domainStatus_searchService :: Lens' DomainStatus (Maybe ServiceEndpoint)
domainStatus_limits :: Lens' DomainStatus (Maybe Limits)
domainStatus_searchPartitionCount :: Lens' DomainStatus (Maybe Natural)
domainStatus_deleted :: Lens' DomainStatus (Maybe Bool)
domainStatus_processing :: Lens' DomainStatus (Maybe Bool)
domainStatus_domainId :: Lens' DomainStatus Text
domainStatus_domainName :: Lens' DomainStatus Text
domainStatus_requiresIndexDocuments :: Lens' DomainStatus Bool

Documentation

data DomainStatus Source #

The current status of the search domain.

See: newDomainStatus smart constructor.

Constructors

DomainStatus'

Fields

searchInstanceCount :: Maybe Natural
The number of search instances that are available to process search requests.
searchInstanceType :: Maybe Text
The instance type that is being used to process search requests.
docService :: Maybe ServiceEndpoint
The service endpoint for updating documents in a search domain.
arn :: Maybe Text
created :: Maybe Bool
True if the search domain is created. It can take several minutes to initialize a domain when CreateDomain is called. Newly created search domains are returned from DescribeDomains with a false value for Created until domain creation is complete.
searchService :: Maybe ServiceEndpoint
The service endpoint for requesting search results from a search domain.
limits :: Maybe Limits
searchPartitionCount :: Maybe Natural
The number of partitions across which the search index is spread.
deleted :: Maybe Bool
True if the search domain has been deleted. The system must clean up resources dedicated to the search domain when DeleteDomain is called. Newly deleted search domains are returned from DescribeDomains with a true value for IsDeleted for several minutes until resource cleanup is complete.
processing :: Maybe Bool
True if processing is being done to activate the current domain configuration.
domainId :: Text
domainName :: Text
requiresIndexDocuments :: Bool
True if IndexDocuments needs to be called to activate the current domain configuration.

Instances

Instances details

Eq DomainStatus Source #
Instance details Defined in Amazonka.CloudSearch.Types.DomainStatus Methods (==) :: DomainStatus -> DomainStatus -> Bool # (/=) :: DomainStatus -> DomainStatus -> Bool #
Read DomainStatus Source #
Instance details Defined in Amazonka.CloudSearch.Types.DomainStatus Methods readsPrec :: Int -> ReadS DomainStatus # readList :: ReadS [DomainStatus] # readPrec :: ReadPrec DomainStatus # readListPrec :: ReadPrec [DomainStatus] #
Show DomainStatus Source #
Instance details Defined in Amazonka.CloudSearch.Types.DomainStatus Methods showsPrec :: Int -> DomainStatus -> ShowS # show :: DomainStatus -> String # showList :: [DomainStatus] -> ShowS #
Generic DomainStatus Source #
Instance details Defined in Amazonka.CloudSearch.Types.DomainStatus Associated Types type Rep DomainStatus :: Type -> Type # Methods from :: DomainStatus -> Rep DomainStatus x # to :: Rep DomainStatus x -> DomainStatus #
NFData DomainStatus Source #
Instance details Defined in Amazonka.CloudSearch.Types.DomainStatus Methods rnf :: DomainStatus -> () #
Hashable DomainStatus Source #
Instance details Defined in Amazonka.CloudSearch.Types.DomainStatus Methods hashWithSalt :: Int -> DomainStatus -> Int # hash :: DomainStatus -> Int #
FromXML DomainStatus Source #
Instance details Defined in Amazonka.CloudSearch.Types.DomainStatus Methods parseXML :: [Node] -> Either String DomainStatus #
type Rep DomainStatus Source #
Instance details Defined in Amazonka.CloudSearch.Types.DomainStatus type Rep DomainStatus = D1 ('MetaData "DomainStatus" "Amazonka.CloudSearch.Types.DomainStatus" "libZSservicesZSamazonka-cloudsearchZSamazonka-cloudsearch" 'False) (C1 ('MetaCons "DomainStatus'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "searchInstanceCount") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :: (S1 ('MetaSel ('Just "searchInstanceType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "docService") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ServiceEndpoint)))) :: (S1 ('MetaSel ('Just "arn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "created") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :: S1 ('MetaSel ('Just "searchService") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ServiceEndpoint))))) :: ((S1 ('MetaSel ('Just "limits") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Limits)) :: (S1 ('MetaSel ('Just "searchPartitionCount") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :: S1 ('MetaSel ('Just "deleted") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)))) :: ((S1 ('MetaSel ('Just "processing") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :: S1 ('MetaSel ('Just "domainId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)) :: (S1 ('MetaSel ('Just "domainName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: S1 ('MetaSel ('Just "requiresIndexDocuments") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Bool))))))

newDomainStatus Source #

Arguments

:: Text	`$sel:domainId:DomainStatus'`
-> Text	`$sel:domainName:DomainStatus'`
-> Bool	`$sel:requiresIndexDocuments:DomainStatus'`
-> DomainStatus

Create a value of DomainStatus 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:searchInstanceCount:DomainStatus', domainStatus_searchInstanceCount - The number of search instances that are available to process search requests.

$sel:searchInstanceType:DomainStatus', domainStatus_searchInstanceType - The instance type that is being used to process search requests.

$sel:docService:DomainStatus', domainStatus_docService - The service endpoint for updating documents in a search domain.

$sel:arn:DomainStatus', domainStatus_arn - Undocumented member.

$sel:created:DomainStatus', domainStatus_created - True if the search domain is created. It can take several minutes to initialize a domain when CreateDomain is called. Newly created search domains are returned from DescribeDomains with a false value for Created until domain creation is complete.

$sel:searchService:DomainStatus', domainStatus_searchService - The service endpoint for requesting search results from a search domain.

$sel:limits:DomainStatus', domainStatus_limits - Undocumented member.

$sel:searchPartitionCount:DomainStatus', domainStatus_searchPartitionCount - The number of partitions across which the search index is spread.

$sel:deleted:DomainStatus', domainStatus_deleted - True if the search domain has been deleted. The system must clean up resources dedicated to the search domain when DeleteDomain is called. Newly deleted search domains are returned from DescribeDomains with a true value for IsDeleted for several minutes until resource cleanup is complete.

$sel:processing:DomainStatus', domainStatus_processing - True if processing is being done to activate the current domain configuration.

$sel:domainId:DomainStatus', domainStatus_domainId - Undocumented member.

$sel:domainName:DomainStatus', domainStatus_domainName - Undocumented member.

$sel:requiresIndexDocuments:DomainStatus', domainStatus_requiresIndexDocuments - True if IndexDocuments needs to be called to activate the current domain configuration.

domainStatus_searchInstanceCount :: Lens' DomainStatus (Maybe Natural) Source #

The number of search instances that are available to process search requests.

domainStatus_searchInstanceType :: Lens' DomainStatus (Maybe Text) Source #

The instance type that is being used to process search requests.

domainStatus_docService :: Lens' DomainStatus (Maybe ServiceEndpoint) Source #

The service endpoint for updating documents in a search domain.

domainStatus_arn :: Lens' DomainStatus (Maybe Text) Source #

Undocumented member.

domainStatus_created :: Lens' DomainStatus (Maybe Bool) Source #

True if the search domain is created. It can take several minutes to initialize a domain when CreateDomain is called. Newly created search domains are returned from DescribeDomains with a false value for Created until domain creation is complete.

domainStatus_searchService :: Lens' DomainStatus (Maybe ServiceEndpoint) Source #

The service endpoint for requesting search results from a search domain.

domainStatus_limits :: Lens' DomainStatus (Maybe Limits) Source #

Undocumented member.

domainStatus_searchPartitionCount :: Lens' DomainStatus (Maybe Natural) Source #

The number of partitions across which the search index is spread.

domainStatus_deleted :: Lens' DomainStatus (Maybe Bool) Source #

True if the search domain has been deleted. The system must clean up resources dedicated to the search domain when DeleteDomain is called. Newly deleted search domains are returned from DescribeDomains with a true value for IsDeleted for several minutes until resource cleanup is complete.

domainStatus_processing :: Lens' DomainStatus (Maybe Bool) Source #

True if processing is being done to activate the current domain configuration.

domainStatus_domainId :: Lens' DomainStatus Text Source #

Undocumented member.

domainStatus_domainName :: Lens' DomainStatus Text Source #

Undocumented member.

domainStatus_requiresIndexDocuments :: Lens' DomainStatus Bool Source #

True if IndexDocuments needs to be called to activate the current domain configuration.