Copyright	(c) 2013-2018 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
Language	Haskell2010

Network.AWS.CloudSearch.DefineIndexField

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

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 .

Creating a Request

defineIndexField #

Arguments

:: Text	`defeDomainName`
-> IndexField	`defeIndexField`
-> DefineIndexField

Creates a value of DefineIndexField with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

defeDomainName - Undocumented member.
defeIndexField - The index field and field options you want to configure.

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: defineIndexField smart constructor.

Instances

Eq DefineIndexField #
Instance details Defined in Network.AWS.CloudSearch.DefineIndexField Methods (==) :: DefineIndexField -> DefineIndexField -> Bool # (/=) :: DefineIndexField -> DefineIndexField -> Bool #
Data DefineIndexField #
Instance details Defined in Network.AWS.CloudSearch.DefineIndexField Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> DefineIndexField -> c DefineIndexField # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c DefineIndexField # toConstr :: DefineIndexField -> Constr # dataTypeOf :: DefineIndexField -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c DefineIndexField) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c DefineIndexField) # gmapT :: (forall b. Data b => b -> b) -> DefineIndexField -> DefineIndexField # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> DefineIndexField -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> DefineIndexField -> r # gmapQ :: (forall d. Data d => d -> u) -> DefineIndexField -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> DefineIndexField -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> DefineIndexField -> m DefineIndexField # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> DefineIndexField -> m DefineIndexField # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> DefineIndexField -> m DefineIndexField #
Read DefineIndexField #
Instance details Defined in Network.AWS.CloudSearch.DefineIndexField Methods readsPrec :: Int -> ReadS DefineIndexField # readList :: ReadS [DefineIndexField] # readPrec :: ReadPrec DefineIndexField # readListPrec :: ReadPrec [DefineIndexField] #
Show DefineIndexField #
Instance details Defined in Network.AWS.CloudSearch.DefineIndexField Methods showsPrec :: Int -> DefineIndexField -> ShowS # show :: DefineIndexField -> String # showList :: [DefineIndexField] -> ShowS #
Generic DefineIndexField #
Instance details Defined in Network.AWS.CloudSearch.DefineIndexField Associated Types type Rep DefineIndexField :: * -> * # Methods from :: DefineIndexField -> Rep DefineIndexField x # to :: Rep DefineIndexField x -> DefineIndexField #
Hashable DefineIndexField #
Instance details Defined in Network.AWS.CloudSearch.DefineIndexField Methods hashWithSalt :: Int -> DefineIndexField -> Int # hash :: DefineIndexField -> Int #
AWSRequest DefineIndexField #
Instance details Defined in Network.AWS.CloudSearch.DefineIndexField Associated Types type Rs DefineIndexField :: * # Methods request :: DefineIndexField -> Request DefineIndexField # response :: (MonadResource m, MonadThrow m) => Logger -> Service -> Proxy DefineIndexField -> ClientResponse -> m (Response DefineIndexField) #
ToHeaders DefineIndexField #
Instance details Defined in Network.AWS.CloudSearch.DefineIndexField Methods toHeaders :: DefineIndexField -> [Header] #
ToPath DefineIndexField #
Instance details Defined in Network.AWS.CloudSearch.DefineIndexField Methods toPath :: DefineIndexField -> ByteString #
ToQuery DefineIndexField #
Instance details Defined in Network.AWS.CloudSearch.DefineIndexField Methods toQuery :: DefineIndexField -> QueryString #
NFData DefineIndexField #
Instance details Defined in Network.AWS.CloudSearch.DefineIndexField Methods rnf :: DefineIndexField -> () #
type Rep DefineIndexField #
Instance details Defined in Network.AWS.CloudSearch.DefineIndexField type Rep DefineIndexField = D1 (MetaData "DefineIndexField" "Network.AWS.CloudSearch.DefineIndexField" "amazonka-cloudsearch-1.6.0-C9KDnoOihM1BDmnzNS5XoR" False) (C1 (MetaCons "DefineIndexField'" PrefixI True) (S1 (MetaSel (Just "_defeDomainName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text) :*: S1 (MetaSel (Just "_defeIndexField") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 IndexField)))
type Rs DefineIndexField #
Instance details Defined in Network.AWS.CloudSearch.DefineIndexField type Rs DefineIndexField = DefineIndexFieldResponse

Request Lenses

defeDomainName :: Lens' DefineIndexField Text #

Undocumented member.

defeIndexField :: Lens' DefineIndexField IndexField #

The index field and field options you want to configure.

Destructuring the Response

defineIndexFieldResponse #

Arguments

:: Int	`defrsResponseStatus`
-> IndexFieldStatus	`defrsIndexField`
-> DefineIndexFieldResponse

Creates a value of DefineIndexFieldResponse with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

defrsResponseStatus - -- | The response status code.
defrsIndexField - Undocumented member.

data DefineIndexFieldResponse #

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

See: defineIndexFieldResponse smart constructor.

Instances

Eq DefineIndexFieldResponse #
Instance details Defined in Network.AWS.CloudSearch.DefineIndexField Methods (==) :: DefineIndexFieldResponse -> DefineIndexFieldResponse -> Bool # (/=) :: DefineIndexFieldResponse -> DefineIndexFieldResponse -> Bool #
Data DefineIndexFieldResponse #
Instance details Defined in Network.AWS.CloudSearch.DefineIndexField Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> DefineIndexFieldResponse -> c DefineIndexFieldResponse # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c DefineIndexFieldResponse # toConstr :: DefineIndexFieldResponse -> Constr # dataTypeOf :: DefineIndexFieldResponse -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c DefineIndexFieldResponse) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c DefineIndexFieldResponse) # gmapT :: (forall b. Data b => b -> b) -> DefineIndexFieldResponse -> DefineIndexFieldResponse # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> DefineIndexFieldResponse -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> DefineIndexFieldResponse -> r # gmapQ :: (forall d. Data d => d -> u) -> DefineIndexFieldResponse -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> DefineIndexFieldResponse -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> DefineIndexFieldResponse -> m DefineIndexFieldResponse # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> DefineIndexFieldResponse -> m DefineIndexFieldResponse # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> DefineIndexFieldResponse -> m DefineIndexFieldResponse #
Read DefineIndexFieldResponse #
Instance details Defined in Network.AWS.CloudSearch.DefineIndexField Methods readsPrec :: Int -> ReadS DefineIndexFieldResponse # readList :: ReadS [DefineIndexFieldResponse] # readPrec :: ReadPrec DefineIndexFieldResponse # readListPrec :: ReadPrec [DefineIndexFieldResponse] #
Show DefineIndexFieldResponse #
Instance details Defined in Network.AWS.CloudSearch.DefineIndexField Methods showsPrec :: Int -> DefineIndexFieldResponse -> ShowS # show :: DefineIndexFieldResponse -> String # showList :: [DefineIndexFieldResponse] -> ShowS #
Generic DefineIndexFieldResponse #
Instance details Defined in Network.AWS.CloudSearch.DefineIndexField Associated Types type Rep DefineIndexFieldResponse :: * -> * # Methods from :: DefineIndexFieldResponse -> Rep DefineIndexFieldResponse x # to :: Rep DefineIndexFieldResponse x -> DefineIndexFieldResponse #
NFData DefineIndexFieldResponse #
Instance details Defined in Network.AWS.CloudSearch.DefineIndexField Methods rnf :: DefineIndexFieldResponse -> () #
type Rep DefineIndexFieldResponse #
Instance details Defined in Network.AWS.CloudSearch.DefineIndexField type Rep DefineIndexFieldResponse = D1 (MetaData "DefineIndexFieldResponse" "Network.AWS.CloudSearch.DefineIndexField" "amazonka-cloudsearch-1.6.0-C9KDnoOihM1BDmnzNS5XoR" False) (C1 (MetaCons "DefineIndexFieldResponse'" PrefixI True) (S1 (MetaSel (Just "_defrsResponseStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Int) :*: S1 (MetaSel (Just "_defrsIndexField") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 IndexFieldStatus)))

Response Lenses

defrsResponseStatus :: Lens' DefineIndexFieldResponse Int #

- | The response status code.

defrsIndexField :: Lens' DefineIndexFieldResponse IndexFieldStatus #

Undocumented member.