kendra

Table of Contents

Client

class kendra.Client

A low-level client representing AWSKendraFrontendService:

client = session.create_client('kendra')

These are the available methods:

batch_delete_document(**kwargs)

Removes one or more documents from an index. The documents must have been added with the BatchPutDocument operation.

The documents are deleted asynchronously. You can see the progress of the deletion by using AWS CloudWatch. Any error messages releated to the processing of the batch are sent to you CloudWatch log.

See also: AWS API Documentation

Request Syntax

response = client.batch_delete_document(
    IndexId='string',
    DocumentIdList=[
        'string',
    ]
)
Parameters
  • IndexId (string) --

    [REQUIRED]

    The identifier of the index that contains the documents to delete.

  • DocumentIdList (list) --

    [REQUIRED]

    One or more identifiers for documents to delete from the index.

    • (string) --
Return type

dict

Returns

Response Syntax

{
    'FailedDocuments': [
        {
            'Id': 'string',
            'ErrorCode': 'InternalError'|'InvalidRequest',
            'ErrorMessage': 'string'
        },
    ]
}

Response Structure

  • (dict) --

    • FailedDocuments (list) --

      A list of documents that could not be removed from the index. Each entry contains an error message that indicates why the document couldn't be removed from the index.

      • (dict) --

        Provides information about documents that could not be removed from an index by the BatchDeleteDocument operation.

        • Id (string) --

          The identifier of the document that couldn't be removed from the index.

        • ErrorCode (string) --

          The error code for why the document couldn't be removed from the index.

        • ErrorMessage (string) --

          An explanation for why the document couldn't be removed from the index.

batch_put_document(**kwargs)

Adds one or more documents to an index.

The BatchPutDocument operation enables you to ingest inline documents or a set of documents stored in an Amazon S3 bucket. Use this operation to ingest your text and unstructured text into an index, add custom attributes to the documents, and to attach an access control list to the documents added to the index.

The documents are indexed asynchronously. You can see the progress of the batch using AWS CloudWatch. Any error messages related to processing the batch are sent to your AWS CloudWatch log.

See also: AWS API Documentation

Request Syntax

response = client.batch_put_document(
    IndexId='string',
    RoleArn='string',
    Documents=[
        {
            'Id': 'string',
            'Title': 'string',
            'Blob': b'bytes',
            'S3Path': {
                'Bucket': 'string',
                'Key': 'string'
            },
            'Attributes': [
                {
                    'Key': 'string',
                    'Value': {
                        'StringValue': 'string',
                        'StringListValue': [
                            'string',
                        ],
                        'LongValue': 123,
                        'DateValue': datetime(2015, 1, 1)
                    }
                },
            ],
            'AccessControlList': [
                {
                    'Name': 'string',
                    'Type': 'USER'|'GROUP',
                    'Access': 'ALLOW'|'DENY'
                },
            ],
            'ContentType': 'PDF'|'HTML'|'MS_WORD'|'PLAIN_TEXT'|'PPT'
        },
    ]
)
Parameters
  • IndexId (string) --

    [REQUIRED]

    The identifier of the index to add the documents to. You need to create the index first using the CreateIndex operation.

  • RoleArn (string) -- The Amazon Resource Name (ARN) of a role that is allowed to run the BatchPutDocument operation. For more information, see IAM Roles for Amazon Kendra .
  • Documents (list) --

    [REQUIRED]

    One or more documents to add to the index.

    Each document is limited to 5 Mb, the total size of the list is limited to 50 Mb.

    • (dict) --

      A document in an index.

      • Id (string) -- [REQUIRED]

        A unique identifier of the document in the index.

      • Title (string) --

        The title of the document.

      • Blob (bytes) --

        The contents of the document.

        Documents passed to the Blob parameter must be base64 encoded. Your code might not need to encode the document file bytes if you're using an AWS SDK to call Amazon Kendra operations. If you are calling the Amazon Kendra endpoint directly using REST, you must base64 encode the contents before sending.

      • S3Path (dict) --

        Information required to find a specific file in an Amazon S3 bucket.

        • Bucket (string) -- [REQUIRED]

          The name of the S3 bucket that contains the file.

        • Key (string) -- [REQUIRED]

          The name of the file.

      • Attributes (list) --

        Custom attributes to apply to the document. Use the custom attributes to provide additional information for searching, to provide facets for refining searches, and to provide additional information in the query response.

        • (dict) --

          A custom attribute value assigned to a document.

          • Key (string) -- [REQUIRED]

            The identifier for the attribute.

          • Value (dict) -- [REQUIRED]

            The value of the attribute.

            • StringValue (string) --

              A string, such as "department".

            • StringListValue (list) --

              A list of strings.

              • (string) --
            • LongValue (integer) --

              A long integer value.

            • DateValue (datetime) --

              A date value expressed as seconds from the Unix epoch.

      • AccessControlList (list) --

        Information to use for user context filtering.

        • (dict) --

          Provides user and group information for document access filtering.

          • Name (string) -- [REQUIRED]

            The name of the user or group.

          • Type (string) -- [REQUIRED]

            The type of principal.

          • Access (string) -- [REQUIRED]

            Whether to allow or deny access to the principal.

      • ContentType (string) --

        The file type of the document in the Blob field.

Return type

dict

Returns

Response Syntax

{
    'FailedDocuments': [
        {
            'Id': 'string',
            'ErrorCode': 'InternalError'|'InvalidRequest',
            'ErrorMessage': 'string'
        },
    ]
}

Response Structure

  • (dict) --

    • FailedDocuments (list) --

      A list of documents that were not added to the index because the document failed a validation check. Each document contains an error message that indicates why the document couldn't be added to the index.

      If there was an error adding a document to an index the error is reported in your AWS CloudWatch log.

      • (dict) --

        Provides information about a document that could not be indexed.

        • Id (string) --

          The unique identifier of the document.

        • ErrorCode (string) --

          The type of error that caused the document to fail to be indexed.

        • ErrorMessage (string) --

          A description of the reason why the document could not be indexed.

can_paginate(operation_name)

Check if an operation can be paginated.

Parameters
operation_name (string) -- The operation name. This is the same name as the method name on the client. For example, if the method name is create_foo, and you'd normally invoke the operation as client.create_foo(**kwargs), if the create_foo operation can be paginated, you can use the call client.get_paginator("create_foo").
Returns
True if the operation can be paginated, False otherwise.
create_data_source(**kwargs)

Creates a data source that you use to with an Amazon Kendra index.

You specify a name, connector type and description for your data source. You can choose between an S3 connector, a SharePoint Online connector, and a database connector.

You also specify configuration information such as document metadata (author, source URI, and so on) and user context information.

CreateDataSource is a synchronous operation. The operation returns 200 if the data source was successfully created. Otherwise, an exception is raised.

See also: AWS API Documentation

Request Syntax

