create_data_source ¶

def create_data_source(
    self,
    name: "capo_kendra.types.data_source_name.DataSourceName",
    index_id: "capo_kendra.types.index_id.IndexId",
    type: "capo_kendra.types.data_source_type.DataSourceType",
    *,
    config_overrides: Optional[kendraClientConfig] = None,
    configuration: Optional[
        "capo_kendra.types.data_source_configuration.DataSourceConfiguration"
    ] = None,
    vpc_configuration: Optional[
        "capo_kendra.types.data_source_vpc_configuration.DataSourceVpcConfiguration"
    ] = None,
    description: Optional["capo_kendra.types.description.Description"] = None,
    schedule: Optional["capo_kendra.types.scan_schedule.ScanSchedule"] = None,
    role_arn: Optional["capo_kendra.types.role_arn.RoleArn"] = None,
    tags: Optional["capo_kendra.types.tag_list.TagList"] = None,
    client_token: Optional[
        "capo_kendra.types.client_token_name.ClientTokenName"
    ] = None,
    language_code: Optional["capo_kendra.types.language_code.LanguageCode"] = None,
    custom_document_enrichment_configuration: Optional[
        "capo_kendra.types.custom_document_enrichment_configuration.CustomDocumentEnrichmentConfiguration"
    ] = None,
) -> "capo_kendra.types.create_data_source_response.CreateDataSourceResponse":
    """<p>Creates a data source connector that you want to use with an Amazon Kendra index.</p> <p>You specify a name, data source connector type and description for your data source. You also specify configuration information for the data source connector.</p> <p> <code>CreateDataSource</code> is a synchronous operation. The operation returns 200 if the data source was successfully created. Otherwise, an exception is raised.</p> <p>For an example of creating an index and data source using the Python SDK, see <a href="https://docs.aws.amazon.com/kendra/latest/dg/gs-python.html">Getting started with Python SDK</a>. For an example of creating an index and data source using the Java SDK, see <a href="https://docs.aws.amazon.com/kendra/latest/dg/gs-java.html">Getting started with Java SDK</a>.</p>

    Args:
        name: <p>A name for the data source connector.</p>
        index_id: <p>The identifier of the index you want to use with the data source connector.</p>
        type: <p>The type of data source repository. For example, <code>SHAREPOINT</code>.</p>
        configuration: <p>Configuration information to connect to your data source repository.</p> <p>You can't specify the <code>Configuration</code> parameter when the <code>Type</code> parameter is set to <code>CUSTOM</code>. If you do, you receive a <code>ValidationException</code> exception.</p> <p>The <code>Configuration</code> parameter is required for all other data sources.</p>
        vpc_configuration: <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: <p>A description for the data source connector.</p>
        schedule: <p>Sets the frequency for Amazon Kendra to check the documents in your data source repository and update the index. If you don't set a schedule Amazon Kendra will not periodically update the index. You can call the <code>StartDataSourceSyncJob</code> API to update the index.</p> <p>Specify a <code>cron-</code> format schedule string or an empty string to indicate that the index is updated on demand.</p> <p>You can't specify the <code>Schedule</code> parameter when the <code>Type</code> parameter is set to <code>CUSTOM</code>. If you do, you receive a <code>ValidationException</code> exception.</p>
        role_arn: <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 access roles for Amazon Kendra.</a>.</p> <p>You can't specify the <code>RoleArn</code> parameter when the <code>Type</code> parameter is set to <code>CUSTOM</code>. If you do, you receive a <code>ValidationException</code> exception.</p> <p>The <code>RoleArn</code> parameter is required for all other data sources.</p>
        tags: <p>A list of key-value pairs that identify or categorize the data source connector. You can also use tags to help control access to the data source connector. Tag keys and values can consist of Unicode letters, digits, white space, and any of the following symbols: _ . : / = + - @.</p>
        client_token: <p>A token that you provide to identify the request to create a data source connector. Multiple calls to the <code>CreateDataSource</code> API with the same client token will create only one data source connector.</p>
        language_code: <p>The code for a language. This allows you to support a language for all documents when creating the data source connector. 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: <p>Configuration information 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>

    Raises:
        capo_kendra.errors.access_denied_exception.AccessDeniedException: <p>You don't have sufficient access to perform this action. Please ensure you have the required permission policies and user accounts and try again.</p>
        capo_kendra.errors.conflict_exception.ConflictException: <p>A conflict occurred with the request. Please fix any inconsistences with your resources and try again.</p>
        capo_kendra.errors.internal_server_exception.InternalServerException: <p>An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes and try again, or contact <a href="http://aws.amazon.com/contact-us/">Support</a> for help.</p>
        capo_kendra.errors.resource_already_exist_exception.ResourceAlreadyExistException: <p>The resource you want to use already exists. Please check you have provided the correct resource and try again.</p>
        capo_kendra.errors.resource_not_found_exception.ResourceNotFoundException: <p>The resource you want to use doesn’t exist. Please check you have provided the correct resource and try again.</p>
        capo_kendra.errors.service_quota_exceeded_exception.ServiceQuotaExceededException: <p>You have exceeded the set limits for your Amazon Kendra service. Please see <a href="https://docs.aws.amazon.com/kendra/latest/dg/quotas.html">Quotas</a> for more information, or contact <a href="http://aws.amazon.com/contact-us/">Support</a> to inquire about an increase of limits.</p>
        capo_kendra.errors.throttling_exception.ThrottlingException: <p>The request was denied due to request throttling. Please reduce the number of requests and try again.</p>
        capo_kendra.errors.validation_exception.ValidationException: <p>The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct input and try again.</p>
        capo_kendra.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_kendra.types.create_data_source_request.CreateDataSourceRequest]",
    ) -> OperationResponse[
        "capo_kendra.types.create_data_source_response.CreateDataSourceResponse"
    ]:
        import capo_kendra._operations.aws_kendra_frontend_service.create_data_source

        output, http_response = (
            capo_kendra._operations.aws_kendra_frontend_service.create_data_source.create_data_source(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("CreateDataSource")
    )
    input_: capo_kendra.types.create_data_source_request.CreateDataSourceRequest = {
        "name": name,
        "index_id": index_id,
        "type": type,
    }
    if configuration is not None:
        input_["configuration"] = configuration
    if vpc_configuration is not None:
        input_["vpc_configuration"] = vpc_configuration
    if description is not None:
        input_["description"] = description
    if schedule is not None:
        input_["schedule"] = schedule
    if role_arn is not None:
        input_["role_arn"] = role_arn
    if tags is not None:
        input_["tags"] = tags
    if client_token is None:
        client_token = str(uuid.uuid4())
    input_["client_token"] = client_token
    if language_code is not None:
        input_["language_code"] = language_code
    if custom_document_enrichment_configuration is not None:
        input_["custom_document_enrichment_configuration"] = (
            custom_document_enrichment_configuration
        )

    response = execute_pipeline(
        OperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    response.response.close()
    return response.output