From 90991637433913861d343f647f0c1561713a724a Mon Sep 17 00:00:00 2001 From: awstools Date: Fri, 22 Mar 2024 18:13:20 +0000 Subject: [PATCH] feat(client-kendra): Documentation update, March 2024. Corrects some docs for Amazon Kendra. --- .../src/commands/DeleteIndexCommand.ts | 2 +- .../src/commands/DeleteThesaurusCommand.ts | 2 +- .../src/commands/DescribeIndexCommand.ts | 2 +- .../src/commands/DescribeThesaurusCommand.ts | 2 +- .../src/commands/UpdateDataSourceCommand.ts | 2 +- .../src/commands/UpdateIndexCommand.ts | 2 +- clients/client-kendra/src/models/models_0.ts | 205 +++++++++++++++--- clients/client-kendra/src/models/models_1.ts | 98 +++++---- codegen/sdk-codegen/aws-models/kendra.json | 86 ++++---- 9 files changed, 273 insertions(+), 128 deletions(-) diff --git a/clients/client-kendra/src/commands/DeleteIndexCommand.ts b/clients/client-kendra/src/commands/DeleteIndexCommand.ts index 3196161f58f0..02ce4a58583e 100644 --- a/clients/client-kendra/src/commands/DeleteIndexCommand.ts +++ b/clients/client-kendra/src/commands/DeleteIndexCommand.ts @@ -27,7 +27,7 @@ export interface DeleteIndexCommandInput extends DeleteIndexRequest {} export interface DeleteIndexCommandOutput extends __MetadataBearer {} /** - *

Deletes an existing Amazon Kendra index. An exception is not thrown if the index is + *

Deletes an 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 API is set to * DELETING.

diff --git a/clients/client-kendra/src/commands/DeleteThesaurusCommand.ts b/clients/client-kendra/src/commands/DeleteThesaurusCommand.ts index a80f19c8e307..4eb252c8dc2d 100644 --- a/clients/client-kendra/src/commands/DeleteThesaurusCommand.ts +++ b/clients/client-kendra/src/commands/DeleteThesaurusCommand.ts @@ -27,7 +27,7 @@ export interface DeleteThesaurusCommandInput extends DeleteThesaurusRequest {} export interface DeleteThesaurusCommandOutput extends __MetadataBearer {} /** - *

Deletes an existing Amazon Kendra thesaurus. + *

Deletes an Amazon Kendra thesaurus. *

* @example * Use a bare-bones client and the command you need to make an API call. diff --git a/clients/client-kendra/src/commands/DescribeIndexCommand.ts b/clients/client-kendra/src/commands/DescribeIndexCommand.ts index a9cb0b47b7f8..5968e3b5726d 100644 --- a/clients/client-kendra/src/commands/DescribeIndexCommand.ts +++ b/clients/client-kendra/src/commands/DescribeIndexCommand.ts @@ -31,7 +31,7 @@ export interface DescribeIndexCommandInput extends DescribeIndexRequest {} export interface DescribeIndexCommandOutput extends DescribeIndexResponse, __MetadataBearer {} /** - *

Gets information about an existing Amazon Kendra index.

+ *

Gets information about an Amazon Kendra index.

* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript diff --git a/clients/client-kendra/src/commands/DescribeThesaurusCommand.ts b/clients/client-kendra/src/commands/DescribeThesaurusCommand.ts index a831789640a6..aa9d4d06ac2f 100644 --- a/clients/client-kendra/src/commands/DescribeThesaurusCommand.ts +++ b/clients/client-kendra/src/commands/DescribeThesaurusCommand.ts @@ -27,7 +27,7 @@ export interface DescribeThesaurusCommandInput extends DescribeThesaurusRequest export interface DescribeThesaurusCommandOutput extends DescribeThesaurusResponse, __MetadataBearer {} /** - *

Gets information about an existing Amazon Kendra thesaurus.

+ *

Gets information about an Amazon Kendra thesaurus.

* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript diff --git a/clients/client-kendra/src/commands/UpdateDataSourceCommand.ts b/clients/client-kendra/src/commands/UpdateDataSourceCommand.ts index d04ca85eb8f2..58f763821c7c 100644 --- a/clients/client-kendra/src/commands/UpdateDataSourceCommand.ts +++ b/clients/client-kendra/src/commands/UpdateDataSourceCommand.ts @@ -27,7 +27,7 @@ export interface UpdateDataSourceCommandInput extends UpdateDataSourceRequest {} export interface UpdateDataSourceCommandOutput extends __MetadataBearer {} /** - *

Updates an existing Amazon Kendra data source connector.

+ *

Updates an Amazon Kendra data source connector.

* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript diff --git a/clients/client-kendra/src/commands/UpdateIndexCommand.ts b/clients/client-kendra/src/commands/UpdateIndexCommand.ts index 8d56f3574b97..eda54af46504 100644 --- a/clients/client-kendra/src/commands/UpdateIndexCommand.ts +++ b/clients/client-kendra/src/commands/UpdateIndexCommand.ts @@ -27,7 +27,7 @@ export interface UpdateIndexCommandInput extends UpdateIndexRequest {} export interface UpdateIndexCommandOutput extends __MetadataBearer {} /** - *

Updates an existing Amazon Kendra index.

+ *

Updates an Amazon Kendra index.

* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript diff --git a/clients/client-kendra/src/models/models_0.ts b/clients/client-kendra/src/models/models_0.ts index 01ca5183c842..9809acacc1c2 100644 --- a/clients/client-kendra/src/models/models_0.ts +++ b/clients/client-kendra/src/models/models_0.ts @@ -2707,6 +2707,16 @@ export type FsxFileSystemType = (typeof FsxFileSystemType)[keyof typeof FsxFileS /** *

Provides the configuration information to connect to Amazon FSx as your data * source.

+ * + *

Amazon Kendra now supports an upgraded Amazon FSx Windows connector.

+ *

You must now use the TemplateConfiguration object instead of the + * FsxConfiguration object to configure your connector.

+ *

Connectors configured using the older console and API architecture will continue to + * function as configured. However, you won't be able to edit or update them. If you want + * to edit or update your connector configuration, you must create a new connector.

+ *

We recommended migrating your connector workflow to the upgraded version. Support for + * connectors configured using the older architecture is scheduled to end by June 2024.

+ * * @public */ export interface FsxConfiguration { @@ -2854,7 +2864,7 @@ export interface OnPremiseConfiguration { HostUrl: string | undefined; /** - *

The name of the organization of the GitHub Enterprise Server (in-premise) account you + *

The name of the organization of the GitHub Enterprise Server (on-premises) account you * want to connect to. You can find your organization name by logging into GitHub desktop * and selecting Your organizations under your profile * picture dropdown.

@@ -2912,6 +2922,18 @@ export type Type = (typeof Type)[keyof typeof Type]; /** *

Provides the configuration information to connect to GitHub as your data * source.

+ * + *

Amazon Kendra now supports an upgraded GitHub connector.

+ *

You must now use the TemplateConfiguration object instead of the + * GitHubConfiguration object to configure your connector.

+ *

Connectors configured using the older console and API architecture will continue + * to function as configured. However, you won’t be able to edit or update them. If you + * want to edit or update your connector configuration, you must create a new + * connector.

+ *

We recommended migrating your connector workflow to the upgraded version. Support + * for connectors configured using the older architecture is scheduled to end by June + * 2024.

+ * * @public */ export interface GitHubConfiguration { @@ -3577,6 +3599,16 @@ export interface DocumentsMetadataConfiguration { /** *

Provides the configuration information to connect to an Amazon S3 * bucket.

+ * + *

Amazon Kendra now supports an upgraded Amazon S3 connector.

+ *

You must now use the TemplateConfiguration object instead of the + * S3DataSourceConfiguration object to configure your connector.

+ *

Connectors configured using the older console and API architecture will continue to + * function as configured. However, you won't be able to edit or update them. If you want + * to edit or update your connector configuration, you must create a new connector.

+ *

We recommended migrating your connector workflow to the upgraded version. Support for + * connectors configured using the older architecture is scheduled to end by June 2024.

+ * * @public */ export interface S3DataSourceConfiguration { @@ -3593,56 +3625,105 @@ export interface S3DataSourceConfiguration { InclusionPrefixes?: string[]; /** - *

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

- *

Some examples - * are:

+ *

A list of glob patterns (patterns that can expand a wildcard pattern into a list of + * path names that match the given pattern) for certain file names and file types to include + * in your index. If a document matches both an inclusion and exclusion prefix or pattern, + * the exclusion prefix takes precendence and the document is not indexed. Examples of glob + * patterns include:

* + *

For more examples, see Use of Exclude and + * Include Filters in the Amazon Web Services CLI Command Reference.

* @public */ InclusionPatterns?: string[]; /** - *

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

- *

Some examples - * are:

+ *

A list of glob patterns (patterns that can expand a wildcard pattern into a list of + * path names that match the given pattern) for certain file names and file types to exclude + * from your index. If a document matches both an inclusion and exclusion prefix or pattern, + * the exclusion prefix takes precendence and the document is not indexed. Examples of glob + * patterns include:

* + *

For more examples, see Use of Exclude and + * Include Filters in the Amazon Web Services CLI Command Reference.

* @public */ ExclusionPatterns?: string[]; @@ -4409,6 +4490,16 @@ export type SlackEntity = (typeof SlackEntity)[keyof typeof SlackEntity]; /** *

Provides the configuration information to connect to Slack as your data source.

+ * + *

Amazon Kendra now supports an upgraded Slack connector.

+ *

You must now use the TemplateConfiguration object instead of the + * SlackConfiguration object to configure your connector.

+ *

Connectors configured using the older console and API architecture will continue to + * function as configured. However, you won’t be able to edit or update them. If you want + * to edit or update your connector configuration, you must create a new connector.

+ *

We recommended migrating your connector workflow to the upgraded version. Support for + * connectors configured using the older architecture is scheduled to end by June 2024.

+ * * @public */ export interface SlackConfiguration { @@ -4857,6 +4948,16 @@ export interface DataSourceConfiguration { /** *

Provides the configuration information to connect to an Amazon S3 bucket as your * data source.

+ * + *

Amazon Kendra now supports an upgraded Amazon S3 connector.

+ *

You must now use the TemplateConfiguration object instead of the + * S3DataSourceConfiguration object to configure your connector.

+ *

Connectors configured using the older console and API architecture will continue to + * function as configured. However, you won't be able to edit or update them. If you want + * to edit or update your connector configuration, you must create a new connector.

+ *

We recommended migrating your connector workflow to the upgraded version. Support for + * connectors configured using the older architecture is scheduled to end by June 2024.

+ * * @public */ S3Configuration?: S3DataSourceConfiguration; @@ -4927,12 +5028,32 @@ export interface DataSourceConfiguration { /** *

Provides the configuration information to connect to Amazon FSx as your data * source.

+ * + *

Amazon Kendra now supports an upgraded Amazon FSx Windows connector.

+ *

You must now use the TemplateConfiguration object instead of the + * FsxConfiguration object to configure your connector.

+ *

Connectors configured using the older console and API architecture will continue to + * function as configured. However, you won't be able to edit or update them. If you want + * to edit or update your connector configuration, you must create a new connector.

+ *

We recommended migrating your connector workflow to the upgraded version. Support for + * connectors configured using the older architecture is scheduled to end by June 2024.

+ * * @public */ FsxConfiguration?: FsxConfiguration; /** *

Provides the configuration information to connect to Slack as your data source.

+ * + *

Amazon Kendra now supports an upgraded Slack connector.

+ *

You must now use the TemplateConfiguration object instead of the + * SlackConfiguration object to configure your connector.

+ *

Connectors configured using the older console and API architecture will continue to + * function as configured. However, you won't be able to edit or update them. If you want + * to edit or update your connector configuration, you must create a new connector.

+ *

We recommended migrating your connector workflow to the upgraded version. Support for + * connectors configured using the older architecture is scheduled to end by June 2024.

+ * * @public */ SlackConfiguration?: SlackConfiguration; @@ -4957,6 +5078,18 @@ export interface DataSourceConfiguration { /** *

Provides the configuration information to connect to GitHub as your data source.

+ * + *

Amazon Kendra now supports an upgraded GitHub connector.

+ *

You must now use the TemplateConfiguration object instead of the + * GitHubConfiguration object to configure your connector.

+ *

Connectors configured using the older console and API architecture will continue + * to function as configured. However, you won’t be able to edit or update them. If you + * want to edit or update your connector configuration, you must create a new + * connector.

+ *

We recommended migrating your connector workflow to the upgraded version. Support + * for connectors configured using the older architecture is scheduled to end by June + * 2024.

+ * * @public */ GitHubConfiguration?: GitHubConfiguration; @@ -4965,9 +5098,12 @@ export interface DataSourceConfiguration { * @deprecated * *

Provides the configuration information to connect to Alfresco as your data source.

- *

Support for AlfrescoConfiguration ended May 2023. - * We recommend migrating to or using the Alfresco data source template - * schema / TemplateConfiguration API.

+ * + *

Support for AlfrescoConfiguration ended May 2023. + * We recommend migrating to or using the Alfresco data source template + * schema / TemplateConfiguration + * API.

+ * * @public */ AlfrescoConfiguration?: AlfrescoConfiguration; @@ -5906,7 +6042,8 @@ export interface CreateIndexRequest { /** *

Gets users and groups from IAM Identity Center - * identity source. To configure this, see UserGroupResolutionConfiguration.

+ * identity source. To configure this, see UserGroupResolutionConfiguration. This is useful for user context filtering, where + * search results are filtered based on the user or their group access to documents.

* @public */ UserGroupResolutionConfiguration?: UserGroupResolutionConfiguration; @@ -6904,8 +7041,7 @@ export interface Relevance { /** *

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.

+ * 1 is "fresher" than document 2. Only applies to DATE fields.

* @public */ Freshness?: boolean; @@ -6937,14 +7073,14 @@ export interface Relevance { *

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.

+ *

Only applies to LONG fields.

* @public */ RankOrder?: Order; /** *

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 + * 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 @@ -7133,14 +7269,14 @@ export interface DescribeIndexResponse { Edition?: IndexEdition; /** - *

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

+ *

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

* @public */ RoleArn?: string; /** - *

The identifier of the KMScustomer master key (CMK) that is used to encrypt + *

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

* @public */ @@ -7167,7 +7303,7 @@ export interface DescribeIndexResponse { CreatedAt?: Date; /** - *

The Unix when the index was last updated.

+ *

The Unix timestamp when the index was last updated.

* @public */ UpdatedAt?: Date; @@ -7217,8 +7353,9 @@ export interface DescribeIndexResponse { UserContextPolicy?: UserContextPolicy; /** - *

Whether you have enabled the configuration for fetching access levels of groups and - * users from an IAM Identity Center identity source.

+ *

Whether you have enabled IAM Identity Center identity source for your + * users and groups. This is useful for user context filtering, where + * search results are filtered based on the user or their group access to documents.

* @public */ UserGroupResolutionConfiguration?: UserGroupResolutionConfiguration; diff --git a/clients/client-kendra/src/models/models_1.ts b/clients/client-kendra/src/models/models_1.ts index 7aed49bca0eb..caa06e63bf3e 100644 --- a/clients/client-kendra/src/models/models_1.ts +++ b/clients/client-kendra/src/models/models_1.ts @@ -148,7 +148,9 @@ export interface TableExcerpt { */ export interface QueryResultItem { /** - *

The identifier for the query result.

+ *

The unique identifier for the query result item id (Id) and the query + * result item document id (DocumentId) combined. The value of this field changes + * with every request, even when you have the same documents.

* @public */ Id?: string; @@ -202,18 +204,18 @@ export interface QueryResultItem { DocumentURI?: string; /** - *

An array of document fields/attributes assigned to a document in the search results. - * For example, the document author (_author) or the source URI - * (_source_uri) of the document.

+ *

An array of document fields/attributes assigned to a document in the search results. For + * example, the document author (_author) or the source URI + * (_source_uri) of the document.

* @public */ DocumentAttributes?: DocumentAttribute[]; /** - *

Indicates the confidence level of Amazon Kendra providing a relevant result for - * the query. Each result is placed into a bin that indicates the confidence, - * VERY_HIGH, HIGH, MEDIUM and LOW. - * You can use the score to determine if a response meets the confidence needed for your + *

Indicates the confidence level of Amazon Kendra providing a relevant result for the + * query. Each result is placed into a bin that indicates the confidence, + * VERY_HIGH, HIGH, MEDIUM and LOW. You + * can use the score to determine if a response meets the confidence needed for your * application.

*

The field is only set to LOW when the Type field is set to * DOCUMENT and Amazon Kendra is not confident that the result is @@ -224,7 +226,8 @@ export interface QueryResultItem { /** *

A token that identifies a particular result from a particular query. Use this token to - * provide click-through feedback for the result. For more information, see Submitting feedback.

+ * provide click-through feedback for the result. For more information, see Submitting + * feedback.

* @public */ FeedbackToken?: string; @@ -844,7 +847,7 @@ export interface UpdateIndexRequest { Id: string | undefined; /** - *

The name of the index you want to update.

+ *

A new name for the index.

* @public */ Name?: string; @@ -893,8 +896,9 @@ export interface UpdateIndexRequest { UserContextPolicy?: UserContextPolicy; /** - *

Enables fetching access levels of groups and users from an IAM Identity Center - * identity source. To configure this, see UserGroupResolutionConfiguration.

+ *

Gets users and groups from IAM Identity Center + * identity source. To configure this, see UserGroupResolutionConfiguration. This is useful for user context filtering, where + * search results are filtered based on the user or their group access to documents.

* @public */ UserGroupResolutionConfiguration?: UserGroupResolutionConfiguration; @@ -1109,8 +1113,8 @@ export interface Facet { } /** - *

Provides the count of documents that match a particular document attribute or - * field when doing a faceted search.

+ *

Provides the count of documents that match a particular document attribute or field when + * doing a faceted search.

* @public */ export interface DocumentAttributeValueCountPair { @@ -1121,8 +1125,8 @@ export interface DocumentAttributeValueCountPair { DocumentAttributeValue?: DocumentAttributeValue; /** - *

The number of documents in the response that have the attribute/field value for - * the key.

+ *

The number of documents in the response that have the attribute/field value for the + * key.

* @public */ Count?: number; @@ -1173,14 +1177,13 @@ export interface FacetResult { /** *

Filters the search results based on document attributes or fields.

- *

You can filter results using attributes for your particular documents. - * The attributes must exist in your index. For example, if your documents - * include the custom attribute "Department", you can filter documents that - * belong to the "HR" department. You would use the EqualsTo - * operation to filter results or documents with "Department" equals to "HR".

- *

You can use AndAllFilters and AndOrFilters in - * combination with each other or with other operations such as EqualsTo. - * For example:

+ *

You can filter results using attributes for your particular documents. The attributes + * must exist in your index. For example, if your documents include the custom attribute + * "Department", you can filter documents that belong to the "HR" department. You would use + * the EqualsTo operation to filter results or documents with "Department" equals + * to "HR".

+ *

You can use AndAllFilters and AndOrFilters in combination with + * each other or with other operations such as EqualsTo. For example:

*

* AndAllFilters *

@@ -1202,18 +1205,18 @@ export interface FacetResult { * * *

This example filters results or documents that belong to the HR department - * and belong to projects that contain "new hires" - * or "new hiring" in the project name (must use - * ContainAny with StringListValue). This example is - * filtering with a depth of 2.

+ * and belong to projects that contain "new hires" + * or "new hiring" in the project name (must use + * ContainAny with StringListValue). This example is filtering + * with a depth of 2.

*

You cannot filter more than a depth of 2, otherwise you receive a - * ValidationException exception with the message "AttributeFilter - * cannot have a depth of more than 2." Also, if you use more than 10 attribute - * filters in a given list for AndAllFilters or OrAllFilters, - * you receive a ValidationException with the message "AttributeFilter - * cannot have a length of more than 10".

- *

For examples of using AttributeFilter, see Using - * document attributes to filter search results.

+ * ValidationException exception with the message "AttributeFilter cannot have + * a depth of more than 2." Also, if you use more than 10 attribute filters in a given list + * for AndAllFilters or OrAllFilters, you receive a + * ValidationException with the message "AttributeFilter cannot have a length + * of more than 10".

+ *

For examples of using AttributeFilter, see Using document attributes to + * filter search results.

* @public */ export interface AttributeFilter { @@ -1256,8 +1259,8 @@ export interface AttributeFilter { ContainsAny?: DocumentAttribute; /** - *

Performs a greater than operation on document attributes/fields and their - * values. Use with the document attribute + *

Performs a greater than operation on document attributes/fields and their values. Use + * with the document attribute * type * Date or Long.

* @public @@ -1265,8 +1268,8 @@ export interface AttributeFilter { GreaterThan?: DocumentAttribute; /** - *

Performs a greater or equals than operation on document attributes/fields and - * their values. Use with the document attribute + *

Performs a greater or equals than operation on document attributes/fields and their + * values. Use with the document attribute * type * Date or Long.

* @public @@ -1274,8 +1277,8 @@ export interface AttributeFilter { GreaterThanOrEquals?: DocumentAttribute; /** - *

Performs a less than operation on document attributes/fields and their values. - * Use with the document attribute + *

Performs a less than operation on document attributes/fields and their values. Use with + * the document attribute * type * Date or Long.

* @public @@ -1283,8 +1286,8 @@ export interface AttributeFilter { LessThan?: DocumentAttribute; /** - *

Performs a less than or equals operation on document attributes/fields and - * their values. Use with the document attribute + *

Performs a less than or equals operation on document attributes/fields and their values. + * Use with the document attribute * type * Date or Long.

* @public @@ -1398,7 +1401,10 @@ export interface RetrieveRequest { /** *

The input query text to retrieve relevant passages for the search. Amazon Kendra * truncates queries at 30 token words, which excludes punctuation and stop words. - * Truncation still applies if you use Boolean or more advanced, complex queries.

+ * Truncation still applies if you use Boolean or more advanced, complex queries. For + * example, Timeoff AND October AND Category:HR is counted as 3 tokens: + * timeoff, october, hr. For more information, + * see Searching with advanced query syntax in the Amazon Kendra Developer Guide.

* @public */ QueryText: string | undefined; @@ -1521,7 +1527,9 @@ export interface QueryRequest { /** *

The input query text for the search. Amazon Kendra truncates queries at 30 token * words, which excludes punctuation and stop words. Truncation still applies if you use - * Boolean or more advanced, complex queries.

+ * Boolean or more advanced, complex queries. For example, Timeoff AND October AND + * Category:HR is counted as 3 tokens: timeoff, october, + * hr. For more information, see Searching with advanced query syntax in the Amazon Kendra Developer Guide.

* @public */ QueryText?: string; diff --git a/codegen/sdk-codegen/aws-models/kendra.json b/codegen/sdk-codegen/aws-models/kendra.json index f3aec1eecf17..59e852007188 100644 --- a/codegen/sdk-codegen/aws-models/kendra.json +++ b/codegen/sdk-codegen/aws-models/kendra.json @@ -1477,42 +1477,42 @@ "ContainsAll": { "target": "com.amazonaws.kendra#DocumentAttribute", "traits": { - "smithy.api#documentation": "

Returns true when a document contains all of the specified document attributes/fields. \n This filter is only applicable to StringListValue.

" + "smithy.api#documentation": "

Returns true when a document contains all of the specified document attributes/fields.\n This filter is only applicable to StringListValue.

" } }, "ContainsAny": { "target": "com.amazonaws.kendra#DocumentAttribute", "traits": { - "smithy.api#documentation": "

Returns true when a document contains any of the specified document attributes/fields. \n This filter is only applicable to StringListValue.

" + "smithy.api#documentation": "

Returns true when a document contains any of the specified document attributes/fields.\n This filter is only applicable to StringListValue.

" } }, "GreaterThan": { "target": "com.amazonaws.kendra#DocumentAttribute", "traits": { - "smithy.api#documentation": "

Performs a greater than operation on document attributes/fields and their \n values. Use with the document attribute \n type\n Date or Long.

" + "smithy.api#documentation": "

Performs a greater than operation on document attributes/fields and their values. Use\n with the document attribute\n type\n Date or Long.

" } }, "GreaterThanOrEquals": { "target": "com.amazonaws.kendra#DocumentAttribute", "traits": { - "smithy.api#documentation": "

Performs a greater or equals than operation on document attributes/fields and \n their values. Use with the document attribute \n type\n Date or Long.

" + "smithy.api#documentation": "

Performs a greater or equals than operation on document attributes/fields and their\n values. Use with the document attribute\n type\n Date or Long.

" } }, "LessThan": { "target": "com.amazonaws.kendra#DocumentAttribute", "traits": { - "smithy.api#documentation": "

Performs a less than operation on document attributes/fields and their values. \n Use with the document attribute \n type\n Date or Long.

" + "smithy.api#documentation": "

Performs a less than operation on document attributes/fields and their values. Use with\n the document attribute\n type\n Date or Long.

" } }, "LessThanOrEquals": { "target": "com.amazonaws.kendra#DocumentAttribute", "traits": { - "smithy.api#documentation": "

Performs a less than or equals operation on document attributes/fields and \n their values. Use with the document attribute \n type\n Date or Long.

" + "smithy.api#documentation": "

Performs a less than or equals operation on document attributes/fields and their values.\n Use with the document attribute\n type\n Date or Long.

" } } }, "traits": { - "smithy.api#documentation": "

Filters the search results based on document attributes or fields.

\n

You can filter results using attributes for your particular documents. \n The attributes must exist in your index. For example, if your documents \n include the custom attribute \"Department\", you can filter documents that \n belong to the \"HR\" department. You would use the EqualsTo \n operation to filter results or documents with \"Department\" equals to \"HR\".

\n

You can use AndAllFilters and AndOrFilters in \n combination with each other or with other operations such as EqualsTo. \n For example:

\n

\n AndAllFilters\n

\n \n

This example filters results or documents that belong to the HR department \n and belong to projects that contain \"new hires\" \n or \"new hiring\" in the project name (must use \n ContainAny with StringListValue). This example is \n filtering with a depth of 2.

\n

You cannot filter more than a depth of 2, otherwise you receive a \n ValidationException exception with the message \"AttributeFilter \n cannot have a depth of more than 2.\" Also, if you use more than 10 attribute \n filters in a given list for AndAllFilters or OrAllFilters, \n you receive a ValidationException with the message \"AttributeFilter \n cannot have a length of more than 10\".

\n

For examples of using AttributeFilter, see Using \n document attributes to filter search results.

" + "smithy.api#documentation": "

Filters the search results based on document attributes or fields.

\n

You can filter results using attributes for your particular documents. The attributes\n must exist in your index. For example, if your documents include the custom attribute\n \"Department\", you can filter documents that belong to the \"HR\" department. You would use\n the EqualsTo operation to filter results or documents with \"Department\" equals\n to \"HR\".

\n

You can use AndAllFilters and AndOrFilters in combination with\n each other or with other operations such as EqualsTo. For example:

\n

\n AndAllFilters\n

\n \n

This example filters results or documents that belong to the HR department\n and belong to projects that contain \"new hires\"\n or \"new hiring\" in the project name (must use\n ContainAny with StringListValue). This example is filtering\n with a depth of 2.

\n

You cannot filter more than a depth of 2, otherwise you receive a\n ValidationException exception with the message \"AttributeFilter cannot have\n a depth of more than 2.\" Also, if you use more than 10 attribute filters in a given list\n for AndAllFilters or OrAllFilters, you receive a\n ValidationException with the message \"AttributeFilter cannot have a length\n of more than 10\".

\n

For examples of using AttributeFilter, see Using document attributes to\n filter search results.

" } }, "com.amazonaws.kendra#AttributeFilterList": { @@ -4011,7 +4011,7 @@ "UserGroupResolutionConfiguration": { "target": "com.amazonaws.kendra#UserGroupResolutionConfiguration", "traits": { - "smithy.api#documentation": "

Gets users and groups from IAM Identity Center \n identity source. To configure this, see UserGroupResolutionConfiguration.

" + "smithy.api#documentation": "

Gets users and groups from IAM Identity Center \n identity source. To configure this, see UserGroupResolutionConfiguration. This is useful for user context filtering, where\n search results are filtered based on the user or their group access to documents.

" } } }, @@ -4279,7 +4279,7 @@ "S3Configuration": { "target": "com.amazonaws.kendra#S3DataSourceConfiguration", "traits": { - "smithy.api#documentation": "

Provides the configuration information to connect to an Amazon S3 bucket as your\n data source.

" + "smithy.api#documentation": "

Provides the configuration information to connect to an Amazon S3 bucket as your\n data source.

\n \n

Amazon Kendra now supports an upgraded Amazon S3 connector.

\n

You must now use the TemplateConfiguration object instead of the \n S3DataSourceConfiguration object to configure your connector.

\n

Connectors configured using the older console and API architecture will continue to\n function as configured. However, you won't be able to edit or update them. If you want\n to edit or update your connector configuration, you must create a new connector.

\n

We recommended migrating your connector workflow to the upgraded version. Support for \n connectors configured using the older architecture is scheduled to end by June 2024.

\n " } }, "SharePointConfiguration": { @@ -4336,13 +4336,13 @@ "FsxConfiguration": { "target": "com.amazonaws.kendra#FsxConfiguration", "traits": { - "smithy.api#documentation": "

Provides the configuration information to connect to Amazon FSx as your data\n source.

" + "smithy.api#documentation": "

Provides the configuration information to connect to Amazon FSx as your data\n source.

\n \n

Amazon Kendra now supports an upgraded Amazon FSx Windows connector.

\n

You must now use the TemplateConfiguration object instead of the \n FsxConfiguration object to configure your connector.

\n

Connectors configured using the older console and API architecture will continue to\n function as configured. However, you won't be able to edit or update them. If you want\n to edit or update your connector configuration, you must create a new connector.

\n

We recommended migrating your connector workflow to the upgraded version. Support for \n connectors configured using the older architecture is scheduled to end by June 2024.

\n " } }, "SlackConfiguration": { "target": "com.amazonaws.kendra#SlackConfiguration", "traits": { - "smithy.api#documentation": "

Provides the configuration information to connect to Slack as your data source.

" + "smithy.api#documentation": "

Provides the configuration information to connect to Slack as your data source.

\n \n

Amazon Kendra now supports an upgraded Slack connector.

\n

You must now use the TemplateConfiguration object instead of the \n SlackConfiguration object to configure your connector.

\n

Connectors configured using the older console and API architecture will continue to\n function as configured. However, you won't be able to edit or update them. If you want\n to edit or update your connector configuration, you must create a new connector.

\n

We recommended migrating your connector workflow to the upgraded version. Support for \n connectors configured using the older architecture is scheduled to end by June 2024.

\n " } }, "BoxConfiguration": { @@ -4366,7 +4366,7 @@ "GitHubConfiguration": { "target": "com.amazonaws.kendra#GitHubConfiguration", "traits": { - "smithy.api#documentation": "

Provides the configuration information to connect to GitHub as your data source.

" + "smithy.api#documentation": "

Provides the configuration information to connect to GitHub as your data source.

\n \n

Amazon Kendra now supports an upgraded GitHub connector.

\n

You must now use the TemplateConfiguration object instead of the\n GitHubConfiguration object to configure your connector.

\n

Connectors configured using the older console and API architecture will continue\n to function as configured. However, you won’t be able to edit or update them. If you\n want to edit or update your connector configuration, you must create a new\n connector.

\n

We recommended migrating your connector workflow to the upgraded version. Support\n for connectors configured using the older architecture is scheduled to end by June\n 2024.

\n " } }, "AlfrescoConfiguration": { @@ -4375,7 +4375,7 @@ "smithy.api#deprecated": { "message": "Deprecated AlfrescoConfiguration in favor of TemplateConfiguration" }, - "smithy.api#documentation": "

Provides the configuration information to connect to Alfresco as your data source.

\n

Support for AlfrescoConfiguration ended May 2023. \n We recommend migrating to or using the Alfresco data source template \n schema / TemplateConfiguration API.

" + "smithy.api#documentation": "

Provides the configuration information to connect to Alfresco as your data source.

\n \n

Support for AlfrescoConfiguration ended May 2023. \n We recommend migrating to or using the Alfresco data source template \n schema / TemplateConfiguration \n API.

\n " } }, "TemplateConfiguration": { @@ -5306,7 +5306,7 @@ } ], "traits": { - "smithy.api#documentation": "

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

" + "smithy.api#documentation": "

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

" } }, "com.amazonaws.kendra#DeleteIndexRequest": { @@ -5473,7 +5473,7 @@ } ], "traits": { - "smithy.api#documentation": "

Deletes an existing Amazon Kendra thesaurus. \n

" + "smithy.api#documentation": "

Deletes an Amazon Kendra thesaurus. \n

" } }, "com.amazonaws.kendra#DeleteThesaurusRequest": { @@ -6129,7 +6129,7 @@ } ], "traits": { - "smithy.api#documentation": "

Gets information about an existing Amazon Kendra index.

" + "smithy.api#documentation": "

Gets information about an Amazon Kendra index.

" } }, "com.amazonaws.kendra#DescribeIndexRequest": { @@ -6171,13 +6171,13 @@ "RoleArn": { "target": "com.amazonaws.kendra#RoleArn", "traits": { - "smithy.api#documentation": "

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

" + "smithy.api#documentation": "

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

" } }, "ServerSideEncryptionConfiguration": { "target": "com.amazonaws.kendra#ServerSideEncryptionConfiguration", "traits": { - "smithy.api#documentation": "

The identifier of the KMScustomer master key (CMK) that is used to encrypt\n your data. Amazon Kendra doesn't support asymmetric CMKs.

" + "smithy.api#documentation": "

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

" } }, "Status": { @@ -6201,7 +6201,7 @@ "UpdatedAt": { "target": "com.amazonaws.kendra#Timestamp", "traits": { - "smithy.api#documentation": "

The Unix when the index was last updated.

" + "smithy.api#documentation": "

The Unix timestamp when the index was last updated.

" } }, "DocumentMetadataConfigurations": { @@ -6243,7 +6243,7 @@ "UserGroupResolutionConfiguration": { "target": "com.amazonaws.kendra#UserGroupResolutionConfiguration", "traits": { - "smithy.api#documentation": "

Whether you have enabled the configuration for fetching access levels of groups and\n users from an IAM Identity Center identity source.

" + "smithy.api#documentation": "

Whether you have enabled IAM Identity Center identity source for your \n users and groups. This is useful for user context filtering, where\n search results are filtered based on the user or their group access to documents.

" } } }, @@ -6609,7 +6609,7 @@ } ], "traits": { - "smithy.api#documentation": "

Gets information about an existing Amazon Kendra thesaurus.

" + "smithy.api#documentation": "

Gets information about an Amazon Kendra thesaurus.

" } }, "com.amazonaws.kendra#DescribeThesaurusRequest": { @@ -7107,7 +7107,7 @@ "Count": { "target": "com.amazonaws.kendra#Integer", "traits": { - "smithy.api#documentation": "

The number of documents in the response that have the attribute/field value for \n the key.

" + "smithy.api#documentation": "

The number of documents in the response that have the attribute/field value for the\n key.

" } }, "FacetResults": { @@ -7118,7 +7118,7 @@ } }, "traits": { - "smithy.api#documentation": "

Provides the count of documents that match a particular document attribute or \n field when doing a faceted search.

" + "smithy.api#documentation": "

Provides the count of documents that match a particular document attribute or field when\n doing a faceted search.

" } }, "com.amazonaws.kendra#DocumentAttributeValueCountPairList": { @@ -8547,7 +8547,7 @@ } }, "traits": { - "smithy.api#documentation": "

Provides the configuration information to connect to Amazon FSx as your data\n source.

" + "smithy.api#documentation": "

Provides the configuration information to connect to Amazon FSx as your data\n source.

\n \n

Amazon Kendra now supports an upgraded Amazon FSx Windows connector.

\n

You must now use the TemplateConfiguration object instead of the \n FsxConfiguration object to configure your connector.

\n

Connectors configured using the older console and API architecture will continue to\n function as configured. However, you won't be able to edit or update them. If you want\n to edit or update your connector configuration, you must create a new connector.

\n

We recommended migrating your connector workflow to the upgraded version. Support for \n connectors configured using the older architecture is scheduled to end by June 2024.

\n " } }, "com.amazonaws.kendra#FsxFileSystemType": { @@ -8899,7 +8899,7 @@ } }, "traits": { - "smithy.api#documentation": "

Provides the configuration information to connect to GitHub as your data\n source.

" + "smithy.api#documentation": "

Provides the configuration information to connect to GitHub as your data\n source.

\n \n

Amazon Kendra now supports an upgraded GitHub connector.

\n

You must now use the TemplateConfiguration object instead of the\n GitHubConfiguration object to configure your connector.

\n

Connectors configured using the older console and API architecture will continue\n to function as configured. However, you won’t be able to edit or update them. If you\n want to edit or update your connector configuration, you must create a new\n connector.

\n

We recommended migrating your connector workflow to the upgraded version. Support\n for connectors configured using the older architecture is scheduled to end by June\n 2024.

\n " } }, "com.amazonaws.kendra#GitHubDocumentCrawlProperties": { @@ -11285,7 +11285,7 @@ "OrganizationName": { "target": "com.amazonaws.kendra#OrganizationName", "traits": { - "smithy.api#documentation": "

The name of the organization of the GitHub Enterprise Server (in-premise) account you\n want to connect to. You can find your organization name by logging into GitHub desktop\n and selecting Your organizations under your profile\n picture dropdown.

", + "smithy.api#documentation": "

The name of the organization of the GitHub Enterprise Server (on-premises) account you\n want to connect to. You can find your organization name by logging into GitHub desktop\n and selecting Your organizations under your profile\n picture dropdown.

", "smithy.api#required": {} } }, @@ -11821,7 +11821,7 @@ "QueryText": { "target": "com.amazonaws.kendra#QueryText", "traits": { - "smithy.api#documentation": "

The input query text for the search. Amazon Kendra truncates queries at 30 token\n words, which excludes punctuation and stop words. Truncation still applies if you use\n Boolean or more advanced, complex queries.

" + "smithy.api#documentation": "

The input query text for the search. Amazon Kendra truncates queries at 30 token\n words, which excludes punctuation and stop words. Truncation still applies if you use\n Boolean or more advanced, complex queries. For example, Timeoff AND October AND\n Category:HR is counted as 3 tokens: timeoff, october,\n hr. For more information, see Searching with advanced query syntax in the Amazon Kendra Developer Guide.

" } }, "AttributeFilter": { @@ -11980,7 +11980,7 @@ "Id": { "target": "com.amazonaws.kendra#ResultId", "traits": { - "smithy.api#documentation": "

The identifier for the query result.

" + "smithy.api#documentation": "

The unique identifier for the query result item id (Id) and the query\n result item document id (DocumentId) combined. The value of this field changes\n with every request, even when you have the same documents.

" } }, "Type": { @@ -12028,19 +12028,19 @@ "DocumentAttributes": { "target": "com.amazonaws.kendra#DocumentAttributeList", "traits": { - "smithy.api#documentation": "

An array of document fields/attributes assigned to a document in the search results. \n For example, the document author (_author) or the source URI \n (_source_uri) of the document.

" + "smithy.api#documentation": "

An array of document fields/attributes assigned to a document in the search results. For\n example, the document author (_author) or the source URI\n (_source_uri) of the document.

" } }, "ScoreAttributes": { "target": "com.amazonaws.kendra#ScoreAttributes", "traits": { - "smithy.api#documentation": "

Indicates the confidence level of Amazon Kendra providing a relevant result for \n the query. Each result is placed into a bin that indicates the confidence,\n VERY_HIGH, HIGH, MEDIUM and LOW. \n You can use the score to determine if a response meets the confidence needed for your\n application.

\n

The field is only set to LOW when the Type field is set to\n DOCUMENT and Amazon Kendra is not confident that the result is \n relevant to the query.

" + "smithy.api#documentation": "

Indicates the confidence level of Amazon Kendra providing a relevant result for the\n query. Each result is placed into a bin that indicates the confidence,\n VERY_HIGH, HIGH, MEDIUM and LOW. You\n can use the score to determine if a response meets the confidence needed for your\n application.

\n

The field is only set to LOW when the Type field is set to\n DOCUMENT and Amazon Kendra is not confident that the result is\n relevant to the query.

" } }, "FeedbackToken": { "target": "com.amazonaws.kendra#FeedbackToken", "traits": { - "smithy.api#documentation": "

A token that identifies a particular result from a particular query. Use this token to\n provide click-through feedback for the result. For more information, see Submitting feedback.

" + "smithy.api#documentation": "

A token that identifies a particular result from a particular query. Use this token to\n provide click-through feedback for the result. For more information, see Submitting\n feedback.

" } }, "TableExcerpt": { @@ -12349,7 +12349,7 @@ "Freshness": { "target": "com.amazonaws.kendra#DocumentMetadataBoolean", "traits": { - "smithy.api#documentation": "

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

" + "smithy.api#documentation": "

Indicates that this field determines how \"fresh\" a document is. For example, if\n document 1 was created on November 5, and document 2 was created on October 31, document\n 1 is \"fresher\" than document 2. Only applies to DATE fields.

" } }, "Importance": { @@ -12367,13 +12367,13 @@ "RankOrder": { "target": "com.amazonaws.kendra#Order", "traits": { - "smithy.api#documentation": "

Determines how values should be interpreted.

\n

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

\n

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

\n

Only applies to LONG and DOUBLE fields.

" + "smithy.api#documentation": "

Determines how values should be interpreted.

\n

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

\n

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

\n

Only applies to LONG fields.

" } }, "ValueImportanceMap": { "target": "com.amazonaws.kendra#ValueImportanceMap", "traits": { - "smithy.api#documentation": "

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

\n

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

" + "smithy.api#documentation": "

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

\n

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

" } } }, @@ -12551,7 +12551,7 @@ "QueryText": { "target": "com.amazonaws.kendra#QueryText", "traits": { - "smithy.api#documentation": "

The input query text to retrieve relevant passages for the search. Amazon Kendra\n truncates queries at 30 token words, which excludes punctuation and stop words.\n Truncation still applies if you use Boolean or more advanced, complex queries.

", + "smithy.api#documentation": "

The input query text to retrieve relevant passages for the search. Amazon Kendra\n truncates queries at 30 token words, which excludes punctuation and stop words.\n Truncation still applies if you use Boolean or more advanced, complex queries. For\n example, Timeoff AND October AND Category:HR is counted as 3 tokens:\n timeoff, october, hr. For more information,\n see Searching with advanced query syntax in the Amazon Kendra Developer Guide.

", "smithy.api#required": {} } }, @@ -12711,13 +12711,13 @@ "InclusionPatterns": { "target": "com.amazonaws.kendra#DataSourceInclusionsExclusionsStrings", "traits": { - "smithy.api#documentation": "

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

\n

Some examples\n are:

\n " + "smithy.api#documentation": "

A list of glob patterns (patterns that can expand a wildcard pattern into a list of\n path names that match the given pattern) for certain file names and file types to include \n in your index. If a document matches both an inclusion and exclusion prefix or pattern, \n the exclusion prefix takes precendence and the document is not indexed. Examples of glob \n patterns include:

\n \n

For more examples, see Use of Exclude and\n Include Filters in the Amazon Web Services CLI Command Reference.

" } }, "ExclusionPatterns": { "target": "com.amazonaws.kendra#DataSourceInclusionsExclusionsStrings", "traits": { - "smithy.api#documentation": "

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

\n

Some examples\n are:

\n " + "smithy.api#documentation": "

A list of glob patterns (patterns that can expand a wildcard pattern into a list of\n path names that match the given pattern) for certain file names and file types to exclude \n from your index. If a document matches both an inclusion and exclusion prefix or pattern, \n the exclusion prefix takes precendence and the document is not indexed. Examples of glob \n patterns include:

\n \n

For more examples, see Use of Exclude and\n Include Filters in the Amazon Web Services CLI Command Reference.

" } }, "DocumentsMetadataConfiguration": { @@ -12731,7 +12731,7 @@ } }, "traits": { - "smithy.api#documentation": "

Provides the configuration information to connect to an Amazon S3\n bucket.

" + "smithy.api#documentation": "

Provides the configuration information to connect to an Amazon S3\n bucket.

\n \n

Amazon Kendra now supports an upgraded Amazon S3 connector.

\n

You must now use the TemplateConfiguration object instead of the \n S3DataSourceConfiguration object to configure your connector.

\n

Connectors configured using the older console and API architecture will continue to\n function as configured. However, you won't be able to edit or update them. If you want\n to edit or update your connector configuration, you must create a new connector.

\n

We recommended migrating your connector workflow to the upgraded version. Support for \n connectors configured using the older architecture is scheduled to end by June 2024.

\n " } }, "com.amazonaws.kendra#S3ObjectKey": { @@ -13943,7 +13943,7 @@ } }, "traits": { - "smithy.api#documentation": "

Provides the configuration information to connect to Slack as your data source.

" + "smithy.api#documentation": "

Provides the configuration information to connect to Slack as your data source.

\n \n

Amazon Kendra now supports an upgraded Slack connector.

\n

You must now use the TemplateConfiguration object instead of the \n SlackConfiguration object to configure your connector.

\n

Connectors configured using the older console and API architecture will continue to\n function as configured. However, you won’t be able to edit or update them. If you want\n to edit or update your connector configuration, you must create a new connector.

\n

We recommended migrating your connector workflow to the upgraded version. Support for \n connectors configured using the older architecture is scheduled to end by June 2024.

\n " } }, "com.amazonaws.kendra#SlackEntity": { @@ -15217,7 +15217,7 @@ } ], "traits": { - "smithy.api#documentation": "

Updates an existing Amazon Kendra data source connector.

" + "smithy.api#documentation": "

Updates an Amazon Kendra data source connector.

" } }, "com.amazonaws.kendra#UpdateDataSourceRequest": { @@ -15498,7 +15498,7 @@ } ], "traits": { - "smithy.api#documentation": "

Updates an existing Amazon Kendra index.

" + "smithy.api#documentation": "

Updates an Amazon Kendra index.

" } }, "com.amazonaws.kendra#UpdateIndexRequest": { @@ -15514,7 +15514,7 @@ "Name": { "target": "com.amazonaws.kendra#IndexName", "traits": { - "smithy.api#documentation": "

The name of the index you want to update.

" + "smithy.api#documentation": "

A new name for the index.

" } }, "RoleArn": { @@ -15556,7 +15556,7 @@ "UserGroupResolutionConfiguration": { "target": "com.amazonaws.kendra#UserGroupResolutionConfiguration", "traits": { - "smithy.api#documentation": "

Enables fetching access levels of groups and users from an IAM Identity Center\n identity source. To configure this, see UserGroupResolutionConfiguration.

" + "smithy.api#documentation": "

Gets users and groups from IAM Identity Center\n identity source. To configure this, see UserGroupResolutionConfiguration. This is useful for user context filtering, where\n search results are filtered based on the user or their group access to documents.

" } } },