Skip to content

UpdateDataSourceRequest

Source code in docs_src/capo_kendra/types/update_data_source_request.py
class UpdateDataSourceRequest(TypedDict, closed=True):
    id: "capo_kendra.types.data_source_id.DataSourceId"
    """<p>The identifier of the data source connector you want to update.</p>"""
    name: NotRequired["capo_kendra.types.data_source_name.DataSourceName"]
    """<p>A new name for the data source connector.</p>"""
    index_id: "capo_kendra.types.index_id.IndexId"
    """<p>The identifier of the index used with the data source connector.</p>"""
    configuration: NotRequired[
        "capo_kendra.types.data_source_configuration.DataSourceConfiguration"
    ]
    """<p>Configuration information you want to update for the data source connector.</p>"""
    vpc_configuration: NotRequired[
        "capo_kendra.types.data_source_vpc_configuration.DataSourceVpcConfiguration"
    ]
    """<p>Configuration information for an Amazon Virtual Private Cloud to connect to your data source. For more information, see <a href="https://docs.aws.amazon.com/kendra/latest/dg/vpc-configuration.html">Configuring a VPC</a>.</p>"""
    description: NotRequired["capo_kendra.types.description.Description"]
    """<p>A new description for the data source connector.</p>"""
    schedule: NotRequired["capo_kendra.types.scan_schedule.ScanSchedule"]
    """<p>The sync schedule you want to update for the data source connector.</p>"""
    role_arn: NotRequired["capo_kendra.types.role_arn.RoleArn"]
    """<p>The Amazon Resource Name (ARN) of an IAM role with permission to access the data source and required resources. For more information, see <a href="https://docs.aws.amazon.com/kendra/latest/dg/iam-roles.html">IAM roles for Amazon Kendra</a>.</p>"""
    language_code: NotRequired["capo_kendra.types.language_code.LanguageCode"]
    """<p>The code for a language you want to update for the data source connector. This allows you to support a language for all documents when updating the data source. English is supported by default. For more information on supported languages, including their codes, see <a href="https://docs.aws.amazon.com/kendra/latest/dg/in-adding-languages.html">Adding documents in languages other than English</a>.</p>"""
    custom_document_enrichment_configuration: NotRequired[
        "capo_kendra.types.custom_document_enrichment_configuration.CustomDocumentEnrichmentConfiguration"
    ]
    """<p>Configuration information you want to update for altering document metadata and content during the document ingestion process.</p> <p>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 <a href="https://docs.aws.amazon.com/kendra/latest/dg/custom-document-enrichment.html">Customizing document metadata during the ingestion process</a>.</p>"""

configuration instance-attribute

configuration: NotRequired[DataSourceConfiguration]

Configuration information you want to update for the data source connector.

custom_document_enrichment_configuration instance-attribute

custom_document_enrichment_configuration: NotRequired[
    CustomDocumentEnrichmentConfiguration
]

Configuration information you want to update 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 instance-attribute

description: NotRequired[Description]

A new description for the data source connector.

id instance-attribute

The identifier of the data source connector you want to update.

index_id instance-attribute

index_id: IndexId

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

language_code instance-attribute

language_code: NotRequired[LanguageCode]

The code for a language you want to update for the data source connector. This allows you to support a language for all documents when updating 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 instance-attribute

name: NotRequired[DataSourceName]

A new name for the data source connector.

role_arn instance-attribute

role_arn: NotRequired[RoleArn]

The Amazon Resource Name (ARN) of an IAM role with permission to access the data source and required resources. For more information, see IAM roles for Amazon Kendra.

schedule instance-attribute

schedule: NotRequired[ScanSchedule]

The sync schedule you want to update for the data source connector.

vpc_configuration instance-attribute

vpc_configuration: NotRequired[DataSourceVpcConfiguration]

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