@aws-sdk/client-kendra 3.95.0 → 3.104.0

package/dist-types/models/models_0.d.ts

@@ -1025,6 +1025,11 @@ export declare namespace S3Path {
 export interface Document {
     /**
      * <p>A unique identifier of the document in the index.</p>
+     *         <p>Note, each document ID must be unique per index. You cannot create a data source
+     *             to index your documents with their unique IDs and then use the
+     *             <code>BatchPutDocument</code> API to index the same documents, or vice versa. You
+     *             can delete a data source and then use the <code>BatchPutDocument</code> API to index
+     *             the same documents, or vice versa.</p>
      */
     Id: string | undefined;
     /**
@@ -1984,6 +1989,280 @@ export declare namespace FsxConfiguration {
      */
     const filterSensitiveLog: (obj: FsxConfiguration) => any;
 }
+/**
+ * <p>Provides the configuration information to include certain types of GitHub content. You can
+ *             configure to index repository files only, or also include issues and pull requests,
+ *             comments, and comment attachments.</p>
+ */
+export interface GitHubDocumentCrawlProperties {
+    /**
+     * <p>
+     *             <code>TRUE</code> to index all files with a repository.</p>
+     */
+    CrawlRepositoryDocuments?: boolean;
+    /**
+     * <p>
+     *             <code>TRUE</code> to index all issues within a repository.</p>
+     */
+    CrawlIssue?: boolean;
+    /**
+     * <p>
+     *             <code>TRUE</code> to index all comments on issues.</p>
+     */
+    CrawlIssueComment?: boolean;
+    /**
+     * <p>
+     *             <code>TRUE</code> to include all comment attachments for issues.</p>
+     */
+    CrawlIssueCommentAttachment?: boolean;
+    /**
+     * <p>
+     *             <code>TRUE</code> to index all pull requests within a repository.</p>
+     */
+    CrawlPullRequest?: boolean;
+    /**
+     * <p>
+     *             <code>TRUE</code> to index all comments on pull requests.</p>
+     */
+    CrawlPullRequestComment?: boolean;
+    /**
+     * <p>
+     *             <code>TRUE</code> to include all comment attachments for pull requests.</p>
+     */
+    CrawlPullRequestCommentAttachment?: boolean;
+}
+export declare namespace GitHubDocumentCrawlProperties {
+    /**
+     * @internal
+     */
+    const filterSensitiveLog: (obj: GitHubDocumentCrawlProperties) => any;
+}
+/**
+ * <p>Provides the configuration information to connect to GitHub Enterprise Server (on premises).</p>
+ */
+export interface OnPremiseConfiguration {
+    /**
+     * <p>The GitHub host URL or API endpoint URL. For example,
+     *             <i>https://on-prem-host-url/api/v3/</i>
+     *          </p>
+     */
+    HostUrl: string | undefined;
+    /**
+     * <p>The name of the organization of the GitHub Enterprise Server (in-premise) account you want
+     *             to connect to. You can find your organization name by logging into GitHub desktop and
+     *             selecting <b>Your organizations</b> under your profile picture dropdown.</p>
+     */
+    OrganizationName: string | undefined;
+    /**
+     * <p>Information required to find a specific file in an Amazon S3 bucket.</p>
+     */
+    SslCertificateS3Path: S3Path | undefined;
+}
+export declare namespace OnPremiseConfiguration {
+    /**
+     * @internal
+     */
+    const filterSensitiveLog: (obj: OnPremiseConfiguration) => any;
+}
+/**
+ * <p>Provides the configuration information to connect to GitHub Enterprise Cloud (SaaS).</p>
+ */
+export interface SaaSConfiguration {
+    /**
+     * <p>The name of the organization of the GitHub Enterprise Cloud (SaaS) account you want
+     *             to connect to. You can find your organization name by logging into GitHub desktop and
+     *             selecting <b>Your organizations</b> under your profile picture dropdown.</p>
+     */
+    OrganizationName: string | undefined;
+    /**
+     * <p>The GitHub host URL or API endpoint URL. For example,
+     *             <i>https://api.github.com</i>.</p>
+     */
+    HostUrl: string | undefined;
+}
+export declare namespace SaaSConfiguration {
+    /**
+     * @internal
+     */
+    const filterSensitiveLog: (obj: SaaSConfiguration) => any;
+}
+export declare enum Type {
+    ON_PREMISE = "ON_PREMISE",
+    SAAS = "SAAS"
+}
+/**
+ * <p>Provides the configuration information to connect to GitHub
+ *             as your data source.</p>
+ */
+export interface GitHubConfiguration {
+    /**
+     * <p>Configuration information to connect to GitHub Enterprise Cloud (SaaS).</p>
+     */
+    SaaSConfiguration?: SaaSConfiguration;
+    /**
+     * <p>Configuration information to connect to GitHub Enterprise Server (on premises).</p>
+     */
+    OnPremiseConfiguration?: OnPremiseConfiguration;
+    /**
+     * <p>The type of GitHub service you want to connect to—GitHub Enterprise
+     *             Cloud (SaaS) or GitHub Enterprise Server (on premises).</p>
+     */
+    Type?: Type | string;
+    /**
+     * <p>The Amazon Resource Name (ARN) of an Secrets Manager secret that contains
+     *             the key-value pairs required to connect to your GitHub. The secret must contain
+     *             a JSON structure with the following keys:</p>
+     *         <ul>
+     *             <li>
+     *                 <p>githubToken—The access token created in GitHub. For more information
+     *                     on creating a token in GitHub, see <a href="https://docs.aws.amazon.com/kendra/latest/dg/data-source-github.html#github-authentication">Authentication
+     *                         for a GitHub data source</a>.</p>
+     *             </li>
+     *          </ul>
+     */
+    SecretArn: string | undefined;
+    /**
+     * <p>
+     *             <code>TRUE</code> to use the GitHub change log to determine which documents require
+     *             updating in the index. Depending on the GitHub change log's size, it may take longer
+     *             for Amazon Kendra to use the change log than to scan all of your documents in
+     *             GitHub.</p>
+     */
+    UseChangeLog?: boolean;
+    /**
+     * <p>Configuration information to include certain types of GitHub content. You can
+     *             configure to index repository files only, or also include issues and pull requests,
+     *             comments, and comment attachments.</p>
+     */
+    GitHubDocumentCrawlProperties?: GitHubDocumentCrawlProperties;
+    /**
+     * <p>A list of names of the specific repositories you want to index.</p>
+     */
+    RepositoryFilter?: string[];
+    /**
+     * <p>A list of regular expression patterns to include certain folder names in your
+     *             GitHub repository or repositories. Folder names that match the patterns are
+     *             included in the index. Folder names that don't match the patterns are excluded
+     *             from the index. If a folder matches both an inclusion and exclusion pattern, the
+     *             exclusion pattern takes precedence and the folder isn't included in the index.</p>
+     */
+    InclusionFolderNamePatterns?: string[];
+    /**
+     * <p>A list of regular expression patterns to include certain file types in your
+     *             GitHub repository or repositories. File types that match the patterns are
+     *             included in the index. File types that don't match the patterns are excluded
+     *             from the index. If a file matches both an inclusion and exclusion pattern, the
+     *             exclusion pattern takes precedence and the file isn't included in the index.</p>
+     */
+    InclusionFileTypePatterns?: string[];
+    /**
+     * <p>A list of regular expression patterns to include certain file names in your
+     *             GitHub repository or repositories. File names that match the patterns are
+     *             included in the index. File names that don't match the patterns are excluded
+     *             from the index. If a file matches both an inclusion and exclusion pattern, the
+     *             exclusion pattern takes precedence and the file isn't included in the index.</p>
+     */
+    InclusionFileNamePatterns?: string[];
+    /**
+     * <p>A list of regular expression patterns to exclude certain folder names in your
+     *             GitHub repository or repositories. Folder names that match the patterns are excluded
+     *             from the index. Folder names that don't match the patterns are included in the index.
+     *             If a folder matches both an exclusion and inclusion pattern, the exclusion pattern
+     *             takes precedence and the folder isn't included in the index.</p>
+     */
+    ExclusionFolderNamePatterns?: string[];
+    /**
+     * <p>A list of regular expression patterns to exclude certain file types in your
+     *             GitHub repository or repositories. File types that match the patterns are excluded
+     *             from the index. File types that don't match the patterns are included in the index.
+     *             If a file matches both an exclusion and inclusion pattern, the exclusion pattern
+     *             takes precedence and the file isn't included in the index.</p>
+     */
+    ExclusionFileTypePatterns?: string[];
+    /**
+     * <p>A list of regular expression patterns to exclude certain file names in your
+     *             GitHub repository or repositories. File names that match the patterns are excluded
+     *             from the index. File names that don't match the patterns are included in the index.
+     *             If a file matches both an exclusion and inclusion pattern, the exclusion pattern
+     *             takes precedence and the file isn't included in the index.</p>
+     */
+    ExclusionFileNamePatterns?: string[];
+    /**
+     * <p>Configuration information of an Amazon Virtual Private Cloud to connect to your
+     *             GitHub. For more information, see <a href="https://docs.aws.amazon.com/kendra/latest/dg/vpc-configuration.html">Configuring a VPC</a>.</p>
+     */
+    VpcConfiguration?: DataSourceVpcConfiguration;
+    /**
+     * <p>A list of <code>DataSourceToIndexFieldMapping</code> objects that map GitHub
+     *             repository attributes or field names to Amazon Kendra index field names.
+     *             To create custom fields, use the <code>UpdateIndex</code> API before you map to
+     *             GitHub fields. For more information, see <a href="https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html">Mapping data source fields</a>.
+     *             The GitHub data source field names must exist in your GitHub custom metadata.</p>
+     */
+    GitHubRepositoryConfigurationFieldMappings?: DataSourceToIndexFieldMapping[];
+    /**
+     * <p>A list of <code>DataSourceToIndexFieldMapping</code> objects that map attributes
+     *             or field names of GitHub commits to Amazon Kendra index field names.
+     *             To create custom fields, use the <code>UpdateIndex</code> API before you map to
+     *             GitHub fields. For more information, see <a href="https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html">Mapping data source fields</a>.
+     *             The GitHub data source field names must exist in your GitHub custom metadata.</p>
+     */
+    GitHubCommitConfigurationFieldMappings?: DataSourceToIndexFieldMapping[];
+    /**
+     * <p>A list of <code>DataSourceToIndexFieldMapping</code> objects that map attributes
+     *             or field names of GitHub issues to Amazon Kendra index field names.
+     *             To create custom fields, use the <code>UpdateIndex</code> API before you map to
+     *             GitHub fields. For more information, see <a href="https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html">Mapping data source fields</a>.
+     *             The GitHub data source field names must exist in your GitHub custom metadata.</p>
+     */
+    GitHubIssueDocumentConfigurationFieldMappings?: DataSourceToIndexFieldMapping[];
+    /**
+     * <p>A list of <code>DataSourceToIndexFieldMapping</code> objects that map attributes
+     *             or field names of GitHub issue comments to Amazon Kendra index field names.
+     *             To create custom fields, use the <code>UpdateIndex</code> API before you map to
+     *             GitHub fields. For more information, see <a href="https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html">Mapping data source fields</a>.
+     *             The GitHub data source field names must exist in your GitHub custom metadata.</p>
+     */
+    GitHubIssueCommentConfigurationFieldMappings?: DataSourceToIndexFieldMapping[];
+    /**
+     * <p>A list of <code>DataSourceToIndexFieldMapping</code> objects that map attributes
+     *             or field names of GitHub issue attachments to Amazon Kendra index field names.
+     *             To create custom fields, use the <code>UpdateIndex</code> API before you map to
+     *             GitHub fields. For more information, see <a href="https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html">Mapping data source fields</a>.
+     *             The GitHub data source field names must exist in your GitHub custom metadata.</p>
+     */
+    GitHubIssueAttachmentConfigurationFieldMappings?: DataSourceToIndexFieldMapping[];
+    /**
+     * <p>A list of <code>DataSourceToIndexFieldMapping</code> objects that map attributes
+     *             or field names of GitHub pull request comments to Amazon Kendra index field names.
+     *             To create custom fields, use the <code>UpdateIndex</code> API before you map to
+     *             GitHub fields. For more information, see <a href="https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html">Mapping data source fields</a>.
+     *             The GitHub data source field names must exist in your GitHub custom metadata.</p>
+     */
+    GitHubPullRequestCommentConfigurationFieldMappings?: DataSourceToIndexFieldMapping[];
+    /**
+     * <p>A list of <code>DataSourceToIndexFieldMapping</code> objects that map attributes
+     *             or field names of GitHub pull requests to Amazon Kendra index field names.
+     *             To create custom fields, use the <code>UpdateIndex</code> API before you map to
+     *             GitHub fields. For more information, see <a href="https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html">Mapping data source fields</a>.
+     *             The GitHub data source field names must exist in your GitHub custom metadata.</p>
+     */
+    GitHubPullRequestDocumentConfigurationFieldMappings?: DataSourceToIndexFieldMapping[];
+    /**
+     * <p>A list of <code>DataSourceToIndexFieldMapping</code> objects that map attributes
+     *             or field names of GitHub pull request attachments to Amazon Kendra index field names.
+     *             To create custom fields, use the <code>UpdateIndex</code> API before you map to
+     *             GitHub fields. For more information, see <a href="https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html">Mapping data source fields</a>.
+     *             The GitHub data source field names must exist in your GitHub custom metadata.</p>
+     */
+    GitHubPullRequestDocumentAttachmentConfigurationFieldMappings?: DataSourceToIndexFieldMapping[];
+}
+export declare namespace GitHubConfiguration {
+    /**
+     * @internal
+     */
+    const filterSensitiveLog: (obj: GitHubConfiguration) => any;
+}
 /**
  * <p>Provides the configuration information to connect to
  *             Google Drive as your data source.</p>
@@ -2053,6 +2332,10 @@ export declare enum IssueSubEntity {
     COMMENTS = "COMMENTS",
     WORKLOGS = "WORKLOGS"
 }
+/**
+ * <p>Provides the configuration information to connect to Jira as your
+ *             data source.</p>
+ */
 export interface JiraConfiguration {
     /**
      * <p>The URL of the Jira account. For example, company.attlassian.net or
@@ -2067,9 +2350,7 @@ export interface JiraConfiguration {
      *             contain a JSON structure with the following keys:</p>
      *         <ul>
      *             <li>
-     *                 <p>jira-id—The Active Directory user name, along with the
-     *                     Domain Name System (DNS) domain name. For example,
-     *                     <i>user@corp.example.com</i>.</p>
+     *                 <p>jira-id—The ID of the Jira account.</p>
      *             </li>
      *             <li>
      *                 <p>jiraCredentials—The password of the Jira account user.</p>
@@ -3583,6 +3864,11 @@ export interface DataSourceConfiguration {
      *             data source.</p>
      */
     JiraConfiguration?: JiraConfiguration;
+    /**
+     * <p>Provides the configuration information to connect to GitHub as
+     *             your data source.</p>
+     */
+    GitHubConfiguration?: GitHubConfiguration;
 }
 export declare namespace DataSourceConfiguration {
     /**
@@ -3619,6 +3905,7 @@ export declare enum DataSourceType {
     CUSTOM = "CUSTOM",
     DATABASE = "DATABASE",
     FSX = "FSX",
+    GITHUB = "GITHUB",
     GOOGLEDRIVE = "GOOGLEDRIVE",
     JIRA = "JIRA",
     ONEDRIVE = "ONEDRIVE",
@@ -3933,14 +4220,14 @@ export declare enum IndexEdition {
     ENTERPRISE_EDITION = "ENTERPRISE_EDITION"
 }
 /**
- * <p>Provides the identifier of the KMScustomer master key (CMK)
- *             used to encrypt data indexed by Amazon Kendra. Amazon Kendra doesn't support
- *             asymmetric CMKs.</p>
+ * <p>Provides the identifier of the KMS key used to
+ *             encrypt data indexed by Amazon Kendra. Amazon Kendra doesn't
+ *             support asymmetric keys.</p>
  */
 export interface ServerSideEncryptionConfiguration {
     /**
-     * <p>The identifier of the KMScustomer master key (CMK). Amazon Kendra
-     *             doesn't support asymmetric CMKs.</p>
+     * <p>The identifier of the KMS key. Amazon Kendra
+     *             doesn't support asymmetric keys.</p>
      */
     KmsKeyId?: string;
 }

package/dist-types/ts3.4/models/models_0.d.ts

@@ -904,6 +904,106 @@ export declare namespace FsxConfiguration {
     const filterSensitiveLog: (obj: FsxConfiguration) => any;
 }
 
+export interface GitHubDocumentCrawlProperties {
+    
+    CrawlRepositoryDocuments?: boolean;
+    
+    CrawlIssue?: boolean;
+    
+    CrawlIssueComment?: boolean;
+    
+    CrawlIssueCommentAttachment?: boolean;
+    
+    CrawlPullRequest?: boolean;
+    
+    CrawlPullRequestComment?: boolean;
+    
+    CrawlPullRequestCommentAttachment?: boolean;
+}
+export declare namespace GitHubDocumentCrawlProperties {
+    
+    const filterSensitiveLog: (obj: GitHubDocumentCrawlProperties) => any;
+}
+
+export interface OnPremiseConfiguration {
+    
+    HostUrl: string | undefined;
+    
+    OrganizationName: string | undefined;
+    
+    SslCertificateS3Path: S3Path | undefined;
+}
+export declare namespace OnPremiseConfiguration {
+    
+    const filterSensitiveLog: (obj: OnPremiseConfiguration) => any;
+}
+
+export interface SaaSConfiguration {
+    
+    OrganizationName: string | undefined;
+    
+    HostUrl: string | undefined;
+}
+export declare namespace SaaSConfiguration {
+    
+    const filterSensitiveLog: (obj: SaaSConfiguration) => any;
+}
+export declare enum Type {
+    ON_PREMISE = "ON_PREMISE",
+    SAAS = "SAAS"
+}
+
+export interface GitHubConfiguration {
+    
+    SaaSConfiguration?: SaaSConfiguration;
+    
+    OnPremiseConfiguration?: OnPremiseConfiguration;
+    
+    Type?: Type | string;
+    
+    SecretArn: string | undefined;
+    
+    UseChangeLog?: boolean;
+    
+    GitHubDocumentCrawlProperties?: GitHubDocumentCrawlProperties;
+    
+    RepositoryFilter?: string[];
+    
+    InclusionFolderNamePatterns?: string[];
+    
+    InclusionFileTypePatterns?: string[];
+    
+    InclusionFileNamePatterns?: string[];
+    
+    ExclusionFolderNamePatterns?: string[];
+    
+    ExclusionFileTypePatterns?: string[];
+    
+    ExclusionFileNamePatterns?: string[];
+    
+    VpcConfiguration?: DataSourceVpcConfiguration;
+    
+    GitHubRepositoryConfigurationFieldMappings?: DataSourceToIndexFieldMapping[];
+    
+    GitHubCommitConfigurationFieldMappings?: DataSourceToIndexFieldMapping[];
+    
+    GitHubIssueDocumentConfigurationFieldMappings?: DataSourceToIndexFieldMapping[];
+    
+    GitHubIssueCommentConfigurationFieldMappings?: DataSourceToIndexFieldMapping[];
+    
+    GitHubIssueAttachmentConfigurationFieldMappings?: DataSourceToIndexFieldMapping[];
+    
+    GitHubPullRequestCommentConfigurationFieldMappings?: DataSourceToIndexFieldMapping[];
+    
+    GitHubPullRequestDocumentConfigurationFieldMappings?: DataSourceToIndexFieldMapping[];
+    
+    GitHubPullRequestDocumentAttachmentConfigurationFieldMappings?: DataSourceToIndexFieldMapping[];
+}
+export declare namespace GitHubConfiguration {
+    
+    const filterSensitiveLog: (obj: GitHubConfiguration) => any;
+}
+
 export interface GoogleDriveConfiguration {
     
     SecretArn: string | undefined;
@@ -929,6 +1029,7 @@ export declare enum IssueSubEntity {
     COMMENTS = "COMMENTS",
     WORKLOGS = "WORKLOGS"
 }
+
 export interface JiraConfiguration {
     
     JiraAccountUrl: string | undefined;
@@ -1460,6 +1561,8 @@ export interface DataSourceConfiguration {
     QuipConfiguration?: QuipConfiguration;
     
     JiraConfiguration?: JiraConfiguration;
+    
+    GitHubConfiguration?: GitHubConfiguration;
 }
 export declare namespace DataSourceConfiguration {
     
@@ -1482,6 +1585,7 @@ export declare enum DataSourceType {
     CUSTOM = "CUSTOM",
     DATABASE = "DATABASE",
     FSX = "FSX",
+    GITHUB = "GITHUB",
     GOOGLEDRIVE = "GOOGLEDRIVE",
     JIRA = "JIRA",
     ONEDRIVE = "ONEDRIVE",

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@aws-sdk/client-kendra",
   "description": "AWS SDK for JavaScript Kendra Client for Node.js, Browser and React Native",
-  "version": "3.95.0",
+  "version": "3.104.0",
   "scripts": {
     "build": "concurrently 'yarn:build:cjs' 'yarn:build:es' 'yarn:build:types'",
     "build:cjs": "tsc -p tsconfig.cjs.json",
@@ -18,9 +18,9 @@
   "dependencies": {
     "@aws-crypto/sha256-browser": "2.0.0",
     "@aws-crypto/sha256-js": "2.0.0",
-    "@aws-sdk/client-sts": "3.95.0",
+    "@aws-sdk/client-sts": "3.100.0",
     "@aws-sdk/config-resolver": "3.80.0",
-    "@aws-sdk/credential-provider-node": "3.95.0",
+    "@aws-sdk/credential-provider-node": "3.100.0",
     "@aws-sdk/fetch-http-handler": "3.78.0",
     "@aws-sdk/hash-node": "3.78.0",
     "@aws-sdk/invalid-dependency": "3.78.0",
@@ -35,15 +35,15 @@
     "@aws-sdk/node-config-provider": "3.80.0",
     "@aws-sdk/node-http-handler": "3.94.0",
     "@aws-sdk/protocol-http": "3.78.0",
-    "@aws-sdk/smithy-client": "3.85.0",
+    "@aws-sdk/smithy-client": "3.99.0",
     "@aws-sdk/types": "3.78.0",
     "@aws-sdk/url-parser": "3.78.0",
     "@aws-sdk/util-base64-browser": "3.58.0",
     "@aws-sdk/util-base64-node": "3.55.0",
     "@aws-sdk/util-body-length-browser": "3.55.0",
     "@aws-sdk/util-body-length-node": "3.55.0",
-    "@aws-sdk/util-defaults-mode-browser": "3.85.0",
-    "@aws-sdk/util-defaults-mode-node": "3.85.0",
+    "@aws-sdk/util-defaults-mode-browser": "3.99.0",
+    "@aws-sdk/util-defaults-mode-node": "3.99.0",
     "@aws-sdk/util-user-agent-browser": "3.78.0",
     "@aws-sdk/util-user-agent-node": "3.80.0",
     "@aws-sdk/util-utf8-browser": "3.55.0",