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

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
• defeIndexField

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

Methods

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

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

Data 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

Methods

readsPrec :: Int -> ReadS DefineIndexField

readList :: ReadS [DefineIndexField]

readPrec :: ReadPrec DefineIndexField

readListPrec :: ReadPrec [DefineIndexField]

Show DefineIndexField

Methods

showsPrec :: Int -> DefineIndexField -> ShowS

show :: DefineIndexField -> String

showList :: [DefineIndexField] -> ShowS

Generic DefineIndexField

Associated Types

type Rep DefineIndexField :: * -> *

Methods

from :: DefineIndexField -> Rep DefineIndexField x

to :: Rep DefineIndexField x -> DefineIndexField

Hashable DefineIndexField

Methods

hashWithSalt :: Int -> DefineIndexField -> Int

hash :: DefineIndexField -> Int

NFData DefineIndexField

Methods

rnf :: DefineIndexField -> ()

AWSRequest DefineIndexField

Associated Types

type Rs DefineIndexField :: *

Methods

request :: DefineIndexField -> Request DefineIndexField

response :: MonadResource m => Logger -> Service -> Proxy * DefineIndexField -> ClientResponse -> m (Response DefineIndexField)

ToPath DefineIndexField

Methods

toPath :: DefineIndexField -> ByteString

ToHeaders DefineIndexField

Methods

toHeaders :: DefineIndexField -> [Header]

ToQuery DefineIndexField

Methods

toQuery :: DefineIndexField -> QueryString

type Rep DefineIndexField

type Rep DefineIndexField = D1 (MetaData "DefineIndexField" "Network.AWS.CloudSearch.DefineIndexField" "amazonka-cloudsearch-1.4.3-8jIA3omBRonH9H48gQAXGd" False) (C1 (MetaCons "DefineIndexField'" PrefixI True) ((:*:) (S1 (MetaSel (Just Symbol "_defeDomainName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text)) (S1 (MetaSel (Just Symbol "_defeIndexField") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 IndexField))))

type Rs 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
• defrsIndexField

data DefineIndexFieldResponse

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

See: defineIndexFieldResponse smart constructor.

Instances

Eq DefineIndexFieldResponse

Methods

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

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

Data DefineIndexFieldResponse

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

Methods

readsPrec :: Int -> ReadS DefineIndexFieldResponse

readList :: ReadS [DefineIndexFieldResponse]

readPrec :: ReadPrec DefineIndexFieldResponse

readListPrec :: ReadPrec [DefineIndexFieldResponse]

Show DefineIndexFieldResponse

Methods

showsPrec :: Int -> DefineIndexFieldResponse -> ShowS

show :: DefineIndexFieldResponse -> String

showList :: [DefineIndexFieldResponse] -> ShowS

Generic DefineIndexFieldResponse

Associated Types

type Rep DefineIndexFieldResponse :: * -> *

Methods

from :: DefineIndexFieldResponse -> Rep DefineIndexFieldResponse x

to :: Rep DefineIndexFieldResponse x -> DefineIndexFieldResponse

NFData DefineIndexFieldResponse

Methods

rnf :: DefineIndexFieldResponse -> ()

type Rep DefineIndexFieldResponse

type Rep DefineIndexFieldResponse = D1 (MetaData "DefineIndexFieldResponse" "Network.AWS.CloudSearch.DefineIndexField" "amazonka-cloudsearch-1.4.3-8jIA3omBRonH9H48gQAXGd" False) (C1 (MetaCons "DefineIndexFieldResponse'" PrefixI True) ((:*:) (S1 (MetaSel (Just Symbol "_defrsResponseStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Int)) (S1 (MetaSel (Just Symbol "_defrsIndexField") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 IndexFieldStatus))))

Response Lenses

defrsResponseStatus :: Lens' DefineIndexFieldResponse Int

The response status code.

defrsIndexField :: Lens' DefineIndexFieldResponse IndexFieldStatus

Undocumented member.