| 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.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
- data IndexDocuments = IndexDocuments' {
- domainName :: Text
- newIndexDocuments :: Text -> IndexDocuments
- indexDocuments_domainName :: Lens' IndexDocuments Text
- data IndexDocumentsResponse = IndexDocumentsResponse' {
- fieldNames :: Maybe [Text]
- httpStatus :: Int
- newIndexDocumentsResponse :: Int -> IndexDocumentsResponse
- indexDocumentsResponse_fieldNames :: Lens' IndexDocumentsResponse (Maybe [Text])
- indexDocumentsResponse_httpStatus :: Lens' IndexDocumentsResponse Int
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
Arguments
| :: Text | |
| -> 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:
$sel:domainName:IndexDocuments', indexDocuments_domainName - Undocumented member.
Request Lenses
indexDocuments_domainName :: Lens' IndexDocuments Text Source #
Undocumented member.
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
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.
indexDocumentsResponse_httpStatus :: Lens' IndexDocumentsResponse Int Source #
The response's http status code.