@aws-sdk/client-kendra-ranking 3.321.1 → 3.326.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (10) hide show
  1. package/dist-types/commands/CreateRescoreExecutionPlanCommand.d.ts +7 -0
  2. package/dist-types/commands/DeleteRescoreExecutionPlanCommand.d.ts +4 -0
  3. package/dist-types/commands/DescribeRescoreExecutionPlanCommand.d.ts +16 -0
  4. package/dist-types/commands/ListRescoreExecutionPlansCommand.d.ts +15 -0
  5. package/dist-types/commands/ListTagsForResourceCommand.d.ts +11 -0
  6. package/dist-types/commands/RescoreCommand.d.ts +12 -0
  7. package/dist-types/commands/TagResourceCommand.d.ts +4 -0
  8. package/dist-types/commands/UntagResourceCommand.d.ts +4 -0
  9. package/dist-types/commands/UpdateRescoreExecutionPlanCommand.d.ts +4 -0
  10. package/package.json +16 -16
package/dist-types/commands/CreateRescoreExecutionPlanCommand.d.ts CHANGED
@@ -51,6 +51,11 @@ export interface CreateRescoreExecutionPlanCommandOutput extends CreateRescoreEx
51
51
  * };
52
52
  * const command = new CreateRescoreExecutionPlanCommand(input);
53
53
  * const response = await client.send(command);
54
+ * // { // CreateRescoreExecutionPlanResponse
55
+ * // Id: "STRING_VALUE", // required
56
+ * // Arn: "STRING_VALUE", // required
57
+ * // };
58
+ *
54
59
  * ```
55
60
  *
56
61
  * @param CreateRescoreExecutionPlanCommandInput - {@link CreateRescoreExecutionPlanCommandInput}
@@ -91,6 +96,8 @@ export interface CreateRescoreExecutionPlanCommandOutput extends CreateRescoreEx
91
96
  * the Amazon Kendra Intelligent Ranking service.
92
97
  * Please provide the correct input and try again.</p>
93
98
  *
99
+ * @throws {@link KendraRankingServiceException}
100
+ * <p>Base exception class for all service exceptions from KendraRanking service.</p>
94
101
  *
95
102
  */
96
103
  export declare class CreateRescoreExecutionPlanCommand extends $Command<CreateRescoreExecutionPlanCommandInput, CreateRescoreExecutionPlanCommandOutput, KendraRankingClientResolvedConfig> {
package/dist-types/commands/DeleteRescoreExecutionPlanCommand.d.ts CHANGED
@@ -33,6 +33,8 @@ export interface DeleteRescoreExecutionPlanCommandOutput extends __MetadataBeare
33
33
  * };
34
34
  * const command = new DeleteRescoreExecutionPlanCommand(input);
35
35
  * const response = await client.send(command);
36
+ * // {};
37
+ *
36
38
  * ```
37
39
  *
38
40
  * @param DeleteRescoreExecutionPlanCommandInput - {@link DeleteRescoreExecutionPlanCommandInput}
@@ -71,6 +73,8 @@ export interface DeleteRescoreExecutionPlanCommandOutput extends __MetadataBeare
71
73
  * the Amazon Kendra Intelligent Ranking service.
72
74
  * Please provide the correct input and try again.</p>
73
75
  *
76
+ * @throws {@link KendraRankingServiceException}
77
+ * <p>Base exception class for all service exceptions from KendraRanking service.</p>
74
78
  *
75
79
  */
76
80
  export declare class DeleteRescoreExecutionPlanCommand extends $Command<DeleteRescoreExecutionPlanCommandInput, DeleteRescoreExecutionPlanCommandOutput, KendraRankingClientResolvedConfig> {
package/dist-types/commands/DescribeRescoreExecutionPlanCommand.d.ts CHANGED
@@ -33,6 +33,20 @@ export interface DescribeRescoreExecutionPlanCommandOutput extends DescribeResco
33
33
  * };
34
34
  * const command = new DescribeRescoreExecutionPlanCommand(input);
35
35
  * const response = await client.send(command);
