Network.AWS.CloudSearch.DescribeIndexFields

Gets information about the index fields configured for the search domain. Can be limited to specific fields by name. By default, shows all fields and includes any pending changes to the configuration. Set the Deployed option to true to show the active configuration and exclude pending changes. For more information, see Getting Domain Information in the Amazon CloudSearch Developer Guide .

Creating a Request

describeIndexFields

Arguments

:: Text

difDomainName

-> DescribeIndexFields

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

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

• difDeployed - Whether to display the deployed configuration (true ) or include any pending changes (false ). Defaults to false .
• difFieldNames - A list of the index fields you want to describe. If not specified, information is returned for all configured index fields.
• difDomainName - The name of the domain you want to describe.

data DescribeIndexFields

Container for the parameters to the DescribeIndexFields operation. Specifies the name of the domain you want to describe. To restrict the response to particular index fields, specify the names of the index fields you want to describe. To show the active configuration and exclude any pending changes, set the Deployed option to true .

See: describeIndexFields smart constructor.

Instances

Eq DescribeIndexFields

Methods

(==) :: DescribeIndexFields -> DescribeIndexFields -> Bool

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

Data DescribeIndexFields

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> DescribeIndexFields -> c DescribeIndexFields

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c DescribeIndexFields

toConstr :: DescribeIndexFields -> Constr

dataTypeOf :: DescribeIndexFields -> DataType

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c DescribeIndexFields)

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c DescribeIndexFields)

gmapT :: (forall b. Data b => b -> b) -> DescribeIndexFields -> DescribeIndexFields

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> DescribeIndexFields -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> DescribeIndexFields -> r

gmapQ :: (forall d. Data d => d -> u) -> DescribeIndexFields -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> DescribeIndexFields -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> DescribeIndexFields -> m DescribeIndexFields

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> DescribeIndexFields -> m DescribeIndexFields

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> DescribeIndexFields -> m DescribeIndexFields

Read DescribeIndexFields

Methods

readsPrec :: Int -> ReadS DescribeIndexFields

readList :: ReadS [DescribeIndexFields]

readPrec :: ReadPrec DescribeIndexFields

readListPrec :: ReadPrec [DescribeIndexFields]

Show DescribeIndexFields

Methods

showsPrec :: Int -> DescribeIndexFields -> ShowS

show :: DescribeIndexFields -> String

showList :: [DescribeIndexFields] -> ShowS

Generic DescribeIndexFields

Associated Types

type Rep DescribeIndexFields :: * -> *

Methods

from :: DescribeIndexFields -> Rep DescribeIndexFields x

to :: Rep DescribeIndexFields x -> DescribeIndexFields

Hashable DescribeIndexFields

Methods

hashWithSalt :: Int -> DescribeIndexFields -> Int

hash :: DescribeIndexFields -> Int

NFData DescribeIndexFields

Methods

rnf :: DescribeIndexFields -> ()

AWSRequest DescribeIndexFields

Associated Types

type Rs DescribeIndexFields :: *

Methods

request :: DescribeIndexFields -> Request DescribeIndexFields

response :: (MonadResource m, MonadThrow m) => Logger -> Service -> Proxy * DescribeIndexFields -> ClientResponse -> m (Response DescribeIndexFields)

ToHeaders DescribeIndexFields

Methods

toHeaders :: DescribeIndexFields -> [Header]

ToPath DescribeIndexFields

Methods

toPath :: DescribeIndexFields -> ByteString

ToQuery DescribeIndexFields

Methods

toQuery :: DescribeIndexFields -> QueryString

type Rep DescribeIndexFields

