@aws-sdk/client-quicksight 3.1062.0 → 3.1064.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.
- package/README.md +56 -0
- package/dist-cjs/index.js +195 -0
- package/dist-cjs/models/errors.js +54 -54
- package/dist-cjs/schemas/schemas_0.js +569 -225
- package/dist-es/QuickSight.js +20 -0
- package/dist-es/commands/BatchDeleteKnowledgeBaseCommand.js +16 -0
- package/dist-es/commands/DeleteKnowledgeBaseCommand.js +16 -0
- package/dist-es/commands/DescribeKnowledgeBaseCommand.js +16 -0
- package/dist-es/commands/DescribeKnowledgeBasePermissionsCommand.js +16 -0
- package/dist-es/commands/ListKnowledgeBasesCommand.js +16 -0
- package/dist-es/commands/ListUsersIndexCapacityCommand.js +16 -0
- package/dist-es/commands/SearchKnowledgeBasesCommand.js +16 -0
- package/dist-es/commands/UpdateKnowledgeBasePermissionsCommand.js +16 -0
- package/dist-es/commands/index.js +8 -0
- package/dist-es/models/enums.js +63 -0
- package/dist-es/models/errors.js +48 -48
- package/dist-es/pagination/ListKnowledgeBasesPaginator.js +4 -0
- package/dist-es/pagination/SearchKnowledgeBasesPaginator.js +4 -0
- package/dist-es/pagination/index.js +2 -0
- package/dist-es/schemas/schemas_0.js +532 -189
- package/dist-types/QuickSight.d.ts +70 -0
- package/dist-types/QuickSightClient.d.ts +10 -2
- package/dist-types/commands/BatchDeleteKnowledgeBaseCommand.d.ts +117 -0
- package/dist-types/commands/DeleteKnowledgeBaseCommand.d.ts +110 -0
- package/dist-types/commands/DescribeDataSetCommand.d.ts +2 -1
- package/dist-types/commands/DescribeDataSetPermissionsCommand.d.ts +1 -1
- package/dist-types/commands/DescribeDataSetRefreshPropertiesCommand.d.ts +1 -1
- package/dist-types/commands/DescribeDataSourceCommand.d.ts +1 -1
- package/dist-types/commands/DescribeDataSourcePermissionsCommand.d.ts +1 -2
- package/dist-types/commands/DescribeKnowledgeBaseCommand.d.ts +157 -0
- package/dist-types/commands/DescribeKnowledgeBasePermissionsCommand.d.ts +115 -0
- package/dist-types/commands/ListKnowledgeBasesCommand.d.ts +117 -0
- package/dist-types/commands/ListUsersIndexCapacityCommand.d.ts +127 -0
- package/dist-types/commands/SearchKnowledgeBasesCommand.d.ts +131 -0
- package/dist-types/commands/StartDashboardSnapshotJobCommand.d.ts +1 -1
- package/dist-types/commands/StartDashboardSnapshotJobScheduleCommand.d.ts +1 -1
- package/dist-types/commands/TagResourceCommand.d.ts +1 -1
- package/dist-types/commands/UntagResourceCommand.d.ts +1 -1
- package/dist-types/commands/UpdateAccountCustomPermissionCommand.d.ts +1 -1
- package/dist-types/commands/UpdateAccountCustomizationCommand.d.ts +1 -1
- package/dist-types/commands/UpdateAccountSettingsCommand.d.ts +1 -1
- package/dist-types/commands/UpdateActionConnectorCommand.d.ts +1 -1
- package/dist-types/commands/UpdateActionConnectorPermissionsCommand.d.ts +1 -1
- package/dist-types/commands/UpdateAgentCommand.d.ts +1 -1
- package/dist-types/commands/UpdateAgentPermissionsCommand.d.ts +1 -1
- package/dist-types/commands/UpdateAnalysisCommand.d.ts +1 -1
- package/dist-types/commands/UpdateAnalysisPermissionsCommand.d.ts +1 -1
- package/dist-types/commands/UpdateApplicationWithTokenExchangeGrantCommand.d.ts +1 -1
- package/dist-types/commands/UpdateBrandCommand.d.ts +1 -1
- package/dist-types/commands/UpdateKnowledgeBasePermissionsCommand.d.ts +134 -0
- package/dist-types/commands/index.d.ts +8 -0
- package/dist-types/models/enums.d.ts +159 -0
- package/dist-types/models/errors.d.ts +53 -53
- package/dist-types/models/models_2.d.ts +106 -144
- package/dist-types/models/models_3.d.ts +184 -154
- package/dist-types/models/models_4.d.ts +1367 -1363
- package/dist-types/models/models_5.d.ts +860 -4
- package/dist-types/pagination/ListKnowledgeBasesPaginator.d.ts +7 -0
- package/dist-types/pagination/SearchKnowledgeBasesPaginator.d.ts +7 -0
- package/dist-types/pagination/index.d.ts +2 -0
- package/dist-types/schemas/schemas_0.d.ts +41 -0
- package/dist-types/ts3.4/QuickSight.d.ts +150 -0
- package/dist-types/ts3.4/QuickSightClient.d.ts +48 -0
- package/dist-types/ts3.4/commands/BatchDeleteKnowledgeBaseCommand.d.ts +53 -0
- package/dist-types/ts3.4/commands/DeleteKnowledgeBaseCommand.d.ts +53 -0
- package/dist-types/ts3.4/commands/DescribeDataSetCommand.d.ts +2 -4
- package/dist-types/ts3.4/commands/DescribeDataSetPermissionsCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/DescribeDataSetRefreshPropertiesCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/DescribeDataSourceCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/DescribeDataSourcePermissionsCommand.d.ts +4 -2
- package/dist-types/ts3.4/commands/DescribeKnowledgeBaseCommand.d.ts +53 -0
- package/dist-types/ts3.4/commands/DescribeKnowledgeBasePermissionsCommand.d.ts +53 -0
- package/dist-types/ts3.4/commands/ListKnowledgeBasesCommand.d.ts +53 -0
- package/dist-types/ts3.4/commands/ListUsersIndexCapacityCommand.d.ts +53 -0
- package/dist-types/ts3.4/commands/SearchKnowledgeBasesCommand.d.ts +53 -0
- package/dist-types/ts3.4/commands/StartDashboardSnapshotJobCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/StartDashboardSnapshotJobScheduleCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/TagResourceCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/UntagResourceCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/UpdateAccountCustomPermissionCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/UpdateAccountCustomizationCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/UpdateAccountSettingsCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/UpdateActionConnectorCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/UpdateActionConnectorPermissionsCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/UpdateAgentCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/UpdateAgentPermissionsCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/UpdateAnalysisCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/UpdateAnalysisPermissionsCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/UpdateApplicationWithTokenExchangeGrantCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/UpdateBrandCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/UpdateKnowledgeBasePermissionsCommand.d.ts +53 -0
- package/dist-types/ts3.4/commands/index.d.ts +8 -0
- package/dist-types/ts3.4/models/enums.d.ts +85 -0
- package/dist-types/ts3.4/models/errors.d.ts +28 -28
- package/dist-types/ts3.4/models/models_2.d.ts +27 -34
- package/dist-types/ts3.4/models/models_3.d.ts +47 -44
- package/dist-types/ts3.4/models/models_4.d.ts +219 -195
- package/dist-types/ts3.4/models/models_5.d.ts +209 -0
- package/dist-types/ts3.4/pagination/ListKnowledgeBasesPaginator.d.ts +11 -0
- package/dist-types/ts3.4/pagination/SearchKnowledgeBasesPaginator.d.ts +11 -0
- package/dist-types/ts3.4/pagination/index.d.ts +2 -0
- package/dist-types/ts3.4/schemas/schemas_0.d.ts +41 -0
- package/package.json +6 -6
|
@@ -0,0 +1,157 @@
|
|
|
1
|
+
import { Command as $Command } from "@smithy/core/client";
|
|
2
|
+
import type { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
3
|
+
import type { DescribeKnowledgeBaseRequest, DescribeKnowledgeBaseResponse } from "../models/models_4";
|
|
4
|
+
import type { QuickSightClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../QuickSightClient";
|
|
5
|
+
/**
|
|
6
|
+
* @public
|
|
7
|
+
*/
|
|
8
|
+
export type { __MetadataBearer };
|
|
9
|
+
export { $Command };
|
|
10
|
+
/**
|
|
11
|
+
* @public
|
|
12
|
+
*
|
|
13
|
+
* The input for {@link DescribeKnowledgeBaseCommand}.
|
|
14
|
+
*/
|
|
15
|
+
export interface DescribeKnowledgeBaseCommandInput extends DescribeKnowledgeBaseRequest {
|
|
16
|
+
}
|
|
17
|
+
/**
|
|
18
|
+
* @public
|
|
19
|
+
*
|
|
20
|
+
* The output of {@link DescribeKnowledgeBaseCommand}.
|
|
21
|
+
*/
|
|
22
|
+
export interface DescribeKnowledgeBaseCommandOutput extends DescribeKnowledgeBaseResponse, __MetadataBearer {
|
|
23
|
+
}
|
|
24
|
+
declare const DescribeKnowledgeBaseCommand_base: {
|
|
25
|
+
new (input: DescribeKnowledgeBaseCommandInput): import("@smithy/core/client").CommandImpl<DescribeKnowledgeBaseCommandInput, DescribeKnowledgeBaseCommandOutput, QuickSightClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
26
|
+
new (input: DescribeKnowledgeBaseCommandInput): import("@smithy/core/client").CommandImpl<DescribeKnowledgeBaseCommandInput, DescribeKnowledgeBaseCommandOutput, QuickSightClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
27
|
+
getEndpointParameterInstructions(): {
|
|
28
|
+
[x: string]: unknown;
|
|
29
|
+
};
|
|
30
|
+
};
|
|
31
|
+
/**
|
|
32
|
+
* <p>Describes a knowledge base.</p>
|
|
33
|
+
* @example
|
|
34
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
35
|
+
* ```javascript
|
|
36
|
+
* import { QuickSightClient, DescribeKnowledgeBaseCommand } from "@aws-sdk/client-quicksight"; // ES Modules import
|
|
37
|
+
* // const { QuickSightClient, DescribeKnowledgeBaseCommand } = require("@aws-sdk/client-quicksight"); // CommonJS import
|
|
38
|
+
* // import type { QuickSightClientConfig } from "@aws-sdk/client-quicksight";
|
|
39
|
+
* const config = {}; // type is QuickSightClientConfig
|
|
40
|
+
* const client = new QuickSightClient(config);
|
|
41
|
+
* const input = { // DescribeKnowledgeBaseRequest
|
|
42
|
+
* AwsAccountId: "STRING_VALUE", // required
|
|
43
|
+
* KnowledgeBaseId: "STRING_VALUE", // required
|
|
44
|
+
* };
|
|
45
|
+
* const command = new DescribeKnowledgeBaseCommand(input);
|
|
46
|
+
* const response = await client.send(command);
|
|
47
|
+
* // { // DescribeKnowledgeBaseResponse
|
|
48
|
+
* // KnowledgeBase: { // KnowledgeBase
|
|
49
|
+
* // KnowledgeBaseArn: "STRING_VALUE", // required
|
|
50
|
+
* // KnowledgeBaseId: "STRING_VALUE", // required
|
|
51
|
+
* // Name: "STRING_VALUE", // required
|
|
52
|
+
* // Status: "CREATING" || "UPDATING" || "ACTIVE" || "FAILED" || "DELETING", // required
|
|
53
|
+
* // DataSourceArn: "STRING_VALUE", // required
|
|
54
|
+
* // KnowledgeBaseConfiguration: { // KnowledgeBaseConfiguration
|
|
55
|
+
* // templateConfiguration: { // KbTemplateConfiguration
|
|
56
|
+
* // template: "DOCUMENT_VALUE",
|
|
57
|
+
* // },
|
|
58
|
+
* // eventEnabled: true || false,
|
|
59
|
+
* // },
|
|
60
|
+
* // MediaExtractionConfiguration: { // MediaExtractionConfiguration
|
|
61
|
+
* // imageExtractionConfiguration: { // ImageExtractionConfiguration
|
|
62
|
+
* // imageExtractionStatus: "ENABLED" || "DISABLED", // required
|
|
63
|
+
* // },
|
|
64
|
+
* // audioExtractionConfiguration: { // AudioExtractionConfiguration
|
|
65
|
+
* // audioExtractionStatus: "ENABLED" || "DISABLED", // required
|
|
66
|
+
* // },
|
|
67
|
+
* // videoExtractionConfiguration: { // VideoExtractionConfiguration
|
|
68
|
+
* // videoExtractionStatus: "ENABLED" || "DISABLED", // required
|
|
69
|
+
* // videoExtractionType: "AUDIO_TRANSCRIPTION_ONLY" || "VISUAL_CONTENT_AND_AUDIO_TRANSCRIPTION",
|
|
70
|
+
* // },
|
|
71
|
+
* // },
|
|
72
|
+
* // Type: "STRING_VALUE",
|
|
73
|
+
* // CreatedAt: new Date("TIMESTAMP"),
|
|
74
|
+
* // UpdatedAt: new Date("TIMESTAMP"),
|
|
75
|
+
* // Description: "STRING_VALUE",
|
|
76
|
+
* // IsEmailNotificationOptedForIngestionFailures: true || false,
|
|
77
|
+
* // FirstCompletedIngestionSummary: { // KnowledgeBaseIngestionSummary
|
|
78
|
+
* // IngestionId: "STRING_VALUE", // required
|
|
79
|
+
* // IngestionStatus: "QUEUED" || "RUNNING" || "FAILED" || "COMPLETED" || "INCOMPLETE" || "CANCELLED" || "CANCELLING" || "TIMEOUT", // required
|
|
80
|
+
* // StartTime: new Date("TIMESTAMP"),
|
|
81
|
+
* // EndTime: new Date("TIMESTAMP"),
|
|
82
|
+
* // },
|
|
83
|
+
* // FirstIncompleteIngestionSummary: {
|
|
84
|
+
* // IngestionId: "STRING_VALUE", // required
|
|
85
|
+
* // IngestionStatus: "QUEUED" || "RUNNING" || "FAILED" || "COMPLETED" || "INCOMPLETE" || "CANCELLED" || "CANCELLING" || "TIMEOUT", // required
|
|
86
|
+
* // StartTime: new Date("TIMESTAMP"),
|
|
87
|
+
* // EndTime: new Date("TIMESTAMP"),
|
|
88
|
+
* // },
|
|
89
|
+
* // LatestIngestionSummary: {
|
|
90
|
+
* // IngestionId: "STRING_VALUE", // required
|
|
91
|
+
* // IngestionStatus: "QUEUED" || "RUNNING" || "FAILED" || "COMPLETED" || "INCOMPLETE" || "CANCELLED" || "CANCELLING" || "TIMEOUT", // required
|
|
92
|
+
* // StartTime: new Date("TIMESTAMP"),
|
|
93
|
+
* // EndTime: new Date("TIMESTAMP"),
|
|
94
|
+
* // },
|
|
95
|
+
* // KnowledgeBaseSizeBytes: Number("long"),
|
|
96
|
+
* // DocumentCount: Number("long"),
|
|
97
|
+
* // PrimaryOwnerArn: "STRING_VALUE",
|
|
98
|
+
* // PrimaryOwnerUsername: "STRING_VALUE",
|
|
99
|
+
* // },
|
|
100
|
+
* // RequestId: "STRING_VALUE",
|
|
101
|
+
* // Status: Number("int"),
|
|
102
|
+
* // };
|
|
103
|
+
*
|
|
104
|
+
* ```
|
|
105
|
+
*
|
|
106
|
+
* @param DescribeKnowledgeBaseCommandInput - {@link DescribeKnowledgeBaseCommandInput}
|
|
107
|
+
* @returns {@link DescribeKnowledgeBaseCommandOutput}
|
|
108
|
+
* @see {@link DescribeKnowledgeBaseCommandInput} for command's `input` shape.
|
|
109
|
+
* @see {@link DescribeKnowledgeBaseCommandOutput} for command's `response` shape.
|
|
110
|
+
* @see {@link QuickSightClientResolvedConfig | config} for QuickSightClient's `config` shape.
|
|
111
|
+
*
|
|
112
|
+
* @throws {@link AccessDeniedException} (client fault)
|
|
113
|
+
* <p>You don't have access to this item. The provided credentials couldn't be
|
|
114
|
+
* validated. You might not be authorized to carry out the request. Make sure that your
|
|
115
|
+
* account is authorized to use the Amazon Quick Sight service, that your policies have the
|
|
116
|
+
* correct permissions, and that you are using the correct credentials.</p>
|
|
117
|
+
*
|
|
118
|
+
* @throws {@link InternalFailureException} (server fault)
|
|
119
|
+
* <p>An internal failure occurred.</p>
|
|
120
|
+
*
|
|
121
|
+
* @throws {@link InvalidParameterValueException} (client fault)
|
|
122
|
+
* <p>One or more parameters has a value that isn't valid.</p>
|
|
123
|
+
*
|
|
124
|
+
* @throws {@link InvalidRequestException} (client fault)
|
|
125
|
+
* <p>You don't have this feature activated for your account. To fix this issue, contact Amazon Web Services support.</p>
|
|
126
|
+
*
|
|
127
|
+
* @throws {@link LimitExceededException} (client fault)
|
|
128
|
+
* <p>A limit is exceeded.</p>
|
|
129
|
+
*
|
|
130
|
+
* @throws {@link PreconditionNotMetException} (client fault)
|
|
131
|
+
* <p>One or more preconditions aren't met.</p>
|
|
132
|
+
*
|
|
133
|
+
* @throws {@link ResourceNotFoundException} (client fault)
|
|
134
|
+
* <p>One or more resources can't be found.</p>
|
|
135
|
+
*
|
|
136
|
+
* @throws {@link ThrottlingException} (client fault)
|
|
137
|
+
* <p>Access is throttled.</p>
|
|
138
|
+
*
|
|
139
|
+
* @throws {@link QuickSightServiceException}
|
|
140
|
+
* <p>Base exception class for all service exceptions from QuickSight service.</p>
|
|
141
|
+
*
|
|
142
|
+
*
|
|
143
|
+
* @public
|
|
144
|
+
*/
|
|
145
|
+
export declare class DescribeKnowledgeBaseCommand extends DescribeKnowledgeBaseCommand_base {
|
|
146
|
+
/** @internal type navigation helper, not in runtime. */
|
|
147
|
+
protected static __types: {
|
|
148
|
+
api: {
|
|
149
|
+
input: DescribeKnowledgeBaseRequest;
|
|
150
|
+
output: DescribeKnowledgeBaseResponse;
|
|
151
|
+
};
|
|
152
|
+
sdk: {
|
|
153
|
+
input: DescribeKnowledgeBaseCommandInput;
|
|
154
|
+
output: DescribeKnowledgeBaseCommandOutput;
|
|
155
|
+
};
|
|
156
|
+
};
|
|
157
|
+
}
|
|
@@ -0,0 +1,115 @@
|
|
|
1
|
+
import { Command as $Command } from "@smithy/core/client";
|
|
2
|
+
import type { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
3
|
+
import type { DescribeKnowledgeBasePermissionsRequest, DescribeKnowledgeBasePermissionsResponse } from "../models/models_4";
|
|
4
|
+
import type { QuickSightClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../QuickSightClient";
|
|
5
|
+
/**
|
|
6
|
+
* @public
|
|
7
|
+
*/
|
|
8
|
+
export type { __MetadataBearer };
|
|
9
|
+
export { $Command };
|
|
10
|
+
/**
|
|
11
|
+
* @public
|
|
12
|
+
*
|
|
13
|
+
* The input for {@link DescribeKnowledgeBasePermissionsCommand}.
|
|
14
|
+
*/
|
|
15
|
+
export interface DescribeKnowledgeBasePermissionsCommandInput extends DescribeKnowledgeBasePermissionsRequest {
|
|
16
|
+
}
|
|
17
|
+
/**
|
|
18
|
+
* @public
|
|
19
|
+
*
|
|
20
|
+
* The output of {@link DescribeKnowledgeBasePermissionsCommand}.
|
|
21
|
+
*/
|
|
22
|
+
export interface DescribeKnowledgeBasePermissionsCommandOutput extends DescribeKnowledgeBasePermissionsResponse, __MetadataBearer {
|
|
23
|
+
}
|
|
24
|
+
declare const DescribeKnowledgeBasePermissionsCommand_base: {
|
|
25
|
+
new (input: DescribeKnowledgeBasePermissionsCommandInput): import("@smithy/core/client").CommandImpl<DescribeKnowledgeBasePermissionsCommandInput, DescribeKnowledgeBasePermissionsCommandOutput, QuickSightClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
26
|
+
new (input: DescribeKnowledgeBasePermissionsCommandInput): import("@smithy/core/client").CommandImpl<DescribeKnowledgeBasePermissionsCommandInput, DescribeKnowledgeBasePermissionsCommandOutput, QuickSightClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
27
|
+
getEndpointParameterInstructions(): {
|
|
28
|
+
[x: string]: unknown;
|
|
29
|
+
};
|
|
30
|
+
};
|
|
31
|
+
/**
|
|
32
|
+
* <p>Describes the resource permissions for a knowledge base.</p>
|
|
33
|
+
* @example
|
|
34
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
35
|
+
* ```javascript
|
|
36
|
+
* import { QuickSightClient, DescribeKnowledgeBasePermissionsCommand } from "@aws-sdk/client-quicksight"; // ES Modules import
|
|
37
|
+
* // const { QuickSightClient, DescribeKnowledgeBasePermissionsCommand } = require("@aws-sdk/client-quicksight"); // CommonJS import
|
|
38
|
+
* // import type { QuickSightClientConfig } from "@aws-sdk/client-quicksight";
|
|
39
|
+
* const config = {}; // type is QuickSightClientConfig
|
|
40
|
+
* const client = new QuickSightClient(config);
|
|
41
|
+
* const input = { // DescribeKnowledgeBasePermissionsRequest
|
|
42
|
+
* AwsAccountId: "STRING_VALUE", // required
|
|
43
|
+
* KnowledgeBaseId: "STRING_VALUE", // required
|
|
44
|
+
* };
|
|
45
|
+
* const command = new DescribeKnowledgeBasePermissionsCommand(input);
|
|
46
|
+
* const response = await client.send(command);
|
|
47
|
+
* // { // DescribeKnowledgeBasePermissionsResponse
|
|
48
|
+
* // KnowledgeBaseArn: "STRING_VALUE", // required
|
|
49
|
+
* // KnowledgeBaseId: "STRING_VALUE", // required
|
|
50
|
+
* // Permissions: [ // ResourcePermissionList
|
|
51
|
+
* // { // ResourcePermission
|
|
52
|
+
* // Principal: "STRING_VALUE", // required
|
|
53
|
+
* // Actions: [ // ActionList // required
|
|
54
|
+
* // "STRING_VALUE",
|
|
55
|
+
* // ],
|
|
56
|
+
* // },
|
|
57
|
+
* // ],
|
|
58
|
+
* // RequestId: "STRING_VALUE",
|
|
59
|
+
* // Status: Number("int"),
|
|
60
|
+
* // };
|
|
61
|
+
*
|
|
62
|
+
* ```
|
|
63
|
+
*
|
|
64
|
+
* @param DescribeKnowledgeBasePermissionsCommandInput - {@link DescribeKnowledgeBasePermissionsCommandInput}
|
|
65
|
+
* @returns {@link DescribeKnowledgeBasePermissionsCommandOutput}
|
|
66
|
+
* @see {@link DescribeKnowledgeBasePermissionsCommandInput} for command's `input` shape.
|
|
67
|
+
* @see {@link DescribeKnowledgeBasePermissionsCommandOutput} for command's `response` shape.
|
|
68
|
+
* @see {@link QuickSightClientResolvedConfig | config} for QuickSightClient's `config` shape.
|
|
69
|
+
*
|
|
70
|
+
* @throws {@link AccessDeniedException} (client fault)
|
|
71
|
+
* <p>You don't have access to this item. The provided credentials couldn't be
|
|
72
|
+
* validated. You might not be authorized to carry out the request. Make sure that your
|
|
73
|
+
* account is authorized to use the Amazon Quick Sight service, that your policies have the
|
|
74
|
+
* correct permissions, and that you are using the correct credentials.</p>
|
|
75
|
+
*
|
|
76
|
+
* @throws {@link InternalFailureException} (server fault)
|
|
77
|
+
* <p>An internal failure occurred.</p>
|
|
78
|
+
*
|
|
79
|
+
* @throws {@link InvalidParameterValueException} (client fault)
|
|
80
|
+
* <p>One or more parameters has a value that isn't valid.</p>
|
|
81
|
+
*
|
|
82
|
+
* @throws {@link InvalidRequestException} (client fault)
|
|
83
|
+
* <p>You don't have this feature activated for your account. To fix this issue, contact Amazon Web Services support.</p>
|
|
84
|
+
*
|
|
85
|
+
* @throws {@link LimitExceededException} (client fault)
|
|
86
|
+
* <p>A limit is exceeded.</p>
|
|
87
|
+
*
|
|
88
|
+
* @throws {@link PreconditionNotMetException} (client fault)
|
|
89
|
+
* <p>One or more preconditions aren't met.</p>
|
|
90
|
+
*
|
|
91
|
+
* @throws {@link ResourceNotFoundException} (client fault)
|
|
92
|
+
* <p>One or more resources can't be found.</p>
|
|
93
|
+
*
|
|
94
|
+
* @throws {@link ThrottlingException} (client fault)
|
|
95
|
+
* <p>Access is throttled.</p>
|
|
96
|
+
*
|
|
97
|
+
* @throws {@link QuickSightServiceException}
|
|
98
|
+
* <p>Base exception class for all service exceptions from QuickSight service.</p>
|
|
99
|
+
*
|
|
100
|
+
*
|
|
101
|
+
* @public
|
|
102
|
+
*/
|
|
103
|
+
export declare class DescribeKnowledgeBasePermissionsCommand extends DescribeKnowledgeBasePermissionsCommand_base {
|
|
104
|
+
/** @internal type navigation helper, not in runtime. */
|
|
105
|
+
protected static __types: {
|
|
106
|
+
api: {
|
|
107
|
+
input: DescribeKnowledgeBasePermissionsRequest;
|
|
108
|
+
output: DescribeKnowledgeBasePermissionsResponse;
|
|
109
|
+
};
|
|
110
|
+
sdk: {
|
|
111
|
+
input: DescribeKnowledgeBasePermissionsCommandInput;
|
|
112
|
+
output: DescribeKnowledgeBasePermissionsCommandOutput;
|
|
113
|
+
};
|
|
114
|
+
};
|
|
115
|
+
}
|
|
@@ -0,0 +1,117 @@
|
|
|
1
|
+
import { Command as $Command } from "@smithy/core/client";
|
|
2
|
+
import type { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
3
|
+
import type { ListKnowledgeBasesRequest, ListKnowledgeBasesResponse } from "../models/models_4";
|
|
4
|
+
import type { QuickSightClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../QuickSightClient";
|
|
5
|
+
/**
|
|
6
|
+
* @public
|
|
7
|
+
*/
|
|
8
|
+
export type { __MetadataBearer };
|
|
9
|
+
export { $Command };
|
|
10
|
+
/**
|
|
11
|
+
* @public
|
|
12
|
+
*
|
|
13
|
+
* The input for {@link ListKnowledgeBasesCommand}.
|
|
14
|
+
*/
|
|
15
|
+
export interface ListKnowledgeBasesCommandInput extends ListKnowledgeBasesRequest {
|
|
16
|
+
}
|
|
17
|
+
/**
|
|
18
|
+
* @public
|
|
19
|
+
*
|
|
20
|
+
* The output of {@link ListKnowledgeBasesCommand}.
|
|
21
|
+
*/
|
|
22
|
+
export interface ListKnowledgeBasesCommandOutput extends ListKnowledgeBasesResponse, __MetadataBearer {
|
|
23
|
+
}
|
|
24
|
+
declare const ListKnowledgeBasesCommand_base: {
|
|
25
|
+
new (input: ListKnowledgeBasesCommandInput): import("@smithy/core/client").CommandImpl<ListKnowledgeBasesCommandInput, ListKnowledgeBasesCommandOutput, QuickSightClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
26
|
+
new (input: ListKnowledgeBasesCommandInput): import("@smithy/core/client").CommandImpl<ListKnowledgeBasesCommandInput, ListKnowledgeBasesCommandOutput, QuickSightClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
27
|
+
getEndpointParameterInstructions(): {
|
|
28
|
+
[x: string]: unknown;
|
|
29
|
+
};
|
|
30
|
+
};
|
|
31
|
+
/**
|
|
32
|
+
* <p>Lists all knowledge bases in an Amazon QuickSight account.</p>
|
|
33
|
+
* @example
|
|
34
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
35
|
+
* ```javascript
|
|
36
|
+
* import { QuickSightClient, ListKnowledgeBasesCommand } from "@aws-sdk/client-quicksight"; // ES Modules import
|
|
37
|
+
* // const { QuickSightClient, ListKnowledgeBasesCommand } = require("@aws-sdk/client-quicksight"); // CommonJS import
|
|
38
|
+
* // import type { QuickSightClientConfig } from "@aws-sdk/client-quicksight";
|
|
39
|
+
* const config = {}; // type is QuickSightClientConfig
|
|
40
|
+
* const client = new QuickSightClient(config);
|
|
41
|
+
* const input = { // ListKnowledgeBasesRequest
|
|
42
|
+
* AwsAccountId: "STRING_VALUE", // required
|
|
43
|
+
* MaxResults: Number("int"),
|
|
44
|
+
* NextToken: "STRING_VALUE",
|
|
45
|
+
* };
|
|
46
|
+
* const command = new ListKnowledgeBasesCommand(input);
|
|
47
|
+
* const response = await client.send(command);
|
|
48
|
+
* // { // ListKnowledgeBasesResponse
|
|
49
|
+
* // KnowledgeBaseSummaries: [ // KnowledgeBaseSummaries // required
|
|
50
|
+
* // { // KnowledgeBaseSummary
|
|
51
|
+
* // KnowledgeBaseArn: "STRING_VALUE", // required
|
|
52
|
+
* // KnowledgeBaseId: "STRING_VALUE", // required
|
|
53
|
+
* // Name: "STRING_VALUE", // required
|
|
54
|
+
* // Status: "CREATING" || "UPDATING" || "ACTIVE" || "FAILED" || "DELETING", // required
|
|
55
|
+
* // DataSourceArn: "STRING_VALUE", // required
|
|
56
|
+
* // Type: "STRING_VALUE",
|
|
57
|
+
* // CreatedAt: new Date("TIMESTAMP"),
|
|
58
|
+
* // UpdatedAt: new Date("TIMESTAMP"),
|
|
59
|
+
* // KnowledgeBaseSizeBytes: Number("long"),
|
|
60
|
+
* // DocumentCount: Number("long"),
|
|
61
|
+
* // PrimaryOwnerArn: "STRING_VALUE",
|
|
62
|
+
* // PrimaryOwnerUsername: "STRING_VALUE",
|
|
63
|
+
* // },
|
|
64
|
+
* // ],
|
|
65
|
+
* // NextToken: "STRING_VALUE",
|
|
66
|
+
* // RequestId: "STRING_VALUE",
|
|
67
|
+
* // Status: Number("int"),
|
|
68
|
+
* // };
|
|
69
|
+
*
|
|
70
|
+
* ```
|
|
71
|
+
*
|
|
72
|
+
* @param ListKnowledgeBasesCommandInput - {@link ListKnowledgeBasesCommandInput}
|
|
73
|
+
* @returns {@link ListKnowledgeBasesCommandOutput}
|
|
74
|
+
* @see {@link ListKnowledgeBasesCommandInput} for command's `input` shape.
|
|
75
|
+
* @see {@link ListKnowledgeBasesCommandOutput} for command's `response` shape.
|
|
76
|
+
* @see {@link QuickSightClientResolvedConfig | config} for QuickSightClient's `config` shape.
|
|
77
|
+
*
|
|
78
|
+
* @throws {@link AccessDeniedException} (client fault)
|
|
79
|
+
* <p>You don't have access to this item. The provided credentials couldn't be
|
|
80
|
+
* validated. You might not be authorized to carry out the request. Make sure that your
|
|
81
|
+
* account is authorized to use the Amazon Quick Sight service, that your policies have the
|
|
82
|
+
* correct permissions, and that you are using the correct credentials.</p>
|
|
83
|
+
*
|
|
84
|
+
* @throws {@link InternalFailureException} (server fault)
|
|
85
|
+
* <p>An internal failure occurred.</p>
|
|
86
|
+
*
|
|
87
|
+
* @throws {@link InvalidParameterValueException} (client fault)
|
|
88
|
+
* <p>One or more parameters has a value that isn't valid.</p>
|
|
89
|
+
*
|
|
90
|
+
* @throws {@link InvalidRequestException} (client fault)
|
|
91
|
+
* <p>You don't have this feature activated for your account. To fix this issue, contact Amazon Web Services support.</p>
|
|
92
|
+
*
|
|
93
|
+
* @throws {@link PreconditionNotMetException} (client fault)
|
|
94
|
+
* <p>One or more preconditions aren't met.</p>
|
|
95
|
+
*
|
|
96
|
+
* @throws {@link ThrottlingException} (client fault)
|
|
97
|
+
* <p>Access is throttled.</p>
|
|
98
|
+
*
|
|
99
|
+
* @throws {@link QuickSightServiceException}
|
|
100
|
+
* <p>Base exception class for all service exceptions from QuickSight service.</p>
|
|
101
|
+
*
|
|
102
|
+
*
|
|
103
|
+
* @public
|
|
104
|
+
*/
|
|
105
|
+
export declare class ListKnowledgeBasesCommand extends ListKnowledgeBasesCommand_base {
|
|
106
|
+
/** @internal type navigation helper, not in runtime. */
|
|
107
|
+
protected static __types: {
|
|
108
|
+
api: {
|
|
109
|
+
input: ListKnowledgeBasesRequest;
|
|
110
|
+
output: ListKnowledgeBasesResponse;
|
|
111
|
+
};
|
|
112
|
+
sdk: {
|
|
113
|
+
input: ListKnowledgeBasesCommandInput;
|
|
114
|
+
output: ListKnowledgeBasesCommandOutput;
|
|
115
|
+
};
|
|
116
|
+
};
|
|
117
|
+
}
|
|
@@ -0,0 +1,127 @@
|
|
|
1
|
+
import { Command as $Command } from "@smithy/core/client";
|
|
2
|
+
import type { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
3
|
+
import type { ListUsersIndexCapacityRequest, ListUsersIndexCapacityResponse } from "../models/models_4";
|
|
4
|
+
import type { QuickSightClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../QuickSightClient";
|
|
5
|
+
/**
|
|
6
|
+
* @public
|
|
7
|
+
*/
|
|
8
|
+
export type { __MetadataBearer };
|
|
9
|
+
export { $Command };
|
|
10
|
+
/**
|
|
11
|
+
* @public
|
|
12
|
+
*
|
|
13
|
+
* The input for {@link ListUsersIndexCapacityCommand}.
|
|
14
|
+
*/
|
|
15
|
+
export interface ListUsersIndexCapacityCommandInput extends ListUsersIndexCapacityRequest {
|
|
16
|
+
}
|
|
17
|
+
/**
|
|
18
|
+
* @public
|
|
19
|
+
*
|
|
20
|
+
* The output of {@link ListUsersIndexCapacityCommand}.
|
|
21
|
+
*/
|
|
22
|
+
export interface ListUsersIndexCapacityCommandOutput extends ListUsersIndexCapacityResponse, __MetadataBearer {
|
|
23
|
+
}
|
|
24
|
+
declare const ListUsersIndexCapacityCommand_base: {
|
|
25
|
+
new (input: ListUsersIndexCapacityCommandInput): import("@smithy/core/client").CommandImpl<ListUsersIndexCapacityCommandInput, ListUsersIndexCapacityCommandOutput, QuickSightClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
26
|
+
new (input: ListUsersIndexCapacityCommandInput): import("@smithy/core/client").CommandImpl<ListUsersIndexCapacityCommandInput, ListUsersIndexCapacityCommandOutput, QuickSightClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
27
|
+
getEndpointParameterInstructions(): {
|
|
28
|
+
[x: string]: unknown;
|
|
29
|
+
};
|
|
30
|
+
};
|
|
31
|
+
/**
|
|
32
|
+
* <p>Lists per-user index capacity consumption for an account.</p>
|
|
33
|
+
* @example
|
|
34
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
35
|
+
* ```javascript
|
|
36
|
+
* import { QuickSightClient, ListUsersIndexCapacityCommand } from "@aws-sdk/client-quicksight"; // ES Modules import
|
|
37
|
+
* // const { QuickSightClient, ListUsersIndexCapacityCommand } = require("@aws-sdk/client-quicksight"); // CommonJS import
|
|
38
|
+
* // import type { QuickSightClientConfig } from "@aws-sdk/client-quicksight";
|
|
39
|
+
* const config = {}; // type is QuickSightClientConfig
|
|
40
|
+
* const client = new QuickSightClient(config);
|
|
41
|
+
* const input = { // ListUsersIndexCapacityRequest
|
|
42
|
+
* awsAccountId: "STRING_VALUE", // required
|
|
43
|
+
* namespace: "STRING_VALUE",
|
|
44
|
+
* filters: [ // UserIndexCapacityFilters
|
|
45
|
+
* { // UserIndexCapacityFilter Union: only one key present
|
|
46
|
+
* userNameOrEmail: { // UserNameOrEmailFilter
|
|
47
|
+
* prefix: "STRING_VALUE", // required
|
|
48
|
+
* },
|
|
49
|
+
* totalCapacityBytes: { // CapacityBytesRangeFilter
|
|
50
|
+
* minBytes: Number("long"),
|
|
51
|
+
* maxBytes: Number("long"),
|
|
52
|
+
* },
|
|
53
|
+
* },
|
|
54
|
+
* ],
|
|
55
|
+
* sortBy: "TOTAL_CAPACITY_BYTES",
|
|
56
|
+
* sortOrder: "ASC" || "DESC",
|
|
57
|
+
* maxResults: Number("int"),
|
|
58
|
+
* nextToken: "STRING_VALUE",
|
|
59
|
+
* };
|
|
60
|
+
* const command = new ListUsersIndexCapacityCommand(input);
|
|
61
|
+
* const response = await client.send(command);
|
|
62
|
+
* // { // ListUsersIndexCapacityResponse
|
|
63
|
+
* // users: [ // UserIndexCapacityList
|
|
64
|
+
* // { // UserIndexCapacity
|
|
65
|
+
* // userArn: "STRING_VALUE",
|
|
66
|
+
* // userName: "STRING_VALUE",
|
|
67
|
+
* // email: "STRING_VALUE",
|
|
68
|
+
* // role: "STRING_VALUE",
|
|
69
|
+
* // totalCapacityBytes: Number("long"),
|
|
70
|
+
* // totalKBCapacityBytes: Number("long"),
|
|
71
|
+
* // totalSpaceCapacityBytes: Number("long"),
|
|
72
|
+
* // kbCount: Number("int"),
|
|
73
|
+
* // spaceCount: Number("int"),
|
|
74
|
+
* // },
|
|
75
|
+
* // ],
|
|
76
|
+
* // nextToken: "STRING_VALUE",
|
|
77
|
+
* // requestId: "STRING_VALUE",
|
|
78
|
+
* // };
|
|
79
|
+
*
|
|
80
|
+
* ```
|
|
81
|
+
*
|
|
82
|
+
* @param ListUsersIndexCapacityCommandInput - {@link ListUsersIndexCapacityCommandInput}
|
|
83
|
+
* @returns {@link ListUsersIndexCapacityCommandOutput}
|
|
84
|
+
* @see {@link ListUsersIndexCapacityCommandInput} for command's `input` shape.
|
|
85
|
+
* @see {@link ListUsersIndexCapacityCommandOutput} for command's `response` shape.
|
|
86
|
+
* @see {@link QuickSightClientResolvedConfig | config} for QuickSightClient's `config` shape.
|
|
87
|
+
*
|
|
88
|
+
* @throws {@link AccessDeniedException} (client fault)
|
|
89
|
+
* <p>You don't have access to this item. The provided credentials couldn't be
|
|
90
|
+
* validated. You might not be authorized to carry out the request. Make sure that your
|
|
91
|
+
* account is authorized to use the Amazon Quick Sight service, that your policies have the
|
|
92
|
+
* correct permissions, and that you are using the correct credentials.</p>
|
|
93
|
+
*
|
|
94
|
+
* @throws {@link InternalFailureException} (server fault)
|
|
95
|
+
* <p>An internal failure occurred.</p>
|
|
96
|
+
*
|
|
97
|
+
* @throws {@link InvalidRequestException} (client fault)
|
|
98
|
+
* <p>You don't have this feature activated for your account. To fix this issue, contact Amazon Web Services support.</p>
|
|
99
|
+
*
|
|
100
|
+
* @throws {@link PreconditionNotMetException} (client fault)
|
|
101
|
+
* <p>One or more preconditions aren't met.</p>
|
|
102
|
+
*
|
|
103
|
+
* @throws {@link ResourceNotFoundException} (client fault)
|
|
104
|
+
* <p>One or more resources can't be found.</p>
|
|
105
|
+
*
|
|
106
|
+
* @throws {@link ThrottlingException} (client fault)
|
|
107
|
+
* <p>Access is throttled.</p>
|
|
108
|
+
*
|
|
109
|
+
* @throws {@link QuickSightServiceException}
|
|
110
|
+
* <p>Base exception class for all service exceptions from QuickSight service.</p>
|
|
111
|
+
*
|
|
112
|
+
*
|
|
113
|
+
* @public
|
|
114
|
+
*/
|
|
115
|
+
export declare class ListUsersIndexCapacityCommand extends ListUsersIndexCapacityCommand_base {
|
|
116
|
+
/** @internal type navigation helper, not in runtime. */
|
|
117
|
+
protected static __types: {
|
|
118
|
+
api: {
|
|
119
|
+
input: ListUsersIndexCapacityRequest;
|
|
120
|
+
output: ListUsersIndexCapacityResponse;
|
|
121
|
+
};
|
|
122
|
+
sdk: {
|
|
123
|
+
input: ListUsersIndexCapacityCommandInput;
|
|
124
|
+
output: ListUsersIndexCapacityCommandOutput;
|
|
125
|
+
};
|
|
126
|
+
};
|
|
127
|
+
}
|
|
@@ -0,0 +1,131 @@
|
|
|
1
|
+
import { Command as $Command } from "@smithy/core/client";
|
|
2
|
+
import type { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
3
|
+
import type { SearchKnowledgeBasesRequest, SearchKnowledgeBasesResponse } from "../models/models_4";
|
|
4
|
+
import type { QuickSightClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../QuickSightClient";
|
|
5
|
+
/**
|
|
6
|
+
* @public
|
|
7
|
+
*/
|
|
8
|
+
export type { __MetadataBearer };
|
|
9
|
+
export { $Command };
|
|
10
|
+
/**
|
|
11
|
+
* @public
|
|
12
|
+
*
|
|
13
|
+
* The input for {@link SearchKnowledgeBasesCommand}.
|
|
14
|
+
*/
|
|
15
|
+
export interface SearchKnowledgeBasesCommandInput extends SearchKnowledgeBasesRequest {
|
|
16
|
+
}
|
|
17
|
+
/**
|
|
18
|
+
* @public
|
|
19
|
+
*
|
|
20
|
+
* The output of {@link SearchKnowledgeBasesCommand}.
|
|
21
|
+
*/
|
|
22
|
+
export interface SearchKnowledgeBasesCommandOutput extends SearchKnowledgeBasesResponse, __MetadataBearer {
|
|
23
|
+
}
|
|
24
|
+
declare const SearchKnowledgeBasesCommand_base: {
|
|
25
|
+
new (input: SearchKnowledgeBasesCommandInput): import("@smithy/core/client").CommandImpl<SearchKnowledgeBasesCommandInput, SearchKnowledgeBasesCommandOutput, QuickSightClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
26
|
+
new (input: SearchKnowledgeBasesCommandInput): import("@smithy/core/client").CommandImpl<SearchKnowledgeBasesCommandInput, SearchKnowledgeBasesCommandOutput, QuickSightClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
27
|
+
getEndpointParameterInstructions(): {
|
|
28
|
+
[x: string]: unknown;
|
|
29
|
+
};
|
|
30
|
+
};
|
|
31
|
+
/**
|
|
32
|
+
* <p>Searches for a subset of knowledge bases based on specified filters.</p>
|
|
33
|
+
* @example
|
|
34
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
35
|
+
* ```javascript
|
|
36
|
+
* import { QuickSightClient, SearchKnowledgeBasesCommand } from "@aws-sdk/client-quicksight"; // ES Modules import
|
|
37
|
+
* // const { QuickSightClient, SearchKnowledgeBasesCommand } = require("@aws-sdk/client-quicksight"); // CommonJS import
|
|
38
|
+
* // import type { QuickSightClientConfig } from "@aws-sdk/client-quicksight";
|
|
39
|
+
* const config = {}; // type is QuickSightClientConfig
|
|
40
|
+
* const client = new QuickSightClient(config);
|
|
41
|
+
* const input = { // SearchKnowledgeBasesRequest
|
|
42
|
+
* AwsAccountId: "STRING_VALUE", // required
|
|
43
|
+
* NextToken: "STRING_VALUE",
|
|
44
|
+
* MaxResults: Number("int"),
|
|
45
|
+
* Filters: [ // KnowledgeBaseSearchFilters
|
|
46
|
+
* { // KnowledgeBaseSearchFilter
|
|
47
|
+
* name: "KNOWLEDGE_BASE_ID" || "KNOWLEDGE_BASE_NAME" || "DIRECT_QUICKSIGHT_OWNER" || "DIRECT_QUICKSIGHT_VIEWER_OR_OWNER" || "DIRECT_QUICKSIGHT_SOLE_OWNER" || "KNOWLEDGE_BASE_SIZE_BYTES" || "PRIMARY_OWNER", // required
|
|
48
|
+
* operator: "STRING_EQUALS" || "STRING_LIKE" || "GREATER_THAN_OR_EQUALS" || "LESS_THAN_OR_EQUALS", // required
|
|
49
|
+
* value: "STRING_VALUE", // required
|
|
50
|
+
* },
|
|
51
|
+
* ],
|
|
52
|
+
* SortBy: { // KnowledgeBaseSortBy
|
|
53
|
+
* sortByField: "KNOWLEDGE_BASE_SIZE_BYTES" || "CREATED_AT", // required
|
|
54
|
+
* sortOrder: "ASC" || "DESC", // required
|
|
55
|
+
* },
|
|
56
|
+
* };
|
|
57
|
+
* const command = new SearchKnowledgeBasesCommand(input);
|
|
58
|
+
* const response = await client.send(command);
|
|
59
|
+
* // { // SearchKnowledgeBasesResponse
|
|
60
|
+
* // KnowledgeBaseSummaries: [ // KnowledgeBaseSummaries // required
|
|
61
|
+
* // { // KnowledgeBaseSummary
|
|
62
|
+
* // KnowledgeBaseArn: "STRING_VALUE", // required
|
|
63
|
+
* // KnowledgeBaseId: "STRING_VALUE", // required
|
|
64
|
+
* // Name: "STRING_VALUE", // required
|
|
65
|
+
* // Status: "CREATING" || "UPDATING" || "ACTIVE" || "FAILED" || "DELETING", // required
|
|
66
|
+
* // DataSourceArn: "STRING_VALUE", // required
|
|
67
|
+
* // Type: "STRING_VALUE",
|
|
68
|
+
* // CreatedAt: new Date("TIMESTAMP"),
|
|
69
|
+
* // UpdatedAt: new Date("TIMESTAMP"),
|
|
70
|
+
* // KnowledgeBaseSizeBytes: Number("long"),
|
|
71
|
+
* // DocumentCount: Number("long"),
|
|
72
|
+
* // PrimaryOwnerArn: "STRING_VALUE",
|
|
73
|
+
* // PrimaryOwnerUsername: "STRING_VALUE",
|
|
74
|
+
* // },
|
|
75
|
+
* // ],
|
|
76
|
+
* // NextToken: "STRING_VALUE",
|
|
77
|
+
* // RequestId: "STRING_VALUE",
|
|
78
|
+
* // Status: Number("int"),
|
|
79
|
+
* // };
|
|
80
|
+
*
|
|
81
|
+
* ```
|
|
82
|
+
*
|
|
83
|
+
* @param SearchKnowledgeBasesCommandInput - {@link SearchKnowledgeBasesCommandInput}
|
|
84
|
+
* @returns {@link SearchKnowledgeBasesCommandOutput}
|
|
85
|
+
* @see {@link SearchKnowledgeBasesCommandInput} for command's `input` shape.
|
|
86
|
+
* @see {@link SearchKnowledgeBasesCommandOutput} for command's `response` shape.
|
|
87
|
+
* @see {@link QuickSightClientResolvedConfig | config} for QuickSightClient's `config` shape.
|
|
88
|
+
*
|
|
89
|
+
* @throws {@link AccessDeniedException} (client fault)
|
|
90
|
+
* <p>You don't have access to this item. The provided credentials couldn't be
|
|
91
|
+
* validated. You might not be authorized to carry out the request. Make sure that your
|
|
92
|
+
* account is authorized to use the Amazon Quick Sight service, that your policies have the
|
|
93
|
+
* correct permissions, and that you are using the correct credentials.</p>
|
|
94
|
+
*
|
|
95
|
+
* @throws {@link InternalFailureException} (server fault)
|
|
96
|
+
* <p>An internal failure occurred.</p>
|
|
97
|
+
*
|
|
98
|
+
* @throws {@link InvalidNextTokenException} (client fault)
|
|
99
|
+
* <p>The <code>NextToken</code> value isn't valid.</p>
|
|
100
|
+
*
|
|
101
|
+
* @throws {@link InvalidParameterValueException} (client fault)
|
|
102
|
+
* <p>One or more parameters has a value that isn't valid.</p>
|
|
103
|
+
*
|
|
104
|
+
* @throws {@link PreconditionNotMetException} (client fault)
|
|
105
|
+
* <p>One or more preconditions aren't met.</p>
|
|
106
|
+
*
|
|
107
|
+
* @throws {@link ResourceNotFoundException} (client fault)
|
|
108
|
+
* <p>One or more resources can't be found.</p>
|
|
109
|
+
*
|
|
110
|
+
* @throws {@link ThrottlingException} (client fault)
|
|
111
|
+
* <p>Access is throttled.</p>
|
|
112
|
+
*
|
|
113
|
+
* @throws {@link QuickSightServiceException}
|
|
114
|
+
* <p>Base exception class for all service exceptions from QuickSight service.</p>
|
|
115
|
+
*
|
|
116
|
+
*
|
|
117
|
+
* @public
|
|
118
|
+
*/
|
|
119
|
+
export declare class SearchKnowledgeBasesCommand extends SearchKnowledgeBasesCommand_base {
|
|
120
|
+
/** @internal type navigation helper, not in runtime. */
|
|
121
|
+
protected static __types: {
|
|
122
|
+
api: {
|
|
123
|
+
input: SearchKnowledgeBasesRequest;
|
|
124
|
+
output: SearchKnowledgeBasesResponse;
|
|
125
|
+
};
|
|
126
|
+
sdk: {
|
|
127
|
+
input: SearchKnowledgeBasesCommandInput;
|
|
128
|
+
output: SearchKnowledgeBasesCommandOutput;
|
|
129
|
+
};
|
|
130
|
+
};
|
|
131
|
+
}
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
import { Command as $Command } from "@smithy/core/client";
|
|
2
2
|
import type { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
3
|
-
import type { StartDashboardSnapshotJobRequest, StartDashboardSnapshotJobResponse } from "../models/
|
|
3
|
+
import type { StartDashboardSnapshotJobRequest, StartDashboardSnapshotJobResponse } from "../models/models_5";
|
|
4
4
|
import type { QuickSightClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../QuickSightClient";
|
|
5
5
|
/**
|
|
6
6
|
* @public
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
import { Command as $Command } from "@smithy/core/client";
|
|
2
2
|
import type { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
3
|
-
import type { StartDashboardSnapshotJobScheduleRequest, StartDashboardSnapshotJobScheduleResponse } from "../models/
|
|
3
|
+
import type { StartDashboardSnapshotJobScheduleRequest, StartDashboardSnapshotJobScheduleResponse } from "../models/models_5";
|
|
4
4
|
import type { QuickSightClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../QuickSightClient";
|
|
5
5
|
/**
|
|
6
6
|
* @public
|