response = client.create_data_source(
    Name='string',
    IndexId='string',
    Type='S3'|'SHAREPOINT'|'DATABASE',
    Configuration={
        'S3Configuration': {
            'BucketName': 'string',
            'InclusionPrefixes': [
                'string',
            ],
            'ExclusionPatterns': [
                'string',
            ],
            'DocumentsMetadataConfiguration': {
                'S3Prefix': 'string'
            },
            'AccessControlListConfiguration': {
                'KeyPath': 'string'
            }
        },
        'SharePointConfiguration': {
            'SharePointVersion': 'SHAREPOINT_ONLINE',
            'Urls': [
                'string',
            ],
            'SecretArn': 'string',
            'CrawlAttachments': True|False,
            'UseChangeLog': True|False,
            'InclusionPatterns': [
                'string',
            ],
            'ExclusionPatterns': [
                'string',
            ],
            'VpcConfiguration': {
                'SubnetIds': [
                    'string',
                ],
                'SecurityGroupIds': [
                    'string',
                ]
            },
            'FieldMappings': [
                {
                    'DataSourceFieldName': 'string',
                    'DateFieldFormat': 'string',
                    'IndexFieldName': 'string'
                },
            ],
            'DocumentTitleFieldName': 'string'
        },
        'DatabaseConfiguration': {
            'DatabaseEngineType': 'RDS_AURORA_MYSQL'|'RDS_AURORA_POSTGRESQL'|'RDS_MYSQL'|'RDS_POSTGRESQL',
            'ConnectionConfiguration': {
                'DatabaseHost': 'string',
                'DatabasePort': 123,
                'DatabaseName': 'string',
                'TableName': 'string',
                'SecretArn': 'string'
            },
            'VpcConfiguration': {
                'SubnetIds': [
                    'string',
                ],
                'SecurityGroupIds': [
                    'string',
                ]
            },
            'ColumnConfiguration': {
                'DocumentIdColumnName': 'string',
                'DocumentDataColumnName': 'string',
                'DocumentTitleColumnName': 'string',
                'FieldMappings': [
                    {
                        'DataSourceFieldName': 'string',
                        'DateFieldFormat': 'string',
                        'IndexFieldName': 'string'
                    },
                ],
                'ChangeDetectingColumns': [
                    'string',
                ]
            },
            'AclConfiguration': {
                'AllowedGroupsColumnName': 'string'
            }
        }
    },
    Description='string',
    Schedule='string',
    RoleArn='string'
)
Parameters
  • Name (string) --

    [REQUIRED]

    A unique name for the data source. A data source name can't be changed without deleting and recreating the data source.

  • IndexId (string) --

    [REQUIRED]

    The identifier of the index that should be associated with this data source.

  • Type (string) --

    [REQUIRED]

    The type of repository that contains the data source.

  • Configuration (dict) --

    [REQUIRED]

    The connector configuration information that is required to access the repository.

    • S3Configuration (dict) --

      Provides information to create a connector for a document repository in an Amazon S3 bucket.

      • BucketName (string) -- [REQUIRED]

        The name of the bucket that contains the documents.

      • InclusionPrefixes (list) --

        A list of S3 prefixes for the documents that should be included in the index.

        • (string) --
      • ExclusionPatterns (list) --

        A list of glob patterns for documents that should not be indexed. If a document that matches an inclusion prefix also matches an exclusion pattern, the document is not indexed.

        For more information about glob patterns, see glob (programming) in Wikipedia .

        • (string) --
      • DocumentsMetadataConfiguration (dict) --

        Document metadata files that contain information such as the document access control information, source URI, document author, and custom attributes. Each metadata file contains metadata about a single document.

        • S3Prefix (string) --

          A prefix used to filter metadata configuration files in the AWS S3 bucket. The S3 bucket might contain multiple metadata files. Use S3Prefix to include only the desired metadata files.

      • AccessControlListConfiguration (dict) --

        Provides the path to the S3 bucket that contains the user context filtering files for the data source.

        • KeyPath (string) --

          Path to the AWS S3 bucket that contains the ACL files.

    • SharePointConfiguration (dict) --

      Provides information necessary to create a connector for a Microsoft SharePoint site.

      • SharePointVersion (string) -- [REQUIRED]

        The version of Microsoft SharePoint that you are using as a data source.

      • Urls (list) -- [REQUIRED]

        The URLs of the Microsoft SharePoint site that contains the documents that should be indexed.

        • (string) --
      • SecretArn (string) -- [REQUIRED]

        The Amazon Resource Name (ARN) of credentials stored in AWS Secrets Manager. The credentials should be a user/password pair. For more information, see Using a Microsoft SharePoint Data Source . For more information about AWS Secrets Manager, see What Is AWS Secrets Manager in the AWS Secrets Manager user guide.

      • CrawlAttachments (boolean) --
        TRUE to include attachments to documents stored in your Microsoft SharePoint site in the index; otherwise, FALSE .
      • UseChangeLog (boolean) --

        Set to TRUE to use the Microsoft SharePoint change log to determine the documents that need to be updated in the index. Depending on the size of the SharePoint change log, it may take longer for Amazon Kendra to use the change log than it takes it to determine the changed documents using the Amazon Kendra document crawler.

      • InclusionPatterns (list) --

        A list of regular expression patterns. Documents that match the patterns are included in the index. Documents that don't match the patterns are excluded from the index. If a document matches both an inclusion pattern and an exclusion pattern, the document is not included in the index.

        The regex is applied to the display URL of the SharePoint document.

        • (string) --
      • ExclusionPatterns (list) --

        A list of regular expression patterns. Documents that match the patterns are excluded from the index. Documents that don't match the patterns are included in the index. If a document matches both an exclusion pattern and an inclusion pattern, the document is not included in the index.

        The regex is applied to the display URL of the SharePoint document.

        • (string) --
      • VpcConfiguration (dict) --

        Provides information for connecting to an Amazon VPC.

        • SubnetIds (list) -- [REQUIRED]

          A list of identifiers for subnets within your Amazon VPC. The subnets should be able to connect to each other in the VPC, and they should have outgoing access to the Internet through a NAT device.

          • (string) --
        • SecurityGroupIds (list) -- [REQUIRED]

          A list of identifiers of security groups within your Amazon VPC. The security groups should enable Amazon Kendra to connect to the data source.

          • (string) --
      • FieldMappings (list) --

        A list of DataSourceToIndexFieldMapping objects that map Microsoft SharePoint attributes to custom fields in the Amazon Kendra index. You must first create the index fields using the operation before you map SharePoint attributes. For more information, see Mapping Data Source Fields .

        • (dict) --

          Maps a column or attribute in the data source to an index field. You must first create the fields in the index using the UpdateIndex operation.

          • DataSourceFieldName (string) -- [REQUIRED]

            The name of the column or attribute in the data source.

          • DateFieldFormat (string) --

            The type of data stored in the column or attribute.

          • IndexFieldName (string) -- [REQUIRED]

            The name of the field in the index.

      • DocumentTitleFieldName (string) --

        The Microsoft SharePoint attribute field that contains the title of the document.

    • DatabaseConfiguration (dict) --

      Provides information necessary to create a connector for a database.

      • DatabaseEngineType (string) -- [REQUIRED]

        The type of database engine that runs the database.

      • ConnectionConfiguration (dict) -- [REQUIRED]

        The information necessary to connect to a database.

        • DatabaseHost (string) -- [REQUIRED]

          The name of the host for the database. Can be either a string (host.subdomain.domain.tld) or an IPv4 or IPv6 address.

        • DatabasePort (integer) -- [REQUIRED]

          The port that the database uses for connections.

        • DatabaseName (string) -- [REQUIRED]

          The name of the database containing the document data.

        • TableName (string) -- [REQUIRED]

          The name of the table that contains the document data.

        • SecretArn (string) -- [REQUIRED]

          The Amazon Resource Name (ARN) of credentials stored in AWS Secrets Manager. The credentials should be a user/password pair. For more information, see Using a Database Data Source . For more information about AWS Secrets Manager, see What Is AWS Secrets Manager in the AWS Secrets Manager user guide.

      • VpcConfiguration (dict) --

        Provides information for connecting to an Amazon VPC.

        • SubnetIds (list) -- [REQUIRED]

          A list of identifiers for subnets within your Amazon VPC. The subnets should be able to connect to each other in the VPC, and they should have outgoing access to the Internet through a NAT device.

          • (string) --
        • SecurityGroupIds (list) -- [REQUIRED]

          A list of identifiers of security groups within your Amazon VPC. The security groups should enable Amazon Kendra to connect to the data source.

          • (string) --
      • ColumnConfiguration (dict) -- [REQUIRED]

        Information about where the index should get the document information from the database.

        • DocumentIdColumnName (string) -- [REQUIRED]

          The column that provides the document's unique identifier.

        • DocumentDataColumnName (string) -- [REQUIRED]

          The column that contains the contents of the document.

        • DocumentTitleColumnName (string) --

          The column that contains the title of the document.

        • FieldMappings (list) --

          An array of objects that map database column names to the corresponding fields in an index. You must first create the fields in the index using the UpdateIndex operation.

          • (dict) --

            Maps a column or attribute in the data source to an index field. You must first create the fields in the index using the UpdateIndex operation.

            • DataSourceFieldName (string) -- [REQUIRED]

              The name of the column or attribute in the data source.

            • DateFieldFormat (string) --

              The type of data stored in the column or attribute.

            • IndexFieldName (string) -- [REQUIRED]

              The name of the field in the index.

        • ChangeDetectingColumns (list) -- [REQUIRED]

          One to five columns that indicate when a document in the database has changed.

          • (string) --
      • AclConfiguration (dict) --

        Information about the database column that provides information for user context filtering.

        • AllowedGroupsColumnName (string) -- [REQUIRED]

          A list of groups, separated by semi-colons, that filters a query response based on user context. The document is only returned to users that are in one of the groups specified in the UserContext field of the Query operation.

  • Description (string) -- A description for the data source.
  • Schedule (string) -- Sets the frequency that Amazon Kendra will check the documents in your repository and update the index. If you don't set a schedule Amazon Kendra will not periodically update the index. You can call the StartDataSourceSyncJob operation to update the index.
  • RoleArn (string) --

    [REQUIRED]

    The Amazon Resource Name (ARN) of a role with permission to access the data source. For more information, see IAM Roles for Amazon Kendra .

Return type

dict

Returns

Response Syntax

{
    'Id': 'string'
}

Response Structure

  • (dict) --

    • Id (string) --

      A unique identifier for the data source.

create_faq(**kwargs)

Creates an new set of frequently asked question (FAQ) questions and answers.

See also: AWS API Documentation

Request Syntax

response = client.create_faq(
    IndexId='string',
    Name='string',
    Description='string',
    S3Path={
        'Bucket': 'string',
        'Key': 'string'
    },
    RoleArn='string'
)
Parameters
  • IndexId (string) --

    [REQUIRED]

    The identifier of the index that contains the FAQ.

  • Name (string) --

    [REQUIRED]

    The name that should be associated with the FAQ.

  • Description (string) -- A description of the FAQ.
  • S3Path (dict) --

    [REQUIRED]

    The S3 location of the FAQ input data.

    • Bucket (string) -- [REQUIRED]

      The name of the S3 bucket that contains the file.

    • Key (string) -- [REQUIRED]

      The name of the file.

  • RoleArn (string) --

    [REQUIRED]

    The Amazon Resource Name (ARN) of a role with permission to access the S3 bucket that contains the FAQs. For more information, see IAM Roles for Amazon Kendra .

Return type

dict

Returns

Response Syntax

{
    'Id': 'string'
}

Response Structure

  • (dict) --

    • Id (string) --

      The unique identifier of the FAQ.

create_index(**kwargs)

Creates a new Amazon Kendra index. Index creation is an asynchronous operation. To determine if index creation has completed, check the Status field returned from a call to . The Status field is set to ACTIVE when the index is ready to use.

Once the index is active you can index your documents using the operation or using one of the supported data sources.

See also: AWS API Documentation

Request Syntax

response = client.create_index(
    Name='string',
    RoleArn='string',
    ServerSideEncryptionConfiguration={
        'KmsKeyId': 'string'
    },
    Description='string',
    ClientToken='string'
)
Parameters
  • Name (string) --

    [REQUIRED]

    The name for the new index.

  • RoleArn (string) --

    [REQUIRED]

    An IAM role that gives Amazon Kendra permissions to access your Amazon CloudWatch logs and metrics. This is also the role used when you use the BatchPutDocument operation to index documents from an Amazon S3 bucket.

  • ServerSideEncryptionConfiguration (dict) --

    The identifier of the AWS KMS customer managed key (CMK) to use to encrypt data indexed by Amazon Kendra. Amazon Kendra doesn't support asymmetric CMKs.

    • KmsKeyId (string) --

      The identifier of the AWS KMS customer master key (CMK). Amazon Kendra doesn't support asymmetric CMKs.

  • Description (string) -- A description for the index.
  • ClientToken (string) --

    A token that you provide to identify the request to create an index. Multiple calls to the CreateIndex operation with the same client token will create only one index.”

    This field is autopopulated if not provided.