type Rep DescribeIndexFields = D1 * (MetaData "DescribeIndexFields" "Network.AWS.CloudSearch.DescribeIndexFields" "amazonka-cloudsearch-1.6.0-FqLbtgWX59z7wIOS2Mnl98" False) (C1 * (MetaCons "DescribeIndexFields'" PrefixI True) ((:*:) * (S1 * (MetaSel (Just Symbol "_difDeployed") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Bool))) ((:*:) * (S1 * (MetaSel (Just Symbol "_difFieldNames") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe [Text]))) (S1 * (MetaSel (Just Symbol "_difDomainName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * Text)))))

type Rs DescribeIndexFields

type Rs DescribeIndexFields = DescribeIndexFieldsResponse

Request Lenses

difDeployed :: Lens' DescribeIndexFields (Maybe Bool)

Whether to display the deployed configuration (true ) or include any pending changes (false ). Defaults to false .

difFieldNames :: Lens' DescribeIndexFields [Text]

A list of the index fields you want to describe. If not specified, information is returned for all configured index fields.

difDomainName :: Lens' DescribeIndexFields Text

The name of the domain you want to describe.

Destructuring the Response

describeIndexFieldsResponse

Arguments

:: Int

difsrsResponseStatus

-> DescribeIndexFieldsResponse

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

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

• difsrsResponseStatus - -- | The response status code.
• difsrsIndexFields - The index fields configured for the domain.

data DescribeIndexFieldsResponse

The result of a DescribeIndexFields request. Contains the index fields configured for the domain specified in the request.

See: describeIndexFieldsResponse smart constructor.

Instances

Eq DescribeIndexFieldsResponse

Methods

(==) :: DescribeIndexFieldsResponse -> DescribeIndexFieldsResponse -> Bool

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

Data DescribeIndexFieldsResponse

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> DescribeIndexFieldsResponse -> c DescribeIndexFieldsResponse

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c DescribeIndexFieldsResponse

toConstr :: DescribeIndexFieldsResponse -> Constr

dataTypeOf :: DescribeIndexFieldsResponse -> DataType

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c DescribeIndexFieldsResponse)

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c DescribeIndexFieldsResponse)

gmapT :: (forall b. Data b => b -> b) -> DescribeIndexFieldsResponse -> DescribeIndexFieldsResponse

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> DescribeIndexFieldsResponse -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> DescribeIndexFieldsResponse -> r

gmapQ :: (forall d. Data d => d -> u) -> DescribeIndexFieldsResponse -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> DescribeIndexFieldsResponse -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> DescribeIndexFieldsResponse -> m DescribeIndexFieldsResponse

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> DescribeIndexFieldsResponse -> m DescribeIndexFieldsResponse

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> DescribeIndexFieldsResponse -> m DescribeIndexFieldsResponse

Read DescribeIndexFieldsResponse

Methods

readsPrec :: Int -> ReadS DescribeIndexFieldsResponse

readList :: ReadS [DescribeIndexFieldsResponse]

readPrec :: ReadPrec DescribeIndexFieldsResponse

readListPrec :: ReadPrec [DescribeIndexFieldsResponse]

Show DescribeIndexFieldsResponse

Methods

showsPrec :: Int -> DescribeIndexFieldsResponse -> ShowS

show :: DescribeIndexFieldsResponse -> String

showList :: [DescribeIndexFieldsResponse] -> ShowS

Generic DescribeIndexFieldsResponse

Associated Types

type Rep DescribeIndexFieldsResponse :: * -> *

Methods

from :: DescribeIndexFieldsResponse -> Rep DescribeIndexFieldsResponse x

to :: Rep DescribeIndexFieldsResponse x -> DescribeIndexFieldsResponse

NFData DescribeIndexFieldsResponse

Methods

rnf :: DescribeIndexFieldsResponse -> ()

type Rep DescribeIndexFieldsResponse

type Rep DescribeIndexFieldsResponse = D1 * (MetaData "DescribeIndexFieldsResponse" "Network.AWS.CloudSearch.DescribeIndexFields" "amazonka-cloudsearch-1.6.0-FqLbtgWX59z7wIOS2Mnl98" False) (C1 * (MetaCons "DescribeIndexFieldsResponse'" PrefixI True) ((:*:) * (S1 * (MetaSel (Just Symbol "_difsrsResponseStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * Int)) (S1 * (MetaSel (Just Symbol "_difsrsIndexFields") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * [IndexFieldStatus]))))

Response Lenses

difsrsResponseStatus :: Lens' DescribeIndexFieldsResponse Int

• - | The response status code.

difsrsIndexFields :: Lens' DescribeIndexFieldsResponse [IndexFieldStatus]

The index fields configured for the domain.