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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Creates a data source connector that you want to use with an Amazon Kendra index.

You specify a name, data source connector type and description for your data source. You also specify configuration information for the data source connector.

CreateDataSource is a synchronous operation. The operation returns 200 if the data source was successfully created. Otherwise, an exception is raised.

Amazon S3 and custom data sources are the only supported data sources in the Amazon Web Services GovCloud (US-West) region.

For an example of creating an index and data source using the Python SDK, see Getting started with Python SDK. For an example of creating an index and data source using the Java SDK, see Getting started with Java SDK.

Synopsis

data CreateDataSource = CreateDataSource' {
- clientToken :: Maybe Text
- configuration :: Maybe DataSourceConfiguration
- customDocumentEnrichmentConfiguration :: Maybe CustomDocumentEnrichmentConfiguration
- description :: Maybe Text
- languageCode :: Maybe Text
- roleArn :: Maybe Text
- schedule :: Maybe Text
- tags :: Maybe [Tag]
- vpcConfiguration :: Maybe DataSourceVpcConfiguration
- name :: Text
- indexId :: Text
- type' :: DataSourceType
}
newCreateDataSource :: Text -> Text -> DataSourceType -> CreateDataSource
createDataSource_clientToken :: Lens' CreateDataSource (Maybe Text)
createDataSource_configuration :: Lens' CreateDataSource (Maybe DataSourceConfiguration)
createDataSource_customDocumentEnrichmentConfiguration :: Lens' CreateDataSource (Maybe CustomDocumentEnrichmentConfiguration)
createDataSource_description :: Lens' CreateDataSource (Maybe Text)
createDataSource_languageCode :: Lens' CreateDataSource (Maybe Text)
createDataSource_roleArn :: Lens' CreateDataSource (Maybe Text)
createDataSource_schedule :: Lens' CreateDataSource (Maybe Text)
createDataSource_tags :: Lens' CreateDataSource (Maybe [Tag])
createDataSource_vpcConfiguration :: Lens' CreateDataSource (Maybe DataSourceVpcConfiguration)
createDataSource_name :: Lens' CreateDataSource Text
createDataSource_indexId :: Lens' CreateDataSource Text
createDataSource_type :: Lens' CreateDataSource DataSourceType
data CreateDataSourceResponse = CreateDataSourceResponse' {
- httpStatus :: Int
- id :: Text
}
newCreateDataSourceResponse :: Int -> Text -> CreateDataSourceResponse
createDataSourceResponse_httpStatus :: Lens' CreateDataSourceResponse Int
createDataSourceResponse_id :: Lens' CreateDataSourceResponse Text

Creating a Request

data CreateDataSource Source #

See: newCreateDataSource smart constructor.

Constructors

CreateDataSource'

Fields

clientToken :: Maybe Text
A token that you provide to identify the request to create a data source connector. Multiple calls to the CreateDataSource API with the same client token will create only one data source connector.
configuration :: Maybe DataSourceConfiguration
Configuration information to connect to your data source repository.
You can't specify the Configuration parameter when the Type parameter is set to CUSTOM. If you do, you receive a ValidationException exception.
The Configuration parameter is required for all other data sources.
customDocumentEnrichmentConfiguration :: Maybe CustomDocumentEnrichmentConfiguration
Configuration information 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 description for the data source connector.
languageCode :: Maybe Text
The code for a language. This allows you to support a language for all documents when creating the data source connector. English is supported by default. For more information on supported languages, including their codes, see Adding documents in languages other than English.
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.
You can't specify the RoleArn parameter when the Type parameter is set to CUSTOM. If you do, you receive a ValidationException exception.
The RoleArn parameter is required for all other data sources.
schedule :: Maybe Text
Sets the frequency for Amazon Kendra to check the documents in your data source repository and update the index. If you don't set a schedule Amazon Kendra will not periodically update the index. You can call the StartDataSourceSyncJob API to update the index.
You can't specify the Schedule parameter when the Type parameter is set to CUSTOM. If you do, you receive a ValidationException exception.
tags :: Maybe [Tag]
A list of key-value pairs that identify the data source connector. You can use the tags to identify and organize your resources and to control access to resources.
vpcConfiguration :: Maybe DataSourceVpcConfiguration
Configuration information for an Amazon Virtual Private Cloud to connect to your data source. For more information, see Configuring a VPC.
name :: Text
A name for the data source connector.
indexId :: Text
The identifier of the index you want to use with the data source connector.
type' :: DataSourceType
The type of data source repository. For example, SHAREPOINT.

