@aws-sdk/client-quicksight 3.369.0 → 3.376.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 +24 -0
- package/dist-cjs/QuickSight.js +6 -0
- package/dist-cjs/commands/DescribeDashboardSnapshotJobCommand.js +47 -0
- package/dist-cjs/commands/DescribeDashboardSnapshotJobResultCommand.js +47 -0
- package/dist-cjs/commands/StartDashboardSnapshotJobCommand.js +47 -0
- package/dist-cjs/commands/UpdateDataSetCommand.js +2 -2
- package/dist-cjs/commands/UpdateDataSourceCommand.js +2 -2
- package/dist-cjs/commands/UpdateTemplateCommand.js +2 -2
- package/dist-cjs/commands/index.js +3 -0
- package/dist-cjs/models/models_0.js +6 -12
- package/dist-cjs/models/models_1.js +35 -26
- package/dist-cjs/models/models_2.js +25 -3
- package/dist-cjs/models/models_3.js +39 -24
- package/dist-cjs/models/models_4.js +26 -1
- package/dist-cjs/pagination/ListGroupMembershipsPaginator.js +29 -0
- package/dist-cjs/pagination/ListGroupsPaginator.js +29 -0
- package/dist-cjs/pagination/ListIAMPolicyAssignmentsForUserPaginator.js +29 -0
- package/dist-cjs/pagination/ListIAMPolicyAssignmentsPaginator.js +29 -0
- package/dist-cjs/pagination/ListUserGroupsPaginator.js +29 -0
- package/dist-cjs/pagination/ListUsersPaginator.js +29 -0
- package/dist-cjs/pagination/SearchGroupsPaginator.js +29 -0
- package/dist-cjs/pagination/index.js +7 -0
- package/dist-cjs/protocols/Aws_restJson1.js +326 -6
- package/dist-es/QuickSight.js +6 -0
- package/dist-es/commands/DescribeDashboardSnapshotJobCommand.js +43 -0
- package/dist-es/commands/DescribeDashboardSnapshotJobResultCommand.js +43 -0
- package/dist-es/commands/StartDashboardSnapshotJobCommand.js +43 -0
- package/dist-es/commands/UpdateDataSetCommand.js +1 -1
- package/dist-es/commands/UpdateDataSourceCommand.js +1 -1
- package/dist-es/commands/UpdateTemplateCommand.js +1 -1
- package/dist-es/commands/index.js +3 -0
- package/dist-es/models/models_0.js +3 -7
- package/dist-es/models/models_1.js +26 -22
- package/dist-es/models/models_2.js +22 -0
- package/dist-es/models/models_3.js +30 -19
- package/dist-es/models/models_4.js +22 -0
- package/dist-es/pagination/ListGroupMembershipsPaginator.js +25 -0
- package/dist-es/pagination/ListGroupsPaginator.js +25 -0
- package/dist-es/pagination/ListIAMPolicyAssignmentsForUserPaginator.js +25 -0
- package/dist-es/pagination/ListIAMPolicyAssignmentsPaginator.js +25 -0
- package/dist-es/pagination/ListUserGroupsPaginator.js +25 -0
- package/dist-es/pagination/ListUsersPaginator.js +25 -0
- package/dist-es/pagination/SearchGroupsPaginator.js +25 -0
- package/dist-es/pagination/index.js +7 -0
- package/dist-es/protocols/Aws_restJson1.js +314 -0
- package/dist-types/QuickSight.d.ts +21 -0
- package/dist-types/QuickSightClient.d.ts +5 -2
- package/dist-types/commands/CreateAnalysisCommand.d.ts +48 -0
- package/dist-types/commands/CreateDashboardCommand.d.ts +48 -0
- package/dist-types/commands/CreateTemplateCommand.d.ts +48 -0
- package/dist-types/commands/DeleteAccountCustomizationCommand.d.ts +6 -0
- package/dist-types/commands/DeleteAccountSubscriptionCommand.d.ts +1 -1
- package/dist-types/commands/DeleteAnalysisCommand.d.ts +1 -1
- package/dist-types/commands/DeleteDashboardCommand.d.ts +1 -1
- package/dist-types/commands/DeleteDataSetCommand.d.ts +1 -1
- package/dist-types/commands/DeleteDataSetRefreshPropertiesCommand.d.ts +1 -1
- package/dist-types/commands/DeleteDataSourceCommand.d.ts +1 -1
- package/dist-types/commands/DeleteFolderCommand.d.ts +1 -2
- package/dist-types/commands/DescribeAnalysisDefinitionCommand.d.ts +48 -0
- package/dist-types/commands/DescribeDashboardDefinitionCommand.d.ts +48 -0
- package/dist-types/commands/DescribeDashboardSnapshotJobCommand.d.ts +179 -0
- package/dist-types/commands/DescribeDashboardSnapshotJobResultCommand.d.ts +155 -0
- package/dist-types/commands/DescribeTemplateDefinitionCommand.d.ts +48 -0
- package/dist-types/commands/StartDashboardSnapshotJobCommand.d.ts +197 -0
- package/dist-types/commands/UpdateAnalysisCommand.d.ts +48 -0
- package/dist-types/commands/UpdateDashboardCommand.d.ts +48 -0
- package/dist-types/commands/UpdateDashboardPermissionsCommand.d.ts +1 -1
- package/dist-types/commands/UpdateDashboardPublishedVersionCommand.d.ts +1 -1
- package/dist-types/commands/UpdateDataSetCommand.d.ts +1 -1
- package/dist-types/commands/UpdateDataSetPermissionsCommand.d.ts +1 -1
- package/dist-types/commands/UpdateDataSourceCommand.d.ts +1 -1
- package/dist-types/commands/UpdateDataSourcePermissionsCommand.d.ts +1 -1
- package/dist-types/commands/UpdateFolderCommand.d.ts +1 -1
- package/dist-types/commands/UpdateFolderPermissionsCommand.d.ts +1 -1
- package/dist-types/commands/UpdateGroupCommand.d.ts +1 -1
- package/dist-types/commands/UpdateIAMPolicyAssignmentCommand.d.ts +1 -1
- package/dist-types/commands/UpdateIpRestrictionCommand.d.ts +1 -1
- package/dist-types/commands/UpdatePublicSharingSettingsCommand.d.ts +1 -1
- package/dist-types/commands/UpdateRefreshScheduleCommand.d.ts +1 -1
- package/dist-types/commands/UpdateTemplateAliasCommand.d.ts +1 -2
- package/dist-types/commands/UpdateTemplateCommand.d.ts +49 -1
- package/dist-types/commands/index.d.ts +3 -0
- package/dist-types/models/models_0.d.ts +77 -47
- package/dist-types/models/models_1.d.ts +208 -213
- package/dist-types/models/models_2.d.ts +219 -220
- package/dist-types/models/models_3.d.ts +602 -805
- package/dist-types/models/models_4.d.ts +770 -2
- package/dist-types/pagination/ListGroupMembershipsPaginator.d.ts +7 -0
- package/dist-types/pagination/ListGroupsPaginator.d.ts +7 -0
- package/dist-types/pagination/ListIAMPolicyAssignmentsForUserPaginator.d.ts +7 -0
- package/dist-types/pagination/ListIAMPolicyAssignmentsPaginator.d.ts +7 -0
- package/dist-types/pagination/ListUserGroupsPaginator.d.ts +7 -0
- package/dist-types/pagination/ListUsersPaginator.d.ts +7 -0
- package/dist-types/pagination/SearchGroupsPaginator.d.ts +7 -0
- package/dist-types/pagination/index.d.ts +7 -0
- package/dist-types/protocols/Aws_restJson1.d.ts +27 -0
- package/dist-types/ts3.4/QuickSight.d.ts +57 -0
- package/dist-types/ts3.4/QuickSightClient.d.ts +18 -0
- package/dist-types/ts3.4/commands/DeleteAccountSubscriptionCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/DeleteAnalysisCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/DeleteDashboardCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/DeleteDataSetCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/DeleteDataSetRefreshPropertiesCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/DeleteDataSourceCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/DeleteFolderCommand.d.ts +1 -2
- package/dist-types/ts3.4/commands/DescribeDashboardSnapshotJobCommand.d.ts +42 -0
- package/dist-types/ts3.4/commands/DescribeDashboardSnapshotJobResultCommand.d.ts +42 -0
- package/dist-types/ts3.4/commands/StartDashboardSnapshotJobCommand.d.ts +42 -0
- package/dist-types/ts3.4/commands/UpdateDashboardPermissionsCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/UpdateDashboardPublishedVersionCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/UpdateDataSetCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/UpdateDataSetPermissionsCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/UpdateDataSourceCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/UpdateDataSourcePermissionsCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/UpdateFolderCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/UpdateFolderPermissionsCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/UpdateGroupCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/UpdateIAMPolicyAssignmentCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/UpdateIpRestrictionCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/UpdatePublicSharingSettingsCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/UpdateRefreshScheduleCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/UpdateTemplateAliasCommand.d.ts +4 -2
- package/dist-types/ts3.4/commands/UpdateTemplateCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/index.d.ts +3 -0
- package/dist-types/ts3.4/models/models_0.d.ts +21 -17
- package/dist-types/ts3.4/models/models_1.d.ts +71 -81
- package/dist-types/ts3.4/models/models_2.d.ts +85 -67
- package/dist-types/ts3.4/models/models_3.d.ts +176 -222
- package/dist-types/ts3.4/models/models_4.d.ts +222 -1
- package/dist-types/ts3.4/pagination/ListGroupMembershipsPaginator.d.ts +11 -0
- package/dist-types/ts3.4/pagination/ListGroupsPaginator.d.ts +11 -0
- package/dist-types/ts3.4/pagination/ListIAMPolicyAssignmentsForUserPaginator.d.ts +11 -0
- package/dist-types/ts3.4/pagination/ListIAMPolicyAssignmentsPaginator.d.ts +11 -0
- package/dist-types/ts3.4/pagination/ListUserGroupsPaginator.d.ts +11 -0
- package/dist-types/ts3.4/pagination/ListUsersPaginator.d.ts +11 -0
- package/dist-types/ts3.4/pagination/SearchGroupsPaginator.d.ts +11 -0
- package/dist-types/ts3.4/pagination/index.d.ts +7 -0
- package/dist-types/ts3.4/protocols/Aws_restJson1.d.ts +36 -0
- package/package.json +16 -17
|
@@ -0,0 +1,155 @@
|
|
|
1
|
+
import { EndpointParameterInstructions } from "@smithy/middleware-endpoint";
|
|
2
|
+
import { Command as $Command } from "@smithy/smithy-client";
|
|
3
|
+
import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@smithy/types";
|
|
4
|
+
import { DescribeDashboardSnapshotJobResultRequest, DescribeDashboardSnapshotJobResultResponse } from "../models/models_3";
|
|
5
|
+
import { QuickSightClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../QuickSightClient";
|
|
6
|
+
/**
|
|
7
|
+
* @public
|
|
8
|
+
*/
|
|
9
|
+
export { __MetadataBearer, $Command };
|
|
10
|
+
/**
|
|
11
|
+
* @public
|
|
12
|
+
*
|
|
13
|
+
* The input for {@link DescribeDashboardSnapshotJobResultCommand}.
|
|
14
|
+
*/
|
|
15
|
+
export interface DescribeDashboardSnapshotJobResultCommandInput extends DescribeDashboardSnapshotJobResultRequest {
|
|
16
|
+
}
|
|
17
|
+
/**
|
|
18
|
+
* @public
|
|
19
|
+
*
|
|
20
|
+
* The output of {@link DescribeDashboardSnapshotJobResultCommand}.
|
|
21
|
+
*/
|
|
22
|
+
export interface DescribeDashboardSnapshotJobResultCommandOutput extends DescribeDashboardSnapshotJobResultResponse, __MetadataBearer {
|
|
23
|
+
}
|
|
24
|
+
/**
|
|
25
|
+
* @public
|
|
26
|
+
* <p>Describes the result of an existing snapshot job that has finished running.</p>
|
|
27
|
+
* <p>A finished snapshot job will return a <code>COMPLETED</code> or <code>FAILED</code> status when you poll the job with a <code>DescribeDashboardSnapshotJob</code> API call.</p>
|
|
28
|
+
* <p>If the job has not finished running, this operation returns a message that says <code>Dashboard Snapshot Job with id <SnapshotjobId> has not reached a terminal state.</code>.</p>
|
|
29
|
+
* @example
|
|
30
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
31
|
+
* ```javascript
|
|
32
|
+
* import { QuickSightClient, DescribeDashboardSnapshotJobResultCommand } from "@aws-sdk/client-quicksight"; // ES Modules import
|
|
33
|
+
* // const { QuickSightClient, DescribeDashboardSnapshotJobResultCommand } = require("@aws-sdk/client-quicksight"); // CommonJS import
|
|
34
|
+
* const client = new QuickSightClient(config);
|
|
35
|
+
* const input = { // DescribeDashboardSnapshotJobResultRequest
|
|
36
|
+
* AwsAccountId: "STRING_VALUE", // required
|
|
37
|
+
* DashboardId: "STRING_VALUE", // required
|
|
38
|
+
* SnapshotJobId: "STRING_VALUE", // required
|
|
39
|
+
* };
|
|
40
|
+
* const command = new DescribeDashboardSnapshotJobResultCommand(input);
|
|
41
|
+
* const response = await client.send(command);
|
|
42
|
+
* // { // DescribeDashboardSnapshotJobResultResponse
|
|
43
|
+
* // Arn: "STRING_VALUE",
|
|
44
|
+
* // JobStatus: "QUEUED" || "RUNNING" || "COMPLETED" || "FAILED",
|
|
45
|
+
* // CreatedTime: new Date("TIMESTAMP"),
|
|
46
|
+
* // LastUpdatedTime: new Date("TIMESTAMP"),
|
|
47
|
+
* // Result: { // SnapshotJobResult
|
|
48
|
+
* // AnonymousUsers: [ // AnonymousUserSnapshotJobResultList
|
|
49
|
+
* // { // AnonymousUserSnapshotJobResult
|
|
50
|
+
* // FileGroups: [ // SnapshotJobResultFileGroupList
|
|
51
|
+
* // { // SnapshotJobResultFileGroup
|
|
52
|
+
* // Files: [ // SnapshotFileList
|
|
53
|
+
* // { // SnapshotFile
|
|
54
|
+
* // SheetSelections: [ // SnapshotFileSheetSelectionList // required
|
|
55
|
+
* // { // SnapshotFileSheetSelection
|
|
56
|
+
* // SheetId: "STRING_VALUE", // required
|
|
57
|
+
* // SelectionScope: "ALL_VISUALS" || "SELECTED_VISUALS", // required
|
|
58
|
+
* // VisualIds: [ // SnapshotFileSheetSelectionVisualIdList
|
|
59
|
+
* // "STRING_VALUE",
|
|
60
|
+
* // ],
|
|
61
|
+
* // },
|
|
62
|
+
* // ],
|
|
63
|
+
* // FormatType: "CSV" || "PDF", // required
|
|
64
|
+
* // },
|
|
65
|
+
* // ],
|
|
66
|
+
* // S3Results: [ // SnapshotJobS3ResultList
|
|
67
|
+
* // { // SnapshotJobS3Result
|
|
68
|
+
* // S3DestinationConfiguration: { // SnapshotS3DestinationConfiguration
|
|
69
|
+
* // BucketConfiguration: { // S3BucketConfiguration
|
|
70
|
+
* // BucketName: "STRING_VALUE", // required
|
|
71
|
+
* // BucketPrefix: "STRING_VALUE", // required
|
|
72
|
+
* // BucketRegion: "STRING_VALUE", // required
|
|
73
|
+
* // },
|
|
74
|
+
* // },
|
|
75
|
+
* // S3Uri: "STRING_VALUE",
|
|
76
|
+
* // ErrorInfo: [ // SnapshotJobResultErrorInfoList
|
|
77
|
+
* // { // SnapshotJobResultErrorInfo
|
|
78
|
+
* // ErrorMessage: "STRING_VALUE",
|
|
79
|
+
* // ErrorType: "STRING_VALUE",
|
|
80
|
+
* // },
|
|
81
|
+
* // ],
|
|
82
|
+
* // },
|
|
83
|
+
* // ],
|
|
84
|
+
* // },
|
|
85
|
+
* // ],
|
|
86
|
+
* // },
|
|
87
|
+
* // ],
|
|
88
|
+
* // },
|
|
89
|
+
* // ErrorInfo: { // SnapshotJobErrorInfo
|
|
90
|
+
* // ErrorMessage: "STRING_VALUE",
|
|
91
|
+
* // ErrorType: "STRING_VALUE",
|
|
92
|
+
* // },
|
|
93
|
+
* // RequestId: "STRING_VALUE",
|
|
94
|
+
* // Status: Number("int"),
|
|
95
|
+
* // };
|
|
96
|
+
*
|
|
97
|
+
* ```
|
|
98
|
+
*
|
|
99
|
+
* @param DescribeDashboardSnapshotJobResultCommandInput - {@link DescribeDashboardSnapshotJobResultCommandInput}
|
|
100
|
+
* @returns {@link DescribeDashboardSnapshotJobResultCommandOutput}
|
|
101
|
+
* @see {@link DescribeDashboardSnapshotJobResultCommandInput} for command's `input` shape.
|
|
102
|
+
* @see {@link DescribeDashboardSnapshotJobResultCommandOutput} for command's `response` shape.
|
|
103
|
+
* @see {@link QuickSightClientResolvedConfig | config} for QuickSightClient's `config` shape.
|
|
104
|
+
*
|
|
105
|
+
* @throws {@link AccessDeniedException} (client fault)
|
|
106
|
+
* <p>You don't have access to this item. The provided credentials couldn't be
|
|
107
|
+
* validated. You might not be authorized to carry out the request. Make sure that your
|
|
108
|
+
* account is authorized to use the Amazon QuickSight service, that your policies have the
|
|
109
|
+
* correct permissions, and that you are using the correct credentials.</p>
|
|
110
|
+
*
|
|
111
|
+
* @throws {@link InternalFailureException} (server fault)
|
|
112
|
+
* <p>An internal failure occurred.</p>
|
|
113
|
+
*
|
|
114
|
+
* @throws {@link InvalidParameterValueException} (client fault)
|
|
115
|
+
* <p>One or more parameters has a value that isn't valid.</p>
|
|
116
|
+
*
|
|
117
|
+
* @throws {@link PreconditionNotMetException} (client fault)
|
|
118
|
+
* <p>One or more preconditions aren't met.</p>
|
|
119
|
+
*
|
|
120
|
+
* @throws {@link ResourceNotFoundException} (client fault)
|
|
121
|
+
* <p>One or more resources can't be found.</p>
|
|
122
|
+
*
|
|
123
|
+
* @throws {@link ThrottlingException} (client fault)
|
|
124
|
+
* <p>Access is throttled.</p>
|
|
125
|
+
*
|
|
126
|
+
* @throws {@link UnsupportedUserEditionException} (client fault)
|
|
127
|
+
* <p>This error indicates that you are calling an operation on an Amazon QuickSight
|
|
128
|
+
* subscription where the edition doesn't include support for that operation. Amazon
|
|
129
|
+
* Amazon QuickSight currently has Standard Edition and Enterprise Edition. Not every operation and
|
|
130
|
+
* capability is available in every edition.</p>
|
|
131
|
+
*
|
|
132
|
+
* @throws {@link QuickSightServiceException}
|
|
133
|
+
* <p>Base exception class for all service exceptions from QuickSight service.</p>
|
|
134
|
+
*
|
|
135
|
+
*/
|
|
136
|
+
export declare class DescribeDashboardSnapshotJobResultCommand extends $Command<DescribeDashboardSnapshotJobResultCommandInput, DescribeDashboardSnapshotJobResultCommandOutput, QuickSightClientResolvedConfig> {
|
|
137
|
+
readonly input: DescribeDashboardSnapshotJobResultCommandInput;
|
|
138
|
+
static getEndpointParameterInstructions(): EndpointParameterInstructions;
|
|
139
|
+
/**
|
|
140
|
+
* @public
|
|
141
|
+
*/
|
|
142
|
+
constructor(input: DescribeDashboardSnapshotJobResultCommandInput);
|
|
143
|
+
/**
|
|
144
|
+
* @internal
|
|
145
|
+
*/
|
|
146
|
+
resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: QuickSightClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DescribeDashboardSnapshotJobResultCommandInput, DescribeDashboardSnapshotJobResultCommandOutput>;
|
|
147
|
+
/**
|
|
148
|
+
* @internal
|
|
149
|
+
*/
|
|
150
|
+
private serialize;
|
|
151
|
+
/**
|
|
152
|
+
* @internal
|
|
153
|
+
*/
|
|
154
|
+
private deserialize;
|
|
155
|
+
}
|
|
@@ -116,6 +116,10 @@ export interface DescribeTemplateDefinitionCommandOutput extends DescribeTemplat
|
|
|
116
116
|
* // CustomLabel: "STRING_VALUE",
|
|
117
117
|
* // },
|
|
118
118
|
* // DateTimeFormat: "STRING_VALUE",
|
|
119
|
+
* // InfoIconLabelOptions: { // SheetControlInfoIconLabelOptions
|
|
120
|
+
* // Visibility: "HIDDEN" || "VISIBLE",
|
|
121
|
+
* // InfoIconText: "STRING_VALUE",
|
|
122
|
+
* // },
|
|
119
123
|
* // },
|
|
120
124
|
* // },
|
|
121
125
|
* // List: { // ParameterListControl
|
|
@@ -144,6 +148,10 @@ export interface DescribeTemplateDefinitionCommandOutput extends DescribeTemplat
|
|
|
144
148
|
* // },
|
|
145
149
|
* // CustomLabel: "STRING_VALUE",
|
|
146
150
|
* // },
|
|
151
|
+
* // InfoIconLabelOptions: {
|
|
152
|
+
* // Visibility: "HIDDEN" || "VISIBLE",
|
|
153
|
+
* // InfoIconText: "STRING_VALUE",
|
|
154
|
+
* // },
|
|
147
155
|
* // },
|
|
148
156
|
* // Type: "MULTI_SELECT" || "SINGLE_SELECT",
|
|
149
157
|
* // SelectableValues: { // ParameterSelectableValues
|
|
@@ -190,6 +198,10 @@ export interface DescribeTemplateDefinitionCommandOutput extends DescribeTemplat
|
|
|
190
198
|
* // },
|
|
191
199
|
* // CustomLabel: "STRING_VALUE",
|
|
192
200
|
* // },
|
|
201
|
+
* // InfoIconLabelOptions: {
|
|
202
|
+
* // Visibility: "HIDDEN" || "VISIBLE",
|
|
203
|
+
* // InfoIconText: "STRING_VALUE",
|
|
204
|
+
* // },
|
|
193
205
|
* // },
|
|
194
206
|
* // Type: "MULTI_SELECT" || "SINGLE_SELECT",
|
|
195
207
|
* // SelectableValues: {
|
|
@@ -236,6 +248,10 @@ export interface DescribeTemplateDefinitionCommandOutput extends DescribeTemplat
|
|
|
236
248
|
* // PlaceholderOptions: { // TextControlPlaceholderOptions
|
|
237
249
|
* // Visibility: "HIDDEN" || "VISIBLE",
|
|
238
250
|
* // },
|
|
251
|
+
* // InfoIconLabelOptions: {
|
|
252
|
+
* // Visibility: "HIDDEN" || "VISIBLE",
|
|
253
|
+
* // InfoIconText: "STRING_VALUE",
|
|
254
|
+
* // },
|
|
239
255
|
* // },
|
|
240
256
|
* // },
|
|
241
257
|
* // TextArea: { // ParameterTextAreaControl
|
|
@@ -262,6 +278,10 @@ export interface DescribeTemplateDefinitionCommandOutput extends DescribeTemplat
|
|
|
262
278
|
* // PlaceholderOptions: {
|
|
263
279
|
* // Visibility: "HIDDEN" || "VISIBLE",
|
|
264
280
|
* // },
|
|
281
|
+
* // InfoIconLabelOptions: {
|
|
282
|
+
* // Visibility: "HIDDEN" || "VISIBLE",
|
|
283
|
+
* // InfoIconText: "STRING_VALUE",
|
|
284
|
+
* // },
|
|
265
285
|
* // },
|
|
266
286
|
* // },
|
|
267
287
|
* // Slider: { // ParameterSliderControl
|
|
@@ -270,6 +290,7 @@ export interface DescribeTemplateDefinitionCommandOutput extends DescribeTemplat
|
|
|
270
290
|
* // SourceParameterName: "STRING_VALUE", // required
|
|
271
291
|
* // DisplayOptions: { // SliderControlDisplayOptions
|
|
272
292
|
* // TitleOptions: "<LabelOptions>",
|
|
293
|
+
* // InfoIconLabelOptions: "<SheetControlInfoIconLabelOptions>",
|
|
273
294
|
* // },
|
|
274
295
|
* // MaximumValue: Number("double"), // required
|
|
275
296
|
* // MinimumValue: Number("double"), // required
|
|
@@ -286,6 +307,7 @@ export interface DescribeTemplateDefinitionCommandOutput extends DescribeTemplat
|
|
|
286
307
|
* // DisplayOptions: {
|
|
287
308
|
* // TitleOptions: "<LabelOptions>",
|
|
288
309
|
* // DateTimeFormat: "STRING_VALUE",
|
|
310
|
+
* // InfoIconLabelOptions: "<SheetControlInfoIconLabelOptions>",
|
|
289
311
|
* // },
|
|
290
312
|
* // Type: "SINGLE_VALUED" || "DATE_RANGE",
|
|
291
313
|
* // },
|
|
@@ -301,6 +323,7 @@ export interface DescribeTemplateDefinitionCommandOutput extends DescribeTemplat
|
|
|
301
323
|
* // Visibility: "HIDDEN" || "VISIBLE",
|
|
302
324
|
* // },
|
|
303
325
|
* // TitleOptions: "<LabelOptions>",
|
|
326
|
+
* // InfoIconLabelOptions: "<SheetControlInfoIconLabelOptions>",
|
|
304
327
|
* // },
|
|
305
328
|
* // Type: "MULTI_SELECT" || "SINGLE_SELECT",
|
|
306
329
|
* // SelectableValues: { // FilterSelectableValues
|
|
@@ -329,6 +352,7 @@ export interface DescribeTemplateDefinitionCommandOutput extends DescribeTemplat
|
|
|
329
352
|
* // Visibility: "HIDDEN" || "VISIBLE",
|
|
330
353
|
* // },
|
|
331
354
|
* // TitleOptions: "<LabelOptions>",
|
|
355
|
+
* // InfoIconLabelOptions: "<SheetControlInfoIconLabelOptions>",
|
|
332
356
|
* // },
|
|
333
357
|
* // Type: "MULTI_SELECT" || "SINGLE_SELECT",
|
|
334
358
|
* // SelectableValues: {
|
|
@@ -354,6 +378,7 @@ export interface DescribeTemplateDefinitionCommandOutput extends DescribeTemplat
|
|
|
354
378
|
* // PlaceholderOptions: {
|
|
355
379
|
* // Visibility: "HIDDEN" || "VISIBLE",
|
|
356
380
|
* // },
|
|
381
|
+
* // InfoIconLabelOptions: "<SheetControlInfoIconLabelOptions>",
|
|
357
382
|
* // },
|
|
358
383
|
* // },
|
|
359
384
|
* // TextArea: { // FilterTextAreaControl
|
|
@@ -366,6 +391,7 @@ export interface DescribeTemplateDefinitionCommandOutput extends DescribeTemplat
|
|
|
366
391
|
* // PlaceholderOptions: {
|
|
367
392
|
* // Visibility: "HIDDEN" || "VISIBLE",
|
|
368
393
|
* // },
|
|
394
|
+
* // InfoIconLabelOptions: "<SheetControlInfoIconLabelOptions>",
|
|
369
395
|
* // },
|
|
370
396
|
* // },
|
|
371
397
|
* // Slider: { // FilterSliderControl
|
|
@@ -374,6 +400,7 @@ export interface DescribeTemplateDefinitionCommandOutput extends DescribeTemplat
|
|
|
374
400
|
* // SourceFilterId: "STRING_VALUE", // required
|
|
375
401
|
* // DisplayOptions: {
|
|
376
402
|
* // TitleOptions: "<LabelOptions>",
|
|
403
|
+
* // InfoIconLabelOptions: "<SheetControlInfoIconLabelOptions>",
|
|
377
404
|
* // },
|
|
378
405
|
* // Type: "SINGLE_POINT" || "RANGE",
|
|
379
406
|
* // MaximumValue: Number("double"), // required
|
|
@@ -387,6 +414,7 @@ export interface DescribeTemplateDefinitionCommandOutput extends DescribeTemplat
|
|
|
387
414
|
* // DisplayOptions: { // RelativeDateTimeControlDisplayOptions
|
|
388
415
|
* // TitleOptions: "<LabelOptions>",
|
|
389
416
|
* // DateTimeFormat: "STRING_VALUE",
|
|
417
|
+
* // InfoIconLabelOptions: "<SheetControlInfoIconLabelOptions>",
|
|
390
418
|
* // },
|
|
391
419
|
* // },
|
|
392
420
|
* // },
|
|
@@ -727,6 +755,10 @@ export interface DescribeTemplateDefinitionCommandOutput extends DescribeTemplat
|
|
|
727
755
|
* // },
|
|
728
756
|
* // CategoricalAggregationFunction: "COUNT" || "DISTINCT_COUNT",
|
|
729
757
|
* // DateAggregationFunction: "COUNT" || "DISTINCT_COUNT" || "MIN" || "MAX",
|
|
758
|
+
* // AttributeAggregationFunction: { // AttributeAggregationFunction
|
|
759
|
+
* // SimpleAttributeAggregation: "UNIQUE_VALUE",
|
|
760
|
+
* // ValueForMultipleValues: "STRING_VALUE",
|
|
761
|
+
* // },
|
|
730
762
|
* // },
|
|
731
763
|
* // },
|
|
732
764
|
* // },
|
|
@@ -1187,6 +1219,10 @@ export interface DescribeTemplateDefinitionCommandOutput extends DescribeTemplat
|
|
|
1187
1219
|
* // },
|
|
1188
1220
|
* // CategoricalAggregationFunction: "COUNT" || "DISTINCT_COUNT",
|
|
1189
1221
|
* // DateAggregationFunction: "COUNT" || "DISTINCT_COUNT" || "MIN" || "MAX",
|
|
1222
|
+
* // AttributeAggregationFunction: {
|
|
1223
|
+
* // SimpleAttributeAggregation: "UNIQUE_VALUE",
|
|
1224
|
+
* // ValueForMultipleValues: "STRING_VALUE",
|
|
1225
|
+
* // },
|
|
1190
1226
|
* // },
|
|
1191
1227
|
* // },
|
|
1192
1228
|
* // DataPath: { // DataPathSort
|
|
@@ -1578,6 +1614,10 @@ export interface DescribeTemplateDefinitionCommandOutput extends DescribeTemplat
|
|
|
1578
1614
|
* // NumericalAggregationFunction: "<NumericalAggregationFunction>",
|
|
1579
1615
|
* // CategoricalAggregationFunction: "COUNT" || "DISTINCT_COUNT",
|
|
1580
1616
|
* // DateAggregationFunction: "COUNT" || "DISTINCT_COUNT" || "MIN" || "MAX",
|
|
1617
|
+
* // AttributeAggregationFunction: {
|
|
1618
|
+
* // SimpleAttributeAggregation: "UNIQUE_VALUE",
|
|
1619
|
+
* // ValueForMultipleValues: "STRING_VALUE",
|
|
1620
|
+
* // },
|
|
1581
1621
|
* // },
|
|
1582
1622
|
* // },
|
|
1583
1623
|
* // },
|
|
@@ -1599,6 +1639,10 @@ export interface DescribeTemplateDefinitionCommandOutput extends DescribeTemplat
|
|
|
1599
1639
|
* // NumericalAggregationFunction: "<NumericalAggregationFunction>",
|
|
1600
1640
|
* // CategoricalAggregationFunction: "COUNT" || "DISTINCT_COUNT",
|
|
1601
1641
|
* // DateAggregationFunction: "COUNT" || "DISTINCT_COUNT" || "MIN" || "MAX",
|
|
1642
|
+
* // AttributeAggregationFunction: {
|
|
1643
|
+
* // SimpleAttributeAggregation: "UNIQUE_VALUE",
|
|
1644
|
+
* // ValueForMultipleValues: "STRING_VALUE",
|
|
1645
|
+
* // },
|
|
1602
1646
|
* // },
|
|
1603
1647
|
* // },
|
|
1604
1648
|
* // },
|
|
@@ -1620,6 +1664,10 @@ export interface DescribeTemplateDefinitionCommandOutput extends DescribeTemplat
|
|
|
1620
1664
|
* // NumericalAggregationFunction: "<NumericalAggregationFunction>",
|
|
1621
1665
|
* // CategoricalAggregationFunction: "COUNT" || "DISTINCT_COUNT",
|
|
1622
1666
|
* // DateAggregationFunction: "COUNT" || "DISTINCT_COUNT" || "MIN" || "MAX",
|
|
1667
|
+
* // AttributeAggregationFunction: {
|
|
1668
|
+
* // SimpleAttributeAggregation: "UNIQUE_VALUE",
|
|
1669
|
+
* // ValueForMultipleValues: "STRING_VALUE",
|
|
1670
|
+
* // },
|
|
1623
1671
|
* // },
|
|
1624
1672
|
* // },
|
|
1625
1673
|
* // },
|
|
@@ -0,0 +1,197 @@
|
|
|
1
|
+
import { EndpointParameterInstructions } from "@smithy/middleware-endpoint";
|
|
2
|
+
import { Command as $Command } from "@smithy/smithy-client";
|
|
3
|
+
import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@smithy/types";
|
|
4
|
+
import { StartDashboardSnapshotJobRequest, StartDashboardSnapshotJobResponse } from "../models/models_3";
|
|
5
|
+
import { QuickSightClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../QuickSightClient";
|
|
6
|
+
/**
|
|
7
|
+
* @public
|
|
8
|
+
*/
|
|
9
|
+
export { __MetadataBearer, $Command };
|
|
10
|
+
/**
|
|
11
|
+
* @public
|
|
12
|
+
*
|
|
13
|
+
* The input for {@link StartDashboardSnapshotJobCommand}.
|
|
14
|
+
*/
|
|
15
|
+
export interface StartDashboardSnapshotJobCommandInput extends StartDashboardSnapshotJobRequest {
|
|
16
|
+
}
|
|
17
|
+
/**
|
|
18
|
+
* @public
|
|
19
|
+
*
|
|
20
|
+
* The output of {@link StartDashboardSnapshotJobCommand}.
|
|
21
|
+
*/
|
|
22
|
+
export interface StartDashboardSnapshotJobCommandOutput extends StartDashboardSnapshotJobResponse, __MetadataBearer {
|
|
23
|
+
}
|
|
24
|
+
/**
|
|
25
|
+
* @public
|
|
26
|
+
* <p>Starts an asynchronous job that generates a dashboard snapshot. You can request up to one paginated PDF and up to five CSVs per API call.</p>
|
|
27
|
+
* <p>Poll job descriptions with a <code>DescribeDashboardSnapshotJob</code> API call. Once the job succeeds, use the <code>DescribeDashboardSnapshotJobResult</code> API to obtain the download URIs that the job generates.</p>
|
|
28
|
+
* @example
|
|
29
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
30
|
+
* ```javascript
|
|
31
|
+
* import { QuickSightClient, StartDashboardSnapshotJobCommand } from "@aws-sdk/client-quicksight"; // ES Modules import
|
|
32
|
+
* // const { QuickSightClient, StartDashboardSnapshotJobCommand } = require("@aws-sdk/client-quicksight"); // CommonJS import
|
|
33
|
+
* const client = new QuickSightClient(config);
|
|
34
|
+
* const input = { // StartDashboardSnapshotJobRequest
|
|
35
|
+
* AwsAccountId: "STRING_VALUE", // required
|
|
36
|
+
* DashboardId: "STRING_VALUE", // required
|
|
37
|
+
* SnapshotJobId: "STRING_VALUE", // required
|
|
38
|
+
* UserConfiguration: { // SnapshotUserConfiguration
|
|
39
|
+
* AnonymousUsers: [ // SnapshotAnonymousUserList
|
|
40
|
+
* { // SnapshotAnonymousUser
|
|
41
|
+
* RowLevelPermissionTags: [ // SessionTagList
|
|
42
|
+
* { // SessionTag
|
|
43
|
+
* Key: "STRING_VALUE", // required
|
|
44
|
+
* Value: "STRING_VALUE", // required
|
|
45
|
+
* },
|
|
46
|
+
* ],
|
|
47
|
+
* },
|
|
48
|
+
* ],
|
|
49
|
+
* },
|
|
50
|
+
* SnapshotConfiguration: { // SnapshotConfiguration
|
|
51
|
+
* FileGroups: [ // SnapshotFileGroupList // required
|
|
52
|
+
* { // SnapshotFileGroup
|
|
53
|
+
* Files: [ // SnapshotFileList
|
|
54
|
+
* { // SnapshotFile
|
|
55
|
+
* SheetSelections: [ // SnapshotFileSheetSelectionList // required
|
|
56
|
+
* { // SnapshotFileSheetSelection
|
|
57
|
+
* SheetId: "STRING_VALUE", // required
|
|
58
|
+
* SelectionScope: "ALL_VISUALS" || "SELECTED_VISUALS", // required
|
|
59
|
+
* VisualIds: [ // SnapshotFileSheetSelectionVisualIdList
|
|
60
|
+
* "STRING_VALUE",
|
|
61
|
+
* ],
|
|
62
|
+
* },
|
|
63
|
+
* ],
|
|
64
|
+
* FormatType: "CSV" || "PDF", // required
|
|
65
|
+
* },
|
|
66
|
+
* ],
|
|
67
|
+
* },
|
|
68
|
+
* ],
|
|
69
|
+
* DestinationConfiguration: { // SnapshotDestinationConfiguration
|
|
70
|
+
* S3Destinations: [ // SnapshotS3DestinationConfigurationList
|
|
71
|
+
* { // SnapshotS3DestinationConfiguration
|
|
72
|
+
* BucketConfiguration: { // S3BucketConfiguration
|
|
73
|
+
* BucketName: "STRING_VALUE", // required
|
|
74
|
+
* BucketPrefix: "STRING_VALUE", // required
|
|
75
|
+
* BucketRegion: "STRING_VALUE", // required
|
|
76
|
+
* },
|
|
77
|
+
* },
|
|
78
|
+
* ],
|
|
79
|
+
* },
|
|
80
|
+
* Parameters: { // Parameters
|
|
81
|
+
* StringParameters: [ // StringParameterList
|
|
82
|
+
* { // StringParameter
|
|
83
|
+
* Name: "STRING_VALUE", // required
|
|
84
|
+
* Values: [ // SensitiveStringList // required
|
|
85
|
+
* "STRING_VALUE",
|
|
86
|
+
* ],
|
|
87
|
+
* },
|
|
88
|
+
* ],
|
|
89
|
+
* IntegerParameters: [ // IntegerParameterList
|
|
90
|
+
* { // IntegerParameter
|
|
91
|
+
* Name: "STRING_VALUE", // required
|
|
92
|
+
* Values: [ // SensitiveLongList // required
|
|
93
|
+
* Number("long"),
|
|
94
|
+
* ],
|
|
95
|
+
* },
|
|
96
|
+
* ],
|
|
97
|
+
* DecimalParameters: [ // DecimalParameterList
|
|
98
|
+
* { // DecimalParameter
|
|
99
|
+
* Name: "STRING_VALUE", // required
|
|
100
|
+
* Values: [ // SensitiveDoubleList // required
|
|
101
|
+
* Number("double"),
|
|
102
|
+
* ],
|
|
103
|
+
* },
|
|
104
|
+
* ],
|
|
105
|
+
* DateTimeParameters: [ // DateTimeParameterList
|
|
106
|
+
* { // DateTimeParameter
|
|
107
|
+
* Name: "STRING_VALUE", // required
|
|
108
|
+
* Values: [ // SensitiveTimestampList // required
|
|
109
|
+
* new Date("TIMESTAMP"),
|
|
110
|
+
* ],
|
|
111
|
+
* },
|
|
112
|
+
* ],
|
|
113
|
+
* },
|
|
114
|
+
* },
|
|
115
|
+
* };
|
|
116
|
+
* const command = new StartDashboardSnapshotJobCommand(input);
|
|
117
|
+
* const response = await client.send(command);
|
|
118
|
+
* // { // StartDashboardSnapshotJobResponse
|
|
119
|
+
* // Arn: "STRING_VALUE",
|
|
120
|
+
* // SnapshotJobId: "STRING_VALUE",
|
|
121
|
+
* // RequestId: "STRING_VALUE",
|
|
122
|
+
* // Status: Number("int"),
|
|
123
|
+
* // };
|
|
124
|
+
*
|
|
125
|
+
* ```
|
|
126
|
+
*
|
|
127
|
+
* @param StartDashboardSnapshotJobCommandInput - {@link StartDashboardSnapshotJobCommandInput}
|
|
128
|
+
* @returns {@link StartDashboardSnapshotJobCommandOutput}
|
|
129
|
+
* @see {@link StartDashboardSnapshotJobCommandInput} for command's `input` shape.
|
|
130
|
+
* @see {@link StartDashboardSnapshotJobCommandOutput} for command's `response` shape.
|
|
131
|
+
* @see {@link QuickSightClientResolvedConfig | config} for QuickSightClient's `config` shape.
|
|
132
|
+
*
|
|
133
|
+
* @throws {@link AccessDeniedException} (client fault)
|
|
134
|
+
* <p>You don't have access to this item. The provided credentials couldn't be
|
|
135
|
+
* validated. You might not be authorized to carry out the request. Make sure that your
|
|
136
|
+
* account is authorized to use the Amazon QuickSight service, that your policies have the
|
|
137
|
+
* correct permissions, and that you are using the correct credentials.</p>
|
|
138
|
+
*
|
|
139
|
+
* @throws {@link InternalFailureException} (server fault)
|
|
140
|
+
* <p>An internal failure occurred.</p>
|
|
141
|
+
*
|
|
142
|
+
* @throws {@link InvalidParameterValueException} (client fault)
|
|
143
|
+
* <p>One or more parameters has a value that isn't valid.</p>
|
|
144
|
+
*
|
|
145
|
+
* @throws {@link LimitExceededException} (client fault)
|
|
146
|
+
* <p>A limit is exceeded.</p>
|
|
147
|
+
*
|
|
148
|
+
* @throws {@link ResourceExistsException} (client fault)
|
|
149
|
+
* <p>The resource specified already exists. </p>
|
|
150
|
+
*
|
|
151
|
+
* @throws {@link ResourceNotFoundException} (client fault)
|
|
152
|
+
* <p>One or more resources can't be found.</p>
|
|
153
|
+
*
|
|
154
|
+
* @throws {@link ThrottlingException} (client fault)
|
|
155
|
+
* <p>Access is throttled.</p>
|
|
156
|
+
*
|
|
157
|
+
* @throws {@link UnsupportedPricingPlanException} (client fault)
|
|
158
|
+
* <p>This error indicates that you are calling an embedding operation in Amazon QuickSight
|
|
159
|
+
* without the required pricing plan on your Amazon Web Services account. Before you can use embedding
|
|
160
|
+
* for anonymous users, a QuickSight administrator needs to add capacity pricing to Amazon QuickSight. You
|
|
161
|
+
* can do this on the <b>Manage Amazon QuickSight</b> page. </p>
|
|
162
|
+
* <p>After capacity pricing is added, you can use the
|
|
163
|
+
* <code>
|
|
164
|
+
* <a href="https://docs.aws.amazon.com/quicksight/latest/APIReference/API_GetDashboardEmbedUrl.html">GetDashboardEmbedUrl</a>
|
|
165
|
+
* </code> API operation with the
|
|
166
|
+
* <code>--identity-type ANONYMOUS</code> option.</p>
|
|
167
|
+
*
|
|
168
|
+
* @throws {@link UnsupportedUserEditionException} (client fault)
|
|
169
|
+
* <p>This error indicates that you are calling an operation on an Amazon QuickSight
|
|
170
|
+
* subscription where the edition doesn't include support for that operation. Amazon
|
|
171
|
+
* Amazon QuickSight currently has Standard Edition and Enterprise Edition. Not every operation and
|
|
172
|
+
* capability is available in every edition.</p>
|
|
173
|
+
*
|
|
174
|
+
* @throws {@link QuickSightServiceException}
|
|
175
|
+
* <p>Base exception class for all service exceptions from QuickSight service.</p>
|
|
176
|
+
*
|
|
177
|
+
*/
|
|
178
|
+
export declare class StartDashboardSnapshotJobCommand extends $Command<StartDashboardSnapshotJobCommandInput, StartDashboardSnapshotJobCommandOutput, QuickSightClientResolvedConfig> {
|
|
179
|
+
readonly input: StartDashboardSnapshotJobCommandInput;
|
|
180
|
+
static getEndpointParameterInstructions(): EndpointParameterInstructions;
|
|
181
|
+
/**
|
|
182
|
+
* @public
|
|
183
|
+
*/
|
|
184
|
+
constructor(input: StartDashboardSnapshotJobCommandInput);
|
|
185
|
+
/**
|
|
186
|
+
* @internal
|
|
187
|
+
*/
|
|
188
|
+
resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: QuickSightClientResolvedConfig, options?: __HttpHandlerOptions): Handler<StartDashboardSnapshotJobCommandInput, StartDashboardSnapshotJobCommandOutput>;
|
|
189
|
+
/**
|
|
190
|
+
* @internal
|
|
191
|
+
*/
|
|
192
|
+
private serialize;
|
|
193
|
+
/**
|
|
194
|
+
* @internal
|
|
195
|
+
*/
|
|
196
|
+
private deserialize;
|
|
197
|
+
}
|