Amazonka.CloudSearch.DefineIndexField

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.

Creating a Request

data DefineIndexField

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

• domainName :: Text
• indexField :: IndexField

  The index field and field options you want to configure.

Instances

ToHeaders DefineIndexField

Defined in Amazonka.CloudSearch.DefineIndexField

Methods

toHeaders :: DefineIndexField -> [Header]

ToPath DefineIndexField

Defined in Amazonka.CloudSearch.DefineIndexField

Methods

toPath :: DefineIndexField -> ByteString

ToQuery DefineIndexField

Defined in Amazonka.CloudSearch.DefineIndexField

Methods

toQuery :: DefineIndexField -> QueryString

AWSRequest DefineIndexField

Defined in Amazonka.CloudSearch.DefineIndexField

Associated Types

type AWSResponse DefineIndexField

Methods

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

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

Generic DefineIndexField

Defined in Amazonka.CloudSearch.DefineIndexField

Associated Types

type Rep DefineIndexField :: Type -> Type

Methods

from :: DefineIndexField -> Rep DefineIndexField x

to :: Rep DefineIndexField x -> DefineIndexField

Read DefineIndexField

Defined in Amazonka.CloudSearch.DefineIndexField

Methods

readsPrec :: Int -> ReadS DefineIndexField

readList :: ReadS [DefineIndexField]

readPrec :: ReadPrec DefineIndexField

readListPrec :: ReadPrec [DefineIndexField]

Show DefineIndexField

Defined in Amazonka.CloudSearch.DefineIndexField

Methods

showsPrec :: Int -> DefineIndexField -> ShowS

show :: DefineIndexField -> String

showList :: [DefineIndexField] -> ShowS

NFData DefineIndexField

Defined in Amazonka.CloudSearch.DefineIndexField

Methods

rnf :: DefineIndexField -> ()

Eq DefineIndexField

Defined in Amazonka.CloudSearch.DefineIndexField

Methods

(==) :: DefineIndexField -> DefineIndexField -> Bool

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

Hashable DefineIndexField

Defined in Amazonka.CloudSearch.DefineIndexField

Methods

hashWithSalt :: Int -> DefineIndexField -> Int

hash :: DefineIndexField -> Int

type AWSResponse DefineIndexField

Defined in Amazonka.CloudSearch.DefineIndexField

type AWSResponse DefineIndexField = DefineIndexFieldResponse

type Rep DefineIndexField

Defined in Amazonka.CloudSearch.DefineIndexField

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

newDefineIndexField

Arguments

:: Text

DefineIndexField

-> IndexField

DefineIndexField

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

DefineIndexField, defineIndexField_domainName - Undocumented member.

DefineIndexField, defineIndexField_indexField - The index field and field options you want to configure.

Request Lenses

defineIndexField_domainName :: Lens' DefineIndexField Text

Undocumented member.

defineIndexField_indexField :: Lens' DefineIndexField IndexField

The index field and field options you want to configure.

Destructuring the Response

data DefineIndexFieldResponse

The result of a DefineIndexField request. Contains the status of the newly-configured index field.

See: newDefineIndexFieldResponse smart constructor.

Constructors

DefineIndexFieldResponse'

Fields

• httpStatus :: Int

  The response's http status code.

• indexField :: IndexFieldStatus

Instances

Generic DefineIndexFieldResponse

Defined in Amazonka.CloudSearch.DefineIndexField

Associated Types

type Rep DefineIndexFieldResponse :: Type -> Type

Methods

from :: DefineIndexFieldResponse -> Rep DefineIndexFieldResponse x

to :: Rep DefineIndexFieldResponse x -> DefineIndexFieldResponse

Read DefineIndexFieldResponse

Defined in Amazonka.CloudSearch.DefineIndexField

Methods

readsPrec :: Int -> ReadS DefineIndexFieldResponse

readList :: ReadS [DefineIndexFieldResponse]

readPrec :: ReadPrec DefineIndexFieldResponse

readListPrec :: ReadPrec [DefineIndexFieldResponse]

Show DefineIndexFieldResponse

Defined in Amazonka.CloudSearch.DefineIndexField

Methods

showsPrec :: Int -> DefineIndexFieldResponse -> ShowS

show :: DefineIndexFieldResponse -> String

showList :: [DefineIndexFieldResponse] -> ShowS

NFData DefineIndexFieldResponse

Defined in Amazonka.CloudSearch.DefineIndexField

Methods

rnf :: DefineIndexFieldResponse -> ()

Eq DefineIndexFieldResponse

Defined in Amazonka.CloudSearch.DefineIndexField

Methods

(==) :: DefineIndexFieldResponse -> DefineIndexFieldResponse -> Bool

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

type Rep DefineIndexFieldResponse

Defined in Amazonka.CloudSearch.DefineIndexField

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

Arguments

:: Int

$sel:httpStatus:DefineIndexFieldResponse'

-> IndexFieldStatus

DefineIndexField

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

DefineIndexField, defineIndexFieldResponse_indexField - Undocumented member.

Response Lenses

defineIndexFieldResponse_httpStatus :: Lens' DefineIndexFieldResponse Int

The response's http status code.

defineIndexFieldResponse_indexField :: Lens' DefineIndexFieldResponse IndexFieldStatus

Undocumented member.