Network.AWS.IoT.DescribeIndex

Describes a search index.

Creating a Request

describeIndex

Arguments

:: Text

diIndexName

-> DescribeIndex

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

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

• diIndexName - The index name.

data DescribeIndex

See: describeIndex smart constructor.

Instances

Eq DescribeIndex

Methods

(==) :: DescribeIndex -> DescribeIndex -> Bool

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

Data DescribeIndex

Methods

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

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

toConstr :: DescribeIndex -> Constr

dataTypeOf :: DescribeIndex -> DataType

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

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

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

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

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

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

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

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

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

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

Read DescribeIndex

Methods

readsPrec :: Int -> ReadS DescribeIndex

readList :: ReadS [DescribeIndex]

readPrec :: ReadPrec DescribeIndex

readListPrec :: ReadPrec [DescribeIndex]

Show DescribeIndex

Methods

showsPrec :: Int -> DescribeIndex -> ShowS

show :: DescribeIndex -> String

showList :: [DescribeIndex] -> ShowS

Generic DescribeIndex

Associated Types

type Rep DescribeIndex :: * -> *

Methods

from :: DescribeIndex -> Rep DescribeIndex x

to :: Rep DescribeIndex x -> DescribeIndex

Hashable DescribeIndex

Methods

hashWithSalt :: Int -> DescribeIndex -> Int

hash :: DescribeIndex -> Int

NFData DescribeIndex

Methods

rnf :: DescribeIndex -> ()

AWSRequest DescribeIndex

Associated Types

type Rs DescribeIndex :: *

Methods

request :: DescribeIndex -> Request DescribeIndex

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

ToHeaders DescribeIndex

Methods

toHeaders :: DescribeIndex -> [Header]

ToPath DescribeIndex

Methods

toPath :: DescribeIndex -> ByteString

ToQuery DescribeIndex

Methods

toQuery :: DescribeIndex -> QueryString

type Rep DescribeIndex

type Rep DescribeIndex = D1 * (MetaData "DescribeIndex" "Network.AWS.IoT.DescribeIndex" "amazonka-iot-1.6.0-GZYdsKS1TEjHFZo6BqaYJk" True) (C1 * (MetaCons "DescribeIndex'" PrefixI True) (S1 * (MetaSel (Just Symbol "_diIndexName") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 * Text)))

type Rs DescribeIndex

type Rs DescribeIndex = DescribeIndexResponse

Request Lenses

diIndexName :: Lens' DescribeIndex Text

The index name.

Destructuring the Response

describeIndexResponse

Arguments

:: Int

dirsResponseStatus

-> DescribeIndexResponse

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

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

• dirsIndexStatus - The index status.
• dirsSchema - Contains a value that specifies the type of indexing performed. Valid values are: * REGISTRY – Your thing index will contain only registry data. * REGISTRY_AND_SHADOW - Your thing index will contain registry and shadow data.
• dirsIndexName - The index name.
• dirsResponseStatus - -- | The response status code.

data DescribeIndexResponse

See: describeIndexResponse smart constructor.

Instances

Eq DescribeIndexResponse

Methods

(==) :: DescribeIndexResponse -> DescribeIndexResponse -> Bool

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

Data DescribeIndexResponse

Methods

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

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

toConstr :: DescribeIndexResponse -> Constr

dataTypeOf :: DescribeIndexResponse -> DataType

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

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

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

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

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

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

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

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

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

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

Read DescribeIndexResponse

Methods

readsPrec :: Int -> ReadS DescribeIndexResponse

readList :: ReadS [DescribeIndexResponse]

readPrec :: ReadPrec DescribeIndexResponse

readListPrec :: ReadPrec [DescribeIndexResponse]

Show DescribeIndexResponse

Methods

showsPrec :: Int -> DescribeIndexResponse -> ShowS

show :: DescribeIndexResponse -> String

showList :: [DescribeIndexResponse] -> ShowS

Generic DescribeIndexResponse

Associated Types

type Rep DescribeIndexResponse :: * -> *

Methods

from :: DescribeIndexResponse -> Rep DescribeIndexResponse x

to :: Rep DescribeIndexResponse x -> DescribeIndexResponse

NFData DescribeIndexResponse

Methods

rnf :: DescribeIndexResponse -> ()

type Rep DescribeIndexResponse

type Rep DescribeIndexResponse = D1 * (MetaData "DescribeIndexResponse" "Network.AWS.IoT.DescribeIndex" "amazonka-iot-1.6.0-GZYdsKS1TEjHFZo6BqaYJk" False) (C1 * (MetaCons "DescribeIndexResponse'" PrefixI True) ((:*:) * ((:*:) * (S1 * (MetaSel (Just Symbol "_dirsIndexStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe IndexStatus))) (S1 * (MetaSel (Just Symbol "_dirsSchema") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text)))) ((:*:) * (S1 * (MetaSel (Just Symbol "_dirsIndexName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) (S1 * (MetaSel (Just Symbol "_dirsResponseStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * Int)))))

Response Lenses

dirsIndexStatus :: Lens' DescribeIndexResponse (Maybe IndexStatus)

The index status.

dirsSchema :: Lens' DescribeIndexResponse (Maybe Text)

Contains a value that specifies the type of indexing performed. Valid values are: * REGISTRY – Your thing index will contain only registry data. * REGISTRY_AND_SHADOW - Your thing index will contain registry and shadow data.

dirsIndexName :: Lens' DescribeIndexResponse (Maybe Text)

The index name.

dirsResponseStatus :: Lens' DescribeIndexResponse Int

• - | The response status code.