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.Wisdom.Types.KnowledgeBaseSummary

Description

Synopsis

Documentation

data KnowledgeBaseSummary Source #

Summary information about the knowledge base.

See: newKnowledgeBaseSummary smart constructor.

Constructors

KnowledgeBaseSummary'

Fields

description :: Maybe Text
The description of the knowledge base.
renderingConfiguration :: Maybe RenderingConfiguration
Information about how to render the content.
serverSideEncryptionConfiguration :: Maybe ServerSideEncryptionConfiguration
The KMS key used for encryption.
sourceConfiguration :: Maybe SourceConfiguration
Configuration information about the external data source.
tags :: Maybe (HashMap Text Text)
The tags used to organize, track, or control access for this resource.
knowledgeBaseArn :: Text
The Amazon Resource Name (ARN) of the knowledge base.
knowledgeBaseId :: Text
The identifier of the knowledge base.
knowledgeBaseType :: KnowledgeBaseType
The type of knowledge base.
name :: Text
The name of the knowledge base.
status :: KnowledgeBaseStatus
The status of the knowledge base summary.

Instances

Instances details

FromJSON KnowledgeBaseSummary Source #
Instance details Defined in Amazonka.Wisdom.Types.KnowledgeBaseSummary Methods parseJSON :: Value -> Parser KnowledgeBaseSummary # parseJSONList :: Value -> Parser [KnowledgeBaseSummary] #
Generic KnowledgeBaseSummary Source #
Instance details Defined in Amazonka.Wisdom.Types.KnowledgeBaseSummary Associated Types type Rep KnowledgeBaseSummary :: Type -> Type # Methods from :: KnowledgeBaseSummary -> Rep KnowledgeBaseSummary x # to :: Rep KnowledgeBaseSummary x -> KnowledgeBaseSummary #
Read KnowledgeBaseSummary Source #
Instance details Defined in Amazonka.Wisdom.Types.KnowledgeBaseSummary Methods readsPrec :: Int -> ReadS KnowledgeBaseSummary # readList :: ReadS [KnowledgeBaseSummary] # readPrec :: ReadPrec KnowledgeBaseSummary # readListPrec :: ReadPrec [KnowledgeBaseSummary] #
Show KnowledgeBaseSummary Source #
Instance details Defined in Amazonka.Wisdom.Types.KnowledgeBaseSummary Methods showsPrec :: Int -> KnowledgeBaseSummary -> ShowS # show :: KnowledgeBaseSummary -> String # showList :: [KnowledgeBaseSummary] -> ShowS #
NFData KnowledgeBaseSummary Source #
Instance details Defined in Amazonka.Wisdom.Types.KnowledgeBaseSummary Methods rnf :: KnowledgeBaseSummary -> () #
Eq KnowledgeBaseSummary Source #
Instance details Defined in Amazonka.Wisdom.Types.KnowledgeBaseSummary Methods (==) :: KnowledgeBaseSummary -> KnowledgeBaseSummary -> Bool # (/=) :: KnowledgeBaseSummary -> KnowledgeBaseSummary -> Bool #
Hashable KnowledgeBaseSummary Source #
Instance details Defined in Amazonka.Wisdom.Types.KnowledgeBaseSummary Methods hashWithSalt :: Int -> KnowledgeBaseSummary -> Int # hash :: KnowledgeBaseSummary -> Int #
type Rep KnowledgeBaseSummary Source #
Instance details Defined in Amazonka.Wisdom.Types.KnowledgeBaseSummary type Rep KnowledgeBaseSummary = D1 ('MetaData "KnowledgeBaseSummary" "Amazonka.Wisdom.Types.KnowledgeBaseSummary" "amazonka-wisdom-2.0-D8ZGZ1sJNnDDHDNbH2yubp" 'False) (C1 ('MetaCons "KnowledgeBaseSummary'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "renderingConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe RenderingConfiguration))) :: (S1 ('MetaSel ('Just "serverSideEncryptionConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ServerSideEncryptionConfiguration)) :: (S1 ('MetaSel ('Just "sourceConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe SourceConfiguration)) :: S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text)))))) :: ((S1 ('MetaSel ('Just "knowledgeBaseArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: S1 ('MetaSel ('Just "knowledgeBaseId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)) :: (S1 ('MetaSel ('Just "knowledgeBaseType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 KnowledgeBaseType) :: (S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "status") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 KnowledgeBaseStatus))))))