36
+ * // { // DescribeRescoreExecutionPlanResponse
37
+ * // Id: "STRING_VALUE",
38
+ * // Arn: "STRING_VALUE",
39
+ * // Name: "STRING_VALUE",
40
+ * // Description: "STRING_VALUE",
41
+ * // CapacityUnits: { // CapacityUnitsConfiguration
42
+ * // RescoreCapacityUnits: Number("int"), // required
43
+ * // },
44
+ * // CreatedAt: new Date("TIMESTAMP"),
45
+ * // UpdatedAt: new Date("TIMESTAMP"),
46
+ * // Status: "CREATING" || "UPDATING" || "ACTIVE" || "DELETING" || "FAILED",
47
+ * // ErrorMessage: "STRING_VALUE",
48
+ * // };
49
+ *
36
50
  * ```
37
51
  *
38
52
  * @param DescribeRescoreExecutionPlanCommandInput - {@link DescribeRescoreExecutionPlanCommandInput}
@@ -67,6 +81,8 @@ export interface DescribeRescoreExecutionPlanCommandOutput extends DescribeResco
67
81
  * the Amazon Kendra Intelligent Ranking service.
68
82
  * Please provide the correct input and try again.</p>
69
83
  *
84
+ * @throws {@link KendraRankingServiceException}
85
+ * <p>Base exception class for all service exceptions from KendraRanking service.</p>
70
86
  *
71
87
  */
72
88
  export declare class DescribeRescoreExecutionPlanCommand extends $Command<DescribeRescoreExecutionPlanCommandInput, DescribeRescoreExecutionPlanCommandOutput, KendraRankingClientResolvedConfig> {
package/dist-types/commands/ListRescoreExecutionPlansCommand.d.ts CHANGED
@@ -34,6 +34,19 @@ export interface ListRescoreExecutionPlansCommandOutput extends ListRescoreExecu
34
34
  * };
35
35
  * const command = new ListRescoreExecutionPlansCommand(input);
36
36
  * const response = await client.send(command);
37
+ * // { // ListRescoreExecutionPlansResponse
38
+ * // SummaryItems: [ // RescoreExecutionPlanSummaryList
39
+ * // { // RescoreExecutionPlanSummary
40
+ * // Name: "STRING_VALUE",
41
+ * // Id: "STRING_VALUE",
42
+ * // CreatedAt: new Date("TIMESTAMP"),
43
+ * // UpdatedAt: new Date("TIMESTAMP"),
44
+ * // Status: "CREATING" || "UPDATING" || "ACTIVE" || "DELETING" || "FAILED",
45
+ * // },
46
+ * // ],
47
+ * // NextToken: "STRING_VALUE",
48
+ * // };
49
+ *
37
50
  * ```
38
51
  *
39
52
  * @param ListRescoreExecutionPlansCommandInput - {@link ListRescoreExecutionPlansCommandInput}
@@ -63,6 +76,8 @@ export interface ListRescoreExecutionPlansCommandOutput extends ListRescoreExecu
63
76
  * the Amazon Kendra Intelligent Ranking service.
64
77
  * Please provide the correct input and try again.</p>
65
78
  *
79
+ * @throws {@link KendraRankingServiceException}
80
+ * <p>Base exception class for all service exceptions from KendraRanking service.</p>
66
81
  *
67
82
  */
68
83
  export declare class ListRescoreExecutionPlansCommand extends $Command<ListRescoreExecutionPlansCommandInput, ListRescoreExecutionPlansCommandOutput, KendraRankingClientResolvedConfig> {
package/dist-types/commands/ListTagsForResourceCommand.d.ts CHANGED
@@ -33,6 +33,15 @@ export interface ListTagsForResourceCommandOutput extends ListTagsForResourceRes
33
33
  * };
34
34
  * const command = new ListTagsForResourceCommand(input);
35
35
  * const response = await client.send(command);
36
+ * // { // ListTagsForResourceResponse
37
+ * // Tags: [ // TagList
38
+ * // { // Tag
39
+ * // Key: "STRING_VALUE", // required
40
+ * // Value: "STRING_VALUE", // required
41
+ * // },
42
+ * // ],
43
+ * // };
44
+ *
36
45
  * ```
37
46
  *
38
47
  * @param ListTagsForResourceCommandInput - {@link ListTagsForResourceCommandInput}
@@ -67,6 +76,8 @@ export interface ListTagsForResourceCommandOutput extends ListTagsForResourceRes
67
76
  * the Amazon Kendra Intelligent Ranking service.
68
77
  * Please provide the correct input and try again.</p>
69
78
  *
79
+ * @throws {@link KendraRankingServiceException}
80
+ * <p>Base exception class for all service exceptions from KendraRanking service.</p>
70
81
  *
71
82
  */
72
83
  export declare class ListTagsForResourceCommand extends $Command<ListTagsForResourceCommandInput, ListTagsForResourceCommandOutput, KendraRankingClientResolvedConfig> {
package/dist-types/commands/RescoreCommand.d.ts CHANGED
@@ -50,6 +50,16 @@ export interface RescoreCommandOutput extends RescoreResult, __MetadataBearer {
50
50
  * };
51
51
  * const command = new RescoreCommand(input);
52
52
  * const response = await client.send(command);
53
+ * // { // RescoreResult
54
+ * // RescoreId: "STRING_VALUE",
55
+ * // ResultItems: [ // RescoreResultItemList
56
+ * // { // RescoreResultItem
57
+ * // DocumentId: "STRING_VALUE",
58
+ * // Score: Number("float"),
59
+ * // },
60
+ * // ],
61
+ * // };
62
+ *
53
63
  * ```
