@aws-sdk/client-quicksight 3.326.0 → 3.328.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 +144 -0
- package/dist-cjs/QuickSight.js +36 -0
- package/dist-cjs/commands/CreateTopicCommand.js +46 -0
- package/dist-cjs/commands/CreateTopicRefreshScheduleCommand.js +45 -0
- package/dist-cjs/commands/CreateVPCConnectionCommand.js +45 -0
- package/dist-cjs/commands/DeleteTopicCommand.js +45 -0
- package/dist-cjs/commands/DeleteTopicRefreshScheduleCommand.js +45 -0
- package/dist-cjs/commands/DeleteVPCConnectionCommand.js +45 -0
- package/dist-cjs/commands/DescribeDataSetCommand.js +2 -2
- package/dist-cjs/commands/DescribeTemplateDefinitionCommand.js +2 -2
- package/dist-cjs/commands/DescribeTopicCommand.js +46 -0
- package/dist-cjs/commands/DescribeTopicPermissionsCommand.js +45 -0
- package/dist-cjs/commands/DescribeTopicRefreshCommand.js +45 -0
- package/dist-cjs/commands/DescribeTopicRefreshScheduleCommand.js +45 -0
- package/dist-cjs/commands/DescribeVPCConnectionCommand.js +45 -0
- package/dist-cjs/commands/ListTopicRefreshSchedulesCommand.js +45 -0
- package/dist-cjs/commands/ListTopicsCommand.js +45 -0
- package/dist-cjs/commands/ListVPCConnectionsCommand.js +45 -0
- package/dist-cjs/commands/UpdateTopicCommand.js +46 -0
- package/dist-cjs/commands/UpdateTopicPermissionsCommand.js +45 -0
- package/dist-cjs/commands/UpdateTopicRefreshScheduleCommand.js +45 -0
- package/dist-cjs/commands/UpdateVPCConnectionCommand.js +45 -0
- package/dist-cjs/commands/index.js +18 -0
- package/dist-cjs/models/models_0.js +1 -11
- package/dist-cjs/models/models_1.js +46 -50
- package/dist-cjs/models/models_2.js +262 -141
- package/dist-cjs/models/models_3.js +167 -1
- package/dist-cjs/pagination/ListTopicsPaginator.js +29 -0
- package/dist-cjs/pagination/ListVPCConnectionsPaginator.js +29 -0
- package/dist-cjs/pagination/index.js +2 -0
- package/dist-cjs/protocols/Aws_restJson1.js +2076 -307
- package/dist-es/QuickSight.js +36 -0
- package/dist-es/commands/CreateTopicCommand.js +42 -0
- package/dist-es/commands/CreateTopicRefreshScheduleCommand.js +41 -0
- package/dist-es/commands/CreateVPCConnectionCommand.js +41 -0
- package/dist-es/commands/DeleteTopicCommand.js +41 -0
- package/dist-es/commands/DeleteTopicRefreshScheduleCommand.js +41 -0
- package/dist-es/commands/DeleteVPCConnectionCommand.js +41 -0
- package/dist-es/commands/DescribeDataSetCommand.js +1 -1
- package/dist-es/commands/DescribeTemplateDefinitionCommand.js +1 -1
- package/dist-es/commands/DescribeTopicCommand.js +42 -0
- package/dist-es/commands/DescribeTopicPermissionsCommand.js +41 -0
- package/dist-es/commands/DescribeTopicRefreshCommand.js +41 -0
- package/dist-es/commands/DescribeTopicRefreshScheduleCommand.js +41 -0
- package/dist-es/commands/DescribeVPCConnectionCommand.js +41 -0
- package/dist-es/commands/ListTopicRefreshSchedulesCommand.js +41 -0
- package/dist-es/commands/ListTopicsCommand.js +41 -0
- package/dist-es/commands/ListVPCConnectionsCommand.js +41 -0
- package/dist-es/commands/UpdateTopicCommand.js +42 -0
- package/dist-es/commands/UpdateTopicPermissionsCommand.js +41 -0
- package/dist-es/commands/UpdateTopicRefreshScheduleCommand.js +41 -0
- package/dist-es/commands/UpdateVPCConnectionCommand.js +41 -0
- package/dist-es/commands/index.js +18 -0
- package/dist-es/models/models_0.js +0 -9
- package/dist-es/models/models_1.js +41 -43
- package/dist-es/models/models_2.js +242 -135
- package/dist-es/models/models_3.js +161 -1
- package/dist-es/pagination/ListTopicsPaginator.js +25 -0
- package/dist-es/pagination/ListVPCConnectionsPaginator.js +25 -0
- package/dist-es/pagination/index.js +2 -0
- package/dist-es/protocols/Aws_restJson1.js +2030 -298
- package/dist-types/QuickSight.d.ts +126 -0
- package/dist-types/QuickSightClient.d.ts +20 -2
- package/dist-types/commands/CreateAccountCustomizationCommand.d.ts +1 -1
- package/dist-types/commands/CreateAccountSubscriptionCommand.d.ts +1 -1
- package/dist-types/commands/CreateAnalysisCommand.d.ts +56 -4
- package/dist-types/commands/CreateDashboardCommand.d.ts +56 -4
- package/dist-types/commands/CreateDataSetCommand.d.ts +63 -0
- package/dist-types/commands/CreateIAMPolicyAssignmentCommand.d.ts +5 -4
- package/dist-types/commands/CreateTemplateCommand.d.ts +56 -4
- package/dist-types/commands/CreateTopicCommand.d.ts +352 -0
- package/dist-types/commands/CreateTopicRefreshScheduleCommand.d.ts +111 -0
- package/dist-types/commands/CreateVPCConnectionCommand.d.ts +122 -0
- package/dist-types/commands/DeleteTopicCommand.d.ts +94 -0
- package/dist-types/commands/DeleteTopicRefreshScheduleCommand.d.ts +102 -0
- package/dist-types/commands/DeleteVPCConnectionCommand.d.ts +102 -0
- package/dist-types/commands/DescribeAnalysisDefinitionCommand.d.ts +56 -4
- package/dist-types/commands/DescribeDashboardDefinitionCommand.d.ts +56 -4
- package/dist-types/commands/DescribeDataSetCommand.d.ts +64 -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 -1
- package/dist-types/commands/DescribeFolderCommand.d.ts +1 -1
- package/dist-types/commands/DescribeFolderPermissionsCommand.d.ts +1 -1
- package/dist-types/commands/DescribeFolderResolvedPermissionsCommand.d.ts +1 -1
- package/dist-types/commands/DescribeGroupCommand.d.ts +1 -1
- package/dist-types/commands/DescribeGroupMembershipCommand.d.ts +1 -1
- package/dist-types/commands/DescribeIAMPolicyAssignmentCommand.d.ts +3 -2
- package/dist-types/commands/DescribeIngestionCommand.d.ts +1 -1
- package/dist-types/commands/DescribeIpRestrictionCommand.d.ts +1 -1
- package/dist-types/commands/DescribeNamespaceCommand.d.ts +1 -1
- package/dist-types/commands/DescribeRefreshScheduleCommand.d.ts +1 -1
- package/dist-types/commands/DescribeTemplateAliasCommand.d.ts +1 -1
- package/dist-types/commands/DescribeTemplateCommand.d.ts +1 -1
- package/dist-types/commands/DescribeTemplateDefinitionCommand.d.ts +57 -5
- package/dist-types/commands/DescribeTemplatePermissionsCommand.d.ts +1 -1
- package/dist-types/commands/DescribeThemeAliasCommand.d.ts +1 -1
- package/dist-types/commands/DescribeThemeCommand.d.ts +1 -1
- package/dist-types/commands/DescribeThemePermissionsCommand.d.ts +1 -1
- package/dist-types/commands/DescribeTopicCommand.d.ts +336 -0
- package/dist-types/commands/DescribeTopicPermissionsCommand.d.ts +99 -0
- package/dist-types/commands/DescribeTopicRefreshCommand.d.ts +95 -0
- package/dist-types/commands/DescribeTopicRefreshScheduleCommand.d.ts +110 -0
- package/dist-types/commands/DescribeUserCommand.d.ts +1 -1
- package/dist-types/commands/DescribeVPCConnectionCommand.d.ts +121 -0
- package/dist-types/commands/GenerateEmbedUrlForRegisteredUserCommand.d.ts +3 -0
- package/dist-types/commands/ListIAMPolicyAssignmentsCommand.d.ts +3 -1
- package/dist-types/commands/ListIAMPolicyAssignmentsForUserCommand.d.ts +7 -3
- package/dist-types/commands/ListTopicRefreshSchedulesCommand.d.ts +115 -0
- package/dist-types/commands/ListTopicsCommand.d.ts +98 -0
- package/dist-types/commands/ListVPCConnectionsCommand.d.ts +126 -0
- package/dist-types/commands/TagResourceCommand.d.ts +1 -1
- package/dist-types/commands/UpdateAnalysisCommand.d.ts +56 -4
- package/dist-types/commands/UpdateDashboardCommand.d.ts +56 -4
- package/dist-types/commands/UpdateDataSetCommand.d.ts +63 -0
- package/dist-types/commands/UpdateIAMPolicyAssignmentCommand.d.ts +3 -4
- package/dist-types/commands/UpdateIpRestrictionCommand.d.ts +4 -1
- package/dist-types/commands/UpdateTemplateCommand.d.ts +56 -4
- package/dist-types/commands/UpdateTopicCommand.d.ts +346 -0
- package/dist-types/commands/UpdateTopicPermissionsCommand.d.ts +127 -0
- package/dist-types/commands/UpdateTopicRefreshScheduleCommand.d.ts +110 -0
- package/dist-types/commands/UpdateVPCConnectionCommand.d.ts +116 -0
- package/dist-types/commands/index.d.ts +18 -0
- package/dist-types/models/models_0.d.ts +43 -91
- package/dist-types/models/models_1.d.ts +210 -281
- package/dist-types/models/models_2.d.ts +2375 -2163
- package/dist-types/models/models_3.d.ts +2468 -54
- package/dist-types/pagination/ListTopicsPaginator.d.ts +7 -0
- package/dist-types/pagination/ListVPCConnectionsPaginator.d.ts +7 -0
- package/dist-types/pagination/index.d.ts +2 -0
- package/dist-types/protocols/Aws_restJson1.d.ts +162 -0
- package/dist-types/ts3.4/QuickSight.d.ts +306 -0
- package/dist-types/ts3.4/QuickSightClient.d.ts +110 -2
- package/dist-types/ts3.4/commands/CreateAccountCustomizationCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/CreateAccountSubscriptionCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/CreateTopicCommand.d.ts +34 -0
- package/dist-types/ts3.4/commands/CreateTopicRefreshScheduleCommand.d.ts +41 -0
- package/dist-types/ts3.4/commands/CreateVPCConnectionCommand.d.ts +38 -0
- package/dist-types/ts3.4/commands/DeleteTopicCommand.d.ts +34 -0
- package/dist-types/ts3.4/commands/DeleteTopicRefreshScheduleCommand.d.ts +41 -0
- package/dist-types/ts3.4/commands/DeleteVPCConnectionCommand.d.ts +38 -0
- package/dist-types/ts3.4/commands/DescribeDataSetCommand.d.ts +1 -1
- 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 +1 -1
- package/dist-types/ts3.4/commands/DescribeFolderCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/DescribeFolderPermissionsCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/DescribeFolderResolvedPermissionsCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/DescribeGroupCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/DescribeGroupMembershipCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/DescribeIAMPolicyAssignmentCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/DescribeIngestionCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/DescribeIpRestrictionCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/DescribeNamespaceCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/DescribeRefreshScheduleCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/DescribeTemplateAliasCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/DescribeTemplateCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/DescribeTemplateDefinitionCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/DescribeTemplatePermissionsCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/DescribeThemeAliasCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/DescribeThemeCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/DescribeThemePermissionsCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/DescribeTopicCommand.d.ts +37 -0
- package/dist-types/ts3.4/commands/DescribeTopicPermissionsCommand.d.ts +41 -0
- package/dist-types/ts3.4/commands/DescribeTopicRefreshCommand.d.ts +41 -0
- package/dist-types/ts3.4/commands/DescribeTopicRefreshScheduleCommand.d.ts +41 -0
- package/dist-types/ts3.4/commands/DescribeUserCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/DescribeVPCConnectionCommand.d.ts +41 -0
- package/dist-types/ts3.4/commands/ListTopicRefreshSchedulesCommand.d.ts +41 -0
- package/dist-types/ts3.4/commands/ListTopicsCommand.d.ts +34 -0
- package/dist-types/ts3.4/commands/ListVPCConnectionsCommand.d.ts +38 -0
- package/dist-types/ts3.4/commands/UpdateTopicCommand.d.ts +34 -0
- package/dist-types/ts3.4/commands/UpdateTopicPermissionsCommand.d.ts +41 -0
- package/dist-types/ts3.4/commands/UpdateTopicRefreshScheduleCommand.d.ts +41 -0
- package/dist-types/ts3.4/commands/UpdateVPCConnectionCommand.d.ts +38 -0
- package/dist-types/ts3.4/commands/index.d.ts +18 -0
- package/dist-types/ts3.4/models/models_0.d.ts +12 -22
- package/dist-types/ts3.4/models/models_1.d.ts +79 -75
- package/dist-types/ts3.4/models/models_2.d.ts +605 -500
- package/dist-types/ts3.4/models/models_3.d.ts +737 -9
- package/dist-types/ts3.4/pagination/ListTopicsPaginator.d.ts +11 -0
- package/dist-types/ts3.4/pagination/ListVPCConnectionsPaginator.d.ts +11 -0
- package/dist-types/ts3.4/pagination/index.d.ts +2 -0
- package/dist-types/ts3.4/protocols/Aws_restJson1.d.ts +216 -0
- package/package.json +8 -8
|
@@ -0,0 +1,346 @@
|
|
|
1
|
+
import { EndpointParameterInstructions } from "@aws-sdk/middleware-endpoint";
|
|
2
|
+
import { Command as $Command } from "@aws-sdk/smithy-client";
|
|
3
|
+
import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@aws-sdk/types";
|
|
4
|
+
import { UpdateTopicRequest, UpdateTopicResponse } from "../models/models_3";
|
|
5
|
+
import { QuickSightClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../QuickSightClient";
|
|
6
|
+
/**
|
|
7
|
+
* @public
|
|
8
|
+
*
|
|
9
|
+
* The input for {@link UpdateTopicCommand}.
|
|
10
|
+
*/
|
|
11
|
+
export interface UpdateTopicCommandInput extends UpdateTopicRequest {
|
|
12
|
+
}
|
|
13
|
+
/**
|
|
14
|
+
* @public
|
|
15
|
+
*
|
|
16
|
+
* The output of {@link UpdateTopicCommand}.
|
|
17
|
+
*/
|
|
18
|
+
export interface UpdateTopicCommandOutput extends UpdateTopicResponse, __MetadataBearer {
|
|
19
|
+
}
|
|
20
|
+
/**
|
|
21
|
+
* @public
|
|
22
|
+
* <p>Updates a topic.</p>
|
|
23
|
+
* @example
|
|
24
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
25
|
+
* ```javascript
|
|
26
|
+
* import { QuickSightClient, UpdateTopicCommand } from "@aws-sdk/client-quicksight"; // ES Modules import
|
|
27
|
+
* // const { QuickSightClient, UpdateTopicCommand } = require("@aws-sdk/client-quicksight"); // CommonJS import
|
|
28
|
+
* const client = new QuickSightClient(config);
|
|
29
|
+
* const input = { // UpdateTopicRequest
|
|
30
|
+
* AwsAccountId: "STRING_VALUE", // required
|
|
31
|
+
* TopicId: "STRING_VALUE", // required
|
|
32
|
+
* Topic: { // TopicDetails
|
|
33
|
+
* Name: "STRING_VALUE",
|
|
34
|
+
* Description: "STRING_VALUE",
|
|
35
|
+
* DataSets: [ // Datasets
|
|
36
|
+
* { // DatasetMetadata
|
|
37
|
+
* DatasetArn: "STRING_VALUE", // required
|
|
38
|
+
* DatasetName: "STRING_VALUE",
|
|
39
|
+
* DatasetDescription: "STRING_VALUE",
|
|
40
|
+
* DataAggregation: { // DataAggregation
|
|
41
|
+
* DatasetRowDateGranularity: "SECOND" || "MINUTE" || "HOUR" || "DAY" || "WEEK" || "MONTH" || "QUARTER" || "YEAR",
|
|
42
|
+
* DefaultDateColumnName: "STRING_VALUE",
|
|
43
|
+
* },
|
|
44
|
+
* Filters: [ // TopicFilters
|
|
45
|
+
* { // TopicFilter
|
|
46
|
+
* FilterDescription: "STRING_VALUE",
|
|
47
|
+
* FilterClass: "ENFORCED_VALUE_FILTER" || "CONDITIONAL_VALUE_FILTER" || "NAMED_VALUE_FILTER",
|
|
48
|
+
* FilterName: "STRING_VALUE", // required
|
|
49
|
+
* FilterSynonyms: [ // Synonyms
|
|
50
|
+
* "STRING_VALUE",
|
|
51
|
+
* ],
|
|
52
|
+
* OperandFieldName: "STRING_VALUE", // required
|
|
53
|
+
* FilterType: "CATEGORY_FILTER" || "NUMERIC_EQUALITY_FILTER" || "NUMERIC_RANGE_FILTER" || "DATE_RANGE_FILTER" || "RELATIVE_DATE_FILTER",
|
|
54
|
+
* CategoryFilter: { // TopicCategoryFilter
|
|
55
|
+
* CategoryFilterFunction: "EXACT" || "CONTAINS",
|
|
56
|
+
* CategoryFilterType: "CUSTOM_FILTER" || "CUSTOM_FILTER_LIST" || "FILTER_LIST",
|
|
57
|
+
* Constant: { // TopicCategoryFilterConstant
|
|
58
|
+
* ConstantType: "SINGULAR" || "RANGE" || "COLLECTIVE",
|
|
59
|
+
* SingularConstant: "STRING_VALUE",
|
|
60
|
+
* CollectiveConstant: { // CollectiveConstant
|
|
61
|
+
* ValueList: [ // StringList
|
|
62
|
+
* "STRING_VALUE",
|
|
63
|
+
* ],
|
|
64
|
+
* },
|
|
65
|
+
* },
|
|
66
|
+
* Inverse: true || false,
|
|
67
|
+
* },
|
|
68
|
+
* NumericEqualityFilter: { // TopicNumericEqualityFilter
|
|
69
|
+
* Constant: { // TopicSingularFilterConstant
|
|
70
|
+
* ConstantType: "SINGULAR" || "RANGE" || "COLLECTIVE",
|
|
71
|
+
* SingularConstant: "STRING_VALUE",
|
|
72
|
+
* },
|
|
73
|
+
* Aggregation: "NO_AGGREGATION" || "SUM" || "AVERAGE" || "COUNT" || "DISTINCT_COUNT" || "MAX" || "MEDIAN" || "MIN" || "STDEV" || "STDEVP" || "VAR" || "VARP",
|
|
74
|
+
* },
|
|
75
|
+
* NumericRangeFilter: { // TopicNumericRangeFilter
|
|
76
|
+
* Inclusive: true || false,
|
|
77
|
+
* Constant: { // TopicRangeFilterConstant
|
|
78
|
+
* ConstantType: "SINGULAR" || "RANGE" || "COLLECTIVE",
|
|
79
|
+
* RangeConstant: { // RangeConstant
|
|
80
|
+
* Minimum: "STRING_VALUE",
|
|
81
|
+
* Maximum: "STRING_VALUE",
|
|
82
|
+
* },
|
|
83
|
+
* },
|
|
84
|
+
* Aggregation: "NO_AGGREGATION" || "SUM" || "AVERAGE" || "COUNT" || "DISTINCT_COUNT" || "MAX" || "MEDIAN" || "MIN" || "STDEV" || "STDEVP" || "VAR" || "VARP",
|
|
85
|
+
* },
|
|
86
|
+
* DateRangeFilter: { // TopicDateRangeFilter
|
|
87
|
+
* Inclusive: true || false,
|
|
88
|
+
* Constant: {
|
|
89
|
+
* ConstantType: "SINGULAR" || "RANGE" || "COLLECTIVE",
|
|
90
|
+
* RangeConstant: {
|
|
91
|
+
* Minimum: "STRING_VALUE",
|
|
92
|
+
* Maximum: "STRING_VALUE",
|
|
93
|
+
* },
|
|
94
|
+
* },
|
|
95
|
+
* },
|
|
96
|
+
* RelativeDateFilter: { // TopicRelativeDateFilter
|
|
97
|
+
* TimeGranularity: "SECOND" || "MINUTE" || "HOUR" || "DAY" || "WEEK" || "MONTH" || "QUARTER" || "YEAR",
|
|
98
|
+
* RelativeDateFilterFunction: "PREVIOUS" || "THIS" || "LAST" || "NEXT" || "NOW",
|
|
99
|
+
* Constant: {
|
|
100
|
+
* ConstantType: "SINGULAR" || "RANGE" || "COLLECTIVE",
|
|
101
|
+
* SingularConstant: "STRING_VALUE",
|
|
102
|
+
* },
|
|
103
|
+
* },
|
|
104
|
+
* },
|
|
105
|
+
* ],
|
|
106
|
+
* Columns: [ // TopicColumns
|
|
107
|
+
* { // TopicColumn
|
|
108
|
+
* ColumnName: "STRING_VALUE", // required
|
|
109
|
+
* ColumnFriendlyName: "STRING_VALUE",
|
|
110
|
+
* ColumnDescription: "STRING_VALUE",
|
|
111
|
+
* ColumnSynonyms: [
|
|
112
|
+
* "STRING_VALUE",
|
|
113
|
+
* ],
|
|
114
|
+
* ColumnDataRole: "DIMENSION" || "MEASURE",
|
|
115
|
+
* Aggregation: "SUM" || "MAX" || "MIN" || "COUNT" || "DISTINCT_COUNT" || "AVERAGE",
|
|
116
|
+
* IsIncludedInTopic: true || false,
|
|
117
|
+
* DisableIndexing: true || false,
|
|
118
|
+
* ComparativeOrder: { // ComparativeOrder
|
|
119
|
+
* UseOrdering: "GREATER_IS_BETTER" || "LESSER_IS_BETTER" || "SPECIFIED",
|
|
120
|
+
* SpecifedOrder: [
|
|
121
|
+
* "STRING_VALUE",
|
|
122
|
+
* ],
|
|
123
|
+
* TreatUndefinedSpecifiedValues: "LEAST" || "MOST",
|
|
124
|
+
* },
|
|
125
|
+
* SemanticType: { // SemanticType
|
|
126
|
+
* TypeName: "STRING_VALUE",
|
|
127
|
+
* SubTypeName: "STRING_VALUE",
|
|
128
|
+
* TypeParameters: { // TypeParameters
|
|
129
|
+
* "<keys>": "STRING_VALUE",
|
|
130
|
+
* },
|
|
131
|
+
* TruthyCellValue: "STRING_VALUE",
|
|
132
|
+
* TruthyCellValueSynonyms: [ // SensitiveStringList
|
|
133
|
+
* "STRING_VALUE",
|
|
134
|
+
* ],
|
|
135
|
+
* FalseyCellValue: "STRING_VALUE",
|
|
136
|
+
* FalseyCellValueSynonyms: [
|
|
137
|
+
* "STRING_VALUE",
|
|
138
|
+
* ],
|
|
139
|
+
* },
|
|
140
|
+
* TimeGranularity: "SECOND" || "MINUTE" || "HOUR" || "DAY" || "WEEK" || "MONTH" || "QUARTER" || "YEAR",
|
|
141
|
+
* AllowedAggregations: [ // AuthorSpecifiedAggregations
|
|
142
|
+
* "COUNT" || "DISTINCT_COUNT" || "MIN" || "MAX" || "MEDIAN" || "SUM" || "AVERAGE" || "STDEV" || "STDEVP" || "VAR" || "VARP" || "PERCENTILE",
|
|
143
|
+
* ],
|
|
144
|
+
* NotAllowedAggregations: [
|
|
145
|
+
* "COUNT" || "DISTINCT_COUNT" || "MIN" || "MAX" || "MEDIAN" || "SUM" || "AVERAGE" || "STDEV" || "STDEVP" || "VAR" || "VARP" || "PERCENTILE",
|
|
146
|
+
* ],
|
|
147
|
+
* DefaultFormatting: { // DefaultFormatting
|
|
148
|
+
* DisplayFormat: "AUTO" || "PERCENT" || "CURRENCY" || "NUMBER" || "DATE" || "STRING",
|
|
149
|
+
* DisplayFormatOptions: { // DisplayFormatOptions
|
|
150
|
+
* UseBlankCellFormat: true || false,
|
|
151
|
+
* BlankCellFormat: "STRING_VALUE",
|
|
152
|
+
* DateFormat: "STRING_VALUE",
|
|
153
|
+
* DecimalSeparator: "COMMA" || "DOT",
|
|
154
|
+
* GroupingSeparator: "STRING_VALUE",
|
|
155
|
+
* UseGrouping: true || false,
|
|
156
|
+
* FractionDigits: Number("int"),
|
|
157
|
+
* Prefix: "STRING_VALUE",
|
|
158
|
+
* Suffix: "STRING_VALUE",
|
|
159
|
+
* UnitScaler: "NONE" || "AUTO" || "THOUSANDS" || "MILLIONS" || "BILLIONS" || "TRILLIONS",
|
|
160
|
+
* NegativeFormat: { // NegativeFormat
|
|
161
|
+
* Prefix: "STRING_VALUE",
|
|
162
|
+
* Suffix: "STRING_VALUE",
|
|
163
|
+
* },
|
|
164
|
+
* CurrencySymbol: "STRING_VALUE",
|
|
165
|
+
* },
|
|
166
|
+
* },
|
|
167
|
+
* NeverAggregateInFilter: true || false,
|
|
168
|
+
* CellValueSynonyms: [ // CellValueSynonyms
|
|
169
|
+
* { // CellValueSynonym
|
|
170
|
+
* CellValue: "STRING_VALUE",
|
|
171
|
+
* Synonyms: "<StringList>",
|
|
172
|
+
* },
|
|
173
|
+
* ],
|
|
174
|
+
* },
|
|
175
|
+
* ],
|
|
176
|
+
* CalculatedFields: [ // TopicCalculatedFields
|
|
177
|
+
* { // TopicCalculatedField
|
|
178
|
+
* CalculatedFieldName: "STRING_VALUE", // required
|
|
179
|
+
* CalculatedFieldDescription: "STRING_VALUE",
|
|
180
|
+
* Expression: "STRING_VALUE", // required
|
|
181
|
+
* CalculatedFieldSynonyms: [
|
|
182
|
+
* "STRING_VALUE",
|
|
183
|
+
* ],
|
|
184
|
+
* IsIncludedInTopic: true || false,
|
|
185
|
+
* DisableIndexing: true || false,
|
|
186
|
+
* ColumnDataRole: "DIMENSION" || "MEASURE",
|
|
187
|
+
* TimeGranularity: "SECOND" || "MINUTE" || "HOUR" || "DAY" || "WEEK" || "MONTH" || "QUARTER" || "YEAR",
|
|
188
|
+
* DefaultFormatting: {
|
|
189
|
+
* DisplayFormat: "AUTO" || "PERCENT" || "CURRENCY" || "NUMBER" || "DATE" || "STRING",
|
|
190
|
+
* DisplayFormatOptions: {
|
|
191
|
+
* UseBlankCellFormat: true || false,
|
|
192
|
+
* BlankCellFormat: "STRING_VALUE",
|
|
193
|
+
* DateFormat: "STRING_VALUE",
|
|
194
|
+
* DecimalSeparator: "COMMA" || "DOT",
|
|
195
|
+
* GroupingSeparator: "STRING_VALUE",
|
|
196
|
+
* UseGrouping: true || false,
|
|
197
|
+
* FractionDigits: Number("int"),
|
|
198
|
+
* Prefix: "STRING_VALUE",
|
|
199
|
+
* Suffix: "STRING_VALUE",
|
|
200
|
+
* UnitScaler: "NONE" || "AUTO" || "THOUSANDS" || "MILLIONS" || "BILLIONS" || "TRILLIONS",
|
|
201
|
+
* NegativeFormat: {
|
|
202
|
+
* Prefix: "STRING_VALUE",
|
|
203
|
+
* Suffix: "STRING_VALUE",
|
|
204
|
+
* },
|
|
205
|
+
* CurrencySymbol: "STRING_VALUE",
|
|
206
|
+
* },
|
|
207
|
+
* },
|
|
208
|
+
* Aggregation: "SUM" || "MAX" || "MIN" || "COUNT" || "DISTINCT_COUNT" || "AVERAGE",
|
|
209
|
+
* ComparativeOrder: {
|
|
210
|
+
* UseOrdering: "GREATER_IS_BETTER" || "LESSER_IS_BETTER" || "SPECIFIED",
|
|
211
|
+
* SpecifedOrder: "<StringList>",
|
|
212
|
+
* TreatUndefinedSpecifiedValues: "LEAST" || "MOST",
|
|
213
|
+
* },
|
|
214
|
+
* SemanticType: {
|
|
215
|
+
* TypeName: "STRING_VALUE",
|
|
216
|
+
* SubTypeName: "STRING_VALUE",
|
|
217
|
+
* TypeParameters: {
|
|
218
|
+
* "<keys>": "STRING_VALUE",
|
|
219
|
+
* },
|
|
220
|
+
* TruthyCellValue: "STRING_VALUE",
|
|
221
|
+
* TruthyCellValueSynonyms: [
|
|
222
|
+
* "STRING_VALUE",
|
|
223
|
+
* ],
|
|
224
|
+
* FalseyCellValue: "STRING_VALUE",
|
|
225
|
+
* FalseyCellValueSynonyms: [
|
|
226
|
+
* "STRING_VALUE",
|
|
227
|
+
* ],
|
|
228
|
+
* },
|
|
229
|
+
* AllowedAggregations: [
|
|
230
|
+
* "COUNT" || "DISTINCT_COUNT" || "MIN" || "MAX" || "MEDIAN" || "SUM" || "AVERAGE" || "STDEV" || "STDEVP" || "VAR" || "VARP" || "PERCENTILE",
|
|
231
|
+
* ],
|
|
232
|
+
* NotAllowedAggregations: [
|
|
233
|
+
* "COUNT" || "DISTINCT_COUNT" || "MIN" || "MAX" || "MEDIAN" || "SUM" || "AVERAGE" || "STDEV" || "STDEVP" || "VAR" || "VARP" || "PERCENTILE",
|
|
234
|
+
* ],
|
|
235
|
+
* NeverAggregateInFilter: true || false,
|
|
236
|
+
* CellValueSynonyms: [
|
|
237
|
+
* {
|
|
238
|
+
* CellValue: "STRING_VALUE",
|
|
239
|
+
* Synonyms: "<StringList>",
|
|
240
|
+
* },
|
|
241
|
+
* ],
|
|
242
|
+
* },
|
|
243
|
+
* ],
|
|
244
|
+
* NamedEntities: [ // TopicNamedEntities
|
|
245
|
+
* { // TopicNamedEntity
|
|
246
|
+
* EntityName: "STRING_VALUE", // required
|
|
247
|
+
* EntityDescription: "STRING_VALUE",
|
|
248
|
+
* EntitySynonyms: [
|
|
249
|
+
* "STRING_VALUE",
|
|
250
|
+
* ],
|
|
251
|
+
* SemanticEntityType: { // SemanticEntityType
|
|
252
|
+
* TypeName: "STRING_VALUE",
|
|
253
|
+
* SubTypeName: "STRING_VALUE",
|
|
254
|
+
* TypeParameters: {
|
|
255
|
+
* "<keys>": "STRING_VALUE",
|
|
256
|
+
* },
|
|
257
|
+
* },
|
|
258
|
+
* Definition: [ // NamedEntityDefinitions
|
|
259
|
+
* { // NamedEntityDefinition
|
|
260
|
+
* FieldName: "STRING_VALUE",
|
|
261
|
+
* PropertyName: "STRING_VALUE",
|
|
262
|
+
* PropertyRole: "PRIMARY" || "ID",
|
|
263
|
+
* PropertyUsage: "INHERIT" || "DIMENSION" || "MEASURE",
|
|
264
|
+
* Metric: { // NamedEntityDefinitionMetric
|
|
265
|
+
* Aggregation: "SUM" || "MIN" || "MAX" || "COUNT" || "AVERAGE" || "DISTINCT_COUNT" || "STDEV" || "STDEVP" || "VAR" || "VARP" || "PERCENTILE" || "MEDIAN" || "CUSTOM",
|
|
266
|
+
* AggregationFunctionParameters: { // AggregationFunctionParameters
|
|
267
|
+
* "<keys>": "STRING_VALUE",
|
|
268
|
+
* },
|
|
269
|
+
* },
|
|
270
|
+
* },
|
|
271
|
+
* ],
|
|
272
|
+
* },
|
|
273
|
+
* ],
|
|
274
|
+
* },
|
|
275
|
+
* ],
|
|
276
|
+
* },
|
|
277
|
+
* };
|
|
278
|
+
* const command = new UpdateTopicCommand(input);
|
|
279
|
+
* const response = await client.send(command);
|
|
280
|
+
* // { // UpdateTopicResponse
|
|
281
|
+
* // TopicId: "STRING_VALUE",
|
|
282
|
+
* // Arn: "STRING_VALUE",
|
|
283
|
+
* // RefreshArn: "STRING_VALUE",
|
|
284
|
+
* // RequestId: "STRING_VALUE",
|
|
285
|
+
* // Status: Number("int"),
|
|
286
|
+
* // };
|
|
287
|
+
*
|
|
288
|
+
* ```
|
|
289
|
+
*
|
|
290
|
+
* @param UpdateTopicCommandInput - {@link UpdateTopicCommandInput}
|
|
291
|
+
* @returns {@link UpdateTopicCommandOutput}
|
|
292
|
+
* @see {@link UpdateTopicCommandInput} for command's `input` shape.
|
|
293
|
+
* @see {@link UpdateTopicCommandOutput} for command's `response` shape.
|
|
294
|
+
* @see {@link QuickSightClientResolvedConfig | config} for QuickSightClient's `config` shape.
|
|
295
|
+
*
|
|
296
|
+
* @throws {@link AccessDeniedException} (client fault)
|
|
297
|
+
* <p>You don't have access to this item. The provided credentials couldn't be
|
|
298
|
+
* validated. You might not be authorized to carry out the request. Make sure that your
|
|
299
|
+
* account is authorized to use the Amazon QuickSight service, that your policies have the
|
|
300
|
+
* correct permissions, and that you are using the correct credentials.</p>
|
|
301
|
+
*
|
|
302
|
+
* @throws {@link ConflictException} (client fault)
|
|
303
|
+
* <p>Updating or deleting a resource can cause an inconsistent state.</p>
|
|
304
|
+
*
|
|
305
|
+
* @throws {@link InternalFailureException} (server fault)
|
|
306
|
+
* <p>An internal failure occurred.</p>
|
|
307
|
+
*
|
|
308
|
+
* @throws {@link InvalidParameterValueException} (client fault)
|
|
309
|
+
* <p>One or more parameters has a value that isn't valid.</p>
|
|
310
|
+
*
|
|
311
|
+
* @throws {@link LimitExceededException} (client fault)
|
|
312
|
+
* <p>A limit is exceeded.</p>
|
|
313
|
+
*
|
|
314
|
+
* @throws {@link ResourceExistsException} (client fault)
|
|
315
|
+
* <p>The resource specified already exists. </p>
|
|
316
|
+
*
|
|
317
|
+
* @throws {@link ResourceNotFoundException} (client fault)
|
|
318
|
+
* <p>One or more resources can't be found.</p>
|
|
319
|
+
*
|
|
320
|
+
* @throws {@link ThrottlingException} (client fault)
|
|
321
|
+
* <p>Access is throttled.</p>
|
|
322
|
+
*
|
|
323
|
+
* @throws {@link QuickSightServiceException}
|
|
324
|
+
* <p>Base exception class for all service exceptions from QuickSight service.</p>
|
|
325
|
+
*
|
|
326
|
+
*/
|
|
327
|
+
export declare class UpdateTopicCommand extends $Command<UpdateTopicCommandInput, UpdateTopicCommandOutput, QuickSightClientResolvedConfig> {
|
|
328
|
+
readonly input: UpdateTopicCommandInput;
|
|
329
|
+
static getEndpointParameterInstructions(): EndpointParameterInstructions;
|
|
330
|
+
/**
|
|
331
|
+
* @public
|
|
332
|
+
*/
|
|
333
|
+
constructor(input: UpdateTopicCommandInput);
|
|
334
|
+
/**
|
|
335
|
+
* @internal
|
|
336
|
+
*/
|
|
337
|
+
resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: QuickSightClientResolvedConfig, options?: __HttpHandlerOptions): Handler<UpdateTopicCommandInput, UpdateTopicCommandOutput>;
|
|
338
|
+
/**
|
|
339
|
+
* @internal
|
|
340
|
+
*/
|
|
341
|
+
private serialize;
|
|
342
|
+
/**
|
|
343
|
+
* @internal
|
|
344
|
+
*/
|
|
345
|
+
private deserialize;
|
|
346
|
+
}
|
|
@@ -0,0 +1,127 @@
|
|
|
1
|
+
import { EndpointParameterInstructions } from "@aws-sdk/middleware-endpoint";
|
|
2
|
+
import { Command as $Command } from "@aws-sdk/smithy-client";
|
|
3
|
+
import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@aws-sdk/types";
|
|
4
|
+
import { UpdateTopicPermissionsRequest, UpdateTopicPermissionsResponse } from "../models/models_3";
|
|
5
|
+
import { QuickSightClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../QuickSightClient";
|
|
6
|
+
/**
|
|
7
|
+
* @public
|
|
8
|
+
*
|
|
9
|
+
* The input for {@link UpdateTopicPermissionsCommand}.
|
|
10
|
+
*/
|
|
11
|
+
export interface UpdateTopicPermissionsCommandInput extends UpdateTopicPermissionsRequest {
|
|
12
|
+
}
|
|
13
|
+
/**
|
|
14
|
+
* @public
|
|
15
|
+
*
|
|
16
|
+
* The output of {@link UpdateTopicPermissionsCommand}.
|
|
17
|
+
*/
|
|
18
|
+
export interface UpdateTopicPermissionsCommandOutput extends UpdateTopicPermissionsResponse, __MetadataBearer {
|
|
19
|
+
}
|
|
20
|
+
/**
|
|
21
|
+
* @public
|
|
22
|
+
* <p>Updates the permissions of a topic.</p>
|
|
23
|
+
* @example
|
|
24
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
25
|
+
* ```javascript
|
|
26
|
+
* import { QuickSightClient, UpdateTopicPermissionsCommand } from "@aws-sdk/client-quicksight"; // ES Modules import
|
|
27
|
+
* // const { QuickSightClient, UpdateTopicPermissionsCommand } = require("@aws-sdk/client-quicksight"); // CommonJS import
|
|
28
|
+
* const client = new QuickSightClient(config);
|
|
29
|
+
* const input = { // UpdateTopicPermissionsRequest
|
|
30
|
+
* AwsAccountId: "STRING_VALUE", // required
|
|
31
|
+
* TopicId: "STRING_VALUE", // required
|
|
32
|
+
* GrantPermissions: [ // UpdateResourcePermissionList
|
|
33
|
+
* { // ResourcePermission
|
|
34
|
+
* Principal: "STRING_VALUE", // required
|
|
35
|
+
* Actions: [ // ActionList // required
|
|
36
|
+
* "STRING_VALUE",
|
|
37
|
+
* ],
|
|
38
|
+
* },
|
|
39
|
+
* ],
|
|
40
|
+
* RevokePermissions: [
|
|
41
|
+
* {
|
|
42
|
+
* Principal: "STRING_VALUE", // required
|
|
43
|
+
* Actions: [ // required
|
|
44
|
+
* "STRING_VALUE",
|
|
45
|
+
* ],
|
|
46
|
+
* },
|
|
47
|
+
* ],
|
|
48
|
+
* };
|
|
49
|
+
* const command = new UpdateTopicPermissionsCommand(input);
|
|
50
|
+
* const response = await client.send(command);
|
|
51
|
+
* // { // UpdateTopicPermissionsResponse
|
|
52
|
+
* // TopicId: "STRING_VALUE",
|
|
53
|
+
* // TopicArn: "STRING_VALUE",
|
|
54
|
+
* // Permissions: [ // ResourcePermissionList
|
|
55
|
+
* // { // ResourcePermission
|
|
56
|
+
* // Principal: "STRING_VALUE", // required
|
|
57
|
+
* // Actions: [ // ActionList // required
|
|
58
|
+
* // "STRING_VALUE",
|
|
59
|
+
* // ],
|
|
60
|
+
* // },
|
|
61
|
+
* // ],
|
|
62
|
+
* // Status: Number("int"),
|
|
63
|
+
* // RequestId: "STRING_VALUE",
|
|
64
|
+
* // };
|
|
65
|
+
*
|
|
66
|
+
* ```
|
|
67
|
+
*
|
|
68
|
+
* @param UpdateTopicPermissionsCommandInput - {@link UpdateTopicPermissionsCommandInput}
|
|
69
|
+
* @returns {@link UpdateTopicPermissionsCommandOutput}
|
|
70
|
+
* @see {@link UpdateTopicPermissionsCommandInput} for command's `input` shape.
|
|
71
|
+
* @see {@link UpdateTopicPermissionsCommandOutput} for command's `response` shape.
|
|
72
|
+
* @see {@link QuickSightClientResolvedConfig | config} for QuickSightClient's `config` shape.
|
|
73
|
+
*
|
|
74
|
+
* @throws {@link AccessDeniedException} (client fault)
|
|
75
|
+
* <p>You don't have access to this item. The provided credentials couldn't be
|
|
76
|
+
* validated. You might not be authorized to carry out the request. Make sure that your
|
|
77
|
+
* account is authorized to use the Amazon QuickSight service, that your policies have the
|
|
78
|
+
* correct permissions, and that you are using the correct credentials.</p>
|
|
79
|
+
*
|
|
80
|
+
* @throws {@link ConflictException} (client fault)
|
|
81
|
+
* <p>Updating or deleting a resource can cause an inconsistent state.</p>
|
|
82
|
+
*
|
|
83
|
+
* @throws {@link InternalFailureException} (server fault)
|
|
84
|
+
* <p>An internal failure occurred.</p>
|
|
85
|
+
*
|
|
86
|
+
* @throws {@link InvalidParameterValueException} (client fault)
|
|
87
|
+
* <p>One or more parameters has a value that isn't valid.</p>
|
|
88
|
+
*
|
|
89
|
+
* @throws {@link LimitExceededException} (client fault)
|
|
90
|
+
* <p>A limit is exceeded.</p>
|
|
91
|
+
*
|
|
92
|
+
* @throws {@link ResourceNotFoundException} (client fault)
|
|
93
|
+
* <p>One or more resources can't be found.</p>
|
|
94
|
+
*
|
|
95
|
+
* @throws {@link ThrottlingException} (client fault)
|
|
96
|
+
* <p>Access is throttled.</p>
|
|
97
|
+
*
|
|
98
|
+
* @throws {@link UnsupportedUserEditionException} (client fault)
|
|
99
|
+
* <p>This error indicates that you are calling an operation on an Amazon QuickSight
|
|
100
|
+
* subscription where the edition doesn't include support for that operation. Amazon
|
|
101
|
+
* Amazon QuickSight currently has Standard Edition and Enterprise Edition. Not every operation and
|
|
102
|
+
* capability is available in every edition.</p>
|
|
103
|
+
*
|
|
104
|
+
* @throws {@link QuickSightServiceException}
|
|
105
|
+
* <p>Base exception class for all service exceptions from QuickSight service.</p>
|
|
106
|
+
*
|
|
107
|
+
*/
|
|
108
|
+
export declare class UpdateTopicPermissionsCommand extends $Command<UpdateTopicPermissionsCommandInput, UpdateTopicPermissionsCommandOutput, QuickSightClientResolvedConfig> {
|
|
109
|
+
readonly input: UpdateTopicPermissionsCommandInput;
|
|
110
|
+
static getEndpointParameterInstructions(): EndpointParameterInstructions;
|
|
111
|
+
/**
|
|
112
|
+
* @public
|
|
113
|
+
*/
|
|
114
|
+
constructor(input: UpdateTopicPermissionsCommandInput);
|
|
115
|
+
/**
|
|
116
|
+
* @internal
|
|
117
|
+
*/
|
|
118
|
+
resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: QuickSightClientResolvedConfig, options?: __HttpHandlerOptions): Handler<UpdateTopicPermissionsCommandInput, UpdateTopicPermissionsCommandOutput>;
|
|
119
|
+
/**
|
|
120
|
+
* @internal
|
|
121
|
+
*/
|
|
122
|
+
private serialize;
|
|
123
|
+
/**
|
|
124
|
+
* @internal
|
|
125
|
+
*/
|
|
126
|
+
private deserialize;
|
|
127
|
+
}
|
|
@@ -0,0 +1,110 @@
|
|
|
1
|
+
import { EndpointParameterInstructions } from "@aws-sdk/middleware-endpoint";
|
|
2
|
+
import { Command as $Command } from "@aws-sdk/smithy-client";
|
|
3
|
+
import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@aws-sdk/types";
|
|
4
|
+
import { UpdateTopicRefreshScheduleRequest, UpdateTopicRefreshScheduleResponse } from "../models/models_3";
|
|
5
|
+
import { QuickSightClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../QuickSightClient";
|
|
6
|
+
/**
|
|
7
|
+
* @public
|
|
8
|
+
*
|
|
9
|
+
* The input for {@link UpdateTopicRefreshScheduleCommand}.
|
|
10
|
+
*/
|
|
11
|
+
export interface UpdateTopicRefreshScheduleCommandInput extends UpdateTopicRefreshScheduleRequest {
|
|
12
|
+
}
|
|
13
|
+
/**
|
|
14
|
+
* @public
|
|
15
|
+
*
|
|
16
|
+
* The output of {@link UpdateTopicRefreshScheduleCommand}.
|
|
17
|
+
*/
|
|
18
|
+
export interface UpdateTopicRefreshScheduleCommandOutput extends UpdateTopicRefreshScheduleResponse, __MetadataBearer {
|
|
19
|
+
}
|
|
20
|
+
/**
|
|
21
|
+
* @public
|
|
22
|
+
* <p>Updates a topic refresh schedule.</p>
|
|
23
|
+
* @example
|
|
24
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
25
|
+
* ```javascript
|
|
26
|
+
* import { QuickSightClient, UpdateTopicRefreshScheduleCommand } from "@aws-sdk/client-quicksight"; // ES Modules import
|
|
27
|
+
* // const { QuickSightClient, UpdateTopicRefreshScheduleCommand } = require("@aws-sdk/client-quicksight"); // CommonJS import
|
|
28
|
+
* const client = new QuickSightClient(config);
|
|
29
|
+
* const input = { // UpdateTopicRefreshScheduleRequest
|
|
30
|
+
* AwsAccountId: "STRING_VALUE", // required
|
|
31
|
+
* TopicId: "STRING_VALUE", // required
|
|
32
|
+
* DatasetId: "STRING_VALUE", // required
|
|
33
|
+
* RefreshSchedule: { // TopicRefreshSchedule
|
|
34
|
+
* IsEnabled: true || false, // required
|
|
35
|
+
* BasedOnSpiceSchedule: true || false, // required
|
|
36
|
+
* StartingAt: new Date("TIMESTAMP"),
|
|
37
|
+
* Timezone: "STRING_VALUE",
|
|
38
|
+
* RepeatAt: "STRING_VALUE",
|
|
39
|
+
* TopicScheduleType: "HOURLY" || "DAILY" || "WEEKLY" || "MONTHLY",
|
|
40
|
+
* },
|
|
41
|
+
* };
|
|
42
|
+
* const command = new UpdateTopicRefreshScheduleCommand(input);
|
|
43
|
+
* const response = await client.send(command);
|
|
44
|
+
* // { // UpdateTopicRefreshScheduleResponse
|
|
45
|
+
* // TopicId: "STRING_VALUE",
|
|
46
|
+
* // TopicArn: "STRING_VALUE",
|
|
47
|
+
* // DatasetArn: "STRING_VALUE",
|
|
48
|
+
* // Status: Number("int"),
|
|
49
|
+
* // RequestId: "STRING_VALUE",
|
|
50
|
+
* // };
|
|
51
|
+
*
|
|
52
|
+
* ```
|
|
53
|
+
*
|
|
54
|
+
* @param UpdateTopicRefreshScheduleCommandInput - {@link UpdateTopicRefreshScheduleCommandInput}
|
|
55
|
+
* @returns {@link UpdateTopicRefreshScheduleCommandOutput}
|
|
56
|
+
* @see {@link UpdateTopicRefreshScheduleCommandInput} for command's `input` shape.
|
|
57
|
+
* @see {@link UpdateTopicRefreshScheduleCommandOutput} for command's `response` shape.
|
|
58
|
+
* @see {@link QuickSightClientResolvedConfig | config} for QuickSightClient's `config` shape.
|
|
59
|
+
*
|
|
60
|
+
* @throws {@link AccessDeniedException} (client fault)
|
|
61
|
+
* <p>You don't have access to this item. The provided credentials couldn't be
|
|
62
|
+
* validated. You might not be authorized to carry out the request. Make sure that your
|
|
63
|
+
* account is authorized to use the Amazon QuickSight service, that your policies have the
|
|
64
|
+
* correct permissions, and that you are using the correct credentials.</p>
|
|
65
|
+
*
|
|
66
|
+
* @throws {@link ConflictException} (client fault)
|
|
67
|
+
* <p>Updating or deleting a resource can cause an inconsistent state.</p>
|
|
68
|
+
*
|
|
69
|
+
* @throws {@link InternalFailureException} (server fault)
|
|
70
|
+
* <p>An internal failure occurred.</p>
|
|
71
|
+
*
|
|
72
|
+
* @throws {@link InvalidParameterValueException} (client fault)
|
|
73
|
+
* <p>One or more parameters has a value that isn't valid.</p>
|
|
74
|
+
*
|
|
75
|
+
* @throws {@link LimitExceededException} (client fault)
|
|
76
|
+
* <p>A limit is exceeded.</p>
|
|
77
|
+
*
|
|
78
|
+
* @throws {@link ResourceExistsException} (client fault)
|
|
79
|
+
* <p>The resource specified already exists. </p>
|
|
80
|
+
*
|
|
81
|
+
* @throws {@link ResourceNotFoundException} (client fault)
|
|
82
|
+
* <p>One or more resources can't be found.</p>
|
|
83
|
+
*
|
|
84
|
+
* @throws {@link ThrottlingException} (client fault)
|
|
85
|
+
* <p>Access is throttled.</p>
|
|
86
|
+
*
|
|
87
|
+
* @throws {@link QuickSightServiceException}
|
|
88
|
+
* <p>Base exception class for all service exceptions from QuickSight service.</p>
|
|
89
|
+
*
|
|
90
|
+
*/
|
|
91
|
+
export declare class UpdateTopicRefreshScheduleCommand extends $Command<UpdateTopicRefreshScheduleCommandInput, UpdateTopicRefreshScheduleCommandOutput, QuickSightClientResolvedConfig> {
|
|
92
|
+
readonly input: UpdateTopicRefreshScheduleCommandInput;
|
|
93
|
+
static getEndpointParameterInstructions(): EndpointParameterInstructions;
|
|
94
|
+
/**
|
|
95
|
+
* @public
|
|
96
|
+
*/
|
|
97
|
+
constructor(input: UpdateTopicRefreshScheduleCommandInput);
|
|
98
|
+
/**
|
|
99
|
+
* @internal
|
|
100
|
+
*/
|
|
101
|
+
resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: QuickSightClientResolvedConfig, options?: __HttpHandlerOptions): Handler<UpdateTopicRefreshScheduleCommandInput, UpdateTopicRefreshScheduleCommandOutput>;
|
|
102
|
+
/**
|
|
103
|
+
* @internal
|
|
104
|
+
*/
|
|
105
|
+
private serialize;
|
|
106
|
+
/**
|
|
107
|
+
* @internal
|
|
108
|
+
*/
|
|
109
|
+
private deserialize;
|
|
110
|
+
}
|