@aws-sdk/client-quicksight 3.886.0 → 3.887.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +24 -0
- package/dist-cjs/index.js +175 -16
- package/dist-es/QuickSight.js +6 -0
- package/dist-es/commands/DeleteAccountCustomPermissionCommand.js +22 -0
- package/dist-es/commands/DescribeAccountCustomPermissionCommand.js +22 -0
- package/dist-es/commands/UpdateAccountCustomPermissionCommand.js +22 -0
- package/dist-es/commands/index.js +3 -0
- package/dist-es/models/models_2.js +2 -0
- package/dist-es/models/models_3.js +12 -0
- package/dist-es/models/models_4.js +4 -13
- package/dist-es/models/models_5.js +13 -0
- package/dist-es/protocols/Aws_restJson1.js +79 -0
- package/dist-types/QuickSight.d.ts +21 -0
- package/dist-types/QuickSightClient.d.ts +5 -2
- package/dist-types/commands/CreateAccountCustomizationCommand.d.ts +2 -2
- package/dist-types/commands/CreateAccountSubscriptionCommand.d.ts +9 -9
- package/dist-types/commands/CreateAnalysisCommand.d.ts +1 -1
- package/dist-types/commands/CreateBrandCommand.d.ts +1 -1
- package/dist-types/commands/CreateCustomPermissionsCommand.d.ts +2 -0
- package/dist-types/commands/CreateDashboardCommand.d.ts +9 -3
- package/dist-types/commands/CreateDataSetCommand.d.ts +1 -1
- package/dist-types/commands/CreateDataSourceCommand.d.ts +8 -2
- package/dist-types/commands/CreateFolderCommand.d.ts +1 -1
- package/dist-types/commands/CreateFolderMembershipCommand.d.ts +1 -1
- package/dist-types/commands/CreateGroupCommand.d.ts +1 -1
- package/dist-types/commands/CreateNamespaceCommand.d.ts +3 -3
- package/dist-types/commands/CreateRoleMembershipCommand.d.ts +1 -1
- package/dist-types/commands/CreateTemplateAliasCommand.d.ts +1 -1
- package/dist-types/commands/CreateTemplateCommand.d.ts +3 -3
- package/dist-types/commands/CreateThemeAliasCommand.d.ts +1 -1
- package/dist-types/commands/CreateThemeCommand.d.ts +1 -1
- package/dist-types/commands/CreateTopicCommand.d.ts +9 -1
- package/dist-types/commands/CreateVPCConnectionCommand.d.ts +1 -1
- package/dist-types/commands/DeleteAccountCustomPermissionCommand.d.ts +91 -0
- package/dist-types/commands/DeleteAccountCustomizationCommand.d.ts +1 -1
- package/dist-types/commands/DeleteAccountSubscriptionCommand.d.ts +1 -1
- package/dist-types/commands/DeleteAnalysisCommand.d.ts +4 -4
- package/dist-types/commands/DeleteBrandCommand.d.ts +1 -1
- package/dist-types/commands/DeleteDashboardCommand.d.ts +1 -1
- package/dist-types/commands/DeleteDefaultQBusinessApplicationCommand.d.ts +1 -1
- package/dist-types/commands/DeleteFolderCommand.d.ts +1 -1
- package/dist-types/commands/DeleteFolderMembershipCommand.d.ts +1 -1
- package/dist-types/commands/DeleteIdentityPropagationConfigCommand.d.ts +2 -2
- package/dist-types/commands/DeleteRoleMembershipCommand.d.ts +2 -1
- package/dist-types/commands/DeleteTemplateAliasCommand.d.ts +2 -2
- package/dist-types/commands/DeleteTemplateCommand.d.ts +2 -2
- package/dist-types/commands/DeleteThemeAliasCommand.d.ts +1 -1
- package/dist-types/commands/DeleteThemeCommand.d.ts +2 -2
- package/dist-types/commands/DeleteVPCConnectionCommand.d.ts +1 -1
- package/dist-types/commands/DescribeAccountCustomPermissionCommand.d.ts +92 -0
- package/dist-types/commands/DescribeAccountCustomizationCommand.d.ts +7 -7
- package/dist-types/commands/DescribeAccountSettingsCommand.d.ts +1 -1
- package/dist-types/commands/DescribeAccountSubscriptionCommand.d.ts +1 -1
- package/dist-types/commands/DescribeAnalysisCommand.d.ts +1 -1
- package/dist-types/commands/DescribeAnalysisDefinitionCommand.d.ts +1 -1
- package/dist-types/commands/DescribeAnalysisPermissionsCommand.d.ts +1 -1
- package/dist-types/commands/DescribeAssetBundleExportJobCommand.d.ts +1 -1
- package/dist-types/commands/DescribeAssetBundleImportJobCommand.d.ts +4 -1
- package/dist-types/commands/DescribeCustomPermissionsCommand.d.ts +2 -0
- package/dist-types/commands/DescribeDashboardCommand.d.ts +1 -1
- package/dist-types/commands/DescribeDashboardDefinitionCommand.d.ts +7 -1
- package/dist-types/commands/DescribeDashboardPermissionsCommand.d.ts +1 -1
- package/dist-types/commands/DescribeDashboardSnapshotJobCommand.d.ts +1 -1
- package/dist-types/commands/DescribeDashboardSnapshotJobResultCommand.d.ts +1 -1
- package/dist-types/commands/DescribeDataSourceCommand.d.ts +7 -1
- package/dist-types/commands/DescribeDefaultQBusinessApplicationCommand.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/DescribeKeyRegistrationCommand.d.ts +5 -1
- package/dist-types/commands/DescribeQuickSightQSearchConfigurationCommand.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 +1 -1
- 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 +9 -1
- package/dist-types/commands/DescribeVPCConnectionCommand.d.ts +1 -1
- package/dist-types/commands/GenerateEmbedUrlForAnonymousUserCommand.d.ts +3 -3
- package/dist-types/commands/GenerateEmbedUrlForRegisteredUserCommand.d.ts +3 -3
- package/dist-types/commands/GenerateEmbedUrlForRegisteredUserWithIdentityCommand.d.ts +5 -5
- package/dist-types/commands/GetDashboardEmbedUrlCommand.d.ts +5 -5
- package/dist-types/commands/GetSessionEmbedUrlCommand.d.ts +3 -3
- 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 +2 -0
- package/dist-types/commands/ListDashboardVersionsCommand.d.ts +2 -2
- package/dist-types/commands/ListDashboardsCommand.d.ts +1 -1
- package/dist-types/commands/ListDataSourcesCommand.d.ts +7 -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/ListIdentityPropagationConfigsCommand.d.ts +2 -2
- package/dist-types/commands/ListTemplateAliasesCommand.d.ts +1 -1
- package/dist-types/commands/ListTemplateVersionsCommand.d.ts +1 -1
- package/dist-types/commands/ListTemplatesCommand.d.ts +1 -1
- package/dist-types/commands/ListThemeAliasesCommand.d.ts +1 -1
- package/dist-types/commands/ListThemeVersionsCommand.d.ts +1 -1
- package/dist-types/commands/ListThemesCommand.d.ts +1 -1
- package/dist-types/commands/ListVPCConnectionsCommand.d.ts +1 -1
- package/dist-types/commands/PredictQAResultsCommand.d.ts +1 -1
- package/dist-types/commands/RegisterUserCommand.d.ts +1 -1
- package/dist-types/commands/RestoreAnalysisCommand.d.ts +1 -1
- package/dist-types/commands/SearchAnalysesCommand.d.ts +1 -1
- package/dist-types/commands/SearchDashboardsCommand.d.ts +1 -1
- package/dist-types/commands/SearchDataSetsCommand.d.ts +1 -1
- package/dist-types/commands/SearchDataSourcesCommand.d.ts +2 -2
- package/dist-types/commands/SearchFoldersCommand.d.ts +2 -2
- package/dist-types/commands/SearchGroupsCommand.d.ts +2 -2
- package/dist-types/commands/SearchTopicsCommand.d.ts +2 -2
- package/dist-types/commands/StartAssetBundleExportJobCommand.d.ts +2 -2
- package/dist-types/commands/StartAssetBundleImportJobCommand.d.ts +5 -2
- package/dist-types/commands/StartDashboardSnapshotJobCommand.d.ts +6 -6
- package/dist-types/commands/StartDashboardSnapshotJobScheduleCommand.d.ts +2 -2
- package/dist-types/commands/TagResourceCommand.d.ts +5 -5
- package/dist-types/commands/UpdateAccountCustomPermissionCommand.d.ts +92 -0
- package/dist-types/commands/UpdateAccountCustomizationCommand.d.ts +1 -1
- package/dist-types/commands/UpdateAnalysisCommand.d.ts +1 -1
- package/dist-types/commands/UpdateAnalysisPermissionsCommand.d.ts +1 -1
- package/dist-types/commands/UpdateApplicationWithTokenExchangeGrantCommand.d.ts +1 -1
- package/dist-types/commands/UpdateCustomPermissionsCommand.d.ts +2 -0
- package/dist-types/commands/UpdateDashboardCommand.d.ts +7 -1
- package/dist-types/commands/UpdateDashboardLinksCommand.d.ts +1 -1
- package/dist-types/commands/UpdateDashboardPermissionsCommand.d.ts +1 -1
- package/dist-types/commands/UpdateDashboardPublishedVersionCommand.d.ts +1 -1
- package/dist-types/commands/UpdateDataSetCommand.d.ts +1 -1
- package/dist-types/commands/UpdateDataSourceCommand.d.ts +7 -1
- package/dist-types/commands/UpdateDefaultQBusinessApplicationCommand.d.ts +1 -1
- package/dist-types/commands/UpdateFolderCommand.d.ts +1 -1
- package/dist-types/commands/UpdateFolderPermissionsCommand.d.ts +1 -1
- package/dist-types/commands/UpdateIdentityPropagationConfigCommand.d.ts +2 -2
- package/dist-types/commands/UpdateKeyRegistrationCommand.d.ts +1 -1
- package/dist-types/commands/UpdatePublicSharingSettingsCommand.d.ts +6 -6
- package/dist-types/commands/UpdateQuickSightQSearchConfigurationCommand.d.ts +1 -1
- package/dist-types/commands/UpdateSPICECapacityConfigurationCommand.d.ts +1 -1
- package/dist-types/commands/UpdateTemplateAliasCommand.d.ts +1 -1
- package/dist-types/commands/UpdateTemplateCommand.d.ts +1 -1
- package/dist-types/commands/UpdateTemplatePermissionsCommand.d.ts +1 -1
- package/dist-types/commands/UpdateThemeAliasCommand.d.ts +1 -1
- package/dist-types/commands/UpdateThemeCommand.d.ts +1 -1
- package/dist-types/commands/UpdateThemePermissionsCommand.d.ts +1 -1
- package/dist-types/commands/UpdateTopicCommand.d.ts +9 -1
- package/dist-types/commands/UpdateTopicPermissionsCommand.d.ts +1 -1
- package/dist-types/commands/UpdateVPCConnectionCommand.d.ts +1 -1
- package/dist-types/commands/index.d.ts +3 -0
- package/dist-types/models/models_0.d.ts +39 -39
- package/dist-types/models/models_1.d.ts +2 -2
- package/dist-types/models/models_2.d.ts +106 -47
- package/dist-types/models/models_3.d.ts +236 -257
- package/dist-types/models/models_4.d.ts +346 -362
- package/dist-types/models/models_5.d.ts +355 -55
- package/dist-types/protocols/Aws_restJson1.d.ts +27 -0
- package/dist-types/ts3.4/QuickSight.d.ts +51 -0
- package/dist-types/ts3.4/QuickSightClient.d.ts +18 -0
- package/dist-types/ts3.4/commands/DeleteAccountCustomPermissionCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/DeleteRoleMembershipCommand.d.ts +2 -4
- package/dist-types/ts3.4/commands/DeleteTemplateAliasCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/DeleteTemplateCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/DeleteThemeCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/DescribeAccountCustomPermissionCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/SearchDataSetsCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/SearchDataSourcesCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/SearchFoldersCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/SearchGroupsCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/UpdateAccountCustomPermissionCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/index.d.ts +3 -0
- package/dist-types/ts3.4/models/models_2.d.ts +64 -4
- package/dist-types/ts3.4/models/models_3.d.ts +44 -43
- package/dist-types/ts3.4/models/models_4.d.ts +56 -74
- package/dist-types/ts3.4/models/models_5.d.ts +86 -1
- package/dist-types/ts3.4/protocols/Aws_restJson1.d.ts +36 -0
- package/package.json +37 -37
|
@@ -1,7 +1,263 @@
|
|
|
1
1
|
import { AccountCustomization, ResourceStatus } from "./models_0";
|
|
2
2
|
import { AnalysisDefinition, AnalysisSourceEntity, AssetBundleCloudFormationOverridePropertyConfiguration, AssetBundleExportFormat, AssetBundleExportJobValidationStrategy, AssetBundleImportFailureAction, AssetBundleImportJobOverrideParameters, AssetBundleImportJobOverridePermissions, AssetBundleImportJobOverrideTags, AssetBundleImportJobOverrideValidationStrategy, AssetBundleImportSource, AssignmentStatus, BrandDefinition, DataSourceParameters, ServiceType, SslProperties, Tag, TopicIR, TopicTemplate, VisualRole, VpcConnectionProperties } from "./models_2";
|
|
3
|
-
import { _Parameters, BrandDetail, Capabilities, ColumnGroup, ColumnLevelPermissionRule, CustomInstructions, DashboardPublishOptions, DashboardSourceEntity, DashboardsQAStatus, DashboardVersionDefinition, DataSetImportMode, DatasetParameter, DataSetUsageConfiguration, DataSourceCredentials, FieldFolder, Group, LinkSharingConfiguration, LogicalTable, PerformanceConfiguration, PhysicalTable, RefreshSchedule, ResourcePermission, Role, RowLevelPermissionDataSet, RowLevelPermissionTagConfiguration, TemplateAlias, TemplateSourceEntity, TemplateVersionDefinition, ThemeAlias, ThemeConfiguration, TopicDetails, TopicRefreshSchedule, ValidationStrategy, VPCConnectionAvailabilityStatus, VPCConnectionResourceStatus } from "./models_3";
|
|
4
|
-
import { FailedKeyRegistrationEntry, IncludeFolderMembers, PersonalizationMode, PurchaseMode, QSearchStatus, RegisteredCustomerManagedKey, SessionTag, SnapshotConfiguration,
|
|
3
|
+
import { _Parameters, BrandDetail, Capabilities, ColumnGroup, ColumnLevelPermissionRule, CustomInstructions, DashboardPublishOptions, DashboardSourceEntity, DashboardsQAStatus, DashboardVersionDefinition, DataSetImportMode, DatasetParameter, DataSetSearchFilter, DataSetSummary, DataSetUsageConfiguration, DataSourceCredentials, DataSourceSearchFilter, DataSourceSummary, FieldFolder, Group, LinkSharingConfiguration, LogicalTable, PerformanceConfiguration, PhysicalTable, RefreshSchedule, ResourcePermission, Role, RowLevelPermissionDataSet, RowLevelPermissionTagConfiguration, TemplateAlias, TemplateSourceEntity, TemplateVersionDefinition, ThemeAlias, ThemeConfiguration, TopicDetails, TopicRefreshSchedule, ValidationStrategy, VPCConnectionAvailabilityStatus, VPCConnectionResourceStatus } from "./models_3";
|
|
4
|
+
import { FailedKeyRegistrationEntry, FolderSearchFilter, FolderSummary, GroupSearchFilter, IncludeFolderMembers, PersonalizationMode, PurchaseMode, QSearchStatus, RegisteredCustomerManagedKey, SessionTag, SnapshotConfiguration, TopicSummary, User, UserRole } from "./models_4";
|
|
5
|
+
/**
|
|
6
|
+
* @public
|
|
7
|
+
*/
|
|
8
|
+
export interface SearchDataSetsRequest {
|
|
9
|
+
/**
|
|
10
|
+
* <p>The Amazon Web Services account ID.</p>
|
|
11
|
+
* @public
|
|
12
|
+
*/
|
|
13
|
+
AwsAccountId: string | undefined;
|
|
14
|
+
/**
|
|
15
|
+
* <p>The filters to apply to the search.</p>
|
|
16
|
+
* @public
|
|
17
|
+
*/
|
|
18
|
+
Filters: DataSetSearchFilter[] | undefined;
|
|
19
|
+
/**
|
|
20
|
+
* <p>A pagination token that can be used in a subsequent request.</p>
|
|
21
|
+
* @public
|
|
22
|
+
*/
|
|
23
|
+
NextToken?: string | undefined;
|
|
24
|
+
/**
|
|
25
|
+
* <p>The maximum number of results to be returned per request.</p>
|
|
26
|
+
* @public
|
|
27
|
+
*/
|
|
28
|
+
MaxResults?: number | undefined;
|
|
29
|
+
}
|
|
30
|
+
/**
|
|
31
|
+
* @public
|
|
32
|
+
*/
|
|
33
|
+
export interface SearchDataSetsResponse {
|
|
34
|
+
/**
|
|
35
|
+
* <p>A <code>DataSetSummaries</code> object that returns a summary of a dataset.</p>
|
|
36
|
+
* @public
|
|
37
|
+
*/
|
|
38
|
+
DataSetSummaries?: DataSetSummary[] | undefined;
|
|
39
|
+
/**
|
|
40
|
+
* <p>A pagination token that can be used in a subsequent request.</p>
|
|
41
|
+
* @public
|
|
42
|
+
*/
|
|
43
|
+
NextToken?: string | undefined;
|
|
44
|
+
/**
|
|
45
|
+
* <p>The HTTP status of the request.</p>
|
|
46
|
+
* @public
|
|
47
|
+
*/
|
|
48
|
+
Status?: number | undefined;
|
|
49
|
+
/**
|
|
50
|
+
* <p>The Amazon Web Services request ID for this operation.</p>
|
|
51
|
+
* @public
|
|
52
|
+
*/
|
|
53
|
+
RequestId?: string | undefined;
|
|
54
|
+
}
|
|
55
|
+
/**
|
|
56
|
+
* @public
|
|
57
|
+
*/
|
|
58
|
+
export interface SearchDataSourcesRequest {
|
|
59
|
+
/**
|
|
60
|
+
* <p>The Amazon Web Services account ID.</p>
|
|
61
|
+
* @public
|
|
62
|
+
*/
|
|
63
|
+
AwsAccountId: string | undefined;
|
|
64
|
+
/**
|
|
65
|
+
* <p>The filters to apply to the search.</p>
|
|
66
|
+
* @public
|
|
67
|
+
*/
|
|
68
|
+
Filters: DataSourceSearchFilter[] | undefined;
|
|
69
|
+
/**
|
|
70
|
+
* <p>A pagination token that can be used in a subsequent request.</p>
|
|
71
|
+
* @public
|
|
72
|
+
*/
|
|
73
|
+
NextToken?: string | undefined;
|
|
74
|
+
/**
|
|
75
|
+
* <p>The maximum number of results to be returned per request.</p>
|
|
76
|
+
* @public
|
|
77
|
+
*/
|
|
78
|
+
MaxResults?: number | undefined;
|
|
79
|
+
}
|
|
80
|
+
/**
|
|
81
|
+
* @public
|
|
82
|
+
*/
|
|
83
|
+
export interface SearchDataSourcesResponse {
|
|
84
|
+
/**
|
|
85
|
+
* <p>A <code>DataSourceSummaries</code> object that returns a summary of a data source.</p>
|
|
86
|
+
* @public
|
|
87
|
+
*/
|
|
88
|
+
DataSourceSummaries?: DataSourceSummary[] | undefined;
|
|
89
|
+
/**
|
|
90
|
+
* <p>A pagination token that can be used in a subsequent request.</p>
|
|
91
|
+
* @public
|
|
92
|
+
*/
|
|
93
|
+
NextToken?: string | undefined;
|
|
94
|
+
/**
|
|
95
|
+
* <p>The HTTP status of the request.</p>
|
|
96
|
+
* @public
|
|
97
|
+
*/
|
|
98
|
+
Status?: number | undefined;
|
|
99
|
+
/**
|
|
100
|
+
* <p>The Amazon Web Services request ID for this operation.</p>
|
|
101
|
+
* @public
|
|
102
|
+
*/
|
|
103
|
+
RequestId?: string | undefined;
|
|
104
|
+
}
|
|
105
|
+
/**
|
|
106
|
+
* @public
|
|
107
|
+
*/
|
|
108
|
+
export interface SearchFoldersRequest {
|
|
109
|
+
/**
|
|
110
|
+
* <p>The ID for the Amazon Web Services account that contains the folder.</p>
|
|
111
|
+
* @public
|
|
112
|
+
*/
|
|
113
|
+
AwsAccountId: string | undefined;
|
|
114
|
+
/**
|
|
115
|
+
* <p>The filters to apply to the search. Currently, you can search only by the parent folder ARN. For example, <code>"Filters": [ \{ "Name": "PARENT_FOLDER_ARN", "Operator": "StringEquals", "Value": "arn:aws:quicksight:us-east-1:1:folder/folderId" \} ]</code>.</p>
|
|
116
|
+
* @public
|
|
117
|
+
*/
|
|
118
|
+
Filters: FolderSearchFilter[] | undefined;
|
|
119
|
+
/**
|
|
120
|
+
* <p>The token for the next set of results, or null if there are no more results.</p>
|
|
121
|
+
* @public
|
|
122
|
+
*/
|
|
123
|
+
NextToken?: string | undefined;
|
|
124
|
+
/**
|
|
125
|
+
* <p>The maximum number of results to be returned per request.</p>
|
|
126
|
+
* @public
|
|
127
|
+
*/
|
|
128
|
+
MaxResults?: number | undefined;
|
|
129
|
+
}
|
|
130
|
+
/**
|
|
131
|
+
* @public
|
|
132
|
+
*/
|
|
133
|
+
export interface SearchFoldersResponse {
|
|
134
|
+
/**
|
|
135
|
+
* <p>The HTTP status of the request.</p>
|
|
136
|
+
* @public
|
|
137
|
+
*/
|
|
138
|
+
Status?: number | undefined;
|
|
139
|
+
/**
|
|
140
|
+
* <p>A structure that contains all of the folders in the Amazon Web Services account. This structure provides basic information about the folders.</p>
|
|
141
|
+
* @public
|
|
142
|
+
*/
|
|
143
|
+
FolderSummaryList?: FolderSummary[] | undefined;
|
|
144
|
+
/**
|
|
145
|
+
* <p>The token for the next set of results, or null if there are no more results.</p>
|
|
146
|
+
* @public
|
|
147
|
+
*/
|
|
148
|
+
NextToken?: string | undefined;
|
|
149
|
+
/**
|
|
150
|
+
* <p>The Amazon Web Services request ID for this operation.</p>
|
|
151
|
+
* @public
|
|
152
|
+
*/
|
|
153
|
+
RequestId?: string | undefined;
|
|
154
|
+
}
|
|
155
|
+
/**
|
|
156
|
+
* @public
|
|
157
|
+
*/
|
|
158
|
+
export interface SearchGroupsRequest {
|
|
159
|
+
/**
|
|
160
|
+
* <p>The ID for the Amazon Web Services account that the group is in. Currently, you use the ID for the
|
|
161
|
+
* Amazon Web Services account that contains your Amazon QuickSight account.</p>
|
|
162
|
+
* @public
|
|
163
|
+
*/
|
|
164
|
+
AwsAccountId: string | undefined;
|
|
165
|
+
/**
|
|
166
|
+
* <p>A pagination token that can be used in a subsequent request.</p>
|
|
167
|
+
* @public
|
|
168
|
+
*/
|
|
169
|
+
NextToken?: string | undefined;
|
|
170
|
+
/**
|
|
171
|
+
* <p>The maximum number of results to return from this request.</p>
|
|
172
|
+
* @public
|
|
173
|
+
*/
|
|
174
|
+
MaxResults?: number | undefined;
|
|
175
|
+
/**
|
|
176
|
+
* <p>The namespace that you want to search.</p>
|
|
177
|
+
* @public
|
|
178
|
+
*/
|
|
179
|
+
Namespace: string | undefined;
|
|
180
|
+
/**
|
|
181
|
+
* <p>The structure for the search filters that you want to apply to your search.</p>
|
|
182
|
+
* @public
|
|
183
|
+
*/
|
|
184
|
+
Filters: GroupSearchFilter[] | undefined;
|
|
185
|
+
}
|
|
186
|
+
/**
|
|
187
|
+
* @public
|
|
188
|
+
*/
|
|
189
|
+
export interface SearchGroupsResponse {
|
|
190
|
+
/**
|
|
191
|
+
* <p>A list of groups in a specified namespace that match the filters you set in your <code>SearchGroups</code> request.</p>
|
|
192
|
+
* @public
|
|
193
|
+
*/
|
|
194
|
+
GroupList?: Group[] | undefined;
|
|
195
|
+
/**
|
|
196
|
+
* <p>A pagination token that can be used in a subsequent request.</p>
|
|
197
|
+
* @public
|
|
198
|
+
*/
|
|
199
|
+
NextToken?: string | undefined;
|
|
200
|
+
/**
|
|
201
|
+
* <p>The Amazon Web Services request ID for this operation.</p>
|
|
202
|
+
* @public
|
|
203
|
+
*/
|
|
204
|
+
RequestId?: string | undefined;
|
|
205
|
+
/**
|
|
206
|
+
* <p>The HTTP status of the request.</p>
|
|
207
|
+
* @public
|
|
208
|
+
*/
|
|
209
|
+
Status?: number | undefined;
|
|
210
|
+
}
|
|
211
|
+
/**
|
|
212
|
+
* @public
|
|
213
|
+
* @enum
|
|
214
|
+
*/
|
|
215
|
+
export declare const TopicFilterAttribute: {
|
|
216
|
+
readonly DIRECT_QUICKSIGHT_OWNER: "DIRECT_QUICKSIGHT_OWNER";
|
|
217
|
+
readonly DIRECT_QUICKSIGHT_SOLE_OWNER: "DIRECT_QUICKSIGHT_SOLE_OWNER";
|
|
218
|
+
readonly DIRECT_QUICKSIGHT_VIEWER_OR_OWNER: "DIRECT_QUICKSIGHT_VIEWER_OR_OWNER";
|
|
219
|
+
readonly QUICKSIGHT_OWNER: "QUICKSIGHT_OWNER";
|
|
220
|
+
readonly QUICKSIGHT_USER: "QUICKSIGHT_USER";
|
|
221
|
+
readonly QUICKSIGHT_VIEWER_OR_OWNER: "QUICKSIGHT_VIEWER_OR_OWNER";
|
|
222
|
+
readonly TOPIC_NAME: "TOPIC_NAME";
|
|
223
|
+
};
|
|
224
|
+
/**
|
|
225
|
+
* @public
|
|
226
|
+
*/
|
|
227
|
+
export type TopicFilterAttribute = (typeof TopicFilterAttribute)[keyof typeof TopicFilterAttribute];
|
|
228
|
+
/**
|
|
229
|
+
* @public
|
|
230
|
+
* @enum
|
|
231
|
+
*/
|
|
232
|
+
export declare const TopicFilterOperator: {
|
|
233
|
+
readonly StringEquals: "StringEquals";
|
|
234
|
+
readonly StringLike: "StringLike";
|
|
235
|
+
};
|
|
236
|
+
/**
|
|
237
|
+
* @public
|
|
238
|
+
*/
|
|
239
|
+
export type TopicFilterOperator = (typeof TopicFilterOperator)[keyof typeof TopicFilterOperator];
|
|
240
|
+
/**
|
|
241
|
+
* <p>The filter that is used to search for a topic.</p>
|
|
242
|
+
* @public
|
|
243
|
+
*/
|
|
244
|
+
export interface TopicSearchFilter {
|
|
245
|
+
/**
|
|
246
|
+
* <p>The operator like equals or like.</p>
|
|
247
|
+
* @public
|
|
248
|
+
*/
|
|
249
|
+
Operator: TopicFilterOperator | undefined;
|
|
250
|
+
/**
|
|
251
|
+
* <p>The name of the topic search filter.</p>
|
|
252
|
+
* @public
|
|
253
|
+
*/
|
|
254
|
+
Name: TopicFilterAttribute | undefined;
|
|
255
|
+
/**
|
|
256
|
+
* <p>The value of the topic search filter.</p>
|
|
257
|
+
* @public
|
|
258
|
+
*/
|
|
259
|
+
Value: string | undefined;
|
|
260
|
+
}
|
|
5
261
|
/**
|
|
6
262
|
* @public
|
|
7
263
|
*/
|
|
@@ -210,7 +466,7 @@ export interface StartAssetBundleImportJobRequest {
|
|
|
210
466
|
* <p>The failure action for the import job.</p>
|
|
211
467
|
* <p>If you choose <code>ROLLBACK</code>, failed import jobs will attempt to undo any asset changes caused by the failed job.</p>
|
|
212
468
|
* <p>If you choose <code>DO_NOTHING</code>, failed import jobs will not attempt to roll back
|
|
213
|
-
* any asset changes caused by the failed job, possibly keeping the
|
|
469
|
+
* any asset changes caused by the failed job, possibly keeping the QuickSight account in an inconsistent state.</p>
|
|
214
470
|
* @public
|
|
215
471
|
*/
|
|
216
472
|
FailureAction?: AssetBundleImportFailureAction | undefined;
|
|
@@ -262,7 +518,7 @@ export interface StartAssetBundleImportJobResponse {
|
|
|
262
518
|
export interface SnapshotAnonymousUser {
|
|
263
519
|
/**
|
|
264
520
|
* <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>
|
|
265
|
-
* <p>These are not the tags that are used for Amazon Web Services resource tagging. For more information on row level security in
|
|
521
|
+
* <p>These are not the tags that are used for Amazon Web Services resource tagging. For more information on row level security in QuickSight, 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 QuickSight User Guide</i>.</p>
|
|
266
522
|
* @public
|
|
267
523
|
*/
|
|
268
524
|
RowLevelPermissionTags?: SessionTag[] | undefined;
|
|
@@ -300,7 +556,7 @@ export interface StartDashboardSnapshotJobRequest {
|
|
|
300
556
|
SnapshotJobId: string | undefined;
|
|
301
557
|
/**
|
|
302
558
|
* <p>
|
|
303
|
-
* A structure that contains information about the anonymous users that the generated snapshot is for. This API will not return information about registered
|
|
559
|
+
* A structure that contains information about the anonymous users that the generated snapshot is for. This API will not return information about registered QuickSight.</p>
|
|
304
560
|
* @public
|
|
305
561
|
*/
|
|
306
562
|
UserConfiguration: SnapshotUserConfiguration | undefined;
|
|
@@ -353,7 +609,7 @@ export interface StartDashboardSnapshotJobScheduleRequest {
|
|
|
353
609
|
*/
|
|
354
610
|
DashboardId: string | undefined;
|
|
355
611
|
/**
|
|
356
|
-
* <p>The ID of the schedule that you want to start a snapshot job schedule for. The schedule ID can be found in the
|
|
612
|
+
* <p>The ID of the schedule that you want to start a snapshot job schedule for. The schedule ID can be found in the QuickSight console in the <b>Schedules</b> pane of the dashboard that the schedule is configured for.</p>
|
|
357
613
|
* @public
|
|
358
614
|
*/
|
|
359
615
|
ScheduleId: string | undefined;
|
|
@@ -440,18 +696,18 @@ export interface UntagResourceResponse {
|
|
|
440
696
|
*/
|
|
441
697
|
export interface UpdateAccountCustomizationRequest {
|
|
442
698
|
/**
|
|
443
|
-
* <p>The ID for the Amazon Web Services account that you want to update
|
|
699
|
+
* <p>The ID for the Amazon Web Services account that you want to update QuickSight customizations
|
|
444
700
|
* for.</p>
|
|
445
701
|
* @public
|
|
446
702
|
*/
|
|
447
703
|
AwsAccountId: string | undefined;
|
|
448
704
|
/**
|
|
449
|
-
* <p>The namespace that you want to update
|
|
705
|
+
* <p>The namespace that you want to update QuickSight customizations for.</p>
|
|
450
706
|
* @public
|
|
451
707
|
*/
|
|
452
708
|
Namespace?: string | undefined;
|
|
453
709
|
/**
|
|
454
|
-
* <p>The
|
|
710
|
+
* <p>The QuickSight customizations you're updating in the current Amazon Web Services Region. </p>
|
|
455
711
|
* @public
|
|
456
712
|
*/
|
|
457
713
|
AccountCustomization: AccountCustomization | undefined;
|
|
@@ -466,7 +722,7 @@ export interface UpdateAccountCustomizationResponse {
|
|
|
466
722
|
*/
|
|
467
723
|
Arn?: string | undefined;
|
|
468
724
|
/**
|
|
469
|
-
* <p>The ID for the Amazon Web Services account that you want to update
|
|
725
|
+
* <p>The ID for the Amazon Web Services account that you want to update QuickSight customizations
|
|
470
726
|
* for.</p>
|
|
471
727
|
* @public
|
|
472
728
|
*/
|
|
@@ -477,7 +733,7 @@ export interface UpdateAccountCustomizationResponse {
|
|
|
477
733
|
*/
|
|
478
734
|
Namespace?: string | undefined;
|
|
479
735
|
/**
|
|
480
|
-
* <p>The
|
|
736
|
+
* <p>The QuickSight customizations you're updating in the current Amazon Web Services Region. </p>
|
|
481
737
|
* @public
|
|
482
738
|
*/
|
|
483
739
|
AccountCustomization?: AccountCustomization | undefined;
|
|
@@ -492,12 +748,42 @@ export interface UpdateAccountCustomizationResponse {
|
|
|
492
748
|
*/
|
|
493
749
|
Status?: number | undefined;
|
|
494
750
|
}
|
|
751
|
+
/**
|
|
752
|
+
* @public
|
|
753
|
+
*/
|
|
754
|
+
export interface UpdateAccountCustomPermissionRequest {
|
|
755
|
+
/**
|
|
756
|
+
* <p>The name of the custom permissions profile that you want to apply to an account.</p>
|
|
757
|
+
* @public
|
|
758
|
+
*/
|
|
759
|
+
CustomPermissionsName: string | undefined;
|
|
760
|
+
/**
|
|
761
|
+
* <p>The ID of the Amazon Web Services account for which you want to apply a custom permissions profile.</p>
|
|
762
|
+
* @public
|
|
763
|
+
*/
|
|
764
|
+
AwsAccountId: string | undefined;
|
|
765
|
+
}
|
|
766
|
+
/**
|
|
767
|
+
* @public
|
|
768
|
+
*/
|
|
769
|
+
export interface UpdateAccountCustomPermissionResponse {
|
|
770
|
+
/**
|
|
771
|
+
* <p>The Amazon Web Services request ID for this operation.</p>
|
|
772
|
+
* @public
|
|
773
|
+
*/
|
|
774
|
+
RequestId?: string | undefined;
|
|
775
|
+
/**
|
|
776
|
+
* <p>The HTTP status of the request.</p>
|
|
777
|
+
* @public
|
|
778
|
+
*/
|
|
779
|
+
Status?: number | undefined;
|
|
780
|
+
}
|
|
495
781
|
/**
|
|
496
782
|
* @public
|
|
497
783
|
*/
|
|
498
784
|
export interface UpdateAccountSettingsRequest {
|
|
499
785
|
/**
|
|
500
|
-
* <p>The ID for the Amazon Web Services account that contains the
|
|
786
|
+
* <p>The ID for the Amazon Web Services account that contains the QuickSight settings that you want to
|
|
501
787
|
* list.</p>
|
|
502
788
|
* @public
|
|
503
789
|
*/
|
|
@@ -505,20 +791,20 @@ export interface UpdateAccountSettingsRequest {
|
|
|
505
791
|
/**
|
|
506
792
|
* <p>The default namespace for this Amazon Web Services account. Currently, the default is
|
|
507
793
|
* <code>default</code>. IAM users that
|
|
508
|
-
* register for the first time with
|
|
794
|
+
* register for the first time with QuickSight provide an email address that becomes
|
|
509
795
|
* associated with the default namespace.
|
|
510
796
|
* </p>
|
|
511
797
|
* @public
|
|
512
798
|
*/
|
|
513
799
|
DefaultNamespace: string | undefined;
|
|
514
800
|
/**
|
|
515
|
-
* <p>The email address that you want
|
|
516
|
-
* Amazon Web Services account or
|
|
801
|
+
* <p>The email address that you want QuickSight to send notifications to regarding your
|
|
802
|
+
* Amazon Web Services account or QuickSight subscription.</p>
|
|
517
803
|
* @public
|
|
518
804
|
*/
|
|
519
805
|
NotificationEmail?: string | undefined;
|
|
520
806
|
/**
|
|
521
|
-
* <p>A boolean value that determines whether or not an
|
|
807
|
+
* <p>A boolean value that determines whether or not an QuickSight account can be deleted. A <code>True</code> value doesn't allow the account to be deleted and results in an error message if a user tries to make a <code>DeleteAccountSubscription</code> request. A <code>False</code> value will allow the account to be deleted.</p>
|
|
522
808
|
* @public
|
|
523
809
|
*/
|
|
524
810
|
TerminationProtectionEnabled?: boolean | undefined;
|
|
@@ -555,7 +841,7 @@ export interface UpdateAnalysisRequest {
|
|
|
555
841
|
AnalysisId: string | undefined;
|
|
556
842
|
/**
|
|
557
843
|
* <p>A descriptive name for the analysis that you're updating. This name displays for the
|
|
558
|
-
* analysis in the
|
|
844
|
+
* analysis in the QuickSight console.</p>
|
|
559
845
|
* @public
|
|
560
846
|
*/
|
|
561
847
|
Name: string | undefined;
|
|
@@ -573,7 +859,7 @@ export interface UpdateAnalysisRequest {
|
|
|
573
859
|
SourceEntity?: AnalysisSourceEntity | undefined;
|
|
574
860
|
/**
|
|
575
861
|
* <p>The Amazon Resource Name (ARN) for the theme to apply to the analysis that you're
|
|
576
|
-
* creating. To see the theme in the
|
|
862
|
+
* creating. To see the theme in the QuickSight console, make sure that you have access to
|
|
577
863
|
* it.</p>
|
|
578
864
|
* @public
|
|
579
865
|
*/
|
|
@@ -690,7 +976,7 @@ export interface UpdateApplicationWithTokenExchangeGrantRequest {
|
|
|
690
976
|
*/
|
|
691
977
|
AwsAccountId: string | undefined;
|
|
692
978
|
/**
|
|
693
|
-
* <p>The namespace of the
|
|
979
|
+
* <p>The namespace of the QuickSight application.</p>
|
|
694
980
|
* @public
|
|
695
981
|
*/
|
|
696
982
|
Namespace: string | undefined;
|
|
@@ -720,7 +1006,7 @@ export interface UpdateBrandRequest {
|
|
|
720
1006
|
*/
|
|
721
1007
|
AwsAccountId: string | undefined;
|
|
722
1008
|
/**
|
|
723
|
-
* <p>The ID of the
|
|
1009
|
+
* <p>The ID of the QuickSight brand.</p>
|
|
724
1010
|
* @public
|
|
725
1011
|
*/
|
|
726
1012
|
BrandId: string | undefined;
|
|
@@ -790,7 +1076,7 @@ export interface UpdateBrandPublishedVersionRequest {
|
|
|
790
1076
|
*/
|
|
791
1077
|
AwsAccountId: string | undefined;
|
|
792
1078
|
/**
|
|
793
|
-
* <p>The ID of the
|
|
1079
|
+
* <p>The ID of the QuickSight brand.</p>
|
|
794
1080
|
* @public
|
|
795
1081
|
*/
|
|
796
1082
|
BrandId: string | undefined;
|
|
@@ -885,7 +1171,7 @@ export interface UpdateDashboardRequest {
|
|
|
885
1171
|
* </code> API operation. For
|
|
886
1172
|
* <code>SourceTemplate</code>, specify the Amazon Resource Name (ARN) of the source
|
|
887
1173
|
* template. The <code>SourceTemplate</code> ARN can contain any Amazon Web Services account and any
|
|
888
|
-
*
|
|
1174
|
+
* QuickSight-supported Amazon Web Services Region. </p>
|
|
889
1175
|
* <p>Use the <code>DataSetReferences</code> entity within <code>SourceTemplate</code> to
|
|
890
1176
|
* list the replacement datasets for the placeholders listed in the original. The schema in
|
|
891
1177
|
* each dataset must match its placeholder. </p>
|
|
@@ -911,7 +1197,7 @@ export interface UpdateDashboardRequest {
|
|
|
911
1197
|
* <p>
|
|
912
1198
|
* <code>AvailabilityStatus</code> for <code>AdHocFilteringOption</code> - This
|
|
913
1199
|
* status can be either <code>ENABLED</code> or <code>DISABLED</code>. When this is
|
|
914
|
-
* set to <code>DISABLED</code>,
|
|
1200
|
+
* set to <code>DISABLED</code>, QuickSight disables the left filter pane on the
|
|
915
1201
|
* published dashboard, which can be used for ad hoc (one-time) filtering. This
|
|
916
1202
|
* option is <code>ENABLED</code> by default. </p>
|
|
917
1203
|
* </li>
|
|
@@ -928,6 +1214,20 @@ export interface UpdateDashboardRequest {
|
|
|
928
1214
|
* visibility state can be either <code>COLLAPSED</code> or <code>EXPANDED</code>.
|
|
929
1215
|
* This option is <code>COLLAPSED</code> by default. </p>
|
|
930
1216
|
* </li>
|
|
1217
|
+
* <li>
|
|
1218
|
+
* <p>
|
|
1219
|
+
* <code>AvailabilityStatus</code> for <code>ExecutiveSummaryOption</code> - This status
|
|
1220
|
+
* can be either <code>ENABLED</code> or <code>DISABLED</code>. The option to build an executive
|
|
1221
|
+
* summary is disabled when this is set to <code>DISABLED</code>. This option is <code>ENABLED</code>
|
|
1222
|
+
* by default.</p>
|
|
1223
|
+
* </li>
|
|
1224
|
+
* <li>
|
|
1225
|
+
* <p>
|
|
1226
|
+
* <code>AvailabilityStatus</code> for <code>DataStoriesSharingOption</code> - This status
|
|
1227
|
+
* can be either <code>ENABLED</code> or <code>DISABLED</code>. The option to share a data story is
|
|
1228
|
+
* disabled when this is set to <code>DISABLED</code>. This option is <code>ENABLED</code>
|
|
1229
|
+
* by default.</p>
|
|
1230
|
+
* </li>
|
|
931
1231
|
* </ul>
|
|
932
1232
|
* @public
|
|
933
1233
|
*/
|
|
@@ -1098,7 +1398,7 @@ export interface UpdateDashboardPermissionsResponse {
|
|
|
1098
1398
|
*/
|
|
1099
1399
|
Status?: number | undefined;
|
|
1100
1400
|
/**
|
|
1101
|
-
* <p>Updates the permissions of a shared link to an
|
|
1401
|
+
* <p>Updates the permissions of a shared link to an QuickSight dashboard.</p>
|
|
1102
1402
|
* @public
|
|
1103
1403
|
*/
|
|
1104
1404
|
LinkSharingConfiguration?: LinkSharingConfiguration | undefined;
|
|
@@ -1220,7 +1520,7 @@ export interface UpdateDataSetRequest {
|
|
|
1220
1520
|
*/
|
|
1221
1521
|
ImportMode: DataSetImportMode | undefined;
|
|
1222
1522
|
/**
|
|
1223
|
-
* <p>Groupings of columns that work together in certain
|
|
1523
|
+
* <p>Groupings of columns that work together in certain QuickSight features. Currently, only geospatial hierarchy is supported.</p>
|
|
1224
1524
|
* @public
|
|
1225
1525
|
*/
|
|
1226
1526
|
ColumnGroups?: ColumnGroup[] | undefined;
|
|
@@ -1371,24 +1671,24 @@ export interface UpdateDataSourceRequest {
|
|
|
1371
1671
|
*/
|
|
1372
1672
|
Name: string | undefined;
|
|
1373
1673
|
/**
|
|
1374
|
-
* <p>The parameters that
|
|
1674
|
+
* <p>The parameters that QuickSight uses to connect to your underlying source.</p>
|
|
1375
1675
|
* @public
|
|
1376
1676
|
*/
|
|
1377
1677
|
DataSourceParameters?: DataSourceParameters | undefined;
|
|
1378
1678
|
/**
|
|
1379
|
-
* <p>The credentials that
|
|
1679
|
+
* <p>The credentials that QuickSight that uses to connect to your underlying source. Currently,
|
|
1380
1680
|
* only credentials based on user name and password are supported.</p>
|
|
1381
1681
|
* @public
|
|
1382
1682
|
*/
|
|
1383
1683
|
Credentials?: DataSourceCredentials | undefined;
|
|
1384
1684
|
/**
|
|
1385
|
-
* <p>Use this parameter only when you want
|
|
1685
|
+
* <p>Use this parameter only when you want QuickSight to use a VPC connection when connecting to
|
|
1386
1686
|
* your underlying source.</p>
|
|
1387
1687
|
* @public
|
|
1388
1688
|
*/
|
|
1389
1689
|
VpcConnectionProperties?: VpcConnectionProperties | undefined;
|
|
1390
1690
|
/**
|
|
1391
|
-
* <p>Secure Socket Layer (SSL) properties that apply when
|
|
1691
|
+
* <p>Secure Socket Layer (SSL) properties that apply when QuickSight connects to your underlying
|
|
1392
1692
|
* source.</p>
|
|
1393
1693
|
* @public
|
|
1394
1694
|
*/
|
|
@@ -1479,12 +1779,12 @@ export interface UpdateDataSourcePermissionsResponse {
|
|
|
1479
1779
|
*/
|
|
1480
1780
|
export interface UpdateDefaultQBusinessApplicationRequest {
|
|
1481
1781
|
/**
|
|
1482
|
-
* <p>The ID of the
|
|
1782
|
+
* <p>The ID of the QuickSight account that is connected to the Amazon Q Business application that you want to update.</p>
|
|
1483
1783
|
* @public
|
|
1484
1784
|
*/
|
|
1485
1785
|
AwsAccountId: string | undefined;
|
|
1486
1786
|
/**
|
|
1487
|
-
* <p>The
|
|
1787
|
+
* <p>The QuickSight namespace that contains the linked Amazon Q Business application. If this field is left blank, the default namespace is used. Currently, the default namespace is the only valid value for this parameter.</p>
|
|
1488
1788
|
* @public
|
|
1489
1789
|
*/
|
|
1490
1790
|
Namespace?: string | undefined;
|
|
@@ -1701,13 +2001,13 @@ export interface UpdateIAMPolicyAssignmentRequest {
|
|
|
1701
2001
|
*/
|
|
1702
2002
|
AssignmentStatus?: AssignmentStatus | undefined;
|
|
1703
2003
|
/**
|
|
1704
|
-
* <p>The ARN for the IAM policy to apply to the
|
|
2004
|
+
* <p>The ARN for the IAM policy to apply to the QuickSight users and
|
|
1705
2005
|
* groups specified in this assignment.</p>
|
|
1706
2006
|
* @public
|
|
1707
2007
|
*/
|
|
1708
2008
|
PolicyArn?: string | undefined;
|
|
1709
2009
|
/**
|
|
1710
|
-
* <p>The
|
|
2010
|
+
* <p>The QuickSight users, groups, or both that you want to assign the policy
|
|
1711
2011
|
* to.</p>
|
|
1712
2012
|
* @public
|
|
1713
2013
|
*/
|
|
@@ -1728,13 +2028,13 @@ export interface UpdateIAMPolicyAssignmentResponse {
|
|
|
1728
2028
|
*/
|
|
1729
2029
|
AssignmentId?: string | undefined;
|
|
1730
2030
|
/**
|
|
1731
|
-
* <p>The ARN for the IAM policy applied to the
|
|
2031
|
+
* <p>The ARN for the IAM policy applied to the QuickSight users and
|
|
1732
2032
|
* groups specified in this assignment.</p>
|
|
1733
2033
|
* @public
|
|
1734
2034
|
*/
|
|
1735
2035
|
PolicyArn?: string | undefined;
|
|
1736
2036
|
/**
|
|
1737
|
-
* <p>The
|
|
2037
|
+
* <p>The QuickSight users, groups, or both that the IAM policy is
|
|
1738
2038
|
* assigned to.</p>
|
|
1739
2039
|
* @public
|
|
1740
2040
|
*/
|
|
@@ -1867,13 +2167,13 @@ export interface UpdateKeyRegistrationRequest {
|
|
|
1867
2167
|
*/
|
|
1868
2168
|
AwsAccountId: string | undefined;
|
|
1869
2169
|
/**
|
|
1870
|
-
* <p>A list of <code>RegisteredCustomerManagedKey</code> objects to be updated to the
|
|
2170
|
+
* <p>A list of <code>RegisteredCustomerManagedKey</code> objects to be updated to the QuickSight account.</p>
|
|
1871
2171
|
* @public
|
|
1872
2172
|
*/
|
|
1873
2173
|
KeyRegistration: RegisteredCustomerManagedKey[] | undefined;
|
|
1874
2174
|
}
|
|
1875
2175
|
/**
|
|
1876
|
-
* <p>A success entry that occurs when a <code>KeyRegistration</code> job is successfully applied to the
|
|
2176
|
+
* <p>A success entry that occurs when a <code>KeyRegistration</code> job is successfully applied to the QuickSight account.</p>
|
|
1877
2177
|
* @public
|
|
1878
2178
|
*/
|
|
1879
2179
|
export interface SuccessfulKeyRegistrationEntry {
|
|
@@ -1913,12 +2213,12 @@ export interface UpdateKeyRegistrationResponse {
|
|
|
1913
2213
|
*/
|
|
1914
2214
|
export interface UpdatePublicSharingSettingsRequest {
|
|
1915
2215
|
/**
|
|
1916
|
-
* <p>The Amazon Web Services account ID associated with your
|
|
2216
|
+
* <p>The Amazon Web Services account ID associated with your QuickSight subscription.</p>
|
|
1917
2217
|
* @public
|
|
1918
2218
|
*/
|
|
1919
2219
|
AwsAccountId: string | undefined;
|
|
1920
2220
|
/**
|
|
1921
|
-
* <p>A Boolean value that indicates whether public sharing is turned on for an
|
|
2221
|
+
* <p>A Boolean value that indicates whether public sharing is turned on for an QuickSight account.</p>
|
|
1922
2222
|
* @public
|
|
1923
2223
|
*/
|
|
1924
2224
|
PublicSharingEnabled?: boolean | undefined;
|
|
@@ -1948,7 +2248,7 @@ export interface UpdateQPersonalizationConfigurationRequest {
|
|
|
1948
2248
|
*/
|
|
1949
2249
|
AwsAccountId: string | undefined;
|
|
1950
2250
|
/**
|
|
1951
|
-
* <p>An option to allow
|
|
2251
|
+
* <p>An option to allow QuickSight to customize data stories with user specific metadata, specifically location and job information, in your IAM Identity Center instance.</p>
|
|
1952
2252
|
* @public
|
|
1953
2253
|
*/
|
|
1954
2254
|
PersonalizationMode: PersonalizationMode | undefined;
|
|
@@ -1978,12 +2278,12 @@ export interface UpdateQPersonalizationConfigurationResponse {
|
|
|
1978
2278
|
*/
|
|
1979
2279
|
export interface UpdateQuickSightQSearchConfigurationRequest {
|
|
1980
2280
|
/**
|
|
1981
|
-
* <p>The ID of the Amazon Web Services account that contains the
|
|
2281
|
+
* <p>The ID of the Amazon Web Services account that contains the QuickSight Q Search configuration that you want to update.</p>
|
|
1982
2282
|
* @public
|
|
1983
2283
|
*/
|
|
1984
2284
|
AwsAccountId: string | undefined;
|
|
1985
2285
|
/**
|
|
1986
|
-
* <p>The status of the
|
|
2286
|
+
* <p>The status of the QuickSight Q Search configuration that the user wants to update.</p>
|
|
1987
2287
|
* @public
|
|
1988
2288
|
*/
|
|
1989
2289
|
QSearchStatus: QSearchStatus | undefined;
|
|
@@ -1993,7 +2293,7 @@ export interface UpdateQuickSightQSearchConfigurationRequest {
|
|
|
1993
2293
|
*/
|
|
1994
2294
|
export interface UpdateQuickSightQSearchConfigurationResponse {
|
|
1995
2295
|
/**
|
|
1996
|
-
* <p>The status of the
|
|
2296
|
+
* <p>The status of the QuickSight Q Search configuration.</p>
|
|
1997
2297
|
* @public
|
|
1998
2298
|
*/
|
|
1999
2299
|
QSearchStatus?: QSearchStatus | undefined;
|
|
@@ -2154,7 +2454,7 @@ export interface UpdateTemplateRequest {
|
|
|
2154
2454
|
* analysis. Both of these require an Amazon Resource Name (ARN). For
|
|
2155
2455
|
* <code>SourceTemplate</code>, specify the ARN of the source template. For
|
|
2156
2456
|
* <code>SourceAnalysis</code>, specify the ARN of the source analysis. The <code>SourceTemplate</code>
|
|
2157
|
-
* ARN can contain any Amazon Web Services account and any
|
|
2457
|
+
* ARN can contain any Amazon Web Services account and any QuickSight-supported Amazon Web Services Region;. </p>
|
|
2158
2458
|
* <p>Use the <code>DataSetReferences</code> entity within <code>SourceTemplate</code> or
|
|
2159
2459
|
* <code>SourceAnalysis</code> to list the replacement datasets for the placeholders listed
|
|
2160
2460
|
* in the original. The schema in each dataset must match its placeholder. </p>
|
|
@@ -2345,7 +2645,7 @@ export interface UpdateThemeRequest {
|
|
|
2345
2645
|
Name?: string | undefined;
|
|
2346
2646
|
/**
|
|
2347
2647
|
* <p>The theme ID, defined by Amazon QuickSight, that a custom theme inherits from.
|
|
2348
|
-
* All themes initially inherit from a default
|
|
2648
|
+
* All themes initially inherit from a default QuickSight theme.</p>
|
|
2349
2649
|
* @public
|
|
2350
2650
|
*/
|
|
2351
2651
|
BaseThemeId: string | undefined;
|
|
@@ -2710,7 +3010,7 @@ export interface UpdateUserRequest {
|
|
|
2710
3010
|
* </li>
|
|
2711
3011
|
* <li>
|
|
2712
3012
|
* <p>
|
|
2713
|
-
* <code>READER_PRO</code>: Reader Pro adds Generative BI capabilities to the Reader role. Reader Pros have access to Amazon Q in
|
|
3013
|
+
* <code>READER_PRO</code>: Reader Pro adds Generative BI capabilities to the Reader role. Reader Pros have access to Amazon Q in QuickSight, can build stories with Amazon Q, and can generate executive summaries from dashboards.</p>
|
|
2714
3014
|
* </li>
|
|
2715
3015
|
* <li>
|
|
2716
3016
|
* <p>
|
|
@@ -2721,7 +3021,7 @@ export interface UpdateUserRequest {
|
|
|
2721
3021
|
* <code>ADMIN_PRO</code>: Admin Pros are Author Pros who can also manage Amazon QuickSight administrative settings. Admin Pro users are billed at Author Pro pricing.</p>
|
|
2722
3022
|
* </li>
|
|
2723
3023
|
* </ul>
|
|
2724
|
-
* <p>The name of the
|
|
3024
|
+
* <p>The name of the QuickSight role is invisible to the user except for the console
|
|
2725
3025
|
* screens dealing with permissions.</p>
|
|
2726
3026
|
* @public
|
|
2727
3027
|
*/
|
|
@@ -2745,13 +3045,13 @@ export interface UpdateUserRequest {
|
|
|
2745
3045
|
* </li>
|
|
2746
3046
|
* </ul>
|
|
2747
3047
|
* <p>A set of custom permissions includes any combination of these restrictions. Currently,
|
|
2748
|
-
* you need to create the profile names for custom permission sets by using the
|
|
3048
|
+
* you need to create the profile names for custom permission sets by using the QuickSight
|
|
2749
3049
|
* console. Then, you use the <code>RegisterUser</code> API operation to assign the named set of
|
|
2750
|
-
* permissions to a
|
|
2751
|
-
* <p>
|
|
2752
|
-
* override the permissions typically granted by assigning
|
|
2753
|
-
* default security cohorts in
|
|
2754
|
-
* <p>This feature is available only to
|
|
3050
|
+
* permissions to a QuickSight user. </p>
|
|
3051
|
+
* <p>QuickSight custom permissions are applied through IAM policies. Therefore, they
|
|
3052
|
+
* override the permissions typically granted by assigning QuickSight users to one of the
|
|
3053
|
+
* default security cohorts in QuickSight (admin, author, reader).</p>
|
|
3054
|
+
* <p>This feature is available only to QuickSight Enterprise edition subscriptions.</p>
|
|
2755
3055
|
* @public
|
|
2756
3056
|
*/
|
|
2757
3057
|
CustomPermissionsName?: string | undefined;
|
|
@@ -2764,7 +3064,7 @@ export interface UpdateUserRequest {
|
|
|
2764
3064
|
*/
|
|
2765
3065
|
UnapplyCustomPermissions?: boolean | undefined;
|
|
2766
3066
|
/**
|
|
2767
|
-
* <p>The type of supported external login provider that provides identity to let a user federate into
|
|
3067
|
+
* <p>The type of supported external login provider that provides identity to let a user federate into QuickSight with an associated Identity and Access Management(IAM) role. The type of supported external login provider can be one of the following.</p>
|
|
2768
3068
|
* <ul>
|
|
2769
3069
|
* <li>
|
|
2770
3070
|
* <p>
|
|
@@ -2788,7 +3088,7 @@ export interface UpdateUserRequest {
|
|
|
2788
3088
|
ExternalLoginFederationProviderType?: string | undefined;
|
|
2789
3089
|
/**
|
|
2790
3090
|
* <p>The URL of the custom OpenID Connect (OIDC) provider that provides identity to let a user federate
|
|
2791
|
-
* into
|
|
3091
|
+
* into QuickSight with an associated Identity and Access Management(IAM) role. This parameter should
|
|
2792
3092
|
* only be used when <code>ExternalLoginFederationProviderType</code> parameter is set to <code>CUSTOM_OIDC</code>.</p>
|
|
2793
3093
|
* @public
|
|
2794
3094
|
*/
|