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.UpdateDataSource

Contents

Creating a Request
Request Lenses
Destructuring the Response

Description

Updates an existing Amazon Kendra data source connector.

Synopsis

data UpdateDataSource = UpdateDataSource' {
- configuration :: Maybe DataSourceConfiguration
- customDocumentEnrichmentConfiguration :: Maybe CustomDocumentEnrichmentConfiguration
- description :: Maybe Text
- languageCode :: Maybe Text
- name :: Maybe Text
- roleArn :: Maybe Text
- schedule :: Maybe Text
- vpcConfiguration :: Maybe DataSourceVpcConfiguration
- id :: Text
- indexId :: Text
}
newUpdateDataSource :: Text -> Text -> UpdateDataSource
updateDataSource_configuration :: Lens' UpdateDataSource (Maybe DataSourceConfiguration)
updateDataSource_customDocumentEnrichmentConfiguration :: Lens' UpdateDataSource (Maybe CustomDocumentEnrichmentConfiguration)
updateDataSource_description :: Lens' UpdateDataSource (Maybe Text)
updateDataSource_languageCode :: Lens' UpdateDataSource (Maybe Text)
updateDataSource_name :: Lens' UpdateDataSource (Maybe Text)
updateDataSource_roleArn :: Lens' UpdateDataSource (Maybe Text)
updateDataSource_schedule :: Lens' UpdateDataSource (Maybe Text)
updateDataSource_vpcConfiguration :: Lens' UpdateDataSource (Maybe DataSourceVpcConfiguration)
updateDataSource_id :: Lens' UpdateDataSource Text
updateDataSource_indexId :: Lens' UpdateDataSource Text
data UpdateDataSourceResponse = UpdateDataSourceResponse' {
}
newUpdateDataSourceResponse :: UpdateDataSourceResponse

Creating a Request

data UpdateDataSource Source #

See: newUpdateDataSource smart constructor.

Constructors

UpdateDataSource'

Fields

configuration :: Maybe DataSourceConfiguration
Configuration information you want to update for the data source connector.
customDocumentEnrichmentConfiguration :: Maybe CustomDocumentEnrichmentConfiguration
Configuration information you want to update for altering document metadata and content during the document ingestion process.
For more information on how to create, modify and delete document metadata, or make other content alterations when you ingest documents into Amazon Kendra, see Customizing document metadata during the ingestion process.
description :: Maybe Text
A new description for the data source connector.
languageCode :: Maybe Text
The code for a language you want to update for the data source connector. This allows you to support a language for all documents when updating the data source. English is supported by default. For more information on supported languages, including their codes, see Adding documents in languages other than English.
name :: Maybe Text
A new name for the data source connector.
roleArn :: Maybe Text
The Amazon Resource Name (ARN) of a role with permission to access the data source and required resources. For more information, see IAM roles for Amazon Kendra.
schedule :: Maybe Text
The sync schedule you want to update for the data source connector.
vpcConfiguration :: Maybe DataSourceVpcConfiguration
Configuration information for an Amazon Virtual Private Cloud to connect to your data source. For more information, see Configuring a VPC.
id :: Text
The identifier of the data source connector you want to update.
indexId :: Text
The identifier of the index used with the data source connector.

Instances

Instances details

