Amazonka.CloudSearch.IndexDocuments

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.

Creating a Request

data IndexDocuments

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

• domainName :: Text

Instances

ToHeaders IndexDocuments

Defined in Amazonka.CloudSearch.IndexDocuments

Methods

toHeaders :: IndexDocuments -> [Header]

ToPath IndexDocuments

Defined in Amazonka.CloudSearch.IndexDocuments

Methods

toPath :: IndexDocuments -> ByteString

ToQuery IndexDocuments

Defined in Amazonka.CloudSearch.IndexDocuments

Methods

toQuery :: IndexDocuments -> QueryString

AWSRequest IndexDocuments

Defined in Amazonka.CloudSearch.IndexDocuments

Associated Types

type AWSResponse IndexDocuments

Methods

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

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

Generic IndexDocuments

Defined in Amazonka.CloudSearch.IndexDocuments

Associated Types

type Rep IndexDocuments :: Type -> Type

Methods

from :: IndexDocuments -> Rep IndexDocuments x

to :: Rep IndexDocuments x -> IndexDocuments

Read IndexDocuments

Defined in Amazonka.CloudSearch.IndexDocuments

Methods

readsPrec :: Int -> ReadS IndexDocuments

readList :: ReadS [IndexDocuments]

readPrec :: ReadPrec IndexDocuments

readListPrec :: ReadPrec [IndexDocuments]

Show IndexDocuments

Defined in Amazonka.CloudSearch.IndexDocuments

Methods

showsPrec :: Int -> IndexDocuments -> ShowS

show :: IndexDocuments -> String

showList :: [IndexDocuments] -> ShowS

NFData IndexDocuments

Defined in Amazonka.CloudSearch.IndexDocuments

Methods

rnf :: IndexDocuments -> ()

Eq IndexDocuments

Defined in Amazonka.CloudSearch.IndexDocuments

Methods

(==) :: IndexDocuments -> IndexDocuments -> Bool

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

Hashable IndexDocuments

Defined in Amazonka.CloudSearch.IndexDocuments

Methods

hashWithSalt :: Int -> IndexDocuments -> Int

hash :: IndexDocuments -> Int

type AWSResponse IndexDocuments

Defined in Amazonka.CloudSearch.IndexDocuments

type AWSResponse IndexDocuments = IndexDocumentsResponse

type Rep IndexDocuments

Defined in Amazonka.CloudSearch.IndexDocuments

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

newIndexDocuments

Arguments

:: Text

IndexDocuments

-> IndexDocuments

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:

IndexDocuments, indexDocuments_domainName - Undocumented member.

Request Lenses

indexDocuments_domainName :: Lens' IndexDocuments Text

Undocumented member.

Destructuring the Response

data IndexDocumentsResponse

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

• fieldNames :: Maybe [Text]

  The names of the fields that are currently being indexed.

• httpStatus :: Int

  The response's http status code.

Instances

Generic IndexDocumentsResponse

Defined in Amazonka.CloudSearch.IndexDocuments

Associated Types

type Rep IndexDocumentsResponse :: Type -> Type

Methods

from :: IndexDocumentsResponse -> Rep IndexDocumentsResponse x

to :: Rep IndexDocumentsResponse x -> IndexDocumentsResponse

Read IndexDocumentsResponse

Defined in Amazonka.CloudSearch.IndexDocuments

Methods

readsPrec :: Int -> ReadS IndexDocumentsResponse

readList :: ReadS [IndexDocumentsResponse]

readPrec :: ReadPrec IndexDocumentsResponse

readListPrec :: ReadPrec [IndexDocumentsResponse]

Show IndexDocumentsResponse

Defined in Amazonka.CloudSearch.IndexDocuments

Methods

showsPrec :: Int -> IndexDocumentsResponse -> ShowS

show :: IndexDocumentsResponse -> String

showList :: [IndexDocumentsResponse] -> ShowS

NFData IndexDocumentsResponse

Defined in Amazonka.CloudSearch.IndexDocuments

Methods

rnf :: IndexDocumentsResponse -> ()

Eq IndexDocumentsResponse

Defined in Amazonka.CloudSearch.IndexDocuments

Methods

(==) :: IndexDocumentsResponse -> IndexDocumentsResponse -> Bool

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

type Rep IndexDocumentsResponse

Defined in Amazonka.CloudSearch.IndexDocuments

type Rep IndexDocumentsResponse = D1 ('MetaData "IndexDocumentsResponse" "Amazonka.CloudSearch.IndexDocuments" "amazonka-cloudsearch-2.0-A2SXRDW2ivUDvdOgQgoVJQ" '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

Arguments

:: Int

$sel:httpStatus:IndexDocumentsResponse'

-> IndexDocumentsResponse

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])

The names of the fields that are currently being indexed.

indexDocumentsResponse_httpStatus :: Lens' IndexDocumentsResponse Int

The response's http status code.