Module Values.GetDataSourceResponseSource

Gets information about an existing Amazon Q Business data source connector.

Sourcetype nonrec t = {
  1. applicationId : ApplicationId.t option;
    (*

    The identifier of the Amazon Q Business application.

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

    The identifier of the index linked to the data source connector.

    *)
  3. dataSourceId : DataSourceId.t option;
    (*

    The identifier of the data source connector.

    *)
  4. dataSourceArn : DataSourceArn.t option;
    (*

    The Amazon Resource Name (ARN) of the data source.

    *)
  5. displayName : DataSourceName.t option;
    (*

    The name for the data source connector.

    *)
  6. type_ : String_.t option;
    (*

    The type of the data source connector. For example, S3.

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

    The details of how the data source connector is configured.

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

    Configuration information for an Amazon VPC (Virtual Private Cloud) to connect to your data source.

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

    The Unix timestamp when the data source connector was created.

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

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

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

    The description for the data source connector.

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

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

    *)
  13. syncSchedule : SyncSchedule.t option;
    (*

    The schedule for Amazon Q Business to update the index.

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

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

    *)
  15. error : ErrorDetail.t option;
    (*

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

    *)
  16. documentEnrichmentConfiguration : DocumentEnrichmentConfiguration.t option;
  17. mediaExtractionConfiguration : MediaExtractionConfiguration.t option;
    (*

    The configuration for extracting information from media in documents for the data source.

    *)
}
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 : ?applicationId:??? -> ?indexId:??? -> ?dataSourceId:??? -> ?dataSourceArn:??? -> ?displayName:??? -> ?type_:??? -> ?configuration:??? -> ?vpcConfiguration:??? -> ?createdAt:??? -> ?updatedAt:??? -> ?description:??? -> ?status:??? -> ?syncSchedule:??? -> ?roleArn:??? -> ?error:??? -> ?documentEnrichmentConfiguration:??? -> ?mediaExtractionConfiguration:??? -> 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 ApplicationId.t | `Structure of (string * [> `Enum of string | `List of [> `String of SubnetId.t | `Structure of (string * [> `Enum of string | `Structure of (string * [> `Enum of string | `String of DocumentAttributeKey.t | `Structure of (string * [> `List of [> `String of String_.t ] list | `Long of Long.t | `String of DocumentAttributeValueStringValueString.t | `Timestamp of Timestamp.t ]) list ]) list ]) list ] list | `String of ErrorMessage.t | `Structure of (string * [> `Enum of string | `String of LambdaArn.t | `Structure of (string * [> `Enum of string | `String of DocumentAttributeKey.t | `Structure of (string * [> `List of [> `String of String_.t ] list | `Long of Long.t | `String of DocumentAttributeValueStringValueString.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