@aws-sdk/client-quicksight 3.922.0 → 3.926.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 +1 -1
- package/dist-cjs/index.js +823 -360
- package/dist-es/commands/CreateTopicCommand.js +1 -1
- package/dist-es/commands/GenerateEmbedUrlForRegisteredUserCommand.js +1 -1
- package/dist-es/commands/GenerateEmbedUrlForRegisteredUserWithIdentityCommand.js +1 -1
- package/dist-es/commands/GetDashboardEmbedUrlCommand.js +1 -1
- package/dist-es/commands/GetSessionEmbedUrlCommand.js +1 -1
- package/dist-es/commands/ListActionConnectorsCommand.js +1 -1
- package/dist-es/models/models_0.js +8 -4
- package/dist-es/models/models_1.js +5 -26
- package/dist-es/models/models_2.js +26 -39
- package/dist-es/models/models_3.js +233 -222
- package/dist-es/models/models_4.js +217 -70
- package/dist-es/models/models_5.js +74 -2
- package/dist-es/protocols/Aws_restJson1.js +240 -4
- package/dist-types/QuickSight.d.ts +1 -1
- package/dist-types/QuickSightClient.d.ts +1 -1
- package/dist-types/auth/httpAuthSchemeProvider.d.ts +1 -1
- package/dist-types/commands/CreateDataSetCommand.d.ts +398 -3
- package/dist-types/commands/CreateTopicCommand.d.ts +1 -1
- package/dist-types/commands/CreateTopicRefreshScheduleCommand.d.ts +1 -1
- package/dist-types/commands/CreateVPCConnectionCommand.d.ts +1 -1
- package/dist-types/commands/DescribeDataSetCommand.d.ts +396 -3
- package/dist-types/commands/GenerateEmbedUrlForAnonymousUserCommand.d.ts +4 -4
- package/dist-types/commands/GenerateEmbedUrlForRegisteredUserCommand.d.ts +7 -7
- package/dist-types/commands/GenerateEmbedUrlForRegisteredUserWithIdentityCommand.d.ts +1 -1
- package/dist-types/commands/GetDashboardEmbedUrlCommand.d.ts +4 -4
- package/dist-types/commands/GetFlowMetadataCommand.d.ts +1 -1
- package/dist-types/commands/GetFlowPermissionsCommand.d.ts +1 -1
- package/dist-types/commands/GetSessionEmbedUrlCommand.d.ts +3 -3
- package/dist-types/commands/ListActionConnectorsCommand.d.ts +1 -1
- package/dist-types/commands/ListAnalysesCommand.d.ts +1 -1
- package/dist-types/commands/ListAssetBundleExportJobsCommand.d.ts +1 -1
- package/dist-types/commands/ListAssetBundleImportJobsCommand.d.ts +1 -1
- package/dist-types/commands/ListBrandsCommand.d.ts +1 -1
- package/dist-types/commands/ListCustomPermissionsCommand.d.ts +1 -1
- package/dist-types/commands/ListDashboardVersionsCommand.d.ts +1 -1
- package/dist-types/commands/ListDashboardsCommand.d.ts +1 -1
- package/dist-types/commands/ListDataSetsCommand.d.ts +10 -1
- package/dist-types/commands/ListDataSourcesCommand.d.ts +1 -1
- package/dist-types/commands/ListFlowsCommand.d.ts +1 -1
- package/dist-types/commands/ListFolderMembersCommand.d.ts +1 -1
- package/dist-types/commands/ListFoldersCommand.d.ts +1 -1
- package/dist-types/commands/ListFoldersForResourceCommand.d.ts +1 -1
- package/dist-types/commands/ListGroupMembershipsCommand.d.ts +1 -1
- package/dist-types/commands/ListGroupsCommand.d.ts +1 -2
- package/dist-types/commands/PredictQAResultsCommand.d.ts +1 -1
- package/dist-types/commands/SearchDataSetsCommand.d.ts +9 -0
- package/dist-types/commands/SearchTopicsCommand.d.ts +1 -1
- package/dist-types/commands/UpdateApplicationWithTokenExchangeGrantCommand.d.ts +1 -1
- package/dist-types/commands/UpdateDataSetCommand.d.ts +398 -3
- package/dist-types/commands/UpdatePublicSharingSettingsCommand.d.ts +1 -1
- package/dist-types/index.d.ts +1 -1
- package/dist-types/models/models_0.d.ts +162 -182
- package/dist-types/models/models_1.d.ts +177 -161
- package/dist-types/models/models_2.d.ts +196 -250
- package/dist-types/models/models_3.d.ts +2725 -3153
- package/dist-types/models/models_4.d.ts +4088 -3877
- package/dist-types/models/models_5.d.ts +1555 -12
- package/dist-types/ts3.4/commands/CreateTopicCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/CreateTopicRefreshScheduleCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/CreateVPCConnectionCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/GenerateEmbedUrlForRegisteredUserCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/GenerateEmbedUrlForRegisteredUserWithIdentityCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/GetDashboardEmbedUrlCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/GetFlowMetadataCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/GetFlowPermissionsCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/GetSessionEmbedUrlCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/ListActionConnectorsCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/ListAnalysesCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/ListAssetBundleExportJobsCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/ListAssetBundleImportJobsCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/ListBrandsCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/ListCustomPermissionsCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/ListDashboardVersionsCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/ListDashboardsCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/ListDataSetsCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/ListDataSourcesCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/ListFlowsCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/ListFolderMembersCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/ListFoldersCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/ListFoldersForResourceCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/ListGroupMembershipsCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/ListGroupsCommand.d.ts +1 -2
- package/dist-types/ts3.4/models/models_0.d.ts +42 -42
- package/dist-types/ts3.4/models/models_1.d.ts +44 -56
- package/dist-types/ts3.4/models/models_2.d.ts +72 -94
- package/dist-types/ts3.4/models/models_3.d.ts +446 -511
- package/dist-types/ts3.4/models/models_4.d.ts +513 -366
- package/dist-types/ts3.4/models/models_5.d.ts +381 -17
- package/package.json +8 -8
|
@@ -1,7 +1,1508 @@
|
|
|
1
|
+
import { ExceptionOptionType as __ExceptionOptionType } from "@smithy/smithy-client";
|
|
1
2
|
import { AccountCustomization, ActionConnectorSearchFilter, ActionConnectorSummary, ActiveIAMPolicyAssignment, ResourceStatus } from "./models_0";
|
|
2
|
-
import { AnalysisDefinition, AnalysisSearchFilter, AnalysisSourceEntity, AnalysisSummary, AssetBundleCloudFormationOverridePropertyConfiguration, AssetBundleExportFormat, AssetBundleExportJobValidationStrategy, AssetBundleImportFailureAction, AssetBundleImportJobOverrideParameters, AssetBundleImportJobOverridePermissions, AssetBundleImportJobOverrideTags, AssetBundleImportJobOverrideValidationStrategy, AssetBundleImportSource, AssignmentStatus, AuthConfig, AuthorizedTargetsByService, DataSetRefreshProperties, DataSourceParameters, ServiceType, SslProperties, Tag, VpcConnectionProperties } from "./models_2";
|
|
3
|
-
import { _Parameters, BrandDefinition, BrandDetail, Capabilities, ColumnGroup, ColumnLevelPermissionRule, CustomInstructions, DashboardPublishOptions,
|
|
4
|
-
import { DataSourceSummary, FailedKeyRegistrationEntry, FieldName, FlowSummary, FolderSearchFilter, FolderSummary, GeneratedAnswerResult,
|
|
3
|
+
import { AnalysisDefinition, AnalysisSearchFilter, AnalysisSourceEntity, AnalysisSummary, AssetBundleCloudFormationOverridePropertyConfiguration, AssetBundleExportFormat, AssetBundleExportJobSummary, AssetBundleExportJobValidationStrategy, AssetBundleImportFailureAction, AssetBundleImportJobOverrideParameters, AssetBundleImportJobOverridePermissions, AssetBundleImportJobOverrideTags, AssetBundleImportJobOverrideValidationStrategy, AssetBundleImportJobSummary, AssetBundleImportSource, AssignmentStatus, AuthConfig, AuthorizedTargetsByService, DataSetRefreshProperties, DataSourceParameters, ServiceType, SslProperties, Tag, VpcConnectionProperties } from "./models_2";
|
|
4
|
+
import { _Parameters, BrandDefinition, BrandDetail, BrandSummary, Capabilities, ColumnGroup, ColumnLevelPermissionRule, CustomInstructions, DashboardPublishOptions, DashboardSourceEntity, DashboardVersionDefinition, DataPrepConfiguration, DataSetImportMode, DatasetParameter, DataSetUsageConfiguration, DataSourceCredentials, FieldFolder, Group, GroupMember, LinkSharingConfiguration, LogicalTable, PerformanceConfiguration, PhysicalTable, RefreshSchedule, ResourcePermission, Role, RowLevelPermissionDataSet, RowLevelPermissionTagConfiguration, SemanticModelConfiguration, TemplateAlias, TemplateSourceEntity, TemplateVersionDefinition, ThemeAlias, ThemeConfiguration, TopicIR, TopicTemplate, ValidationStrategy, VisualRole } from "./models_3";
|
|
5
|
+
import { CustomPermissions, DashboardSearchFilter, DashboardsQAStatus, DashboardSummary, DashboardVersionSummary, DashboardVisualResult, DataSetSearchFilter, DataSetSummary, DataSource, DataSourceSearchFilter, DataSourceSummary, EmbeddingIdentityType, FailedKeyRegistrationEntry, FieldName, FlowPublishState, FlowSummary, FolderSearchFilter, FolderSummary, GeneratedAnswerResult, IdentityType, IncludeFolderMembers, Ingestion, MemberIdArnPair, NamespaceInfoV2, NetworkInterface, PersonalizationMode, QSearchStatus, RegisteredCustomerManagedKey, RegisteredUserConsoleFeatureConfigurations, RegisteredUserDashboardEmbeddingConfiguration, RegisteredUserDashboardVisualEmbeddingConfiguration, RegisteredUserGenerativeQnAEmbeddingConfiguration, RegisteredUserQSearchBarEmbeddingConfiguration, SessionTag, SnapshotConfiguration, ThemeType, TopicDetails, TopicRefreshSchedule, TopicUserExperienceVersion, User, UserRole, VPCConnectionAvailabilityStatus, VPCConnectionResourceStatus } from "./models_4";
|
|
6
|
+
import { QuickSightServiceException as __BaseException } from "./QuickSightServiceException";
|
|
7
|
+
/**
|
|
8
|
+
* <p>Information about the Amazon Quick Sight console that you want to embed.</p>
|
|
9
|
+
* @public
|
|
10
|
+
*/
|
|
11
|
+
export interface RegisteredUserQuickSightConsoleEmbeddingConfiguration {
|
|
12
|
+
/**
|
|
13
|
+
* <p>The initial URL path for the Amazon Quick Sight console. <code>InitialPath</code> is
|
|
14
|
+
* required.</p>
|
|
15
|
+
* <p>The entry point URL is constrained to the following paths:</p>
|
|
16
|
+
* <ul>
|
|
17
|
+
* <li>
|
|
18
|
+
* <p>
|
|
19
|
+
* <code>/start</code>
|
|
20
|
+
* </p>
|
|
21
|
+
* </li>
|
|
22
|
+
* <li>
|
|
23
|
+
* <p>
|
|
24
|
+
* <code>/start/analyses</code>
|
|
25
|
+
* </p>
|
|
26
|
+
* </li>
|
|
27
|
+
* <li>
|
|
28
|
+
* <p>
|
|
29
|
+
* <code>/start/dashboards</code>
|
|
30
|
+
* </p>
|
|
31
|
+
* </li>
|
|
32
|
+
* <li>
|
|
33
|
+
* <p>
|
|
34
|
+
* <code>/start/favorites</code>
|
|
35
|
+
* </p>
|
|
36
|
+
* </li>
|
|
37
|
+
* <li>
|
|
38
|
+
* <p>
|
|
39
|
+
* <code>/dashboards/DashboardId</code>. <i>DashboardId</i> is the
|
|
40
|
+
* actual ID key from the Amazon Quick Sight console URL of the dashboard.</p>
|
|
41
|
+
* </li>
|
|
42
|
+
* <li>
|
|
43
|
+
* <p>
|
|
44
|
+
* <code>/analyses/AnalysisId</code>. <i>AnalysisId</i> is the
|
|
45
|
+
* actual ID key from the Amazon Quick Sight console URL of the analysis.</p>
|
|
46
|
+
* </li>
|
|
47
|
+
* </ul>
|
|
48
|
+
* @public
|
|
49
|
+
*/
|
|
50
|
+
InitialPath?: string | undefined;
|
|
51
|
+
/**
|
|
52
|
+
* <p>The embedding configuration of an embedded Amazon Quick Sight console.</p>
|
|
53
|
+
* @public
|
|
54
|
+
*/
|
|
55
|
+
FeatureConfigurations?: RegisteredUserConsoleFeatureConfigurations | undefined;
|
|
56
|
+
}
|
|
57
|
+
/**
|
|
58
|
+
* <p>The type of experience you want to embed. For registered users, you can embed Quick Suite dashboards or the Amazon Quick Sight console.</p>
|
|
59
|
+
* <note>
|
|
60
|
+
* <p>Exactly one of the experience configurations is required. You can choose
|
|
61
|
+
* <code>Dashboard</code> or <code>QuickSightConsole</code>. You cannot choose more
|
|
62
|
+
* than one experience configuration.</p>
|
|
63
|
+
* </note>
|
|
64
|
+
* @public
|
|
65
|
+
*/
|
|
66
|
+
export interface RegisteredUserEmbeddingExperienceConfiguration {
|
|
67
|
+
/**
|
|
68
|
+
* <p>The configuration details for providing a dashboard embedding experience.</p>
|
|
69
|
+
* @public
|
|
70
|
+
*/
|
|
71
|
+
Dashboard?: RegisteredUserDashboardEmbeddingConfiguration | undefined;
|
|
72
|
+
/**
|
|
73
|
+
* <p>The configuration details for providing each Amazon Quick Sight console embedding
|
|
74
|
+
* experience. This can be used along with custom permissions to restrict access to certain
|
|
75
|
+
* features. For more information, see <a href="https://docs.aws.amazon.com/quicksight/latest/user/customizing-permissions-to-the-quicksight-console.html">Customizing Access to the Amazon Quick Sight Console</a> in the
|
|
76
|
+
* <i>Amazon Quick Suite User Guide</i>.</p>
|
|
77
|
+
* <p>Use <code>
|
|
78
|
+
* <a href="https://docs.aws.amazon.com/quicksight/latest/APIReference/API_GenerateEmbedUrlForRegisteredUser.html">GenerateEmbedUrlForRegisteredUser</a>
|
|
79
|
+
* </code> where you want to provide an
|
|
80
|
+
* authoring portal that allows users to create data sources, datasets, analyses, and
|
|
81
|
+
* dashboards. The users who accesses an embedded Amazon Quick Sight console needs to belong
|
|
82
|
+
* to the author or admin security cohort. If you want to restrict permissions to some of
|
|
83
|
+
* these features, add a custom permissions profile to the user with the <code>
|
|
84
|
+
* <a href="https://docs.aws.amazon.com/quicksight/latest/APIReference/API_UpdateUser.html">UpdateUser</a>
|
|
85
|
+
* </code> API operation. Use the <code>
|
|
86
|
+
* <a href="https://docs.aws.amazon.com/quicksight/latest/APIReference/API_RegisterUser.html">RegisterUser</a>
|
|
87
|
+
* </code> API operation to add a new user with a custom
|
|
88
|
+
* permission profile attached. For more information, see the following sections in the
|
|
89
|
+
* <i>Amazon Quick Suite User Guide</i>:</p>
|
|
90
|
+
* <ul>
|
|
91
|
+
* <li>
|
|
92
|
+
* <p>
|
|
93
|
+
* <a href="https://docs.aws.amazon.com/quicksight/latest/user/embedded-analytics-full-console-for-authenticated-users.html">Embedding the Full Functionality of the Amazon Quick Sight Console for
|
|
94
|
+
* Authenticated Users</a>
|
|
95
|
+
* </p>
|
|
96
|
+
* </li>
|
|
97
|
+
* <li>
|
|
98
|
+
* <p>
|
|
99
|
+
* <a href="https://docs.aws.amazon.com/quicksight/latest/user/customizing-permissions-to-the-quicksight-console.html">Customizing Access to the Amazon Quick Suite Console</a>
|
|
100
|
+
* </p>
|
|
101
|
+
* </li>
|
|
102
|
+
* </ul>
|
|
103
|
+
* <p>For more information about the high-level steps for embedding and for an interactive
|
|
104
|
+
* demo of the ways you can customize embedding, visit the <a href="https://docs.aws.amazon.com/quicksight/latest/user/quicksight-dev-portal.html">Amazon Quick Suite
|
|
105
|
+
* Developer Portal</a>.</p>
|
|
106
|
+
* @public
|
|
107
|
+
*/
|
|
108
|
+
QuickSightConsole?: RegisteredUserQuickSightConsoleEmbeddingConfiguration | undefined;
|
|
109
|
+
/**
|
|
110
|
+
* <p>The configuration details for embedding the Q search bar.</p>
|
|
111
|
+
* <p>For more information about embedding the Q search bar, see <a href="https://docs.aws.amazon.com/quicksight/latest/user/embedding-overview.html">Embedding Overview</a> in
|
|
112
|
+
* the <i>Amazon Quick Sight User Guide</i>.</p>
|
|
113
|
+
* @public
|
|
114
|
+
*/
|
|
115
|
+
QSearchBar?: RegisteredUserQSearchBarEmbeddingConfiguration | undefined;
|
|
116
|
+
/**
|
|
117
|
+
* <p>The type of embedding experience. In this case, Amazon Quick Sight visuals.</p>
|
|
118
|
+
* @public
|
|
119
|
+
*/
|
|
120
|
+
DashboardVisual?: RegisteredUserDashboardVisualEmbeddingConfiguration | undefined;
|
|
121
|
+
/**
|
|
122
|
+
* <p>The configuration details for embedding the Generative Q&A experience.</p>
|
|
123
|
+
* <p>For more information about embedding the Generative Q&A experience, see <a href="https://docs.aws.amazon.com/quicksight/latest/user/embedding-overview.html">Embedding Overview</a> in
|
|
124
|
+
* the <i>Amazon Quick Sight User Guide</i>.</p>
|
|
125
|
+
* @public
|
|
126
|
+
*/
|
|
127
|
+
GenerativeQnA?: RegisteredUserGenerativeQnAEmbeddingConfiguration | undefined;
|
|
128
|
+
}
|
|
129
|
+
/**
|
|
130
|
+
* @public
|
|
131
|
+
*/
|
|
132
|
+
export interface GenerateEmbedUrlForRegisteredUserRequest {
|
|
133
|
+
/**
|
|
134
|
+
* <p>The ID for the Amazon Web Services account that contains the dashboard that you're
|
|
135
|
+
* embedding.</p>
|
|
136
|
+
* @public
|
|
137
|
+
*/
|
|
138
|
+
AwsAccountId: string | undefined;
|
|
139
|
+
/**
|
|
140
|
+
* <p>How many minutes the session is valid. The session lifetime must be in [15-600]
|
|
141
|
+
* minutes range.</p>
|
|
142
|
+
* @public
|
|
143
|
+
*/
|
|
144
|
+
SessionLifetimeInMinutes?: number | undefined;
|
|
145
|
+
/**
|
|
146
|
+
* <p>The Amazon Resource Name for the registered user.</p>
|
|
147
|
+
* @public
|
|
148
|
+
*/
|
|
149
|
+
UserArn: string | undefined;
|
|
150
|
+
/**
|
|
151
|
+
* <p>The experience that you want to embed. For registered users, you can embed Quick Suite dashboards, Amazon Quick Sight visuals, the Amazon Quick Sight Q search bar,
|
|
152
|
+
* the Amazon Quick Sight Generative Q&A experience, or the entire Amazon Quick Sight console.</p>
|
|
153
|
+
* @public
|
|
154
|
+
*/
|
|
155
|
+
ExperienceConfiguration: RegisteredUserEmbeddingExperienceConfiguration | undefined;
|
|
156
|
+
/**
|
|
157
|
+
* <p>The domains that you want to add to the allow list for access to the generated URL
|
|
158
|
+
* that is then embedded. This optional parameter overrides the static domains that are
|
|
159
|
+
* configured in the Manage Quick Sight menu in the Amazon Quick Sight console. Instead, it
|
|
160
|
+
* allows only the domains that you include in this parameter. You can list up to three
|
|
161
|
+
* domains or subdomains in each API call.</p>
|
|
162
|
+
* <p>To include all subdomains under a specific domain to the allow list, use
|
|
163
|
+
* <code>*</code>. For example, <code>https://*.sapp.amazon.com</code> includes all
|
|
164
|
+
* subdomains under <code>https://sapp.amazon.com</code>.</p>
|
|
165
|
+
* @public
|
|
166
|
+
*/
|
|
167
|
+
AllowedDomains?: string[] | undefined;
|
|
168
|
+
}
|
|
169
|
+
/**
|
|
170
|
+
* @public
|
|
171
|
+
*/
|
|
172
|
+
export interface GenerateEmbedUrlForRegisteredUserResponse {
|
|
173
|
+
/**
|
|
174
|
+
* <p>The embed URL for the Amazon Quick Sight dashboard, visual, Q search bar, Generative Q&A experience, or
|
|
175
|
+
* console.</p>
|
|
176
|
+
* @public
|
|
177
|
+
*/
|
|
178
|
+
EmbedUrl: string | undefined;
|
|
179
|
+
/**
|
|
180
|
+
* <p>The HTTP status of the request.</p>
|
|
181
|
+
* @public
|
|
182
|
+
*/
|
|
183
|
+
Status: number | undefined;
|
|
184
|
+
/**
|
|
185
|
+
* <p>The Amazon Web Services request ID for this operation.</p>
|
|
186
|
+
* @public
|
|
187
|
+
*/
|
|
188
|
+
RequestId: string | undefined;
|
|
189
|
+
}
|
|
190
|
+
/**
|
|
191
|
+
* <p>The user with the provided name isn't found. This error can happen in any operation
|
|
192
|
+
* that requires finding a user based on a provided user name, such as
|
|
193
|
+
* <code>DeleteUser</code>, <code>DescribeUser</code>, and so on.</p>
|
|
194
|
+
* @public
|
|
195
|
+
*/
|
|
196
|
+
export declare class QuickSightUserNotFoundException extends __BaseException {
|
|
197
|
+
readonly name: "QuickSightUserNotFoundException";
|
|
198
|
+
readonly $fault: "client";
|
|
199
|
+
Message?: string | undefined;
|
|
200
|
+
/**
|
|
201
|
+
* <p>The Amazon Web Services request ID for this request.</p>
|
|
202
|
+
* @public
|
|
203
|
+
*/
|
|
204
|
+
RequestId?: string | undefined;
|
|
205
|
+
/**
|
|
206
|
+
* @internal
|
|
207
|
+
*/
|
|
208
|
+
constructor(opts: __ExceptionOptionType<QuickSightUserNotFoundException, __BaseException>);
|
|
209
|
+
}
|
|
210
|
+
/**
|
|
211
|
+
* @public
|
|
212
|
+
*/
|
|
213
|
+
export interface GenerateEmbedUrlForRegisteredUserWithIdentityRequest {
|
|
214
|
+
/**
|
|
215
|
+
* <p>The ID of the Amazon Web Services registered user.</p>
|
|
216
|
+
* @public
|
|
217
|
+
*/
|
|
218
|
+
AwsAccountId: string | undefined;
|
|
219
|
+
/**
|
|
220
|
+
* <p>The validity of the session in minutes.</p>
|
|
221
|
+
* @public
|
|
222
|
+
*/
|
|
223
|
+
SessionLifetimeInMinutes?: number | undefined;
|
|
224
|
+
/**
|
|
225
|
+
* <p>The type of experience you want to embed. For registered users, you can embed Quick Suite dashboards or the Amazon Quick Sight console.</p>
|
|
226
|
+
* <note>
|
|
227
|
+
* <p>Exactly one of the experience configurations is required. You can choose
|
|
228
|
+
* <code>Dashboard</code> or <code>QuickSightConsole</code>. You cannot choose more
|
|
229
|
+
* than one experience configuration.</p>
|
|
230
|
+
* </note>
|
|
231
|
+
* @public
|
|
232
|
+
*/
|
|
233
|
+
ExperienceConfiguration: RegisteredUserEmbeddingExperienceConfiguration | undefined;
|
|
234
|
+
/**
|
|
235
|
+
* <p>A list of domains to be allowed to generate the embed URL.</p>
|
|
236
|
+
* @public
|
|
237
|
+
*/
|
|
238
|
+
AllowedDomains?: string[] | undefined;
|
|
239
|
+
}
|
|
240
|
+
/**
|
|
241
|
+
* @public
|
|
242
|
+
*/
|
|
243
|
+
export interface GenerateEmbedUrlForRegisteredUserWithIdentityResponse {
|
|
244
|
+
/**
|
|
245
|
+
* <p>The generated embed URL for the registered user.</p>
|
|
246
|
+
* @public
|
|
247
|
+
*/
|
|
248
|
+
EmbedUrl: string | undefined;
|
|
249
|
+
/**
|
|
250
|
+
* <p>The HTTP status of the request.</p>
|
|
251
|
+
* @public
|
|
252
|
+
*/
|
|
253
|
+
Status: number | undefined;
|
|
254
|
+
/**
|
|
255
|
+
* <p>The Amazon Web Services request ID for this operation.</p>
|
|
256
|
+
* @public
|
|
257
|
+
*/
|
|
258
|
+
RequestId: string | undefined;
|
|
259
|
+
}
|
|
260
|
+
/**
|
|
261
|
+
* @public
|
|
262
|
+
*/
|
|
263
|
+
export interface GetDashboardEmbedUrlRequest {
|
|
264
|
+
/**
|
|
265
|
+
* <p>The ID for the Amazon Web Services account that contains the dashboard that you're
|
|
266
|
+
* embedding.</p>
|
|
267
|
+
* @public
|
|
268
|
+
*/
|
|
269
|
+
AwsAccountId: string | undefined;
|
|
270
|
+
/**
|
|
271
|
+
* <p>The ID for the dashboard, also added to the Identity and Access Management (IAM) policy.</p>
|
|
272
|
+
* @public
|
|
273
|
+
*/
|
|
274
|
+
DashboardId: string | undefined;
|
|
275
|
+
/**
|
|
276
|
+
* <p>The authentication method that the user uses to sign in.</p>
|
|
277
|
+
* @public
|
|
278
|
+
*/
|
|
279
|
+
IdentityType: EmbeddingIdentityType | undefined;
|
|
280
|
+
/**
|
|
281
|
+
* <p>How many minutes the session is valid. The session lifetime must be 15-600
|
|
282
|
+
* minutes.</p>
|
|
283
|
+
* @public
|
|
284
|
+
*/
|
|
285
|
+
SessionLifetimeInMinutes?: number | undefined;
|
|
286
|
+
/**
|
|
287
|
+
* <p>Remove the undo/redo button on the embedded dashboard. The default is FALSE, which
|
|
288
|
+
* enables the undo/redo button.</p>
|
|
289
|
+
* @public
|
|
290
|
+
*/
|
|
291
|
+
UndoRedoDisabled?: boolean | undefined;
|
|
292
|
+
/**
|
|
293
|
+
* <p>Remove the reset button on the embedded dashboard. The default is FALSE, which enables
|
|
294
|
+
* the reset button.</p>
|
|
295
|
+
* @public
|
|
296
|
+
*/
|
|
297
|
+
ResetDisabled?: boolean | undefined;
|
|
298
|
+
/**
|
|
299
|
+
* <p>Adds persistence of state for the user session in an embedded dashboard. Persistence
|
|
300
|
+
* applies to the sheet and the parameter settings. These are control settings that the
|
|
301
|
+
* dashboard subscriber (Amazon Quick Sight reader) chooses while viewing the dashboard. If
|
|
302
|
+
* this is set to <code>TRUE</code>, the settings are the same when the subscriber reopens
|
|
303
|
+
* the same dashboard URL. The state is stored in Amazon Quick Sight, not in a browser
|
|
304
|
+
* cookie. If this is set to FALSE, the state of the user session is not persisted. The
|
|
305
|
+
* default is <code>FALSE</code>.</p>
|
|
306
|
+
* @public
|
|
307
|
+
*/
|
|
308
|
+
StatePersistenceEnabled?: boolean | undefined;
|
|
309
|
+
/**
|
|
310
|
+
* <p>The Amazon Quick Suite user's Amazon Resource Name (ARN), for use with
|
|
311
|
+
* <code>QUICKSIGHT</code> identity type. You can use this for any Amazon Quick Suite users in your account (readers, authors, or admins) authenticated as one of the
|
|
312
|
+
* following:</p>
|
|
313
|
+
* <ul>
|
|
314
|
+
* <li>
|
|
315
|
+
* <p>Active Directory (AD) users or group members</p>
|
|
316
|
+
* </li>
|
|
317
|
+
* <li>
|
|
318
|
+
* <p>Invited nonfederated users</p>
|
|
319
|
+
* </li>
|
|
320
|
+
* <li>
|
|
321
|
+
* <p>IAM users and IAM role-based sessions
|
|
322
|
+
* authenticated through Federated Single Sign-On using SAML, OpenID Connect, or
|
|
323
|
+
* IAM federation.</p>
|
|
324
|
+
* </li>
|
|
325
|
+
* </ul>
|
|
326
|
+
* <p>Omit this parameter for users in the third group – IAM users and IAM
|
|
327
|
+
* role-based sessions.</p>
|
|
328
|
+
* @public
|
|
329
|
+
*/
|
|
330
|
+
UserArn?: string | undefined;
|
|
331
|
+
/**
|
|
332
|
+
* <p>The Amazon Quick Sight namespace that contains the dashboard IDs in this request. If
|
|
333
|
+
* you're not using a custom namespace, set <code>Namespace = default</code>.</p>
|
|
334
|
+
* @public
|
|
335
|
+
*/
|
|
336
|
+
Namespace?: string | undefined;
|
|
337
|
+
/**
|
|
338
|
+
* <p>A list of one or more dashboard IDs that you want anonymous users to have tempporary
|
|
339
|
+
* access to. Currently, the <code>IdentityType</code> parameter must be set to
|
|
340
|
+
* <code>ANONYMOUS</code> because other identity types authenticate as Quick Suite or IAM users. For example, if you set "<code>--dashboard-id
|
|
341
|
+
* dash_id1 --dashboard-id dash_id2 dash_id3 identity-type ANONYMOUS</code>", the
|
|
342
|
+
* session can access all three dashboards.</p>
|
|
343
|
+
* @public
|
|
344
|
+
*/
|
|
345
|
+
AdditionalDashboardIds?: string[] | undefined;
|
|
346
|
+
}
|
|
347
|
+
/**
|
|
348
|
+
* <p>Output returned from the <code>GetDashboardEmbedUrl</code> operation.</p>
|
|
349
|
+
* @public
|
|
350
|
+
*/
|
|
351
|
+
export interface GetDashboardEmbedUrlResponse {
|
|
352
|
+
/**
|
|
353
|
+
* <p>A single-use URL that you can put into your server-side webpage to embed your
|
|
354
|
+
* dashboard. This URL is valid for 5 minutes. The API operation provides the URL with an
|
|
355
|
+
* <code>auth_code</code> value that enables one (and only one) sign-on to a user
|
|
356
|
+
* session that is valid for 10 hours. </p>
|
|
357
|
+
* @public
|
|
358
|
+
*/
|
|
359
|
+
EmbedUrl?: string | undefined;
|
|
360
|
+
/**
|
|
361
|
+
* <p>The HTTP status of the request.</p>
|
|
362
|
+
* @public
|
|
363
|
+
*/
|
|
364
|
+
Status?: number | undefined;
|
|
365
|
+
/**
|
|
366
|
+
* <p>The Amazon Web Services request ID for this operation.</p>
|
|
367
|
+
* @public
|
|
368
|
+
*/
|
|
369
|
+
RequestId?: string | undefined;
|
|
370
|
+
}
|
|
371
|
+
/**
|
|
372
|
+
* <p>The identity type specified isn't supported. Supported identity types include
|
|
373
|
+
* <code>IAM</code> and <code>QUICKSIGHT</code>.</p>
|
|
374
|
+
* @public
|
|
375
|
+
*/
|
|
376
|
+
export declare class IdentityTypeNotSupportedException extends __BaseException {
|
|
377
|
+
readonly name: "IdentityTypeNotSupportedException";
|
|
378
|
+
readonly $fault: "client";
|
|
379
|
+
Message?: string | undefined;
|
|
380
|
+
/**
|
|
381
|
+
* <p>The Amazon Web Services request ID for this request.</p>
|
|
382
|
+
* @public
|
|
383
|
+
*/
|
|
384
|
+
RequestId?: string | undefined;
|
|
385
|
+
/**
|
|
386
|
+
* @internal
|
|
387
|
+
*/
|
|
388
|
+
constructor(opts: __ExceptionOptionType<IdentityTypeNotSupportedException, __BaseException>);
|
|
389
|
+
}
|
|
390
|
+
/**
|
|
391
|
+
* @public
|
|
392
|
+
*/
|
|
393
|
+
export interface GetFlowMetadataInput {
|
|
394
|
+
/**
|
|
395
|
+
* <p>The ID of the Amazon Web Services account that contains the flow that you are getting metadata for.</p>
|
|
396
|
+
* @public
|
|
397
|
+
*/
|
|
398
|
+
AwsAccountId: string | undefined;
|
|
399
|
+
/**
|
|
400
|
+
* <p>The unique identifier of the flow.</p>
|
|
401
|
+
* @public
|
|
402
|
+
*/
|
|
403
|
+
FlowId: string | undefined;
|
|
404
|
+
}
|
|
405
|
+
/**
|
|
406
|
+
* @public
|
|
407
|
+
*/
|
|
408
|
+
export interface GetFlowMetadataOutput {
|
|
409
|
+
/**
|
|
410
|
+
* <p>The Amazon Resource Name (ARN) of the flow.</p>
|
|
411
|
+
* @public
|
|
412
|
+
*/
|
|
413
|
+
Arn: string | undefined;
|
|
414
|
+
/**
|
|
415
|
+
* <p>The unique identifier of the flow.</p>
|
|
416
|
+
* @public
|
|
417
|
+
*/
|
|
418
|
+
FlowId: string | undefined;
|
|
419
|
+
/**
|
|
420
|
+
* <p>A display name for the flow.</p>
|
|
421
|
+
* @public
|
|
422
|
+
*/
|
|
423
|
+
Name: string | undefined;
|
|
424
|
+
/**
|
|
425
|
+
* <p>The description for the flow.</p>
|
|
426
|
+
* @public
|
|
427
|
+
*/
|
|
428
|
+
Description?: string | undefined;
|
|
429
|
+
/**
|
|
430
|
+
* <p>The publish state for the flow. Valid values are <code>DRAFT</code>, <code>PUBLISHED</code>,
|
|
431
|
+
* or <code>PENDING_APPROVAL</code>.</p>
|
|
432
|
+
* @public
|
|
433
|
+
*/
|
|
434
|
+
PublishState?: FlowPublishState | undefined;
|
|
435
|
+
/**
|
|
436
|
+
* <p>The number of users who have used the flow.</p>
|
|
437
|
+
* @public
|
|
438
|
+
*/
|
|
439
|
+
UserCount?: number | undefined;
|
|
440
|
+
/**
|
|
441
|
+
* <p>The number of runs done for the flow.</p>
|
|
442
|
+
* @public
|
|
443
|
+
*/
|
|
444
|
+
RunCount?: number | undefined;
|
|
445
|
+
/**
|
|
446
|
+
* <p>The time this flow was created.</p>
|
|
447
|
+
* @public
|
|
448
|
+
*/
|
|
449
|
+
CreatedTime: Date | undefined;
|
|
450
|
+
/**
|
|
451
|
+
* <p>The last time this flow was modified.</p>
|
|
452
|
+
* @public
|
|
453
|
+
*/
|
|
454
|
+
LastUpdatedTime?: Date | undefined;
|
|
455
|
+
/**
|
|
456
|
+
* <p>The Amazon Web Services request ID for this operation.</p>
|
|
457
|
+
* @public
|
|
458
|
+
*/
|
|
459
|
+
RequestId?: string | undefined;
|
|
460
|
+
/**
|
|
461
|
+
* <p>The HTTP status of the request.</p>
|
|
462
|
+
* @public
|
|
463
|
+
*/
|
|
464
|
+
Status?: number | undefined;
|
|
465
|
+
}
|
|
466
|
+
/**
|
|
467
|
+
* @public
|
|
468
|
+
*/
|
|
469
|
+
export interface GetFlowPermissionsInput {
|
|
470
|
+
/**
|
|
471
|
+
* <p>The ID of the Amazon Web Services account that contains the flow that you are getting permissions for.</p>
|
|
472
|
+
* @public
|
|
473
|
+
*/
|
|
474
|
+
AwsAccountId: string | undefined;
|
|
475
|
+
/**
|
|
476
|
+
* <p>The unique identifier of the flow to get permissions from.</p>
|
|
477
|
+
* @public
|
|
478
|
+
*/
|
|
479
|
+
FlowId: string | undefined;
|
|
480
|
+
}
|
|
481
|
+
/**
|
|
482
|
+
* <p>A structure that contains the permission information for one principal against one flow.</p>
|
|
483
|
+
* @public
|
|
484
|
+
*/
|
|
485
|
+
export interface Permission {
|
|
486
|
+
/**
|
|
487
|
+
* <p>A list of actions that the principal can perform against the flow.</p>
|
|
488
|
+
* <p>The following are the list of values to set a principal as a flow owner:</p>
|
|
489
|
+
* <ul>
|
|
490
|
+
* <li>
|
|
491
|
+
* <p>quicksight:PublishFlow</p>
|
|
492
|
+
* </li>
|
|
493
|
+
* <li>
|
|
494
|
+
* <p>quicksight:GetFlow</p>
|
|
495
|
+
* </li>
|
|
496
|
+
* <li>
|
|
497
|
+
* <p>quicksight:UpdateFlowPermissions</p>
|
|
498
|
+
* </li>
|
|
499
|
+
* <li>
|
|
500
|
+
* <p>quicksight:GetFlowSession</p>
|
|
501
|
+
* </li>
|
|
502
|
+
* <li>
|
|
503
|
+
* <p>quicksight:StartFlowSession</p>
|
|
504
|
+
* </li>
|
|
505
|
+
* <li>
|
|
506
|
+
* <p>quicksight:StopFlowSession</p>
|
|
507
|
+
* </li>
|
|
508
|
+
* <li>
|
|
509
|
+
* <p>quicksight:UpdateFlowSession</p>
|
|
510
|
+
* </li>
|
|
511
|
+
* <li>
|
|
512
|
+
* <p>quicksight:UnpublishFlow</p>
|
|
513
|
+
* </li>
|
|
514
|
+
* <li>
|
|
515
|
+
* <p>quicksight:GetFlowStages</p>
|
|
516
|
+
* </li>
|
|
517
|
+
* <li>
|
|
518
|
+
* <p>quicksight:DeleteFlow</p>
|
|
519
|
+
* </li>
|
|
520
|
+
* <li>
|
|
521
|
+
* <p>quicksight:DescribeFlowPermissions</p>
|
|
522
|
+
* </li>
|
|
523
|
+
* <li>
|
|
524
|
+
* <p>quicksight:UpdateFlow</p>
|
|
525
|
+
* </li>
|
|
526
|
+
* <li>
|
|
527
|
+
* <p>quicksight:CreatePresignedUrl</p>
|
|
528
|
+
* </li>
|
|
529
|
+
* </ul>
|
|
530
|
+
* <p>The following are the list of values to set a principal as a flow viewer:</p>
|
|
531
|
+
* <ul>
|
|
532
|
+
* <li>
|
|
533
|
+
* <p>quicksight:GetFlow</p>
|
|
534
|
+
* </li>
|
|
535
|
+
* <li>
|
|
536
|
+
* <p>quicksight:UpdateFlowSession</p>
|
|
537
|
+
* </li>
|
|
538
|
+
* <li>
|
|
539
|
+
* <p>quicksight:StartFlowSession</p>
|
|
540
|
+
* </li>
|
|
541
|
+
* <li>
|
|
542
|
+
* <p>quicksight:StopFlowSession</p>
|
|
543
|
+
* </li>
|
|
544
|
+
* <li>
|
|
545
|
+
* <p>quicksight:GetFlowSession</p>
|
|
546
|
+
* </li>
|
|
547
|
+
* <li>
|
|
548
|
+
* <p>quicksight:CreatePresignedUrl</p>
|
|
549
|
+
* </li>
|
|
550
|
+
* <li>
|
|
551
|
+
* <p>quicksight:GetFlowStages</p>
|
|
552
|
+
* </li>
|
|
553
|
+
* </ul>
|
|
554
|
+
* @public
|
|
555
|
+
*/
|
|
556
|
+
Actions: string[] | undefined;
|
|
557
|
+
/**
|
|
558
|
+
* <p>The Amazon Resource Name (ARN) of the principal.
|
|
559
|
+
* This can be an Amazon Quick Suite user, group or namespace associated with the flow.
|
|
560
|
+
* Namespace principal can only be set as a viewer and will grant everyone in the same namespace viewer permissions.</p>
|
|
561
|
+
* @public
|
|
562
|
+
*/
|
|
563
|
+
Principal: string | undefined;
|
|
564
|
+
}
|
|
565
|
+
/**
|
|
566
|
+
* @public
|
|
567
|
+
*/
|
|
568
|
+
export interface GetFlowPermissionsOutput {
|
|
569
|
+
/**
|
|
570
|
+
* <p>The Amazon Resource Name (ARN) of the flow you are getting permissions against.</p>
|
|
571
|
+
* @public
|
|
572
|
+
*/
|
|
573
|
+
Arn: string | undefined;
|
|
574
|
+
/**
|
|
575
|
+
* <p>The unique identifier of the flow with permissions.</p>
|
|
576
|
+
* @public
|
|
577
|
+
*/
|
|
578
|
+
FlowId: string | undefined;
|
|
579
|
+
/**
|
|
580
|
+
* <p>A structure that contains the permissions for the flow.</p>
|
|
581
|
+
* @public
|
|
582
|
+
*/
|
|
583
|
+
Permissions: Permission[] | undefined;
|
|
584
|
+
/**
|
|
585
|
+
* <p>The Amazon Web Services request ID for this operation.</p>
|
|
586
|
+
* @public
|
|
587
|
+
*/
|
|
588
|
+
RequestId?: string | undefined;
|
|
589
|
+
/**
|
|
590
|
+
* <p>The HTTP status of the request.</p>
|
|
591
|
+
* @public
|
|
592
|
+
*/
|
|
593
|
+
Status?: number | undefined;
|
|
594
|
+
}
|
|
595
|
+
/**
|
|
596
|
+
* @public
|
|
597
|
+
*/
|
|
598
|
+
export interface GetSessionEmbedUrlRequest {
|
|
599
|
+
/**
|
|
600
|
+
* <p>The ID for the Amazon Web Services account associated with your Amazon Quick Sight
|
|
601
|
+
* subscription.</p>
|
|
602
|
+
* @public
|
|
603
|
+
*/
|
|
604
|
+
AwsAccountId: string | undefined;
|
|
605
|
+
/**
|
|
606
|
+
* <p>The URL you use to access the embedded session. The entry point URL is constrained to
|
|
607
|
+
* the following paths:</p>
|
|
608
|
+
* <ul>
|
|
609
|
+
* <li>
|
|
610
|
+
* <p>
|
|
611
|
+
* <code>/start</code>
|
|
612
|
+
* </p>
|
|
613
|
+
* </li>
|
|
614
|
+
* <li>
|
|
615
|
+
* <p>
|
|
616
|
+
* <code>/start/analyses</code>
|
|
617
|
+
* </p>
|
|
618
|
+
* </li>
|
|
619
|
+
* <li>
|
|
620
|
+
* <p>
|
|
621
|
+
* <code>/start/dashboards</code>
|
|
622
|
+
* </p>
|
|
623
|
+
* </li>
|
|
624
|
+
* <li>
|
|
625
|
+
* <p>
|
|
626
|
+
* <code>/start/favorites</code>
|
|
627
|
+
* </p>
|
|
628
|
+
* </li>
|
|
629
|
+
* <li>
|
|
630
|
+
* <p>
|
|
631
|
+
* <code>/dashboards/<i>DashboardId</i>
|
|
632
|
+
* </code> - where
|
|
633
|
+
* <code>DashboardId</code> is the actual ID key from the Amazon Quick Sight
|
|
634
|
+
* console URL of the dashboard</p>
|
|
635
|
+
* </li>
|
|
636
|
+
* <li>
|
|
637
|
+
* <p>
|
|
638
|
+
* <code>/analyses/<i>AnalysisId</i>
|
|
639
|
+
* </code> - where
|
|
640
|
+
* <code>AnalysisId</code> is the actual ID key from the Amazon Quick Sight
|
|
641
|
+
* console URL of the analysis</p>
|
|
642
|
+
* </li>
|
|
643
|
+
* </ul>
|
|
644
|
+
* @public
|
|
645
|
+
*/
|
|
646
|
+
EntryPoint?: string | undefined;
|
|
647
|
+
/**
|
|
648
|
+
* <p>How many minutes the session is valid. The session lifetime must be 15-600
|
|
649
|
+
* minutes.</p>
|
|
650
|
+
* @public
|
|
651
|
+
*/
|
|
652
|
+
SessionLifetimeInMinutes?: number | undefined;
|
|
653
|
+
/**
|
|
654
|
+
* <p>The Amazon Quick Suite user's Amazon Resource Name (ARN), for use with
|
|
655
|
+
* <code>QUICKSIGHT</code> identity type. You can use this for any type of Amazon Quick Suite users in your account (readers, authors, or admins). They need to be
|
|
656
|
+
* authenticated as one of the following:</p>
|
|
657
|
+
* <ol>
|
|
658
|
+
* <li>
|
|
659
|
+
* <p>Active Directory (AD) users or group members</p>
|
|
660
|
+
* </li>
|
|
661
|
+
* <li>
|
|
662
|
+
* <p>Invited nonfederated users</p>
|
|
663
|
+
* </li>
|
|
664
|
+
* <li>
|
|
665
|
+
* <p>IAM users and IAM role-based sessions
|
|
666
|
+
* authenticated through Federated Single Sign-On using SAML, OpenID Connect, or
|
|
667
|
+
* IAM federation</p>
|
|
668
|
+
* </li>
|
|
669
|
+
* </ol>
|
|
670
|
+
* <p>Omit this parameter for users in the third group, IAM users and IAM role-based sessions.</p>
|
|
671
|
+
* @public
|
|
672
|
+
*/
|
|
673
|
+
UserArn?: string | undefined;
|
|
674
|
+
}
|
|
675
|
+
/**
|
|
676
|
+
* @public
|
|
677
|
+
*/
|
|
678
|
+
export interface GetSessionEmbedUrlResponse {
|
|
679
|
+
/**
|
|
680
|
+
* <p>A single-use URL that you can put into your server-side web page to embed your Quick Suite session. This URL is valid for 5 minutes. The API operation provides the
|
|
681
|
+
* URL with an <code>auth_code</code> value that enables one (and only one) sign-on to a
|
|
682
|
+
* user session that is valid for 10 hours. </p>
|
|
683
|
+
* @public
|
|
684
|
+
*/
|
|
685
|
+
EmbedUrl?: string | undefined;
|
|
686
|
+
/**
|
|
687
|
+
* <p>The HTTP status of the request.</p>
|
|
688
|
+
* @public
|
|
689
|
+
*/
|
|
690
|
+
Status?: number | undefined;
|
|
691
|
+
/**
|
|
692
|
+
* <p>The Amazon Web Services request ID for this operation.</p>
|
|
693
|
+
* @public
|
|
694
|
+
*/
|
|
695
|
+
RequestId?: string | undefined;
|
|
696
|
+
}
|
|
697
|
+
/**
|
|
698
|
+
* @public
|
|
699
|
+
* @enum
|
|
700
|
+
*/
|
|
701
|
+
export declare const GroupFilterAttribute: {
|
|
702
|
+
readonly GROUP_NAME: "GROUP_NAME";
|
|
703
|
+
};
|
|
704
|
+
/**
|
|
705
|
+
* @public
|
|
706
|
+
*/
|
|
707
|
+
export type GroupFilterAttribute = (typeof GroupFilterAttribute)[keyof typeof GroupFilterAttribute];
|
|
708
|
+
/**
|
|
709
|
+
* @public
|
|
710
|
+
* @enum
|
|
711
|
+
*/
|
|
712
|
+
export declare const GroupFilterOperator: {
|
|
713
|
+
readonly StartsWith: "StartsWith";
|
|
714
|
+
};
|
|
715
|
+
/**
|
|
716
|
+
* @public
|
|
717
|
+
*/
|
|
718
|
+
export type GroupFilterOperator = (typeof GroupFilterOperator)[keyof typeof GroupFilterOperator];
|
|
719
|
+
/**
|
|
720
|
+
* <p>A <code>GroupSearchFilter</code> object that you want to apply to your search.</p>
|
|
721
|
+
* @public
|
|
722
|
+
*/
|
|
723
|
+
export interface GroupSearchFilter {
|
|
724
|
+
/**
|
|
725
|
+
* <p>The comparison operator that you want to use as a filter, for example <code>"Operator":
|
|
726
|
+
* "StartsWith"</code>. Currently, the only supported operator is
|
|
727
|
+
* <code>StartsWith</code>.</p>
|
|
728
|
+
* @public
|
|
729
|
+
*/
|
|
730
|
+
Operator: GroupFilterOperator | undefined;
|
|
731
|
+
/**
|
|
732
|
+
* <p>The name of the value that you want to use as a filter, for example <code>"Name":
|
|
733
|
+
* "GROUP_NAME"</code>. Currently, the only supported name is
|
|
734
|
+
* <code>GROUP_NAME</code>.</p>
|
|
735
|
+
* @public
|
|
736
|
+
*/
|
|
737
|
+
Name: GroupFilterAttribute | undefined;
|
|
738
|
+
/**
|
|
739
|
+
* <p>The value of the named item, in this case <code>GROUP_NAME</code>, that you want to use as a filter.</p>
|
|
740
|
+
* @public
|
|
741
|
+
*/
|
|
742
|
+
Value: string | undefined;
|
|
743
|
+
}
|
|
744
|
+
/**
|
|
745
|
+
* <p>IAM policy assignment summary.</p>
|
|
746
|
+
* @public
|
|
747
|
+
*/
|
|
748
|
+
export interface IAMPolicyAssignmentSummary {
|
|
749
|
+
/**
|
|
750
|
+
* <p>Assignment name.</p>
|
|
751
|
+
* @public
|
|
752
|
+
*/
|
|
753
|
+
AssignmentName?: string | undefined;
|
|
754
|
+
/**
|
|
755
|
+
* <p>Assignment status.</p>
|
|
756
|
+
* @public
|
|
757
|
+
*/
|
|
758
|
+
AssignmentStatus?: AssignmentStatus | undefined;
|
|
759
|
+
}
|
|
760
|
+
/**
|
|
761
|
+
* @public
|
|
762
|
+
* @enum
|
|
763
|
+
*/
|
|
764
|
+
export declare const IncludeGeneratedAnswer: {
|
|
765
|
+
readonly EXCLUDE: "EXCLUDE";
|
|
766
|
+
readonly INCLUDE: "INCLUDE";
|
|
767
|
+
};
|
|
768
|
+
/**
|
|
769
|
+
* @public
|
|
770
|
+
*/
|
|
771
|
+
export type IncludeGeneratedAnswer = (typeof IncludeGeneratedAnswer)[keyof typeof IncludeGeneratedAnswer];
|
|
772
|
+
/**
|
|
773
|
+
* @public
|
|
774
|
+
* @enum
|
|
775
|
+
*/
|
|
776
|
+
export declare const IncludeQuickSightQIndex: {
|
|
777
|
+
readonly EXCLUDE: "EXCLUDE";
|
|
778
|
+
readonly INCLUDE: "INCLUDE";
|
|
779
|
+
};
|
|
780
|
+
/**
|
|
781
|
+
* @public
|
|
782
|
+
*/
|
|
783
|
+
export type IncludeQuickSightQIndex = (typeof IncludeQuickSightQIndex)[keyof typeof IncludeQuickSightQIndex];
|
|
784
|
+
/**
|
|
785
|
+
* @public
|
|
786
|
+
*/
|
|
787
|
+
export interface ListActionConnectorsRequest {
|
|
788
|
+
/**
|
|
789
|
+
* <p>The Amazon Web Services account ID for which to list action connectors.</p>
|
|
790
|
+
* @public
|
|
791
|
+
*/
|
|
792
|
+
AwsAccountId: string | undefined;
|
|
793
|
+
/**
|
|
794
|
+
* <p>The maximum number of action connectors to return in a single response. Valid range is 1 to 100.</p>
|
|
795
|
+
* @public
|
|
796
|
+
*/
|
|
797
|
+
MaxResults?: number | undefined;
|
|
798
|
+
/**
|
|
799
|
+
* <p>A pagination token to retrieve the next set of results. Use the token returned from a previous call to continue listing action connectors.</p>
|
|
800
|
+
* @public
|
|
801
|
+
*/
|
|
802
|
+
NextToken?: string | undefined;
|
|
803
|
+
}
|
|
804
|
+
/**
|
|
805
|
+
* @public
|
|
806
|
+
*/
|
|
807
|
+
export interface ListActionConnectorsResponse {
|
|
808
|
+
/**
|
|
809
|
+
* <p>A list of action connector summaries containing basic information about each connector.</p>
|
|
810
|
+
* @public
|
|
811
|
+
*/
|
|
812
|
+
ActionConnectorSummaries: ActionConnectorSummary[] | undefined;
|
|
813
|
+
/**
|
|
814
|
+
* <p>A pagination token to retrieve the next set of results. If null, there are no more results to retrieve.</p>
|
|
815
|
+
* @public
|
|
816
|
+
*/
|
|
817
|
+
NextToken?: string | undefined;
|
|
818
|
+
/**
|
|
819
|
+
* <p>The Amazon Web Services request ID for this operation.</p>
|
|
820
|
+
* @public
|
|
821
|
+
*/
|
|
822
|
+
RequestId?: string | undefined;
|
|
823
|
+
/**
|
|
824
|
+
* <p>The HTTP status code of the request.</p>
|
|
825
|
+
* @public
|
|
826
|
+
*/
|
|
827
|
+
Status?: number | undefined;
|
|
828
|
+
}
|
|
829
|
+
/**
|
|
830
|
+
* @public
|
|
831
|
+
*/
|
|
832
|
+
export interface ListAnalysesRequest {
|
|
833
|
+
/**
|
|
834
|
+
* <p>The ID of the Amazon Web Services account that contains the analyses.</p>
|
|
835
|
+
* @public
|
|
836
|
+
*/
|
|
837
|
+
AwsAccountId: string | undefined;
|
|
838
|
+
/**
|
|
839
|
+
* <p>A pagination token that can be used in a subsequent request.</p>
|
|
840
|
+
* @public
|
|
841
|
+
*/
|
|
842
|
+
NextToken?: string | undefined;
|
|
843
|
+
/**
|
|
844
|
+
* <p>The maximum number of results to return.</p>
|
|
845
|
+
* @public
|
|
846
|
+
*/
|
|
847
|
+
MaxResults?: number | undefined;
|
|
848
|
+
}
|
|
849
|
+
/**
|
|
850
|
+
* @public
|
|
851
|
+
*/
|
|
852
|
+
export interface ListAnalysesResponse {
|
|
853
|
+
/**
|
|
854
|
+
* <p>Metadata describing each of the analyses that are listed.</p>
|
|
855
|
+
* @public
|
|
856
|
+
*/
|
|
857
|
+
AnalysisSummaryList?: AnalysisSummary[] | undefined;
|
|
858
|
+
/**
|
|
859
|
+
* <p>A pagination token that can be used in a subsequent request.</p>
|
|
860
|
+
* @public
|
|
861
|
+
*/
|
|
862
|
+
NextToken?: string | undefined;
|
|
863
|
+
/**
|
|
864
|
+
* <p>The HTTP status of the request.</p>
|
|
865
|
+
* @public
|
|
866
|
+
*/
|
|
867
|
+
Status?: number | undefined;
|
|
868
|
+
/**
|
|
869
|
+
* <p>The Amazon Web Services request ID for this operation.</p>
|
|
870
|
+
* @public
|
|
871
|
+
*/
|
|
872
|
+
RequestId?: string | undefined;
|
|
873
|
+
}
|
|
874
|
+
/**
|
|
875
|
+
* @public
|
|
876
|
+
*/
|
|
877
|
+
export interface ListAssetBundleExportJobsRequest {
|
|
878
|
+
/**
|
|
879
|
+
* <p>The ID of the Amazon Web Services account that the export jobs were executed in. </p>
|
|
880
|
+
* @public
|
|
881
|
+
*/
|
|
882
|
+
AwsAccountId: string | undefined;
|
|
883
|
+
/**
|
|
884
|
+
* <p>The token for the next set of results, or null if there are no more results.</p>
|
|
885
|
+
* @public
|
|
886
|
+
*/
|
|
887
|
+
NextToken?: string | undefined;
|
|
888
|
+
/**
|
|
889
|
+
* <p>The maximum number of results to be returned per request.</p>
|
|
890
|
+
* @public
|
|
891
|
+
*/
|
|
892
|
+
MaxResults?: number | undefined;
|
|
893
|
+
}
|
|
894
|
+
/**
|
|
895
|
+
* @public
|
|
896
|
+
*/
|
|
897
|
+
export interface ListAssetBundleExportJobsResponse {
|
|
898
|
+
/**
|
|
899
|
+
* <p>A list of export job summaries.</p>
|
|
900
|
+
* @public
|
|
901
|
+
*/
|
|
902
|
+
AssetBundleExportJobSummaryList?: AssetBundleExportJobSummary[] | undefined;
|
|
903
|
+
/**
|
|
904
|
+
* <p>The token for the next set of results, or null if there are no more results.</p>
|
|
905
|
+
* @public
|
|
906
|
+
*/
|
|
907
|
+
NextToken?: string | undefined;
|
|
908
|
+
/**
|
|
909
|
+
* <p>The Amazon Web Services request ID for this operation.</p>
|
|
910
|
+
* @public
|
|
911
|
+
*/
|
|
912
|
+
RequestId?: string | undefined;
|
|
913
|
+
/**
|
|
914
|
+
* <p>The HTTP status of the request.</p>
|
|
915
|
+
* @public
|
|
916
|
+
*/
|
|
917
|
+
Status?: number | undefined;
|
|
918
|
+
}
|
|
919
|
+
/**
|
|
920
|
+
* @public
|
|
921
|
+
*/
|
|
922
|
+
export interface ListAssetBundleImportJobsRequest {
|
|
923
|
+
/**
|
|
924
|
+
* <p>The ID of the Amazon Web Services account that the import jobs were executed in.</p>
|
|
925
|
+
* @public
|
|
926
|
+
*/
|
|
927
|
+
AwsAccountId: string | undefined;
|
|
928
|
+
/**
|
|
929
|
+
* <p>The token for the next set of results, or null if there are no more results.</p>
|
|
930
|
+
* @public
|
|
931
|
+
*/
|
|
932
|
+
NextToken?: string | undefined;
|
|
933
|
+
/**
|
|
934
|
+
* <p>The maximum number of results to be returned per request.</p>
|
|
935
|
+
* @public
|
|
936
|
+
*/
|
|
937
|
+
MaxResults?: number | undefined;
|
|
938
|
+
}
|
|
939
|
+
/**
|
|
940
|
+
* @public
|
|
941
|
+
*/
|
|
942
|
+
export interface ListAssetBundleImportJobsResponse {
|
|
943
|
+
/**
|
|
944
|
+
* <p>A list of import job summaries.</p>
|
|
945
|
+
* @public
|
|
946
|
+
*/
|
|
947
|
+
AssetBundleImportJobSummaryList?: AssetBundleImportJobSummary[] | undefined;
|
|
948
|
+
/**
|
|
949
|
+
* <p>The token for the next set of results, or null if there are no more results.</p>
|
|
950
|
+
* @public
|
|
951
|
+
*/
|
|
952
|
+
NextToken?: string | undefined;
|
|
953
|
+
/**
|
|
954
|
+
* <p>The Amazon Web Services request ID for this operation.</p>
|
|
955
|
+
* @public
|
|
956
|
+
*/
|
|
957
|
+
RequestId?: string | undefined;
|
|
958
|
+
/**
|
|
959
|
+
* <p>The HTTP status of the response.</p>
|
|
960
|
+
* @public
|
|
961
|
+
*/
|
|
962
|
+
Status?: number | undefined;
|
|
963
|
+
}
|
|
964
|
+
/**
|
|
965
|
+
* @public
|
|
966
|
+
*/
|
|
967
|
+
export interface ListBrandsRequest {
|
|
968
|
+
/**
|
|
969
|
+
* <p>The ID of the Amazon Web Services account that owns the brands that you want to list.</p>
|
|
970
|
+
* @public
|
|
971
|
+
*/
|
|
972
|
+
AwsAccountId: string | undefined;
|
|
973
|
+
/**
|
|
974
|
+
* <p>The maximum number of results to be returned in a single request.</p>
|
|
975
|
+
* @public
|
|
976
|
+
*/
|
|
977
|
+
MaxResults?: number | undefined;
|
|
978
|
+
/**
|
|
979
|
+
* <p>The token for the next set of results, or null if there are no more results.</p>
|
|
980
|
+
* @public
|
|
981
|
+
*/
|
|
982
|
+
NextToken?: string | undefined;
|
|
983
|
+
}
|
|
984
|
+
/**
|
|
985
|
+
* @public
|
|
986
|
+
*/
|
|
987
|
+
export interface ListBrandsResponse {
|
|
988
|
+
/**
|
|
989
|
+
* <p>The token for the next set of results, or null if there are no more results.</p>
|
|
990
|
+
* @public
|
|
991
|
+
*/
|
|
992
|
+
NextToken?: string | undefined;
|
|
993
|
+
/**
|
|
994
|
+
* <p>A list of all brands in your Amazon Web Services account. This structure provides basic
|
|
995
|
+
* information about each brand.</p>
|
|
996
|
+
* @public
|
|
997
|
+
*/
|
|
998
|
+
Brands?: BrandSummary[] | undefined;
|
|
999
|
+
}
|
|
1000
|
+
/**
|
|
1001
|
+
* @public
|
|
1002
|
+
*/
|
|
1003
|
+
export interface ListCustomPermissionsRequest {
|
|
1004
|
+
/**
|
|
1005
|
+
* <p>The ID of the Amazon Web Services account that contains the custom permissions profiles that you want to list.</p>
|
|
1006
|
+
* @public
|
|
1007
|
+
*/
|
|
1008
|
+
AwsAccountId: string | undefined;
|
|
1009
|
+
/**
|
|
1010
|
+
* <p>The maximum number of results to return.</p>
|
|
1011
|
+
* @public
|
|
1012
|
+
*/
|
|
1013
|
+
MaxResults?: number | undefined;
|
|
1014
|
+
/**
|
|
1015
|
+
* <p>The token for the next set of results, or null if there are no more results.</p>
|
|
1016
|
+
* @public
|
|
1017
|
+
*/
|
|
1018
|
+
NextToken?: string | undefined;
|
|
1019
|
+
}
|
|
1020
|
+
/**
|
|
1021
|
+
* @public
|
|
1022
|
+
*/
|
|
1023
|
+
export interface ListCustomPermissionsResponse {
|
|
1024
|
+
/**
|
|
1025
|
+
* <p>The HTTP status of the request.</p>
|
|
1026
|
+
* @public
|
|
1027
|
+
*/
|
|
1028
|
+
Status?: number | undefined;
|
|
1029
|
+
/**
|
|
1030
|
+
* <p>A list of custom permissions profiles.</p>
|
|
1031
|
+
* @public
|
|
1032
|
+
*/
|
|
1033
|
+
CustomPermissionsList?: CustomPermissions[] | undefined;
|
|
1034
|
+
/**
|
|
1035
|
+
* <p>The token for the next set of results, or null if there are no more results.</p>
|
|
1036
|
+
* @public
|
|
1037
|
+
*/
|
|
1038
|
+
NextToken?: string | undefined;
|
|
1039
|
+
/**
|
|
1040
|
+
* <p>The Amazon Web Services request ID for this operation.</p>
|
|
1041
|
+
* @public
|
|
1042
|
+
*/
|
|
1043
|
+
RequestId?: string | undefined;
|
|
1044
|
+
}
|
|
1045
|
+
/**
|
|
1046
|
+
* @public
|
|
1047
|
+
*/
|
|
1048
|
+
export interface ListDashboardsRequest {
|
|
1049
|
+
/**
|
|
1050
|
+
* <p>The ID of the Amazon Web Services account that contains the dashboards that you're
|
|
1051
|
+
* listing.</p>
|
|
1052
|
+
* @public
|
|
1053
|
+
*/
|
|
1054
|
+
AwsAccountId: string | undefined;
|
|
1055
|
+
/**
|
|
1056
|
+
* <p>The token for the next set of results, or null if there are no more results.</p>
|
|
1057
|
+
* @public
|
|
1058
|
+
*/
|
|
1059
|
+
NextToken?: string | undefined;
|
|
1060
|
+
/**
|
|
1061
|
+
* <p>The maximum number of results to be returned per request.</p>
|
|
1062
|
+
* @public
|
|
1063
|
+
*/
|
|
1064
|
+
MaxResults?: number | undefined;
|
|
1065
|
+
}
|
|
1066
|
+
/**
|
|
1067
|
+
* @public
|
|
1068
|
+
*/
|
|
1069
|
+
export interface ListDashboardsResponse {
|
|
1070
|
+
/**
|
|
1071
|
+
* <p>A structure that contains all of the dashboards in your Amazon Web Services account.
|
|
1072
|
+
* This structure provides basic information about the dashboards.</p>
|
|
1073
|
+
* @public
|
|
1074
|
+
*/
|
|
1075
|
+
DashboardSummaryList?: DashboardSummary[] | undefined;
|
|
1076
|
+
/**
|
|
1077
|
+
* <p>The token for the next set of results, or null if there are no more results.</p>
|
|
1078
|
+
* @public
|
|
1079
|
+
*/
|
|
1080
|
+
NextToken?: string | undefined;
|
|
1081
|
+
/**
|
|
1082
|
+
* <p>The HTTP status of the request.</p>
|
|
1083
|
+
* @public
|
|
1084
|
+
*/
|
|
1085
|
+
Status?: number | undefined;
|
|
1086
|
+
/**
|
|
1087
|
+
* <p>The Amazon Web Services request ID for this operation.</p>
|
|
1088
|
+
* @public
|
|
1089
|
+
*/
|
|
1090
|
+
RequestId?: string | undefined;
|
|
1091
|
+
}
|
|
1092
|
+
/**
|
|
1093
|
+
* @public
|
|
1094
|
+
*/
|
|
1095
|
+
export interface ListDashboardVersionsRequest {
|
|
1096
|
+
/**
|
|
1097
|
+
* <p>The ID of the Amazon Web Services account that contains the dashboard that you're
|
|
1098
|
+
* listing versions for.</p>
|
|
1099
|
+
* @public
|
|
1100
|
+
*/
|
|
1101
|
+
AwsAccountId: string | undefined;
|
|
1102
|
+
/**
|
|
1103
|
+
* <p>The ID for the dashboard.</p>
|
|
1104
|
+
* @public
|
|
1105
|
+
*/
|
|
1106
|
+
DashboardId: string | undefined;
|
|
1107
|
+
/**
|
|
1108
|
+
* <p>The token for the next set of results, or null if there are no more results.</p>
|
|
1109
|
+
* @public
|
|
1110
|
+
*/
|
|
1111
|
+
NextToken?: string | undefined;
|
|
1112
|
+
/**
|
|
1113
|
+
* <p>The maximum number of results to be returned per request.</p>
|
|
1114
|
+
* @public
|
|
1115
|
+
*/
|
|
1116
|
+
MaxResults?: number | undefined;
|
|
1117
|
+
}
|
|
1118
|
+
/**
|
|
1119
|
+
* @public
|
|
1120
|
+
*/
|
|
1121
|
+
export interface ListDashboardVersionsResponse {
|
|
1122
|
+
/**
|
|
1123
|
+
* <p>A structure that contains information about each version of the dashboard.</p>
|
|
1124
|
+
* @public
|
|
1125
|
+
*/
|
|
1126
|
+
DashboardVersionSummaryList?: DashboardVersionSummary[] | undefined;
|
|
1127
|
+
/**
|
|
1128
|
+
* <p>The token for the next set of results, or null if there are no more results.</p>
|
|
1129
|
+
* @public
|
|
1130
|
+
*/
|
|
1131
|
+
NextToken?: string | undefined;
|
|
1132
|
+
/**
|
|
1133
|
+
* <p>The HTTP status of the request.</p>
|
|
1134
|
+
* @public
|
|
1135
|
+
*/
|
|
1136
|
+
Status?: number | undefined;
|
|
1137
|
+
/**
|
|
1138
|
+
* <p>The Amazon Web Services request ID for this operation.</p>
|
|
1139
|
+
* @public
|
|
1140
|
+
*/
|
|
1141
|
+
RequestId?: string | undefined;
|
|
1142
|
+
}
|
|
1143
|
+
/**
|
|
1144
|
+
* @public
|
|
1145
|
+
*/
|
|
1146
|
+
export interface ListDataSetsRequest {
|
|
1147
|
+
/**
|
|
1148
|
+
* <p>The Amazon Web Services account ID.</p>
|
|
1149
|
+
* @public
|
|
1150
|
+
*/
|
|
1151
|
+
AwsAccountId: string | undefined;
|
|
1152
|
+
/**
|
|
1153
|
+
* <p>The token for the next set of results, or null if there are no more results.</p>
|
|
1154
|
+
* @public
|
|
1155
|
+
*/
|
|
1156
|
+
NextToken?: string | undefined;
|
|
1157
|
+
/**
|
|
1158
|
+
* <p>The maximum number of results to be returned per request.</p>
|
|
1159
|
+
* @public
|
|
1160
|
+
*/
|
|
1161
|
+
MaxResults?: number | undefined;
|
|
1162
|
+
}
|
|
1163
|
+
/**
|
|
1164
|
+
* @public
|
|
1165
|
+
*/
|
|
1166
|
+
export interface ListDataSetsResponse {
|
|
1167
|
+
/**
|
|
1168
|
+
* <p>The list of dataset summaries.</p>
|
|
1169
|
+
* @public
|
|
1170
|
+
*/
|
|
1171
|
+
DataSetSummaries?: DataSetSummary[] | undefined;
|
|
1172
|
+
/**
|
|
1173
|
+
* <p>The token for the next set of results, or null if there are no more results.</p>
|
|
1174
|
+
* @public
|
|
1175
|
+
*/
|
|
1176
|
+
NextToken?: string | undefined;
|
|
1177
|
+
/**
|
|
1178
|
+
* <p>The Amazon Web Services request ID for this operation.</p>
|
|
1179
|
+
* @public
|
|
1180
|
+
*/
|
|
1181
|
+
RequestId?: string | undefined;
|
|
1182
|
+
/**
|
|
1183
|
+
* <p>The HTTP status of the request.</p>
|
|
1184
|
+
* @public
|
|
1185
|
+
*/
|
|
1186
|
+
Status?: number | undefined;
|
|
1187
|
+
}
|
|
1188
|
+
/**
|
|
1189
|
+
* @public
|
|
1190
|
+
*/
|
|
1191
|
+
export interface ListDataSourcesRequest {
|
|
1192
|
+
/**
|
|
1193
|
+
* <p>The Amazon Web Services account ID.</p>
|
|
1194
|
+
* @public
|
|
1195
|
+
*/
|
|
1196
|
+
AwsAccountId: string | undefined;
|
|
1197
|
+
/**
|
|
1198
|
+
* <p>The token for the next set of results, or null if there are no more results.</p>
|
|
1199
|
+
* @public
|
|
1200
|
+
*/
|
|
1201
|
+
NextToken?: string | undefined;
|
|
1202
|
+
/**
|
|
1203
|
+
* <p>The maximum number of results to be returned per request.</p>
|
|
1204
|
+
* @public
|
|
1205
|
+
*/
|
|
1206
|
+
MaxResults?: number | undefined;
|
|
1207
|
+
}
|
|
1208
|
+
/**
|
|
1209
|
+
* @public
|
|
1210
|
+
*/
|
|
1211
|
+
export interface ListDataSourcesResponse {
|
|
1212
|
+
/**
|
|
1213
|
+
* <p>A list of data sources.</p>
|
|
1214
|
+
* @public
|
|
1215
|
+
*/
|
|
1216
|
+
DataSources?: DataSource[] | undefined;
|
|
1217
|
+
/**
|
|
1218
|
+
* <p>The token for the next set of results, or null if there are no more results.</p>
|
|
1219
|
+
* @public
|
|
1220
|
+
*/
|
|
1221
|
+
NextToken?: string | undefined;
|
|
1222
|
+
/**
|
|
1223
|
+
* <p>The Amazon Web Services request ID for this operation.</p>
|
|
1224
|
+
* @public
|
|
1225
|
+
*/
|
|
1226
|
+
RequestId?: string | undefined;
|
|
1227
|
+
/**
|
|
1228
|
+
* <p>The HTTP status of the request.</p>
|
|
1229
|
+
* @public
|
|
1230
|
+
*/
|
|
1231
|
+
Status?: number | undefined;
|
|
1232
|
+
}
|
|
1233
|
+
/**
|
|
1234
|
+
* @public
|
|
1235
|
+
*/
|
|
1236
|
+
export interface ListFlowsInput {
|
|
1237
|
+
/**
|
|
1238
|
+
* <p>The ID of the Amazon Web Services account that contains the flow list that you are getting.</p>
|
|
1239
|
+
* @public
|
|
1240
|
+
*/
|
|
1241
|
+
AwsAccountId: string | undefined;
|
|
1242
|
+
/**
|
|
1243
|
+
* <p>The token to request the next set of results, or null if you want to retrieve the first set.</p>
|
|
1244
|
+
* @public
|
|
1245
|
+
*/
|
|
1246
|
+
NextToken?: string | undefined;
|
|
1247
|
+
/**
|
|
1248
|
+
* <p>The maximum number of results to be returned per request.</p>
|
|
1249
|
+
* @public
|
|
1250
|
+
*/
|
|
1251
|
+
MaxResults?: number | undefined;
|
|
1252
|
+
}
|
|
1253
|
+
/**
|
|
1254
|
+
* @public
|
|
1255
|
+
*/
|
|
1256
|
+
export interface ListFlowsOutput {
|
|
1257
|
+
/**
|
|
1258
|
+
* <p>A structure that contains all of the flows in your Amazon Web Services account. This structure
|
|
1259
|
+
* provides basic information about the flows.</p>
|
|
1260
|
+
* @public
|
|
1261
|
+
*/
|
|
1262
|
+
FlowSummaryList?: FlowSummary[] | undefined;
|
|
1263
|
+
/**
|
|
1264
|
+
* <p>The token for the next set of results, or null if there are no more results.</p>
|
|
1265
|
+
* @public
|
|
1266
|
+
*/
|
|
1267
|
+
NextToken?: string | undefined;
|
|
1268
|
+
/**
|
|
1269
|
+
* <p>The Amazon Web Services request ID for this operation.</p>
|
|
1270
|
+
* @public
|
|
1271
|
+
*/
|
|
1272
|
+
RequestId?: string | undefined;
|
|
1273
|
+
/**
|
|
1274
|
+
* <p>The HTTP status of the request.</p>
|
|
1275
|
+
* @public
|
|
1276
|
+
*/
|
|
1277
|
+
Status?: number | undefined;
|
|
1278
|
+
}
|
|
1279
|
+
/**
|
|
1280
|
+
* @public
|
|
1281
|
+
*/
|
|
1282
|
+
export interface ListFolderMembersRequest {
|
|
1283
|
+
/**
|
|
1284
|
+
* <p>The ID for the Amazon Web Services account that contains the folder.</p>
|
|
1285
|
+
* @public
|
|
1286
|
+
*/
|
|
1287
|
+
AwsAccountId: string | undefined;
|
|
1288
|
+
/**
|
|
1289
|
+
* <p>The ID of the folder.</p>
|
|
1290
|
+
* @public
|
|
1291
|
+
*/
|
|
1292
|
+
FolderId: string | undefined;
|
|
1293
|
+
/**
|
|
1294
|
+
* <p>The token for the next set of results, or null if there are no more results.</p>
|
|
1295
|
+
* @public
|
|
1296
|
+
*/
|
|
1297
|
+
NextToken?: string | undefined;
|
|
1298
|
+
/**
|
|
1299
|
+
* <p>The maximum number of results to be returned per request.</p>
|
|
1300
|
+
* @public
|
|
1301
|
+
*/
|
|
1302
|
+
MaxResults?: number | undefined;
|
|
1303
|
+
}
|
|
1304
|
+
/**
|
|
1305
|
+
* @public
|
|
1306
|
+
*/
|
|
1307
|
+
export interface ListFolderMembersResponse {
|
|
1308
|
+
/**
|
|
1309
|
+
* <p>The HTTP status of the request.</p>
|
|
1310
|
+
* @public
|
|
1311
|
+
*/
|
|
1312
|
+
Status?: number | undefined;
|
|
1313
|
+
/**
|
|
1314
|
+
* <p>A structure that contains all of the folder members (dashboards, analyses, and datasets) in the folder.</p>
|
|
1315
|
+
* @public
|
|
1316
|
+
*/
|
|
1317
|
+
FolderMemberList?: MemberIdArnPair[] | undefined;
|
|
1318
|
+
/**
|
|
1319
|
+
* <p>The token for the next set of results, or null if there are no more results.</p>
|
|
1320
|
+
* @public
|
|
1321
|
+
*/
|
|
1322
|
+
NextToken?: string | undefined;
|
|
1323
|
+
/**
|
|
1324
|
+
* <p>The Amazon Web Services request ID for this operation.</p>
|
|
1325
|
+
* @public
|
|
1326
|
+
*/
|
|
1327
|
+
RequestId?: string | undefined;
|
|
1328
|
+
}
|
|
1329
|
+
/**
|
|
1330
|
+
* @public
|
|
1331
|
+
*/
|
|
1332
|
+
export interface ListFoldersRequest {
|
|
1333
|
+
/**
|
|
1334
|
+
* <p>The ID for the Amazon Web Services account that contains the folder.</p>
|
|
1335
|
+
* @public
|
|
1336
|
+
*/
|
|
1337
|
+
AwsAccountId: string | undefined;
|
|
1338
|
+
/**
|
|
1339
|
+
* <p>The token for the next set of results, or null if there are no more results.</p>
|
|
1340
|
+
* @public
|
|
1341
|
+
*/
|
|
1342
|
+
NextToken?: string | undefined;
|
|
1343
|
+
/**
|
|
1344
|
+
* <p>The maximum number of results to be returned per request.</p>
|
|
1345
|
+
* @public
|
|
1346
|
+
*/
|
|
1347
|
+
MaxResults?: number | undefined;
|
|
1348
|
+
}
|
|
1349
|
+
/**
|
|
1350
|
+
* @public
|
|
1351
|
+
*/
|
|
1352
|
+
export interface ListFoldersResponse {
|
|
1353
|
+
/**
|
|
1354
|
+
* <p>The HTTP status of the request.</p>
|
|
1355
|
+
* @public
|
|
1356
|
+
*/
|
|
1357
|
+
Status?: number | undefined;
|
|
1358
|
+
/**
|
|
1359
|
+
* <p>A structure that contains all of the folders in the Amazon Web Services account. This structure provides basic information about the folders.</p>
|
|
1360
|
+
* @public
|
|
1361
|
+
*/
|
|
1362
|
+
FolderSummaryList?: FolderSummary[] | undefined;
|
|
1363
|
+
/**
|
|
1364
|
+
* <p>The token for the next set of results, or null if there are no more results.</p>
|
|
1365
|
+
* @public
|
|
1366
|
+
*/
|
|
1367
|
+
NextToken?: string | undefined;
|
|
1368
|
+
/**
|
|
1369
|
+
* <p>The Amazon Web Services request ID for this operation.</p>
|
|
1370
|
+
* @public
|
|
1371
|
+
*/
|
|
1372
|
+
RequestId?: string | undefined;
|
|
1373
|
+
}
|
|
1374
|
+
/**
|
|
1375
|
+
* @public
|
|
1376
|
+
*/
|
|
1377
|
+
export interface ListFoldersForResourceRequest {
|
|
1378
|
+
/**
|
|
1379
|
+
* <p>The ID for the Amazon Web Services account that contains the resource.</p>
|
|
1380
|
+
* @public
|
|
1381
|
+
*/
|
|
1382
|
+
AwsAccountId: string | undefined;
|
|
1383
|
+
/**
|
|
1384
|
+
* <p>The Amazon Resource Name (ARN) the resource whose folders you need to list.</p>
|
|
1385
|
+
* @public
|
|
1386
|
+
*/
|
|
1387
|
+
ResourceArn: string | undefined;
|
|
1388
|
+
/**
|
|
1389
|
+
* <p>The token for the next set of results, or null if there are no more results.</p>
|
|
1390
|
+
* @public
|
|
1391
|
+
*/
|
|
1392
|
+
NextToken?: string | undefined;
|
|
1393
|
+
/**
|
|
1394
|
+
* <p>The maximum number of results to be returned per request.</p>
|
|
1395
|
+
* @public
|
|
1396
|
+
*/
|
|
1397
|
+
MaxResults?: number | undefined;
|
|
1398
|
+
}
|
|
1399
|
+
/**
|
|
1400
|
+
* @public
|
|
1401
|
+
*/
|
|
1402
|
+
export interface ListFoldersForResourceResponse {
|
|
1403
|
+
/**
|
|
1404
|
+
* <p>The HTTP status of the request.</p>
|
|
1405
|
+
* @public
|
|
1406
|
+
*/
|
|
1407
|
+
Status?: number | undefined;
|
|
1408
|
+
/**
|
|
1409
|
+
* <p>A list that contains the Amazon Resource Names (ARNs) of all folders that the resource is a member of.</p>
|
|
1410
|
+
* @public
|
|
1411
|
+
*/
|
|
1412
|
+
Folders?: string[] | undefined;
|
|
1413
|
+
/**
|
|
1414
|
+
* <p>The token for the next set of results, or null if there are no more results.</p>
|
|
1415
|
+
* @public
|
|
1416
|
+
*/
|
|
1417
|
+
NextToken?: string | undefined;
|
|
1418
|
+
/**
|
|
1419
|
+
* <p>The Amazon Web Services request ID for this operation.</p>
|
|
1420
|
+
* @public
|
|
1421
|
+
*/
|
|
1422
|
+
RequestId?: string | undefined;
|
|
1423
|
+
}
|
|
1424
|
+
/**
|
|
1425
|
+
* @public
|
|
1426
|
+
*/
|
|
1427
|
+
export interface ListGroupMembershipsRequest {
|
|
1428
|
+
/**
|
|
1429
|
+
* <p>The name of the group that you want to see a membership list of.</p>
|
|
1430
|
+
* @public
|
|
1431
|
+
*/
|
|
1432
|
+
GroupName: string | undefined;
|
|
1433
|
+
/**
|
|
1434
|
+
* <p>A pagination token that can be used in a subsequent request.</p>
|
|
1435
|
+
* @public
|
|
1436
|
+
*/
|
|
1437
|
+
NextToken?: string | undefined;
|
|
1438
|
+
/**
|
|
1439
|
+
* <p>The maximum number of results to return from this request.</p>
|
|
1440
|
+
* @public
|
|
1441
|
+
*/
|
|
1442
|
+
MaxResults?: number | undefined;
|
|
1443
|
+
/**
|
|
1444
|
+
* <p>The ID for the Amazon Web Services account that the group is in. Currently, you use the ID for the
|
|
1445
|
+
* Amazon Web Services account that contains your Amazon Quick Sight account.</p>
|
|
1446
|
+
* @public
|
|
1447
|
+
*/
|
|
1448
|
+
AwsAccountId: string | undefined;
|
|
1449
|
+
/**
|
|
1450
|
+
* <p>The namespace of the group that you want a list of users from.</p>
|
|
1451
|
+
* @public
|
|
1452
|
+
*/
|
|
1453
|
+
Namespace: string | undefined;
|
|
1454
|
+
}
|
|
1455
|
+
/**
|
|
1456
|
+
* @public
|
|
1457
|
+
*/
|
|
1458
|
+
export interface ListGroupMembershipsResponse {
|
|
1459
|
+
/**
|
|
1460
|
+
* <p>The list of the members of the group.</p>
|
|
1461
|
+
* @public
|
|
1462
|
+
*/
|
|
1463
|
+
GroupMemberList?: GroupMember[] | undefined;
|
|
1464
|
+
/**
|
|
1465
|
+
* <p>A pagination token that can be used in a subsequent request.</p>
|
|
1466
|
+
* @public
|
|
1467
|
+
*/
|
|
1468
|
+
NextToken?: string | undefined;
|
|
1469
|
+
/**
|
|
1470
|
+
* <p>The Amazon Web Services request ID for this operation.</p>
|
|
1471
|
+
* @public
|
|
1472
|
+
*/
|
|
1473
|
+
RequestId?: string | undefined;
|
|
1474
|
+
/**
|
|
1475
|
+
* <p>The HTTP status of the request.</p>
|
|
1476
|
+
* @public
|
|
1477
|
+
*/
|
|
1478
|
+
Status?: number | undefined;
|
|
1479
|
+
}
|
|
1480
|
+
/**
|
|
1481
|
+
* @public
|
|
1482
|
+
*/
|
|
1483
|
+
export interface ListGroupsRequest {
|
|
1484
|
+
/**
|
|
1485
|
+
* <p>The ID for the Amazon Web Services account that the group is in. Currently, you use the ID for the
|
|
1486
|
+
* Amazon Web Services account that contains your Amazon Quick Sight account.</p>
|
|
1487
|
+
* @public
|
|
1488
|
+
*/
|
|
1489
|
+
AwsAccountId: string | undefined;
|
|
1490
|
+
/**
|
|
1491
|
+
* <p>A pagination token that can be used in a subsequent request.</p>
|
|
1492
|
+
* @public
|
|
1493
|
+
*/
|
|
1494
|
+
NextToken?: string | undefined;
|
|
1495
|
+
/**
|
|
1496
|
+
* <p>The maximum number of results to return.</p>
|
|
1497
|
+
* @public
|
|
1498
|
+
*/
|
|
1499
|
+
MaxResults?: number | undefined;
|
|
1500
|
+
/**
|
|
1501
|
+
* <p>The namespace that you want a list of groups from.</p>
|
|
1502
|
+
* @public
|
|
1503
|
+
*/
|
|
1504
|
+
Namespace: string | undefined;
|
|
1505
|
+
}
|
|
5
1506
|
/**
|
|
6
1507
|
* @public
|
|
7
1508
|
*/
|
|
@@ -2406,7 +3907,7 @@ export interface StartAssetBundleImportJobResponse {
|
|
|
2406
3907
|
export interface SnapshotAnonymousUser {
|
|
2407
3908
|
/**
|
|
2408
3909
|
* <p>The tags to be used for row-level security (RLS). Make sure that the relevant datasets have RLS tags configured before you start a snapshot export job. You can configure the RLS tags of a dataset with a <code>DataSet$RowLevelPermissionTagConfiguration</code> API call.</p>
|
|
2409
|
-
* <p>These are not the tags that are used for Amazon Web Services resource tagging. For more information on row level security in Amazon Quick Sight, see <a href="https://docs.aws.amazon.com/quicksight/latest/user/quicksight-dev-rls-tags.html">Using Row-Level Security (RLS) with Tags</a>in the <i>Amazon
|
|
3910
|
+
* <p>These are not the tags that are used for Amazon Web Services resource tagging. For more information on row level security in Amazon Quick Sight, see <a href="https://docs.aws.amazon.com/quicksight/latest/user/quicksight-dev-rls-tags.html">Using Row-Level Security (RLS) with Tags</a>in the <i>Amazon Quick Suite User Guide</i>.</p>
|
|
2410
3911
|
* @public
|
|
2411
3912
|
*/
|
|
2412
3913
|
RowLevelPermissionTags?: SessionTag[] | undefined;
|
|
@@ -2986,7 +4487,7 @@ export interface UpdateApplicationWithTokenExchangeGrantRequest {
|
|
|
2986
4487
|
*/
|
|
2987
4488
|
AwsAccountId: string | undefined;
|
|
2988
4489
|
/**
|
|
2989
|
-
* <p>The namespace of the
|
|
4490
|
+
* <p>The namespace of the Quick Suite application.</p>
|
|
2990
4491
|
* @public
|
|
2991
4492
|
*/
|
|
2992
4493
|
Namespace: string | undefined;
|
|
@@ -3016,7 +4517,7 @@ export interface UpdateBrandRequest {
|
|
|
3016
4517
|
*/
|
|
3017
4518
|
AwsAccountId: string | undefined;
|
|
3018
4519
|
/**
|
|
3019
|
-
* <p>The ID of the
|
|
4520
|
+
* <p>The ID of the Quick Suite brand.</p>
|
|
3020
4521
|
* @public
|
|
3021
4522
|
*/
|
|
3022
4523
|
BrandId: string | undefined;
|
|
@@ -3086,7 +4587,7 @@ export interface UpdateBrandPublishedVersionRequest {
|
|
|
3086
4587
|
*/
|
|
3087
4588
|
AwsAccountId: string | undefined;
|
|
3088
4589
|
/**
|
|
3089
|
-
* <p>The ID of the
|
|
4590
|
+
* <p>The ID of the Quick Suite brand.</p>
|
|
3090
4591
|
* @public
|
|
3091
4592
|
*/
|
|
3092
4593
|
BrandId: string | undefined;
|
|
@@ -3533,7 +5034,9 @@ export interface UpdateDataSetRequest {
|
|
|
3533
5034
|
PhysicalTableMap: Record<string, PhysicalTable> | undefined;
|
|
3534
5035
|
/**
|
|
3535
5036
|
* <p>Configures the combination and transformation of the data from the physical
|
|
3536
|
-
* tables.</p>
|
|
5037
|
+
* tables. This parameter is used with the legacy data preparation experience.</p>
|
|
5038
|
+
*
|
|
5039
|
+
* @deprecated Only used in the legacy data preparation experience.
|
|
3537
5040
|
* @public
|
|
3538
5041
|
*/
|
|
3539
5042
|
LogicalTableMap?: Record<string, LogicalTable> | undefined;
|
|
@@ -3554,13 +5057,19 @@ export interface UpdateDataSetRequest {
|
|
|
3554
5057
|
*/
|
|
3555
5058
|
FieldFolders?: Record<string, FieldFolder> | undefined;
|
|
3556
5059
|
/**
|
|
3557
|
-
* <p>The row-level security configuration for the data you want to create
|
|
5060
|
+
* <p>The row-level security configuration for the data you want to create. This parameter is used
|
|
5061
|
+
* with the legacy data preparation experience.</p>
|
|
5062
|
+
*
|
|
5063
|
+
* @deprecated Only used in the legacy data preparation experience.
|
|
3558
5064
|
* @public
|
|
3559
5065
|
*/
|
|
3560
5066
|
RowLevelPermissionDataSet?: RowLevelPermissionDataSet | undefined;
|
|
3561
5067
|
/**
|
|
3562
5068
|
* <p>The configuration of tags on a dataset to set row-level security. Row-level security
|
|
3563
|
-
* tags are currently supported for anonymous embedding only
|
|
5069
|
+
* tags are currently supported for anonymous embedding only. This parameter is used with
|
|
5070
|
+
* the legacy data preparation experience.</p>
|
|
5071
|
+
*
|
|
5072
|
+
* @deprecated Only used in the legacy data preparation experience.
|
|
3564
5073
|
* @public
|
|
3565
5074
|
*/
|
|
3566
5075
|
RowLevelPermissionTagConfiguration?: RowLevelPermissionTagConfiguration | undefined;
|
|
@@ -3587,6 +5096,20 @@ export interface UpdateDataSetRequest {
|
|
|
3587
5096
|
* @public
|
|
3588
5097
|
*/
|
|
3589
5098
|
PerformanceConfiguration?: PerformanceConfiguration | undefined;
|
|
5099
|
+
/**
|
|
5100
|
+
* <p>The data preparation configuration for the dataset. This configuration defines the source tables,
|
|
5101
|
+
* transformation steps, and destination tables used to prepare the data.
|
|
5102
|
+
* Required when using the new data preparation experience.</p>
|
|
5103
|
+
* @public
|
|
5104
|
+
*/
|
|
5105
|
+
DataPrepConfiguration?: DataPrepConfiguration | undefined;
|
|
5106
|
+
/**
|
|
5107
|
+
* <p>The semantic model configuration for the dataset. This configuration defines how the prepared
|
|
5108
|
+
* data is structured for an analysis, including table mappings and row-level security configurations.
|
|
5109
|
+
* Required when using the new data preparation experience.</p>
|
|
5110
|
+
* @public
|
|
5111
|
+
*/
|
|
5112
|
+
SemanticModelConfiguration?: SemanticModelConfiguration | undefined;
|
|
3590
5113
|
}
|
|
3591
5114
|
/**
|
|
3592
5115
|
* @public
|
|
@@ -3598,7 +5121,7 @@ export interface UpdateDataSetResponse {
|
|
|
3598
5121
|
*/
|
|
3599
5122
|
Arn?: string | undefined;
|
|
3600
5123
|
/**
|
|
3601
|
-
* <p>The ID for the dataset that you want to
|
|
5124
|
+
* <p>The ID for the dataset that you want to update. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.</p>
|
|
3602
5125
|
* @public
|
|
3603
5126
|
*/
|
|
3604
5127
|
DataSetId?: string | undefined;
|
|
@@ -4305,7 +5828,7 @@ export interface UpdatePublicSharingSettingsRequest {
|
|
|
4305
5828
|
*/
|
|
4306
5829
|
AwsAccountId: string | undefined;
|
|
4307
5830
|
/**
|
|
4308
|
-
* <p>A Boolean value that indicates whether public sharing is turned on for an
|
|
5831
|
+
* <p>A Boolean value that indicates whether public sharing is turned on for an Quick Suite account.</p>
|
|
4309
5832
|
* @public
|
|
4310
5833
|
*/
|
|
4311
5834
|
PublicSharingEnabled?: boolean | undefined;
|
|
@@ -5477,6 +7000,26 @@ export interface ListTopicReviewedAnswersResponse {
|
|
|
5477
7000
|
*/
|
|
5478
7001
|
RequestId?: string | undefined;
|
|
5479
7002
|
}
|
|
7003
|
+
/**
|
|
7004
|
+
* @internal
|
|
7005
|
+
*/
|
|
7006
|
+
export declare const GenerateEmbedUrlForRegisteredUserResponseFilterSensitiveLog: (obj: GenerateEmbedUrlForRegisteredUserResponse) => any;
|
|
7007
|
+
/**
|
|
7008
|
+
* @internal
|
|
7009
|
+
*/
|
|
7010
|
+
export declare const GenerateEmbedUrlForRegisteredUserWithIdentityResponseFilterSensitiveLog: (obj: GenerateEmbedUrlForRegisteredUserWithIdentityResponse) => any;
|
|
7011
|
+
/**
|
|
7012
|
+
* @internal
|
|
7013
|
+
*/
|
|
7014
|
+
export declare const GetDashboardEmbedUrlResponseFilterSensitiveLog: (obj: GetDashboardEmbedUrlResponse) => any;
|
|
7015
|
+
/**
|
|
7016
|
+
* @internal
|
|
7017
|
+
*/
|
|
7018
|
+
export declare const GetSessionEmbedUrlResponseFilterSensitiveLog: (obj: GetSessionEmbedUrlResponse) => any;
|
|
7019
|
+
/**
|
|
7020
|
+
* @internal
|
|
7021
|
+
*/
|
|
7022
|
+
export declare const ListActionConnectorsResponseFilterSensitiveLog: (obj: ListActionConnectorsResponse) => any;
|
|
5480
7023
|
/**
|
|
5481
7024
|
* @internal
|
|
5482
7025
|
*/
|