Return type

dict

Returns

Response Syntax

{
    'Id': 'string'
}

Response Structure

  • (dict) --

    • Id (string) --

      The unique identifier of the index. Use this identifier when you query an index, set up a data source, or index a document.

delete_faq(**kwargs)

Removes an FAQ from an index.

See also: AWS API Documentation

Request Syntax

response = client.delete_faq(
    Id='string',
    IndexId='string'
)
Parameters
  • Id (string) --

    [REQUIRED]

    The identifier of the FAQ to remove.

  • IndexId (string) --

    [REQUIRED]

    The index to remove the FAQ from.

Returns

None

delete_index(**kwargs)

Deletes an existing Amazon Kendra index. An exception is not thrown if the index is already being deleted. While the index is being deleted, the Status field returned by a call to the DescribeIndex operation is set to DELETING .

See also: AWS API Documentation

Request Syntax

response = client.delete_index(
    Id='string'
)
Parameters
Id (string) --

[REQUIRED]

The identifier of the index to delete.

Returns
None
describe_data_source(**kwargs)

Gets information about a Amazon Kendra data source.

See also: AWS API Documentation

Request Syntax

response = client.describe_data_source(
    Id='string',
    IndexId='string'
)
Parameters
  • Id (string) --

    [REQUIRED]

    The unique identifier of the data source to describe.

  • IndexId (string) --

    [REQUIRED]

    The identifier of the index that contains the data source.

Return type

dict

Returns

Response Syntax

{
    'Id': 'string',
    'IndexId': 'string',
    'Name': 'string',
    'Type': 'S3'|'SHAREPOINT'|'DATABASE',
    'Configuration': {
        'S3Configuration': {
            'BucketName': 'string',
            'InclusionPrefixes': [
                'string',
            ],
            'ExclusionPatterns': [
                'string',
            ],
            'DocumentsMetadataConfiguration': {
                'S3Prefix': 'string'
            },
            'AccessControlListConfiguration': {
                'KeyPath': 'string'
            }
        },
        'SharePointConfiguration': {
            'SharePointVersion': 'SHAREPOINT_ONLINE',
            'Urls': [
                'string',
            ],
            'SecretArn': 'string',
            'CrawlAttachments': True|False,
            'UseChangeLog': True|False,
            'InclusionPatterns': [
                'string',
            ],
            'ExclusionPatterns': [
                'string',
            ],
            'VpcConfiguration': {
                'SubnetIds': [
                    'string',
                ],
                'SecurityGroupIds': [
                    'string',
                ]
            },
            'FieldMappings': [
                {
                    'DataSourceFieldName': 'string',
                    'DateFieldFormat': 'string',
                    'IndexFieldName': 'string'
                },
            ],
            'DocumentTitleFieldName': 'string'
        },
        'DatabaseConfiguration': {
            'DatabaseEngineType': 'RDS_AURORA_MYSQL'|'RDS_AURORA_POSTGRESQL'|'RDS_MYSQL'|'RDS_POSTGRESQL',
            'ConnectionConfiguration': {
                'DatabaseHost': 'string',
                'DatabasePort': 123,
                'DatabaseName': 'string',
                'TableName': 'string',
                'SecretArn': 'string'
            },
            'VpcConfiguration': {
                'SubnetIds': [
                    'string',
                ],
                'SecurityGroupIds': [
                    'string',
                ]
            },
            'ColumnConfiguration': {
                'DocumentIdColumnName': 'string',
                'DocumentDataColumnName': 'string',
                'DocumentTitleColumnName': 'string',
                'FieldMappings': [
                    {
                        'DataSourceFieldName': 'string',
                        'DateFieldFormat': 'string',
                        'IndexFieldName': 'string'
                    },
                ],
                'ChangeDetectingColumns': [
                    'string',
                ]
            },
            'AclConfiguration': {
                'AllowedGroupsColumnName': 'string'
            }
        }
    },
    'CreatedAt': datetime(2015, 1, 1),
    'UpdatedAt': datetime(2015, 1, 1),
    'Description': 'string',
    'Status': 'CREATING'|'DELETING'|'FAILED'|'UPDATING'|'ACTIVE',
    'Schedule': 'string',
    'RoleArn': 'string',
    'ErrorMessage': 'string'
}

Response Structure

  • (dict) --

    • Id (string) --

      The identifier of the data source.

    • IndexId (string) --

      The identifier of the index that contains the data source.

    • Name (string) --

      The name that you gave the data source when it was created.

    • Type (string) --

      The type of the data source.

    • Configuration (dict) --

      Information that describes where the data source is located and how the data source is configured. The specific information in the description depends on the data source provider.

      • S3Configuration (dict) --

        Provides information to create a connector for a document repository in an Amazon S3 bucket.

        • BucketName (string) --

          The name of the bucket that contains the documents.

        • InclusionPrefixes (list) --

          A list of S3 prefixes for the documents that should be included in the index.

          • (string) --
        • ExclusionPatterns (list) --

          A list of glob patterns for documents that should not be indexed. If a document that matches an inclusion prefix also matches an exclusion pattern, the document is not indexed.

          For more information about glob patterns, see glob (programming) in Wikipedia .

          • (string) --
        • DocumentsMetadataConfiguration (dict) --

          Document metadata files that contain information such as the document access control information, source URI, document author, and custom attributes. Each metadata file contains metadata about a single document.

          • S3Prefix (string) --

            A prefix used to filter metadata configuration files in the AWS S3 bucket. The S3 bucket might contain multiple metadata files. Use S3Prefix to include only the desired metadata files.

        • AccessControlListConfiguration (dict) --

          Provides the path to the S3 bucket that contains the user context filtering files for the data source.

          • KeyPath (string) --

            Path to the AWS S3 bucket that contains the ACL files.

      • SharePointConfiguration (dict) --

        Provides information necessary to create a connector for a Microsoft SharePoint site.

        • SharePointVersion (string) --

          The version of Microsoft SharePoint that you are using as a data source.

        • Urls (list) --

          The URLs of the Microsoft SharePoint site that contains the documents that should be indexed.

          • (string) --
        • SecretArn (string) --

          The Amazon Resource Name (ARN) of credentials stored in AWS Secrets Manager. The credentials should be a user/password pair. For more information, see Using a Microsoft SharePoint Data Source . For more information about AWS Secrets Manager, see What Is AWS Secrets Manager in the AWS Secrets Manager user guide.

        • CrawlAttachments (boolean) --

          TRUE to include attachments to documents stored in your Microsoft SharePoint site in the index; otherwise, FALSE .

        • UseChangeLog (boolean) --

          Set to TRUE to use the Microsoft SharePoint change log to determine the documents that need to be updated in the index. Depending on the size of the SharePoint change log, it may take longer for Amazon Kendra to use the change log than it takes it to determine the changed documents using the Amazon Kendra document crawler.

        • InclusionPatterns (list) --

          A list of regular expression patterns. Documents that match the patterns are included in the index. Documents that don't match the patterns are excluded from the index. If a document matches both an inclusion pattern and an exclusion pattern, the document is not included in the index.

          The regex is applied to the display URL of the SharePoint document.

          • (string) --
        • ExclusionPatterns (list) --

          A list of regular expression patterns. Documents that match the patterns are excluded from the index. Documents that don't match the patterns are included in the index. If a document matches both an exclusion pattern and an inclusion pattern, the document is not included in the index.

          The regex is applied to the display URL of the SharePoint document.

          • (string) --
        • VpcConfiguration (dict) --

          Provides information for connecting to an Amazon VPC.

          • SubnetIds (list) --

            A list of identifiers for subnets within your Amazon VPC. The subnets should be able to connect to each other in the VPC, and they should have outgoing access to the Internet through a NAT device.

            • (string) --
          • SecurityGroupIds (list) --

            A list of identifiers of security groups within your Amazon VPC. The security groups should enable Amazon Kendra to connect to the data source.

            • (string) --
        • FieldMappings (list) --

          A list of DataSourceToIndexFieldMapping objects that map Microsoft SharePoint attributes to custom fields in the Amazon Kendra index. You must first create the index fields using the operation before you map SharePoint attributes. For more information, see Mapping Data Source Fields .

          • (dict) --

            Maps a column or attribute in the data source to an index field. You must first create the fields in the index using the UpdateIndex operation.

            • DataSourceFieldName (string) --

              The name of the column or attribute in the data source.

            • DateFieldFormat (string) --

              The type of data stored in the column or attribute.

            • IndexFieldName (string) --

              The name of the field in the index.

        • DocumentTitleFieldName (string) --

          The Microsoft SharePoint attribute field that contains the title of the document.

      • DatabaseConfiguration (dict) --

        Provides information necessary to create a connector for a database.

        • DatabaseEngineType (string) --

          The type of database engine that runs the database.

        • ConnectionConfiguration (dict) --

          The information necessary to connect to a database.

          • DatabaseHost (string) --

            The name of the host for the database. Can be either a string (host.subdomain.domain.tld) or an IPv4 or IPv6 address.

          • DatabasePort (integer) --

            The port that the database uses for connections.

          • DatabaseName (string) --

            The name of the database containing the document data.

          • TableName (string) --

            The name of the table that contains the document data.

          • SecretArn (string) --

            The Amazon Resource Name (ARN) of credentials stored in AWS Secrets Manager. The credentials should be a user/password pair. For more information, see Using a Database Data Source . For more information about AWS Secrets Manager, see What Is AWS Secrets Manager in the AWS Secrets Manager user guide.

        • VpcConfiguration (dict) --

          Provides information for connecting to an Amazon VPC.

          • SubnetIds (list) --

            A list of identifiers for subnets within your Amazon VPC. The subnets should be able to connect to each other in the VPC, and they should have outgoing access to the Internet through a NAT device.

            • (string) --
          • SecurityGroupIds (list) --

            A list of identifiers of security groups within your Amazon VPC. The security groups should enable Amazon Kendra to connect to the data source.

            • (string) --
        • ColumnConfiguration (dict) --

          Information about where the index should get the document information from the database.

          • DocumentIdColumnName (string) --

            The column that provides the document's unique identifier.

          • DocumentDataColumnName (string) --

            The column that contains the contents of the document.

          • DocumentTitleColumnName (string) --

            The column that contains the title of the document.

          • FieldMappings (list) --

            An array of objects that map database column names to the corresponding fields in an index. You must first create the fields in the index using the UpdateIndex operation.

            • (dict) --

              Maps a column or attribute in the data source to an index field. You must first create the fields in the index using the UpdateIndex operation.

              • DataSourceFieldName (string) --

                The name of the column or attribute in the data source.

              • DateFieldFormat (string) --

                The type of data stored in the column or attribute.

              • IndexFieldName (string) --

                The name of the field in the index.

          • ChangeDetectingColumns (list) --

            One to five columns that indicate when a document in the database has changed.

            • (string) --
        • AclConfiguration (dict) --

          Information about the database column that provides information for user context filtering.

          • AllowedGroupsColumnName (string) --

            A list of groups, separated by semi-colons, that filters a query response based on user context. The document is only returned to users that are in one of the groups specified in the UserContext field of the Query operation.

    • CreatedAt (datetime) --

      The Unix timestamp of when the data source was created.

    • UpdatedAt (datetime) --

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

    • Description (string) --

      The description of the data source.

    • Status (string) --

      The current status of the data source. When the status is ACTIVE the data source is ready to use. When the status is FAILED , the ErrorMessage field contains the reason that the data source failed.

    • Schedule (string) --

      The schedule that Amazon Kendra will update the data source.

    • RoleArn (string) --

      The Amazon Resource Name (ARN) of the role that enables the data source to access its resources.

    • ErrorMessage (string) --

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