54
64
  *
55
65
  * @param RescoreCommandInput - {@link RescoreCommandInput}
@@ -88,6 +98,8 @@ export interface RescoreCommandOutput extends RescoreResult, __MetadataBearer {
88
98
  * the Amazon Kendra Intelligent Ranking service.
89
99
  * Please provide the correct input and try again.</p>
90
100
  *
101
+ * @throws {@link KendraRankingServiceException}
102
+ * <p>Base exception class for all service exceptions from KendraRanking service.</p>
91
103
  *
92
104
  */
93
105
  export declare class RescoreCommand extends $Command<RescoreCommandInput, RescoreCommandOutput, KendraRankingClientResolvedConfig> {
package/dist-types/commands/TagResourceCommand.d.ts CHANGED
@@ -41,6 +41,8 @@ export interface TagResourceCommandOutput extends TagResourceResponse, __Metadat
41
41
  * };
42
42
  * const command = new TagResourceCommand(input);
43
43
  * const response = await client.send(command);
44
+ * // {};
45
+ *
44
46
  * ```
45
47
  *
46
48
  * @param TagResourceCommandInput - {@link TagResourceCommandInput}
@@ -75,6 +77,8 @@ export interface TagResourceCommandOutput extends TagResourceResponse, __Metadat
75
77
  * the Amazon Kendra Intelligent Ranking service.
76
78
  * Please provide the correct input and try again.</p>
77
79
  *
80
+ * @throws {@link KendraRankingServiceException}
81
+ * <p>Base exception class for all service exceptions from KendraRanking service.</p>
78
82
  *
79
83
  */
80
84
  export declare class TagResourceCommand extends $Command<TagResourceCommandInput, TagResourceCommandOutput, KendraRankingClientResolvedConfig> {
package/dist-types/commands/UntagResourceCommand.d.ts CHANGED
@@ -37,6 +37,8 @@ export interface UntagResourceCommandOutput extends UntagResourceResponse, __Met
37
37
  * };
38
38
  * const command = new UntagResourceCommand(input);
39
39
  * const response = await client.send(command);
40
+ * // {};
41
+ *
40
42
  * ```
41
43
  *
42
44
  * @param UntagResourceCommandInput - {@link UntagResourceCommandInput}
@@ -71,6 +73,8 @@ export interface UntagResourceCommandOutput extends UntagResourceResponse, __Met
71
73
  * the Amazon Kendra Intelligent Ranking service.
72
74
  * Please provide the correct input and try again.</p>
73
75
  *
76
+ * @throws {@link KendraRankingServiceException}
77
+ * <p>Base exception class for all service exceptions from KendraRanking service.</p>
74
78
  *
75
79
  */
76
80
  export declare class UntagResourceCommand extends $Command<UntagResourceCommandInput, UntagResourceCommandOutput, KendraRankingClientResolvedConfig> {
package/dist-types/commands/UpdateRescoreExecutionPlanCommand.d.ts CHANGED
@@ -41,6 +41,8 @@ export interface UpdateRescoreExecutionPlanCommandOutput extends __MetadataBeare
41
41
  * };
42
42
  * const command = new UpdateRescoreExecutionPlanCommand(input);
43
43
  * const response = await client.send(command);
44
+ * // {};
45
+ *
44
46
  * ```
45
47
  *
46
48
  * @param UpdateRescoreExecutionPlanCommandInput - {@link UpdateRescoreExecutionPlanCommandInput}
@@ -86,6 +88,8 @@ export interface UpdateRescoreExecutionPlanCommandOutput extends __MetadataBeare
86
88
  * the Amazon Kendra Intelligent Ranking service.
87
89
  * Please provide the correct input and try again.</p>
88
90
  *
91
+ * @throws {@link KendraRankingServiceException}
92
+ * <p>Base exception class for all service exceptions from KendraRanking service.</p>
89
93
  *
90
94
  */
91
95
  export declare class UpdateRescoreExecutionPlanCommand extends $Command<UpdateRescoreExecutionPlanCommandInput, UpdateRescoreExecutionPlanCommandOutput, KendraRankingClientResolvedConfig> {
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@aws-sdk/client-kendra-ranking",
3
3
  "description": "AWS SDK for JavaScript Kendra Ranking Client for Node.js, Browser and React Native",
4
- "version": "3.321.1",
4
+ "version": "3.326.0",
5
5
  "scripts": {
6
6
  "build": "concurrently 'yarn:build:cjs' 'yarn:build:es' 'yarn:build:types'",
7
7
  "build:cjs": "tsc -p tsconfig.cjs.json",
@@ -21,33 +21,33 @@
21
21
  "dependencies": {
22
22
  "@aws-crypto/sha256-browser": "3.0.0",
23
23
  "@aws-crypto/sha256-js": "3.0.0",
24
- "@aws-sdk/client-sts": "3.321.1",
24
+ "@aws-sdk/client-sts": "3.326.0",
25
25
  "@aws-sdk/config-resolver": "3.310.0",
26
- "@aws-sdk/credential-provider-node": "3.321.1",
26
+ "@aws-sdk/credential-provider-node": "3.326.0",
27
27
  "@aws-sdk/fetch-http-handler": "3.310.0",
28
28
  "@aws-sdk/hash-node": "3.310.0",
29
29
  "@aws-sdk/invalid-dependency": "3.310.0",
30
- "@aws-sdk/middleware-content-length": "3.310.0",
31
- "@aws-sdk/middleware-endpoint": "3.310.0",
32
- "@aws-sdk/middleware-host-header": "3.310.0",
33
- "@aws-sdk/middleware-logger": "3.310.0",
34
- "@aws-sdk/middleware-recursion-detection": "3.310.0",
35
- "@aws-sdk/middleware-retry": "3.310.0",
36
- "@aws-sdk/middleware-serde": "3.310.0",
37
- "@aws-sdk/middleware-signing": "3.310.0",
38
- "@aws-sdk/middleware-stack": "3.310.0",
39
- "@aws-sdk/middleware-user-agent": "3.319.0",
30
+ "@aws-sdk/middleware-content-length": "3.325.0",
31
+ "@aws-sdk/middleware-endpoint": "3.325.0",
32
+ "@aws-sdk/middleware-host-header": "3.325.0",
33
+ "@aws-sdk/middleware-logger": "3.325.0",
34
+ "@aws-sdk/middleware-recursion-detection": "3.325.0",
35
+ "@aws-sdk/middleware-retry": "3.325.0",
36
+ "@aws-sdk/middleware-serde": "3.325.0",
37
+ "@aws-sdk/middleware-signing": "3.325.0",
38
+ "@aws-sdk/middleware-stack": "3.325.0",
39
+ "@aws-sdk/middleware-user-agent": "3.325.0",
40
40
  "@aws-sdk/node-config-provider": "3.310.0",
41
41
  "@aws-sdk/node-http-handler": "3.321.1",
42
42
  "@aws-sdk/protocol-http": "3.310.0",
43
- "@aws-sdk/smithy-client": "3.316.0",
43
+ "@aws-sdk/smithy-client": "3.325.0",
44
44
  "@aws-sdk/types": "3.310.0",
45
45
  "@aws-sdk/url-parser": "3.310.0",
46
46
  "@aws-sdk/util-base64": "3.310.0",
47
47
  "@aws-sdk/util-body-length-browser": "3.310.0",
48
48
  "@aws-sdk/util-body-length-node": "3.310.0",
49
- "@aws-sdk/util-defaults-mode-browser": "3.316.0",
50
- "@aws-sdk/util-defaults-mode-node": "3.316.0",
49
+ "@aws-sdk/util-defaults-mode-browser": "3.325.0",
50
+ "@aws-sdk/util-defaults-mode-node": "3.325.0",
51
51
  "@aws-sdk/util-endpoints": "3.319.0",
52
52
  "@aws-sdk/util-retry": "3.310.0",
53
53
  "@aws-sdk/util-user-agent-browser": "3.310.0",