Amazonka.IoT.DescribeIndex

Describes a search index.

Requires permission to access the DescribeIndex action.

Creating a Request

data DescribeIndex

See: newDescribeIndex smart constructor.

Constructors

DescribeIndex'

Fields

• indexName :: Text

  The index name.

Instances

ToHeaders DescribeIndex

Defined in Amazonka.IoT.DescribeIndex

Methods

toHeaders :: DescribeIndex -> [Header]

ToPath DescribeIndex

Defined in Amazonka.IoT.DescribeIndex

Methods

toPath :: DescribeIndex -> ByteString

ToQuery DescribeIndex

Defined in Amazonka.IoT.DescribeIndex

Methods

toQuery :: DescribeIndex -> QueryString

AWSRequest DescribeIndex

Defined in Amazonka.IoT.DescribeIndex

Associated Types

type AWSResponse DescribeIndex

Methods

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

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

Generic DescribeIndex

Defined in Amazonka.IoT.DescribeIndex

Associated Types

type Rep DescribeIndex :: Type -> Type

Methods

from :: DescribeIndex -> Rep DescribeIndex x

to :: Rep DescribeIndex x -> DescribeIndex

Read DescribeIndex

Defined in Amazonka.IoT.DescribeIndex

Methods

readsPrec :: Int -> ReadS DescribeIndex

readList :: ReadS [DescribeIndex]

readPrec :: ReadPrec DescribeIndex

readListPrec :: ReadPrec [DescribeIndex]

Show DescribeIndex

Defined in Amazonka.IoT.DescribeIndex

Methods

showsPrec :: Int -> DescribeIndex -> ShowS

show :: DescribeIndex -> String

showList :: [DescribeIndex] -> ShowS

NFData DescribeIndex

Defined in Amazonka.IoT.DescribeIndex

Methods

rnf :: DescribeIndex -> ()

Eq DescribeIndex

Defined in Amazonka.IoT.DescribeIndex

Methods

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

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

Hashable DescribeIndex

Defined in Amazonka.IoT.DescribeIndex

Methods

hashWithSalt :: Int -> DescribeIndex -> Int

hash :: DescribeIndex -> Int

type AWSResponse DescribeIndex

Defined in Amazonka.IoT.DescribeIndex

type AWSResponse DescribeIndex = DescribeIndexResponse

type Rep DescribeIndex

Defined in Amazonka.IoT.DescribeIndex