describe_faq(**kwargs)

Gets information about an FAQ list.

See also: AWS API Documentation

Request Syntax

response = client.describe_faq(
    Id='string',
    IndexId='string'
)
Parameters
  • Id (string) --

    [REQUIRED]

    The unique identifier of the FAQ.

  • IndexId (string) --

    [REQUIRED]

    The identifier of the index that contains the FAQ.

Return type

dict

Returns

Response Syntax

{
    'Id': 'string',
    'IndexId': 'string',
    'Name': 'string',
    'Description': 'string',
    'CreatedAt': datetime(2015, 1, 1),
    'UpdatedAt': datetime(2015, 1, 1),
    'S3Path': {
        'Bucket': 'string',
        'Key': 'string'
    },
    'Status': 'CREATING'|'UPDATING'|'ACTIVE'|'DELETING'|'FAILED',
    'RoleArn': 'string',
    'ErrorMessage': 'string'
}

Response Structure

  • (dict) --

    • Id (string) --

      The identifier of the FAQ.

    • IndexId (string) --

      The identifier of the index that contains the FAQ.

    • Name (string) --

      The name that you gave the FAQ when it was created.

    • Description (string) --

      The description of the FAQ that you provided when it was created.

    • CreatedAt (datetime) --

      The date and time that the FAQ was created.

    • UpdatedAt (datetime) --

      The date and time that the FAQ was last updated.

    • S3Path (dict) --

      Information required to find a specific file in an Amazon S3 bucket.

      • Bucket (string) --

        The name of the S3 bucket that contains the file.

      • Key (string) --

        The name of the file.

    • Status (string) --

      The status of the FAQ. It is ready to use when the status is ACTIVE .

    • RoleArn (string) --

      The Amazon Resource Name (ARN) of the role that provides access to the S3 bucket containing the input files for the FAQ.

    • ErrorMessage (string) --

      If the Status field is FAILED , the ErrorMessage field contains the reason why the FAQ failed.

describe_index(**kwargs)

Describes an existing Amazon Kendra index

See also: AWS API Documentation

Request Syntax

response = client.describe_index(
    Id='string'
)
Parameters
Id (string) --

[REQUIRED]

The name of the index to describe.

Return type
dict
Returns
Response Syntax
{
    'Name': 'string',
    'Id': 'string',
    'RoleArn': 'string',
    'ServerSideEncryptionConfiguration': {
        'KmsKeyId': 'string'
    },
    'Status': 'CREATING'|'ACTIVE'|'DELETING'|'FAILED'|'SYSTEM_UPDATING',
    'Description': 'string',
    'CreatedAt': datetime(2015, 1, 1),
    'UpdatedAt': datetime(2015, 1, 1),
    'DocumentMetadataConfigurations': [
        {
            'Name': 'string',
            'Type': 'STRING_VALUE'|'STRING_LIST_VALUE'|'LONG_VALUE'|'DATE_VALUE',
            'Relevance': {
                'Freshness': True|False,
                'Importance': 123,
                'Duration': 'string',
                'RankOrder': 'ASCENDING'|'DESCENDING',
                'ValueImportanceMap': {
                    'string': 123
                }
            },
            'Search': {
                'Facetable': True|False,
                'Searchable': True|False,
                'Displayable': True|False
            }
        },
    ],
    'IndexStatistics': {
        'FaqStatistics': {
            'IndexedQuestionAnswersCount': 123
        },
        'TextDocumentStatistics': {
            'IndexedTextDocumentsCount': 123
        }
    },
    'ErrorMessage': 'string'
}

Response Structure

  • (dict) --
    • Name (string) --

      The name of the index.

    • Id (string) --

      the name of the index.

    • RoleArn (string) --

      The Amazon Resource Name (ARN) of the IAM role that gives Amazon Kendra permission to write to your Amazon Cloudwatch logs.

    • ServerSideEncryptionConfiguration (dict) --

      The identifier of the AWS KMS customer master key (CMK) used to encrypt your data. Amazon Kendra doesn't support asymmetric CMKs.

      • KmsKeyId (string) --

        The identifier of the AWS KMS customer master key (CMK). Amazon Kendra doesn't support asymmetric CMKs.

    • Status (string) --

      The current status of the index. When the value is ACTIVE , the index is ready for use. If the Status field value is FAILED , the ErrorMessage field contains a message that explains why.

    • Description (string) --

      The description of the index.

    • CreatedAt (datetime) --

      The Unix datetime that the index was created.

    • UpdatedAt (datetime) --

      The Unix datetime that the index was last updated.

    • DocumentMetadataConfigurations (list) --

      Configuration settings for any metadata applied to the documents in the index.

      • (dict) --

        Specifies the properties of a custom index field.

        • Name (string) --

          The name of the index field.

        • Type (string) --

          The data type of the index field.

        • Relevance (dict) --

          Provides manual tuning parameters to determine how the field affects the search results.

          • Freshness (boolean) --

            Indicates that this field determines how "fresh" a document is. For example, if document 1 was created on November 5, and document 2 was created on October 31, document 1 is "fresher" than document 2. You can only set the Freshness field on one DATE type field. Only applies to DATE fields.

          • Importance (integer) --

            The relative importance of the field in the search. Larger numbers provide more of a boost than smaller numbers.

          • Duration (string) --

            Specifies the time period that the boost applies to. For example, to make the boost apply to documents with the field value within the last month, you would use "2628000s". Once the field value is beyond the specified range, the effect of the boost drops off. The higher the importance, the faster the effect drops off. If you don't specify a value, the default is 3 months. The value of the field is a numeric string followed by the character "s", for example "86400s" for one day, or "604800s" for one week.

            Only applies to DATE fields.

          • RankOrder (string) --

            Determines how values should be interpreted.

            When the RankOrder field is ASCENDING , higher numbers are better. For example, a document with a rating score of 10 is higher ranking than a document with a rating score of 1.

            When the RankOrder field is DESCENDING , lower numbers are better. For example, in a task tracking application, a priority 1 task is more important than a priority 5 task.

            Only applies to LONG and DOUBLE fields.

          • ValueImportanceMap (dict) --

            A list of values that should be given a different boost when they appear in the result list. For example, if you are boosting a field called "department," query terms that match the department field are boosted in the result. However, you can add entries from the department field to boost documents with those values higher.

            For example, you can add entries to the map with names of departments. If you add "HR",5 and "Legal",3 those departments are given special attention when they appear in the metadata of a document. When those terms appear they are given the specified importance instead of the regular importance for the boost.

            • (string) --
              • (integer) --
        • Search (dict) --

          Provides information about how the field is used during a search.

          • Facetable (boolean) --

            Indicates that the field can be used to create search facets, a count of results for each value in the field. The default is false .

          • Searchable (boolean) --

            Determines whether the field is used in the search. If the Searchable field is true , you can use relevance tuning to manually tune how Amazon Kendra weights the field in the search. The default is true for string fields and false for number and date fields.

          • Displayable (boolean) --

            Determines whether the field is returned in the query response. The default is true .

    • IndexStatistics (dict) --

      Provides information about the number of FAQ questions and answers and the number of text documents indexed.

      • FaqStatistics (dict) --

        The number of question and answer topics in the index.

        • IndexedQuestionAnswersCount (integer) --

          The total number of FAQ questions and answers contained in the index.

      • TextDocumentStatistics (dict) --

        The number of text documents indexed.

        • IndexedTextDocumentsCount (integer) --

          The number of text documents indexed.

    • ErrorMessage (string) --

      When th e``Status`` field value is FAILED , the ErrorMessage field contains a message that explains why.

generate_presigned_url(ClientMethod, Params=None, ExpiresIn=3600, HttpMethod=None)

Generate a presigned url given a client, its method, and arguments

Parameters
  • ClientMethod (string) -- The client method to presign for
  • Params (dict) -- The parameters normally passed to ClientMethod.
  • ExpiresIn (int) -- The number of seconds the presigned url is valid for. By default it expires in an hour (3600 seconds)
  • HttpMethod (string) -- The http method to use on the generated url. By default, the http method is whatever is used in the method's model.
Returns

The presigned url

get_paginator(operation_name)

Create a paginator for an operation.

