Module Values.DescribeDataSourceResponseSource

Gets information about an Amazon Kendra data source connector.

Sourcetype nonrec t = {
  1. id : DataSourceId.t option;
    (*

    The identifier of the data source connector.

    *)
  2. indexId : IndexId.t option;
    (*

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

    *)
  3. name : DataSourceName.t option;
    (*

    The name for the data source connector.

    *)
  4. type_ : DataSourceType.t option;
    (*

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

    *)
  5. configuration : DataSourceConfiguration.t option;
    (*

    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.

    *)
  6. vpcConfiguration : DataSourceVpcConfiguration.t option;
    (*

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

    *)
  7. createdAt : Timestamp.t option;
    (*

    The Unix timestamp when the data source connector was created.

    *)
  8. updatedAt : Timestamp.t option;
    (*

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

    *)
  9. description : Description.t option;
    (*

    The description for the data source connector.

    *)
  10. status : DataSourceStatus.t option;
    (*

    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.

    *)
  11. schedule : ScanSchedule.t option;
    (*

    The schedule for Amazon Kendra to update the index.

    *)
  12. roleArn : RoleArn.t option;
    (*

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

    *)
  13. errorMessage : ErrorMessage.t option;
    (*

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

    *)
  14. languageCode : LanguageCode.t option;
    (*

    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.

    *)
  15. customDocumentEnrichmentConfiguration : CustomDocumentEnrichmentConfiguration.t option;
    (*

    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.

    *)
}
Sourcetype nonrec error = [
  1. | `AccessDeniedException of AccessDeniedException.t
  2. | `InternalServerException of InternalServerException.t
  3. | `ResourceNotFoundException of ResourceNotFoundException.t
  4. | `ThrottlingException of ThrottlingException.t
  5. | `ValidationException of ValidationException.t
  6. | `Unknown_operation_error of string * string option
]
Sourceval make : ?id:??? -> ?indexId:??? -> ?name:??? -> ?type_:??? -> ?configuration:??? -> ?vpcConfiguration:??? -> ?createdAt:??? -> ?updatedAt:??? -> ?description:??? -> ?status:??? -> ?schedule:??? -> ?roleArn:??? -> ?errorMessage:??? -> ?languageCode:??? -> ?customDocumentEnrichmentConfiguration:??? -> unit -> t
Sourceval error_of_json : string -> Yojson.Safe.t -> [> `AccessDeniedException of AccessDeniedException.t | `InternalServerException of InternalServerException.t | `ResourceNotFoundException of ResourceNotFoundException.t | `ThrottlingException of ThrottlingException.t | `Unknown_operation_error of string * string option | `ValidationException of ValidationException.t ]
Sourceval error_of_xml : string -> Awso.Xml.t -> [> `AccessDeniedException of AccessDeniedException.t | `InternalServerException of InternalServerException.t | `ResourceNotFoundException of ResourceNotFoundException.t | `ThrottlingException of ThrottlingException.t | `Unknown_operation_error of string * string option | `ValidationException of ValidationException.t ]
Sourceval error_to_json : error -> Yojson.Safe.t
Sourceval to_value : t -> [> `Structure of (string * [> `Enum of string | `String of DataSourceId.t | `Structure of (string * [> `List of [> `String of SubnetId.t | `Structure of (string * [> `Boolean of Boolean.t | `Structure of (string * [> `Boolean of Boolean.t | `Enum of string | `String of DocumentAttributeKey.t | `Structure of (string * [> `List of [> `String of String_.t ] list | `Long of Long.t | `String of DocumentAttributeStringValue.t | `Timestamp of Timestamp.t ]) list ]) list ]) list ] list | `String of RoleArn.t | `Structure of (string * [> `Boolean of Boolean.t | `Enum of string | `Float of MaxContentSizePerPageInMegaBytes.t | `Integer of CrawlDepth.t | `List of [> `Enum of string | `String of DataSourceInclusionsExclusionsStringsMember.t | `Structure of (string * [> `Enum of string | `List of [> `Structure of (string * [> `String of DataSourceFieldName.t ]) list ] list | `String of DataSourceFieldName.t ]) list ] list | `String of S3BucketName.t | `Structure of (string * [> `Boolean of Boolean.t | `Enum of string | `Integer of Port.t | `List of [> `Enum of string | `String of SubnetId.t | `Structure of (string * [> `Enum of string | `Integer of Port.t | `List of [> `Structure of (string * [> `String of DataSourceFieldName.t ]) list ] list | `String of DataSourceFieldName.t ]) list ] list | `String of S3ObjectKey.t | `Structure of (string * [> `Enum of string | `List of [> `String of SeedUrl.t | `Structure of (string * [> `String of DataSourceFieldName.t ]) list ] list | `Long of Long.t | `String of DataSourceFieldName.t | `Timestamp of Timestamp.t ]) list ]) list ]) list ]) list | `Timestamp of Timestamp.t ]) list ]
Sourceval to_query : t -> Awso.Client.Query.t
Sourceval of_xml : Awso.Xml.t -> t
Sourceval of_string : string -> t
Sourceval of_json : Yojson.Safe.t -> t
Sourceval to_json : t -> Yojson.Safe.t