ToJSON UpdateDataSource Source #
Instance details Defined in Amazonka.Kendra.UpdateDataSource Methods toJSON :: UpdateDataSource -> Value # toEncoding :: UpdateDataSource -> Encoding # toJSONList :: [UpdateDataSource] -> Value # toEncodingList :: [UpdateDataSource] -> Encoding #
ToHeaders UpdateDataSource Source #
Instance details Defined in Amazonka.Kendra.UpdateDataSource Methods toHeaders :: UpdateDataSource -> [Header] #
ToPath UpdateDataSource Source #
Instance details Defined in Amazonka.Kendra.UpdateDataSource Methods toPath :: UpdateDataSource -> ByteString #
ToQuery UpdateDataSource Source #
Instance details Defined in Amazonka.Kendra.UpdateDataSource Methods toQuery :: UpdateDataSource -> QueryString #
AWSRequest UpdateDataSource Source #
Instance details Defined in Amazonka.Kendra.UpdateDataSource Associated Types type AWSResponse UpdateDataSource # Methods request :: (Service -> Service) -> UpdateDataSource -> Request UpdateDataSource # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy UpdateDataSource -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse UpdateDataSource))) #
Generic UpdateDataSource Source #
Instance details Defined in Amazonka.Kendra.UpdateDataSource Associated Types type Rep UpdateDataSource :: Type -> Type # Methods from :: UpdateDataSource -> Rep UpdateDataSource x # to :: Rep UpdateDataSource x -> UpdateDataSource #
Read UpdateDataSource Source #
Instance details Defined in Amazonka.Kendra.UpdateDataSource Methods readsPrec :: Int -> ReadS UpdateDataSource # readList :: ReadS [UpdateDataSource] # readPrec :: ReadPrec UpdateDataSource # readListPrec :: ReadPrec [UpdateDataSource] #
Show UpdateDataSource Source #
Instance details Defined in Amazonka.Kendra.UpdateDataSource Methods showsPrec :: Int -> UpdateDataSource -> ShowS # show :: UpdateDataSource -> String # showList :: [UpdateDataSource] -> ShowS #
NFData UpdateDataSource Source #
Instance details Defined in Amazonka.Kendra.UpdateDataSource Methods rnf :: UpdateDataSource -> () #
Eq UpdateDataSource Source #
Instance details Defined in Amazonka.Kendra.UpdateDataSource Methods (==) :: UpdateDataSource -> UpdateDataSource -> Bool # (/=) :: UpdateDataSource -> UpdateDataSource -> Bool #
Hashable UpdateDataSource Source #
Instance details Defined in Amazonka.Kendra.UpdateDataSource Methods hashWithSalt :: Int -> UpdateDataSource -> Int # hash :: UpdateDataSource -> Int #
type AWSResponse UpdateDataSource Source #
Instance details Defined in Amazonka.Kendra.UpdateDataSource type AWSResponse UpdateDataSource = UpdateDataSourceResponse
type Rep UpdateDataSource Source #
Instance details Defined in Amazonka.Kendra.UpdateDataSource type Rep UpdateDataSource = D1 ('MetaData "UpdateDataSource" "Amazonka.Kendra.UpdateDataSource" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'False) (C1 ('MetaCons "UpdateDataSource'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "configuration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe DataSourceConfiguration)) :: S1 ('MetaSel ('Just "customDocumentEnrichmentConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe CustomDocumentEnrichmentConfiguration))) :: (S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "languageCode") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))) :: ((S1 ('MetaSel ('Just "roleArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "schedule") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "vpcConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe DataSourceVpcConfiguration)) :: (S1 ('MetaSel ('Just "id") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "indexId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))))

newUpdateDataSource Source #

Arguments

:: Text	`UpdateDataSource`
-> Text	`$sel:indexId:UpdateDataSource'`
-> UpdateDataSource

Create a value of UpdateDataSource 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:configuration:UpdateDataSource', updateDataSource_configuration - Configuration information you want to update for the data source connector.

$sel:customDocumentEnrichmentConfiguration:UpdateDataSource', updateDataSource_customDocumentEnrichmentConfiguration - Configuration information you want to update for altering document metadata and content during the document ingestion process.

For more information on how to create, modify and delete document metadata, or make other content alterations when you ingest documents into Amazon Kendra, see Customizing document metadata during the ingestion process.

$sel:description:UpdateDataSource', updateDataSource_description - A new description for the data source connector.

UpdateDataSource, updateDataSource_languageCode - The code for a language you want to update for the data source connector. This allows you to support a language for all documents when updating the data source. English is supported by default. For more information on supported languages, including their codes, see Adding documents in languages other than English.

UpdateDataSource, updateDataSource_name - A new name for the data source connector.

UpdateDataSource, updateDataSource_roleArn - The Amazon Resource Name (ARN) of a role with permission to access the data source and required resources. For more information, see IAM roles for Amazon Kendra.

$sel:schedule:UpdateDataSource', updateDataSource_schedule - The sync schedule you want to update for the data source connector.

UpdateDataSource, updateDataSource_vpcConfiguration - Configuration information for an Amazon Virtual Private Cloud to connect to your data source. For more information, see Configuring a VPC.

UpdateDataSource, updateDataSource_id - The identifier of the data source connector you want to update.

$sel:indexId:UpdateDataSource', updateDataSource_indexId - The identifier of the index used with the data source connector.

Request Lenses

updateDataSource_configuration :: Lens' UpdateDataSource (Maybe DataSourceConfiguration) Source #

Configuration information you want to update for the data source connector.

updateDataSource_customDocumentEnrichmentConfiguration :: Lens' UpdateDataSource (Maybe CustomDocumentEnrichmentConfiguration) Source #

Configuration information you want to update for altering document metadata and content during the document ingestion process.

For more information on how to create, modify and delete document metadata, or make other content alterations when you ingest documents into Amazon Kendra, see Customizing document metadata during the ingestion process.

updateDataSource_description :: Lens' UpdateDataSource (Maybe Text) Source #

A new description for the data source connector.

updateDataSource_languageCode :: Lens' UpdateDataSource (Maybe Text) Source #

The code for a language you want to update for the data source connector. This allows you to support a language for all documents when updating the data source. English is supported by default. For more information on supported languages, including their codes, see Adding documents in languages other than English.

updateDataSource_name :: Lens' UpdateDataSource (Maybe Text) Source #

A new name for the data source connector.

updateDataSource_roleArn :: Lens' UpdateDataSource (Maybe Text) Source #

The Amazon Resource Name (ARN) of a role with permission to access the data source and required resources. For more information, see IAM roles for Amazon Kendra.

updateDataSource_schedule :: Lens' UpdateDataSource (Maybe Text) Source #

The sync schedule you want to update for the data source connector.

updateDataSource_vpcConfiguration :: Lens' UpdateDataSource (Maybe DataSourceVpcConfiguration) Source #

Configuration information for an Amazon Virtual Private Cloud to connect to your data source. For more information, see Configuring a VPC.

updateDataSource_id :: Lens' UpdateDataSource Text Source #

The identifier of the data source connector you want to update.

updateDataSource_indexId :: Lens' UpdateDataSource Text Source #

The identifier of the index used with the data source connector.

Destructuring the Response

data UpdateDataSourceResponse Source #

See: newUpdateDataSourceResponse smart constructor.

Constructors

UpdateDataSourceResponse'

Instances

Instances details

Generic UpdateDataSourceResponse Source #
Instance details Defined in Amazonka.Kendra.UpdateDataSource Associated Types type Rep UpdateDataSourceResponse :: Type -> Type # Methods from :: UpdateDataSourceResponse -> Rep UpdateDataSourceResponse x # to :: Rep UpdateDataSourceResponse x -> UpdateDataSourceResponse #
Read UpdateDataSourceResponse Source #
Instance details Defined in Amazonka.Kendra.UpdateDataSource Methods readsPrec :: Int -> ReadS UpdateDataSourceResponse # readList :: ReadS [UpdateDataSourceResponse] # readPrec :: ReadPrec UpdateDataSourceResponse # readListPrec :: ReadPrec [UpdateDataSourceResponse] #
Show UpdateDataSourceResponse Source #
Instance details Defined in Amazonka.Kendra.UpdateDataSource Methods showsPrec :: Int -> UpdateDataSourceResponse -> ShowS # show :: UpdateDataSourceResponse -> String # showList :: [UpdateDataSourceResponse] -> ShowS #
NFData UpdateDataSourceResponse Source #
Instance details Defined in Amazonka.Kendra.UpdateDataSource Methods rnf :: UpdateDataSourceResponse -> () #
Eq UpdateDataSourceResponse Source #
Instance details Defined in Amazonka.Kendra.UpdateDataSource Methods (==) :: UpdateDataSourceResponse -> UpdateDataSourceResponse -> Bool # (/=) :: UpdateDataSourceResponse -> UpdateDataSourceResponse -> Bool #
type Rep UpdateDataSourceResponse Source #
Instance details Defined in Amazonka.Kendra.UpdateDataSource type Rep UpdateDataSourceResponse = D1 ('MetaData "UpdateDataSourceResponse" "Amazonka.Kendra.UpdateDataSource" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'False) (C1 ('MetaCons "UpdateDataSourceResponse'" 'PrefixI 'False) (U1 :: Type -> Type))

newUpdateDataSourceResponse :: UpdateDataSourceResponse Source #

Create a value of UpdateDataSourceResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.