Parameters
operation_name (string) -- The operation name. This is the same name as the method name on the client. For example, if the method name is create_foo, and you'd normally invoke the operation as client.create_foo(**kwargs), if the create_foo operation can be paginated, you can use the call client.get_paginator("create_foo").
Raises OperationNotPageableError
Raised if the operation is not pageable. You can use the client.can_paginate method to check if an operation is pageable.
Return type
L{botocore.paginate.Paginator}
Returns
A paginator object.
get_waiter(waiter_name)

Returns an object that can wait for some condition.

Parameters
waiter_name (str) -- The name of the waiter to get. See the waiters section of the service docs for a list of available waiters.
Returns
The specified waiter object.
Return type
botocore.waiter.Waiter
list_data_source_sync_jobs(**kwargs)

Gets statistics about synchronizing Amazon Kendra with a data source.

See also: AWS API Documentation

Request Syntax

response = client.list_data_source_sync_jobs(
    Id='string',
    IndexId='string',
    NextToken='string',
    MaxResults=123,
    StartTimeFilter={
        'StartTime': datetime(2015, 1, 1),
        'EndTime': datetime(2015, 1, 1)
    },
    StatusFilter='FAILED'|'SUCCEEDED'|'SYNCING'|'INCOMPLETE'|'STOPPING'|'ABORTED'
)
Parameters
  • Id (string) --

    [REQUIRED]

    The identifier of the data source.

  • IndexId (string) --

    [REQUIRED]

    The identifier of the index that contains the data source.

  • NextToken (string) -- If the result of the previous request to GetDataSourceSyncJobHistory was truncated, include the NextToken to fetch the next set of jobs.
  • MaxResults (integer) -- The maximum number of synchronization jobs to return in the response. If there are fewer results in the list, this response contains only the actual results.
  • StartTimeFilter (dict) --

    When specified, the synchronization jobs returned in the list are limited to jobs between the specified dates.

    • StartTime (datetime) --

      The UNIX datetime of the beginning of the time range.

    • EndTime (datetime) --

      The UNIX datetime of the end of the time range.

  • StatusFilter (string) -- When specified, only returns synchronization jobs with the Status field equal to the specified status.
Return type

dict

Returns

Response Syntax