newKnowledgeBaseSummary Source #

Arguments

:: Text	`$sel:knowledgeBaseArn:KnowledgeBaseSummary'`
-> Text	`$sel:knowledgeBaseId:KnowledgeBaseSummary'`
-> KnowledgeBaseType	`$sel:knowledgeBaseType:KnowledgeBaseSummary'`
-> Text	`$sel:name:KnowledgeBaseSummary'`
-> KnowledgeBaseStatus	`$sel:status:KnowledgeBaseSummary'`
-> KnowledgeBaseSummary

Create a value of KnowledgeBaseSummary 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:description:KnowledgeBaseSummary', knowledgeBaseSummary_description - The description of the knowledge base.

$sel:renderingConfiguration:KnowledgeBaseSummary', knowledgeBaseSummary_renderingConfiguration - Information about how to render the content.

$sel:serverSideEncryptionConfiguration:KnowledgeBaseSummary', knowledgeBaseSummary_serverSideEncryptionConfiguration - The KMS key used for encryption.

$sel:sourceConfiguration:KnowledgeBaseSummary', knowledgeBaseSummary_sourceConfiguration - Configuration information about the external data source.

$sel:tags:KnowledgeBaseSummary', knowledgeBaseSummary_tags - The tags used to organize, track, or control access for this resource.

$sel:knowledgeBaseArn:KnowledgeBaseSummary', knowledgeBaseSummary_knowledgeBaseArn - The Amazon Resource Name (ARN) of the knowledge base.

$sel:knowledgeBaseId:KnowledgeBaseSummary', knowledgeBaseSummary_knowledgeBaseId - The identifier of the knowledge base.

$sel:knowledgeBaseType:KnowledgeBaseSummary', knowledgeBaseSummary_knowledgeBaseType - The type of knowledge base.

$sel:name:KnowledgeBaseSummary', knowledgeBaseSummary_name - The name of the knowledge base.

$sel:status:KnowledgeBaseSummary', knowledgeBaseSummary_status - The status of the knowledge base summary.

knowledgeBaseSummary_description :: Lens' KnowledgeBaseSummary (Maybe Text) Source #

The description of the knowledge base.

knowledgeBaseSummary_renderingConfiguration :: Lens' KnowledgeBaseSummary (Maybe RenderingConfiguration) Source #

Information about how to render the content.

knowledgeBaseSummary_serverSideEncryptionConfiguration :: Lens' KnowledgeBaseSummary (Maybe ServerSideEncryptionConfiguration) Source #

The KMS key used for encryption.

knowledgeBaseSummary_sourceConfiguration :: Lens' KnowledgeBaseSummary (Maybe SourceConfiguration) Source #

Configuration information about the external data source.

knowledgeBaseSummary_tags :: Lens' KnowledgeBaseSummary (Maybe (HashMap Text Text)) Source #

The tags used to organize, track, or control access for this resource.

knowledgeBaseSummary_knowledgeBaseArn :: Lens' KnowledgeBaseSummary Text Source #

The Amazon Resource Name (ARN) of the knowledge base.

knowledgeBaseSummary_knowledgeBaseId :: Lens' KnowledgeBaseSummary Text Source #

The identifier of the knowledge base.

knowledgeBaseSummary_knowledgeBaseType :: Lens' KnowledgeBaseSummary KnowledgeBaseType Source #

The type of knowledge base.

knowledgeBaseSummary_name :: Lens' KnowledgeBaseSummary Text Source #

The name of the knowledge base.

knowledgeBaseSummary_status :: Lens' KnowledgeBaseSummary KnowledgeBaseStatus Source #

The status of the knowledge base summary.