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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Gets information about an Amazon Kendra data source connector.

Synopsis

data DescribeDataSource = DescribeDataSource' {
- id :: Text
- indexId :: Text
}
newDescribeDataSource :: Text -> Text -> DescribeDataSource
describeDataSource_id :: Lens' DescribeDataSource Text
describeDataSource_indexId :: Lens' DescribeDataSource Text
data DescribeDataSourceResponse = DescribeDataSourceResponse' {
- configuration :: Maybe DataSourceConfiguration
- createdAt :: Maybe POSIX
- customDocumentEnrichmentConfiguration :: Maybe CustomDocumentEnrichmentConfiguration
- description :: Maybe Text
- errorMessage :: Maybe Text
- id :: Maybe Text
- indexId :: Maybe Text
- languageCode :: Maybe Text
- name :: Maybe Text
- roleArn :: Maybe Text
- schedule :: Maybe Text
- status :: Maybe DataSourceStatus
- type' :: Maybe DataSourceType
- updatedAt :: Maybe POSIX
- vpcConfiguration :: Maybe DataSourceVpcConfiguration
- httpStatus :: Int
}
newDescribeDataSourceResponse :: Int -> DescribeDataSourceResponse
describeDataSourceResponse_configuration :: Lens' DescribeDataSourceResponse (Maybe DataSourceConfiguration)
describeDataSourceResponse_createdAt :: Lens' DescribeDataSourceResponse (Maybe UTCTime)
describeDataSourceResponse_customDocumentEnrichmentConfiguration :: Lens' DescribeDataSourceResponse (Maybe CustomDocumentEnrichmentConfiguration)
describeDataSourceResponse_description :: Lens' DescribeDataSourceResponse (Maybe Text)
describeDataSourceResponse_errorMessage :: Lens' DescribeDataSourceResponse (Maybe Text)
describeDataSourceResponse_id :: Lens' DescribeDataSourceResponse (Maybe Text)
describeDataSourceResponse_indexId :: Lens' DescribeDataSourceResponse (Maybe Text)
describeDataSourceResponse_languageCode :: Lens' DescribeDataSourceResponse (Maybe Text)
describeDataSourceResponse_name :: Lens' DescribeDataSourceResponse (Maybe Text)
describeDataSourceResponse_roleArn :: Lens' DescribeDataSourceResponse (Maybe Text)
describeDataSourceResponse_schedule :: Lens' DescribeDataSourceResponse (Maybe Text)
describeDataSourceResponse_status :: Lens' DescribeDataSourceResponse (Maybe DataSourceStatus)
describeDataSourceResponse_type :: Lens' DescribeDataSourceResponse (Maybe DataSourceType)
describeDataSourceResponse_updatedAt :: Lens' DescribeDataSourceResponse (Maybe UTCTime)
describeDataSourceResponse_vpcConfiguration :: Lens' DescribeDataSourceResponse (Maybe DataSourceVpcConfiguration)
describeDataSourceResponse_httpStatus :: Lens' DescribeDataSourceResponse Int

Creating a Request

data DescribeDataSource Source #

See: newDescribeDataSource smart constructor.

Constructors

DescribeDataSource'
Fields id :: Text The identifier of the data source connector. indexId :: Text The identifier of the index used with the data source connector.

Instances

Instances details

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

newDescribeDataSource Source #

Arguments

:: Text	`DescribeDataSource`
-> Text	`DescribeDataSource`
-> DescribeDataSource

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

DescribeDataSource, describeDataSource_id - The identifier of the data source connector.

DescribeDataSource, describeDataSource_indexId - The identifier of the index used with the data source connector.

Request Lenses

describeDataSource_id :: Lens' DescribeDataSource Text Source #

The identifier of the data source connector.

describeDataSource_indexId :: Lens' DescribeDataSource Text Source #

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

Destructuring the Response

data DescribeDataSourceResponse Source #

See: newDescribeDataSourceResponse smart constructor.

Constructors

DescribeDataSourceResponse'

Fields