{
    'History': [
        {
            'ExecutionId': 'string',
            'StartTime': datetime(2015, 1, 1),
            'EndTime': datetime(2015, 1, 1),
            'Status': 'FAILED'|'SUCCEEDED'|'SYNCING'|'INCOMPLETE'|'STOPPING'|'ABORTED',
            'ErrorMessage': 'string',
            'ErrorCode': 'InternalError'|'InvalidRequest',
            'DataSourceErrorCode': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) --

    • History (list) --

      A history of synchronization jobs for the data source.

      • (dict) --

        Provides information about a synchronization job.

        • ExecutionId (string) --

          A unique identifier for the synchronization job.

        • StartTime (datetime) --

          The UNIX datetime that the synchronization job was started.

        • EndTime (datetime) --

          The UNIX datetime that the synchronization job was completed.

        • Status (string) --

          The execution status of the synchronization job. When the Status field is set to SUCCEEDED , the synchronization job is done. If the status code is set to FAILED , the ErrorCode and ErrorMessage fields give you the reason for the failure.

        • ErrorMessage (string) --

          If the Status field is set to ERROR , the ErrorMessage field contains a description of the error that caused the synchronization to fail.

        • ErrorCode (string) --

          If the Status field is set to FAILED , the ErrorCode field contains a the reason that the synchronization failed.

        • DataSourceErrorCode (string) --

          If the reason that the synchronization failed is due to an error with the underlying data source, this field contains a code that identifies the error.

    • NextToken (string) --

      The GetDataSourceSyncJobHistory operation returns a page of vocabularies at a time. The maximum size of the page is set by the MaxResults parameter. If there are more jobs in the list than the page size, Amazon Kendra returns the NextPage token. Include the token in the next request to the GetDataSourceSyncJobHistory operation to return in the next page of jobs.

list_data_sources(**kwargs)

Lists the data sources 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 that contains the data source.

  • 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 sources (DataSourceSummaryItems ).
  • MaxResults (integer) -- The maximum number of data sources to return.
Return type

dict

Returns

Response Syntax

{
    'SummaryItems': [
        {
            'Name': 'string',
            'Id': 'string',
            'Type': 'S3'|'SHAREPOINT'|'DATABASE',
            'CreatedAt': datetime(2015, 1, 1),
            'UpdatedAt': datetime(2015, 1, 1),
            'Status': 'CREATING'|'DELETING'|'FAILED'|'UPDATING'|'ACTIVE'
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) --

    • SummaryItems (list) --

      An array of summary information for one or more data sources.

      • (dict) --

        Summary information for a Amazon Kendra data source. Returned in a call to .

        • Name (string) --

          The name of the data source.

        • Id (string) --

          The unique identifier for the data source.

        • Type (string) --

          The type of the data source.

        • CreatedAt (datetime) --

          The UNIX datetime that the data source was created.

        • UpdatedAt (datetime) --

          The UNIX datetime that the data source was lasted updated.

        • Status (string) --

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

    • 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 sources.

list_faqs(**kwargs)

Gets a list of FAQ lists associated with an index.

See also: AWS API Documentation

Request Syntax

response = client.list_faqs(
    IndexId='string',
    NextToken='string',
    MaxResults=123
)
Parameters
  • IndexId (string) --

    [REQUIRED]

    The index that contains the FAQ lists.

  • NextToken (string) -- If the result of the previous request to ListFaqs was truncated, include the NextToken to fetch the next set of FAQs.
  • MaxResults (integer) -- The maximum number of FAQs to return in the response. If there are fewer results in the list, this response contains only the actual results.
Return type

dict

Returns

Response Syntax

{
    'NextToken': 'string',
    'FaqSummaryItems': [
        {
            'Id': 'string',
            'Name': 'string',
            'Status': 'CREATING'|'UPDATING'|'ACTIVE'|'DELETING'|'FAILED',
            'CreatedAt': datetime(2015, 1, 1),
            'UpdatedAt': datetime(2015, 1, 1)
        },
    ]
}

Response Structure

  • (dict) --

    • NextToken (string) --

      The ListFaqs operation returns a page of FAQs at a time. The maximum size of the page is set by the MaxResults parameter. If there are more jobs in the list than the page size, Amazon Kendra returns the NextPage token. Include the token in the next request to the ListFaqs operation to return the next page of FAQs.

    • FaqSummaryItems (list) --

      information about the FAQs associated with the specified index.

      • (dict) --

        Provides information about a frequently asked questions and answer contained in an index.

        • Id (string) --

          The unique identifier of the FAQ.

        • Name (string) --

          The name that you assigned the FAQ when you created or updated the FAQ.

        • Status (string) --

          The current status of the FAQ. When the status is ACTIVE the FAQ is ready for use.

        • CreatedAt (datetime) --

          The UNIX datetime that the FAQ was added to the index.

        • UpdatedAt (datetime) --

          The UNIX datetime that the FAQ was last updated.

list_indices(**kwargs)

Lists the Amazon Kendra indexes that you have created.

See also: AWS API Documentation

Request Syntax

response = client.list_indices(
    NextToken='string',
    MaxResults=123
)
Parameters
  • 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 indexes (DataSourceSummaryItems ).
  • MaxResults (integer) -- The maximum number of data sources to return.
Return type

dict

Returns

Response Syntax

{
    'IndexConfigurationSummaryItems': [
        {
            'Name': 'string',
            'Id': 'string',
            'CreatedAt': datetime(2015, 1, 1),
            'UpdatedAt': datetime(2015, 1, 1),
            'Status': 'CREATING'|'ACTIVE'|'DELETING'|'FAILED'|'SYSTEM_UPDATING'
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) --

    • IndexConfigurationSummaryItems (list) --

      An array of summary information for one or more indexes.

      • (dict) --

        A summary of information about an index.

        • Name (string) --

          The name of the index.

        • Id (string) --

          A unique identifier for the index. Use this to identify the index when you are using operations such as Query , DescribeIndex , UpdateIndex , and DeleteIndex .

        • CreatedAt (datetime) --

          The Unix timestamp when the index was created.

        • UpdatedAt (datetime) --

          The Unix timestamp when the index was last updated by the UpdateIndex operation.

        • Status (string) --

          The current status of the index. When the status is ACTIVE , the index is ready to search.

    • 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 indexes.

query(**kwargs)

Searches an active index. Use this API to search your documents using query. The Query operation enables to do faceted search and to filter results based on document attributes.

It also enables you to provide user context that Amazon Kendra uses to enforce document access control in the search results.

Amazon Kendra searches your index for text content and question and answer (FAQ) content. By default the response contains three types of results.

  • Relevant passages
  • Matching FAQs
  • Relevant documents

You can specify that the query return only one type of result using the QueryResultTypeConfig parameter.

See also: AWS API Documentation

Request Syntax

response = client.query(
    IndexId='string',
    QueryText='string',
    AttributeFilter={
        'AndAllFilters': [
            {'... recursive ...'},
        ],
        'OrAllFilters': [
            {'... recursive ...'},
        ],
        'NotFilter': {'... recursive ...'},
        'EqualsTo': {
            'Key': 'string',
            'Value': {
                'StringValue': 'string',
                'StringListValue': [
                    'string',
                ],
                'LongValue': 123,
                'DateValue': datetime(2015, 1, 1)
            }
        },
        'ContainsAll': {
            'Key': 'string',
            'Value': {
                'StringValue': 'string',
                'StringListValue': [
                    'string',
                ],
                'LongValue': 123,
                'DateValue': datetime(2015, 1, 1)
            }
        },
        'ContainsAny': {
            'Key': 'string',
            'Value': {
                'StringValue': 'string',
                'StringListValue': [
                    'string',
                ],
                'LongValue': 123,
                'DateValue': datetime(2015, 1, 1)
            }
        },
        'GreaterThan': {
            'Key': 'string',
            'Value': {
                'StringValue': 'string',
                'StringListValue': [
                    'string',
                ],
                'LongValue': 123,
                'DateValue': datetime(2015, 1, 1)
            }
        },
        'GreaterThanOrEquals': {
            'Key': 'string',
            'Value': {
                'StringValue': 'string',
                'StringListValue': [
                    'string',
                ],
                'LongValue': 123,
                'DateValue': datetime(2015, 1, 1)
            }
        },
        'LessThan': {
            'Key': 'string',
            'Value': {
                'StringValue': 'string',
                'StringListValue': [
                    'string',
                ],
                'LongValue': 123,
                'DateValue': datetime(2015, 1, 1)
            }
        },
        'LessThanOrEquals': {
            'Key': 'string',
            'Value': {
                'StringValue': 'string',
                'StringListValue': [
                    'string',
                ],
                'LongValue': 123,
                'DateValue': datetime(2015, 1, 1)
            }
        }
    },
    Facets=[
        {
            'DocumentAttributeKey': 'string'
        },
    ],
    RequestedDocumentAttributes=[
        'string',
    ],
    QueryResultTypeFilter='DOCUMENT'|'QUESTION_ANSWER'|'ANSWER',
    PageNumber=123,
    PageSize=123
)
Parameters
  • IndexId (string) --

    [REQUIRED]

    The unique identifier of the index to search. The identifier is returned in the response from the operation.

  • QueryText (string) --

    [REQUIRED]

    The text to search for.

  • AttributeFilter (dict) --

    Enables filtered searches based on document attributes. You can only provide one attribute filter; however, the AndAllFilters , NotFilter , and OrAllFilters parameters contain a list of other filters.

    The AttributeFilter parameter enables you to create a set of filtering rules that a document must satisfy to be included in the query results.

    • AndAllFilters (list) --

      Performs a logical AND operation on all supplied filters.

      • (dict) --

        Provides filtering the query results based on document attributes.

        When you use the AndAllFilters or OrAllFilters , filters you can use a total of 3 layers. For example, you can use:

        • <AndAllFilters>
        • <OrAllFilters>
        • <EqualTo>
    • OrAllFilters (list) --

      Performs a logical OR operation on all supplied filters.

      • (dict) --

        Provides filtering the query results based on document attributes.

        When you use the AndAllFilters or OrAllFilters , filters you can use a total of 3 layers. For example, you can use:

        • <AndAllFilters>
        • <OrAllFilters>
        • <EqualTo>
    • NotFilter (dict) --

      Performs a logical NOT operation on all supplied filters.

    • EqualsTo (dict) --

      Performs an equals operation on two document attributes.

      • Key (string) -- [REQUIRED]

        The identifier for the attribute.

      • Value (dict) -- [REQUIRED]

        The value of the attribute.

        • StringValue (string) --

          A string, such as "department".

        • StringListValue (list) --

          A list of strings.

          • (string) --
        • LongValue (integer) --

          A long integer value.

        • DateValue (datetime) --

          A date value expressed as seconds from the Unix epoch.

    • ContainsAll (dict) --

      Returns true when a document contains all of the specified document attributes.

      • Key (string) -- [REQUIRED]

        The identifier for the attribute.

      • Value (dict) -- [REQUIRED]

        The value of the attribute.

        • StringValue (string) --

          A string, such as "department".

        • StringListValue (list) --

          A list of strings.

          • (string) --
        • LongValue (integer) --

          A long integer value.

        • DateValue (datetime) --

          A date value expressed as seconds from the Unix epoch.

    • ContainsAny (dict) --

      Returns true when a document contains any of the specified document attributes.

      • Key (string) -- [REQUIRED]

        The identifier for the attribute.

      • Value (dict) -- [REQUIRED]

        The value of the attribute.

        • StringValue (string) --

          A string, such as "department".

        • StringListValue (list) --

          A list of strings.

          • (string) --
        • LongValue (integer) --

          A long integer value.

        • DateValue (datetime) --

          A date value expressed as seconds from the Unix epoch.

    • GreaterThan (dict) --

      Performs a greater than operation on two document attributes. Use with a document attribute of type Integer or Long .

      • Key (string) -- [REQUIRED]

        The identifier for the attribute.

      • Value (dict) -- [REQUIRED]

        The value of the attribute.

        • StringValue (string) --

          A string, such as "department".

        • StringListValue (list) --

          A list of strings.

          • (string) --
        • LongValue (integer) --

          A long integer value.

        • DateValue (datetime) --

          A date value expressed as seconds from the Unix epoch.

    • GreaterThanOrEquals (dict) --

      Performs a greater or equals than operation on two document attributes. Use with a document attribute of type Integer or Long .

      • Key (string) -- [REQUIRED]

        The identifier for the attribute.

      • Value (dict) -- [REQUIRED]

        The value of the attribute.

        • StringValue (string) --

          A string, such as "department".

        • StringListValue (list) --

          A list of strings.

          • (string) --
        • LongValue (integer) --

          A long integer value.

        • DateValue (datetime) --

          A date value expressed as seconds from the Unix epoch.

    • LessThan (dict) --

      Performs a less than operation on two document attributes. Use with a document attribute of type Integer or Long .

      • Key (string) -- [REQUIRED]

        The identifier for the attribute.

      • Value (dict) -- [REQUIRED]

        The value of the attribute.

        • StringValue (string) --

          A string, such as "department".

        • StringListValue (list) --

          A list of strings.

          • (string) --
        • LongValue (integer) --

          A long integer value.

        • DateValue (datetime) --

          A date value expressed as seconds from the Unix epoch.

    • LessThanOrEquals (dict) --

      Performs a less than or equals operation on two document attributes. Use with a document attribute of type Integer or Long .

      • Key (string) -- [REQUIRED]

        The identifier for the attribute.

      • Value (dict) -- [REQUIRED]

        The value of the attribute.

        • StringValue (string) --

          A string, such as "department".

        • StringListValue (list) --

          A list of strings.

          • (string) --
        • LongValue (integer) --

          A long integer value.

        • DateValue (datetime) --

          A date value expressed as seconds from the Unix epoch.

  • Facets (list) --

    An array of documents attributes. Amazon Kendra returns a count for each attribute key specified. You can use this information to help narrow the search for your user.

    • (dict) --

      Information a document attribute

      • DocumentAttributeKey (string) --

        The unique key for the document attribute.

  • RequestedDocumentAttributes (list) --

    An array of document attributes to include in the response. No other document attributes are included in the response. By default all document attributes are included in the response.

    • (string) --
  • QueryResultTypeFilter (string) -- Sets the type of query. Only results for the specified query type are returned.
  • PageNumber (integer) -- Query results are returned in pages the size of the PageSize parameter. By default, Amazon Kendra returns the first page of results. Use this parameter to get result pages after the first one.
  • PageSize (integer) -- Sets the number of results that are returned in each page of results. The default page size is 100.
Return type

dict

Returns

Response Syntax

{
    'QueryId': 'string',
    'ResultItems': [
        {
            'Id': 'string',
            'Type': 'DOCUMENT'|'QUESTION_ANSWER'|'ANSWER',
            'AdditionalAttributes': [
                {
                    'Key': 'string',
                    'ValueType': 'TEXT_WITH_HIGHLIGHTS_VALUE',
                    'Value': {
                        'TextWithHighlightsValue': {
                            'Text': 'string',
                            'Highlights': [
                                {
                                    'BeginOffset': 123,
                                    'EndOffset': 123,
                                    'TopAnswer': True|False
                                },
                            ]
                        }
                    }
                },
            ],
            'DocumentId': 'string',
            'DocumentTitle': {
                'Text': 'string',
                'Highlights': [
                    {
                        'BeginOffset': 123,
                        'EndOffset': 123,
                        'TopAnswer': True|False
                    },
                ]
            },
            'DocumentExcerpt': {
                'Text': 'string',
                'Highlights': [
                    {
                        'BeginOffset': 123,
                        'EndOffset': 123,
                        'TopAnswer': True|False
                    },
                ]
            },
            'DocumentURI': 'string',
            'DocumentAttributes': [
                {
                    'Key': 'string',
                    'Value': {
                        'StringValue': 'string',
                        'StringListValue': [
                            'string',
                        ],
                        'LongValue': 123,
                        'DateValue': datetime(2015, 1, 1)
                    }
                },
            ]
        },
    ],
    'FacetResults': [
        {
            'DocumentAttributeKey': 'string',
            'DocumentAttributeValueCountPairs': [
                {
                    'DocumentAttributeValue': {
                        'StringValue': 'string',
                        'StringListValue': [
                            'string',
                        ],
                        'LongValue': 123,
                        'DateValue': datetime(2015, 1, 1)
                    },
                    'Count': 123
                },
            ]
        },
    ],
    'TotalNumberOfResults': 123
}

Response Structure

  • (dict) --

    • QueryId (string) --

      The unique identifier for the search. You use QueryId to identify the search when using the feedback API.

    • ResultItems (list) --

      The results of the search.

      • (dict) --

        A single query result.

        A query result contains information about a document returned by the query. This includes the original location of the document, a list of attributes assigned to the document, and relevant text from the document that satisfies the query.

        • Id (string) --

          The unique identifier for the query result.

        • Type (string) --

          The type of document.

        • AdditionalAttributes (list) --

          • (dict) --

            • Key (string) --

            • ValueType (string) --

            • Value (dict) --

              • TextWithHighlightsValue (dict) --

                The text associated with the attribute and information about the highlight to apply to the text.

                • Text (string) --

                  The text to display to the user.

                • Highlights (list) --

                  The beginning and end of the text that should be highlighted.

                  • (dict) --

                    Provides information that you can use to highlight a search result so that your users can quickly identify terms in the response.

                    • BeginOffset (integer) --

                      The zero-based location in the response string where the highlight starts.

                    • EndOffset (integer) --

                      The zero-based location in the response string where the highlight ends.

                    • TopAnswer (boolean) --

                      Indicates whether the response is the best response. True if this is the best response; otherwise, false.

        • DocumentId (string) --

          The unique identifier for the document.

        • DocumentTitle (dict) --

          The title of the document. Contains the text of the title and information for highlighting the relevant terms in the title.

          • Text (string) --

            The text to display to the user.

          • Highlights (list) --

            The beginning and end of the text that should be highlighted.

            • (dict) --

              Provides information that you can use to highlight a search result so that your users can quickly identify terms in the response.

              • BeginOffset (integer) --

                The zero-based location in the response string where the highlight starts.

              • EndOffset (integer) --

                The zero-based location in the response string where the highlight ends.

              • TopAnswer (boolean) --

                Indicates whether the response is the best response. True if this is the best response; otherwise, false.

        • DocumentExcerpt (dict) --

          An extract of the text in the document. Contains information about highlighting the relevant terms in the excerpt.

          • Text (string) --

            The text to display to the user.

          • Highlights (list) --

            The beginning and end of the text that should be highlighted.

            • (dict) --

              Provides information that you can use to highlight a search result so that your users can quickly identify terms in the response.

              • BeginOffset (integer) --

                The zero-based location in the response string where the highlight starts.

              • EndOffset (integer) --

                The zero-based location in the response string where the highlight ends.

              • TopAnswer (boolean) --

                Indicates whether the response is the best response. True if this is the best response; otherwise, false.

        • DocumentURI (string) --

          The URI of the original location of the document.

        • DocumentAttributes (list) --

          An array of document attributes for the document that the query result maps to. For example, the document author (Author) or the source URI (SourceUri) of the document.

          • (dict) --

            A custom attribute value assigned to a document.

            • Key (string) --

              The identifier for the attribute.

            • Value (dict) --

              The value of the attribute.

              • StringValue (string) --

                A string, such as "department".

              • StringListValue (list) --

                A list of strings.

                • (string) --
              • LongValue (integer) --

                A long integer value.

              • DateValue (datetime) --

                A date value expressed as seconds from the Unix epoch.

    • FacetResults (list) --

      Contains the facet results. A FacetResult contains the counts for each attribute key that was specified in the Facets input parameter.

      • (dict) --

        The facet values for the documents in the response.

        • DocumentAttributeKey (string) --

          The key for the facet values. This is the same as the DocumentAttributeKey provided in the query.

        • DocumentAttributeValueCountPairs (list) --

          An array of key/value pairs, where the key is the value of the attribute and the count is the number of documents that share the key value.

          • (dict) --

            Provides the count of documents that match a particular attribute when doing a faceted search.

            • DocumentAttributeValue (dict) --

              The value of the attribute. For example, "HR."

              • StringValue (string) --

                A string, such as "department".

              • StringListValue (list) --

                A list of strings.

                • (string) --
              • LongValue (integer) --

                A long integer value.

              • DateValue (datetime) --

                A date value expressed as seconds from the Unix epoch.

            • Count (integer) --

              The number of documents in the response that have the attribute value for the key.

    • TotalNumberOfResults (integer) --

      The number of items returned by the search. Use this to determine when you have requested the last set of results.

start_data_source_sync_job(**kwargs)

Starts a synchronization job for a data source. If a synchronization job is already in progress, Amazon Kendra returns a ResourceInUseException exception.

See also: AWS API Documentation

Request Syntax

response = client.start_data_source_sync_job(
    Id='string',
    IndexId='string'
)
Parameters
  • Id (string) --

    [REQUIRED]

    The identifier of the data source to synchronize.

  • IndexId (string) --

    [REQUIRED]

    The identifier of the index that contains the data source.

Return type

dict

Returns

Response Syntax

{
    'ExecutionId': 'string'
}

Response Structure

  • (dict) --

    • ExecutionId (string) --

      Identifies a particular synchronization job.

stop_data_source_sync_job(**kwargs)

Stops a running synchronization job. You can't stop a scheduled synchronization job.

See also: AWS API Documentation

Request Syntax

response = client.stop_data_source_sync_job(
    Id='string',
    IndexId='string'
)
Parameters
  • Id (string) --

    [REQUIRED]

    The identifier of the data source for which to stop the synchronization jobs.

  • IndexId (string) --

    [REQUIRED]

    The identifier of the index that contains the data source.

Returns

None

submit_feedback(**kwargs)

Enables you to provide feedback to Amazon Kendra to improve the performance of the service.

See also: AWS API Documentation

Request Syntax

response = client.submit_feedback(
    IndexId='string',
    QueryId='string',
    ClickFeedbackItems=[
        {
            'ResultId': 'string',
            'ClickTime': datetime(2015, 1, 1)
        },
    ],
    RelevanceFeedbackItems=[
        {
            'ResultId': 'string',
            'RelevanceValue': 'RELEVANT'|'NOT_RELEVANT'
        },
    ]
)
Parameters
  • IndexId (string) --

    [REQUIRED]

    The identifier of the index that was queried.

  • QueryId (string) --

    [REQUIRED]

    The identifier of the specific query for which you are submitting feedback. The query ID is returned in the response to the operation.

  • ClickFeedbackItems (list) --

    Tells Amazon Kendra that a particular search result link was chosen by the user.

    • (dict) --

      Gathers information about when a particular result was clicked by a user. Your application uses the SubmitFeedback operation to provide click information.

      • ResultId (string) -- [REQUIRED]

        The unique identifier of the search result that was clicked.

      • ClickTime (datetime) -- [REQUIRED]

        The Unix timestamp of the data and time that the result was clicked.

  • RelevanceFeedbackItems (list) --

    Provides Amazon Kendra with relevant or not relevant feedback for whether a particular item was relevant to the search.

    • (dict) --

      Provides feedback on how relevant a document is to a search. Your application uses the SubmitFeedback operation to provide relevance information.

      • ResultId (string) -- [REQUIRED]

        The unique identifier of the search result that the user provided relevance feedback for.

      • RelevanceValue (string) -- [REQUIRED]

        Whether to document was relevant or not relevant to the search.

Returns

None

update_data_source(**kwargs)

Updates an existing Amazon Kendra data source.

See also: AWS API Documentation

Request Syntax

response = client.update_data_source(
    Id='string',
    Name='string',
    IndexId='string',
    Configuration={
        'S3Configuration': {
            'BucketName': 'string',
            'InclusionPrefixes': [
                'string',
            ],
            'ExclusionPatterns': [
                'string',
            ],
            'DocumentsMetadataConfiguration': {
                'S3Prefix': 'string'
            },
            'AccessControlListConfiguration': {
                'KeyPath': 'string'
            }
        },
        'SharePointConfiguration': {
            'SharePointVersion': 'SHAREPOINT_ONLINE',
            'Urls': [
                'string',
            ],
            'SecretArn': 'string',
            'CrawlAttachments': True|False,
            'UseChangeLog': True|False,
            'InclusionPatterns': [
                'string',
            ],
            'ExclusionPatterns': [
                'string',
            ],
            'VpcConfiguration': {
                'SubnetIds': [
                    'string',
                ],
                'SecurityGroupIds': [
                    'string',
                ]
            },
            'FieldMappings': [
                {
                    'DataSourceFieldName': 'string',
                    'DateFieldFormat': 'string',
                    'IndexFieldName': 'string'
                },
            ],
            'DocumentTitleFieldName': 'string'
        },
        'DatabaseConfiguration': {
            'DatabaseEngineType': 'RDS_AURORA_MYSQL'|'RDS_AURORA_POSTGRESQL'|'RDS_MYSQL'|'RDS_POSTGRESQL',
            'ConnectionConfiguration': {
                'DatabaseHost': 'string',
                'DatabasePort': 123,
                'DatabaseName': 'string',
                'TableName': 'string',
                'SecretArn': 'string'
            },
            'VpcConfiguration': {
                'SubnetIds': [
                    'string',
                ],
                'SecurityGroupIds': [
                    'string',
                ]
            },
            'ColumnConfiguration': {
                'DocumentIdColumnName': 'string',
                'DocumentDataColumnName': 'string',
                'DocumentTitleColumnName': 'string',
                'FieldMappings': [
                    {
                        'DataSourceFieldName': 'string',
                        'DateFieldFormat': 'string',
                        'IndexFieldName': 'string'
                    },
                ],
                'ChangeDetectingColumns': [
                    'string',
                ]
            },
            'AclConfiguration': {
                'AllowedGroupsColumnName': 'string'
            }
        }
    },
    Description='string',
    Schedule='string',
    RoleArn='string'
)
Parameters
  • Id (string) --

    [REQUIRED]

    The unique identifier of the data source to update.

  • Name (string) -- The name of the data source to update. The name of the data source can't be updated. To rename a data source you must delete the data source and re-create it.
  • IndexId (string) --

    [REQUIRED]

    The identifier of the index that contains the data source to update.

  • Configuration (dict) --

    Configuration information for a Amazon Kendra data source.

    • S3Configuration (dict) --

      Provides information to create a connector for a document repository in an Amazon S3 bucket.

      • BucketName (string) -- [REQUIRED]

        The name of the bucket that contains the documents.

      • InclusionPrefixes (list) --

        A list of S3 prefixes for the documents that should be included in the index.

        • (string) --
      • ExclusionPatterns (list) --

        A list of glob patterns for documents that should not be indexed. If a document that matches an inclusion prefix also matches an exclusion pattern, the document is not indexed.

        For more information about glob patterns, see glob (programming) in Wikipedia .

        • (string) --
      • DocumentsMetadataConfiguration (dict) --

        Document metadata files that contain information such as the document access control information, source URI, document author, and custom attributes. Each metadata file contains metadata about a single document.

        • S3Prefix (string) --

          A prefix used to filter metadata configuration files in the AWS S3 bucket. The S3 bucket might contain multiple metadata files. Use S3Prefix to include only the desired metadata files.

      • AccessControlListConfiguration (dict) --

        Provides the path to the S3 bucket that contains the user context filtering files for the data source.

        • KeyPath (string) --

          Path to the AWS S3 bucket that contains the ACL files.

    • SharePointConfiguration (dict) --

      Provides information necessary to create a connector for a Microsoft SharePoint site.

      • SharePointVersion (string) -- [REQUIRED]

        The version of Microsoft SharePoint that you are using as a data source.

      • Urls (list) -- [REQUIRED]

        The URLs of the Microsoft SharePoint site that contains the documents that should be indexed.

        • (string) --
      • SecretArn (string) -- [REQUIRED]

        The Amazon Resource Name (ARN) of credentials stored in AWS Secrets Manager. The credentials should be a user/password pair. For more information, see Using a Microsoft SharePoint Data Source . For more information about AWS Secrets Manager, see What Is AWS Secrets Manager in the AWS Secrets Manager user guide.

      • CrawlAttachments (boolean) --
        TRUE to include attachments to documents stored in your Microsoft SharePoint site in the index; otherwise, FALSE .
      • UseChangeLog (boolean) --

        Set to TRUE to use the Microsoft SharePoint change log to determine the documents that need to be updated in the index. Depending on the size of the SharePoint change log, it may take longer for Amazon Kendra to use the change log than it takes it to determine the changed documents using the Amazon Kendra document crawler.

      • InclusionPatterns (list) --

        A list of regular expression patterns. Documents that match the patterns are included in the index. Documents that don't match the patterns are excluded from the index. If a document matches both an inclusion pattern and an exclusion pattern, the document is not included in the index.

        The regex is applied to the display URL of the SharePoint document.

        • (string) --
      • ExclusionPatterns (list) --

        A list of regular expression patterns. Documents that match the patterns are excluded from the index. Documents that don't match the patterns are included in the index. If a document matches both an exclusion pattern and an inclusion pattern, the document is not included in the index.

        The regex is applied to the display URL of the SharePoint document.

        • (string) --
      • VpcConfiguration (dict) --

        Provides information for connecting to an Amazon VPC.

        • SubnetIds (list) -- [REQUIRED]

          A list of identifiers for subnets within your Amazon VPC. The subnets should be able to connect to each other in the VPC, and they should have outgoing access to the Internet through a NAT device.

          • (string) --
        • SecurityGroupIds (list) -- [REQUIRED]

          A list of identifiers of security groups within your Amazon VPC. The security groups should enable Amazon Kendra to connect to the data source.

          • (string) --
      • FieldMappings (list) --

        A list of DataSourceToIndexFieldMapping objects that map Microsoft SharePoint attributes to custom fields in the Amazon Kendra index. You must first create the index fields using the operation before you map SharePoint attributes. For more information, see Mapping Data Source Fields .

        • (dict) --

          Maps a column or attribute in the data source to an index field. You must first create the fields in the index using the UpdateIndex operation.

          • DataSourceFieldName (string) -- [REQUIRED]

            The name of the column or attribute in the data source.

          • DateFieldFormat (string) --

            The type of data stored in the column or attribute.

          • IndexFieldName (string) -- [REQUIRED]

            The name of the field in the index.

      • DocumentTitleFieldName (string) --

        The Microsoft SharePoint attribute field that contains the title of the document.

    • DatabaseConfiguration (dict) --

      Provides information necessary to create a connector for a database.

      • DatabaseEngineType (string) -- [REQUIRED]

        The type of database engine that runs the database.

      • ConnectionConfiguration (dict) -- [REQUIRED]

        The information necessary to connect to a database.

        • DatabaseHost (string) -- [REQUIRED]

          The name of the host for the database. Can be either a string (host.subdomain.domain.tld) or an IPv4 or IPv6 address.

        • DatabasePort (integer) -- [REQUIRED]

          The port that the database uses for connections.

        • DatabaseName (string) -- [REQUIRED]

          The name of the database containing the document data.

        • TableName (string) -- [REQUIRED]

          The name of the table that contains the document data.

        • SecretArn (string) -- [REQUIRED]

          The Amazon Resource Name (ARN) of credentials stored in AWS Secrets Manager. The credentials should be a user/password pair. For more information, see Using a Database Data Source . For more information about AWS Secrets Manager, see What Is AWS Secrets Manager in the AWS Secrets Manager user guide.

      • VpcConfiguration (dict) --

        Provides information for connecting to an Amazon VPC.

        • SubnetIds (list) -- [REQUIRED]

          A list of identifiers for subnets within your Amazon VPC. The subnets should be able to connect to each other in the VPC, and they should have outgoing access to the Internet through a NAT device.

          • (string) --
        • SecurityGroupIds (list) -- [REQUIRED]

          A list of identifiers of security groups within your Amazon VPC. The security groups should enable Amazon Kendra to connect to the data source.

          • (string) --
      • ColumnConfiguration (dict) -- [REQUIRED]

        Information about where the index should get the document information from the database.

        • DocumentIdColumnName (string) -- [REQUIRED]

          The column that provides the document's unique identifier.

        • DocumentDataColumnName (string) -- [REQUIRED]

          The column that contains the contents of the document.

        • DocumentTitleColumnName (string) --

          The column that contains the title of the document.

        • FieldMappings (list) --

          An array of objects that map database column names to the corresponding fields in an index. You must first create the fields in the index using the UpdateIndex operation.

          • (dict) --

            Maps a column or attribute in the data source to an index field. You must first create the fields in the index using the UpdateIndex operation.

            • DataSourceFieldName (string) -- [REQUIRED]

              The name of the column or attribute in the data source.

            • DateFieldFormat (string) --

              The type of data stored in the column or attribute.

            • IndexFieldName (string) -- [REQUIRED]

              The name of the field in the index.

        • ChangeDetectingColumns (list) -- [REQUIRED]

          One to five columns that indicate when a document in the database has changed.

          • (string) --
      • AclConfiguration (dict) --

        Information about the database column that provides information for user context filtering.

        • AllowedGroupsColumnName (string) -- [REQUIRED]

          A list of groups, separated by semi-colons, that filters a query response based on user context. The document is only returned to users that are in one of the groups specified in the UserContext field of the Query operation.

  • Description (string) -- The new description for the data source.
  • Schedule (string) -- The new update schedule for the data source.
  • RoleArn (string) -- The Amazon Resource Name (ARN) of the new role to use when the data source is accessing resources on your behalf.
Returns

None

update_index(**kwargs)

Updates an existing Amazon Kendra index.

See also: AWS API Documentation

Request Syntax

response = client.update_index(
    Id='string',
    Name='string',
    RoleArn='string',
    Description='string',
    DocumentMetadataConfigurationUpdates=[
        {
            'Name': 'string',
            'Type': 'STRING_VALUE'|'STRING_LIST_VALUE'|'LONG_VALUE'|'DATE_VALUE',
            'Relevance': {
                'Freshness': True|False,
                'Importance': 123,
                'Duration': 'string',
                'RankOrder': 'ASCENDING'|'DESCENDING',
                'ValueImportanceMap': {
                    'string': 123
                }
            },
            'Search': {
                'Facetable': True|False,
                'Searchable': True|False,
                'Displayable': True|False
            }
        },
    ]
)
Parameters
  • Id (string) --

    [REQUIRED]

    The identifier of the index to update.

  • Name (string) -- The name of the index to update.
  • RoleArn (string) -- A new IAM role that gives Amazon Kendra permission to access your Amazon CloudWatch logs.
  • Description (string) -- A new description for the index.
  • DocumentMetadataConfigurationUpdates (list) --

    The document metadata to update.

    • (dict) --

      Specifies the properties of a custom index field.

      • Name (string) -- [REQUIRED]

        The name of the index field.

      • Type (string) -- [REQUIRED]

        The data type of the index field.

      • Relevance (dict) --

        Provides manual tuning parameters to determine how the field affects the search results.

        • Freshness (boolean) --

          Indicates that this field determines how "fresh" a document is. For example, if document 1 was created on November 5, and document 2 was created on October 31, document 1 is "fresher" than document 2. You can only set the Freshness field on one DATE type field. Only applies to DATE fields.

        • Importance (integer) --

          The relative importance of the field in the search. Larger numbers provide more of a boost than smaller numbers.

        • Duration (string) --

          Specifies the time period that the boost applies to. For example, to make the boost apply to documents with the field value within the last month, you would use "2628000s". Once the field value is beyond the specified range, the effect of the boost drops off. The higher the importance, the faster the effect drops off. If you don't specify a value, the default is 3 months. The value of the field is a numeric string followed by the character "s", for example "86400s" for one day, or "604800s" for one week.

          Only applies to DATE fields.

        • RankOrder (string) --

          Determines how values should be interpreted.

          When the RankOrder field is ASCENDING , higher numbers are better. For example, a document with a rating score of 10 is higher ranking than a document with a rating score of 1.

          When the RankOrder field is DESCENDING , lower numbers are better. For example, in a task tracking application, a priority 1 task is more important than a priority 5 task.

          Only applies to LONG and DOUBLE fields.

        • ValueImportanceMap (dict) --

          A list of values that should be given a different boost when they appear in the result list. For example, if you are boosting a field called "department," query terms that match the department field are boosted in the result. However, you can add entries from the department field to boost documents with those values higher.

          For example, you can add entries to the map with names of departments. If you add "HR",5 and "Legal",3 those departments are given special attention when they appear in the metadata of a document. When those terms appear they are given the specified importance instead of the regular importance for the boost.

          • (string) --
            • (integer) --
      • Search (dict) --

        Provides information about how the field is used during a search.

        • Facetable (boolean) --

          Indicates that the field can be used to create search facets, a count of results for each value in the field. The default is false .

        • Searchable (boolean) --

          Determines whether the field is used in the search. If the Searchable field is true , you can use relevance tuning to manually tune how Amazon Kendra weights the field in the search. The default is true for string fields and false for number and date fields.

        • Displayable (boolean) --

          Determines whether the field is returned in the query response. The default is true .

Returns

None

Paginators

The available paginators are: