libZSservicesZSamazonka-cloudsearchZSamazonka-cloudsearch
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

Amazonka.CloudSearch.IndexDocuments

Description

Tells the search domain to start indexing its documents using the latest indexing options. This operation must be invoked to activate options whose OptionStatus is RequiresIndexDocuments.

Synopsis

Creating a Request

data IndexDocuments Source #

Container for the parameters to the IndexDocuments operation. Specifies the name of the domain you want to re-index.

See: newIndexDocuments smart constructor.

Constructors

IndexDocuments' 

Fields

Instances

Instances details
Eq IndexDocuments Source # 
Instance details

Defined in Amazonka.CloudSearch.IndexDocuments

Read IndexDocuments Source # 
Instance details

Defined in Amazonka.CloudSearch.IndexDocuments

Show IndexDocuments Source # 
Instance details

Defined in Amazonka.CloudSearch.IndexDocuments

Generic IndexDocuments Source # 
Instance details

Defined in Amazonka.CloudSearch.IndexDocuments

Associated Types

type Rep IndexDocuments :: Type -> Type #

NFData IndexDocuments Source # 
Instance details

Defined in Amazonka.CloudSearch.IndexDocuments

Methods

rnf :: IndexDocuments -> () #

Hashable IndexDocuments Source # 
Instance details

Defined in Amazonka.CloudSearch.IndexDocuments

AWSRequest IndexDocuments Source # 
Instance details

Defined in Amazonka.CloudSearch.IndexDocuments

Associated Types

type AWSResponse IndexDocuments #

ToHeaders IndexDocuments Source # 
Instance details

Defined in Amazonka.CloudSearch.IndexDocuments

ToPath IndexDocuments Source # 
Instance details

Defined in Amazonka.CloudSearch.IndexDocuments

ToQuery IndexDocuments Source # 
Instance details

Defined in Amazonka.CloudSearch.IndexDocuments

type Rep IndexDocuments Source # 
Instance details

Defined in Amazonka.CloudSearch.IndexDocuments

type Rep IndexDocuments = D1 ('MetaData "IndexDocuments" "Amazonka.CloudSearch.IndexDocuments" "libZSservicesZSamazonka-cloudsearchZSamazonka-cloudsearch" 'False) (C1 ('MetaCons "IndexDocuments'" 'PrefixI 'True) (S1 ('MetaSel ('Just "domainName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))
type AWSResponse IndexDocuments Source # 
Instance details

Defined in Amazonka.CloudSearch.IndexDocuments

newIndexDocuments Source #

Create a value of IndexDocuments 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:domainName:IndexDocuments', indexDocuments_domainName - Undocumented member.

Request Lenses

Destructuring the Response

data IndexDocumentsResponse Source #

The result of an IndexDocuments request. Contains the status of the indexing operation, including the fields being indexed.

See: newIndexDocumentsResponse smart constructor.

Constructors

IndexDocumentsResponse' 

Fields

Instances

Instances details
Eq IndexDocumentsResponse Source # 
Instance details

Defined in Amazonka.CloudSearch.IndexDocuments

Read IndexDocumentsResponse Source # 
Instance details

Defined in Amazonka.CloudSearch.IndexDocuments

Show IndexDocumentsResponse Source # 
Instance details

Defined in Amazonka.CloudSearch.IndexDocuments

Generic IndexDocumentsResponse Source # 
Instance details

Defined in Amazonka.CloudSearch.IndexDocuments

Associated Types

type Rep IndexDocumentsResponse :: Type -> Type #

NFData IndexDocumentsResponse Source # 
Instance details

Defined in Amazonka.CloudSearch.IndexDocuments

Methods

rnf :: IndexDocumentsResponse -> () #

type Rep IndexDocumentsResponse Source # 
Instance details

Defined in Amazonka.CloudSearch.IndexDocuments

type Rep IndexDocumentsResponse = D1 ('MetaData "IndexDocumentsResponse" "Amazonka.CloudSearch.IndexDocuments" "libZSservicesZSamazonka-cloudsearchZSamazonka-cloudsearch" 'False) (C1 ('MetaCons "IndexDocumentsResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "fieldNames") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newIndexDocumentsResponse Source #

Create a value of IndexDocumentsResponse 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:fieldNames:IndexDocumentsResponse', indexDocumentsResponse_fieldNames - The names of the fields that are currently being indexed.

$sel:httpStatus:IndexDocumentsResponse', indexDocumentsResponse_httpStatus - The response's http status code.

Response Lenses

indexDocumentsResponse_fieldNames :: Lens' IndexDocumentsResponse (Maybe [Text]) Source #

The names of the fields that are currently being indexed.