configuration :: Maybe DataSourceConfiguration
Configuration details for the data source connector. This shows how the data source is configured. The configuration options for a data source depend on the data source provider.
createdAt :: Maybe POSIX
The Unix timestamp of when the data source connector was created.
customDocumentEnrichmentConfiguration :: Maybe CustomDocumentEnrichmentConfiguration
Configuration information for altering document metadata and content during the document ingestion process when you describe a data source.
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
The description for the data source connector.
errorMessage :: Maybe Text
When the Status field value is FAILED, the ErrorMessage field contains a description of the error that caused the data source to fail.
id :: Maybe Text
The identifier of the data source connector.
indexId :: Maybe Text
The identifier of the index used with the data source connector.
languageCode :: Maybe Text
The code for a language. This shows a supported language for all documents in 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
The name for the data source connector.
roleArn :: Maybe Text
The Amazon Resource Name (ARN) of the role with permission to access the data source and required resources.
schedule :: Maybe Text
The schedule for Amazon Kendra to update the index.
status :: Maybe DataSourceStatus
The current status of the data source connector. When the status is ACTIVE the data source is ready to use. When the status is FAILED, the ErrorMessage field contains the reason that the data source failed.
type' :: Maybe DataSourceType
The type of the data source. For example, SHAREPOINT.
updatedAt :: Maybe POSIX
The Unix timestamp of when the data source connector was last updated.
vpcConfiguration :: Maybe DataSourceVpcConfiguration
Configuration information for an Amazon Virtual Private Cloud to connect to your data source. For more information, see Configuring a VPC.
httpStatus :: Int
The response's http status code.

Instances

Instances details

