GetDataSourceResponse ¶

class GetDataSourceResponse(TypedDict, closed=True):
    application_id: NotRequired["capo_qbusiness.types.application_id.ApplicationId"]
    """<p>The identifier of the Amazon Q Business application.</p>"""
    index_id: NotRequired["capo_qbusiness.types.index_id.IndexId"]
    """<p>The identifier of the index linked to the data source connector.</p>"""
    data_source_id: NotRequired["capo_qbusiness.types.data_source_id.DataSourceId"]
    """<p>The identifier of the data source connector.</p>"""
    data_source_arn: NotRequired["capo_qbusiness.types.data_source_arn.DataSourceArn"]
    """<p>The Amazon Resource Name (ARN) of the data source.</p>"""
    display_name: NotRequired["capo_qbusiness.types.data_source_name.DataSourceName"]
    """<p>The name for the data source connector.</p>"""
    type: NotRequired["capo_qbusiness.types.string.String"]
    """<p>The type of the data source connector. For example, <code>S3</code>.</p>"""
    configuration: NotRequired[
        "capo_qbusiness.types.data_source_configuration.DataSourceConfiguration"
    ]
    """<p>The details of how the data source connector is configured.</p>"""
    vpc_configuration: NotRequired[
        "capo_qbusiness.types.data_source_vpc_configuration.DataSourceVpcConfiguration"
    ]
    """<p>Configuration information for an Amazon VPC (Virtual Private Cloud) to connect to your data source.</p>"""
    created_at: NotRequired["capo_qbusiness.types.timestamp.Timestamp"]
    """<p>The Unix timestamp when the data source connector was created.</p>"""
    updated_at: NotRequired["capo_qbusiness.types.timestamp.Timestamp"]
    """<p>The Unix timestamp when the data source connector was last updated.</p>"""
    description: NotRequired["capo_qbusiness.types.description.Description"]
    """<p>The description for the data source connector.</p>"""
    status: NotRequired["capo_qbusiness.types.data_source_status.DataSourceStatus"]
    """<p>The current status of the data source connector. When the <code>Status</code> field value is <code>FAILED</code>, the <code>ErrorMessage</code> field contains a description of the error that caused the data source connector to fail.</p>"""
    sync_schedule: NotRequired["capo_qbusiness.types.sync_schedule.SyncSchedule"]
    """<p>The schedule for Amazon Q Business to update the index.</p>"""
    role_arn: NotRequired["capo_qbusiness.types.role_arn.RoleArn"]
    """<p>The Amazon Resource Name (ARN) of the role with permission to access the data source and required resources.</p>"""
    error: NotRequired["capo_qbusiness.types.error_detail.ErrorDetail"]
    """<p>When the <code>Status</code> field value is <code>FAILED</code>, the <code>ErrorMessage</code> field contains a description of the error that caused the data source connector to fail.</p>"""
    document_enrichment_configuration: NotRequired[
        "capo_qbusiness.types.document_enrichment_configuration.DocumentEnrichmentConfiguration"
    ]
    media_extraction_configuration: NotRequired[
        "capo_qbusiness.types.media_extraction_configuration.MediaExtractionConfiguration"
    ]
    """<p>The configuration for extracting information from media in documents for the data source. </p>"""