@aws-sdk/client-quicksight 3.1020.0 → 3.1022.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 +14 -0
- package/dist-cjs/index.js +48 -0
- package/dist-cjs/schemas/schemas_0.js +186 -82
- package/dist-es/QuickSight.js +4 -0
- package/dist-es/commands/DescribeAutomationJobCommand.js +16 -0
- package/dist-es/commands/StartAutomationJobCommand.js +16 -0
- package/dist-es/commands/index.js +2 -0
- package/dist-es/index.js +1 -0
- package/dist-es/models/enums.js +17 -0
- package/dist-es/models/models_5.js +1 -0
- package/dist-es/schemas/schemas_0.js +160 -56
- package/dist-types/QuickSight.d.ts +14 -0
- package/dist-types/QuickSightClient.d.ts +4 -2
- package/dist-types/commands/BatchCreateTopicReviewedAnswerCommand.d.ts +1 -1
- package/dist-types/commands/CreateAnalysisCommand.d.ts +2007 -161
- package/dist-types/commands/CreateCustomPermissionsCommand.d.ts +3 -0
- package/dist-types/commands/CreateDashboardCommand.d.ts +2007 -161
- package/dist-types/commands/CreateDataSourceCommand.d.ts +9 -4
- package/dist-types/commands/CreateTemplateCommand.d.ts +2007 -161
- package/dist-types/commands/DescribeAnalysisDefinitionCommand.d.ts +2007 -161
- package/dist-types/commands/DescribeAssetBundleImportJobCommand.d.ts +2 -2
- package/dist-types/commands/DescribeAutomationJobCommand.d.ts +104 -0
- package/dist-types/commands/DescribeCustomPermissionsCommand.d.ts +3 -0
- package/dist-types/commands/DescribeDashboardDefinitionCommand.d.ts +2007 -161
- package/dist-types/commands/DescribeDataSourceCommand.d.ts +4 -4
- package/dist-types/commands/DescribeTemplateAliasCommand.d.ts +1 -2
- package/dist-types/commands/DescribeTemplateCommand.d.ts +1 -1
- package/dist-types/commands/DescribeTemplateDefinitionCommand.d.ts +2007 -161
- package/dist-types/commands/ListCustomPermissionsCommand.d.ts +3 -0
- package/dist-types/commands/ListDataSourcesCommand.d.ts +4 -4
- package/dist-types/commands/ListTopicReviewedAnswersCommand.d.ts +2 -1
- package/dist-types/commands/StartAssetBundleImportJobCommand.d.ts +2 -2
- package/dist-types/commands/StartAutomationJobCommand.d.ts +101 -0
- package/dist-types/commands/UpdateAnalysisCommand.d.ts +2007 -161
- package/dist-types/commands/UpdateCustomPermissionsCommand.d.ts +3 -0
- package/dist-types/commands/UpdateDashboardCommand.d.ts +2007 -161
- package/dist-types/commands/UpdateDataSourceCommand.d.ts +9 -4
- package/dist-types/commands/UpdateTemplateCommand.d.ts +2007 -161
- package/dist-types/commands/UpdateUserCustomPermissionCommand.d.ts +2 -1
- package/dist-types/commands/UpdateVPCConnectionCommand.d.ts +1 -1
- package/dist-types/commands/index.d.ts +2 -0
- package/dist-types/index.d.ts +1 -0
- package/dist-types/models/enums.d.ts +41 -0
- package/dist-types/models/models_0.d.ts +16 -16
- package/dist-types/models/models_1.d.ts +84 -30
- package/dist-types/models/models_2.d.ts +96 -213
- package/dist-types/models/models_3.d.ts +334 -230
- package/dist-types/models/models_4.d.ts +282 -250
- package/dist-types/models/models_5.d.ts +248 -0
- package/dist-types/schemas/schemas_0.d.ts +10 -0
- package/dist-types/ts3.4/QuickSight.d.ts +34 -0
- package/dist-types/ts3.4/QuickSightClient.d.ts +12 -0
- package/dist-types/ts3.4/commands/BatchCreateTopicReviewedAnswerCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/DescribeAutomationJobCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/DescribeTemplateAliasCommand.d.ts +4 -2
- package/dist-types/ts3.4/commands/DescribeTemplateCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/ListTopicReviewedAnswersCommand.d.ts +2 -4
- package/dist-types/ts3.4/commands/StartAutomationJobCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/UpdateUserCustomPermissionCommand.d.ts +2 -4
- package/dist-types/ts3.4/commands/UpdateVPCConnectionCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/index.d.ts +2 -0
- package/dist-types/ts3.4/index.d.ts +1 -0
- package/dist-types/ts3.4/models/enums.d.ts +23 -0
- package/dist-types/ts3.4/models/models_0.d.ts +4 -4
- package/dist-types/ts3.4/models/models_1.d.ts +21 -8
- package/dist-types/ts3.4/models/models_2.d.ts +22 -137
- package/dist-types/ts3.4/models/models_3.d.ts +171 -43
- package/dist-types/ts3.4/models/models_4.d.ts +56 -60
- package/dist-types/ts3.4/models/models_5.d.ts +62 -0
- package/dist-types/ts3.4/schemas/schemas_0.d.ts +10 -0
- package/package.json +6 -6
|
@@ -192,7 +192,7 @@ declare const DescribeAssetBundleImportJobCommand_base: {
|
|
|
192
192
|
* // Host: "STRING_VALUE", // required
|
|
193
193
|
* // Database: "STRING_VALUE", // required
|
|
194
194
|
* // Warehouse: "STRING_VALUE", // required
|
|
195
|
-
* // AuthenticationType: "PASSWORD" || "TOKEN" || "X509",
|
|
195
|
+
* // AuthenticationType: "PASSWORD" || "KEYPAIR" || "TOKEN" || "X509",
|
|
196
196
|
* // DatabaseAccessControlRole: "STRING_VALUE",
|
|
197
197
|
* // OAuthParameters: { // OAuthParameters
|
|
198
198
|
* // TokenProviderUrl: "STRING_VALUE", // required
|
|
@@ -239,7 +239,7 @@ declare const DescribeAssetBundleImportJobCommand_base: {
|
|
|
239
239
|
* // Catalog: "STRING_VALUE", // required
|
|
240
240
|
* // ProductType: "GALAXY" || "ENTERPRISE",
|
|
241
241
|
* // DatabaseAccessControlRole: "STRING_VALUE",
|
|
242
|
-
* // AuthenticationType: "PASSWORD" || "TOKEN" || "X509",
|
|
242
|
+
* // AuthenticationType: "PASSWORD" || "KEYPAIR" || "TOKEN" || "X509",
|
|
243
243
|
* // OAuthParameters: {
|
|
244
244
|
* // TokenProviderUrl: "STRING_VALUE", // required
|
|
245
245
|
* // OAuthScope: "STRING_VALUE",
|
|
@@ -0,0 +1,104 @@
|
|
|
1
|
+
import { Command as $Command } from "@smithy/smithy-client";
|
|
2
|
+
import type { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
3
|
+
import type { DescribeAutomationJobRequest, DescribeAutomationJobResponse } from "../models/models_3";
|
|
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 DescribeAutomationJobCommand}.
|
|
14
|
+
*/
|
|
15
|
+
export interface DescribeAutomationJobCommandInput extends DescribeAutomationJobRequest {
|
|
16
|
+
}
|
|
17
|
+
/**
|
|
18
|
+
* @public
|
|
19
|
+
*
|
|
20
|
+
* The output of {@link DescribeAutomationJobCommand}.
|
|
21
|
+
*/
|
|
22
|
+
export interface DescribeAutomationJobCommandOutput extends DescribeAutomationJobResponse, __MetadataBearer {
|
|
23
|
+
}
|
|
24
|
+
declare const DescribeAutomationJobCommand_base: {
|
|
25
|
+
new (input: DescribeAutomationJobCommandInput): import("@smithy/smithy-client").CommandImpl<DescribeAutomationJobCommandInput, DescribeAutomationJobCommandOutput, QuickSightClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
26
|
+
new (input: DescribeAutomationJobCommandInput): import("@smithy/smithy-client").CommandImpl<DescribeAutomationJobCommandInput, DescribeAutomationJobCommandOutput, QuickSightClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
27
|
+
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
|
+
};
|
|
29
|
+
/**
|
|
30
|
+
* <p>Retrieves the status and details of a specified automation job, including its status and outputs.</p>
|
|
31
|
+
* @example
|
|
32
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
33
|
+
* ```javascript
|
|
34
|
+
* import { QuickSightClient, DescribeAutomationJobCommand } from "@aws-sdk/client-quicksight"; // ES Modules import
|
|
35
|
+
* // const { QuickSightClient, DescribeAutomationJobCommand } = require("@aws-sdk/client-quicksight"); // CommonJS import
|
|
36
|
+
* // import type { QuickSightClientConfig } from "@aws-sdk/client-quicksight";
|
|
37
|
+
* const config = {}; // type is QuickSightClientConfig
|
|
38
|
+
* const client = new QuickSightClient(config);
|
|
39
|
+
* const input = { // DescribeAutomationJobRequest
|
|
40
|
+
* AwsAccountId: "STRING_VALUE", // required
|
|
41
|
+
* AutomationGroupId: "STRING_VALUE", // required
|
|
42
|
+
* AutomationId: "STRING_VALUE", // required
|
|
43
|
+
* IncludeInputPayload: true || false,
|
|
44
|
+
* IncludeOutputPayload: true || false,
|
|
45
|
+
* JobId: "STRING_VALUE", // required
|
|
46
|
+
* };
|
|
47
|
+
* const command = new DescribeAutomationJobCommand(input);
|
|
48
|
+
* const response = await client.send(command);
|
|
49
|
+
* // { // DescribeAutomationJobResponse
|
|
50
|
+
* // Arn: "STRING_VALUE", // required
|
|
51
|
+
* // CreatedAt: new Date("TIMESTAMP"),
|
|
52
|
+
* // StartedAt: new Date("TIMESTAMP"),
|
|
53
|
+
* // EndedAt: new Date("TIMESTAMP"),
|
|
54
|
+
* // JobStatus: "FAILED" || "RUNNING" || "SUCCEEDED" || "QUEUED" || "STOPPED", // required
|
|
55
|
+
* // InputPayload: "STRING_VALUE",
|
|
56
|
+
* // OutputPayload: "STRING_VALUE",
|
|
57
|
+
* // RequestId: "STRING_VALUE",
|
|
58
|
+
* // };
|
|
59
|
+
*
|
|
60
|
+
* ```
|
|
61
|
+
*
|
|
62
|
+
* @param DescribeAutomationJobCommandInput - {@link DescribeAutomationJobCommandInput}
|
|
63
|
+
* @returns {@link DescribeAutomationJobCommandOutput}
|
|
64
|
+
* @see {@link DescribeAutomationJobCommandInput} for command's `input` shape.
|
|
65
|
+
* @see {@link DescribeAutomationJobCommandOutput} for command's `response` shape.
|
|
66
|
+
* @see {@link QuickSightClientResolvedConfig | config} for QuickSightClient's `config` shape.
|
|
67
|
+
*
|
|
68
|
+
* @throws {@link AccessDeniedException} (client fault)
|
|
69
|
+
* <p>You don't have access to this item. The provided credentials couldn't be
|
|
70
|
+
* validated. You might not be authorized to carry out the request. Make sure that your
|
|
71
|
+
* account is authorized to use the Amazon Quick Sight service, that your policies have the
|
|
72
|
+
* correct permissions, and that you are using the correct credentials.</p>
|
|
73
|
+
*
|
|
74
|
+
* @throws {@link InternalFailureException} (server fault)
|
|
75
|
+
* <p>An internal failure occurred.</p>
|
|
76
|
+
*
|
|
77
|
+
* @throws {@link InvalidParameterValueException} (client fault)
|
|
78
|
+
* <p>One or more parameters has a value that isn't valid.</p>
|
|
79
|
+
*
|
|
80
|
+
* @throws {@link ResourceNotFoundException} (client fault)
|
|
81
|
+
* <p>One or more resources can't be found.</p>
|
|
82
|
+
*
|
|
83
|
+
* @throws {@link ThrottlingException} (client fault)
|
|
84
|
+
* <p>Access is throttled.</p>
|
|
85
|
+
*
|
|
86
|
+
* @throws {@link QuickSightServiceException}
|
|
87
|
+
* <p>Base exception class for all service exceptions from QuickSight service.</p>
|
|
88
|
+
*
|
|
89
|
+
*
|
|
90
|
+
* @public
|
|
91
|
+
*/
|
|
92
|
+
export declare class DescribeAutomationJobCommand extends DescribeAutomationJobCommand_base {
|
|
93
|
+
/** @internal type navigation helper, not in runtime. */
|
|
94
|
+
protected static __types: {
|
|
95
|
+
api: {
|
|
96
|
+
input: DescribeAutomationJobRequest;
|
|
97
|
+
output: DescribeAutomationJobResponse;
|
|
98
|
+
};
|
|
99
|
+
sdk: {
|
|
100
|
+
input: DescribeAutomationJobCommandInput;
|
|
101
|
+
output: DescribeAutomationJobCommandOutput;
|
|
102
|
+
};
|
|
103
|
+
};
|
|
104
|
+
}
|
|
@@ -259,8 +259,11 @@ declare const DescribeCustomPermissionsCommand_base: {
|
|
|
259
259
|
* // BuildCalculatedFieldWithQ: "DENY",
|
|
260
260
|
* // CreateDashboardExecutiveSummaryWithQ: "DENY",
|
|
261
261
|
* // Space: "DENY",
|
|
262
|
+
* // CreateSpaces: "DENY",
|
|
263
|
+
* // ShareSpaces: "DENY",
|
|
262
264
|
* // ChatAgent: "DENY",
|
|
263
265
|
* // CreateChatAgents: "DENY",
|
|
266
|
+
* // ShareChatAgents: "DENY",
|
|
264
267
|
* // Research: "DENY",
|
|
265
268
|
* // SelfUpgradeUserRole: "DENY",
|
|
266
269
|
* // Extension: "DENY",
|