| 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.DefineIndexField
Description
Configures an IndexField for the search domain. Used to create new
fields and modify existing ones. You must specify the name of the domain
you are configuring and an index field configuration. The index field
configuration specifies a unique name, the index field type, and the
options you want to configure for the field. The options you can specify
depend on the IndexFieldType. If the field exists, the new
configuration replaces the old one. For more information, see
Configuring Index Fields
in the Amazon CloudSearch Developer Guide.
Synopsis
- data DefineIndexField = DefineIndexField' {}
- newDefineIndexField :: Text -> IndexField -> DefineIndexField
- defineIndexField_domainName :: Lens' DefineIndexField Text
- defineIndexField_indexField :: Lens' DefineIndexField IndexField
- data DefineIndexFieldResponse = DefineIndexFieldResponse' {}
- newDefineIndexFieldResponse :: Int -> IndexFieldStatus -> DefineIndexFieldResponse
- defineIndexFieldResponse_httpStatus :: Lens' DefineIndexFieldResponse Int
- defineIndexFieldResponse_indexField :: Lens' DefineIndexFieldResponse IndexFieldStatus
Creating a Request
data DefineIndexField Source #
Container for the parameters to the DefineIndexField operation.
Specifies the name of the domain you want to update and the index field
configuration.
See: newDefineIndexField smart constructor.
Constructors
| DefineIndexField' | |
Fields
| |
Instances
Arguments
| :: Text | |
| -> IndexField | |
| -> DefineIndexField |
Create a value of DefineIndexField 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:DefineIndexField', defineIndexField_domainName - Undocumented member.
$sel:indexField:DefineIndexField', defineIndexField_indexField - The index field and field options you want to configure.
Request Lenses
defineIndexField_domainName :: Lens' DefineIndexField Text Source #
Undocumented member.
defineIndexField_indexField :: Lens' DefineIndexField IndexField Source #
The index field and field options you want to configure.
Destructuring the Response
data DefineIndexFieldResponse Source #
The result of a DefineIndexField request. Contains the status of the
newly-configured index field.
See: newDefineIndexFieldResponse smart constructor.
Constructors
| DefineIndexFieldResponse' | |
Fields
| |
Instances
newDefineIndexFieldResponse Source #
Arguments
| :: Int | |
| -> IndexFieldStatus | |
| -> DefineIndexFieldResponse |
Create a value of DefineIndexFieldResponse 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:httpStatus:DefineIndexFieldResponse', defineIndexFieldResponse_httpStatus - The response's http status code.
$sel:indexField:DefineIndexField', defineIndexFieldResponse_indexField - Undocumented member.
Response Lenses
defineIndexFieldResponse_httpStatus :: Lens' DefineIndexFieldResponse Int Source #
The response's http status code.
defineIndexFieldResponse_indexField :: Lens' DefineIndexFieldResponse IndexFieldStatus Source #
Undocumented member.