@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
|
@@ -1,8 +1,1970 @@
|
|
|
1
1
|
import { ExceptionOptionType as __ExceptionOptionType } from "@aws-sdk/smithy-client";
|
|
2
|
-
import { AccountCustomization, ActiveIAMPolicyAssignment, ResourceStatus } from "./models_0";
|
|
3
|
-
import { AnalysisDefinition, AnalysisSearchFilter, AnalysisSourceEntity, AnalysisSummary, AnonymousUserEmbeddingExperienceConfiguration, AssignmentStatus, ColumnGroup, ColumnLevelPermissionRule, DashboardVisualId, FilterOperator
|
|
4
|
-
import { _Parameters, DashboardPublishOptions, DashboardSearchFilter, DashboardSourceEntity, DashboardSummary, DashboardVersionDefinition, DashboardVersionSummary, DataSetImportMode, DataSetRefreshProperties, DataSetSearchFilter, DataSetSummary, DataSetUsageConfiguration, DataSource, DataSourceCredentials, DataSourceParameters, DataSourceSearchFilter, DataSourceSummary,
|
|
2
|
+
import { AccountCustomization, ActiveIAMPolicyAssignment, Entity, ResourceStatus, Sheet } from "./models_0";
|
|
3
|
+
import { AnalysisDefinition, AnalysisSearchFilter, AnalysisSourceEntity, AnalysisSummary, AnonymousUserEmbeddingExperienceConfiguration, AssignmentStatus, BookmarksConfigurations, ColumnGroup, ColumnLevelPermissionRule, DashboardVisualId, FilterOperator } from "./models_1";
|
|
4
|
+
import { _Parameters, DashboardPublishOptions, DashboardSearchFilter, DashboardSourceEntity, DashboardSummary, DashboardVersionDefinition, DashboardVersionSummary, DataSet, DataSetConfiguration, DataSetImportMode, DatasetParameter, DataSetRefreshProperties, DataSetSearchFilter, DataSetSummary, DataSetUsageConfiguration, DataSource, DataSourceCredentials, DataSourceParameters, DataSourceSearchFilter, DataSourceSummary, FieldFolder, FolderType, Group, GroupMember, IdentityStore, IngestionStatus, LinkSharingConfiguration, LogicalTable, NamespaceStatus, PhysicalTable, RefreshSchedule, ResourcePermission, RowLevelPermissionDataSet, RowLevelPermissionTagConfiguration, SslProperties, Tag, TemplateAlias, TemplateSourceEntity, TemplateVersionDefinition, ThemeAlias, ThemeConfiguration, TopicDetails, TopicRefreshSchedule, VPCConnectionAvailabilityStatus, VpcConnectionProperties, VPCConnectionResourceStatus } from "./models_2";
|
|
5
5
|
import { QuickSightServiceException as __BaseException } from "./QuickSightServiceException";
|
|
6
|
+
/**
|
|
7
|
+
* @public
|
|
8
|
+
*/
|
|
9
|
+
export interface DescribeDataSetRequest {
|
|
10
|
+
/**
|
|
11
|
+
* <p>The Amazon Web Services account ID.</p>
|
|
12
|
+
*/
|
|
13
|
+
AwsAccountId: string | undefined;
|
|
14
|
+
/**
|
|
15
|
+
* <p>The ID for the dataset that you want to create. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.</p>
|
|
16
|
+
*/
|
|
17
|
+
DataSetId: string | undefined;
|
|
18
|
+
}
|
|
19
|
+
/**
|
|
20
|
+
* @public
|
|
21
|
+
*/
|
|
22
|
+
export interface DescribeDataSetResponse {
|
|
23
|
+
/**
|
|
24
|
+
* <p>Information on the dataset.</p>
|
|
25
|
+
*/
|
|
26
|
+
DataSet?: DataSet;
|
|
27
|
+
/**
|
|
28
|
+
* <p>The Amazon Web Services request ID for this operation.</p>
|
|
29
|
+
*/
|
|
30
|
+
RequestId?: string;
|
|
31
|
+
/**
|
|
32
|
+
* <p>The HTTP status of the request.</p>
|
|
33
|
+
*/
|
|
34
|
+
Status?: number;
|
|
35
|
+
}
|
|
36
|
+
/**
|
|
37
|
+
* @public
|
|
38
|
+
*/
|
|
39
|
+
export interface DescribeDataSetPermissionsRequest {
|
|
40
|
+
/**
|
|
41
|
+
* <p>The Amazon Web Services account ID.</p>
|
|
42
|
+
*/
|
|
43
|
+
AwsAccountId: string | undefined;
|
|
44
|
+
/**
|
|
45
|
+
* <p>The ID for the dataset that you want to create. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.</p>
|
|
46
|
+
*/
|
|
47
|
+
DataSetId: string | undefined;
|
|
48
|
+
}
|
|
49
|
+
/**
|
|
50
|
+
* @public
|
|
51
|
+
*/
|
|
52
|
+
export interface DescribeDataSetPermissionsResponse {
|
|
53
|
+
/**
|
|
54
|
+
* <p>The Amazon Resource Name (ARN) of the dataset.</p>
|
|
55
|
+
*/
|
|
56
|
+
DataSetArn?: string;
|
|
57
|
+
/**
|
|
58
|
+
* <p>The ID for the dataset that you want to create. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.</p>
|
|
59
|
+
*/
|
|
60
|
+
DataSetId?: string;
|
|
61
|
+
/**
|
|
62
|
+
* <p>A list of resource permissions on the dataset.</p>
|
|
63
|
+
*/
|
|
64
|
+
Permissions?: ResourcePermission[];
|
|
65
|
+
/**
|
|
66
|
+
* <p>The Amazon Web Services request ID for this operation.</p>
|
|
67
|
+
*/
|
|
68
|
+
RequestId?: string;
|
|
69
|
+
/**
|
|
70
|
+
* <p>The HTTP status of the request.</p>
|
|
71
|
+
*/
|
|
72
|
+
Status?: number;
|
|
73
|
+
}
|
|
74
|
+
/**
|
|
75
|
+
* @public
|
|
76
|
+
*/
|
|
77
|
+
export interface DescribeDataSetRefreshPropertiesRequest {
|
|
78
|
+
/**
|
|
79
|
+
* <p>The Amazon Web Services account ID.</p>
|
|
80
|
+
*/
|
|
81
|
+
AwsAccountId: string | undefined;
|
|
82
|
+
/**
|
|
83
|
+
* <p>The ID of the dataset.</p>
|
|
84
|
+
*/
|
|
85
|
+
DataSetId: string | undefined;
|
|
86
|
+
}
|
|
87
|
+
/**
|
|
88
|
+
* @public
|
|
89
|
+
*/
|
|
90
|
+
export interface DescribeDataSetRefreshPropertiesResponse {
|
|
91
|
+
/**
|
|
92
|
+
* <p>The Amazon Web Services request ID for this operation.</p>
|
|
93
|
+
*/
|
|
94
|
+
RequestId?: string;
|
|
95
|
+
/**
|
|
96
|
+
* <p>The HTTP status of the request.</p>
|
|
97
|
+
*/
|
|
98
|
+
Status?: number;
|
|
99
|
+
/**
|
|
100
|
+
* <p>The dataset refresh properties.</p>
|
|
101
|
+
*/
|
|
102
|
+
DataSetRefreshProperties?: DataSetRefreshProperties;
|
|
103
|
+
}
|
|
104
|
+
/**
|
|
105
|
+
* @public
|
|
106
|
+
*/
|
|
107
|
+
export interface DescribeDataSourceRequest {
|
|
108
|
+
/**
|
|
109
|
+
* <p>The Amazon Web Services account ID.</p>
|
|
110
|
+
*/
|
|
111
|
+
AwsAccountId: string | undefined;
|
|
112
|
+
/**
|
|
113
|
+
* <p>The ID of the data source. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.</p>
|
|
114
|
+
*/
|
|
115
|
+
DataSourceId: string | undefined;
|
|
116
|
+
}
|
|
117
|
+
/**
|
|
118
|
+
* @public
|
|
119
|
+
*/
|
|
120
|
+
export interface DescribeDataSourceResponse {
|
|
121
|
+
/**
|
|
122
|
+
* <p>The information on the data source.</p>
|
|
123
|
+
*/
|
|
124
|
+
DataSource?: DataSource;
|
|
125
|
+
/**
|
|
126
|
+
* <p>The Amazon Web Services request ID for this operation.</p>
|
|
127
|
+
*/
|
|
128
|
+
RequestId?: string;
|
|
129
|
+
/**
|
|
130
|
+
* <p>The HTTP status of the request.</p>
|
|
131
|
+
*/
|
|
132
|
+
Status?: number;
|
|
133
|
+
}
|
|
134
|
+
/**
|
|
135
|
+
* @public
|
|
136
|
+
*/
|
|
137
|
+
export interface DescribeDataSourcePermissionsRequest {
|
|
138
|
+
/**
|
|
139
|
+
* <p>The Amazon Web Services account ID.</p>
|
|
140
|
+
*/
|
|
141
|
+
AwsAccountId: string | undefined;
|
|
142
|
+
/**
|
|
143
|
+
* <p>The ID of the data source. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.</p>
|
|
144
|
+
*/
|
|
145
|
+
DataSourceId: string | undefined;
|
|
146
|
+
}
|
|
147
|
+
/**
|
|
148
|
+
* @public
|
|
149
|
+
*/
|
|
150
|
+
export interface DescribeDataSourcePermissionsResponse {
|
|
151
|
+
/**
|
|
152
|
+
* <p>The Amazon Resource Name (ARN) of the data source.</p>
|
|
153
|
+
*/
|
|
154
|
+
DataSourceArn?: string;
|
|
155
|
+
/**
|
|
156
|
+
* <p>The ID of the data source. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.</p>
|
|
157
|
+
*/
|
|
158
|
+
DataSourceId?: string;
|
|
159
|
+
/**
|
|
160
|
+
* <p>A list of resource permissions on the data source.</p>
|
|
161
|
+
*/
|
|
162
|
+
Permissions?: ResourcePermission[];
|
|
163
|
+
/**
|
|
164
|
+
* <p>The Amazon Web Services request ID for this operation.</p>
|
|
165
|
+
*/
|
|
166
|
+
RequestId?: string;
|
|
167
|
+
/**
|
|
168
|
+
* <p>The HTTP status of the request.</p>
|
|
169
|
+
*/
|
|
170
|
+
Status?: number;
|
|
171
|
+
}
|
|
172
|
+
/**
|
|
173
|
+
* @public
|
|
174
|
+
*/
|
|
175
|
+
export interface DescribeFolderRequest {
|
|
176
|
+
/**
|
|
177
|
+
* <p>The ID for the Amazon Web Services account that contains the folder.</p>
|
|
178
|
+
*/
|
|
179
|
+
AwsAccountId: string | undefined;
|
|
180
|
+
/**
|
|
181
|
+
* <p>The ID of the folder.</p>
|
|
182
|
+
*/
|
|
183
|
+
FolderId: string | undefined;
|
|
184
|
+
}
|
|
185
|
+
/**
|
|
186
|
+
* @public
|
|
187
|
+
* <p>A folder in Amazon QuickSight.</p>
|
|
188
|
+
*/
|
|
189
|
+
export interface Folder {
|
|
190
|
+
/**
|
|
191
|
+
* <p>The ID of the folder.</p>
|
|
192
|
+
*/
|
|
193
|
+
FolderId?: string;
|
|
194
|
+
/**
|
|
195
|
+
* <p>The Amazon Resource Name (ARN) for the folder.</p>
|
|
196
|
+
*/
|
|
197
|
+
Arn?: string;
|
|
198
|
+
/**
|
|
199
|
+
* <p>A display name for the folder.</p>
|
|
200
|
+
*/
|
|
201
|
+
Name?: string;
|
|
202
|
+
/**
|
|
203
|
+
* <p>The type of folder it is.</p>
|
|
204
|
+
*/
|
|
205
|
+
FolderType?: FolderType | string;
|
|
206
|
+
/**
|
|
207
|
+
* <p>An array of ancestor ARN strings for the folder.</p>
|
|
208
|
+
*/
|
|
209
|
+
FolderPath?: string[];
|
|
210
|
+
/**
|
|
211
|
+
* <p>The time that the folder was created.</p>
|
|
212
|
+
*/
|
|
213
|
+
CreatedTime?: Date;
|
|
214
|
+
/**
|
|
215
|
+
* <p>The time that the folder was last updated.</p>
|
|
216
|
+
*/
|
|
217
|
+
LastUpdatedTime?: Date;
|
|
218
|
+
}
|
|
219
|
+
/**
|
|
220
|
+
* @public
|
|
221
|
+
*/
|
|
222
|
+
export interface DescribeFolderResponse {
|
|
223
|
+
/**
|
|
224
|
+
* <p>The HTTP status of the request.</p>
|
|
225
|
+
*/
|
|
226
|
+
Status?: number;
|
|
227
|
+
/**
|
|
228
|
+
* <p>Information about the folder.</p>
|
|
229
|
+
*/
|
|
230
|
+
Folder?: Folder;
|
|
231
|
+
/**
|
|
232
|
+
* <p>The Amazon Web Services request ID for this operation.</p>
|
|
233
|
+
*/
|
|
234
|
+
RequestId?: string;
|
|
235
|
+
}
|
|
236
|
+
/**
|
|
237
|
+
* @public
|
|
238
|
+
*/
|
|
239
|
+
export interface DescribeFolderPermissionsRequest {
|
|
240
|
+
/**
|
|
241
|
+
* <p>The ID for the Amazon Web Services account that contains the folder.</p>
|
|
242
|
+
*/
|
|
243
|
+
AwsAccountId: string | undefined;
|
|
244
|
+
/**
|
|
245
|
+
* <p>The ID of the folder.</p>
|
|
246
|
+
*/
|
|
247
|
+
FolderId: string | undefined;
|
|
248
|
+
}
|
|
249
|
+
/**
|
|
250
|
+
* @public
|
|
251
|
+
*/
|
|
252
|
+
export interface DescribeFolderPermissionsResponse {
|
|
253
|
+
/**
|
|
254
|
+
* <p>The HTTP status of the request.</p>
|
|
255
|
+
*/
|
|
256
|
+
Status?: number;
|
|
257
|
+
/**
|
|
258
|
+
* <p>The ID of the folder.</p>
|
|
259
|
+
*/
|
|
260
|
+
FolderId?: string;
|
|
261
|
+
/**
|
|
262
|
+
* <p>The Amazon Resource Name (ARN) for the folder.</p>
|
|
263
|
+
*/
|
|
264
|
+
Arn?: string;
|
|
265
|
+
/**
|
|
266
|
+
* <p>Information about the permissions on the folder.</p>
|
|
267
|
+
*/
|
|
268
|
+
Permissions?: ResourcePermission[];
|
|
269
|
+
/**
|
|
270
|
+
* <p>The Amazon Web Services request ID for this operation.</p>
|
|
271
|
+
*/
|
|
272
|
+
RequestId?: string;
|
|
273
|
+
}
|
|
274
|
+
/**
|
|
275
|
+
* @public
|
|
276
|
+
*/
|
|
277
|
+
export interface DescribeFolderResolvedPermissionsRequest {
|
|
278
|
+
/**
|
|
279
|
+
* <p>The ID for the Amazon Web Services account that contains the folder.</p>
|
|
280
|
+
*/
|
|
281
|
+
AwsAccountId: string | undefined;
|
|
282
|
+
/**
|
|
283
|
+
* <p>The ID of the folder.</p>
|
|
284
|
+
*/
|
|
285
|
+
FolderId: string | undefined;
|
|
286
|
+
}
|
|
287
|
+
/**
|
|
288
|
+
* @public
|
|
289
|
+
*/
|
|
290
|
+
export interface DescribeFolderResolvedPermissionsResponse {
|
|
291
|
+
/**
|
|
292
|
+
* <p>The HTTP status of the request.</p>
|
|
293
|
+
*/
|
|
294
|
+
Status?: number;
|
|
295
|
+
/**
|
|
296
|
+
* <p>The ID of the folder.</p>
|
|
297
|
+
*/
|
|
298
|
+
FolderId?: string;
|
|
299
|
+
/**
|
|
300
|
+
* <p>The Amazon Resource Name (ARN) of the folder.</p>
|
|
301
|
+
*/
|
|
302
|
+
Arn?: string;
|
|
303
|
+
/**
|
|
304
|
+
* <p>Information about the permissions for the folder.</p>
|
|
305
|
+
*/
|
|
306
|
+
Permissions?: ResourcePermission[];
|
|
307
|
+
/**
|
|
308
|
+
* <p>The Amazon Web Services request ID for this operation.</p>
|
|
309
|
+
*/
|
|
310
|
+
RequestId?: string;
|
|
311
|
+
}
|
|
312
|
+
/**
|
|
313
|
+
* @public
|
|
314
|
+
*/
|
|
315
|
+
export interface DescribeGroupRequest {
|
|
316
|
+
/**
|
|
317
|
+
* <p>The name of the group that you want to describe.</p>
|
|
318
|
+
*/
|
|
319
|
+
GroupName: string | undefined;
|
|
320
|
+
/**
|
|
321
|
+
* <p>The ID for the Amazon Web Services account that the group is in. Currently, you use the ID for the
|
|
322
|
+
* Amazon Web Services account that contains your Amazon QuickSight account.</p>
|
|
323
|
+
*/
|
|
324
|
+
AwsAccountId: string | undefined;
|
|
325
|
+
/**
|
|
326
|
+
* <p>The namespace of the group that you want described.</p>
|
|
327
|
+
*/
|
|
328
|
+
Namespace: string | undefined;
|
|
329
|
+
}
|
|
330
|
+
/**
|
|
331
|
+
* @public
|
|
332
|
+
*/
|
|
333
|
+
export interface DescribeGroupResponse {
|
|
334
|
+
/**
|
|
335
|
+
* <p>The name of the group.</p>
|
|
336
|
+
*/
|
|
337
|
+
Group?: Group;
|
|
338
|
+
/**
|
|
339
|
+
* <p>The Amazon Web Services request ID for this operation.</p>
|
|
340
|
+
*/
|
|
341
|
+
RequestId?: string;
|
|
342
|
+
/**
|
|
343
|
+
* <p>The HTTP status of the request.</p>
|
|
344
|
+
*/
|
|
345
|
+
Status?: number;
|
|
346
|
+
}
|
|
347
|
+
/**
|
|
348
|
+
* @public
|
|
349
|
+
*/
|
|
350
|
+
export interface DescribeGroupMembershipRequest {
|
|
351
|
+
/**
|
|
352
|
+
* <p>The user name of the user that you want to search for.</p>
|
|
353
|
+
*/
|
|
354
|
+
MemberName: string | undefined;
|
|
355
|
+
/**
|
|
356
|
+
* <p>The name of the group that you want to search.</p>
|
|
357
|
+
*/
|
|
358
|
+
GroupName: string | undefined;
|
|
359
|
+
/**
|
|
360
|
+
* <p>The ID for the Amazon Web Services account that the group is in. Currently, you use the ID for the
|
|
361
|
+
* Amazon Web Services account that contains your Amazon QuickSight account.</p>
|
|
362
|
+
*/
|
|
363
|
+
AwsAccountId: string | undefined;
|
|
364
|
+
/**
|
|
365
|
+
* <p>The namespace that includes the group you are searching within.</p>
|
|
366
|
+
*/
|
|
367
|
+
Namespace: string | undefined;
|
|
368
|
+
}
|
|
369
|
+
/**
|
|
370
|
+
* @public
|
|
371
|
+
*/
|
|
372
|
+
export interface DescribeGroupMembershipResponse {
|
|
373
|
+
/**
|
|
374
|
+
* <p>A member of an Amazon QuickSight group. Currently, group members must be users. Groups
|
|
375
|
+
* can't be members of another group. .</p>
|
|
376
|
+
*/
|
|
377
|
+
GroupMember?: GroupMember;
|
|
378
|
+
/**
|
|
379
|
+
* <p>The Amazon Web Services request ID for this operation.</p>
|
|
380
|
+
*/
|
|
381
|
+
RequestId?: string;
|
|
382
|
+
/**
|
|
383
|
+
* <p>The HTTP status of the request.</p>
|
|
384
|
+
*/
|
|
385
|
+
Status?: number;
|
|
386
|
+
}
|
|
387
|
+
/**
|
|
388
|
+
* @public
|
|
389
|
+
*/
|
|
390
|
+
export interface DescribeIAMPolicyAssignmentRequest {
|
|
391
|
+
/**
|
|
392
|
+
* <p>The ID of the Amazon Web Services account that contains the assignment that you want to
|
|
393
|
+
* describe.</p>
|
|
394
|
+
*/
|
|
395
|
+
AwsAccountId: string | undefined;
|
|
396
|
+
/**
|
|
397
|
+
* <p>The name of the assignment, also called a rule.</p>
|
|
398
|
+
*/
|
|
399
|
+
AssignmentName: string | undefined;
|
|
400
|
+
/**
|
|
401
|
+
* <p>The namespace that contains the assignment.</p>
|
|
402
|
+
*/
|
|
403
|
+
Namespace: string | undefined;
|
|
404
|
+
}
|
|
405
|
+
/**
|
|
406
|
+
* @public
|
|
407
|
+
* <p>An Identity and Access Management (IAM) policy assignment.</p>
|
|
408
|
+
*/
|
|
409
|
+
export interface IAMPolicyAssignment {
|
|
410
|
+
/**
|
|
411
|
+
* <p>The Amazon Web Services account ID.</p>
|
|
412
|
+
*/
|
|
413
|
+
AwsAccountId?: string;
|
|
414
|
+
/**
|
|
415
|
+
* <p>Assignment ID.</p>
|
|
416
|
+
*/
|
|
417
|
+
AssignmentId?: string;
|
|
418
|
+
/**
|
|
419
|
+
* <p>Assignment name.</p>
|
|
420
|
+
*/
|
|
421
|
+
AssignmentName?: string;
|
|
422
|
+
/**
|
|
423
|
+
* <p>The Amazon Resource Name (ARN) for the IAM policy.</p>
|
|
424
|
+
*/
|
|
425
|
+
PolicyArn?: string;
|
|
426
|
+
/**
|
|
427
|
+
* <p>Identities.</p>
|
|
428
|
+
*/
|
|
429
|
+
Identities?: Record<string, string[]>;
|
|
430
|
+
/**
|
|
431
|
+
* <p>Assignment status.</p>
|
|
432
|
+
*/
|
|
433
|
+
AssignmentStatus?: AssignmentStatus | string;
|
|
434
|
+
}
|
|
435
|
+
/**
|
|
436
|
+
* @public
|
|
437
|
+
*/
|
|
438
|
+
export interface DescribeIAMPolicyAssignmentResponse {
|
|
439
|
+
/**
|
|
440
|
+
* <p>Information describing the IAM policy assignment.</p>
|
|
441
|
+
*/
|
|
442
|
+
IAMPolicyAssignment?: IAMPolicyAssignment;
|
|
443
|
+
/**
|
|
444
|
+
* <p>The Amazon Web Services request ID for this operation.</p>
|
|
445
|
+
*/
|
|
446
|
+
RequestId?: string;
|
|
447
|
+
/**
|
|
448
|
+
* <p>The HTTP status of the request.</p>
|
|
449
|
+
*/
|
|
450
|
+
Status?: number;
|
|
451
|
+
}
|
|
452
|
+
/**
|
|
453
|
+
* @public
|
|
454
|
+
* <p>The <code>NextToken</code> value isn't valid.</p>
|
|
455
|
+
*/
|
|
456
|
+
export declare class InvalidNextTokenException extends __BaseException {
|
|
457
|
+
readonly name: "InvalidNextTokenException";
|
|
458
|
+
readonly $fault: "client";
|
|
459
|
+
Message?: string;
|
|
460
|
+
/**
|
|
461
|
+
* <p>The Amazon Web Services request ID for this request.</p>
|
|
462
|
+
*/
|
|
463
|
+
RequestId?: string;
|
|
464
|
+
/**
|
|
465
|
+
* @internal
|
|
466
|
+
*/
|
|
467
|
+
constructor(opts: __ExceptionOptionType<InvalidNextTokenException, __BaseException>);
|
|
468
|
+
}
|
|
469
|
+
/**
|
|
470
|
+
* @public
|
|
471
|
+
*/
|
|
472
|
+
export interface DescribeIngestionRequest {
|
|
473
|
+
/**
|
|
474
|
+
* <p>The Amazon Web Services account ID.</p>
|
|
475
|
+
*/
|
|
476
|
+
AwsAccountId: string | undefined;
|
|
477
|
+
/**
|
|
478
|
+
* <p>The ID of the dataset used in the ingestion.</p>
|
|
479
|
+
*/
|
|
480
|
+
DataSetId: string | undefined;
|
|
481
|
+
/**
|
|
482
|
+
* <p>An ID for the ingestion.</p>
|
|
483
|
+
*/
|
|
484
|
+
IngestionId: string | undefined;
|
|
485
|
+
}
|
|
486
|
+
/**
|
|
487
|
+
* @public
|
|
488
|
+
* @enum
|
|
489
|
+
*/
|
|
490
|
+
export declare const IngestionErrorType: {
|
|
491
|
+
readonly ACCOUNT_CAPACITY_LIMIT_EXCEEDED: "ACCOUNT_CAPACITY_LIMIT_EXCEEDED";
|
|
492
|
+
readonly CONNECTION_FAILURE: "CONNECTION_FAILURE";
|
|
493
|
+
readonly CURSOR_NOT_ENABLED: "CURSOR_NOT_ENABLED";
|
|
494
|
+
readonly CUSTOMER_ERROR: "CUSTOMER_ERROR";
|
|
495
|
+
readonly DATA_SET_DELETED: "DATA_SET_DELETED";
|
|
496
|
+
readonly DATA_SET_NOT_SPICE: "DATA_SET_NOT_SPICE";
|
|
497
|
+
readonly DATA_SET_SIZE_LIMIT_EXCEEDED: "DATA_SET_SIZE_LIMIT_EXCEEDED";
|
|
498
|
+
readonly DATA_SOURCE_AUTH_FAILED: "DATA_SOURCE_AUTH_FAILED";
|
|
499
|
+
readonly DATA_SOURCE_CONNECTION_FAILED: "DATA_SOURCE_CONNECTION_FAILED";
|
|
500
|
+
readonly DATA_SOURCE_NOT_FOUND: "DATA_SOURCE_NOT_FOUND";
|
|
501
|
+
readonly DATA_TOLERANCE_EXCEPTION: "DATA_TOLERANCE_EXCEPTION";
|
|
502
|
+
readonly DUPLICATE_COLUMN_NAMES_FOUND: "DUPLICATE_COLUMN_NAMES_FOUND";
|
|
503
|
+
readonly ELASTICSEARCH_CURSOR_NOT_ENABLED: "ELASTICSEARCH_CURSOR_NOT_ENABLED";
|
|
504
|
+
readonly FAILURE_TO_ASSUME_ROLE: "FAILURE_TO_ASSUME_ROLE";
|
|
505
|
+
readonly FAILURE_TO_PROCESS_JSON_FILE: "FAILURE_TO_PROCESS_JSON_FILE";
|
|
506
|
+
readonly IAM_ROLE_NOT_AVAILABLE: "IAM_ROLE_NOT_AVAILABLE";
|
|
507
|
+
readonly INGESTION_CANCELED: "INGESTION_CANCELED";
|
|
508
|
+
readonly INGESTION_SUPERSEDED: "INGESTION_SUPERSEDED";
|
|
509
|
+
readonly INTERNAL_SERVICE_ERROR: "INTERNAL_SERVICE_ERROR";
|
|
510
|
+
readonly INVALID_DATAPREP_SYNTAX: "INVALID_DATAPREP_SYNTAX";
|
|
511
|
+
readonly INVALID_DATA_SOURCE_CONFIG: "INVALID_DATA_SOURCE_CONFIG";
|
|
512
|
+
readonly INVALID_DATE_FORMAT: "INVALID_DATE_FORMAT";
|
|
513
|
+
readonly IOT_DATA_SET_FILE_EMPTY: "IOT_DATA_SET_FILE_EMPTY";
|
|
514
|
+
readonly IOT_FILE_NOT_FOUND: "IOT_FILE_NOT_FOUND";
|
|
515
|
+
readonly OAUTH_TOKEN_FAILURE: "OAUTH_TOKEN_FAILURE";
|
|
516
|
+
readonly PASSWORD_AUTHENTICATION_FAILURE: "PASSWORD_AUTHENTICATION_FAILURE";
|
|
517
|
+
readonly PERMISSION_DENIED: "PERMISSION_DENIED";
|
|
518
|
+
readonly PERMISSION_NOT_FOUND: "PERMISSION_NOT_FOUND";
|
|
519
|
+
readonly QUERY_TIMEOUT: "QUERY_TIMEOUT";
|
|
520
|
+
readonly REFRESH_SUPPRESSED_BY_EDIT: "REFRESH_SUPPRESSED_BY_EDIT";
|
|
521
|
+
readonly ROW_SIZE_LIMIT_EXCEEDED: "ROW_SIZE_LIMIT_EXCEEDED";
|
|
522
|
+
readonly S3_FILE_INACCESSIBLE: "S3_FILE_INACCESSIBLE";
|
|
523
|
+
readonly S3_MANIFEST_ERROR: "S3_MANIFEST_ERROR";
|
|
524
|
+
readonly S3_UPLOADED_FILE_DELETED: "S3_UPLOADED_FILE_DELETED";
|
|
525
|
+
readonly SOURCE_API_LIMIT_EXCEEDED_FAILURE: "SOURCE_API_LIMIT_EXCEEDED_FAILURE";
|
|
526
|
+
readonly SOURCE_RESOURCE_LIMIT_EXCEEDED: "SOURCE_RESOURCE_LIMIT_EXCEEDED";
|
|
527
|
+
readonly SPICE_TABLE_NOT_FOUND: "SPICE_TABLE_NOT_FOUND";
|
|
528
|
+
readonly SQL_EXCEPTION: "SQL_EXCEPTION";
|
|
529
|
+
readonly SQL_INVALID_PARAMETER_VALUE: "SQL_INVALID_PARAMETER_VALUE";
|
|
530
|
+
readonly SQL_NUMERIC_OVERFLOW: "SQL_NUMERIC_OVERFLOW";
|
|
531
|
+
readonly SQL_SCHEMA_MISMATCH_ERROR: "SQL_SCHEMA_MISMATCH_ERROR";
|
|
532
|
+
readonly SQL_TABLE_NOT_FOUND: "SQL_TABLE_NOT_FOUND";
|
|
533
|
+
readonly SSL_CERTIFICATE_VALIDATION_FAILURE: "SSL_CERTIFICATE_VALIDATION_FAILURE";
|
|
534
|
+
readonly UNRESOLVABLE_HOST: "UNRESOLVABLE_HOST";
|
|
535
|
+
readonly UNROUTABLE_HOST: "UNROUTABLE_HOST";
|
|
536
|
+
};
|
|
537
|
+
/**
|
|
538
|
+
* @public
|
|
539
|
+
*/
|
|
540
|
+
export type IngestionErrorType = (typeof IngestionErrorType)[keyof typeof IngestionErrorType];
|
|
541
|
+
/**
|
|
542
|
+
* @public
|
|
543
|
+
* <p>Error information for the SPICE ingestion of a dataset.</p>
|
|
544
|
+
*/
|
|
545
|
+
export interface ErrorInfo {
|
|
546
|
+
/**
|
|
547
|
+
* <p>Error type.</p>
|
|
548
|
+
*/
|
|
549
|
+
Type?: IngestionErrorType | string;
|
|
550
|
+
/**
|
|
551
|
+
* <p>Error message.</p>
|
|
552
|
+
*/
|
|
553
|
+
Message?: string;
|
|
554
|
+
}
|
|
555
|
+
/**
|
|
556
|
+
* @public
|
|
557
|
+
* <p>Information about a queued dataset SPICE ingestion.</p>
|
|
558
|
+
*/
|
|
559
|
+
export interface QueueInfo {
|
|
560
|
+
/**
|
|
561
|
+
* <p>The ID of the queued ingestion.</p>
|
|
562
|
+
*/
|
|
563
|
+
WaitingOnIngestion: string | undefined;
|
|
564
|
+
/**
|
|
565
|
+
* <p>The ID of the ongoing ingestion. The queued ingestion is waiting for the ongoing
|
|
566
|
+
* ingestion to complete.</p>
|
|
567
|
+
*/
|
|
568
|
+
QueuedIngestion: string | undefined;
|
|
569
|
+
}
|
|
570
|
+
/**
|
|
571
|
+
* @public
|
|
572
|
+
* @enum
|
|
573
|
+
*/
|
|
574
|
+
export declare const IngestionRequestSource: {
|
|
575
|
+
readonly MANUAL: "MANUAL";
|
|
576
|
+
readonly SCHEDULED: "SCHEDULED";
|
|
577
|
+
};
|
|
578
|
+
/**
|
|
579
|
+
* @public
|
|
580
|
+
*/
|
|
581
|
+
export type IngestionRequestSource = (typeof IngestionRequestSource)[keyof typeof IngestionRequestSource];
|
|
582
|
+
/**
|
|
583
|
+
* @public
|
|
584
|
+
* @enum
|
|
585
|
+
*/
|
|
586
|
+
export declare const IngestionRequestType: {
|
|
587
|
+
readonly EDIT: "EDIT";
|
|
588
|
+
readonly FULL_REFRESH: "FULL_REFRESH";
|
|
589
|
+
readonly INCREMENTAL_REFRESH: "INCREMENTAL_REFRESH";
|
|
590
|
+
readonly INITIAL_INGESTION: "INITIAL_INGESTION";
|
|
591
|
+
};
|
|
592
|
+
/**
|
|
593
|
+
* @public
|
|
594
|
+
*/
|
|
595
|
+
export type IngestionRequestType = (typeof IngestionRequestType)[keyof typeof IngestionRequestType];
|
|
596
|
+
/**
|
|
597
|
+
* @public
|
|
598
|
+
* <p>Information about rows for a data set SPICE ingestion.</p>
|
|
599
|
+
*/
|
|
600
|
+
export interface RowInfo {
|
|
601
|
+
/**
|
|
602
|
+
* <p>The number of rows that were ingested.</p>
|
|
603
|
+
*/
|
|
604
|
+
RowsIngested?: number;
|
|
605
|
+
/**
|
|
606
|
+
* <p>The number of rows that were not ingested.</p>
|
|
607
|
+
*/
|
|
608
|
+
RowsDropped?: number;
|
|
609
|
+
/**
|
|
610
|
+
* <p>The total number of rows in the dataset.</p>
|
|
611
|
+
*/
|
|
612
|
+
TotalRowsInDataset?: number;
|
|
613
|
+
}
|
|
614
|
+
/**
|
|
615
|
+
* @public
|
|
616
|
+
* <p>Information about the SPICE ingestion for a dataset.</p>
|
|
617
|
+
*/
|
|
618
|
+
export interface Ingestion {
|
|
619
|
+
/**
|
|
620
|
+
* <p>The Amazon Resource Name (ARN) of the resource.</p>
|
|
621
|
+
*/
|
|
622
|
+
Arn: string | undefined;
|
|
623
|
+
/**
|
|
624
|
+
* <p>Ingestion ID.</p>
|
|
625
|
+
*/
|
|
626
|
+
IngestionId?: string;
|
|
627
|
+
/**
|
|
628
|
+
* <p>Ingestion status.</p>
|
|
629
|
+
*/
|
|
630
|
+
IngestionStatus: IngestionStatus | string | undefined;
|
|
631
|
+
/**
|
|
632
|
+
* <p>Error information for this ingestion.</p>
|
|
633
|
+
*/
|
|
634
|
+
ErrorInfo?: ErrorInfo;
|
|
635
|
+
/**
|
|
636
|
+
* <p>Information about rows for a data set SPICE ingestion.</p>
|
|
637
|
+
*/
|
|
638
|
+
RowInfo?: RowInfo;
|
|
639
|
+
/**
|
|
640
|
+
* <p>Information about a queued dataset SPICE ingestion.</p>
|
|
641
|
+
*/
|
|
642
|
+
QueueInfo?: QueueInfo;
|
|
643
|
+
/**
|
|
644
|
+
* <p>The time that this ingestion started.</p>
|
|
645
|
+
*/
|
|
646
|
+
CreatedTime: Date | undefined;
|
|
647
|
+
/**
|
|
648
|
+
* <p>The time that this ingestion took, measured in seconds.</p>
|
|
649
|
+
*/
|
|
650
|
+
IngestionTimeInSeconds?: number;
|
|
651
|
+
/**
|
|
652
|
+
* <p>The size of the data ingested, in bytes.</p>
|
|
653
|
+
*/
|
|
654
|
+
IngestionSizeInBytes?: number;
|
|
655
|
+
/**
|
|
656
|
+
* <p>Event source for this ingestion.</p>
|
|
657
|
+
*/
|
|
658
|
+
RequestSource?: IngestionRequestSource | string;
|
|
659
|
+
/**
|
|
660
|
+
* <p>Type of this ingestion.</p>
|
|
661
|
+
*/
|
|
662
|
+
RequestType?: IngestionRequestType | string;
|
|
663
|
+
}
|
|
664
|
+
/**
|
|
665
|
+
* @public
|
|
666
|
+
*/
|
|
667
|
+
export interface DescribeIngestionResponse {
|
|
668
|
+
/**
|
|
669
|
+
* <p>Information about the ingestion.</p>
|
|
670
|
+
*/
|
|
671
|
+
Ingestion?: Ingestion;
|
|
672
|
+
/**
|
|
673
|
+
* <p>The Amazon Web Services request ID for this operation.</p>
|
|
674
|
+
*/
|
|
675
|
+
RequestId?: string;
|
|
676
|
+
/**
|
|
677
|
+
* <p>The HTTP status of the request.</p>
|
|
678
|
+
*/
|
|
679
|
+
Status?: number;
|
|
680
|
+
}
|
|
681
|
+
/**
|
|
682
|
+
* @public
|
|
683
|
+
*/
|
|
684
|
+
export interface DescribeIpRestrictionRequest {
|
|
685
|
+
/**
|
|
686
|
+
* <p>The ID of the Amazon Web Services account that contains the IP rules.</p>
|
|
687
|
+
*/
|
|
688
|
+
AwsAccountId: string | undefined;
|
|
689
|
+
}
|
|
690
|
+
/**
|
|
691
|
+
* @public
|
|
692
|
+
*/
|
|
693
|
+
export interface DescribeIpRestrictionResponse {
|
|
694
|
+
/**
|
|
695
|
+
* <p>The ID of the Amazon Web Services account that contains the IP rules.</p>
|
|
696
|
+
*/
|
|
697
|
+
AwsAccountId?: string;
|
|
698
|
+
/**
|
|
699
|
+
* <p>A map that describes the IP rules with CIDR range and description.</p>
|
|
700
|
+
*/
|
|
701
|
+
IpRestrictionRuleMap?: Record<string, string>;
|
|
702
|
+
/**
|
|
703
|
+
* <p>A value that specifies whether IP rules are turned on.</p>
|
|
704
|
+
*/
|
|
705
|
+
Enabled?: boolean;
|
|
706
|
+
/**
|
|
707
|
+
* <p>The Amazon Web Services request ID for this operation.</p>
|
|
708
|
+
*/
|
|
709
|
+
RequestId?: string;
|
|
710
|
+
/**
|
|
711
|
+
* <p>The HTTP status of the request.
|
|
712
|
+
* </p>
|
|
713
|
+
*/
|
|
714
|
+
Status?: number;
|
|
715
|
+
}
|
|
716
|
+
/**
|
|
717
|
+
* @public
|
|
718
|
+
*/
|
|
719
|
+
export interface DescribeNamespaceRequest {
|
|
720
|
+
/**
|
|
721
|
+
* <p>The ID for the Amazon Web Services account that contains the Amazon QuickSight namespace that you want to describe.</p>
|
|
722
|
+
*/
|
|
723
|
+
AwsAccountId: string | undefined;
|
|
724
|
+
/**
|
|
725
|
+
* <p>The namespace that you want to describe.</p>
|
|
726
|
+
*/
|
|
727
|
+
Namespace: string | undefined;
|
|
728
|
+
}
|
|
729
|
+
/**
|
|
730
|
+
* @public
|
|
731
|
+
* @enum
|
|
732
|
+
*/
|
|
733
|
+
export declare const NamespaceErrorType: {
|
|
734
|
+
readonly INTERNAL_SERVICE_ERROR: "INTERNAL_SERVICE_ERROR";
|
|
735
|
+
readonly PERMISSION_DENIED: "PERMISSION_DENIED";
|
|
736
|
+
};
|
|
737
|
+
/**
|
|
738
|
+
* @public
|
|
739
|
+
*/
|
|
740
|
+
export type NamespaceErrorType = (typeof NamespaceErrorType)[keyof typeof NamespaceErrorType];
|
|
741
|
+
/**
|
|
742
|
+
* @public
|
|
743
|
+
* <p>Errors that occur during namespace creation.</p>
|
|
744
|
+
*/
|
|
745
|
+
export interface NamespaceError {
|
|
746
|
+
/**
|
|
747
|
+
* <p>The error type.</p>
|
|
748
|
+
*/
|
|
749
|
+
Type?: NamespaceErrorType | string;
|
|
750
|
+
/**
|
|
751
|
+
* <p>The message for the error.</p>
|
|
752
|
+
*/
|
|
753
|
+
Message?: string;
|
|
754
|
+
}
|
|
755
|
+
/**
|
|
756
|
+
* @public
|
|
757
|
+
* <p>The error type.</p>
|
|
758
|
+
*/
|
|
759
|
+
export interface NamespaceInfoV2 {
|
|
760
|
+
/**
|
|
761
|
+
* <p>The name of the error.</p>
|
|
762
|
+
*/
|
|
763
|
+
Name?: string;
|
|
764
|
+
/**
|
|
765
|
+
* <p>The namespace ARN.</p>
|
|
766
|
+
*/
|
|
767
|
+
Arn?: string;
|
|
768
|
+
/**
|
|
769
|
+
* <p>The namespace Amazon Web Services Region.</p>
|
|
770
|
+
*/
|
|
771
|
+
CapacityRegion?: string;
|
|
772
|
+
/**
|
|
773
|
+
* <p>The creation status of a namespace that is not yet completely created.</p>
|
|
774
|
+
*/
|
|
775
|
+
CreationStatus?: NamespaceStatus | string;
|
|
776
|
+
/**
|
|
777
|
+
* <p>The identity store used for the namespace.</p>
|
|
778
|
+
*/
|
|
779
|
+
IdentityStore?: IdentityStore | string;
|
|
780
|
+
/**
|
|
781
|
+
* <p>An error that occurred when the namespace was created.</p>
|
|
782
|
+
*/
|
|
783
|
+
NamespaceError?: NamespaceError;
|
|
784
|
+
}
|
|
785
|
+
/**
|
|
786
|
+
* @public
|
|
787
|
+
*/
|
|
788
|
+
export interface DescribeNamespaceResponse {
|
|
789
|
+
/**
|
|
790
|
+
* <p>The information about the namespace that you're describing. The response includes
|
|
791
|
+
* the namespace ARN, name, Amazon Web Services Region, creation status, and identity store. <code>DescribeNamespace</code> also
|
|
792
|
+
* works for namespaces that are in the process of being created. For incomplete namespaces,
|
|
793
|
+
* this API operation lists the namespace error types and messages associated with the creation process.</p>
|
|
794
|
+
*/
|
|
795
|
+
Namespace?: NamespaceInfoV2;
|
|
796
|
+
/**
|
|
797
|
+
* <p>The Amazon Web Services request ID for this operation.</p>
|
|
798
|
+
*/
|
|
799
|
+
RequestId?: string;
|
|
800
|
+
/**
|
|
801
|
+
* <p>The HTTP status of the request.</p>
|
|
802
|
+
*/
|
|
803
|
+
Status?: number;
|
|
804
|
+
}
|
|
805
|
+
/**
|
|
806
|
+
* @public
|
|
807
|
+
*/
|
|
808
|
+
export interface DescribeRefreshScheduleRequest {
|
|
809
|
+
/**
|
|
810
|
+
* <p>The Amazon Web Services account ID.</p>
|
|
811
|
+
*/
|
|
812
|
+
AwsAccountId: string | undefined;
|
|
813
|
+
/**
|
|
814
|
+
* <p>The ID of the dataset.</p>
|
|
815
|
+
*/
|
|
816
|
+
DataSetId: string | undefined;
|
|
817
|
+
/**
|
|
818
|
+
* <p>The ID of the refresh schedule.</p>
|
|
819
|
+
*/
|
|
820
|
+
ScheduleId: string | undefined;
|
|
821
|
+
}
|
|
822
|
+
/**
|
|
823
|
+
* @public
|
|
824
|
+
*/
|
|
825
|
+
export interface DescribeRefreshScheduleResponse {
|
|
826
|
+
/**
|
|
827
|
+
* <p>The refresh schedule.</p>
|
|
828
|
+
*/
|
|
829
|
+
RefreshSchedule?: RefreshSchedule;
|
|
830
|
+
/**
|
|
831
|
+
* <p>The HTTP status of the request.</p>
|
|
832
|
+
*/
|
|
833
|
+
Status?: number;
|
|
834
|
+
/**
|
|
835
|
+
* <p>The Amazon Web Services request ID for this operation.</p>
|
|
836
|
+
*/
|
|
837
|
+
RequestId?: string;
|
|
838
|
+
/**
|
|
839
|
+
* <p>The Amazon Resource Name (ARN) for the refresh schedule.</p>
|
|
840
|
+
*/
|
|
841
|
+
Arn?: string;
|
|
842
|
+
}
|
|
843
|
+
/**
|
|
844
|
+
* @public
|
|
845
|
+
*/
|
|
846
|
+
export interface DescribeTemplateRequest {
|
|
847
|
+
/**
|
|
848
|
+
* <p>The ID of the Amazon Web Services account that contains the template that you're describing.</p>
|
|
849
|
+
*/
|
|
850
|
+
AwsAccountId: string | undefined;
|
|
851
|
+
/**
|
|
852
|
+
* <p>The ID for the template.</p>
|
|
853
|
+
*/
|
|
854
|
+
TemplateId: string | undefined;
|
|
855
|
+
/**
|
|
856
|
+
* <p>(Optional) The number for the version to describe. If a <code>VersionNumber</code> parameter
|
|
857
|
+
* value isn't provided, the latest version of the template is described.</p>
|
|
858
|
+
*/
|
|
859
|
+
VersionNumber?: number;
|
|
860
|
+
/**
|
|
861
|
+
* <p>The alias of the template that you want to describe. If you name a specific alias, you
|
|
862
|
+
* describe the version that the alias points to. You can specify the latest version of the
|
|
863
|
+
* template by providing the keyword <code>$LATEST</code> in the <code>AliasName</code>
|
|
864
|
+
* parameter. The keyword <code>$PUBLISHED</code> doesn't apply to templates.</p>
|
|
865
|
+
*/
|
|
866
|
+
AliasName?: string;
|
|
867
|
+
}
|
|
868
|
+
/**
|
|
869
|
+
* @public
|
|
870
|
+
* @enum
|
|
871
|
+
*/
|
|
872
|
+
export declare const TemplateErrorType: {
|
|
873
|
+
readonly ACCESS_DENIED: "ACCESS_DENIED";
|
|
874
|
+
readonly DATA_SET_NOT_FOUND: "DATA_SET_NOT_FOUND";
|
|
875
|
+
readonly INTERNAL_FAILURE: "INTERNAL_FAILURE";
|
|
876
|
+
readonly SOURCE_NOT_FOUND: "SOURCE_NOT_FOUND";
|
|
877
|
+
};
|
|
878
|
+
/**
|
|
879
|
+
* @public
|
|
880
|
+
*/
|
|
881
|
+
export type TemplateErrorType = (typeof TemplateErrorType)[keyof typeof TemplateErrorType];
|
|
882
|
+
/**
|
|
883
|
+
* @public
|
|
884
|
+
* <p>List of errors that occurred when the template version creation failed.</p>
|
|
885
|
+
*/
|
|
886
|
+
export interface TemplateError {
|
|
887
|
+
/**
|
|
888
|
+
* <p>Type of error.</p>
|
|
889
|
+
*/
|
|
890
|
+
Type?: TemplateErrorType | string;
|
|
891
|
+
/**
|
|
892
|
+
* <p>Description of the error type.</p>
|
|
893
|
+
*/
|
|
894
|
+
Message?: string;
|
|
895
|
+
/**
|
|
896
|
+
* <p>An error path that shows which entities caused the template error.</p>
|
|
897
|
+
*/
|
|
898
|
+
ViolatedEntities?: Entity[];
|
|
899
|
+
}
|
|
900
|
+
/**
|
|
901
|
+
* @public
|
|
902
|
+
* <p>A version of a template.</p>
|
|
903
|
+
*/
|
|
904
|
+
export interface TemplateVersion {
|
|
905
|
+
/**
|
|
906
|
+
* <p>The time that this template version was created.</p>
|
|
907
|
+
*/
|
|
908
|
+
CreatedTime?: Date;
|
|
909
|
+
/**
|
|
910
|
+
* <p>Errors associated with this template version.</p>
|
|
911
|
+
*/
|
|
912
|
+
Errors?: TemplateError[];
|
|
913
|
+
/**
|
|
914
|
+
* <p>The version number of the template version.</p>
|
|
915
|
+
*/
|
|
916
|
+
VersionNumber?: number;
|
|
917
|
+
/**
|
|
918
|
+
* <p>The status that is associated with the template.</p>
|
|
919
|
+
* <ul>
|
|
920
|
+
* <li>
|
|
921
|
+
* <p>
|
|
922
|
+
* <code>CREATION_IN_PROGRESS</code>
|
|
923
|
+
* </p>
|
|
924
|
+
* </li>
|
|
925
|
+
* <li>
|
|
926
|
+
* <p>
|
|
927
|
+
* <code>CREATION_SUCCESSFUL</code>
|
|
928
|
+
* </p>
|
|
929
|
+
* </li>
|
|
930
|
+
* <li>
|
|
931
|
+
* <p>
|
|
932
|
+
* <code>CREATION_FAILED</code>
|
|
933
|
+
* </p>
|
|
934
|
+
* </li>
|
|
935
|
+
* <li>
|
|
936
|
+
* <p>
|
|
937
|
+
* <code>UPDATE_IN_PROGRESS</code>
|
|
938
|
+
* </p>
|
|
939
|
+
* </li>
|
|
940
|
+
* <li>
|
|
941
|
+
* <p>
|
|
942
|
+
* <code>UPDATE_SUCCESSFUL</code>
|
|
943
|
+
* </p>
|
|
944
|
+
* </li>
|
|
945
|
+
* <li>
|
|
946
|
+
* <p>
|
|
947
|
+
* <code>UPDATE_FAILED</code>
|
|
948
|
+
* </p>
|
|
949
|
+
* </li>
|
|
950
|
+
* <li>
|
|
951
|
+
* <p>
|
|
952
|
+
* <code>DELETED</code>
|
|
953
|
+
* </p>
|
|
954
|
+
* </li>
|
|
955
|
+
* </ul>
|
|
956
|
+
*/
|
|
957
|
+
Status?: ResourceStatus | string;
|
|
958
|
+
/**
|
|
959
|
+
* <p>Schema of the dataset identified by the placeholder. Any dashboard created from this
|
|
960
|
+
* template should be bound to new datasets matching the same schema described through this
|
|
961
|
+
* API operation.</p>
|
|
962
|
+
*/
|
|
963
|
+
DataSetConfigurations?: DataSetConfiguration[];
|
|
964
|
+
/**
|
|
965
|
+
* <p>The description of the template.</p>
|
|
966
|
+
*/
|
|
967
|
+
Description?: string;
|
|
968
|
+
/**
|
|
969
|
+
* <p>The Amazon Resource Name (ARN) of an analysis or template that was used to create this
|
|
970
|
+
* template.</p>
|
|
971
|
+
*/
|
|
972
|
+
SourceEntityArn?: string;
|
|
973
|
+
/**
|
|
974
|
+
* <p>The ARN of the theme associated with this version of the template.</p>
|
|
975
|
+
*/
|
|
976
|
+
ThemeArn?: string;
|
|
977
|
+
/**
|
|
978
|
+
* <p>A list of the associated sheets with the unique identifier and name of each sheet.</p>
|
|
979
|
+
*/
|
|
980
|
+
Sheets?: Sheet[];
|
|
981
|
+
}
|
|
982
|
+
/**
|
|
983
|
+
* @public
|
|
984
|
+
* <p>A template object. A <i>template</i> is an entity in Amazon QuickSight that
|
|
985
|
+
* encapsulates the metadata required to create an analysis and that you can use to create
|
|
986
|
+
* a dashboard. A template adds a layer of abstraction by using placeholders to replace the
|
|
987
|
+
* dataset associated with an analysis. You can use templates to create dashboards by
|
|
988
|
+
* replacing dataset placeholders with datasets that follow the same schema that was used
|
|
989
|
+
* to create the source analysis and template.</p>
|
|
990
|
+
* <p>You can share templates across Amazon Web Services accounts by allowing users in other Amazon Web Services accounts to
|
|
991
|
+
* create a template or a dashboard from an existing template.</p>
|
|
992
|
+
*/
|
|
993
|
+
export interface Template {
|
|
994
|
+
/**
|
|
995
|
+
* <p>The Amazon Resource Name (ARN) of the template.</p>
|
|
996
|
+
*/
|
|
997
|
+
Arn?: string;
|
|
998
|
+
/**
|
|
999
|
+
* <p>The display name of the template.</p>
|
|
1000
|
+
*/
|
|
1001
|
+
Name?: string;
|
|
1002
|
+
/**
|
|
1003
|
+
* <p>A structure describing the versions of the template.</p>
|
|
1004
|
+
*/
|
|
1005
|
+
Version?: TemplateVersion;
|
|
1006
|
+
/**
|
|
1007
|
+
* <p>The ID for the template. This is unique per Amazon Web Services Region for each Amazon Web Services account.</p>
|
|
1008
|
+
*/
|
|
1009
|
+
TemplateId?: string;
|
|
1010
|
+
/**
|
|
1011
|
+
* <p>Time when this was last updated.</p>
|
|
1012
|
+
*/
|
|
1013
|
+
LastUpdatedTime?: Date;
|
|
1014
|
+
/**
|
|
1015
|
+
* <p>Time when this was created.</p>
|
|
1016
|
+
*/
|
|
1017
|
+
CreatedTime?: Date;
|
|
1018
|
+
}
|
|
1019
|
+
/**
|
|
1020
|
+
* @public
|
|
1021
|
+
*/
|
|
1022
|
+
export interface DescribeTemplateResponse {
|
|
1023
|
+
/**
|
|
1024
|
+
* <p>The template structure for the object you want to describe.</p>
|
|
1025
|
+
*/
|
|
1026
|
+
Template?: Template;
|
|
1027
|
+
/**
|
|
1028
|
+
* <p>The HTTP status of the request.</p>
|
|
1029
|
+
*/
|
|
1030
|
+
Status?: number;
|
|
1031
|
+
/**
|
|
1032
|
+
* <p>The Amazon Web Services request ID for this operation.</p>
|
|
1033
|
+
*/
|
|
1034
|
+
RequestId?: string;
|
|
1035
|
+
}
|
|
1036
|
+
/**
|
|
1037
|
+
* @public
|
|
1038
|
+
*/
|
|
1039
|
+
export interface DescribeTemplateAliasRequest {
|
|
1040
|
+
/**
|
|
1041
|
+
* <p>The ID of the Amazon Web Services account that contains the template alias that you're
|
|
1042
|
+
* describing.</p>
|
|
1043
|
+
*/
|
|
1044
|
+
AwsAccountId: string | undefined;
|
|
1045
|
+
/**
|
|
1046
|
+
* <p>The ID for the template.</p>
|
|
1047
|
+
*/
|
|
1048
|
+
TemplateId: string | undefined;
|
|
1049
|
+
/**
|
|
1050
|
+
* <p>The name of the template alias that you want to describe. If you name a specific alias, you
|
|
1051
|
+
* describe the version that the alias points to. You can specify the latest version of the
|
|
1052
|
+
* template by providing the keyword <code>$LATEST</code> in the <code>AliasName</code>
|
|
1053
|
+
* parameter. The keyword <code>$PUBLISHED</code> doesn't apply to templates.</p>
|
|
1054
|
+
*/
|
|
1055
|
+
AliasName: string | undefined;
|
|
1056
|
+
}
|
|
1057
|
+
/**
|
|
1058
|
+
* @public
|
|
1059
|
+
*/
|
|
1060
|
+
export interface DescribeTemplateAliasResponse {
|
|
1061
|
+
/**
|
|
1062
|
+
* <p>Information about the template alias.</p>
|
|
1063
|
+
*/
|
|
1064
|
+
TemplateAlias?: TemplateAlias;
|
|
1065
|
+
/**
|
|
1066
|
+
* <p>The HTTP status of the request.</p>
|
|
1067
|
+
*/
|
|
1068
|
+
Status?: number;
|
|
1069
|
+
/**
|
|
1070
|
+
* <p>The Amazon Web Services request ID for this operation.</p>
|
|
1071
|
+
*/
|
|
1072
|
+
RequestId?: string;
|
|
1073
|
+
}
|
|
1074
|
+
/**
|
|
1075
|
+
* @public
|
|
1076
|
+
*/
|
|
1077
|
+
export interface DescribeTemplateDefinitionRequest {
|
|
1078
|
+
/**
|
|
1079
|
+
* <p>The ID of the Amazon Web Services account that contains the template. You must be using the
|
|
1080
|
+
* Amazon Web Services account that the template is in.</p>
|
|
1081
|
+
*/
|
|
1082
|
+
AwsAccountId: string | undefined;
|
|
1083
|
+
/**
|
|
1084
|
+
* <p>The ID of the template that you're describing.</p>
|
|
1085
|
+
*/
|
|
1086
|
+
TemplateId: string | undefined;
|
|
1087
|
+
/**
|
|
1088
|
+
* <p>The version number of the template.</p>
|
|
1089
|
+
*/
|
|
1090
|
+
VersionNumber?: number;
|
|
1091
|
+
/**
|
|
1092
|
+
* <p>The alias of the template that you want to describe. If you name a specific alias, you
|
|
1093
|
+
* describe the version that the alias points to. You can specify the latest version of the
|
|
1094
|
+
* template by providing the keyword <code>$LATEST</code> in the <code>AliasName</code>
|
|
1095
|
+
* parameter. The keyword <code>$PUBLISHED</code> doesn't apply to templates.</p>
|
|
1096
|
+
*/
|
|
1097
|
+
AliasName?: string;
|
|
1098
|
+
}
|
|
1099
|
+
/**
|
|
1100
|
+
* @public
|
|
1101
|
+
*/
|
|
1102
|
+
export interface DescribeTemplateDefinitionResponse {
|
|
1103
|
+
/**
|
|
1104
|
+
* <p>The descriptive name of the template.</p>
|
|
1105
|
+
*/
|
|
1106
|
+
Name?: string;
|
|
1107
|
+
/**
|
|
1108
|
+
* <p>The ID of the template described.</p>
|
|
1109
|
+
*/
|
|
1110
|
+
TemplateId?: string;
|
|
1111
|
+
/**
|
|
1112
|
+
* <p>Errors associated with the template version.</p>
|
|
1113
|
+
*/
|
|
1114
|
+
Errors?: TemplateError[];
|
|
1115
|
+
/**
|
|
1116
|
+
* <p>Status associated with the template.</p>
|
|
1117
|
+
* <ul>
|
|
1118
|
+
* <li>
|
|
1119
|
+
* <p>
|
|
1120
|
+
* <code>CREATION_IN_PROGRESS</code>
|
|
1121
|
+
* </p>
|
|
1122
|
+
* </li>
|
|
1123
|
+
* <li>
|
|
1124
|
+
* <p>
|
|
1125
|
+
* <code>CREATION_SUCCESSFUL</code>
|
|
1126
|
+
* </p>
|
|
1127
|
+
* </li>
|
|
1128
|
+
* <li>
|
|
1129
|
+
* <p>
|
|
1130
|
+
* <code>CREATION_FAILED</code>
|
|
1131
|
+
* </p>
|
|
1132
|
+
* </li>
|
|
1133
|
+
* <li>
|
|
1134
|
+
* <p>
|
|
1135
|
+
* <code>UPDATE_IN_PROGRESS</code>
|
|
1136
|
+
* </p>
|
|
1137
|
+
* </li>
|
|
1138
|
+
* <li>
|
|
1139
|
+
* <p>
|
|
1140
|
+
* <code>UPDATE_SUCCESSFUL</code>
|
|
1141
|
+
* </p>
|
|
1142
|
+
* </li>
|
|
1143
|
+
* <li>
|
|
1144
|
+
* <p>
|
|
1145
|
+
* <code>UPDATE_FAILED</code>
|
|
1146
|
+
* </p>
|
|
1147
|
+
* </li>
|
|
1148
|
+
* <li>
|
|
1149
|
+
* <p>
|
|
1150
|
+
* <code>DELETED</code>
|
|
1151
|
+
* </p>
|
|
1152
|
+
* </li>
|
|
1153
|
+
* </ul>
|
|
1154
|
+
*/
|
|
1155
|
+
ResourceStatus?: ResourceStatus | string;
|
|
1156
|
+
/**
|
|
1157
|
+
* <p>The ARN of the theme of the template.</p>
|
|
1158
|
+
*/
|
|
1159
|
+
ThemeArn?: string;
|
|
1160
|
+
/**
|
|
1161
|
+
* <p>The definition of the template.</p>
|
|
1162
|
+
* <p>A definition is the data model of all features in a Dashboard, Template, or Analysis.</p>
|
|
1163
|
+
*/
|
|
1164
|
+
Definition?: TemplateVersionDefinition;
|
|
1165
|
+
/**
|
|
1166
|
+
* <p>The HTTP status of the request.</p>
|
|
1167
|
+
*/
|
|
1168
|
+
Status?: number;
|
|
1169
|
+
/**
|
|
1170
|
+
* <p>The Amazon Web Services request ID for this operation.</p>
|
|
1171
|
+
*/
|
|
1172
|
+
RequestId?: string;
|
|
1173
|
+
}
|
|
1174
|
+
/**
|
|
1175
|
+
* @public
|
|
1176
|
+
*/
|
|
1177
|
+
export interface DescribeTemplatePermissionsRequest {
|
|
1178
|
+
/**
|
|
1179
|
+
* <p>The ID of the Amazon Web Services account that contains the template that you're describing.</p>
|
|
1180
|
+
*/
|
|
1181
|
+
AwsAccountId: string | undefined;
|
|
1182
|
+
/**
|
|
1183
|
+
* <p>The ID for the template.</p>
|
|
1184
|
+
*/
|
|
1185
|
+
TemplateId: string | undefined;
|
|
1186
|
+
}
|
|
1187
|
+
/**
|
|
1188
|
+
* @public
|
|
1189
|
+
*/
|
|
1190
|
+
export interface DescribeTemplatePermissionsResponse {
|
|
1191
|
+
/**
|
|
1192
|
+
* <p>The ID for the template.</p>
|
|
1193
|
+
*/
|
|
1194
|
+
TemplateId?: string;
|
|
1195
|
+
/**
|
|
1196
|
+
* <p>The Amazon Resource Name (ARN) of the template.</p>
|
|
1197
|
+
*/
|
|
1198
|
+
TemplateArn?: string;
|
|
1199
|
+
/**
|
|
1200
|
+
* <p>A list of resource permissions to be set on the template. </p>
|
|
1201
|
+
*/
|
|
1202
|
+
Permissions?: ResourcePermission[];
|
|
1203
|
+
/**
|
|
1204
|
+
* <p>The Amazon Web Services request ID for this operation.</p>
|
|
1205
|
+
*/
|
|
1206
|
+
RequestId?: string;
|
|
1207
|
+
/**
|
|
1208
|
+
* <p>The HTTP status of the request.</p>
|
|
1209
|
+
*/
|
|
1210
|
+
Status?: number;
|
|
1211
|
+
}
|
|
1212
|
+
/**
|
|
1213
|
+
* @public
|
|
1214
|
+
*/
|
|
1215
|
+
export interface DescribeThemeRequest {
|
|
1216
|
+
/**
|
|
1217
|
+
* <p>The ID of the Amazon Web Services account that contains the theme that you're describing.</p>
|
|
1218
|
+
*/
|
|
1219
|
+
AwsAccountId: string | undefined;
|
|
1220
|
+
/**
|
|
1221
|
+
* <p>The ID for the theme.</p>
|
|
1222
|
+
*/
|
|
1223
|
+
ThemeId: string | undefined;
|
|
1224
|
+
/**
|
|
1225
|
+
* <p>The version number for the version to describe. If a <code>VersionNumber</code> parameter
|
|
1226
|
+
* value isn't provided, the latest version of the theme is described.</p>
|
|
1227
|
+
*/
|
|
1228
|
+
VersionNumber?: number;
|
|
1229
|
+
/**
|
|
1230
|
+
* <p>The alias of the theme that you want to describe. If you name a specific alias, you
|
|
1231
|
+
* describe the version that the alias points to. You can specify the latest version of the
|
|
1232
|
+
* theme by providing the keyword <code>$LATEST</code> in the <code>AliasName</code>
|
|
1233
|
+
* parameter. The keyword <code>$PUBLISHED</code> doesn't apply to themes.</p>
|
|
1234
|
+
*/
|
|
1235
|
+
AliasName?: string;
|
|
1236
|
+
}
|
|
1237
|
+
/**
|
|
1238
|
+
* @public
|
|
1239
|
+
* @enum
|
|
1240
|
+
*/
|
|
1241
|
+
export declare const ThemeType: {
|
|
1242
|
+
readonly ALL: "ALL";
|
|
1243
|
+
readonly CUSTOM: "CUSTOM";
|
|
1244
|
+
readonly QUICKSIGHT: "QUICKSIGHT";
|
|
1245
|
+
};
|
|
1246
|
+
/**
|
|
1247
|
+
* @public
|
|
1248
|
+
*/
|
|
1249
|
+
export type ThemeType = (typeof ThemeType)[keyof typeof ThemeType];
|
|
1250
|
+
/**
|
|
1251
|
+
* @public
|
|
1252
|
+
* @enum
|
|
1253
|
+
*/
|
|
1254
|
+
export declare const ThemeErrorType: {
|
|
1255
|
+
readonly INTERNAL_FAILURE: "INTERNAL_FAILURE";
|
|
1256
|
+
};
|
|
1257
|
+
/**
|
|
1258
|
+
* @public
|
|
1259
|
+
*/
|
|
1260
|
+
export type ThemeErrorType = (typeof ThemeErrorType)[keyof typeof ThemeErrorType];
|
|
1261
|
+
/**
|
|
1262
|
+
* @public
|
|
1263
|
+
* <p>Theme error.</p>
|
|
1264
|
+
*/
|
|
1265
|
+
export interface ThemeError {
|
|
1266
|
+
/**
|
|
1267
|
+
* <p>The type of error.</p>
|
|
1268
|
+
*/
|
|
1269
|
+
Type?: ThemeErrorType | string;
|
|
1270
|
+
/**
|
|
1271
|
+
* <p>The error message.</p>
|
|
1272
|
+
*/
|
|
1273
|
+
Message?: string;
|
|
1274
|
+
}
|
|
1275
|
+
/**
|
|
1276
|
+
* @public
|
|
1277
|
+
* <p>A version of a theme.</p>
|
|
1278
|
+
*/
|
|
1279
|
+
export interface ThemeVersion {
|
|
1280
|
+
/**
|
|
1281
|
+
* <p>The version number of the theme.</p>
|
|
1282
|
+
*/
|
|
1283
|
+
VersionNumber?: number;
|
|
1284
|
+
/**
|
|
1285
|
+
* <p>The Amazon Resource Name (ARN) of the resource.</p>
|
|
1286
|
+
*/
|
|
1287
|
+
Arn?: string;
|
|
1288
|
+
/**
|
|
1289
|
+
* <p>The description of the theme.</p>
|
|
1290
|
+
*/
|
|
1291
|
+
Description?: string;
|
|
1292
|
+
/**
|
|
1293
|
+
* <p>The Amazon QuickSight-defined ID of the theme that a custom theme inherits from. All
|
|
1294
|
+
* themes initially inherit from a default Amazon QuickSight theme.</p>
|
|
1295
|
+
*/
|
|
1296
|
+
BaseThemeId?: string;
|
|
1297
|
+
/**
|
|
1298
|
+
* <p>The date and time that this theme version was created.</p>
|
|
1299
|
+
*/
|
|
1300
|
+
CreatedTime?: Date;
|
|
1301
|
+
/**
|
|
1302
|
+
* <p>The theme configuration, which contains all the theme display properties.</p>
|
|
1303
|
+
*/
|
|
1304
|
+
Configuration?: ThemeConfiguration;
|
|
1305
|
+
/**
|
|
1306
|
+
* <p>Errors associated with the theme.</p>
|
|
1307
|
+
*/
|
|
1308
|
+
Errors?: ThemeError[];
|
|
1309
|
+
/**
|
|
1310
|
+
* <p>The status of the theme version.</p>
|
|
1311
|
+
*/
|
|
1312
|
+
Status?: ResourceStatus | string;
|
|
1313
|
+
}
|
|
1314
|
+
/**
|
|
1315
|
+
* @public
|
|
1316
|
+
* <p>Summary information about a theme.</p>
|
|
1317
|
+
*/
|
|
1318
|
+
export interface Theme {
|
|
1319
|
+
/**
|
|
1320
|
+
* <p>The Amazon Resource Name (ARN) of the theme.</p>
|
|
1321
|
+
*/
|
|
1322
|
+
Arn?: string;
|
|
1323
|
+
/**
|
|
1324
|
+
* <p>The name that the user gives to the theme.</p>
|
|
1325
|
+
*/
|
|
1326
|
+
Name?: string;
|
|
1327
|
+
/**
|
|
1328
|
+
* <p>The identifier that the user gives to the theme.</p>
|
|
1329
|
+
*/
|
|
1330
|
+
ThemeId?: string;
|
|
1331
|
+
/**
|
|
1332
|
+
* <p>A version of a theme.</p>
|
|
1333
|
+
*/
|
|
1334
|
+
Version?: ThemeVersion;
|
|
1335
|
+
/**
|
|
1336
|
+
* <p>The date and time that the theme was created.</p>
|
|
1337
|
+
*/
|
|
1338
|
+
CreatedTime?: Date;
|
|
1339
|
+
/**
|
|
1340
|
+
* <p>The date and time that the theme was last updated.</p>
|
|
1341
|
+
*/
|
|
1342
|
+
LastUpdatedTime?: Date;
|
|
1343
|
+
/**
|
|
1344
|
+
* <p>The type of theme, based on how it was created. Valid values include:
|
|
1345
|
+
* <code>QUICKSIGHT</code> and <code>CUSTOM</code>.</p>
|
|
1346
|
+
*/
|
|
1347
|
+
Type?: ThemeType | string;
|
|
1348
|
+
}
|
|
1349
|
+
/**
|
|
1350
|
+
* @public
|
|
1351
|
+
*/
|
|
1352
|
+
export interface DescribeThemeResponse {
|
|
1353
|
+
/**
|
|
1354
|
+
* <p>The information about the theme that you are describing.</p>
|
|
1355
|
+
*/
|
|
1356
|
+
Theme?: Theme;
|
|
1357
|
+
/**
|
|
1358
|
+
* <p>The HTTP status of the request.</p>
|
|
1359
|
+
*/
|
|
1360
|
+
Status?: number;
|
|
1361
|
+
/**
|
|
1362
|
+
* <p>The Amazon Web Services request ID for this operation.</p>
|
|
1363
|
+
*/
|
|
1364
|
+
RequestId?: string;
|
|
1365
|
+
}
|
|
1366
|
+
/**
|
|
1367
|
+
* @public
|
|
1368
|
+
*/
|
|
1369
|
+
export interface DescribeThemeAliasRequest {
|
|
1370
|
+
/**
|
|
1371
|
+
* <p>The ID of the Amazon Web Services account that contains the theme alias that you're
|
|
1372
|
+
* describing.</p>
|
|
1373
|
+
*/
|
|
1374
|
+
AwsAccountId: string | undefined;
|
|
1375
|
+
/**
|
|
1376
|
+
* <p>The ID for the theme.</p>
|
|
1377
|
+
*/
|
|
1378
|
+
ThemeId: string | undefined;
|
|
1379
|
+
/**
|
|
1380
|
+
* <p>The name of the theme alias that you want to describe.</p>
|
|
1381
|
+
*/
|
|
1382
|
+
AliasName: string | undefined;
|
|
1383
|
+
}
|
|
1384
|
+
/**
|
|
1385
|
+
* @public
|
|
1386
|
+
*/
|
|
1387
|
+
export interface DescribeThemeAliasResponse {
|
|
1388
|
+
/**
|
|
1389
|
+
* <p>Information about the theme alias.</p>
|
|
1390
|
+
*/
|
|
1391
|
+
ThemeAlias?: ThemeAlias;
|
|
1392
|
+
/**
|
|
1393
|
+
* <p>The HTTP status of the request.</p>
|
|
1394
|
+
*/
|
|
1395
|
+
Status?: number;
|
|
1396
|
+
/**
|
|
1397
|
+
* <p>The Amazon Web Services request ID for this operation.</p>
|
|
1398
|
+
*/
|
|
1399
|
+
RequestId?: string;
|
|
1400
|
+
}
|
|
1401
|
+
/**
|
|
1402
|
+
* @public
|
|
1403
|
+
*/
|
|
1404
|
+
export interface DescribeThemePermissionsRequest {
|
|
1405
|
+
/**
|
|
1406
|
+
* <p>The ID of the Amazon Web Services account that contains the theme that you're describing.</p>
|
|
1407
|
+
*/
|
|
1408
|
+
AwsAccountId: string | undefined;
|
|
1409
|
+
/**
|
|
1410
|
+
* <p>The ID for the theme that you want to describe permissions for.</p>
|
|
1411
|
+
*/
|
|
1412
|
+
ThemeId: string | undefined;
|
|
1413
|
+
}
|
|
1414
|
+
/**
|
|
1415
|
+
* @public
|
|
1416
|
+
*/
|
|
1417
|
+
export interface DescribeThemePermissionsResponse {
|
|
1418
|
+
/**
|
|
1419
|
+
* <p>The ID for the theme.</p>
|
|
1420
|
+
*/
|
|
1421
|
+
ThemeId?: string;
|
|
1422
|
+
/**
|
|
1423
|
+
* <p>The Amazon Resource Name (ARN) of the theme.</p>
|
|
1424
|
+
*/
|
|
1425
|
+
ThemeArn?: string;
|
|
1426
|
+
/**
|
|
1427
|
+
* <p>A list of resource permissions set on the theme. </p>
|
|
1428
|
+
*/
|
|
1429
|
+
Permissions?: ResourcePermission[];
|
|
1430
|
+
/**
|
|
1431
|
+
* <p>The Amazon Web Services request ID for this operation.</p>
|
|
1432
|
+
*/
|
|
1433
|
+
RequestId?: string;
|
|
1434
|
+
/**
|
|
1435
|
+
* <p>The HTTP status of the request.</p>
|
|
1436
|
+
*/
|
|
1437
|
+
Status?: number;
|
|
1438
|
+
}
|
|
1439
|
+
/**
|
|
1440
|
+
* @public
|
|
1441
|
+
*/
|
|
1442
|
+
export interface DescribeTopicRequest {
|
|
1443
|
+
/**
|
|
1444
|
+
* <p>The Amazon Web Services account ID.</p>
|
|
1445
|
+
*/
|
|
1446
|
+
AwsAccountId: string | undefined;
|
|
1447
|
+
/**
|
|
1448
|
+
* <p>The ID of the topic that you want to describe. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.</p>
|
|
1449
|
+
*/
|
|
1450
|
+
TopicId: string | undefined;
|
|
1451
|
+
}
|
|
1452
|
+
/**
|
|
1453
|
+
* @public
|
|
1454
|
+
*/
|
|
1455
|
+
export interface DescribeTopicResponse {
|
|
1456
|
+
/**
|
|
1457
|
+
* <p>The Amazon Resource Name (ARN) of the topic.</p>
|
|
1458
|
+
*/
|
|
1459
|
+
Arn?: string;
|
|
1460
|
+
/**
|
|
1461
|
+
* <p>The ID of the topic that you want to describe. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.</p>
|
|
1462
|
+
*/
|
|
1463
|
+
TopicId?: string;
|
|
1464
|
+
/**
|
|
1465
|
+
* <p>The definition of a topic.</p>
|
|
1466
|
+
*/
|
|
1467
|
+
Topic?: TopicDetails;
|
|
1468
|
+
/**
|
|
1469
|
+
* <p>The Amazon Web Services request ID for this operation.</p>
|
|
1470
|
+
*/
|
|
1471
|
+
RequestId?: string;
|
|
1472
|
+
/**
|
|
1473
|
+
* <p>The HTTP status of the request.</p>
|
|
1474
|
+
*/
|
|
1475
|
+
Status?: number;
|
|
1476
|
+
}
|
|
1477
|
+
/**
|
|
1478
|
+
* @public
|
|
1479
|
+
*/
|
|
1480
|
+
export interface DescribeTopicPermissionsRequest {
|
|
1481
|
+
/**
|
|
1482
|
+
* <p>The ID of the Amazon Web Services account that contains the topic that you want
|
|
1483
|
+
* described.</p>
|
|
1484
|
+
*/
|
|
1485
|
+
AwsAccountId: string | undefined;
|
|
1486
|
+
/**
|
|
1487
|
+
* <p>The ID of the topic that you want to describe. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.</p>
|
|
1488
|
+
*/
|
|
1489
|
+
TopicId: string | undefined;
|
|
1490
|
+
}
|
|
1491
|
+
/**
|
|
1492
|
+
* @public
|
|
1493
|
+
*/
|
|
1494
|
+
export interface DescribeTopicPermissionsResponse {
|
|
1495
|
+
/**
|
|
1496
|
+
* <p>The ID of the topic that you want to describe. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.</p>
|
|
1497
|
+
*/
|
|
1498
|
+
TopicId?: string;
|
|
1499
|
+
/**
|
|
1500
|
+
* <p>The Amazon Resource Name (ARN) of the topic.</p>
|
|
1501
|
+
*/
|
|
1502
|
+
TopicArn?: string;
|
|
1503
|
+
/**
|
|
1504
|
+
* <p>A list of resource permissions that are configured to the topic.</p>
|
|
1505
|
+
*/
|
|
1506
|
+
Permissions?: ResourcePermission[];
|
|
1507
|
+
/**
|
|
1508
|
+
* <p>The HTTP status of the request.</p>
|
|
1509
|
+
*/
|
|
1510
|
+
Status?: number;
|
|
1511
|
+
/**
|
|
1512
|
+
* <p>The Amazon Web Services request ID for this operation.</p>
|
|
1513
|
+
*/
|
|
1514
|
+
RequestId?: string;
|
|
1515
|
+
}
|
|
1516
|
+
/**
|
|
1517
|
+
* @public
|
|
1518
|
+
*/
|
|
1519
|
+
export interface DescribeTopicRefreshRequest {
|
|
1520
|
+
/**
|
|
1521
|
+
* <p>The ID of the Amazon Web Services account that contains the topic whose refresh you want
|
|
1522
|
+
* to describe.</p>
|
|
1523
|
+
*/
|
|
1524
|
+
AwsAccountId: string | undefined;
|
|
1525
|
+
/**
|
|
1526
|
+
* <p>The ID of the topic that you want to describe. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.</p>
|
|
1527
|
+
*/
|
|
1528
|
+
TopicId: string | undefined;
|
|
1529
|
+
/**
|
|
1530
|
+
* <p>The ID of the refresh, which is performed when the topic is created or updated.</p>
|
|
1531
|
+
*/
|
|
1532
|
+
RefreshId: string | undefined;
|
|
1533
|
+
}
|
|
1534
|
+
/**
|
|
1535
|
+
* @public
|
|
1536
|
+
* @enum
|
|
1537
|
+
*/
|
|
1538
|
+
export declare const TopicRefreshStatus: {
|
|
1539
|
+
readonly CANCELLED: "CANCELLED";
|
|
1540
|
+
readonly COMPLETED: "COMPLETED";
|
|
1541
|
+
readonly FAILED: "FAILED";
|
|
1542
|
+
readonly INITIALIZED: "INITIALIZED";
|
|
1543
|
+
readonly RUNNING: "RUNNING";
|
|
1544
|
+
};
|
|
1545
|
+
/**
|
|
1546
|
+
* @public
|
|
1547
|
+
*/
|
|
1548
|
+
export type TopicRefreshStatus = (typeof TopicRefreshStatus)[keyof typeof TopicRefreshStatus];
|
|
1549
|
+
/**
|
|
1550
|
+
* @public
|
|
1551
|
+
* <p>The details about the refresh of a topic.</p>
|
|
1552
|
+
*/
|
|
1553
|
+
export interface TopicRefreshDetails {
|
|
1554
|
+
/**
|
|
1555
|
+
* <p>The Amazon Resource Name (ARN) of the topic refresh.</p>
|
|
1556
|
+
*/
|
|
1557
|
+
RefreshArn?: string;
|
|
1558
|
+
/**
|
|
1559
|
+
* <p>The ID of the refresh, which occurs as a result of topic creation or topic update.</p>
|
|
1560
|
+
*/
|
|
1561
|
+
RefreshId?: string;
|
|
1562
|
+
/**
|
|
1563
|
+
* <p>The status of the refresh job that indicates whether the job is still running, completed successfully, or failed.</p>
|
|
1564
|
+
*/
|
|
1565
|
+
RefreshStatus?: TopicRefreshStatus | string;
|
|
1566
|
+
}
|
|
1567
|
+
/**
|
|
1568
|
+
* @public
|
|
1569
|
+
*/
|
|
1570
|
+
export interface DescribeTopicRefreshResponse {
|
|
1571
|
+
/**
|
|
1572
|
+
* <p>Details of the refresh, which is performed when the topic is created or updated.</p>
|
|
1573
|
+
*/
|
|
1574
|
+
RefreshDetails?: TopicRefreshDetails;
|
|
1575
|
+
/**
|
|
1576
|
+
* <p>The Amazon Web Services request ID for this operation.</p>
|
|
1577
|
+
*/
|
|
1578
|
+
RequestId?: string;
|
|
1579
|
+
/**
|
|
1580
|
+
* <p>The HTTP status of the request.</p>
|
|
1581
|
+
*/
|
|
1582
|
+
Status?: number;
|
|
1583
|
+
}
|
|
1584
|
+
/**
|
|
1585
|
+
* @public
|
|
1586
|
+
*/
|
|
1587
|
+
export interface DescribeTopicRefreshScheduleRequest {
|
|
1588
|
+
/**
|
|
1589
|
+
* <p>The Amazon Web Services account ID.</p>
|
|
1590
|
+
*/
|
|
1591
|
+
AwsAccountId: string | undefined;
|
|
1592
|
+
/**
|
|
1593
|
+
* <p>The ID of the topic that contains the refresh schedule that you want to describe. This
|
|
1594
|
+
* ID is unique per Amazon Web Services Region for each Amazon Web Services account.</p>
|
|
1595
|
+
*/
|
|
1596
|
+
TopicId: string | undefined;
|
|
1597
|
+
/**
|
|
1598
|
+
* <p>The ID of the dataset.</p>
|
|
1599
|
+
*/
|
|
1600
|
+
DatasetId: string | undefined;
|
|
1601
|
+
}
|
|
1602
|
+
/**
|
|
1603
|
+
* @public
|
|
1604
|
+
*/
|
|
1605
|
+
export interface DescribeTopicRefreshScheduleResponse {
|
|
1606
|
+
/**
|
|
1607
|
+
* <p>The ID of the topic that contains the refresh schedule that you want to describe. This
|
|
1608
|
+
* ID is unique per Amazon Web Services Region for each Amazon Web Services account.</p>
|
|
1609
|
+
*/
|
|
1610
|
+
TopicId?: string;
|
|
1611
|
+
/**
|
|
1612
|
+
* <p>The Amazon Resource Name (ARN) of the topic.</p>
|
|
1613
|
+
*/
|
|
1614
|
+
TopicArn?: string;
|
|
1615
|
+
/**
|
|
1616
|
+
* <p>The Amazon Resource Name (ARN) of the dataset.</p>
|
|
1617
|
+
*/
|
|
1618
|
+
DatasetArn?: string;
|
|
1619
|
+
/**
|
|
1620
|
+
* <p>The definition of a refresh schedule.</p>
|
|
1621
|
+
*/
|
|
1622
|
+
RefreshSchedule?: TopicRefreshSchedule;
|
|
1623
|
+
/**
|
|
1624
|
+
* <p>The HTTP status of the request.</p>
|
|
1625
|
+
*/
|
|
1626
|
+
Status?: number;
|
|
1627
|
+
/**
|
|
1628
|
+
* <p>The Amazon Web Services request ID for this operation.</p>
|
|
1629
|
+
*/
|
|
1630
|
+
RequestId?: string;
|
|
1631
|
+
}
|
|
1632
|
+
/**
|
|
1633
|
+
* @public
|
|
1634
|
+
*/
|
|
1635
|
+
export interface DescribeUserRequest {
|
|
1636
|
+
/**
|
|
1637
|
+
* <p>The name of the user that you want to describe.</p>
|
|
1638
|
+
*/
|
|
1639
|
+
UserName: string | undefined;
|
|
1640
|
+
/**
|
|
1641
|
+
* <p>The ID for the Amazon Web Services account that the user is in. Currently, you use the ID for the
|
|
1642
|
+
* Amazon Web Services account that contains your Amazon QuickSight account.</p>
|
|
1643
|
+
*/
|
|
1644
|
+
AwsAccountId: string | undefined;
|
|
1645
|
+
/**
|
|
1646
|
+
* <p>The namespace. Currently, you should set this to <code>default</code>.</p>
|
|
1647
|
+
*/
|
|
1648
|
+
Namespace: string | undefined;
|
|
1649
|
+
}
|
|
1650
|
+
/**
|
|
1651
|
+
* @public
|
|
1652
|
+
* @enum
|
|
1653
|
+
*/
|
|
1654
|
+
export declare const IdentityType: {
|
|
1655
|
+
readonly IAM: "IAM";
|
|
1656
|
+
readonly QUICKSIGHT: "QUICKSIGHT";
|
|
1657
|
+
};
|
|
1658
|
+
/**
|
|
1659
|
+
* @public
|
|
1660
|
+
*/
|
|
1661
|
+
export type IdentityType = (typeof IdentityType)[keyof typeof IdentityType];
|
|
1662
|
+
/**
|
|
1663
|
+
* @public
|
|
1664
|
+
* @enum
|
|
1665
|
+
*/
|
|
1666
|
+
export declare const UserRole: {
|
|
1667
|
+
readonly ADMIN: "ADMIN";
|
|
1668
|
+
readonly AUTHOR: "AUTHOR";
|
|
1669
|
+
readonly READER: "READER";
|
|
1670
|
+
readonly RESTRICTED_AUTHOR: "RESTRICTED_AUTHOR";
|
|
1671
|
+
readonly RESTRICTED_READER: "RESTRICTED_READER";
|
|
1672
|
+
};
|
|
1673
|
+
/**
|
|
1674
|
+
* @public
|
|
1675
|
+
*/
|
|
1676
|
+
export type UserRole = (typeof UserRole)[keyof typeof UserRole];
|
|
1677
|
+
/**
|
|
1678
|
+
* @public
|
|
1679
|
+
* <p>A registered user of Amazon QuickSight. </p>
|
|
1680
|
+
*/
|
|
1681
|
+
export interface User {
|
|
1682
|
+
/**
|
|
1683
|
+
* <p>The Amazon Resource Name (ARN) for the user.</p>
|
|
1684
|
+
*/
|
|
1685
|
+
Arn?: string;
|
|
1686
|
+
/**
|
|
1687
|
+
* <p>The user's user name. This value is required if you are registering a user that will be managed in Amazon QuickSight. In the output, the value for <code>UserName</code> is
|
|
1688
|
+
* <code>N/A</code> when the value for <code>IdentityType</code> is <code>IAM</code>
|
|
1689
|
+
* and the corresponding IAM user is deleted.</p>
|
|
1690
|
+
*/
|
|
1691
|
+
UserName?: string;
|
|
1692
|
+
/**
|
|
1693
|
+
* <p>The user's email address.</p>
|
|
1694
|
+
*/
|
|
1695
|
+
Email?: string;
|
|
1696
|
+
/**
|
|
1697
|
+
* <p>The Amazon QuickSight role for the user. The user role can be one of the
|
|
1698
|
+
* following:.</p>
|
|
1699
|
+
* <ul>
|
|
1700
|
+
* <li>
|
|
1701
|
+
* <p>
|
|
1702
|
+
* <code>READER</code>: A user who has read-only access to dashboards.</p>
|
|
1703
|
+
* </li>
|
|
1704
|
+
* <li>
|
|
1705
|
+
* <p>
|
|
1706
|
+
* <code>AUTHOR</code>: A user who can create data sources, datasets, analyses,
|
|
1707
|
+
* and dashboards.</p>
|
|
1708
|
+
* </li>
|
|
1709
|
+
* <li>
|
|
1710
|
+
* <p>
|
|
1711
|
+
* <code>ADMIN</code>: A user who is an author, who can also manage Amazon
|
|
1712
|
+
* Amazon QuickSight settings.</p>
|
|
1713
|
+
* </li>
|
|
1714
|
+
* <li>
|
|
1715
|
+
* <p>
|
|
1716
|
+
* <code>RESTRICTED_READER</code>: This role isn't currently available for
|
|
1717
|
+
* use.</p>
|
|
1718
|
+
* </li>
|
|
1719
|
+
* <li>
|
|
1720
|
+
* <p>
|
|
1721
|
+
* <code>RESTRICTED_AUTHOR</code>: This role isn't currently available for
|
|
1722
|
+
* use.</p>
|
|
1723
|
+
* </li>
|
|
1724
|
+
* </ul>
|
|
1725
|
+
*/
|
|
1726
|
+
Role?: UserRole | string;
|
|
1727
|
+
/**
|
|
1728
|
+
* <p>The type of identity authentication used by the user.</p>
|
|
1729
|
+
*/
|
|
1730
|
+
IdentityType?: IdentityType | string;
|
|
1731
|
+
/**
|
|
1732
|
+
* <p>The active status of user. When you create an Amazon QuickSight user that's not an IAM user or an Active Directory user, that user is inactive until they sign in and provide a
|
|
1733
|
+
* password.</p>
|
|
1734
|
+
*/
|
|
1735
|
+
Active?: boolean;
|
|
1736
|
+
/**
|
|
1737
|
+
* <p>The principal ID of the user.</p>
|
|
1738
|
+
*/
|
|
1739
|
+
PrincipalId?: string;
|
|
1740
|
+
/**
|
|
1741
|
+
* <p>The custom permissions profile associated with this user.</p>
|
|
1742
|
+
*/
|
|
1743
|
+
CustomPermissionsName?: string;
|
|
1744
|
+
/**
|
|
1745
|
+
* <p>The type of supported external login provider that provides identity to let the user
|
|
1746
|
+
* federate into Amazon QuickSight with an associated IAM role. The type can be one of the following.</p>
|
|
1747
|
+
* <ul>
|
|
1748
|
+
* <li>
|
|
1749
|
+
* <p>
|
|
1750
|
+
* <code>COGNITO</code>: Amazon Cognito. The provider URL is cognito-identity.amazonaws.com.</p>
|
|
1751
|
+
* </li>
|
|
1752
|
+
* <li>
|
|
1753
|
+
* <p>
|
|
1754
|
+
* <code>CUSTOM_OIDC</code>: Custom OpenID Connect (OIDC) provider.</p>
|
|
1755
|
+
* </li>
|
|
1756
|
+
* </ul>
|
|
1757
|
+
*/
|
|
1758
|
+
ExternalLoginFederationProviderType?: string;
|
|
1759
|
+
/**
|
|
1760
|
+
* <p>The URL of the external login provider.</p>
|
|
1761
|
+
*/
|
|
1762
|
+
ExternalLoginFederationProviderUrl?: string;
|
|
1763
|
+
/**
|
|
1764
|
+
* <p>The identity ID for the user in the external login provider.</p>
|
|
1765
|
+
*/
|
|
1766
|
+
ExternalLoginId?: string;
|
|
1767
|
+
}
|
|
1768
|
+
/**
|
|
1769
|
+
* @public
|
|
1770
|
+
*/
|
|
1771
|
+
export interface DescribeUserResponse {
|
|
1772
|
+
/**
|
|
1773
|
+
* <p>The user name.</p>
|
|
1774
|
+
*/
|
|
1775
|
+
User?: User;
|
|
1776
|
+
/**
|
|
1777
|
+
* <p>The Amazon Web Services request ID for this operation.</p>
|
|
1778
|
+
*/
|
|
1779
|
+
RequestId?: string;
|
|
1780
|
+
/**
|
|
1781
|
+
* <p>The HTTP status of the request.</p>
|
|
1782
|
+
*/
|
|
1783
|
+
Status?: number;
|
|
1784
|
+
}
|
|
1785
|
+
/**
|
|
1786
|
+
* @public
|
|
1787
|
+
*/
|
|
1788
|
+
export interface DescribeVPCConnectionRequest {
|
|
1789
|
+
/**
|
|
1790
|
+
* <p>The Amazon Web Services account ID of the account that contains the VPC connection that
|
|
1791
|
+
* you want described.</p>
|
|
1792
|
+
*/
|
|
1793
|
+
AwsAccountId: string | undefined;
|
|
1794
|
+
/**
|
|
1795
|
+
* <p>The ID of the VPC connection that
|
|
1796
|
+
* you're creating. This ID is a unique identifier for each Amazon Web Services Region in an Amazon Web Services account.</p>
|
|
1797
|
+
*/
|
|
1798
|
+
VPCConnectionId: string | undefined;
|
|
1799
|
+
}
|
|
1800
|
+
/**
|
|
1801
|
+
* @public
|
|
1802
|
+
* @enum
|
|
1803
|
+
*/
|
|
1804
|
+
export declare const NetworkInterfaceStatus: {
|
|
1805
|
+
readonly ATTACHMENT_FAILED_ROLLBACK_FAILED: "ATTACHMENT_FAILED_ROLLBACK_FAILED";
|
|
1806
|
+
readonly AVAILABLE: "AVAILABLE";
|
|
1807
|
+
readonly CREATING: "CREATING";
|
|
1808
|
+
readonly CREATION_FAILED: "CREATION_FAILED";
|
|
1809
|
+
readonly DELETED: "DELETED";
|
|
1810
|
+
readonly DELETING: "DELETING";
|
|
1811
|
+
readonly DELETION_FAILED: "DELETION_FAILED";
|
|
1812
|
+
readonly DELETION_SCHEDULED: "DELETION_SCHEDULED";
|
|
1813
|
+
readonly UPDATE_FAILED: "UPDATE_FAILED";
|
|
1814
|
+
readonly UPDATING: "UPDATING";
|
|
1815
|
+
};
|
|
1816
|
+
/**
|
|
1817
|
+
* @public
|
|
1818
|
+
*/
|
|
1819
|
+
export type NetworkInterfaceStatus = (typeof NetworkInterfaceStatus)[keyof typeof NetworkInterfaceStatus];
|
|
1820
|
+
/**
|
|
1821
|
+
* @public
|
|
1822
|
+
* <p>The structure that contains information about a network interface.</p>
|
|
1823
|
+
*/
|
|
1824
|
+
export interface NetworkInterface {
|
|
1825
|
+
/**
|
|
1826
|
+
* <p>The subnet ID associated with the network interface.</p>
|
|
1827
|
+
*/
|
|
1828
|
+
SubnetId?: string;
|
|
1829
|
+
/**
|
|
1830
|
+
* <p>The availability zone that the network interface resides in.</p>
|
|
1831
|
+
*/
|
|
1832
|
+
AvailabilityZone?: string;
|
|
1833
|
+
/**
|
|
1834
|
+
* <p>An error message.</p>
|
|
1835
|
+
*/
|
|
1836
|
+
ErrorMessage?: string;
|
|
1837
|
+
/**
|
|
1838
|
+
* <p>The status of the network interface.</p>
|
|
1839
|
+
*/
|
|
1840
|
+
Status?: NetworkInterfaceStatus | string;
|
|
1841
|
+
/**
|
|
1842
|
+
* <p>The network interface ID.</p>
|
|
1843
|
+
*/
|
|
1844
|
+
NetworkInterfaceId?: string;
|
|
1845
|
+
}
|
|
1846
|
+
/**
|
|
1847
|
+
* @public
|
|
1848
|
+
* <p>The structure of a VPC connection.</p>
|
|
1849
|
+
*/
|
|
1850
|
+
export interface VPCConnection {
|
|
1851
|
+
/**
|
|
1852
|
+
* <p>The ID of the VPC connection that you're creating. This ID is a unique identifier for each Amazon Web Services Region in an
|
|
1853
|
+
* Amazon Web Services account.</p>
|
|
1854
|
+
*/
|
|
1855
|
+
VPCConnectionId?: string;
|
|
1856
|
+
/**
|
|
1857
|
+
* <p>The Amazon Resource Name (ARN) of the VPC connection.</p>
|
|
1858
|
+
*/
|
|
1859
|
+
Arn?: string;
|
|
1860
|
+
/**
|
|
1861
|
+
* <p>The display name for the VPC connection.</p>
|
|
1862
|
+
*/
|
|
1863
|
+
Name?: string;
|
|
1864
|
+
/**
|
|
1865
|
+
* <p>The Amazon EC2 VPC ID associated with the VPC connection.</p>
|
|
1866
|
+
*/
|
|
1867
|
+
VPCId?: string;
|
|
1868
|
+
/**
|
|
1869
|
+
* <p>The Amazon EC2 security group IDs associated with the VPC connection.</p>
|
|
1870
|
+
*/
|
|
1871
|
+
SecurityGroupIds?: string[];
|
|
1872
|
+
/**
|
|
1873
|
+
* <p>A list of IP addresses of DNS resolver endpoints for the VPC connection.</p>
|
|
1874
|
+
*/
|
|
1875
|
+
DnsResolvers?: string[];
|
|
1876
|
+
/**
|
|
1877
|
+
* <p>The status of the VPC connection.</p>
|
|
1878
|
+
*/
|
|
1879
|
+
Status?: VPCConnectionResourceStatus | string;
|
|
1880
|
+
/**
|
|
1881
|
+
* <p>The availability status of the VPC connection.</p>
|
|
1882
|
+
*/
|
|
1883
|
+
AvailabilityStatus?: VPCConnectionAvailabilityStatus | string;
|
|
1884
|
+
/**
|
|
1885
|
+
* <p>A list of network interfaces.</p>
|
|
1886
|
+
*/
|
|
1887
|
+
NetworkInterfaces?: NetworkInterface[];
|
|
1888
|
+
/**
|
|
1889
|
+
* <p>The ARN of the
|
|
1890
|
+
* IAM role associated with the VPC
|
|
1891
|
+
* connection.</p>
|
|
1892
|
+
*/
|
|
1893
|
+
RoleArn?: string;
|
|
1894
|
+
/**
|
|
1895
|
+
* <p>The time that the VPC connection was created.</p>
|
|
1896
|
+
*/
|
|
1897
|
+
CreatedTime?: Date;
|
|
1898
|
+
/**
|
|
1899
|
+
* <p>The time that the VPC connection was last updated.</p>
|
|
1900
|
+
*/
|
|
1901
|
+
LastUpdatedTime?: Date;
|
|
1902
|
+
}
|
|
1903
|
+
/**
|
|
1904
|
+
* @public
|
|
1905
|
+
*/
|
|
1906
|
+
export interface DescribeVPCConnectionResponse {
|
|
1907
|
+
/**
|
|
1908
|
+
* <p>A response object that provides information for the specified VPC connection.</p>
|
|
1909
|
+
*/
|
|
1910
|
+
VPCConnection?: VPCConnection;
|
|
1911
|
+
/**
|
|
1912
|
+
* <p>The Amazon Web Services request ID for this operation.</p>
|
|
1913
|
+
*/
|
|
1914
|
+
RequestId?: string;
|
|
1915
|
+
/**
|
|
1916
|
+
* <p>The HTTP status of the request.</p>
|
|
1917
|
+
*/
|
|
1918
|
+
Status?: number;
|
|
1919
|
+
}
|
|
1920
|
+
/**
|
|
1921
|
+
* @public
|
|
1922
|
+
* <p>The domain specified isn't on the allow list. All domains for embedded dashboards must be
|
|
1923
|
+
* added to the approved list by an Amazon QuickSight admin.</p>
|
|
1924
|
+
*/
|
|
1925
|
+
export declare class DomainNotWhitelistedException extends __BaseException {
|
|
1926
|
+
readonly name: "DomainNotWhitelistedException";
|
|
1927
|
+
readonly $fault: "client";
|
|
1928
|
+
Message?: string;
|
|
1929
|
+
/**
|
|
1930
|
+
* <p>The Amazon Web Services request ID for this request.</p>
|
|
1931
|
+
*/
|
|
1932
|
+
RequestId?: string;
|
|
1933
|
+
/**
|
|
1934
|
+
* @internal
|
|
1935
|
+
*/
|
|
1936
|
+
constructor(opts: __ExceptionOptionType<DomainNotWhitelistedException, __BaseException>);
|
|
1937
|
+
}
|
|
1938
|
+
/**
|
|
1939
|
+
* @public
|
|
1940
|
+
* @enum
|
|
1941
|
+
*/
|
|
1942
|
+
export declare const EmbeddingIdentityType: {
|
|
1943
|
+
readonly ANONYMOUS: "ANONYMOUS";
|
|
1944
|
+
readonly IAM: "IAM";
|
|
1945
|
+
readonly QUICKSIGHT: "QUICKSIGHT";
|
|
1946
|
+
};
|
|
1947
|
+
/**
|
|
1948
|
+
* @public
|
|
1949
|
+
*/
|
|
1950
|
+
export type EmbeddingIdentityType = (typeof EmbeddingIdentityType)[keyof typeof EmbeddingIdentityType];
|
|
1951
|
+
/**
|
|
1952
|
+
* @public
|
|
1953
|
+
* @enum
|
|
1954
|
+
*/
|
|
1955
|
+
export declare const FolderFilterAttribute: {
|
|
1956
|
+
readonly DIRECT_QUICKSIGHT_OWNER: "DIRECT_QUICKSIGHT_OWNER";
|
|
1957
|
+
readonly DIRECT_QUICKSIGHT_SOLE_OWNER: "DIRECT_QUICKSIGHT_SOLE_OWNER";
|
|
1958
|
+
readonly DIRECT_QUICKSIGHT_VIEWER_OR_OWNER: "DIRECT_QUICKSIGHT_VIEWER_OR_OWNER";
|
|
1959
|
+
readonly FOLDER_NAME: "FOLDER_NAME";
|
|
1960
|
+
readonly PARENT_FOLDER_ARN: "PARENT_FOLDER_ARN";
|
|
1961
|
+
readonly QUICKSIGHT_OWNER: "QUICKSIGHT_OWNER";
|
|
1962
|
+
readonly QUICKSIGHT_VIEWER_OR_OWNER: "QUICKSIGHT_VIEWER_OR_OWNER";
|
|
1963
|
+
};
|
|
1964
|
+
/**
|
|
1965
|
+
* @public
|
|
1966
|
+
*/
|
|
1967
|
+
export type FolderFilterAttribute = (typeof FolderFilterAttribute)[keyof typeof FolderFilterAttribute];
|
|
6
1968
|
/**
|
|
7
1969
|
* @public
|
|
8
1970
|
* <p>An object that consists of a member Amazon Resource Name (ARN) and a member ID.</p>
|
|
@@ -240,6 +2202,10 @@ export interface RegisteredUserDashboardFeatureConfigurations {
|
|
|
240
2202
|
* <p>The state persistence settings of an embedded dashboard.</p>
|
|
241
2203
|
*/
|
|
242
2204
|
StatePersistence?: StatePersistenceConfigurations;
|
|
2205
|
+
/**
|
|
2206
|
+
* <p>The bookmarks configuration for an embedded dashboard in Amazon QuickSight.</p>
|
|
2207
|
+
*/
|
|
2208
|
+
Bookmarks?: BookmarksConfigurations;
|
|
243
2209
|
}
|
|
244
2210
|
/**
|
|
245
2211
|
* @public
|
|
@@ -1111,7 +3077,8 @@ export interface ListGroupsResponse {
|
|
|
1111
3077
|
*/
|
|
1112
3078
|
export interface ListIAMPolicyAssignmentsRequest {
|
|
1113
3079
|
/**
|
|
1114
|
-
* <p>The ID of the Amazon Web Services account that contains these IAM policy
|
|
3080
|
+
* <p>The ID of the Amazon Web Services account that contains these IAM policy
|
|
3081
|
+
* assignments.</p>
|
|
1115
3082
|
*/
|
|
1116
3083
|
AwsAccountId: string | undefined;
|
|
1117
3084
|
/**
|
|
@@ -1627,13 +3594,142 @@ export interface ThemeSummary {
|
|
|
1627
3594
|
*/
|
|
1628
3595
|
export interface ListThemesResponse {
|
|
1629
3596
|
/**
|
|
1630
|
-
* <p>Information about the themes in the list.</p>
|
|
3597
|
+
* <p>Information about the themes in the list.</p>
|
|
3598
|
+
*/
|
|
3599
|
+
ThemeSummaryList?: ThemeSummary[];
|
|
3600
|
+
/**
|
|
3601
|
+
* <p>The token for the next set of results, or null if there are no more results.</p>
|
|
3602
|
+
*/
|
|
3603
|
+
NextToken?: string;
|
|
3604
|
+
/**
|
|
3605
|
+
* <p>The HTTP status of the request.</p>
|
|
3606
|
+
*/
|
|
3607
|
+
Status?: number;
|
|
3608
|
+
/**
|
|
3609
|
+
* <p>The Amazon Web Services request ID for this operation.</p>
|
|
3610
|
+
*/
|
|
3611
|
+
RequestId?: string;
|
|
3612
|
+
}
|
|
3613
|
+
/**
|
|
3614
|
+
* @public
|
|
3615
|
+
*/
|
|
3616
|
+
export interface ListThemeVersionsRequest {
|
|
3617
|
+
/**
|
|
3618
|
+
* <p>The ID of the Amazon Web Services account that contains the themes that you're listing.</p>
|
|
3619
|
+
*/
|
|
3620
|
+
AwsAccountId: string | undefined;
|
|
3621
|
+
/**
|
|
3622
|
+
* <p>The ID for the theme.</p>
|
|
3623
|
+
*/
|
|
3624
|
+
ThemeId: string | undefined;
|
|
3625
|
+
/**
|
|
3626
|
+
* <p>The token for the next set of results, or null if there are no more results.</p>
|
|
3627
|
+
*/
|
|
3628
|
+
NextToken?: string;
|
|
3629
|
+
/**
|
|
3630
|
+
* <p>The maximum number of results to be returned per request.</p>
|
|
3631
|
+
*/
|
|
3632
|
+
MaxResults?: number;
|
|
3633
|
+
}
|
|
3634
|
+
/**
|
|
3635
|
+
* @public
|
|
3636
|
+
* <p>The theme version.</p>
|
|
3637
|
+
*/
|
|
3638
|
+
export interface ThemeVersionSummary {
|
|
3639
|
+
/**
|
|
3640
|
+
* <p>The version number of the theme version.</p>
|
|
3641
|
+
*/
|
|
3642
|
+
VersionNumber?: number;
|
|
3643
|
+
/**
|
|
3644
|
+
* <p>The Amazon Resource Name (ARN) of the theme version.</p>
|
|
3645
|
+
*/
|
|
3646
|
+
Arn?: string;
|
|
3647
|
+
/**
|
|
3648
|
+
* <p>The description of the theme version.</p>
|
|
3649
|
+
*/
|
|
3650
|
+
Description?: string;
|
|
3651
|
+
/**
|
|
3652
|
+
* <p>The date and time that this theme version was created.</p>
|
|
3653
|
+
*/
|
|
3654
|
+
CreatedTime?: Date;
|
|
3655
|
+
/**
|
|
3656
|
+
* <p>The status of the theme version.</p>
|
|
3657
|
+
*/
|
|
3658
|
+
Status?: ResourceStatus | string;
|
|
3659
|
+
}
|
|
3660
|
+
/**
|
|
3661
|
+
* @public
|
|
3662
|
+
*/
|
|
3663
|
+
export interface ListThemeVersionsResponse {
|
|
3664
|
+
/**
|
|
3665
|
+
* <p>A structure containing a list of all the versions of the specified theme.</p>
|
|
3666
|
+
*/
|
|
3667
|
+
ThemeVersionSummaryList?: ThemeVersionSummary[];
|
|
3668
|
+
/**
|
|
3669
|
+
* <p>The token for the next set of results, or null if there are no more results.</p>
|
|
3670
|
+
*/
|
|
3671
|
+
NextToken?: string;
|
|
3672
|
+
/**
|
|
3673
|
+
* <p>The HTTP status of the request.</p>
|
|
3674
|
+
*/
|
|
3675
|
+
Status?: number;
|
|
3676
|
+
/**
|
|
3677
|
+
* <p>The Amazon Web Services request ID for this operation.</p>
|
|
3678
|
+
*/
|
|
3679
|
+
RequestId?: string;
|
|
3680
|
+
}
|
|
3681
|
+
/**
|
|
3682
|
+
* @public
|
|
3683
|
+
*/
|
|
3684
|
+
export interface ListTopicRefreshSchedulesRequest {
|
|
3685
|
+
/**
|
|
3686
|
+
* <p>The ID of the Amazon Web Services account that contains the topic whose refresh schedule
|
|
3687
|
+
* you want described.</p>
|
|
3688
|
+
*/
|
|
3689
|
+
AwsAccountId: string | undefined;
|
|
3690
|
+
/**
|
|
3691
|
+
* <p>The ID for the topic that you want to describe. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.</p>
|
|
3692
|
+
*/
|
|
3693
|
+
TopicId: string | undefined;
|
|
3694
|
+
}
|
|
3695
|
+
/**
|
|
3696
|
+
* @public
|
|
3697
|
+
* <p>A summary of the refresh schedule details for a dataset.</p>
|
|
3698
|
+
*/
|
|
3699
|
+
export interface TopicRefreshScheduleSummary {
|
|
3700
|
+
/**
|
|
3701
|
+
* <p>The ID of the dataset.</p>
|
|
3702
|
+
*/
|
|
3703
|
+
DatasetId?: string;
|
|
3704
|
+
/**
|
|
3705
|
+
* <p>The Amazon Resource Name (ARN) of the dataset.</p>
|
|
3706
|
+
*/
|
|
3707
|
+
DatasetArn?: string;
|
|
3708
|
+
/**
|
|
3709
|
+
* <p>The name of the dataset.</p>
|
|
3710
|
+
*/
|
|
3711
|
+
DatasetName?: string;
|
|
3712
|
+
/**
|
|
3713
|
+
* <p>The definition of a refresh schedule.</p>
|
|
3714
|
+
*/
|
|
3715
|
+
RefreshSchedule?: TopicRefreshSchedule;
|
|
3716
|
+
}
|
|
3717
|
+
/**
|
|
3718
|
+
* @public
|
|
3719
|
+
*/
|
|
3720
|
+
export interface ListTopicRefreshSchedulesResponse {
|
|
3721
|
+
/**
|
|
3722
|
+
* <p>The ID for the topic that you want to describe. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.</p>
|
|
1631
3723
|
*/
|
|
1632
|
-
|
|
3724
|
+
TopicId?: string;
|
|
1633
3725
|
/**
|
|
1634
|
-
* <p>The
|
|
3726
|
+
* <p>The Amazon Resource Name (ARN) of the topic.</p>
|
|
1635
3727
|
*/
|
|
1636
|
-
|
|
3728
|
+
TopicArn?: string;
|
|
3729
|
+
/**
|
|
3730
|
+
* <p>The list of topic refresh schedules.</p>
|
|
3731
|
+
*/
|
|
3732
|
+
RefreshSchedules?: TopicRefreshScheduleSummary[];
|
|
1637
3733
|
/**
|
|
1638
3734
|
* <p>The HTTP status of the request.</p>
|
|
1639
3735
|
*/
|
|
@@ -1646,15 +3742,12 @@ export interface ListThemesResponse {
|
|
|
1646
3742
|
/**
|
|
1647
3743
|
* @public
|
|
1648
3744
|
*/
|
|
1649
|
-
export interface
|
|
3745
|
+
export interface ListTopicsRequest {
|
|
1650
3746
|
/**
|
|
1651
|
-
* <p>The ID of the Amazon Web Services account that contains the
|
|
3747
|
+
* <p>The ID of the Amazon Web Services account that contains the topics that you want to
|
|
3748
|
+
* list.</p>
|
|
1652
3749
|
*/
|
|
1653
3750
|
AwsAccountId: string | undefined;
|
|
1654
|
-
/**
|
|
1655
|
-
* <p>The ID for the theme.</p>
|
|
1656
|
-
*/
|
|
1657
|
-
ThemeId: string | undefined;
|
|
1658
3751
|
/**
|
|
1659
3752
|
* <p>The token for the next set of results, or null if there are no more results.</p>
|
|
1660
3753
|
*/
|
|
@@ -1666,50 +3759,42 @@ export interface ListThemeVersionsRequest {
|
|
|
1666
3759
|
}
|
|
1667
3760
|
/**
|
|
1668
3761
|
* @public
|
|
1669
|
-
* <p>
|
|
3762
|
+
* <p>A topic summary.</p>
|
|
1670
3763
|
*/
|
|
1671
|
-
export interface
|
|
1672
|
-
/**
|
|
1673
|
-
* <p>The version number of the theme version.</p>
|
|
1674
|
-
*/
|
|
1675
|
-
VersionNumber?: number;
|
|
3764
|
+
export interface TopicSummary {
|
|
1676
3765
|
/**
|
|
1677
|
-
* <p>The Amazon Resource Name (ARN) of the
|
|
3766
|
+
* <p>The Amazon Resource Name (ARN) of the topic.</p>
|
|
1678
3767
|
*/
|
|
1679
3768
|
Arn?: string;
|
|
1680
3769
|
/**
|
|
1681
|
-
* <p>The
|
|
1682
|
-
*/
|
|
1683
|
-
Description?: string;
|
|
1684
|
-
/**
|
|
1685
|
-
* <p>The date and time that this theme version was created.</p>
|
|
3770
|
+
* <p>The ID for the topic. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.</p>
|
|
1686
3771
|
*/
|
|
1687
|
-
|
|
3772
|
+
TopicId?: string;
|
|
1688
3773
|
/**
|
|
1689
|
-
* <p>The
|
|
3774
|
+
* <p>The name of the topic.</p>
|
|
1690
3775
|
*/
|
|
1691
|
-
|
|
3776
|
+
Name?: string;
|
|
1692
3777
|
}
|
|
1693
3778
|
/**
|
|
1694
3779
|
* @public
|
|
1695
3780
|
*/
|
|
1696
|
-
export interface
|
|
3781
|
+
export interface ListTopicsResponse {
|
|
1697
3782
|
/**
|
|
1698
|
-
* <p>A
|
|
3783
|
+
* <p>A list of topic summaries.</p>
|
|
1699
3784
|
*/
|
|
1700
|
-
|
|
3785
|
+
TopicsSummaries?: TopicSummary[];
|
|
1701
3786
|
/**
|
|
1702
3787
|
* <p>The token for the next set of results, or null if there are no more results.</p>
|
|
1703
3788
|
*/
|
|
1704
3789
|
NextToken?: string;
|
|
1705
|
-
/**
|
|
1706
|
-
* <p>The HTTP status of the request.</p>
|
|
1707
|
-
*/
|
|
1708
|
-
Status?: number;
|
|
1709
3790
|
/**
|
|
1710
3791
|
* <p>The Amazon Web Services request ID for this operation.</p>
|
|
1711
3792
|
*/
|
|
1712
3793
|
RequestId?: string;
|
|
3794
|
+
/**
|
|
3795
|
+
* <p>The HTTP status of the request.</p>
|
|
3796
|
+
*/
|
|
3797
|
+
Status?: number;
|
|
1713
3798
|
}
|
|
1714
3799
|
/**
|
|
1715
3800
|
* @public
|
|
@@ -1801,6 +3886,105 @@ export interface ListUsersResponse {
|
|
|
1801
3886
|
*/
|
|
1802
3887
|
Status?: number;
|
|
1803
3888
|
}
|
|
3889
|
+
/**
|
|
3890
|
+
* @public
|
|
3891
|
+
*/
|
|
3892
|
+
export interface ListVPCConnectionsRequest {
|
|
3893
|
+
/**
|
|
3894
|
+
* <p>The Amazon Web Services account ID of the account that contains the VPC connections
|
|
3895
|
+
* that you want to list.</p>
|
|
3896
|
+
*/
|
|
3897
|
+
AwsAccountId: string | undefined;
|
|
3898
|
+
/**
|
|
3899
|
+
* <p>The token for the next set of results, or null if there are no more results.</p>
|
|
3900
|
+
*/
|
|
3901
|
+
NextToken?: string;
|
|
3902
|
+
/**
|
|
3903
|
+
* <p>The maximum number of results to be returned per request.</p>
|
|
3904
|
+
*/
|
|
3905
|
+
MaxResults?: number;
|
|
3906
|
+
}
|
|
3907
|
+
/**
|
|
3908
|
+
* @public
|
|
3909
|
+
* <p>The summary metadata that describes a VPC connection.</p>
|
|
3910
|
+
*/
|
|
3911
|
+
export interface VPCConnectionSummary {
|
|
3912
|
+
/**
|
|
3913
|
+
* <p>The ID of the VPC connection that
|
|
3914
|
+
* you're
|
|
3915
|
+
* creating. This ID is a unique identifier for each Amazon Web Services Region in an
|
|
3916
|
+
* Amazon Web Services account.</p>
|
|
3917
|
+
*/
|
|
3918
|
+
VPCConnectionId?: string;
|
|
3919
|
+
/**
|
|
3920
|
+
* <p>The Amazon Resource Name (ARN) of the VPC connection.</p>
|
|
3921
|
+
*/
|
|
3922
|
+
Arn?: string;
|
|
3923
|
+
/**
|
|
3924
|
+
* <p>The display name for the VPC connection.</p>
|
|
3925
|
+
*/
|
|
3926
|
+
Name?: string;
|
|
3927
|
+
/**
|
|
3928
|
+
* <p>The Amazon EC2 VPC ID associated with the VPC connection.</p>
|
|
3929
|
+
*/
|
|
3930
|
+
VPCId?: string;
|
|
3931
|
+
/**
|
|
3932
|
+
* <p>The Amazon EC2 security group IDs associated with the VPC connection.</p>
|
|
3933
|
+
*/
|
|
3934
|
+
SecurityGroupIds?: string[];
|
|
3935
|
+
/**
|
|
3936
|
+
* <p>A list of IP addresses of DNS resolver endpoints for the VPC connection.</p>
|
|
3937
|
+
*/
|
|
3938
|
+
DnsResolvers?: string[];
|
|
3939
|
+
/**
|
|
3940
|
+
* <p>The status of the VPC connection.</p>
|
|
3941
|
+
*/
|
|
3942
|
+
Status?: VPCConnectionResourceStatus | string;
|
|
3943
|
+
/**
|
|
3944
|
+
* <p>The availability status of the VPC connection.</p>
|
|
3945
|
+
*/
|
|
3946
|
+
AvailabilityStatus?: VPCConnectionAvailabilityStatus | string;
|
|
3947
|
+
/**
|
|
3948
|
+
* <p>A list of network interfaces.</p>
|
|
3949
|
+
*/
|
|
3950
|
+
NetworkInterfaces?: NetworkInterface[];
|
|
3951
|
+
/**
|
|
3952
|
+
* <p>The ARN of the IAM role associated
|
|
3953
|
+
* with the VPC connection.</p>
|
|
3954
|
+
*/
|
|
3955
|
+
RoleArn?: string;
|
|
3956
|
+
/**
|
|
3957
|
+
* <p>The time that the VPC connection was created.</p>
|
|
3958
|
+
*/
|
|
3959
|
+
CreatedTime?: Date;
|
|
3960
|
+
/**
|
|
3961
|
+
* <p>The time that the VPC connection was last updated.</p>
|
|
3962
|
+
*/
|
|
3963
|
+
LastUpdatedTime?: Date;
|
|
3964
|
+
}
|
|
3965
|
+
/**
|
|
3966
|
+
* @public
|
|
3967
|
+
*/
|
|
3968
|
+
export interface ListVPCConnectionsResponse {
|
|
3969
|
+
/**
|
|
3970
|
+
* <p>A <code>VPCConnectionSummaries</code> object that returns a summary of VPC connection
|
|
3971
|
+
* objects.</p>
|
|
3972
|
+
*/
|
|
3973
|
+
VPCConnectionSummaries?: VPCConnectionSummary[];
|
|
3974
|
+
/**
|
|
3975
|
+
* <p>The token for the next set of results, or null if there are no more
|
|
3976
|
+
* results.</p>
|
|
3977
|
+
*/
|
|
3978
|
+
NextToken?: string;
|
|
3979
|
+
/**
|
|
3980
|
+
* <p>The Amazon Web Services request ID for this operation.</p>
|
|
3981
|
+
*/
|
|
3982
|
+
RequestId?: string;
|
|
3983
|
+
/**
|
|
3984
|
+
* <p>The HTTP status of the request.</p>
|
|
3985
|
+
*/
|
|
3986
|
+
Status?: number;
|
|
3987
|
+
}
|
|
1804
3988
|
/**
|
|
1805
3989
|
* @public
|
|
1806
3990
|
*/
|
|
@@ -2814,6 +4998,10 @@ export interface UpdateDataSetRequest {
|
|
|
2814
4998
|
* <p>The usage configuration to apply to child datasets that reference this dataset as a source.</p>
|
|
2815
4999
|
*/
|
|
2816
5000
|
DataSetUsageConfiguration?: DataSetUsageConfiguration;
|
|
5001
|
+
/**
|
|
5002
|
+
* <p>The parameter declarations of the dataset.</p>
|
|
5003
|
+
*/
|
|
5004
|
+
DatasetParameters?: DatasetParameter[];
|
|
2817
5005
|
}
|
|
2818
5006
|
/**
|
|
2819
5007
|
* @public
|
|
@@ -3121,11 +5309,15 @@ export interface UpdateGroupResponse {
|
|
|
3121
5309
|
*/
|
|
3122
5310
|
export interface UpdateIAMPolicyAssignmentRequest {
|
|
3123
5311
|
/**
|
|
3124
|
-
* <p>The ID of the Amazon Web Services account that contains the IAM policy
|
|
5312
|
+
* <p>The ID of the Amazon Web Services account that contains the IAM policy
|
|
5313
|
+
* assignment. </p>
|
|
3125
5314
|
*/
|
|
3126
5315
|
AwsAccountId: string | undefined;
|
|
3127
5316
|
/**
|
|
3128
|
-
* <p>The name of the assignment, also called a rule.
|
|
5317
|
+
* <p>The name of the assignment, also called a rule.
|
|
5318
|
+
* The
|
|
5319
|
+
* name must be unique within the
|
|
5320
|
+
* Amazon Web Services account.</p>
|
|
3129
5321
|
*/
|
|
3130
5322
|
AssignmentName: string | undefined;
|
|
3131
5323
|
/**
|
|
@@ -3137,28 +5329,30 @@ export interface UpdateIAMPolicyAssignmentRequest {
|
|
|
3137
5329
|
* <ul>
|
|
3138
5330
|
* <li>
|
|
3139
5331
|
* <p>
|
|
3140
|
-
* <code>ENABLED</code> - Anything specified in this assignment is used when
|
|
3141
|
-
*
|
|
5332
|
+
* <code>ENABLED</code> - Anything specified in this assignment is used when
|
|
5333
|
+
* creating the data source.</p>
|
|
3142
5334
|
* </li>
|
|
3143
5335
|
* <li>
|
|
3144
5336
|
* <p>
|
|
3145
|
-
* <code>DISABLED</code> - This assignment isn't used when creating the data
|
|
5337
|
+
* <code>DISABLED</code> - This assignment isn't used when creating the data
|
|
5338
|
+
* source.</p>
|
|
3146
5339
|
* </li>
|
|
3147
5340
|
* <li>
|
|
3148
5341
|
* <p>
|
|
3149
|
-
* <code>DRAFT</code> - This assignment is an unfinished draft and isn't used
|
|
3150
|
-
*
|
|
5342
|
+
* <code>DRAFT</code> - This assignment is an unfinished draft and isn't used
|
|
5343
|
+
* when creating the data source.</p>
|
|
3151
5344
|
* </li>
|
|
3152
5345
|
* </ul>
|
|
3153
5346
|
*/
|
|
3154
5347
|
AssignmentStatus?: AssignmentStatus | string;
|
|
3155
5348
|
/**
|
|
3156
|
-
* <p>The ARN for the IAM policy to apply to the Amazon QuickSight users and
|
|
3157
|
-
* specified in this assignment.</p>
|
|
5349
|
+
* <p>The ARN for the IAM policy to apply to the Amazon QuickSight users and
|
|
5350
|
+
* groups specified in this assignment.</p>
|
|
3158
5351
|
*/
|
|
3159
5352
|
PolicyArn?: string;
|
|
3160
5353
|
/**
|
|
3161
|
-
* <p>The Amazon QuickSight users, groups, or both that you want to assign the policy
|
|
5354
|
+
* <p>The Amazon QuickSight users, groups, or both that you want to assign the policy
|
|
5355
|
+
* to.</p>
|
|
3162
5356
|
*/
|
|
3163
5357
|
Identities?: Record<string, string[]>;
|
|
3164
5358
|
}
|
|
@@ -3175,12 +5369,13 @@ export interface UpdateIAMPolicyAssignmentResponse {
|
|
|
3175
5369
|
*/
|
|
3176
5370
|
AssignmentId?: string;
|
|
3177
5371
|
/**
|
|
3178
|
-
* <p>The ARN for the IAM policy applied to the Amazon QuickSight users and
|
|
3179
|
-
* assignment.</p>
|
|
5372
|
+
* <p>The ARN for the IAM policy applied to the Amazon QuickSight users and
|
|
5373
|
+
* groups specified in this assignment.</p>
|
|
3180
5374
|
*/
|
|
3181
5375
|
PolicyArn?: string;
|
|
3182
5376
|
/**
|
|
3183
|
-
* <p>The Amazon QuickSight users, groups, or both that the IAM policy is
|
|
5377
|
+
* <p>The Amazon QuickSight users, groups, or both that the IAM policy is
|
|
5378
|
+
* assigned to.</p>
|
|
3184
5379
|
*/
|
|
3185
5380
|
Identities?: Record<string, string[]>;
|
|
3186
5381
|
/**
|
|
@@ -3188,17 +5383,18 @@ export interface UpdateIAMPolicyAssignmentResponse {
|
|
|
3188
5383
|
* <ul>
|
|
3189
5384
|
* <li>
|
|
3190
5385
|
* <p>
|
|
3191
|
-
* <code>ENABLED</code> - Anything specified in this assignment is used when
|
|
3192
|
-
*
|
|
5386
|
+
* <code>ENABLED</code> - Anything specified in this assignment is used when
|
|
5387
|
+
* creating the data source.</p>
|
|
3193
5388
|
* </li>
|
|
3194
5389
|
* <li>
|
|
3195
5390
|
* <p>
|
|
3196
|
-
* <code>DISABLED</code> - This assignment isn't used when creating the data
|
|
5391
|
+
* <code>DISABLED</code> - This assignment isn't used when creating the data
|
|
5392
|
+
* source.</p>
|
|
3197
5393
|
* </li>
|
|
3198
5394
|
* <li>
|
|
3199
5395
|
* <p>
|
|
3200
|
-
* <code>DRAFT</code> - This assignment is an unfinished draft and isn't used
|
|
3201
|
-
*
|
|
5396
|
+
* <code>DRAFT</code> - This assignment is an unfinished draft and isn't used
|
|
5397
|
+
* when creating the data source.</p>
|
|
3202
5398
|
* </li>
|
|
3203
5399
|
* </ul>
|
|
3204
5400
|
*/
|
|
@@ -3613,6 +5809,143 @@ export interface UpdateThemePermissionsResponse {
|
|
|
3613
5809
|
*/
|
|
3614
5810
|
Status?: number;
|
|
3615
5811
|
}
|
|
5812
|
+
/**
|
|
5813
|
+
* @public
|
|
5814
|
+
*/
|
|
5815
|
+
export interface UpdateTopicRequest {
|
|
5816
|
+
/**
|
|
5817
|
+
* <p>The ID of the Amazon Web Services account that contains the topic that you want to
|
|
5818
|
+
* update.</p>
|
|
5819
|
+
*/
|
|
5820
|
+
AwsAccountId: string | undefined;
|
|
5821
|
+
/**
|
|
5822
|
+
* <p>The ID of the topic that you want to modify. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.</p>
|
|
5823
|
+
*/
|
|
5824
|
+
TopicId: string | undefined;
|
|
5825
|
+
/**
|
|
5826
|
+
* <p>The definition of the topic that you want to update.</p>
|
|
5827
|
+
*/
|
|
5828
|
+
Topic: TopicDetails | undefined;
|
|
5829
|
+
}
|
|
5830
|
+
/**
|
|
5831
|
+
* @public
|
|
5832
|
+
*/
|
|
5833
|
+
export interface UpdateTopicResponse {
|
|
5834
|
+
/**
|
|
5835
|
+
* <p>The ID of the topic that you want to modify. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.</p>
|
|
5836
|
+
*/
|
|
5837
|
+
TopicId?: string;
|
|
5838
|
+
/**
|
|
5839
|
+
* <p>The Amazon Resource Name (ARN) of the topic.</p>
|
|
5840
|
+
*/
|
|
5841
|
+
Arn?: string;
|
|
5842
|
+
/**
|
|
5843
|
+
* <p>The Amazon Resource Name (ARN) of the topic refresh.</p>
|
|
5844
|
+
*/
|
|
5845
|
+
RefreshArn?: string;
|
|
5846
|
+
/**
|
|
5847
|
+
* <p>The Amazon Web Services request ID for this operation.</p>
|
|
5848
|
+
*/
|
|
5849
|
+
RequestId?: string;
|
|
5850
|
+
/**
|
|
5851
|
+
* <p>The HTTP status of the request.</p>
|
|
5852
|
+
*/
|
|
5853
|
+
Status?: number;
|
|
5854
|
+
}
|
|
5855
|
+
/**
|
|
5856
|
+
* @public
|
|
5857
|
+
*/
|
|
5858
|
+
export interface UpdateTopicPermissionsRequest {
|
|
5859
|
+
/**
|
|
5860
|
+
* <p>The ID of the Amazon Web Services account that contains the topic that you want to update
|
|
5861
|
+
* the permissions for.</p>
|
|
5862
|
+
*/
|
|
5863
|
+
AwsAccountId: string | undefined;
|
|
5864
|
+
/**
|
|
5865
|
+
* <p>The ID of the topic that you want to modify. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.</p>
|
|
5866
|
+
*/
|
|
5867
|
+
TopicId: string | undefined;
|
|
5868
|
+
/**
|
|
5869
|
+
* <p>The resource permissions that you want to grant to the topic.</p>
|
|
5870
|
+
*/
|
|
5871
|
+
GrantPermissions?: ResourcePermission[];
|
|
5872
|
+
/**
|
|
5873
|
+
* <p>The resource permissions that you want to revoke from the topic.</p>
|
|
5874
|
+
*/
|
|
5875
|
+
RevokePermissions?: ResourcePermission[];
|
|
5876
|
+
}
|
|
5877
|
+
/**
|
|
5878
|
+
* @public
|
|
5879
|
+
*/
|
|
5880
|
+
export interface UpdateTopicPermissionsResponse {
|
|
5881
|
+
/**
|
|
5882
|
+
* <p>The ID of the topic that you want to modify. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.</p>
|
|
5883
|
+
*/
|
|
5884
|
+
TopicId?: string;
|
|
5885
|
+
/**
|
|
5886
|
+
* <p>The Amazon Resource Name (ARN) of the topic.</p>
|
|
5887
|
+
*/
|
|
5888
|
+
TopicArn?: string;
|
|
5889
|
+
/**
|
|
5890
|
+
* <p>A list of resource permissions on the topic.</p>
|
|
5891
|
+
*/
|
|
5892
|
+
Permissions?: ResourcePermission[];
|
|
5893
|
+
/**
|
|
5894
|
+
* <p>The HTTP status of the request.</p>
|
|
5895
|
+
*/
|
|
5896
|
+
Status?: number;
|
|
5897
|
+
/**
|
|
5898
|
+
* <p>The Amazon Web Services request ID for this operation.</p>
|
|
5899
|
+
*/
|
|
5900
|
+
RequestId?: string;
|
|
5901
|
+
}
|
|
5902
|
+
/**
|
|
5903
|
+
* @public
|
|
5904
|
+
*/
|
|
5905
|
+
export interface UpdateTopicRefreshScheduleRequest {
|
|
5906
|
+
/**
|
|
5907
|
+
* <p>The ID of the Amazon Web Services account that contains the topic whose refresh schedule
|
|
5908
|
+
* you want to update.</p>
|
|
5909
|
+
*/
|
|
5910
|
+
AwsAccountId: string | undefined;
|
|
5911
|
+
/**
|
|
5912
|
+
* <p>The ID of the topic that you want to modify. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.</p>
|
|
5913
|
+
*/
|
|
5914
|
+
TopicId: string | undefined;
|
|
5915
|
+
/**
|
|
5916
|
+
* <p>The ID of the dataset.</p>
|
|
5917
|
+
*/
|
|
5918
|
+
DatasetId: string | undefined;
|
|
5919
|
+
/**
|
|
5920
|
+
* <p>The definition of a refresh schedule.</p>
|
|
5921
|
+
*/
|
|
5922
|
+
RefreshSchedule: TopicRefreshSchedule | undefined;
|
|
5923
|
+
}
|
|
5924
|
+
/**
|
|
5925
|
+
* @public
|
|
5926
|
+
*/
|
|
5927
|
+
export interface UpdateTopicRefreshScheduleResponse {
|
|
5928
|
+
/**
|
|
5929
|
+
* <p>The ID of the topic that you want to modify. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.</p>
|
|
5930
|
+
*/
|
|
5931
|
+
TopicId?: string;
|
|
5932
|
+
/**
|
|
5933
|
+
* <p>The Amazon Resource Name (ARN) of the topic.</p>
|
|
5934
|
+
*/
|
|
5935
|
+
TopicArn?: string;
|
|
5936
|
+
/**
|
|
5937
|
+
* <p>The Amazon Resource Name (ARN) of the dataset.</p>
|
|
5938
|
+
*/
|
|
5939
|
+
DatasetArn?: string;
|
|
5940
|
+
/**
|
|
5941
|
+
* <p>The HTTP status of the request.</p>
|
|
5942
|
+
*/
|
|
5943
|
+
Status?: number;
|
|
5944
|
+
/**
|
|
5945
|
+
* <p>The Amazon Web Services request ID for this operation.</p>
|
|
5946
|
+
*/
|
|
5947
|
+
RequestId?: string;
|
|
5948
|
+
}
|
|
3616
5949
|
/**
|
|
3617
5950
|
* @public
|
|
3618
5951
|
*/
|
|
@@ -3742,6 +6075,83 @@ export interface UpdateUserResponse {
|
|
|
3742
6075
|
*/
|
|
3743
6076
|
Status?: number;
|
|
3744
6077
|
}
|
|
6078
|
+
/**
|
|
6079
|
+
* @public
|
|
6080
|
+
*/
|
|
6081
|
+
export interface UpdateVPCConnectionRequest {
|
|
6082
|
+
/**
|
|
6083
|
+
* <p>The Amazon Web Services account ID of the account that contains the VPC connection that
|
|
6084
|
+
* you want to update.</p>
|
|
6085
|
+
*/
|
|
6086
|
+
AwsAccountId: string | undefined;
|
|
6087
|
+
/**
|
|
6088
|
+
* <p>The ID of the VPC connection that
|
|
6089
|
+
* you're updating. This ID is a unique identifier for each Amazon Web Services Region in an
|
|
6090
|
+
* Amazon Web Services account.</p>
|
|
6091
|
+
*/
|
|
6092
|
+
VPCConnectionId: string | undefined;
|
|
6093
|
+
/**
|
|
6094
|
+
* <p>The display name for the VPC connection.</p>
|
|
6095
|
+
*/
|
|
6096
|
+
Name: string | undefined;
|
|
6097
|
+
/**
|
|
6098
|
+
* <p>A list of subnet IDs for the VPC connection.</p>
|
|
6099
|
+
*/
|
|
6100
|
+
SubnetIds: string[] | undefined;
|
|
6101
|
+
/**
|
|
6102
|
+
* <p>A list of security group IDs for the VPC connection.</p>
|
|
6103
|
+
*/
|
|
6104
|
+
SecurityGroupIds: string[] | undefined;
|
|
6105
|
+
/**
|
|
6106
|
+
* <p>A list of IP addresses of DNS resolver endpoints for the VPC connection.</p>
|
|
6107
|
+
*/
|
|
6108
|
+
DnsResolvers?: string[];
|
|
6109
|
+
/**
|
|
6110
|
+
* <p>An IAM role associated with the VPC connection.</p>
|
|
6111
|
+
*/
|
|
6112
|
+
RoleArn: string | undefined;
|
|
6113
|
+
}
|
|
6114
|
+
/**
|
|
6115
|
+
* @public
|
|
6116
|
+
*/
|
|
6117
|
+
export interface UpdateVPCConnectionResponse {
|
|
6118
|
+
/**
|
|
6119
|
+
* <p>The Amazon Resource Name (ARN) of the VPC connection.</p>
|
|
6120
|
+
*/
|
|
6121
|
+
Arn?: string;
|
|
6122
|
+
/**
|
|
6123
|
+
* <p>The ID of the VPC connection that you are updating. This ID is a unique identifier for each Amazon Web Services Region in anAmazon Web Services account.</p>
|
|
6124
|
+
*/
|
|
6125
|
+
VPCConnectionId?: string;
|
|
6126
|
+
/**
|
|
6127
|
+
* <p>The update status of the VPC connection's last update.</p>
|
|
6128
|
+
*/
|
|
6129
|
+
UpdateStatus?: VPCConnectionResourceStatus | string;
|
|
6130
|
+
/**
|
|
6131
|
+
* <p>The availability status of the VPC connection.</p>
|
|
6132
|
+
*/
|
|
6133
|
+
AvailabilityStatus?: VPCConnectionAvailabilityStatus | string;
|
|
6134
|
+
/**
|
|
6135
|
+
* <p>The Amazon Web Services request ID for this operation.</p>
|
|
6136
|
+
*/
|
|
6137
|
+
RequestId?: string;
|
|
6138
|
+
/**
|
|
6139
|
+
* <p>The HTTP status of the request.</p>
|
|
6140
|
+
*/
|
|
6141
|
+
Status?: number;
|
|
6142
|
+
}
|
|
6143
|
+
/**
|
|
6144
|
+
* @internal
|
|
6145
|
+
*/
|
|
6146
|
+
export declare const DescribeDataSetResponseFilterSensitiveLog: (obj: DescribeDataSetResponse) => any;
|
|
6147
|
+
/**
|
|
6148
|
+
* @internal
|
|
6149
|
+
*/
|
|
6150
|
+
export declare const DescribeTemplateDefinitionResponseFilterSensitiveLog: (obj: DescribeTemplateDefinitionResponse) => any;
|
|
6151
|
+
/**
|
|
6152
|
+
* @internal
|
|
6153
|
+
*/
|
|
6154
|
+
export declare const DescribeTopicResponseFilterSensitiveLog: (obj: DescribeTopicResponse) => any;
|
|
3745
6155
|
/**
|
|
3746
6156
|
* @internal
|
|
3747
6157
|
*/
|
|
@@ -3786,3 +6196,7 @@ export declare const UpdateDataSourceRequestFilterSensitiveLog: (obj: UpdateData
|
|
|
3786
6196
|
* @internal
|
|
3787
6197
|
*/
|
|
3788
6198
|
export declare const UpdateTemplateRequestFilterSensitiveLog: (obj: UpdateTemplateRequest) => any;
|
|
6199
|
+
/**
|
|
6200
|
+
* @internal
|
|
6201
|
+
*/
|
|
6202
|
+
export declare const UpdateTopicRequestFilterSensitiveLog: (obj: UpdateTopicRequest) => any;
|