Instances

Instances details

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

newCreateDataSource Source #

Arguments

:: Text	`CreateDataSource`
-> Text	`$sel:indexId:CreateDataSource'`
-> DataSourceType	`CreateDataSource`
-> CreateDataSource

Create a value of CreateDataSource 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:clientToken:CreateDataSource', createDataSource_clientToken - A token that you provide to identify the request to create a data source connector. Multiple calls to the CreateDataSource API with the same client token will create only one data source connector.

$sel:configuration:CreateDataSource', createDataSource_configuration - Configuration information to connect to your data source repository.

You can't specify the Configuration parameter when the Type parameter is set to CUSTOM. If you do, you receive a ValidationException exception.

The Configuration parameter is required for all other data sources.

$sel:customDocumentEnrichmentConfiguration:CreateDataSource', createDataSource_customDocumentEnrichmentConfiguration - Configuration information 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:CreateDataSource', createDataSource_description - A description for the data source connector.

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

CreateDataSource, createDataSource_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.

You can't specify the RoleArn parameter when the Type parameter is set to CUSTOM. If you do, you receive a ValidationException exception.

The RoleArn parameter is required for all other data sources.

$sel:schedule:CreateDataSource', createDataSource_schedule - Sets the frequency for Amazon Kendra to check the documents in your data source repository and update the index. If you don't set a schedule Amazon Kendra will not periodically update the index. You can call the StartDataSourceSyncJob API to update the index.

You can't specify the Schedule parameter when the Type parameter is set to CUSTOM. If you do, you receive a ValidationException exception.

$sel:tags:CreateDataSource', createDataSource_tags - A list of key-value pairs that identify the data source connector. You can use the tags to identify and organize your resources and to control access to resources.

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

CreateDataSource, createDataSource_name - A name for the data source connector.

$sel:indexId:CreateDataSource', createDataSource_indexId - The identifier of the index you want to use with the data source connector.

CreateDataSource, createDataSource_type - The type of data source repository. For example, SHAREPOINT.

Request Lenses

createDataSource_clientToken :: Lens' CreateDataSource (Maybe Text) Source #

A token that you provide to identify the request to create a data source connector. Multiple calls to the CreateDataSource API with the same client token will create only one data source connector.

createDataSource_configuration :: Lens' CreateDataSource (Maybe DataSourceConfiguration) Source #

Configuration information to connect to your data source repository.

You can't specify the Configuration parameter when the Type parameter is set to CUSTOM. If you do, you receive a ValidationException exception.

The Configuration parameter is required for all other data sources.

createDataSource_customDocumentEnrichmentConfiguration :: Lens' CreateDataSource (Maybe CustomDocumentEnrichmentConfiguration) Source #

Configuration information 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.

createDataSource_description :: Lens' CreateDataSource (Maybe Text) Source #

A description for the data source connector.

createDataSource_languageCode :: Lens' CreateDataSource (Maybe Text) Source #

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

createDataSource_roleArn :: Lens' CreateDataSource (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.

You can't specify the RoleArn parameter when the Type parameter is set to CUSTOM. If you do, you receive a ValidationException exception.

The RoleArn parameter is required for all other data sources.

createDataSource_schedule :: Lens' CreateDataSource (Maybe Text) Source #

