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

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

Instances details
Eq DefineIndexField Source # 
Instance details

Defined in Amazonka.CloudSearch.DefineIndexField

Read DefineIndexField Source # 
Instance details

Defined in Amazonka.CloudSearch.DefineIndexField

Show DefineIndexField Source # 
Instance details

Defined in Amazonka.CloudSearch.DefineIndexField

Generic DefineIndexField Source # 
Instance details

Defined in Amazonka.CloudSearch.DefineIndexField

Associated Types

type Rep DefineIndexField :: Type -> Type #

NFData DefineIndexField Source # 
Instance details

Defined in Amazonka.CloudSearch.DefineIndexField

Methods

rnf :: DefineIndexField -> () #

Hashable DefineIndexField Source # 
Instance details

Defined in Amazonka.CloudSearch.DefineIndexField

AWSRequest DefineIndexField Source # 
Instance details

Defined in Amazonka.CloudSearch.DefineIndexField

Associated Types

type AWSResponse DefineIndexField #

ToHeaders DefineIndexField Source # 
Instance details

Defined in Amazonka.CloudSearch.DefineIndexField

ToPath DefineIndexField Source # 
Instance details

Defined in Amazonka.CloudSearch.DefineIndexField

ToQuery DefineIndexField Source # 
Instance details

Defined in Amazonka.CloudSearch.DefineIndexField

type Rep DefineIndexField Source # 
Instance details

Defined in Amazonka.CloudSearch.DefineIndexField

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

Defined in Amazonka.CloudSearch.DefineIndexField

newDefineIndexField Source #

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_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

Instances details
Eq DefineIndexFieldResponse Source # 
Instance details

Defined in Amazonka.CloudSearch.DefineIndexField

Read DefineIndexFieldResponse Source # 
Instance details

Defined in Amazonka.CloudSearch.DefineIndexField

Show DefineIndexFieldResponse Source # 
Instance details

Defined in Amazonka.CloudSearch.DefineIndexField

Generic DefineIndexFieldResponse Source # 
Instance details

Defined in Amazonka.CloudSearch.DefineIndexField

Associated Types

type Rep DefineIndexFieldResponse :: Type -> Type #

NFData DefineIndexFieldResponse Source # 
Instance details

Defined in Amazonka.CloudSearch.DefineIndexField

type Rep DefineIndexFieldResponse Source # 
Instance details

Defined in Amazonka.CloudSearch.DefineIndexField

type Rep DefineIndexFieldResponse = D1 ('MetaData "DefineIndexFieldResponse" "Amazonka.CloudSearch.DefineIndexField" "libZSservicesZSamazonka-cloudsearchZSamazonka-cloudsearch" 'False) (C1 ('MetaCons "DefineIndexFieldResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int) :*: S1 ('MetaSel ('Just "indexField") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 IndexFieldStatus)))

newDefineIndexFieldResponse Source #

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