Amazonka.CloudSearch.Types.DomainStatus

Documentation

data DomainStatus

The current status of the search domain.

See: newDomainStatus smart constructor.

Constructors

DomainStatus'

Fields

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

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

• docService :: Maybe ServiceEndpoint

  The service endpoint for updating documents in a search domain.

• limits :: Maybe Limits
• processing :: Maybe Bool

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

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

• searchPartitionCount :: Maybe Natural

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

• searchService :: Maybe ServiceEndpoint

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

• domainId :: Text
• domainName :: Text
• requiresIndexDocuments :: Bool

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

Instances

FromXML DomainStatus

Defined in Amazonka.CloudSearch.Types.DomainStatus

Methods

parseXML :: [Node] -> Either String DomainStatus

Generic DomainStatus

Defined in Amazonka.CloudSearch.Types.DomainStatus

Associated Types

type Rep DomainStatus :: Type -> Type

Methods

from :: DomainStatus -> Rep DomainStatus x

to :: Rep DomainStatus x -> DomainStatus

Read DomainStatus

Defined in Amazonka.CloudSearch.Types.DomainStatus

Methods

readsPrec :: Int -> ReadS DomainStatus

readList :: ReadS [DomainStatus]

readPrec :: ReadPrec DomainStatus

readListPrec :: ReadPrec [DomainStatus]

Show DomainStatus

Defined in Amazonka.CloudSearch.Types.DomainStatus

Methods

showsPrec :: Int -> DomainStatus -> ShowS

show :: DomainStatus -> String

showList :: [DomainStatus] -> ShowS

NFData DomainStatus

Defined in Amazonka.CloudSearch.Types.DomainStatus

Methods

rnf :: DomainStatus -> ()

Eq DomainStatus

Defined in Amazonka.CloudSearch.Types.DomainStatus

Methods

(==) :: DomainStatus -> DomainStatus -> Bool

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

Hashable DomainStatus

Defined in Amazonka.CloudSearch.Types.DomainStatus

Methods

hashWithSalt :: Int -> DomainStatus -> Int

hash :: DomainStatus -> Int

type Rep DomainStatus

Defined in Amazonka.CloudSearch.Types.DomainStatus

type Rep DomainStatus = D1 ('MetaData "DomainStatus" "Amazonka.CloudSearch.Types.DomainStatus" "amazonka-cloudsearch-2.0-A2SXRDW2ivUDvdOgQgoVJQ" 'False) (C1 ('MetaCons "DomainStatus'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "arn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "created") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: S1 ('MetaSel ('Just "deleted") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)))) :*: (S1 ('MetaSel ('Just "docService") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ServiceEndpoint)) :*: (S1 ('MetaSel ('Just "limits") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Limits)) :*: S1 ('MetaSel ('Just "processing") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool))))) :*: ((S1 ('MetaSel ('Just "searchInstanceCount") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :*: (S1 ('MetaSel ('Just "searchInstanceType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "searchPartitionCount") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)))) :*: ((S1 ('MetaSel ('Just "searchService") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ServiceEndpoint)) :*: 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

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: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: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:docService:DomainStatus', domainStatus_docService - The service endpoint for updating documents in a search domain.

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

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

$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:searchPartitionCount:DomainStatus', domainStatus_searchPartitionCount - The number of partitions across which the search index is spread.

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

$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_arn :: Lens' DomainStatus (Maybe Text)

Undocumented member.

domainStatus_created :: Lens' DomainStatus (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.

domainStatus_deleted :: Lens' DomainStatus (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.

domainStatus_docService :: Lens' DomainStatus (Maybe ServiceEndpoint)

The service endpoint for updating documents in a search domain.

domainStatus_limits :: Lens' DomainStatus (Maybe Limits)

Undocumented member.

domainStatus_processing :: Lens' DomainStatus (Maybe Bool)

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

domainStatus_searchInstanceCount :: Lens' DomainStatus (Maybe Natural)

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

domainStatus_searchInstanceType :: Lens' DomainStatus (Maybe Text)

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

domainStatus_searchPartitionCount :: Lens' DomainStatus (Maybe Natural)

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

domainStatus_searchService :: Lens' DomainStatus (Maybe ServiceEndpoint)

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

domainStatus_domainId :: Lens' DomainStatus Text

Undocumented member.

domainStatus_domainName :: Lens' DomainStatus Text

Undocumented member.

domainStatus_requiresIndexDocuments :: Lens' DomainStatus Bool

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