Sets the frequency for Amazon Kendra to check the documents in your data source repository and update the index. If you don't set a schedule Amazon Kendra will not periodically update the index. You can call the StartDataSourceSyncJob API to update the index.

You can't specify the Schedule parameter when the Type parameter is set to CUSTOM. If you do, you receive a ValidationException exception.

createDataSource_tags :: Lens' CreateDataSource (Maybe [Tag]) Source #

A list of key-value pairs that identify the data source connector. You can use the tags to identify and organize your resources and to control access to resources.

createDataSource_vpcConfiguration :: Lens' CreateDataSource (Maybe DataSourceVpcConfiguration) Source #

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

createDataSource_name :: Lens' CreateDataSource Text Source #

A name for the data source connector.

createDataSource_indexId :: Lens' CreateDataSource Text Source #

The identifier of the index you want to use with the data source connector.

createDataSource_type :: Lens' CreateDataSource DataSourceType Source #

The type of data source repository. For example, SHAREPOINT.

Destructuring the Response

data CreateDataSourceResponse Source #

See: newCreateDataSourceResponse smart constructor.

Constructors

CreateDataSourceResponse'
Fields httpStatus :: Int The response's http status code. id :: Text The identifier of the data source connector.

Instances

Instances details

Generic CreateDataSourceResponse Source #
Instance details Defined in Amazonka.Kendra.CreateDataSource Associated Types type Rep CreateDataSourceResponse :: Type -> Type # Methods from :: CreateDataSourceResponse -> Rep CreateDataSourceResponse x # to :: Rep CreateDataSourceResponse x -> CreateDataSourceResponse #
Read CreateDataSourceResponse Source #
Instance details Defined in Amazonka.Kendra.CreateDataSource Methods readsPrec :: Int -> ReadS CreateDataSourceResponse # readList :: ReadS [CreateDataSourceResponse] # readPrec :: ReadPrec CreateDataSourceResponse # readListPrec :: ReadPrec [CreateDataSourceResponse] #
Show CreateDataSourceResponse Source #
Instance details Defined in Amazonka.Kendra.CreateDataSource Methods showsPrec :: Int -> CreateDataSourceResponse -> ShowS # show :: CreateDataSourceResponse -> String # showList :: [CreateDataSourceResponse] -> ShowS #
NFData CreateDataSourceResponse Source #
Instance details Defined in Amazonka.Kendra.CreateDataSource Methods rnf :: CreateDataSourceResponse -> () #
Eq CreateDataSourceResponse Source #
Instance details Defined in Amazonka.Kendra.CreateDataSource Methods (==) :: CreateDataSourceResponse -> CreateDataSourceResponse -> Bool # (/=) :: CreateDataSourceResponse -> CreateDataSourceResponse -> Bool #
type Rep CreateDataSourceResponse Source #
Instance details Defined in Amazonka.Kendra.CreateDataSource type Rep CreateDataSourceResponse = D1 ('MetaData "CreateDataSourceResponse" "Amazonka.Kendra.CreateDataSource" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'False) (C1 ('MetaCons "CreateDataSourceResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int) :*: S1 ('MetaSel ('Just "id") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newCreateDataSourceResponse Source #

Arguments

:: Int	`$sel:httpStatus:CreateDataSourceResponse'`
-> Text	`CreateDataSourceResponse`
-> CreateDataSourceResponse

Create a value of CreateDataSourceResponse 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:httpStatus:CreateDataSourceResponse', createDataSourceResponse_httpStatus - The response's http status code.

CreateDataSourceResponse, createDataSourceResponse_id - The identifier of the data source connector.

Response Lenses

createDataSourceResponse_httpStatus :: Lens' CreateDataSourceResponse Int Source #

The response's http status code.

createDataSourceResponse_id :: Lens' CreateDataSourceResponse Text Source #

The identifier of the data source connector.