type Rep DescribeIndex = D1 ('MetaData "DescribeIndex" "Amazonka.IoT.DescribeIndex" "amazonka-iot-2.0-6w03vgAfmrM1SG22OsNJXL" 'False) (C1 ('MetaCons "DescribeIndex'" 'PrefixI 'True) (S1 ('MetaSel ('Just "indexName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newDescribeIndex

Arguments

:: Text

DescribeIndex

-> DescribeIndex

Create a value of DescribeIndex 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:

DescribeIndex, describeIndex_indexName - The index name.

Request Lenses

describeIndex_indexName :: Lens' DescribeIndex Text

The index name.

Destructuring the Response

data DescribeIndexResponse

See: newDescribeIndexResponse smart constructor.

Constructors

DescribeIndexResponse'

Fields

• indexName :: Maybe Text

  The index name.

• indexStatus :: Maybe IndexStatus

  The index status.

• schema :: Maybe Text

  Contains a value that specifies the type of indexing performed. Valid values are:

  • REGISTRY – Your thing index contains only registry data.
  • REGISTRY_AND_SHADOW - Your thing index contains registry data and shadow data.
  • REGISTRY_AND_CONNECTIVITY_STATUS - Your thing index contains registry data and thing connectivity status data.
  • REGISTRY_AND_SHADOW_AND_CONNECTIVITY_STATUS - Your thing index contains registry data, shadow data, and thing connectivity status data.
  • MULTI_INDEXING_MODE - Your thing index contains multiple data sources. For more information, see GetIndexingConfiguration.
• httpStatus :: Int

  The response's http status code.

Instances

Generic DescribeIndexResponse

Defined in Amazonka.IoT.DescribeIndex

Associated Types

type Rep DescribeIndexResponse :: Type -> Type

Methods

from :: DescribeIndexResponse -> Rep DescribeIndexResponse x

to :: Rep DescribeIndexResponse x -> DescribeIndexResponse

Read DescribeIndexResponse

Defined in Amazonka.IoT.DescribeIndex

Methods

readsPrec :: Int -> ReadS DescribeIndexResponse

readList :: ReadS [DescribeIndexResponse]

readPrec :: ReadPrec DescribeIndexResponse

readListPrec :: ReadPrec [DescribeIndexResponse]

Show DescribeIndexResponse

Defined in Amazonka.IoT.DescribeIndex

Methods

showsPrec :: Int -> DescribeIndexResponse -> ShowS

show :: DescribeIndexResponse -> String

showList :: [DescribeIndexResponse] -> ShowS

NFData DescribeIndexResponse

Defined in Amazonka.IoT.DescribeIndex

Methods

rnf :: DescribeIndexResponse -> ()

Eq DescribeIndexResponse

Defined in Amazonka.IoT.DescribeIndex

Methods

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

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

type Rep DescribeIndexResponse

Defined in Amazonka.IoT.DescribeIndex

type Rep DescribeIndexResponse = D1 ('MetaData "DescribeIndexResponse" "Amazonka.IoT.DescribeIndex" "amazonka-iot-2.0-6w03vgAfmrM1SG22OsNJXL" 'False) (C1 ('MetaCons "DescribeIndexResponse'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "indexName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "indexStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe IndexStatus))) :*: (S1 ('MetaSel ('Just "schema") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newDescribeIndexResponse

Arguments

:: Int

$sel:httpStatus:DescribeIndexResponse'

-> DescribeIndexResponse

Create a value of DescribeIndexResponse 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:

DescribeIndex, describeIndexResponse_indexName - The index name.

$sel:indexStatus:DescribeIndexResponse', describeIndexResponse_indexStatus - The index status.

$sel:schema:DescribeIndexResponse', describeIndexResponse_schema - Contains a value that specifies the type of indexing performed. Valid values are:

• REGISTRY – Your thing index contains only registry data.
• REGISTRY_AND_SHADOW - Your thing index contains registry data and shadow data.
• REGISTRY_AND_CONNECTIVITY_STATUS - Your thing index contains registry data and thing connectivity status data.
• REGISTRY_AND_SHADOW_AND_CONNECTIVITY_STATUS - Your thing index contains registry data, shadow data, and thing connectivity status data.
• MULTI_INDEXING_MODE - Your thing index contains multiple data sources. For more information, see GetIndexingConfiguration.

$sel:httpStatus:DescribeIndexResponse', describeIndexResponse_httpStatus - The response's http status code.

Response Lenses

describeIndexResponse_indexName :: Lens' DescribeIndexResponse (Maybe Text)

The index name.

describeIndexResponse_indexStatus :: Lens' DescribeIndexResponse (Maybe IndexStatus)

The index status.

describeIndexResponse_schema :: Lens' DescribeIndexResponse (Maybe Text)

Contains a value that specifies the type of indexing performed. Valid values are:

• REGISTRY – Your thing index contains only registry data.
• REGISTRY_AND_SHADOW - Your thing index contains registry data and shadow data.
• REGISTRY_AND_CONNECTIVITY_STATUS - Your thing index contains registry data and thing connectivity status data.
• REGISTRY_AND_SHADOW_AND_CONNECTIVITY_STATUS - Your thing index contains registry data, shadow data, and thing connectivity status data.
• MULTI_INDEXING_MODE - Your thing index contains multiple data sources. For more information, see GetIndexingConfiguration.

describeIndexResponse_httpStatus :: Lens' DescribeIndexResponse Int

The response's http status code.