kendra / Client / list_data_sources

list_data_sources#

kendra.Client.list_data_sources(**kwargs)#

Lists the data source connectors that you have created.

See also: AWS API Documentation

Request Syntax

response = client.list_data_sources(
    IndexId='string',
    NextToken='string',
    MaxResults=123
)
Parameters:

  • IndexId (string) –

    [REQUIRED]

    The identifier of the index used with one or more data source connectors.

  • NextToken (string) – If the previous response was incomplete (because there is more data to retrieve), Amazon Kendra returns a pagination token in the response. You can use this pagination token to retrieve the next set of data source connectors.

  • MaxResults (integer) – The maximum number of data source connectors to return.

Return type:

dict

Returns:

Response Syntax

{
    'SummaryItems': [
        {
            'Name': 'string',
            'Id': 'string',
            'Type': 'S3'|'SHAREPOINT'|'DATABASE'|'SALESFORCE'|'ONEDRIVE'|'SERVICENOW'|'CUSTOM'|'CONFLUENCE'|'GOOGLEDRIVE'|'WEBCRAWLER'|'WORKDOCS'|'FSX'|'SLACK'|'BOX'|'QUIP'|'JIRA'|'GITHUB'|'ALFRESCO'|'TEMPLATE',
            'CreatedAt': datetime(2015, 1, 1),
            'UpdatedAt': datetime(2015, 1, 1),
            'Status': 'CREATING'|'DELETING'|'FAILED'|'UPDATING'|'ACTIVE',
            'LanguageCode': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) –

    • SummaryItems (list) –

      An array of summary information for one or more data source connector.

      • (dict) –

        Summary information for a Amazon Kendra data source.

        • Name (string) –

          The name of the data source.

        • Id (string) –

          The identifier for the data source.

        • Type (string) –

          The type of the data source.

        • CreatedAt (datetime) –

          The Unix timestamp when the data source connector was created.

        • UpdatedAt (datetime) –

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

        • Status (string) –

          The status of the data source. When the status is ACTIVE the data source is ready to use.

        • LanguageCode (string) –

          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.

    • NextToken (string) –

      If the response is truncated, Amazon Kendra returns this token that you can use in the subsequent request to retrieve the next set of data source connectors.

Exceptions

  • kendra.Client.exceptions.ValidationException

  • kendra.Client.exceptions.ResourceNotFoundException

  • kendra.Client.exceptions.AccessDeniedException

  • kendra.Client.exceptions.ThrottlingException

  • kendra.Client.exceptions.InternalServerException