Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.Kendra.Types.IndexConfigurationSummary

Description

Documentation

data IndexConfigurationSummary Source #

Summary information on the configuration of an index.

See: newIndexConfigurationSummary smart constructor.

Constructors

IndexConfigurationSummary'

Fields

edition :: Maybe IndexEdition
Indicates whether the index is a Enterprise Edition index or a Developer Edition index.
id :: Maybe Text
A identifier for the index. Use this to identify the index when you are using APIs such as Query, DescribeIndex, UpdateIndex, and DeleteIndex.
name :: Maybe Text
The name of the index.
createdAt :: POSIX
The Unix timestamp when the index was created.
updatedAt :: POSIX
The Unix timestamp when the index was last updated by the UpdateIndex API.
status :: IndexStatus
The current status of the index. When the status is ACTIVE, the index is ready to search.

Instances

Instances details

FromJSON IndexConfigurationSummary Source #
Instance details Defined in Amazonka.Kendra.Types.IndexConfigurationSummary Methods parseJSON :: Value -> Parser IndexConfigurationSummary # parseJSONList :: Value -> Parser [IndexConfigurationSummary] #
Generic IndexConfigurationSummary Source #
Instance details Defined in Amazonka.Kendra.Types.IndexConfigurationSummary Associated Types type Rep IndexConfigurationSummary :: Type -> Type # Methods from :: IndexConfigurationSummary -> Rep IndexConfigurationSummary x # to :: Rep IndexConfigurationSummary x -> IndexConfigurationSummary #
Read IndexConfigurationSummary Source #
Instance details Defined in Amazonka.Kendra.Types.IndexConfigurationSummary Methods readsPrec :: Int -> ReadS IndexConfigurationSummary # readList :: ReadS [IndexConfigurationSummary] # readPrec :: ReadPrec IndexConfigurationSummary # readListPrec :: ReadPrec [IndexConfigurationSummary] #
Show IndexConfigurationSummary Source #
Instance details Defined in Amazonka.Kendra.Types.IndexConfigurationSummary Methods showsPrec :: Int -> IndexConfigurationSummary -> ShowS # show :: IndexConfigurationSummary -> String # showList :: [IndexConfigurationSummary] -> ShowS #
NFData IndexConfigurationSummary Source #
Instance details Defined in Amazonka.Kendra.Types.IndexConfigurationSummary Methods rnf :: IndexConfigurationSummary -> () #
Eq IndexConfigurationSummary Source #
Instance details Defined in Amazonka.Kendra.Types.IndexConfigurationSummary Methods (==) :: IndexConfigurationSummary -> IndexConfigurationSummary -> Bool # (/=) :: IndexConfigurationSummary -> IndexConfigurationSummary -> Bool #
Hashable IndexConfigurationSummary Source #
Instance details Defined in Amazonka.Kendra.Types.IndexConfigurationSummary Methods hashWithSalt :: Int -> IndexConfigurationSummary -> Int # hash :: IndexConfigurationSummary -> Int #
type Rep IndexConfigurationSummary Source #
Instance details Defined in Amazonka.Kendra.Types.IndexConfigurationSummary type Rep IndexConfigurationSummary = D1 ('MetaData "IndexConfigurationSummary" "Amazonka.Kendra.Types.IndexConfigurationSummary" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'False) (C1 ('MetaCons "IndexConfigurationSummary'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "edition") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe IndexEdition)) :: (S1 ('MetaSel ('Just "id") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :: (S1 ('MetaSel ('Just "createdAt") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 POSIX) :: (S1 ('MetaSel ('Just "updatedAt") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 POSIX) :*: S1 ('MetaSel ('Just "status") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 IndexStatus)))))

newIndexConfigurationSummary Source #

Arguments

:: UTCTime	`$sel:createdAt:IndexConfigurationSummary'`
-> UTCTime	`$sel:updatedAt:IndexConfigurationSummary'`
-> IndexStatus	`$sel:status:IndexConfigurationSummary'`
-> IndexConfigurationSummary

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

$sel:edition:IndexConfigurationSummary', indexConfigurationSummary_edition - Indicates whether the index is a Enterprise Edition index or a Developer Edition index.

$sel:id:IndexConfigurationSummary', indexConfigurationSummary_id - A identifier for the index. Use this to identify the index when you are using APIs such as Query, DescribeIndex, UpdateIndex, and DeleteIndex.

$sel:name:IndexConfigurationSummary', indexConfigurationSummary_name - The name of the index.

$sel:createdAt:IndexConfigurationSummary', indexConfigurationSummary_createdAt - The Unix timestamp when the index was created.

$sel:updatedAt:IndexConfigurationSummary', indexConfigurationSummary_updatedAt - The Unix timestamp when the index was last updated by the UpdateIndex API.

$sel:status:IndexConfigurationSummary', indexConfigurationSummary_status - The current status of the index. When the status is ACTIVE, the index is ready to search.

indexConfigurationSummary_edition :: Lens' IndexConfigurationSummary (Maybe IndexEdition) Source #

Indicates whether the index is a Enterprise Edition index or a Developer Edition index.

indexConfigurationSummary_id :: Lens' IndexConfigurationSummary (Maybe Text) Source #

A identifier for the index. Use this to identify the index when you are using APIs such as Query, DescribeIndex, UpdateIndex, and DeleteIndex.

indexConfigurationSummary_name :: Lens' IndexConfigurationSummary (Maybe Text) Source #

The name of the index.

indexConfigurationSummary_createdAt :: Lens' IndexConfigurationSummary UTCTime Source #

The Unix timestamp when the index was created.

indexConfigurationSummary_updatedAt :: Lens' IndexConfigurationSummary UTCTime Source #

The Unix timestamp when the index was last updated by the UpdateIndex API.

indexConfigurationSummary_status :: Lens' IndexConfigurationSummary IndexStatus Source #

The current status of the index. When the status is ACTIVE, the index is ready to search.