Generic DescribeDataSourceResponse Source #
Instance details Defined in Amazonka.Kendra.DescribeDataSource Associated Types type Rep DescribeDataSourceResponse :: Type -> Type # Methods from :: DescribeDataSourceResponse -> Rep DescribeDataSourceResponse x # to :: Rep DescribeDataSourceResponse x -> DescribeDataSourceResponse #
Read DescribeDataSourceResponse Source #
Instance details Defined in Amazonka.Kendra.DescribeDataSource Methods readsPrec :: Int -> ReadS DescribeDataSourceResponse # readList :: ReadS [DescribeDataSourceResponse] # readPrec :: ReadPrec DescribeDataSourceResponse # readListPrec :: ReadPrec [DescribeDataSourceResponse] #
Show DescribeDataSourceResponse Source #
Instance details Defined in Amazonka.Kendra.DescribeDataSource Methods showsPrec :: Int -> DescribeDataSourceResponse -> ShowS # show :: DescribeDataSourceResponse -> String # showList :: [DescribeDataSourceResponse] -> ShowS #
NFData DescribeDataSourceResponse Source #
Instance details Defined in Amazonka.Kendra.DescribeDataSource Methods rnf :: DescribeDataSourceResponse -> () #
Eq DescribeDataSourceResponse Source #
Instance details Defined in Amazonka.Kendra.DescribeDataSource Methods (==) :: DescribeDataSourceResponse -> DescribeDataSourceResponse -> Bool # (/=) :: DescribeDataSourceResponse -> DescribeDataSourceResponse -> Bool #
type Rep DescribeDataSourceResponse Source #
Instance details Defined in Amazonka.Kendra.DescribeDataSource type Rep DescribeDataSourceResponse = D1 ('MetaData "DescribeDataSourceResponse" "Amazonka.Kendra.DescribeDataSource" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'False) (C1 ('MetaCons "DescribeDataSourceResponse'" 'PrefixI 'True) ((((S1 ('MetaSel ('Just "configuration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe DataSourceConfiguration)) :: S1 ('MetaSel ('Just "createdAt") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX))) :: (S1 ('MetaSel ('Just "customDocumentEnrichmentConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe CustomDocumentEnrichmentConfiguration)) :: S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :: ((S1 ('MetaSel ('Just "errorMessage") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "id") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "indexId") '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 "status") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe DataSourceStatus)))) :: ((S1 ('MetaSel ('Just "type'") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe DataSourceType)) :: S1 ('MetaSel ('Just "updatedAt") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX))) :: (S1 ('MetaSel ('Just "vpcConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe DataSourceVpcConfiguration)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))))

newDescribeDataSourceResponse Source #

Arguments

:: Int	`$sel:httpStatus:DescribeDataSourceResponse'`
-> DescribeDataSourceResponse

Create a value of DescribeDataSourceResponse 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:DescribeDataSourceResponse', describeDataSourceResponse_configuration - Configuration details for the data source connector. This shows how the data source is configured. The configuration options for a data source depend on the data source provider.

DescribeDataSourceResponse, describeDataSourceResponse_createdAt - The Unix timestamp of when the data source connector was created.

$sel:customDocumentEnrichmentConfiguration:DescribeDataSourceResponse', describeDataSourceResponse_customDocumentEnrichmentConfiguration - Configuration information for altering document metadata and content during the document ingestion process when you describe a data source.

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:DescribeDataSourceResponse', describeDataSourceResponse_description - The description for the data source connector.

DescribeDataSourceResponse, describeDataSourceResponse_errorMessage - When the Status field value is FAILED, the ErrorMessage field contains a description of the error that caused the data source to fail.

DescribeDataSource, describeDataSourceResponse_id - The identifier of the data source connector.

DescribeDataSource, describeDataSourceResponse_indexId - The identifier of the index used with the data source connector.

DescribeDataSourceResponse, describeDataSourceResponse_languageCode - The code for a language. This shows a supported language for all documents in 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.

DescribeDataSourceResponse, describeDataSourceResponse_name - The name for the data source connector.

DescribeDataSourceResponse, describeDataSourceResponse_roleArn - The Amazon Resource Name (ARN) of the role with permission to access the data source and required resources.

$sel:schedule:DescribeDataSourceResponse', describeDataSourceResponse_schedule - The schedule for Amazon Kendra to update the index.

DescribeDataSourceResponse, describeDataSourceResponse_status - The current status of the data source connector. When the status is ACTIVE the data source is ready to use. When the status is FAILED, the ErrorMessage field contains the reason that the data source failed.

DescribeDataSourceResponse, describeDataSourceResponse_type - The type of the data source. For example, SHAREPOINT.

DescribeDataSourceResponse, describeDataSourceResponse_updatedAt - The Unix timestamp of when the data source connector was last updated.

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

$sel:httpStatus:DescribeDataSourceResponse', describeDataSourceResponse_httpStatus - The response's http status code.

Response Lenses

describeDataSourceResponse_configuration :: Lens' DescribeDataSourceResponse (Maybe DataSourceConfiguration) Source #

Configuration details for the data source connector. This shows how the data source is configured. The configuration options for a data source depend on the data source provider.

describeDataSourceResponse_createdAt :: Lens' DescribeDataSourceResponse (Maybe UTCTime) Source #

The Unix timestamp of when the data source connector was created.

describeDataSourceResponse_customDocumentEnrichmentConfiguration :: Lens' DescribeDataSourceResponse (Maybe CustomDocumentEnrichmentConfiguration) Source #

Configuration information for altering document metadata and content during the document ingestion process when you describe a data source.

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.

describeDataSourceResponse_description :: Lens' DescribeDataSourceResponse (Maybe Text) Source #

The description for the data source connector.

describeDataSourceResponse_errorMessage :: Lens' DescribeDataSourceResponse (Maybe Text) Source #

When the Status field value is FAILED, the ErrorMessage field contains a description of the error that caused the data source to fail.

describeDataSourceResponse_id :: Lens' DescribeDataSourceResponse (Maybe Text) Source #

The identifier of the data source connector.

describeDataSourceResponse_indexId :: Lens' DescribeDataSourceResponse (Maybe Text) Source #

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

describeDataSourceResponse_languageCode :: Lens' DescribeDataSourceResponse (Maybe Text) Source #

The code for a language. This shows a supported language for all documents in 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.

describeDataSourceResponse_name :: Lens' DescribeDataSourceResponse (Maybe Text) Source #

The name for the data source connector.

describeDataSourceResponse_roleArn :: Lens' DescribeDataSourceResponse (Maybe Text) Source #

The Amazon Resource Name (ARN) of the role with permission to access the data source and required resources.

describeDataSourceResponse_schedule :: Lens' DescribeDataSourceResponse (Maybe Text) Source #

The schedule for Amazon Kendra to update the index.

describeDataSourceResponse_status :: Lens' DescribeDataSourceResponse (Maybe DataSourceStatus) Source #

The current status of the data source connector. When the status is ACTIVE the data source is ready to use. When the status is FAILED, the ErrorMessage field contains the reason that the data source failed.

describeDataSourceResponse_type :: Lens' DescribeDataSourceResponse (Maybe DataSourceType) Source #

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

describeDataSourceResponse_updatedAt :: Lens' DescribeDataSourceResponse (Maybe UTCTime) Source #

The Unix timestamp of when the data source connector was last updated.

describeDataSourceResponse_vpcConfiguration :: Lens' DescribeDataSourceResponse (Maybe DataSourceVpcConfiguration) Source #

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

describeDataSourceResponse_httpStatus :: Lens' DescribeDataSourceResponse Int Source #

The response's http status code.