@aws-sdk/client-quicksight 3.168.0 → 3.170.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/CHANGELOG.md +16 -0
- package/dist-types/ts3.4/QuickSight.d.ts +919 -71
- package/dist-types/ts3.4/QuickSightClient.d.ts +849 -193
- package/dist-types/ts3.4/commands/CancelIngestionCommand.d.ts +37 -17
- package/dist-types/ts3.4/commands/CreateAccountCustomizationCommand.d.ts +41 -17
- package/dist-types/ts3.4/commands/CreateAccountSubscriptionCommand.d.ts +41 -17
- package/dist-types/ts3.4/commands/CreateAnalysisCommand.d.ts +37 -17
- package/dist-types/ts3.4/commands/CreateDashboardCommand.d.ts +37 -17
- package/dist-types/ts3.4/commands/CreateDataSetCommand.d.ts +37 -17
- package/dist-types/ts3.4/commands/CreateDataSourceCommand.d.ts +37 -17
- package/dist-types/ts3.4/commands/CreateFolderCommand.d.ts +34 -17
- package/dist-types/ts3.4/commands/CreateFolderMembershipCommand.d.ts +41 -17
- package/dist-types/ts3.4/commands/CreateGroupCommand.d.ts +34 -17
- package/dist-types/ts3.4/commands/CreateGroupMembershipCommand.d.ts +41 -17
- package/dist-types/ts3.4/commands/CreateIAMPolicyAssignmentCommand.d.ts +41 -17
- package/dist-types/ts3.4/commands/CreateIngestionCommand.d.ts +37 -17
- package/dist-types/ts3.4/commands/CreateNamespaceCommand.d.ts +37 -17
- package/dist-types/ts3.4/commands/CreateTemplateAliasCommand.d.ts +38 -17
- package/dist-types/ts3.4/commands/CreateTemplateCommand.d.ts +37 -17
- package/dist-types/ts3.4/commands/CreateThemeAliasCommand.d.ts +37 -17
- package/dist-types/ts3.4/commands/CreateThemeCommand.d.ts +34 -17
- package/dist-types/ts3.4/commands/DeleteAccountCustomizationCommand.d.ts +41 -17
- package/dist-types/ts3.4/commands/DeleteAnalysisCommand.d.ts +37 -17
- package/dist-types/ts3.4/commands/DeleteDashboardCommand.d.ts +37 -17
- package/dist-types/ts3.4/commands/DeleteDataSetCommand.d.ts +37 -17
- package/dist-types/ts3.4/commands/DeleteDataSourceCommand.d.ts +37 -17
- package/dist-types/ts3.4/commands/DeleteFolderCommand.d.ts +34 -17
- package/dist-types/ts3.4/commands/DeleteFolderMembershipCommand.d.ts +41 -17
- package/dist-types/ts3.4/commands/DeleteGroupCommand.d.ts +34 -17
- package/dist-types/ts3.4/commands/DeleteGroupMembershipCommand.d.ts +41 -17
- package/dist-types/ts3.4/commands/DeleteIAMPolicyAssignmentCommand.d.ts +41 -17
- package/dist-types/ts3.4/commands/DeleteNamespaceCommand.d.ts +37 -17
- package/dist-types/ts3.4/commands/DeleteTemplateAliasCommand.d.ts +38 -17
- package/dist-types/ts3.4/commands/DeleteTemplateCommand.d.ts +37 -17
- package/dist-types/ts3.4/commands/DeleteThemeAliasCommand.d.ts +37 -17
- package/dist-types/ts3.4/commands/DeleteThemeCommand.d.ts +34 -17
- package/dist-types/ts3.4/commands/DeleteUserByPrincipalIdCommand.d.ts +41 -17
- package/dist-types/ts3.4/commands/DeleteUserCommand.d.ts +34 -17
- package/dist-types/ts3.4/commands/DescribeAccountCustomizationCommand.d.ts +41 -17
- package/dist-types/ts3.4/commands/DescribeAccountSettingsCommand.d.ts +41 -17
- package/dist-types/ts3.4/commands/DescribeAccountSubscriptionCommand.d.ts +41 -17
- package/dist-types/ts3.4/commands/DescribeAnalysisCommand.d.ts +37 -17
- package/dist-types/ts3.4/commands/DescribeAnalysisPermissionsCommand.d.ts +41 -17
- package/dist-types/ts3.4/commands/DescribeDashboardCommand.d.ts +38 -17
- package/dist-types/ts3.4/commands/DescribeDashboardPermissionsCommand.d.ts +41 -17
- package/dist-types/ts3.4/commands/DescribeDataSetCommand.d.ts +37 -17
- package/dist-types/ts3.4/commands/DescribeDataSetPermissionsCommand.d.ts +41 -17
- package/dist-types/ts3.4/commands/DescribeDataSourceCommand.d.ts +38 -17
- package/dist-types/ts3.4/commands/DescribeDataSourcePermissionsCommand.d.ts +41 -17
- package/dist-types/ts3.4/commands/DescribeFolderCommand.d.ts +37 -17
- package/dist-types/ts3.4/commands/DescribeFolderPermissionsCommand.d.ts +41 -17
- package/dist-types/ts3.4/commands/DescribeFolderResolvedPermissionsCommand.d.ts +41 -17
- package/dist-types/ts3.4/commands/DescribeGroupCommand.d.ts +37 -17
- package/dist-types/ts3.4/commands/DescribeGroupMembershipCommand.d.ts +41 -17
- package/dist-types/ts3.4/commands/DescribeIAMPolicyAssignmentCommand.d.ts +41 -17
- package/dist-types/ts3.4/commands/DescribeIngestionCommand.d.ts +38 -17
- package/dist-types/ts3.4/commands/DescribeIpRestrictionCommand.d.ts +41 -17
- package/dist-types/ts3.4/commands/DescribeNamespaceCommand.d.ts +38 -17
- package/dist-types/ts3.4/commands/DescribeTemplateAliasCommand.d.ts +41 -17
- package/dist-types/ts3.4/commands/DescribeTemplateCommand.d.ts +37 -17
- package/dist-types/ts3.4/commands/DescribeTemplatePermissionsCommand.d.ts +41 -17
- package/dist-types/ts3.4/commands/DescribeThemeAliasCommand.d.ts +38 -17
- package/dist-types/ts3.4/commands/DescribeThemeCommand.d.ts +35 -18
- package/dist-types/ts3.4/commands/DescribeThemePermissionsCommand.d.ts +41 -17
- package/dist-types/ts3.4/commands/DescribeUserCommand.d.ts +34 -17
- package/dist-types/ts3.4/commands/GenerateEmbedUrlForAnonymousUserCommand.d.ts +41 -17
- package/dist-types/ts3.4/commands/GenerateEmbedUrlForRegisteredUserCommand.d.ts +41 -17
- package/dist-types/ts3.4/commands/GetDashboardEmbedUrlCommand.d.ts +41 -17
- package/dist-types/ts3.4/commands/GetSessionEmbedUrlCommand.d.ts +38 -17
- package/dist-types/ts3.4/commands/ListAnalysesCommand.d.ts +34 -17
- package/dist-types/ts3.4/commands/ListDashboardVersionsCommand.d.ts +41 -17
- package/dist-types/ts3.4/commands/ListDashboardsCommand.d.ts +37 -17
- package/dist-types/ts3.4/commands/ListDataSetsCommand.d.ts +17 -8
- package/dist-types/ts3.4/commands/ListDataSourcesCommand.d.ts +37 -17
- package/dist-types/ts3.4/commands/ListFolderMembersCommand.d.ts +38 -17
- package/dist-types/ts3.4/commands/ListFoldersCommand.d.ts +34 -17
- package/dist-types/ts3.4/commands/ListGroupMembershipsCommand.d.ts +41 -17
- package/dist-types/ts3.4/commands/ListGroupsCommand.d.ts +34 -17
- package/dist-types/ts3.4/commands/ListIAMPolicyAssignmentsCommand.d.ts +41 -17
- package/dist-types/ts3.4/commands/ListIAMPolicyAssignmentsForUserCommand.d.ts +41 -17
- package/dist-types/ts3.4/commands/ListIngestionsCommand.d.ts +37 -17
- package/dist-types/ts3.4/commands/ListNamespacesCommand.d.ts +37 -17
- package/dist-types/ts3.4/commands/ListTagsForResourceCommand.d.ts +38 -17
- package/dist-types/ts3.4/commands/ListTemplateAliasesCommand.d.ts +38 -17
- package/dist-types/ts3.4/commands/ListTemplateVersionsCommand.d.ts +41 -17
- package/dist-types/ts3.4/commands/ListTemplatesCommand.d.ts +37 -17
- package/dist-types/ts3.4/commands/ListThemeAliasesCommand.d.ts +37 -17
- package/dist-types/ts3.4/commands/ListThemeVersionsCommand.d.ts +38 -17
- package/dist-types/ts3.4/commands/ListThemesCommand.d.ts +34 -17
- package/dist-types/ts3.4/commands/ListUserGroupsCommand.d.ts +37 -17
- package/dist-types/ts3.4/commands/ListUsersCommand.d.ts +34 -17
- package/dist-types/ts3.4/commands/RegisterUserCommand.d.ts +34 -17
- package/dist-types/ts3.4/commands/RestoreAnalysisCommand.d.ts +37 -17
- package/dist-types/ts3.4/commands/SearchAnalysesCommand.d.ts +37 -17
- package/dist-types/ts3.4/commands/SearchDashboardsCommand.d.ts +37 -17
- package/dist-types/ts3.4/commands/SearchFoldersCommand.d.ts +37 -17
- package/dist-types/ts3.4/commands/SearchGroupsCommand.d.ts +34 -17
- package/dist-types/ts3.4/commands/TagResourceCommand.d.ts +34 -17
- package/dist-types/ts3.4/commands/UntagResourceCommand.d.ts +37 -17
- package/dist-types/ts3.4/commands/UpdateAccountCustomizationCommand.d.ts +41 -17
- package/dist-types/ts3.4/commands/UpdateAccountSettingsCommand.d.ts +41 -17
- package/dist-types/ts3.4/commands/UpdateAnalysisCommand.d.ts +37 -17
- package/dist-types/ts3.4/commands/UpdateAnalysisPermissionsCommand.d.ts +41 -17
- package/dist-types/ts3.4/commands/UpdateDashboardCommand.d.ts +37 -17
- package/dist-types/ts3.4/commands/UpdateDashboardPermissionsCommand.d.ts +41 -17
- package/dist-types/ts3.4/commands/UpdateDashboardPublishedVersionCommand.d.ts +41 -17
- package/dist-types/ts3.4/commands/UpdateDataSetCommand.d.ts +37 -17
- package/dist-types/ts3.4/commands/UpdateDataSetPermissionsCommand.d.ts +41 -17
- package/dist-types/ts3.4/commands/UpdateDataSourceCommand.d.ts +37 -17
- package/dist-types/ts3.4/commands/UpdateDataSourcePermissionsCommand.d.ts +41 -17
- package/dist-types/ts3.4/commands/UpdateFolderCommand.d.ts +34 -17
- package/dist-types/ts3.4/commands/UpdateFolderPermissionsCommand.d.ts +41 -17
- package/dist-types/ts3.4/commands/UpdateGroupCommand.d.ts +34 -17
- package/dist-types/ts3.4/commands/UpdateIAMPolicyAssignmentCommand.d.ts +41 -17
- package/dist-types/ts3.4/commands/UpdateIpRestrictionCommand.d.ts +38 -17
- package/dist-types/ts3.4/commands/UpdatePublicSharingSettingsCommand.d.ts +41 -17
- package/dist-types/ts3.4/commands/UpdateTemplateAliasCommand.d.ts +38 -17
- package/dist-types/ts3.4/commands/UpdateTemplateCommand.d.ts +37 -17
- package/dist-types/ts3.4/commands/UpdateTemplatePermissionsCommand.d.ts +41 -17
- package/dist-types/ts3.4/commands/UpdateThemeAliasCommand.d.ts +37 -17
- package/dist-types/ts3.4/commands/UpdateThemeCommand.d.ts +34 -17
- package/dist-types/ts3.4/commands/UpdateThemePermissionsCommand.d.ts +41 -17
- package/dist-types/ts3.4/commands/UpdateUserCommand.d.ts +34 -17
- package/dist-types/ts3.4/commands/index.d.ts +120 -120
- package/dist-types/ts3.4/endpoints.d.ts +2 -2
- package/dist-types/ts3.4/index.d.ts +6 -6
- package/dist-types/ts3.4/models/QuickSightServiceException.d.ts +8 -6
- package/dist-types/ts3.4/models/index.d.ts +2 -2
- package/dist-types/ts3.4/models/models_0.d.ts +4266 -4030
- package/dist-types/ts3.4/models/models_1.d.ts +3823 -81
- package/dist-types/ts3.4/pagination/Interfaces.d.ts +7 -6
- package/dist-types/ts3.4/pagination/ListAnalysesPaginator.d.ts +11 -4
- package/dist-types/ts3.4/pagination/ListDashboardVersionsPaginator.d.ts +11 -4
- package/dist-types/ts3.4/pagination/ListDashboardsPaginator.d.ts +11 -4
- package/dist-types/ts3.4/pagination/ListDataSetsPaginator.d.ts +11 -4
- package/dist-types/ts3.4/pagination/ListDataSourcesPaginator.d.ts +11 -4
- package/dist-types/ts3.4/pagination/ListIngestionsPaginator.d.ts +11 -4
- package/dist-types/ts3.4/pagination/ListNamespacesPaginator.d.ts +11 -4
- package/dist-types/ts3.4/pagination/ListTemplateAliasesPaginator.d.ts +11 -4
- package/dist-types/ts3.4/pagination/ListTemplateVersionsPaginator.d.ts +11 -4
- package/dist-types/ts3.4/pagination/ListTemplatesPaginator.d.ts +11 -4
- package/dist-types/ts3.4/pagination/ListThemeVersionsPaginator.d.ts +11 -4
- package/dist-types/ts3.4/pagination/ListThemesPaginator.d.ts +11 -4
- package/dist-types/ts3.4/pagination/SearchAnalysesPaginator.d.ts +11 -4
- package/dist-types/ts3.4/pagination/SearchDashboardsPaginator.d.ts +11 -4
- package/dist-types/ts3.4/pagination/index.d.ts +15 -15
- package/dist-types/ts3.4/protocols/Aws_restJson1.d.ts +1445 -362
- package/dist-types/ts3.4/runtimeConfig.browser.d.ts +66 -38
- package/dist-types/ts3.4/runtimeConfig.d.ts +66 -38
- package/dist-types/ts3.4/runtimeConfig.native.d.ts +67 -37
- package/dist-types/ts3.4/runtimeConfig.shared.d.ts +11 -11
- package/package.json +34 -34
|
@@ -4,97 +4,179 @@ import { QuickSightServiceException as __BaseException } from "./QuickSightServi
|
|
|
4
4
|
export declare enum ThemeErrorType {
|
|
5
5
|
INTERNAL_FAILURE = "INTERNAL_FAILURE"
|
|
6
6
|
}
|
|
7
|
-
|
|
7
|
+
/**
|
|
8
|
+
* <p>Theme error.</p>
|
|
9
|
+
*/
|
|
8
10
|
export interface ThemeError {
|
|
9
|
-
|
|
11
|
+
/**
|
|
12
|
+
* <p>The type of error.</p>
|
|
13
|
+
*/
|
|
10
14
|
Type?: ThemeErrorType | string;
|
|
11
|
-
|
|
15
|
+
/**
|
|
16
|
+
* <p>The error message.</p>
|
|
17
|
+
*/
|
|
12
18
|
Message?: string;
|
|
13
19
|
}
|
|
14
|
-
|
|
20
|
+
/**
|
|
21
|
+
* <p>A version of a theme.</p>
|
|
22
|
+
*/
|
|
15
23
|
export interface ThemeVersion {
|
|
16
|
-
|
|
24
|
+
/**
|
|
25
|
+
* <p>The version number of the theme.</p>
|
|
26
|
+
*/
|
|
17
27
|
VersionNumber?: number;
|
|
18
|
-
|
|
28
|
+
/**
|
|
29
|
+
* <p>The Amazon Resource Name (ARN) of the resource.</p>
|
|
30
|
+
*/
|
|
19
31
|
Arn?: string;
|
|
20
|
-
|
|
32
|
+
/**
|
|
33
|
+
* <p>The description of the theme.</p>
|
|
34
|
+
*/
|
|
21
35
|
Description?: string;
|
|
22
|
-
|
|
36
|
+
/**
|
|
37
|
+
* <p>The Amazon QuickSight-defined ID of the theme that a custom theme inherits from. All
|
|
38
|
+
* themes initially inherit from a default Amazon QuickSight theme.</p>
|
|
39
|
+
*/
|
|
23
40
|
BaseThemeId?: string;
|
|
24
|
-
|
|
41
|
+
/**
|
|
42
|
+
* <p>The date and time that this theme version was created.</p>
|
|
43
|
+
*/
|
|
25
44
|
CreatedTime?: Date;
|
|
26
|
-
|
|
45
|
+
/**
|
|
46
|
+
* <p>The theme configuration, which contains all the theme display properties.</p>
|
|
47
|
+
*/
|
|
27
48
|
Configuration?: ThemeConfiguration;
|
|
28
|
-
|
|
49
|
+
/**
|
|
50
|
+
* <p>Errors associated with the theme.</p>
|
|
51
|
+
*/
|
|
29
52
|
Errors?: ThemeError[];
|
|
30
|
-
|
|
53
|
+
/**
|
|
54
|
+
* <p>The status of the theme version.</p>
|
|
55
|
+
*/
|
|
31
56
|
Status?: ResourceStatus | string;
|
|
32
57
|
}
|
|
33
|
-
|
|
58
|
+
/**
|
|
59
|
+
* <p>Summary information about a theme.</p>
|
|
60
|
+
*/
|
|
34
61
|
export interface Theme {
|
|
35
|
-
|
|
62
|
+
/**
|
|
63
|
+
* <p>The Amazon Resource Name (ARN) of the theme.</p>
|
|
64
|
+
*/
|
|
36
65
|
Arn?: string;
|
|
37
|
-
|
|
66
|
+
/**
|
|
67
|
+
* <p>The name that the user gives to the theme.</p>
|
|
68
|
+
*/
|
|
38
69
|
Name?: string;
|
|
39
|
-
|
|
70
|
+
/**
|
|
71
|
+
* <p>The identifier that the user gives to the theme.</p>
|
|
72
|
+
*/
|
|
40
73
|
ThemeId?: string;
|
|
41
|
-
|
|
74
|
+
/**
|
|
75
|
+
* <p>A version of a theme.</p>
|
|
76
|
+
*/
|
|
42
77
|
Version?: ThemeVersion;
|
|
43
|
-
|
|
78
|
+
/**
|
|
79
|
+
* <p>The date and time that the theme was created.</p>
|
|
80
|
+
*/
|
|
44
81
|
CreatedTime?: Date;
|
|
45
|
-
|
|
82
|
+
/**
|
|
83
|
+
* <p>The date and time that the theme was last updated.</p>
|
|
84
|
+
*/
|
|
46
85
|
LastUpdatedTime?: Date;
|
|
47
|
-
|
|
86
|
+
/**
|
|
87
|
+
* <p>The type of theme, based on how it was created. Valid values include:
|
|
88
|
+
* <code>QUICKSIGHT</code> and <code>CUSTOM</code>.</p>
|
|
89
|
+
*/
|
|
48
90
|
Type?: ThemeType | string;
|
|
49
91
|
}
|
|
50
92
|
export interface DescribeThemeResponse {
|
|
51
|
-
|
|
93
|
+
/**
|
|
94
|
+
* <p>The information about the theme that you are describing.</p>
|
|
95
|
+
*/
|
|
52
96
|
Theme?: Theme;
|
|
53
|
-
|
|
97
|
+
/**
|
|
98
|
+
* <p>The HTTP status of the request.</p>
|
|
99
|
+
*/
|
|
54
100
|
Status?: number;
|
|
55
|
-
|
|
101
|
+
/**
|
|
102
|
+
* <p>The Amazon Web Services request ID for this operation.</p>
|
|
103
|
+
*/
|
|
56
104
|
RequestId?: string;
|
|
57
105
|
}
|
|
58
106
|
export interface DescribeThemeAliasRequest {
|
|
59
|
-
|
|
107
|
+
/**
|
|
108
|
+
* <p>The ID of the Amazon Web Services account that contains the theme alias that you're
|
|
109
|
+
* describing.</p>
|
|
110
|
+
*/
|
|
60
111
|
AwsAccountId: string | undefined;
|
|
61
|
-
|
|
112
|
+
/**
|
|
113
|
+
* <p>The ID for the theme.</p>
|
|
114
|
+
*/
|
|
62
115
|
ThemeId: string | undefined;
|
|
63
|
-
|
|
116
|
+
/**
|
|
117
|
+
* <p>The name of the theme alias that you want to describe.</p>
|
|
118
|
+
*/
|
|
64
119
|
AliasName: string | undefined;
|
|
65
120
|
}
|
|
66
121
|
export interface DescribeThemeAliasResponse {
|
|
67
|
-
|
|
122
|
+
/**
|
|
123
|
+
* <p>Information about the theme alias.</p>
|
|
124
|
+
*/
|
|
68
125
|
ThemeAlias?: ThemeAlias;
|
|
69
|
-
|
|
126
|
+
/**
|
|
127
|
+
* <p>The HTTP status of the request.</p>
|
|
128
|
+
*/
|
|
70
129
|
Status?: number;
|
|
71
|
-
|
|
130
|
+
/**
|
|
131
|
+
* <p>The Amazon Web Services request ID for this operation.</p>
|
|
132
|
+
*/
|
|
72
133
|
RequestId?: string;
|
|
73
134
|
}
|
|
74
135
|
export interface DescribeThemePermissionsRequest {
|
|
75
|
-
|
|
136
|
+
/**
|
|
137
|
+
* <p>The ID of the Amazon Web Services account that contains the theme that you're describing.</p>
|
|
138
|
+
*/
|
|
76
139
|
AwsAccountId: string | undefined;
|
|
77
|
-
|
|
140
|
+
/**
|
|
141
|
+
* <p>The ID for the theme that you want to describe permissions for.</p>
|
|
142
|
+
*/
|
|
78
143
|
ThemeId: string | undefined;
|
|
79
144
|
}
|
|
80
145
|
export interface DescribeThemePermissionsResponse {
|
|
81
|
-
|
|
146
|
+
/**
|
|
147
|
+
* <p>The ID for the theme.</p>
|
|
148
|
+
*/
|
|
82
149
|
ThemeId?: string;
|
|
83
|
-
|
|
150
|
+
/**
|
|
151
|
+
* <p>The Amazon Resource Name (ARN) of the theme.</p>
|
|
152
|
+
*/
|
|
84
153
|
ThemeArn?: string;
|
|
85
|
-
|
|
154
|
+
/**
|
|
155
|
+
* <p>A list of resource permissions set on the theme. </p>
|
|
156
|
+
*/
|
|
86
157
|
Permissions?: ResourcePermission[];
|
|
87
|
-
|
|
158
|
+
/**
|
|
159
|
+
* <p>The Amazon Web Services request ID for this operation.</p>
|
|
160
|
+
*/
|
|
88
161
|
RequestId?: string;
|
|
89
|
-
|
|
162
|
+
/**
|
|
163
|
+
* <p>The HTTP status of the request.</p>
|
|
164
|
+
*/
|
|
90
165
|
Status?: number;
|
|
91
166
|
}
|
|
92
167
|
export interface DescribeUserRequest {
|
|
93
|
-
|
|
168
|
+
/**
|
|
169
|
+
* <p>The name of the user that you want to describe.</p>
|
|
170
|
+
*/
|
|
94
171
|
UserName: string | undefined;
|
|
95
|
-
|
|
172
|
+
/**
|
|
173
|
+
* <p>The ID for the Amazon Web Services account that the user is in. Currently, you use the ID for the
|
|
174
|
+
* Amazon Web Services account that contains your Amazon QuickSight account.</p>
|
|
175
|
+
*/
|
|
96
176
|
AwsAccountId: string | undefined;
|
|
97
|
-
|
|
177
|
+
/**
|
|
178
|
+
* <p>The namespace. Currently, you should set this to <code>default</code>.</p>
|
|
179
|
+
*/
|
|
98
180
|
Namespace: string | undefined;
|
|
99
181
|
}
|
|
100
182
|
export declare enum IdentityType {
|
|
@@ -108,47 +190,126 @@ export declare enum UserRole {
|
|
|
108
190
|
RESTRICTED_AUTHOR = "RESTRICTED_AUTHOR",
|
|
109
191
|
RESTRICTED_READER = "RESTRICTED_READER"
|
|
110
192
|
}
|
|
111
|
-
|
|
193
|
+
/**
|
|
194
|
+
* <p>A registered user of Amazon QuickSight. </p>
|
|
195
|
+
*/
|
|
112
196
|
export interface User {
|
|
113
|
-
|
|
197
|
+
/**
|
|
198
|
+
* <p>The Amazon Resource Name (ARN) for the user.</p>
|
|
199
|
+
*/
|
|
114
200
|
Arn?: string;
|
|
115
|
-
|
|
201
|
+
/**
|
|
202
|
+
* <p>The user's user name. In the output, the value for <code>UserName</code> is
|
|
203
|
+
* <code>N/A</code> when the value for <code>IdentityType</code> is <code>IAM</code>
|
|
204
|
+
* and the corresponding IAM user is deleted.</p>
|
|
205
|
+
*/
|
|
116
206
|
UserName?: string;
|
|
117
|
-
|
|
207
|
+
/**
|
|
208
|
+
* <p>The user's email address.</p>
|
|
209
|
+
*/
|
|
118
210
|
Email?: string;
|
|
119
|
-
|
|
211
|
+
/**
|
|
212
|
+
* <p>The Amazon QuickSight role for the user. The user role can be one of the
|
|
213
|
+
* following:.</p>
|
|
214
|
+
* <ul>
|
|
215
|
+
* <li>
|
|
216
|
+
* <p>
|
|
217
|
+
* <code>READER</code>: A user who has read-only access to dashboards.</p>
|
|
218
|
+
* </li>
|
|
219
|
+
* <li>
|
|
220
|
+
* <p>
|
|
221
|
+
* <code>AUTHOR</code>: A user who can create data sources, datasets, analyses,
|
|
222
|
+
* and dashboards.</p>
|
|
223
|
+
* </li>
|
|
224
|
+
* <li>
|
|
225
|
+
* <p>
|
|
226
|
+
* <code>ADMIN</code>: A user who is an author, who can also manage Amazon
|
|
227
|
+
* Amazon QuickSight settings.</p>
|
|
228
|
+
* </li>
|
|
229
|
+
* <li>
|
|
230
|
+
* <p>
|
|
231
|
+
* <code>RESTRICTED_READER</code>: This role isn't currently available for
|
|
232
|
+
* use.</p>
|
|
233
|
+
* </li>
|
|
234
|
+
* <li>
|
|
235
|
+
* <p>
|
|
236
|
+
* <code>RESTRICTED_AUTHOR</code>: This role isn't currently available for
|
|
237
|
+
* use.</p>
|
|
238
|
+
* </li>
|
|
239
|
+
* </ul>
|
|
240
|
+
*/
|
|
120
241
|
Role?: UserRole | string;
|
|
121
|
-
|
|
242
|
+
/**
|
|
243
|
+
* <p>The type of identity authentication used by the user.</p>
|
|
244
|
+
*/
|
|
122
245
|
IdentityType?: IdentityType | string;
|
|
123
|
-
|
|
246
|
+
/**
|
|
247
|
+
* <p>The active status of user. When you create an Amazon QuickSight user that’s not an IAM
|
|
248
|
+
* user or an Active Directory user, that user is inactive until they sign in and provide a
|
|
249
|
+
* password.</p>
|
|
250
|
+
*/
|
|
124
251
|
Active?: boolean;
|
|
125
|
-
|
|
252
|
+
/**
|
|
253
|
+
* <p>The principal ID of the user.</p>
|
|
254
|
+
*/
|
|
126
255
|
PrincipalId?: string;
|
|
127
|
-
|
|
256
|
+
/**
|
|
257
|
+
* <p>The custom permissions profile associated with this user.</p>
|
|
258
|
+
*/
|
|
128
259
|
CustomPermissionsName?: string;
|
|
129
|
-
|
|
260
|
+
/**
|
|
261
|
+
* <p>The type of supported external login provider that provides identity to let the user
|
|
262
|
+
* federate into Amazon QuickSight with an associated IAM role. The type can be one of the following.</p>
|
|
263
|
+
* <ul>
|
|
264
|
+
* <li>
|
|
265
|
+
* <p>
|
|
266
|
+
* <code>COGNITO</code>: Amazon Cognito. The provider URL is cognito-identity.amazonaws.com.</p>
|
|
267
|
+
* </li>
|
|
268
|
+
* <li>
|
|
269
|
+
* <p>
|
|
270
|
+
* <code>CUSTOM_OIDC</code>: Custom OpenID Connect (OIDC) provider.</p>
|
|
271
|
+
* </li>
|
|
272
|
+
* </ul>
|
|
273
|
+
*/
|
|
130
274
|
ExternalLoginFederationProviderType?: string;
|
|
131
|
-
|
|
275
|
+
/**
|
|
276
|
+
* <p>The URL of the external login provider.</p>
|
|
277
|
+
*/
|
|
132
278
|
ExternalLoginFederationProviderUrl?: string;
|
|
133
|
-
|
|
279
|
+
/**
|
|
280
|
+
* <p>The identity ID for the user in the external login provider.</p>
|
|
281
|
+
*/
|
|
134
282
|
ExternalLoginId?: string;
|
|
135
283
|
}
|
|
136
284
|
export interface DescribeUserResponse {
|
|
137
|
-
|
|
285
|
+
/**
|
|
286
|
+
* <p>The user name.</p>
|
|
287
|
+
*/
|
|
138
288
|
User?: User;
|
|
139
|
-
|
|
289
|
+
/**
|
|
290
|
+
* <p>The Amazon Web Services request ID for this operation.</p>
|
|
291
|
+
*/
|
|
140
292
|
RequestId?: string;
|
|
141
|
-
|
|
293
|
+
/**
|
|
294
|
+
* <p>The HTTP status of the request.</p>
|
|
295
|
+
*/
|
|
142
296
|
Status?: number;
|
|
143
297
|
}
|
|
144
|
-
|
|
298
|
+
/**
|
|
299
|
+
* <p>The domain specified isn't on the allow list. All domains for embedded dashboards must be
|
|
300
|
+
* added to the approved list by an Amazon QuickSight admin.</p>
|
|
301
|
+
*/
|
|
145
302
|
export declare class DomainNotWhitelistedException extends __BaseException {
|
|
146
303
|
readonly name: "DomainNotWhitelistedException";
|
|
147
304
|
readonly $fault: "client";
|
|
148
305
|
Message?: string;
|
|
149
|
-
|
|
306
|
+
/**
|
|
307
|
+
* <p>The Amazon Web Services request ID for this request.</p>
|
|
308
|
+
*/
|
|
150
309
|
RequestId?: string;
|
|
151
|
-
|
|
310
|
+
/**
|
|
311
|
+
* @internal
|
|
312
|
+
*/
|
|
152
313
|
constructor(opts: __ExceptionOptionType<DomainNotWhitelistedException, __BaseException>);
|
|
153
314
|
}
|
|
154
315
|
export declare enum EmbeddingIdentityType {
|
|
@@ -159,55 +320,3636 @@ export declare enum EmbeddingIdentityType {
|
|
|
159
320
|
export declare enum FolderFilterAttribute {
|
|
160
321
|
PARENT_FOLDER_ARN = "PARENT_FOLDER_ARN"
|
|
161
322
|
}
|
|
162
|
-
|
|
323
|
+
/**
|
|
324
|
+
* <p>An object that consists of a member Amazon Resource Name (ARN) and a member ID.</p>
|
|
325
|
+
*/
|
|
163
326
|
export interface MemberIdArnPair {
|
|
164
|
-
|
|
327
|
+
/**
|
|
328
|
+
* <p>The ID of the member.</p>
|
|
329
|
+
*/
|
|
165
330
|
MemberId?: string;
|
|
166
|
-
|
|
331
|
+
/**
|
|
332
|
+
* <p>The Amazon Resource Name (ARN) of the member.</p>
|
|
333
|
+
*/
|
|
167
334
|
MemberArn?: string;
|
|
168
335
|
}
|
|
169
|
-
|
|
336
|
+
/**
|
|
337
|
+
* <p>A filter to use to search a Amazon QuickSight folder.</p>
|
|
338
|
+
*/
|
|
170
339
|
export interface FolderSearchFilter {
|
|
171
|
-
|
|
340
|
+
/**
|
|
341
|
+
* <p>The comparison operator that you want to use in the filter. For example, <code>"Operator": "StringEquals"</code>.</p>
|
|
342
|
+
*/
|
|
172
343
|
Operator?: FilterOperator | string;
|
|
173
|
-
|
|
344
|
+
/**
|
|
345
|
+
* <p>The name of a value that you want to use in the filter. For example, <code>"Name": "PARENT_FOLDER_ARN"</code>.</p>
|
|
346
|
+
*/
|
|
174
347
|
Name?: FolderFilterAttribute | string;
|
|
175
|
-
|
|
348
|
+
/**
|
|
349
|
+
* <p>The value of the named item (in this example, <code>PARENT_FOLDER_ARN</code>), that you want to use as a filter. For example, <code>"Value": "arn:aws:quicksight:us-east-1:1:folder/folderId"</code>.</p>
|
|
350
|
+
*/
|
|
176
351
|
Value?: string;
|
|
177
352
|
}
|
|
178
|
-
|
|
353
|
+
/**
|
|
354
|
+
* <p>A summary of information about an existing Amazon QuickSight folder. </p>
|
|
355
|
+
*/
|
|
179
356
|
export interface FolderSummary {
|
|
180
|
-
|
|
357
|
+
/**
|
|
358
|
+
* <p>The Amazon Resource Name (ARN) of the folder.</p>
|
|
359
|
+
*/
|
|
181
360
|
Arn?: string;
|
|
182
|
-
|
|
361
|
+
/**
|
|
362
|
+
* <p>The ID of the folder.</p>
|
|
363
|
+
*/
|
|
183
364
|
FolderId?: string;
|
|
184
|
-
|
|
365
|
+
/**
|
|
366
|
+
* <p>The display name of the folder.</p>
|
|
367
|
+
*/
|
|
185
368
|
Name?: string;
|
|
186
|
-
|
|
369
|
+
/**
|
|
370
|
+
* <p>The type of folder.</p>
|
|
371
|
+
*/
|
|
187
372
|
FolderType?: FolderType | string;
|
|
188
|
-
|
|
373
|
+
/**
|
|
374
|
+
* <p>The time that the folder was created.</p>
|
|
375
|
+
*/
|
|
189
376
|
CreatedTime?: Date;
|
|
190
|
-
|
|
377
|
+
/**
|
|
378
|
+
* <p>The time that the folder was last updated.</p>
|
|
379
|
+
*/
|
|
191
380
|
LastUpdatedTime?: Date;
|
|
192
381
|
}
|
|
193
|
-
|
|
382
|
+
/**
|
|
383
|
+
* <p>The key-value pair used for the row-level security tags feature.</p>
|
|
384
|
+
*/
|
|
194
385
|
export interface SessionTag {
|
|
195
|
-
|
|
386
|
+
/**
|
|
387
|
+
* <p>The key for the tag.</p>
|
|
388
|
+
*/
|
|
196
389
|
Key: string | undefined;
|
|
197
|
-
|
|
390
|
+
/**
|
|
391
|
+
* <p>The value that you want to assign the tag.</p>
|
|
392
|
+
*/
|
|
198
393
|
Value: string | undefined;
|
|
199
394
|
}
|
|
200
395
|
export interface GenerateEmbedUrlForAnonymousUserRequest {
|
|
201
|
-
|
|
396
|
+
/**
|
|
397
|
+
* <p>The ID for the Amazon Web Services account that contains the dashboard that you're embedding.</p>
|
|
398
|
+
*/
|
|
202
399
|
AwsAccountId: string | undefined;
|
|
203
|
-
|
|
400
|
+
/**
|
|
401
|
+
* <p>How many minutes the session is valid. The session lifetime must be in [15-600] minutes range.</p>
|
|
402
|
+
*/
|
|
204
403
|
SessionLifetimeInMinutes?: number;
|
|
205
|
-
|
|
404
|
+
/**
|
|
405
|
+
* <p>The Amazon QuickSight namespace that the anonymous user virtually belongs to. If you are not using an Amazon QuickSight custom namespace, set this to <code>default</code>.</p>
|
|
406
|
+
*/
|
|
206
407
|
Namespace: string | undefined;
|
|
207
|
-
|
|
408
|
+
/**
|
|
409
|
+
* <p>The session tags used for row-level security. Before you use this parameter, make sure that you have configured the relevant datasets using the <code>DataSet$RowLevelPermissionTagConfiguration</code> parameter so that session tags can be used to provide row-level security.</p>
|
|
410
|
+
* <p>These are not the tags used for the Amazon Web Services resource tagging feature. For more information, 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>
|
|
411
|
+
*/
|
|
208
412
|
SessionTags?: SessionTag[];
|
|
209
|
-
|
|
413
|
+
/**
|
|
414
|
+
* <p>The Amazon Resource Names (ARNs) for the Amazon QuickSight resources that the user
|
|
415
|
+
* is authorized to access during the lifetime of the session. If you choose
|
|
416
|
+
* <code>Dashboard</code> embedding experience, pass the list of dashboard ARNs in the
|
|
417
|
+
* account that you want the user to be able to view. Currently, you can pass up to 25
|
|
418
|
+
* dashboard ARNs in each API call.</p>
|
|
419
|
+
*/
|
|
210
420
|
AuthorizedResourceArns: string[] | undefined;
|
|
211
|
-
|
|
421
|
+
/**
|
|
422
|
+
* <p>The configuration of the experience that you are embedding.</p>
|
|
423
|
+
*/
|
|
212
424
|
ExperienceConfiguration: AnonymousUserEmbeddingExperienceConfiguration | undefined;
|
|
213
|
-
|
|
425
|
+
/**
|
|
426
|
+
* <p>The domains that you want to add to the allow list for access to the generated URL that
|
|
427
|
+
* is then embedded. This optional parameter overrides the static domains that are
|
|
428
|
+
* configured in the Manage QuickSight menu in the Amazon QuickSight console. Instead, it
|
|
429
|
+
* allows only the domains that you include in this parameter. You can list up to three
|
|
430
|
+
* domains or subdomains in each API call.</p>
|
|
431
|
+
* <p>To include all subdomains under a specific domain to the allow list, use <code>*</code>.
|
|
432
|
+
* For example, <code>https://*.sapp.amazon.com</code> includes all subdomains under
|
|
433
|
+
* <code>https://sapp.amazon.com</code>.</p>
|
|
434
|
+
*/
|
|
435
|
+
AllowedDomains?: string[];
|
|
436
|
+
}
|
|
437
|
+
export interface GenerateEmbedUrlForAnonymousUserResponse {
|
|
438
|
+
/**
|
|
439
|
+
* <p>The embed URL for the dashboard.</p>
|
|
440
|
+
*/
|
|
441
|
+
EmbedUrl: string | undefined;
|
|
442
|
+
/**
|
|
443
|
+
* <p>The HTTP status of the request.</p>
|
|
444
|
+
*/
|
|
445
|
+
Status: number | undefined;
|
|
446
|
+
/**
|
|
447
|
+
* <p>The Amazon Web Services request ID for this operation.</p>
|
|
448
|
+
*/
|
|
449
|
+
RequestId: string | undefined;
|
|
450
|
+
}
|
|
451
|
+
/**
|
|
452
|
+
* <p>The number of minutes specified for the lifetime of a session isn't valid. The session
|
|
453
|
+
* lifetime must be 15-600 minutes.</p>
|
|
454
|
+
*/
|
|
455
|
+
export declare class SessionLifetimeInMinutesInvalidException extends __BaseException {
|
|
456
|
+
readonly name: "SessionLifetimeInMinutesInvalidException";
|
|
457
|
+
readonly $fault: "client";
|
|
458
|
+
Message?: string;
|
|
459
|
+
/**
|
|
460
|
+
* <p>The Amazon Web Services request ID for this request.</p>
|
|
461
|
+
*/
|
|
462
|
+
RequestId?: string;
|
|
463
|
+
/**
|
|
464
|
+
* @internal
|
|
465
|
+
*/
|
|
466
|
+
constructor(opts: __ExceptionOptionType<SessionLifetimeInMinutesInvalidException, __BaseException>);
|
|
467
|
+
}
|
|
468
|
+
/**
|
|
469
|
+
* <p>This error indicates that you are calling an embedding operation in Amazon QuickSight
|
|
470
|
+
* without the required pricing plan on your Amazon Web Services account. Before you can use embedding
|
|
471
|
+
* for anonymous users, a QuickSight administrator needs to add capacity pricing to Amazon QuickSight. You
|
|
472
|
+
* can do this on the <b>Manage Amazon QuickSight</b> page. </p>
|
|
473
|
+
* <p>After capacity pricing is added, you can use the
|
|
474
|
+
* <code>
|
|
475
|
+
* <a href="https://docs.aws.amazon.com/quicksight/latest/APIReference/API_GetDashboardEmbedUrl.html">GetDashboardEmbedUrl</a>
|
|
476
|
+
* </code> API operation with the
|
|
477
|
+
* <code>--identity-type ANONYMOUS</code> option.</p>
|
|
478
|
+
*/
|
|
479
|
+
export declare class UnsupportedPricingPlanException extends __BaseException {
|
|
480
|
+
readonly name: "UnsupportedPricingPlanException";
|
|
481
|
+
readonly $fault: "client";
|
|
482
|
+
Message?: string;
|
|
483
|
+
/**
|
|
484
|
+
* <p>The Amazon Web Services request ID for this request.</p>
|
|
485
|
+
*/
|
|
486
|
+
RequestId?: string;
|
|
487
|
+
/**
|
|
488
|
+
* @internal
|
|
489
|
+
*/
|
|
490
|
+
constructor(opts: __ExceptionOptionType<UnsupportedPricingPlanException, __BaseException>);
|
|
491
|
+
}
|
|
492
|
+
/**
|
|
493
|
+
* <p>Information about the dashboard you want to embed.</p>
|
|
494
|
+
*/
|
|
495
|
+
export interface RegisteredUserDashboardEmbeddingConfiguration {
|
|
496
|
+
/**
|
|
497
|
+
* <p>The dashboard ID for the dashboard that you want the user to see first. This ID is included in the output URL. When the URL in response is accessed, Amazon QuickSight renders this dashboard if the user has permissions to view it.</p>
|
|
498
|
+
* <p>If the user does not have permission to view this dashboard, they see a permissions error message.</p>
|
|
499
|
+
*/
|
|
500
|
+
InitialDashboardId: string | undefined;
|
|
501
|
+
}
|
|
502
|
+
/**
|
|
503
|
+
* <p>The experience that you are embedding. You can use this object to generate a url that embeds a visual into your application.</p>
|
|
504
|
+
*/
|
|
505
|
+
export interface RegisteredUserDashboardVisualEmbeddingConfiguration {
|
|
506
|
+
/**
|
|
507
|
+
* <p>The visual ID for the visual that you want the user to embed. This ID is included in the output URL. When the URL in response is accessed, Amazon QuickSight renders this visual.</p>
|
|
508
|
+
* <p>The Amazon Resource Name (ARN) of the dashboard that the visual belongs to must be included in the <code>AuthorizedResourceArns</code> parameter. Otherwise, the request will fail with <code>InvalidParameterValueException</code>.</p>
|
|
509
|
+
*/
|
|
510
|
+
InitialDashboardVisualId: DashboardVisualId | undefined;
|
|
511
|
+
}
|
|
512
|
+
/**
|
|
513
|
+
* <p>Information about the Q search bar embedding experience.</p>
|
|
514
|
+
*/
|
|
515
|
+
export interface RegisteredUserQSearchBarEmbeddingConfiguration {
|
|
516
|
+
/**
|
|
517
|
+
* <p>The ID of the Q topic that you want to make the starting topic in the Q search bar.
|
|
518
|
+
* You can find a topic ID by navigating to the Topics pane in the Amazon QuickSight application and opening
|
|
519
|
+
* a topic. The ID is in the URL for the topic that you open.</p>
|
|
520
|
+
* <p>If you don't specify an initial topic, a list of all shared topics is shown in the Q bar
|
|
521
|
+
* for your readers. When you select an initial topic, you can specify whether or not readers
|
|
522
|
+
* are allowed to select other topics from the available ones in the list.</p>
|
|
523
|
+
*/
|
|
524
|
+
InitialTopicId?: string;
|
|
525
|
+
}
|
|
526
|
+
/**
|
|
527
|
+
* <p>Information about the Amazon QuickSight console that you want to embed.</p>
|
|
528
|
+
*/
|
|
529
|
+
export interface RegisteredUserQuickSightConsoleEmbeddingConfiguration {
|
|
530
|
+
/**
|
|
531
|
+
* <p>The initial URL path for the Amazon QuickSight console. <code>InitialPath</code> is required.</p>
|
|
532
|
+
* <p>The entry point URL is constrained to the following paths:</p>
|
|
533
|
+
* <ul>
|
|
534
|
+
* <li>
|
|
535
|
+
* <p>
|
|
536
|
+
* <code>/start</code>
|
|
537
|
+
* </p>
|
|
538
|
+
* </li>
|
|
539
|
+
* <li>
|
|
540
|
+
* <p>
|
|
541
|
+
* <code>/start/analyses</code>
|
|
542
|
+
* </p>
|
|
543
|
+
* </li>
|
|
544
|
+
* <li>
|
|
545
|
+
* <p>
|
|
546
|
+
* <code>/start/dashboards</code>
|
|
547
|
+
* </p>
|
|
548
|
+
* </li>
|
|
549
|
+
* <li>
|
|
550
|
+
* <p>
|
|
551
|
+
* <code>/start/favorites</code>
|
|
552
|
+
* </p>
|
|
553
|
+
* </li>
|
|
554
|
+
* <li>
|
|
555
|
+
* <p>
|
|
556
|
+
* <code>/dashboards/DashboardId</code>. <i>DashboardId</i> is the actual ID key from the Amazon QuickSight console URL of the dashboard.</p>
|
|
557
|
+
* </li>
|
|
558
|
+
* <li>
|
|
559
|
+
* <p>
|
|
560
|
+
* <code>/analyses/AnalysisId</code>. <i>AnalysisId</i> is the actual ID key from the Amazon QuickSight console URL of the analysis.</p>
|
|
561
|
+
* </li>
|
|
562
|
+
* </ul>
|
|
563
|
+
*/
|
|
564
|
+
InitialPath?: string;
|
|
565
|
+
}
|
|
566
|
+
/**
|
|
567
|
+
* <p>The type of experience you want to embed. For registered users, you can embed Amazon QuickSight dashboards or the Amazon QuickSight console.</p>
|
|
568
|
+
* <note>
|
|
569
|
+
* <p>Exactly one of the experience configurations is required. You can choose
|
|
570
|
+
* <code>Dashboard</code> or <code>QuickSightConsole</code>. You cannot choose more
|
|
571
|
+
* than one experience configuration.</p>
|
|
572
|
+
* </note>
|
|
573
|
+
*/
|
|
574
|
+
export interface RegisteredUserEmbeddingExperienceConfiguration {
|
|
575
|
+
/**
|
|
576
|
+
* <p>The configuration details for providing a dashboard embedding experience.</p>
|
|
577
|
+
*/
|
|
578
|
+
Dashboard?: RegisteredUserDashboardEmbeddingConfiguration;
|
|
579
|
+
/**
|
|
580
|
+
* <p>The configuration details for providing each Amazon QuickSight console embedding experience. This can be used along with custom permissions to restrict access to certain 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 QuickSight Console</a> in the <i>Amazon QuickSight User
|
|
581
|
+
* Guide</i>.</p>
|
|
582
|
+
* <p>Use <code>
|
|
583
|
+
* <a href="https://docs.aws.amazon.com/quicksight/latest/APIReference/API_GenerateEmbedUrlForRegisteredUser.html">GenerateEmbedUrlForRegisteredUser</a>
|
|
584
|
+
* </code>
|
|
585
|
+
* where
|
|
586
|
+
* you want to provide an authoring portal that allows users to create data sources,
|
|
587
|
+
* datasets, analyses, and dashboards. The users who accesses an embedded Amazon QuickSight console
|
|
588
|
+
* needs to belong to the author or admin security cohort. If you want to restrict permissions
|
|
589
|
+
* to some of these features, add a custom permissions profile to the user with the
|
|
590
|
+
* <code>
|
|
591
|
+
* <a href="https://docs.aws.amazon.com/quicksight/latest/APIReference/API_UpdateUser.html">UpdateUser</a>
|
|
592
|
+
* </code> API operation. Use the <code>
|
|
593
|
+
* <a href="https://docs.aws.amazon.com/quicksight/latest/APIReference/API_RegisterUser.html">RegisterUser</a>
|
|
594
|
+
* </code> API operation to add a new user with a custom permission profile attached. For more
|
|
595
|
+
* information, see the following sections in the <i>Amazon QuickSight User
|
|
596
|
+
* Guide</i>:</p>
|
|
597
|
+
* <ul>
|
|
598
|
+
* <li>
|
|
599
|
+
* <p>
|
|
600
|
+
* <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 QuickSight Console for Authenticated Users</a>
|
|
601
|
+
* </p>
|
|
602
|
+
* </li>
|
|
603
|
+
* <li>
|
|
604
|
+
* <p>
|
|
605
|
+
* <a href="https://docs.aws.amazon.com/quicksight/latest/user/customizing-permissions-to-the-quicksight-console.html">Customizing Access to the Amazon QuickSight Console</a>
|
|
606
|
+
* </p>
|
|
607
|
+
* </li>
|
|
608
|
+
* </ul>
|
|
609
|
+
* <p>For more information about the high-level steps for embedding and for an interactive 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 QuickSight Developer Portal</a>.</p>
|
|
610
|
+
*/
|
|
611
|
+
QuickSightConsole?: RegisteredUserQuickSightConsoleEmbeddingConfiguration;
|
|
612
|
+
/**
|
|
613
|
+
* <p>The configuration details for embedding the Q search bar.</p>
|
|
614
|
+
* <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
|
|
615
|
+
* the <i>Amazon QuickSight User Guide</i>.</p>
|
|
616
|
+
*/
|
|
617
|
+
QSearchBar?: RegisteredUserQSearchBarEmbeddingConfiguration;
|
|
618
|
+
/**
|
|
619
|
+
* <p>The type of embedding experience. In this case, Amazon QuickSight visuals.</p>
|
|
620
|
+
*/
|
|
621
|
+
DashboardVisual?: RegisteredUserDashboardVisualEmbeddingConfiguration;
|
|
622
|
+
}
|
|
623
|
+
export interface GenerateEmbedUrlForRegisteredUserRequest {
|
|
624
|
+
/**
|
|
625
|
+
* <p>The ID for the Amazon Web Services account that contains the dashboard that you're embedding.</p>
|
|
626
|
+
*/
|
|
627
|
+
AwsAccountId: string | undefined;
|
|
628
|
+
/**
|
|
629
|
+
* <p>How many minutes the session is valid. The session lifetime must be in [15-600] minutes range.</p>
|
|
630
|
+
*/
|
|
631
|
+
SessionLifetimeInMinutes?: number;
|
|
632
|
+
/**
|
|
633
|
+
* <p>The Amazon Resource Name for the registered user.</p>
|
|
634
|
+
*/
|
|
635
|
+
UserArn: string | undefined;
|
|
636
|
+
/**
|
|
637
|
+
* <p>The experience you are embedding. For registered users, you can embed Amazon QuickSight dashboards, Amazon QuickSight visuals, the Amazon QuickSight Q search bar, or the entire Amazon QuickSight console.</p>
|
|
638
|
+
*/
|
|
639
|
+
ExperienceConfiguration: RegisteredUserEmbeddingExperienceConfiguration | undefined;
|
|
640
|
+
/**
|
|
641
|
+
* <p>The domains that you want to add to the allow list for access to the generated URL that
|
|
642
|
+
* is then embedded. This optional parameter overrides the static domains that are
|
|
643
|
+
* configured in the Manage QuickSight menu in the Amazon QuickSight console. Instead, it
|
|
644
|
+
* allows only the domains that you include in this parameter. You can list up to three
|
|
645
|
+
* domains or subdomains in each API call.</p>
|
|
646
|
+
* <p>To include all subdomains under a specific domain to the allow list, use <code>*</code>.
|
|
647
|
+
* For example, <code>https://*.sapp.amazon.com</code> includes all subdomains under
|
|
648
|
+
* <code>https://sapp.amazon.com</code>.</p>
|
|
649
|
+
*/
|
|
650
|
+
AllowedDomains?: string[];
|
|
651
|
+
}
|
|
652
|
+
export interface GenerateEmbedUrlForRegisteredUserResponse {
|
|
653
|
+
/**
|
|
654
|
+
* <p>The embed URL for the Amazon QuickSight dashboard, visual, Q search bar, or console.</p>
|
|
655
|
+
*/
|
|
656
|
+
EmbedUrl: string | undefined;
|
|
657
|
+
/**
|
|
658
|
+
* <p>The HTTP status of the request.</p>
|
|
659
|
+
*/
|
|
660
|
+
Status: number | undefined;
|
|
661
|
+
/**
|
|
662
|
+
* <p>The Amazon Web Services request ID for this operation.</p>
|
|
663
|
+
*/
|
|
664
|
+
RequestId: string | undefined;
|
|
665
|
+
}
|
|
666
|
+
/**
|
|
667
|
+
* <p>The user with the provided name isn't found. This error can happen in any operation
|
|
668
|
+
* that requires finding a user based on a provided user name, such as
|
|
669
|
+
* <code>DeleteUser</code>, <code>DescribeUser</code>, and so on.</p>
|
|
670
|
+
*/
|
|
671
|
+
export declare class QuickSightUserNotFoundException extends __BaseException {
|
|
672
|
+
readonly name: "QuickSightUserNotFoundException";
|
|
673
|
+
readonly $fault: "client";
|
|
674
|
+
Message?: string;
|
|
675
|
+
/**
|
|
676
|
+
* <p>The Amazon Web Services request ID for this request.</p>
|
|
677
|
+
*/
|
|
678
|
+
RequestId?: string;
|
|
679
|
+
/**
|
|
680
|
+
* @internal
|
|
681
|
+
*/
|
|
682
|
+
constructor(opts: __ExceptionOptionType<QuickSightUserNotFoundException, __BaseException>);
|
|
683
|
+
}
|
|
684
|
+
export interface GetDashboardEmbedUrlRequest {
|
|
685
|
+
/**
|
|
686
|
+
* <p>The ID for the Amazon Web Services account that contains the dashboard that you're embedding.</p>
|
|
687
|
+
*/
|
|
688
|
+
AwsAccountId: string | undefined;
|
|
689
|
+
/**
|
|
690
|
+
* <p>The ID for the dashboard, also added to the Identity and Access Management (IAM)
|
|
691
|
+
* policy.</p>
|
|
692
|
+
*/
|
|
693
|
+
DashboardId: string | undefined;
|
|
694
|
+
/**
|
|
695
|
+
* <p>The authentication method that the user uses to sign in.</p>
|
|
696
|
+
*/
|
|
697
|
+
IdentityType: EmbeddingIdentityType | string | undefined;
|
|
698
|
+
/**
|
|
699
|
+
* <p>How many minutes the session is valid. The session lifetime must be 15-600 minutes.</p>
|
|
700
|
+
*/
|
|
701
|
+
SessionLifetimeInMinutes?: number;
|
|
702
|
+
/**
|
|
703
|
+
* <p>Remove the undo/redo button on the embedded dashboard. The default is FALSE, which enables
|
|
704
|
+
* the undo/redo button.</p>
|
|
705
|
+
*/
|
|
706
|
+
UndoRedoDisabled?: boolean;
|
|
707
|
+
/**
|
|
708
|
+
* <p>Remove the reset button on the embedded dashboard. The default is FALSE, which enables the
|
|
709
|
+
* reset button.</p>
|
|
710
|
+
*/
|
|
711
|
+
ResetDisabled?: boolean;
|
|
712
|
+
/**
|
|
713
|
+
* <p>Adds persistence of state for the user session in an embedded dashboard. Persistence
|
|
714
|
+
* applies to the sheet and the parameter settings. These are control settings that the
|
|
715
|
+
* dashboard subscriber (Amazon QuickSight reader) chooses while viewing the dashboard. If this is
|
|
716
|
+
* set to <code>TRUE</code>, the settings are the same when the subscriber reopens the same
|
|
717
|
+
* dashboard URL. The state is stored in Amazon QuickSight, not in a browser cookie. If this is
|
|
718
|
+
* set to FALSE, the state of the user session is not persisted. The default is
|
|
719
|
+
* <code>FALSE</code>.</p>
|
|
720
|
+
*/
|
|
721
|
+
StatePersistenceEnabled?: boolean;
|
|
722
|
+
/**
|
|
723
|
+
* <p>The Amazon QuickSight user's Amazon Resource Name (ARN), for use with <code>QUICKSIGHT</code> identity type.
|
|
724
|
+
* You can use this for any Amazon QuickSight users in your account (readers, authors, or
|
|
725
|
+
* admins) authenticated as one of the following:</p>
|
|
726
|
+
* <ul>
|
|
727
|
+
* <li>
|
|
728
|
+
* <p>Active Directory (AD) users or group members</p>
|
|
729
|
+
* </li>
|
|
730
|
+
* <li>
|
|
731
|
+
* <p>Invited nonfederated users</p>
|
|
732
|
+
* </li>
|
|
733
|
+
* <li>
|
|
734
|
+
* <p>IAM users and IAM role-based sessions authenticated through Federated Single Sign-On using
|
|
735
|
+
* SAML, OpenID Connect, or IAM federation.</p>
|
|
736
|
+
* </li>
|
|
737
|
+
* </ul>
|
|
738
|
+
* <p>Omit this parameter for users in the third group – IAM users and IAM
|
|
739
|
+
* role-based sessions.</p>
|
|
740
|
+
*/
|
|
741
|
+
UserArn?: string;
|
|
742
|
+
/**
|
|
743
|
+
* <p>The Amazon QuickSight namespace that contains the dashboard IDs in this request.
|
|
744
|
+
* If you're not using a custom namespace, set <code>Namespace = default</code>.</p>
|
|
745
|
+
*/
|
|
746
|
+
Namespace?: string;
|
|
747
|
+
/**
|
|
748
|
+
* <p>A list of one or more dashboard IDs that you want anonymous users to have tempporary access to. Currently, the <code>IdentityType</code> parameter must be set to <code>ANONYMOUS</code> because other identity types authenticate as Amazon QuickSight or IAM users. For example, if you set "<code>--dashboard-id dash_id1 --dashboard-id dash_id2 dash_id3 identity-type ANONYMOUS</code>", the session can access all three dashboards.</p>
|
|
749
|
+
*/
|
|
750
|
+
AdditionalDashboardIds?: string[];
|
|
751
|
+
}
|
|
752
|
+
/**
|
|
753
|
+
* <p>Output returned from the <code>GetDashboardEmbedUrl</code> operation.</p>
|
|
754
|
+
*/
|
|
755
|
+
export interface GetDashboardEmbedUrlResponse {
|
|
756
|
+
/**
|
|
757
|
+
* <p>A single-use URL that you can put into your server-side webpage to embed your
|
|
758
|
+
* dashboard. This URL is valid for 5 minutes. The API operation provides the URL with an
|
|
759
|
+
* <code>auth_code</code> value that enables one (and only one) sign-on to a user session
|
|
760
|
+
* that is valid for 10 hours. </p>
|
|
761
|
+
*/
|
|
762
|
+
EmbedUrl?: string;
|
|
763
|
+
/**
|
|
764
|
+
* <p>The HTTP status of the request.</p>
|
|
765
|
+
*/
|
|
766
|
+
Status?: number;
|
|
767
|
+
/**
|
|
768
|
+
* <p>The Amazon Web Services request ID for this operation.</p>
|
|
769
|
+
*/
|
|
770
|
+
RequestId?: string;
|
|
771
|
+
}
|
|
772
|
+
/**
|
|
773
|
+
* <p>The identity type specified isn't supported. Supported identity types include
|
|
774
|
+
* <code>IAM</code> and <code>QUICKSIGHT</code>.</p>
|
|
775
|
+
*/
|
|
776
|
+
export declare class IdentityTypeNotSupportedException extends __BaseException {
|
|
777
|
+
readonly name: "IdentityTypeNotSupportedException";
|
|
778
|
+
readonly $fault: "client";
|
|
779
|
+
Message?: string;
|
|
780
|
+
/**
|
|
781
|
+
* <p>The Amazon Web Services request ID for this request.</p>
|
|
782
|
+
*/
|
|
783
|
+
RequestId?: string;
|
|
784
|
+
/**
|
|
785
|
+
* @internal
|
|
786
|
+
*/
|
|
787
|
+
constructor(opts: __ExceptionOptionType<IdentityTypeNotSupportedException, __BaseException>);
|
|
788
|
+
}
|
|
789
|
+
export interface GetSessionEmbedUrlRequest {
|
|
790
|
+
/**
|
|
791
|
+
* <p>The ID for the Amazon Web Services account associated with your Amazon QuickSight subscription.</p>
|
|
792
|
+
*/
|
|
793
|
+
AwsAccountId: string | undefined;
|
|
794
|
+
/**
|
|
795
|
+
* <p>The URL you use to access the embedded session. The entry point URL is constrained to
|
|
796
|
+
* the following paths:</p>
|
|
797
|
+
* <ul>
|
|
798
|
+
* <li>
|
|
799
|
+
* <p>
|
|
800
|
+
* <code>/start</code>
|
|
801
|
+
* </p>
|
|
802
|
+
* </li>
|
|
803
|
+
* <li>
|
|
804
|
+
* <p>
|
|
805
|
+
* <code>/start/analyses</code>
|
|
806
|
+
* </p>
|
|
807
|
+
* </li>
|
|
808
|
+
* <li>
|
|
809
|
+
* <p>
|
|
810
|
+
* <code>/start/dashboards</code>
|
|
811
|
+
* </p>
|
|
812
|
+
* </li>
|
|
813
|
+
* <li>
|
|
814
|
+
* <p>
|
|
815
|
+
* <code>/start/favorites</code>
|
|
816
|
+
* </p>
|
|
817
|
+
* </li>
|
|
818
|
+
* <li>
|
|
819
|
+
* <p>
|
|
820
|
+
* <code>/dashboards/<i>DashboardId</i>
|
|
821
|
+
* </code> - where <code>DashboardId</code> is the actual ID key from the Amazon QuickSight console URL of the dashboard</p>
|
|
822
|
+
* </li>
|
|
823
|
+
* <li>
|
|
824
|
+
* <p>
|
|
825
|
+
* <code>/analyses/<i>AnalysisId</i>
|
|
826
|
+
* </code> - where <code>AnalysisId</code> is the actual ID key from the Amazon QuickSight console URL of the analysis</p>
|
|
827
|
+
* </li>
|
|
828
|
+
* </ul>
|
|
829
|
+
*/
|
|
830
|
+
EntryPoint?: string;
|
|
831
|
+
/**
|
|
832
|
+
* <p>How many minutes the session is valid. The session lifetime must be 15-600 minutes.</p>
|
|
833
|
+
*/
|
|
834
|
+
SessionLifetimeInMinutes?: number;
|
|
835
|
+
/**
|
|
836
|
+
* <p>The Amazon QuickSight user's Amazon Resource Name (ARN), for use with <code>QUICKSIGHT</code> identity type.
|
|
837
|
+
* You can use this for any type of Amazon QuickSight users in your account (readers, authors, or
|
|
838
|
+
* admins). They need to be authenticated as one of the following:</p>
|
|
839
|
+
* <ol>
|
|
840
|
+
* <li>
|
|
841
|
+
* <p>Active Directory (AD) users or group members</p>
|
|
842
|
+
* </li>
|
|
843
|
+
* <li>
|
|
844
|
+
* <p>Invited nonfederated users</p>
|
|
845
|
+
* </li>
|
|
846
|
+
* <li>
|
|
847
|
+
* <p>Identity and Access Management (IAM) users and IAM role-based sessions authenticated
|
|
848
|
+
* through Federated Single Sign-On using SAML, OpenID Connect, or IAM
|
|
849
|
+
* federation</p>
|
|
850
|
+
* </li>
|
|
851
|
+
* </ol>
|
|
852
|
+
* <p>Omit this parameter for users in the third group, IAM users and IAM role-based
|
|
853
|
+
* sessions.</p>
|
|
854
|
+
*/
|
|
855
|
+
UserArn?: string;
|
|
856
|
+
}
|
|
857
|
+
export interface GetSessionEmbedUrlResponse {
|
|
858
|
+
/**
|
|
859
|
+
* <p>A single-use URL that you can put into your server-side web page to embed your
|
|
860
|
+
* Amazon QuickSight session. This URL is valid for 5 minutes. The API operation provides the URL with an
|
|
861
|
+
* <code>auth_code</code> value that enables one (and only one) sign-on to a user session
|
|
862
|
+
* that is valid for 10 hours. </p>
|
|
863
|
+
*/
|
|
864
|
+
EmbedUrl?: string;
|
|
865
|
+
/**
|
|
866
|
+
* <p>The HTTP status of the request.</p>
|
|
867
|
+
*/
|
|
868
|
+
Status?: number;
|
|
869
|
+
/**
|
|
870
|
+
* <p>The Amazon Web Services request ID for this operation.</p>
|
|
871
|
+
*/
|
|
872
|
+
RequestId?: string;
|
|
873
|
+
}
|
|
874
|
+
export declare enum GroupFilterAttribute {
|
|
875
|
+
GROUP_NAME = "GROUP_NAME"
|
|
876
|
+
}
|
|
877
|
+
export declare enum GroupFilterOperator {
|
|
878
|
+
StartsWith = "StartsWith"
|
|
879
|
+
}
|
|
880
|
+
/**
|
|
881
|
+
* <p>A <code>GroupSearchFilter</code> object that you want to apply to your search.</p>
|
|
882
|
+
*/
|
|
883
|
+
export interface GroupSearchFilter {
|
|
884
|
+
/**
|
|
885
|
+
* <p>The comparison operator that you want to use as a filter, for example <code>"Operator":
|
|
886
|
+
* "StartsWith"</code>. Currently, the only supported operator is
|
|
887
|
+
* <code>StartsWith</code>.</p>
|
|
888
|
+
*/
|
|
889
|
+
Operator: GroupFilterOperator | string | undefined;
|
|
890
|
+
/**
|
|
891
|
+
* <p>The name of the value that you want to use as a filter, for example <code>"Name":
|
|
892
|
+
* "GROUP_NAME"</code>. Currently, the only supported name is
|
|
893
|
+
* <code>GROUP_NAME</code>.</p>
|
|
894
|
+
*/
|
|
895
|
+
Name: GroupFilterAttribute | string | undefined;
|
|
896
|
+
/**
|
|
897
|
+
* <p>The value of the named item, in this case <code>GROUP_NAME</code>, that you want to use as a filter.</p>
|
|
898
|
+
*/
|
|
899
|
+
Value: string | undefined;
|
|
900
|
+
}
|
|
901
|
+
/**
|
|
902
|
+
* <p>IAM policy assignment summary.</p>
|
|
903
|
+
*/
|
|
904
|
+
export interface IAMPolicyAssignmentSummary {
|
|
905
|
+
/**
|
|
906
|
+
* <p>Assignment name.</p>
|
|
907
|
+
*/
|
|
908
|
+
AssignmentName?: string;
|
|
909
|
+
/**
|
|
910
|
+
* <p>Assignment status.</p>
|
|
911
|
+
*/
|
|
912
|
+
AssignmentStatus?: AssignmentStatus | string;
|
|
913
|
+
}
|
|
914
|
+
export interface ListAnalysesRequest {
|
|
915
|
+
/**
|
|
916
|
+
* <p>The ID of the Amazon Web Services account that contains the analyses.</p>
|
|
917
|
+
*/
|
|
918
|
+
AwsAccountId: string | undefined;
|
|
919
|
+
/**
|
|
920
|
+
* <p>A pagination token that can be used in a subsequent request.</p>
|
|
921
|
+
*/
|
|
922
|
+
NextToken?: string;
|
|
923
|
+
/**
|
|
924
|
+
* <p>The maximum number of results to return.</p>
|
|
925
|
+
*/
|
|
926
|
+
MaxResults?: number;
|
|
927
|
+
}
|
|
928
|
+
export interface ListAnalysesResponse {
|
|
929
|
+
/**
|
|
930
|
+
* <p>Metadata describing each of the analyses that are listed.</p>
|
|
931
|
+
*/
|
|
932
|
+
AnalysisSummaryList?: AnalysisSummary[];
|
|
933
|
+
/**
|
|
934
|
+
* <p>A pagination token that can be used in a subsequent request.</p>
|
|
935
|
+
*/
|
|
936
|
+
NextToken?: string;
|
|
937
|
+
/**
|
|
938
|
+
* <p>The HTTP status of the request.</p>
|
|
939
|
+
*/
|
|
940
|
+
Status?: number;
|
|
941
|
+
/**
|
|
942
|
+
* <p>The Amazon Web Services request ID for this operation.</p>
|
|
943
|
+
*/
|
|
944
|
+
RequestId?: string;
|
|
945
|
+
}
|
|
946
|
+
export interface ListDashboardsRequest {
|
|
947
|
+
/**
|
|
948
|
+
* <p>The ID of the Amazon Web Services account that contains the dashboards that you're
|
|
949
|
+
* listing.</p>
|
|
950
|
+
*/
|
|
951
|
+
AwsAccountId: string | undefined;
|
|
952
|
+
/**
|
|
953
|
+
* <p>The token for the next set of results, or null if there are no more results.</p>
|
|
954
|
+
*/
|
|
955
|
+
NextToken?: string;
|
|
956
|
+
/**
|
|
957
|
+
* <p>The maximum number of results to be returned per request.</p>
|
|
958
|
+
*/
|
|
959
|
+
MaxResults?: number;
|
|
960
|
+
}
|
|
961
|
+
export interface ListDashboardsResponse {
|
|
962
|
+
/**
|
|
963
|
+
* <p>A structure that contains all of the dashboards in your Amazon Web Services account. This structure
|
|
964
|
+
* provides basic information about the dashboards.</p>
|
|
965
|
+
*/
|
|
966
|
+
DashboardSummaryList?: DashboardSummary[];
|
|
967
|
+
/**
|
|
968
|
+
* <p>The token for the next set of results, or null if there are no more results.</p>
|
|
969
|
+
*/
|
|
970
|
+
NextToken?: string;
|
|
971
|
+
/**
|
|
972
|
+
* <p>The HTTP status of the request.</p>
|
|
973
|
+
*/
|
|
974
|
+
Status?: number;
|
|
975
|
+
/**
|
|
976
|
+
* <p>The Amazon Web Services request ID for this operation.</p>
|
|
977
|
+
*/
|
|
978
|
+
RequestId?: string;
|
|
979
|
+
}
|
|
980
|
+
export interface ListDashboardVersionsRequest {
|
|
981
|
+
/**
|
|
982
|
+
* <p>The ID of the Amazon Web Services account that contains the dashboard that you're listing versions
|
|
983
|
+
* for.</p>
|
|
984
|
+
*/
|
|
985
|
+
AwsAccountId: string | undefined;
|
|
986
|
+
/**
|
|
987
|
+
* <p>The ID for the dashboard.</p>
|
|
988
|
+
*/
|
|
989
|
+
DashboardId: string | undefined;
|
|
990
|
+
/**
|
|
991
|
+
* <p>The token for the next set of results, or null if there are no more results.</p>
|
|
992
|
+
*/
|
|
993
|
+
NextToken?: string;
|
|
994
|
+
/**
|
|
995
|
+
* <p>The maximum number of results to be returned per request.</p>
|
|
996
|
+
*/
|
|
997
|
+
MaxResults?: number;
|
|
998
|
+
}
|
|
999
|
+
export interface ListDashboardVersionsResponse {
|
|
1000
|
+
/**
|
|
1001
|
+
* <p>A structure that contains information about each version of the dashboard.</p>
|
|
1002
|
+
*/
|
|
1003
|
+
DashboardVersionSummaryList?: DashboardVersionSummary[];
|
|
1004
|
+
/**
|
|
1005
|
+
* <p>The token for the next set of results, or null if there are no more results.</p>
|
|
1006
|
+
*/
|
|
1007
|
+
NextToken?: string;
|
|
1008
|
+
/**
|
|
1009
|
+
* <p>The HTTP status of the request.</p>
|
|
1010
|
+
*/
|
|
1011
|
+
Status?: number;
|
|
1012
|
+
/**
|
|
1013
|
+
* <p>The Amazon Web Services request ID for this operation.</p>
|
|
1014
|
+
*/
|
|
1015
|
+
RequestId?: string;
|
|
1016
|
+
}
|
|
1017
|
+
export interface ListDataSetsRequest {
|
|
1018
|
+
/**
|
|
1019
|
+
* <p>The Amazon Web Services account ID.</p>
|
|
1020
|
+
*/
|
|
1021
|
+
AwsAccountId: string | undefined;
|
|
1022
|
+
/**
|
|
1023
|
+
* <p>The token for the next set of results, or null if there are no more results.</p>
|
|
1024
|
+
*/
|
|
1025
|
+
NextToken?: string;
|
|
1026
|
+
/**
|
|
1027
|
+
* <p>The maximum number of results to be returned per request.</p>
|
|
1028
|
+
*/
|
|
1029
|
+
MaxResults?: number;
|
|
1030
|
+
}
|
|
1031
|
+
export interface ListDataSetsResponse {
|
|
1032
|
+
/**
|
|
1033
|
+
* <p>The list of dataset summaries.</p>
|
|
1034
|
+
*/
|
|
1035
|
+
DataSetSummaries?: DataSetSummary[];
|
|
1036
|
+
/**
|
|
1037
|
+
* <p>The token for the next set of results, or null if there are no more results.</p>
|
|
1038
|
+
*/
|
|
1039
|
+
NextToken?: string;
|
|
1040
|
+
/**
|
|
1041
|
+
* <p>The Amazon Web Services request ID for this operation.</p>
|
|
1042
|
+
*/
|
|
1043
|
+
RequestId?: string;
|
|
1044
|
+
/**
|
|
1045
|
+
* <p>The HTTP status of the request.</p>
|
|
1046
|
+
*/
|
|
1047
|
+
Status?: number;
|
|
1048
|
+
}
|
|
1049
|
+
export interface ListDataSourcesRequest {
|
|
1050
|
+
/**
|
|
1051
|
+
* <p>The Amazon Web Services account ID.</p>
|
|
1052
|
+
*/
|
|
1053
|
+
AwsAccountId: string | undefined;
|
|
1054
|
+
/**
|
|
1055
|
+
* <p>The token for the next set of results, or null if there are no more results.</p>
|
|
1056
|
+
*/
|
|
1057
|
+
NextToken?: string;
|
|
1058
|
+
/**
|
|
1059
|
+
* <p>The maximum number of results to be returned per request.</p>
|
|
1060
|
+
*/
|
|
1061
|
+
MaxResults?: number;
|
|
1062
|
+
}
|
|
1063
|
+
export interface ListDataSourcesResponse {
|
|
1064
|
+
/**
|
|
1065
|
+
* <p>A list of data sources.</p>
|
|
1066
|
+
*/
|
|
1067
|
+
DataSources?: DataSource[];
|
|
1068
|
+
/**
|
|
1069
|
+
* <p>The token for the next set of results, or null if there are no more results.</p>
|
|
1070
|
+
*/
|
|
1071
|
+
NextToken?: string;
|
|
1072
|
+
/**
|
|
1073
|
+
* <p>The Amazon Web Services request ID for this operation.</p>
|
|
1074
|
+
*/
|
|
1075
|
+
RequestId?: string;
|
|
1076
|
+
/**
|
|
1077
|
+
* <p>The HTTP status of the request.</p>
|
|
1078
|
+
*/
|
|
1079
|
+
Status?: number;
|
|
1080
|
+
}
|
|
1081
|
+
export interface ListFolderMembersRequest {
|
|
1082
|
+
/**
|
|
1083
|
+
* <p>The ID for the Amazon Web Services account that contains the folder.</p>
|
|
1084
|
+
*/
|
|
1085
|
+
AwsAccountId: string | undefined;
|
|
1086
|
+
/**
|
|
1087
|
+
* <p>The ID of the folder.</p>
|
|
1088
|
+
*/
|
|
1089
|
+
FolderId: string | undefined;
|
|
1090
|
+
/**
|
|
1091
|
+
* <p>The token for the next set of results, or null if there are no more results.</p>
|
|
1092
|
+
*/
|
|
1093
|
+
NextToken?: string;
|
|
1094
|
+
/**
|
|
1095
|
+
* <p>The maximum number of results to be returned per request.</p>
|
|
1096
|
+
*/
|
|
1097
|
+
MaxResults?: number;
|
|
1098
|
+
}
|
|
1099
|
+
export interface ListFolderMembersResponse {
|
|
1100
|
+
/**
|
|
1101
|
+
* <p>The HTTP status of the request.</p>
|
|
1102
|
+
*/
|
|
1103
|
+
Status?: number;
|
|
1104
|
+
/**
|
|
1105
|
+
* <p>A structure that contains all of the folder members (dashboards, analyses, and datasets) in the folder.</p>
|
|
1106
|
+
*/
|
|
1107
|
+
FolderMemberList?: MemberIdArnPair[];
|
|
1108
|
+
/**
|
|
1109
|
+
* <p>The token for the next set of results, or null if there are no more results.</p>
|
|
1110
|
+
*/
|
|
1111
|
+
NextToken?: string;
|
|
1112
|
+
/**
|
|
1113
|
+
* <p>The Amazon Web Services request ID for this operation.</p>
|
|
1114
|
+
*/
|
|
1115
|
+
RequestId?: string;
|
|
1116
|
+
}
|
|
1117
|
+
export interface ListFoldersRequest {
|
|
1118
|
+
/**
|
|
1119
|
+
* <p>The ID for the Amazon Web Services account that contains the folder.</p>
|
|
1120
|
+
*/
|
|
1121
|
+
AwsAccountId: string | undefined;
|
|
1122
|
+
/**
|
|
1123
|
+
* <p>The token for the next set of results, or null if there are no more results.</p>
|
|
1124
|
+
*/
|
|
1125
|
+
NextToken?: string;
|
|
1126
|
+
/**
|
|
1127
|
+
* <p>The maximum number of results to be returned per request.</p>
|
|
1128
|
+
*/
|
|
1129
|
+
MaxResults?: number;
|
|
1130
|
+
}
|
|
1131
|
+
export interface ListFoldersResponse {
|
|
1132
|
+
/**
|
|
1133
|
+
* <p>The HTTP status of the request.</p>
|
|
1134
|
+
*/
|
|
1135
|
+
Status?: number;
|
|
1136
|
+
/**
|
|
1137
|
+
* <p>A structure that contains all of the folders in the Amazon Web Services account. This structure provides basic information about the folders.</p>
|
|
1138
|
+
*/
|
|
1139
|
+
FolderSummaryList?: FolderSummary[];
|
|
1140
|
+
/**
|
|
1141
|
+
* <p>The token for the next set of results, or null if there are no more results.</p>
|
|
1142
|
+
*/
|
|
1143
|
+
NextToken?: string;
|
|
1144
|
+
/**
|
|
1145
|
+
* <p>The Amazon Web Services request ID for this operation.</p>
|
|
1146
|
+
*/
|
|
1147
|
+
RequestId?: string;
|
|
1148
|
+
}
|
|
1149
|
+
export interface ListGroupMembershipsRequest {
|
|
1150
|
+
/**
|
|
1151
|
+
* <p>The name of the group that you want to see a membership list of.</p>
|
|
1152
|
+
*/
|
|
1153
|
+
GroupName: string | undefined;
|
|
1154
|
+
/**
|
|
1155
|
+
* <p>A pagination token that can be used in a subsequent request.</p>
|
|
1156
|
+
*/
|
|
1157
|
+
NextToken?: string;
|
|
1158
|
+
/**
|
|
1159
|
+
* <p>The maximum number of results to return from this request.</p>
|
|
1160
|
+
*/
|
|
1161
|
+
MaxResults?: number;
|
|
1162
|
+
/**
|
|
1163
|
+
* <p>The ID for the Amazon Web Services account that the group is in. Currently, you use the ID for the
|
|
1164
|
+
* Amazon Web Services account that contains your Amazon QuickSight account.</p>
|
|
1165
|
+
*/
|
|
1166
|
+
AwsAccountId: string | undefined;
|
|
1167
|
+
/**
|
|
1168
|
+
* <p>The namespace of the group that you want a list of users from.</p>
|
|
1169
|
+
*/
|
|
1170
|
+
Namespace: string | undefined;
|
|
1171
|
+
}
|
|
1172
|
+
export interface ListGroupMembershipsResponse {
|
|
1173
|
+
/**
|
|
1174
|
+
* <p>The list of the members of the group.</p>
|
|
1175
|
+
*/
|
|
1176
|
+
GroupMemberList?: GroupMember[];
|
|
1177
|
+
/**
|
|
1178
|
+
* <p>A pagination token that can be used in a subsequent request.</p>
|
|
1179
|
+
*/
|
|
1180
|
+
NextToken?: string;
|
|
1181
|
+
/**
|
|
1182
|
+
* <p>The Amazon Web Services request ID for this operation.</p>
|
|
1183
|
+
*/
|
|
1184
|
+
RequestId?: string;
|
|
1185
|
+
/**
|
|
1186
|
+
* <p>The HTTP status of the request.</p>
|
|
1187
|
+
*/
|
|
1188
|
+
Status?: number;
|
|
1189
|
+
}
|
|
1190
|
+
export interface ListGroupsRequest {
|
|
1191
|
+
/**
|
|
1192
|
+
* <p>The ID for the Amazon Web Services account that the group is in. Currently, you use the ID for the
|
|
1193
|
+
* Amazon Web Services account that contains your Amazon QuickSight account.</p>
|
|
1194
|
+
*/
|
|
1195
|
+
AwsAccountId: string | undefined;
|
|
1196
|
+
/**
|
|
1197
|
+
* <p>A pagination token that can be used in a subsequent request.</p>
|
|
1198
|
+
*/
|
|
1199
|
+
NextToken?: string;
|
|
1200
|
+
/**
|
|
1201
|
+
* <p>The maximum number of results to return.</p>
|
|
1202
|
+
*/
|
|
1203
|
+
MaxResults?: number;
|
|
1204
|
+
/**
|
|
1205
|
+
* <p>The namespace that you want a list of groups from.</p>
|
|
1206
|
+
*/
|
|
1207
|
+
Namespace: string | undefined;
|
|
1208
|
+
}
|
|
1209
|
+
export interface ListGroupsResponse {
|
|
1210
|
+
/**
|
|
1211
|
+
* <p>The list of the groups.</p>
|
|
1212
|
+
*/
|
|
1213
|
+
GroupList?: Group[];
|
|
1214
|
+
/**
|
|
1215
|
+
* <p>A pagination token that can be used in a subsequent request.</p>
|
|
1216
|
+
*/
|
|
1217
|
+
NextToken?: string;
|
|
1218
|
+
/**
|
|
1219
|
+
* <p>The Amazon Web Services request ID for this operation.</p>
|
|
1220
|
+
*/
|
|
1221
|
+
RequestId?: string;
|
|
1222
|
+
/**
|
|
1223
|
+
* <p>The HTTP status of the request.</p>
|
|
1224
|
+
*/
|
|
1225
|
+
Status?: number;
|
|
1226
|
+
}
|
|
1227
|
+
export interface ListIAMPolicyAssignmentsRequest {
|
|
1228
|
+
/**
|
|
1229
|
+
* <p>The ID of the Amazon Web Services account that contains these IAM policy assignments.</p>
|
|
1230
|
+
*/
|
|
1231
|
+
AwsAccountId: string | undefined;
|
|
1232
|
+
/**
|
|
1233
|
+
* <p>The status of the assignments.</p>
|
|
1234
|
+
*/
|
|
1235
|
+
AssignmentStatus?: AssignmentStatus | string;
|
|
1236
|
+
/**
|
|
1237
|
+
* <p>The namespace for the assignments.</p>
|
|
1238
|
+
*/
|
|
1239
|
+
Namespace: string | undefined;
|
|
1240
|
+
/**
|
|
1241
|
+
* <p>The token for the next set of results, or null if there are no more results.</p>
|
|
1242
|
+
*/
|
|
1243
|
+
NextToken?: string;
|
|
1244
|
+
/**
|
|
1245
|
+
* <p>The maximum number of results to be returned per request.</p>
|
|
1246
|
+
*/
|
|
1247
|
+
MaxResults?: number;
|
|
1248
|
+
}
|
|
1249
|
+
export interface ListIAMPolicyAssignmentsResponse {
|
|
1250
|
+
/**
|
|
1251
|
+
* <p>Information describing the IAM policy assignments.</p>
|
|
1252
|
+
*/
|
|
1253
|
+
IAMPolicyAssignments?: IAMPolicyAssignmentSummary[];
|
|
1254
|
+
/**
|
|
1255
|
+
* <p>The token for the next set of results, or null if there are no more results.</p>
|
|
1256
|
+
*/
|
|
1257
|
+
NextToken?: string;
|
|
1258
|
+
/**
|
|
1259
|
+
* <p>The Amazon Web Services request ID for this operation.</p>
|
|
1260
|
+
*/
|
|
1261
|
+
RequestId?: string;
|
|
1262
|
+
/**
|
|
1263
|
+
* <p>The HTTP status of the request.</p>
|
|
1264
|
+
*/
|
|
1265
|
+
Status?: number;
|
|
1266
|
+
}
|
|
1267
|
+
export interface ListIAMPolicyAssignmentsForUserRequest {
|
|
1268
|
+
/**
|
|
1269
|
+
* <p>The ID of the Amazon Web Services account that contains the assignments.</p>
|
|
1270
|
+
*/
|
|
1271
|
+
AwsAccountId: string | undefined;
|
|
1272
|
+
/**
|
|
1273
|
+
* <p>The name of the user.</p>
|
|
1274
|
+
*/
|
|
1275
|
+
UserName: string | undefined;
|
|
1276
|
+
/**
|
|
1277
|
+
* <p>The token for the next set of results, or null if there are no more results.</p>
|
|
1278
|
+
*/
|
|
1279
|
+
NextToken?: string;
|
|
1280
|
+
/**
|
|
1281
|
+
* <p>The maximum number of results to be returned per request.</p>
|
|
1282
|
+
*/
|
|
1283
|
+
MaxResults?: number;
|
|
1284
|
+
/**
|
|
1285
|
+
* <p>The namespace of the assignment.</p>
|
|
1286
|
+
*/
|
|
1287
|
+
Namespace: string | undefined;
|
|
1288
|
+
}
|
|
1289
|
+
export interface ListIAMPolicyAssignmentsForUserResponse {
|
|
1290
|
+
/**
|
|
1291
|
+
* <p>The active assignments for this user.</p>
|
|
1292
|
+
*/
|
|
1293
|
+
ActiveAssignments?: ActiveIAMPolicyAssignment[];
|
|
1294
|
+
/**
|
|
1295
|
+
* <p>The Amazon Web Services request ID for this operation.</p>
|
|
1296
|
+
*/
|
|
1297
|
+
RequestId?: string;
|
|
1298
|
+
/**
|
|
1299
|
+
* <p>The token for the next set of results, or null if there are no more results.</p>
|
|
1300
|
+
*/
|
|
1301
|
+
NextToken?: string;
|
|
1302
|
+
/**
|
|
1303
|
+
* <p>The HTTP status of the request.</p>
|
|
1304
|
+
*/
|
|
1305
|
+
Status?: number;
|
|
1306
|
+
}
|
|
1307
|
+
export interface ListIngestionsRequest {
|
|
1308
|
+
/**
|
|
1309
|
+
* <p>The ID of the dataset used in the ingestion.</p>
|
|
1310
|
+
*/
|
|
1311
|
+
DataSetId: string | undefined;
|
|
1312
|
+
/**
|
|
1313
|
+
* <p>The token for the next set of results, or null if there are no more results.</p>
|
|
1314
|
+
*/
|
|
1315
|
+
NextToken?: string;
|
|
1316
|
+
/**
|
|
1317
|
+
* <p>The Amazon Web Services account ID.</p>
|
|
1318
|
+
*/
|
|
1319
|
+
AwsAccountId: string | undefined;
|
|
1320
|
+
/**
|
|
1321
|
+
* <p>The maximum number of results to be returned per request.</p>
|
|
1322
|
+
*/
|
|
1323
|
+
MaxResults?: number;
|
|
1324
|
+
}
|
|
1325
|
+
export interface ListIngestionsResponse {
|
|
1326
|
+
/**
|
|
1327
|
+
* <p>A list of the ingestions.</p>
|
|
1328
|
+
*/
|
|
1329
|
+
Ingestions?: Ingestion[];
|
|
1330
|
+
/**
|
|
1331
|
+
* <p>The token for the next set of results, or null if there are no more results.</p>
|
|
1332
|
+
*/
|
|
1333
|
+
NextToken?: string;
|
|
1334
|
+
/**
|
|
1335
|
+
* <p>The Amazon Web Services request ID for this operation.</p>
|
|
1336
|
+
*/
|
|
1337
|
+
RequestId?: string;
|
|
1338
|
+
/**
|
|
1339
|
+
* <p>The HTTP status of the request.</p>
|
|
1340
|
+
*/
|
|
1341
|
+
Status?: number;
|
|
1342
|
+
}
|
|
1343
|
+
export interface ListNamespacesRequest {
|
|
1344
|
+
/**
|
|
1345
|
+
* <p>The ID for the Amazon Web Services account that contains the Amazon QuickSight namespaces that you want to list.</p>
|
|
1346
|
+
*/
|
|
1347
|
+
AwsAccountId: string | undefined;
|
|
1348
|
+
/**
|
|
1349
|
+
* <p>A unique pagination token that can be used in a subsequent request. You will receive a pagination token in the response body of a previous <code>ListNameSpaces</code> API call if there is more data that can be returned. To receive the data, make another <code>ListNamespaces</code> API call with the returned token to retrieve the next page of data. Each token is valid for 24 hours. If you try to make a <code>ListNamespaces</code> API call with an expired token, you will receive a <code>HTTP 400 InvalidNextTokenException</code> error.</p>
|
|
1350
|
+
*/
|
|
1351
|
+
NextToken?: string;
|
|
1352
|
+
/**
|
|
1353
|
+
* <p>The maximum number of results to return.</p>
|
|
1354
|
+
*/
|
|
1355
|
+
MaxResults?: number;
|
|
1356
|
+
}
|
|
1357
|
+
export interface ListNamespacesResponse {
|
|
1358
|
+
/**
|
|
1359
|
+
* <p>The information about the namespaces in this Amazon Web Services account. The response includes
|
|
1360
|
+
* the namespace ARN, name, Amazon Web Services Region, notification email address, creation status, and
|
|
1361
|
+
* identity store.</p>
|
|
1362
|
+
*/
|
|
1363
|
+
Namespaces?: NamespaceInfoV2[];
|
|
1364
|
+
/**
|
|
1365
|
+
* <p>A unique pagination token that can be used in a subsequent request. Receiving <code>NextToken</code> in your response inticates that there is more data that can be returned. To receive the data, make another <code>ListNamespaces</code> API call with the returned token to retrieve the next page of data. Each token is valid for 24 hours. If you try to make a <code>ListNamespaces</code> API call with an expired token, you will receive a <code>HTTP 400 InvalidNextTokenException</code> error.</p>
|
|
1366
|
+
*/
|
|
1367
|
+
NextToken?: string;
|
|
1368
|
+
/**
|
|
1369
|
+
* <p>The Amazon Web Services request ID for this operation.</p>
|
|
1370
|
+
*/
|
|
1371
|
+
RequestId?: string;
|
|
1372
|
+
/**
|
|
1373
|
+
* <p>The HTTP status of the request.</p>
|
|
1374
|
+
*/
|
|
1375
|
+
Status?: number;
|
|
1376
|
+
}
|
|
1377
|
+
export interface ListTagsForResourceRequest {
|
|
1378
|
+
/**
|
|
1379
|
+
* <p>The Amazon Resource Name (ARN) of the resource that you want a list of tags for.</p>
|
|
1380
|
+
*/
|
|
1381
|
+
ResourceArn: string | undefined;
|
|
1382
|
+
}
|
|
1383
|
+
export interface ListTagsForResourceResponse {
|
|
1384
|
+
/**
|
|
1385
|
+
* <p>Contains a map of the key-value pairs for the resource tag or tags assigned to the
|
|
1386
|
+
* resource.</p>
|
|
1387
|
+
*/
|
|
1388
|
+
Tags?: Tag[];
|
|
1389
|
+
/**
|
|
1390
|
+
* <p>The Amazon Web Services request ID for this operation.</p>
|
|
1391
|
+
*/
|
|
1392
|
+
RequestId?: string;
|
|
1393
|
+
/**
|
|
1394
|
+
* <p>The HTTP status of the request.</p>
|
|
1395
|
+
*/
|
|
1396
|
+
Status?: number;
|
|
1397
|
+
}
|
|
1398
|
+
export interface ListTemplateAliasesRequest {
|
|
1399
|
+
/**
|
|
1400
|
+
* <p>The ID of the Amazon Web Services account that contains the template aliases that you're listing.</p>
|
|
1401
|
+
*/
|
|
1402
|
+
AwsAccountId: string | undefined;
|
|
1403
|
+
/**
|
|
1404
|
+
* <p>The ID for the template.</p>
|
|
1405
|
+
*/
|
|
1406
|
+
TemplateId: string | undefined;
|
|
1407
|
+
/**
|
|
1408
|
+
* <p>The token for the next set of results, or null if there are no more results.</p>
|
|
1409
|
+
*/
|
|
1410
|
+
NextToken?: string;
|
|
1411
|
+
/**
|
|
1412
|
+
* <p>The maximum number of results to be returned per request.</p>
|
|
1413
|
+
*/
|
|
1414
|
+
MaxResults?: number;
|
|
1415
|
+
}
|
|
1416
|
+
export interface ListTemplateAliasesResponse {
|
|
1417
|
+
/**
|
|
1418
|
+
* <p>A structure containing the list of the template's aliases.</p>
|
|
1419
|
+
*/
|
|
1420
|
+
TemplateAliasList?: TemplateAlias[];
|
|
1421
|
+
/**
|
|
1422
|
+
* <p>The HTTP status of the request.</p>
|
|
1423
|
+
*/
|
|
1424
|
+
Status?: number;
|
|
1425
|
+
/**
|
|
1426
|
+
* <p>The Amazon Web Services request ID for this operation.</p>
|
|
1427
|
+
*/
|
|
1428
|
+
RequestId?: string;
|
|
1429
|
+
/**
|
|
1430
|
+
* <p>The token for the next set of results, or null if there are no more results.</p>
|
|
1431
|
+
*/
|
|
1432
|
+
NextToken?: string;
|
|
1433
|
+
}
|
|
1434
|
+
export interface ListTemplatesRequest {
|
|
1435
|
+
/**
|
|
1436
|
+
* <p>The ID of the Amazon Web Services account that contains the templates that you're listing.</p>
|
|
1437
|
+
*/
|
|
1438
|
+
AwsAccountId: string | undefined;
|
|
1439
|
+
/**
|
|
1440
|
+
* <p>The token for the next set of results, or null if there are no more results.</p>
|
|
1441
|
+
*/
|
|
1442
|
+
NextToken?: string;
|
|
1443
|
+
/**
|
|
1444
|
+
* <p>The maximum number of results to be returned per request.</p>
|
|
1445
|
+
*/
|
|
1446
|
+
MaxResults?: number;
|
|
1447
|
+
}
|
|
1448
|
+
/**
|
|
1449
|
+
* <p>The template summary.</p>
|
|
1450
|
+
*/
|
|
1451
|
+
export interface TemplateSummary {
|
|
1452
|
+
/**
|
|
1453
|
+
* <p>A summary of a template.</p>
|
|
1454
|
+
*/
|
|
1455
|
+
Arn?: string;
|
|
1456
|
+
/**
|
|
1457
|
+
* <p>The ID of the template. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.</p>
|
|
1458
|
+
*/
|
|
1459
|
+
TemplateId?: string;
|
|
1460
|
+
/**
|
|
1461
|
+
* <p>A display name for the template.</p>
|
|
1462
|
+
*/
|
|
1463
|
+
Name?: string;
|
|
1464
|
+
/**
|
|
1465
|
+
* <p>A structure containing a list of version numbers for the template summary.</p>
|
|
1466
|
+
*/
|
|
1467
|
+
LatestVersionNumber?: number;
|
|
1468
|
+
/**
|
|
1469
|
+
* <p>The last time that this template was created.</p>
|
|
1470
|
+
*/
|
|
1471
|
+
CreatedTime?: Date;
|
|
1472
|
+
/**
|
|
1473
|
+
* <p>The last time that this template was updated.</p>
|
|
1474
|
+
*/
|
|
1475
|
+
LastUpdatedTime?: Date;
|
|
1476
|
+
}
|
|
1477
|
+
export interface ListTemplatesResponse {
|
|
1478
|
+
/**
|
|
1479
|
+
* <p>A structure containing information about the templates in the list.</p>
|
|
1480
|
+
*/
|
|
1481
|
+
TemplateSummaryList?: TemplateSummary[];
|
|
1482
|
+
/**
|
|
1483
|
+
* <p>The token for the next set of results, or null if there are no more results.</p>
|
|
1484
|
+
*/
|
|
1485
|
+
NextToken?: string;
|
|
1486
|
+
/**
|
|
1487
|
+
* <p>The HTTP status of the request.</p>
|
|
1488
|
+
*/
|
|
1489
|
+
Status?: number;
|
|
1490
|
+
/**
|
|
1491
|
+
* <p>The Amazon Web Services request ID for this operation.</p>
|
|
1492
|
+
*/
|
|
1493
|
+
RequestId?: string;
|
|
1494
|
+
}
|
|
1495
|
+
export interface ListTemplateVersionsRequest {
|
|
1496
|
+
/**
|
|
1497
|
+
* <p>The ID of the Amazon Web Services account that contains the templates that you're listing.</p>
|
|
1498
|
+
*/
|
|
1499
|
+
AwsAccountId: string | undefined;
|
|
1500
|
+
/**
|
|
1501
|
+
* <p>The ID for the template.</p>
|
|
1502
|
+
*/
|
|
1503
|
+
TemplateId: string | undefined;
|
|
1504
|
+
/**
|
|
1505
|
+
* <p>The token for the next set of results, or null if there are no more results.</p>
|
|
1506
|
+
*/
|
|
1507
|
+
NextToken?: string;
|
|
1508
|
+
/**
|
|
1509
|
+
* <p>The maximum number of results to be returned per request.</p>
|
|
1510
|
+
*/
|
|
1511
|
+
MaxResults?: number;
|
|
1512
|
+
}
|
|
1513
|
+
/**
|
|
1514
|
+
* <p>The template version.</p>
|
|
1515
|
+
*/
|
|
1516
|
+
export interface TemplateVersionSummary {
|
|
1517
|
+
/**
|
|
1518
|
+
* <p>The Amazon Resource Name (ARN) of the template version.</p>
|
|
1519
|
+
*/
|
|
1520
|
+
Arn?: string;
|
|
1521
|
+
/**
|
|
1522
|
+
* <p>The version number of the template version.</p>
|
|
1523
|
+
*/
|
|
1524
|
+
VersionNumber?: number;
|
|
1525
|
+
/**
|
|
1526
|
+
* <p>The time that this template version was created.</p>
|
|
1527
|
+
*/
|
|
1528
|
+
CreatedTime?: Date;
|
|
1529
|
+
/**
|
|
1530
|
+
* <p>The status of the template version.</p>
|
|
1531
|
+
*/
|
|
1532
|
+
Status?: ResourceStatus | string;
|
|
1533
|
+
/**
|
|
1534
|
+
* <p>The description of the template version.</p>
|
|
1535
|
+
*/
|
|
1536
|
+
Description?: string;
|
|
1537
|
+
}
|
|
1538
|
+
export interface ListTemplateVersionsResponse {
|
|
1539
|
+
/**
|
|
1540
|
+
* <p>A structure containing a list of all the versions of the specified template.</p>
|
|
1541
|
+
*/
|
|
1542
|
+
TemplateVersionSummaryList?: TemplateVersionSummary[];
|
|
1543
|
+
/**
|
|
1544
|
+
* <p>The token for the next set of results, or null if there are no more results.</p>
|
|
1545
|
+
*/
|
|
1546
|
+
NextToken?: string;
|
|
1547
|
+
/**
|
|
1548
|
+
* <p>The HTTP status of the request.</p>
|
|
1549
|
+
*/
|
|
1550
|
+
Status?: number;
|
|
1551
|
+
/**
|
|
1552
|
+
* <p>The Amazon Web Services request ID for this operation.</p>
|
|
1553
|
+
*/
|
|
1554
|
+
RequestId?: string;
|
|
1555
|
+
}
|
|
1556
|
+
export interface ListThemeAliasesRequest {
|
|
1557
|
+
/**
|
|
1558
|
+
* <p>The ID of the Amazon Web Services account that contains the theme aliases that you're listing.</p>
|
|
1559
|
+
*/
|
|
1560
|
+
AwsAccountId: string | undefined;
|
|
1561
|
+
/**
|
|
1562
|
+
* <p>The ID for the theme.</p>
|
|
1563
|
+
*/
|
|
1564
|
+
ThemeId: string | undefined;
|
|
1565
|
+
/**
|
|
1566
|
+
* <p>The token for the next set of results, or null if there are no more results.</p>
|
|
1567
|
+
*/
|
|
1568
|
+
NextToken?: string;
|
|
1569
|
+
/**
|
|
1570
|
+
* <p>The maximum number of results to be returned per request.</p>
|
|
1571
|
+
*/
|
|
1572
|
+
MaxResults?: number;
|
|
1573
|
+
}
|
|
1574
|
+
export interface ListThemeAliasesResponse {
|
|
1575
|
+
/**
|
|
1576
|
+
* <p>A structure containing the list of the theme's aliases.</p>
|
|
1577
|
+
*/
|
|
1578
|
+
ThemeAliasList?: ThemeAlias[];
|
|
1579
|
+
/**
|
|
1580
|
+
* <p>The HTTP status of the request.</p>
|
|
1581
|
+
*/
|
|
1582
|
+
Status?: number;
|
|
1583
|
+
/**
|
|
1584
|
+
* <p>The Amazon Web Services request ID for this operation.</p>
|
|
1585
|
+
*/
|
|
1586
|
+
RequestId?: string;
|
|
1587
|
+
/**
|
|
1588
|
+
* <p>The token for the next set of results, or null if there are no more results.</p>
|
|
1589
|
+
*/
|
|
1590
|
+
NextToken?: string;
|
|
1591
|
+
}
|
|
1592
|
+
export interface ListThemesRequest {
|
|
1593
|
+
/**
|
|
1594
|
+
* <p>The ID of the Amazon Web Services account that contains the themes that you're listing.</p>
|
|
1595
|
+
*/
|
|
1596
|
+
AwsAccountId: string | undefined;
|
|
1597
|
+
/**
|
|
1598
|
+
* <p>The token for the next set of results, or null if there are no more results.</p>
|
|
1599
|
+
*/
|
|
1600
|
+
NextToken?: string;
|
|
1601
|
+
/**
|
|
1602
|
+
* <p>The maximum number of results to be returned per request.</p>
|
|
1603
|
+
*/
|
|
1604
|
+
MaxResults?: number;
|
|
1605
|
+
/**
|
|
1606
|
+
* <p>The type of themes that you want to list. Valid options include the following:</p>
|
|
1607
|
+
* <ul>
|
|
1608
|
+
* <li>
|
|
1609
|
+
* <p>
|
|
1610
|
+
* <code>ALL (default)</code>- Display all existing themes.</p>
|
|
1611
|
+
* </li>
|
|
1612
|
+
* <li>
|
|
1613
|
+
* <p>
|
|
1614
|
+
* <code>CUSTOM</code> - Display only the themes created by people using Amazon QuickSight.</p>
|
|
1615
|
+
* </li>
|
|
1616
|
+
* <li>
|
|
1617
|
+
* <p>
|
|
1618
|
+
* <code>QUICKSIGHT</code> - Display only the starting themes defined by Amazon QuickSight.</p>
|
|
1619
|
+
* </li>
|
|
1620
|
+
* </ul>
|
|
1621
|
+
*/
|
|
1622
|
+
Type?: ThemeType | string;
|
|
1623
|
+
}
|
|
1624
|
+
/**
|
|
1625
|
+
* <p>The theme summary.</p>
|
|
1626
|
+
*/
|
|
1627
|
+
export interface ThemeSummary {
|
|
1628
|
+
/**
|
|
1629
|
+
* <p>The Amazon Resource Name (ARN) of the resource.</p>
|
|
1630
|
+
*/
|
|
1631
|
+
Arn?: string;
|
|
1632
|
+
/**
|
|
1633
|
+
* <p>the display name for the theme.</p>
|
|
1634
|
+
*/
|
|
1635
|
+
Name?: string;
|
|
1636
|
+
/**
|
|
1637
|
+
* <p>The ID of the theme. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.</p>
|
|
1638
|
+
*/
|
|
1639
|
+
ThemeId?: string;
|
|
1640
|
+
/**
|
|
1641
|
+
* <p>The latest version number for the theme. </p>
|
|
1642
|
+
*/
|
|
1643
|
+
LatestVersionNumber?: number;
|
|
1644
|
+
/**
|
|
1645
|
+
* <p>The date and time that this theme was created.</p>
|
|
1646
|
+
*/
|
|
1647
|
+
CreatedTime?: Date;
|
|
1648
|
+
/**
|
|
1649
|
+
* <p>The last date and time that this theme was updated.</p>
|
|
1650
|
+
*/
|
|
1651
|
+
LastUpdatedTime?: Date;
|
|
1652
|
+
}
|
|
1653
|
+
export interface ListThemesResponse {
|
|
1654
|
+
/**
|
|
1655
|
+
* <p>Information about the themes in the list.</p>
|
|
1656
|
+
*/
|
|
1657
|
+
ThemeSummaryList?: ThemeSummary[];
|
|
1658
|
+
/**
|
|
1659
|
+
* <p>The token for the next set of results, or null if there are no more results.</p>
|
|
1660
|
+
*/
|
|
1661
|
+
NextToken?: string;
|
|
1662
|
+
/**
|
|
1663
|
+
* <p>The HTTP status of the request.</p>
|
|
1664
|
+
*/
|
|
1665
|
+
Status?: number;
|
|
1666
|
+
/**
|
|
1667
|
+
* <p>The Amazon Web Services request ID for this operation.</p>
|
|
1668
|
+
*/
|
|
1669
|
+
RequestId?: string;
|
|
1670
|
+
}
|
|
1671
|
+
export interface ListThemeVersionsRequest {
|
|
1672
|
+
/**
|
|
1673
|
+
* <p>The ID of the Amazon Web Services account that contains the themes that you're listing.</p>
|
|
1674
|
+
*/
|
|
1675
|
+
AwsAccountId: string | undefined;
|
|
1676
|
+
/**
|
|
1677
|
+
* <p>The ID for the theme.</p>
|
|
1678
|
+
*/
|
|
1679
|
+
ThemeId: string | undefined;
|
|
1680
|
+
/**
|
|
1681
|
+
* <p>The token for the next set of results, or null if there are no more results.</p>
|
|
1682
|
+
*/
|
|
1683
|
+
NextToken?: string;
|
|
1684
|
+
/**
|
|
1685
|
+
* <p>The maximum number of results to be returned per request.</p>
|
|
1686
|
+
*/
|
|
1687
|
+
MaxResults?: number;
|
|
1688
|
+
}
|
|
1689
|
+
/**
|
|
1690
|
+
* <p>The theme version.</p>
|
|
1691
|
+
*/
|
|
1692
|
+
export interface ThemeVersionSummary {
|
|
1693
|
+
/**
|
|
1694
|
+
* <p>The version number of the theme version.</p>
|
|
1695
|
+
*/
|
|
1696
|
+
VersionNumber?: number;
|
|
1697
|
+
/**
|
|
1698
|
+
* <p>The Amazon Resource Name (ARN) of the theme version.</p>
|
|
1699
|
+
*/
|
|
1700
|
+
Arn?: string;
|
|
1701
|
+
/**
|
|
1702
|
+
* <p>The description of the theme version.</p>
|
|
1703
|
+
*/
|
|
1704
|
+
Description?: string;
|
|
1705
|
+
/**
|
|
1706
|
+
* <p>The date and time that this theme version was created.</p>
|
|
1707
|
+
*/
|
|
1708
|
+
CreatedTime?: Date;
|
|
1709
|
+
/**
|
|
1710
|
+
* <p>The status of the theme version.</p>
|
|
1711
|
+
*/
|
|
1712
|
+
Status?: ResourceStatus | string;
|
|
1713
|
+
}
|
|
1714
|
+
export interface ListThemeVersionsResponse {
|
|
1715
|
+
/**
|
|
1716
|
+
* <p>A structure containing a list of all the versions of the specified theme.</p>
|
|
1717
|
+
*/
|
|
1718
|
+
ThemeVersionSummaryList?: ThemeVersionSummary[];
|
|
1719
|
+
/**
|
|
1720
|
+
* <p>The token for the next set of results, or null if there are no more results.</p>
|
|
1721
|
+
*/
|
|
1722
|
+
NextToken?: string;
|
|
1723
|
+
/**
|
|
1724
|
+
* <p>The HTTP status of the request.</p>
|
|
1725
|
+
*/
|
|
1726
|
+
Status?: number;
|
|
1727
|
+
/**
|
|
1728
|
+
* <p>The Amazon Web Services request ID for this operation.</p>
|
|
1729
|
+
*/
|
|
1730
|
+
RequestId?: string;
|
|
1731
|
+
}
|
|
1732
|
+
export interface ListUserGroupsRequest {
|
|
1733
|
+
/**
|
|
1734
|
+
* <p>The Amazon QuickSight user name that you want to list group memberships for.</p>
|
|
1735
|
+
*/
|
|
1736
|
+
UserName: string | undefined;
|
|
1737
|
+
/**
|
|
1738
|
+
* <p>The Amazon Web Services account ID that the user is in. Currently, you use the ID for the Amazon Web Services account
|
|
1739
|
+
* that contains your Amazon QuickSight account.</p>
|
|
1740
|
+
*/
|
|
1741
|
+
AwsAccountId: string | undefined;
|
|
1742
|
+
/**
|
|
1743
|
+
* <p>The namespace. Currently, you should set this to <code>default</code>.</p>
|
|
1744
|
+
*/
|
|
1745
|
+
Namespace: string | undefined;
|
|
1746
|
+
/**
|
|
1747
|
+
* <p>A pagination token that can be used in a subsequent request.</p>
|
|
1748
|
+
*/
|
|
1749
|
+
NextToken?: string;
|
|
1750
|
+
/**
|
|
1751
|
+
* <p>The maximum number of results to return from this request.</p>
|
|
1752
|
+
*/
|
|
1753
|
+
MaxResults?: number;
|
|
1754
|
+
}
|
|
1755
|
+
export interface ListUserGroupsResponse {
|
|
1756
|
+
/**
|
|
1757
|
+
* <p>The list of groups the user is a member of.</p>
|
|
1758
|
+
*/
|
|
1759
|
+
GroupList?: Group[];
|
|
1760
|
+
/**
|
|
1761
|
+
* <p>A pagination token that can be used in a subsequent request.</p>
|
|
1762
|
+
*/
|
|
1763
|
+
NextToken?: string;
|
|
1764
|
+
/**
|
|
1765
|
+
* <p>The Amazon Web Services request ID for this operation.</p>
|
|
1766
|
+
*/
|
|
1767
|
+
RequestId?: string;
|
|
1768
|
+
/**
|
|
1769
|
+
* <p>The HTTP status of the request.</p>
|
|
1770
|
+
*/
|
|
1771
|
+
Status?: number;
|
|
1772
|
+
}
|
|
1773
|
+
export interface ListUsersRequest {
|
|
1774
|
+
/**
|
|
1775
|
+
* <p>The ID for the Amazon Web Services account that the user is in. Currently, you use the ID for the
|
|
1776
|
+
* Amazon Web Services account that contains your Amazon QuickSight account.</p>
|
|
1777
|
+
*/
|
|
1778
|
+
AwsAccountId: string | undefined;
|
|
1779
|
+
/**
|
|
1780
|
+
* <p>A pagination token that can be used in a subsequent request.</p>
|
|
1781
|
+
*/
|
|
1782
|
+
NextToken?: string;
|
|
1783
|
+
/**
|
|
1784
|
+
* <p>The maximum number of results to return from this request.</p>
|
|
1785
|
+
*/
|
|
1786
|
+
MaxResults?: number;
|
|
1787
|
+
/**
|
|
1788
|
+
* <p>The namespace. Currently, you should set this to <code>default</code>.</p>
|
|
1789
|
+
*/
|
|
1790
|
+
Namespace: string | undefined;
|
|
1791
|
+
}
|
|
1792
|
+
export interface ListUsersResponse {
|
|
1793
|
+
/**
|
|
1794
|
+
* <p>The list of users.</p>
|
|
1795
|
+
*/
|
|
1796
|
+
UserList?: User[];
|
|
1797
|
+
/**
|
|
1798
|
+
* <p>A pagination token that can be used in a subsequent request.</p>
|
|
1799
|
+
*/
|
|
1800
|
+
NextToken?: string;
|
|
1801
|
+
/**
|
|
1802
|
+
* <p>The Amazon Web Services request ID for this operation.</p>
|
|
1803
|
+
*/
|
|
1804
|
+
RequestId?: string;
|
|
1805
|
+
/**
|
|
1806
|
+
* <p>The HTTP status of the request.</p>
|
|
1807
|
+
*/
|
|
1808
|
+
Status?: number;
|
|
1809
|
+
}
|
|
1810
|
+
export interface RegisterUserRequest {
|
|
1811
|
+
/**
|
|
1812
|
+
* <p>Amazon QuickSight supports several ways of managing the identity of users. This
|
|
1813
|
+
* parameter accepts two values:</p>
|
|
1814
|
+
* <ul>
|
|
1815
|
+
* <li>
|
|
1816
|
+
* <p>
|
|
1817
|
+
* <code>IAM</code>: A user whose identity maps to an existing IAM user or role.
|
|
1818
|
+
* </p>
|
|
1819
|
+
* </li>
|
|
1820
|
+
* <li>
|
|
1821
|
+
* <p>
|
|
1822
|
+
* <code>QUICKSIGHT</code>: A user whose identity is owned and managed internally by
|
|
1823
|
+
* Amazon QuickSight. </p>
|
|
1824
|
+
* </li>
|
|
1825
|
+
* </ul>
|
|
1826
|
+
*/
|
|
1827
|
+
IdentityType: IdentityType | string | undefined;
|
|
1828
|
+
/**
|
|
1829
|
+
* <p>The email address of the user that you want to register.</p>
|
|
1830
|
+
*/
|
|
1831
|
+
Email: string | undefined;
|
|
1832
|
+
/**
|
|
1833
|
+
* <p>The Amazon QuickSight role for the user. The user role can be one of the
|
|
1834
|
+
* following:</p>
|
|
1835
|
+
* <ul>
|
|
1836
|
+
* <li>
|
|
1837
|
+
* <p>
|
|
1838
|
+
* <code>READER</code>: A user who has read-only access to dashboards.</p>
|
|
1839
|
+
* </li>
|
|
1840
|
+
* <li>
|
|
1841
|
+
* <p>
|
|
1842
|
+
* <code>AUTHOR</code>: A user who can create data sources, datasets, analyses, and
|
|
1843
|
+
* dashboards.</p>
|
|
1844
|
+
* </li>
|
|
1845
|
+
* <li>
|
|
1846
|
+
* <p>
|
|
1847
|
+
* <code>ADMIN</code>: A user who is an author, who can also manage Amazon QuickSight
|
|
1848
|
+
* settings.</p>
|
|
1849
|
+
* </li>
|
|
1850
|
+
* <li>
|
|
1851
|
+
* <p>
|
|
1852
|
+
* <code>RESTRICTED_READER</code>: This role isn't currently available for
|
|
1853
|
+
* use.</p>
|
|
1854
|
+
* </li>
|
|
1855
|
+
* <li>
|
|
1856
|
+
* <p>
|
|
1857
|
+
* <code>RESTRICTED_AUTHOR</code>: This role isn't currently available for
|
|
1858
|
+
* use.</p>
|
|
1859
|
+
* </li>
|
|
1860
|
+
* </ul>
|
|
1861
|
+
*/
|
|
1862
|
+
UserRole: UserRole | string | undefined;
|
|
1863
|
+
/**
|
|
1864
|
+
* <p>The ARN of the IAM user or role that you are registering with Amazon QuickSight. </p>
|
|
1865
|
+
*/
|
|
1866
|
+
IamArn?: string;
|
|
1867
|
+
/**
|
|
1868
|
+
* <p>You need to use this parameter only when you register one or more users using an assumed
|
|
1869
|
+
* IAM role. You don't need to provide the session name for other scenarios, for example when
|
|
1870
|
+
* you are registering an IAM user or an Amazon QuickSight user. You can register multiple
|
|
1871
|
+
* users using the same IAM role if each user has a different session name. For more
|
|
1872
|
+
* information on assuming IAM roles, see <a href="https://docs.aws.amazon.com/cli/latest/reference/sts/assume-role.html">
|
|
1873
|
+
* <code>assume-role</code>
|
|
1874
|
+
* </a> in the <i>CLI Reference.</i>
|
|
1875
|
+
* </p>
|
|
1876
|
+
*/
|
|
1877
|
+
SessionName?: string;
|
|
1878
|
+
/**
|
|
1879
|
+
* <p>The ID for the Amazon Web Services account that the user is in. Currently, you use the ID for the
|
|
1880
|
+
* Amazon Web Services account that contains your Amazon QuickSight account.</p>
|
|
1881
|
+
*/
|
|
1882
|
+
AwsAccountId: string | undefined;
|
|
1883
|
+
/**
|
|
1884
|
+
* <p>The namespace. Currently, you should set this to <code>default</code>.</p>
|
|
1885
|
+
*/
|
|
1886
|
+
Namespace: string | undefined;
|
|
1887
|
+
/**
|
|
1888
|
+
* <p>The Amazon QuickSight user name that you want to create for the user you are
|
|
1889
|
+
* registering.</p>
|
|
1890
|
+
*/
|
|
1891
|
+
UserName?: string;
|
|
1892
|
+
/**
|
|
1893
|
+
* <p>(Enterprise edition only) The name of the custom permissions profile that you want to
|
|
1894
|
+
* assign to this user. Customized permissions allows you to control a user's access by
|
|
1895
|
+
* restricting access the following operations:</p>
|
|
1896
|
+
* <ul>
|
|
1897
|
+
* <li>
|
|
1898
|
+
* <p>Create and update data sources</p>
|
|
1899
|
+
* </li>
|
|
1900
|
+
* <li>
|
|
1901
|
+
* <p>Create and update datasets</p>
|
|
1902
|
+
* </li>
|
|
1903
|
+
* <li>
|
|
1904
|
+
* <p>Create and update email reports</p>
|
|
1905
|
+
* </li>
|
|
1906
|
+
* <li>
|
|
1907
|
+
* <p>Subscribe to email reports</p>
|
|
1908
|
+
* </li>
|
|
1909
|
+
* </ul>
|
|
1910
|
+
* <p>To add custom permissions to an existing user, use <code>
|
|
1911
|
+
* <a href="https://docs.aws.amazon.com/quicksight/latest/APIReference/API_UpdateUser.html">UpdateUser</a>
|
|
1912
|
+
* </code> instead.</p>
|
|
1913
|
+
* <p>A set of custom permissions includes any combination of these restrictions. Currently,
|
|
1914
|
+
* you need to create the profile names for custom permission sets by using the Amazon QuickSight
|
|
1915
|
+
* console. Then, you use the <code>RegisterUser</code> API operation to assign the named set of
|
|
1916
|
+
* permissions to a Amazon QuickSight user. </p>
|
|
1917
|
+
* <p>Amazon QuickSight custom permissions are applied through IAM policies. Therefore, they
|
|
1918
|
+
* override the permissions typically granted by assigning Amazon QuickSight users to one of the
|
|
1919
|
+
* default security cohorts in Amazon QuickSight (admin, author, reader).</p>
|
|
1920
|
+
* <p>This feature is available only to Amazon QuickSight Enterprise edition subscriptions.</p>
|
|
1921
|
+
*/
|
|
1922
|
+
CustomPermissionsName?: string;
|
|
1923
|
+
/**
|
|
1924
|
+
* <p>The type of supported external login provider that provides identity to let a user federate into Amazon QuickSight with an associated Identity and Access Management(IAM) role. The type of supported external login provider can be one of the following.</p>
|
|
1925
|
+
* <ul>
|
|
1926
|
+
* <li>
|
|
1927
|
+
* <p>
|
|
1928
|
+
* <code>COGNITO</code>: Amazon Cognito. The provider URL is cognito-identity.amazonaws.com. When choosing the <code>COGNITO</code> provider type, don’t use the "CustomFederationProviderUrl" parameter which is only needed when the external provider is custom.</p>
|
|
1929
|
+
* </li>
|
|
1930
|
+
* <li>
|
|
1931
|
+
* <p>
|
|
1932
|
+
* <code>CUSTOM_OIDC</code>: Custom OpenID Connect (OIDC) provider. When choosing <code>CUSTOM_OIDC</code> type, use the <code>CustomFederationProviderUrl</code> parameter to provide the custom OIDC provider URL.</p>
|
|
1933
|
+
* </li>
|
|
1934
|
+
* </ul>
|
|
1935
|
+
*/
|
|
1936
|
+
ExternalLoginFederationProviderType?: string;
|
|
1937
|
+
/**
|
|
1938
|
+
* <p>The URL of the custom OpenID Connect (OIDC) provider that provides identity to let a user federate
|
|
1939
|
+
* into Amazon QuickSight with an associated Identity and Access Management(IAM) role. This parameter should
|
|
1940
|
+
* only be used when <code>ExternalLoginFederationProviderType</code> parameter is set to <code>CUSTOM_OIDC</code>.</p>
|
|
1941
|
+
*/
|
|
1942
|
+
CustomFederationProviderUrl?: string;
|
|
1943
|
+
/**
|
|
1944
|
+
* <p>The identity ID for a user in the external login provider.</p>
|
|
1945
|
+
*/
|
|
1946
|
+
ExternalLoginId?: string;
|
|
1947
|
+
}
|
|
1948
|
+
export interface RegisterUserResponse {
|
|
1949
|
+
/**
|
|
1950
|
+
* <p>The user's user name.</p>
|
|
1951
|
+
*/
|
|
1952
|
+
User?: User;
|
|
1953
|
+
/**
|
|
1954
|
+
* <p>The URL the user visits to complete registration and provide a password. This is
|
|
1955
|
+
* returned only for users with an identity type of <code>QUICKSIGHT</code>.</p>
|
|
1956
|
+
*/
|
|
1957
|
+
UserInvitationUrl?: string;
|
|
1958
|
+
/**
|
|
1959
|
+
* <p>The Amazon Web Services request ID for this operation.</p>
|
|
1960
|
+
*/
|
|
1961
|
+
RequestId?: string;
|
|
1962
|
+
/**
|
|
1963
|
+
* <p>The HTTP status of the request.</p>
|
|
1964
|
+
*/
|
|
1965
|
+
Status?: number;
|
|
1966
|
+
}
|
|
1967
|
+
export interface RestoreAnalysisRequest {
|
|
1968
|
+
/**
|
|
1969
|
+
* <p>The ID of the Amazon Web Services account that contains the analysis.</p>
|
|
1970
|
+
*/
|
|
1971
|
+
AwsAccountId: string | undefined;
|
|
1972
|
+
/**
|
|
1973
|
+
* <p>The ID of the analysis that you're restoring.</p>
|
|
1974
|
+
*/
|
|
1975
|
+
AnalysisId: string | undefined;
|
|
1976
|
+
}
|
|
1977
|
+
export interface RestoreAnalysisResponse {
|
|
1978
|
+
/**
|
|
1979
|
+
* <p>The HTTP status of the request.</p>
|
|
1980
|
+
*/
|
|
1981
|
+
Status?: number;
|
|
1982
|
+
/**
|
|
1983
|
+
* <p>The Amazon Resource Name (ARN) of the analysis that you're restoring.</p>
|
|
1984
|
+
*/
|
|
1985
|
+
Arn?: string;
|
|
1986
|
+
/**
|
|
1987
|
+
* <p>The ID of the analysis that you're restoring.
|
|
1988
|
+
* </p>
|
|
1989
|
+
*/
|
|
1990
|
+
AnalysisId?: string;
|
|
1991
|
+
/**
|
|
1992
|
+
* <p>The Amazon Web Services request ID for this operation.</p>
|
|
1993
|
+
*/
|
|
1994
|
+
RequestId?: string;
|
|
1995
|
+
}
|
|
1996
|
+
export interface SearchAnalysesRequest {
|
|
1997
|
+
/**
|
|
1998
|
+
* <p>The ID of the Amazon Web Services account that contains the analyses that you're searching
|
|
1999
|
+
* for.</p>
|
|
2000
|
+
*/
|
|
2001
|
+
AwsAccountId: string | undefined;
|
|
2002
|
+
/**
|
|
2003
|
+
* <p>The structure for the search filters that you want to apply to your search. </p>
|
|
2004
|
+
*/
|
|
2005
|
+
Filters: AnalysisSearchFilter[] | undefined;
|
|
2006
|
+
/**
|
|
2007
|
+
* <p>A pagination token that can be used in a subsequent request.</p>
|
|
2008
|
+
*/
|
|
2009
|
+
NextToken?: string;
|
|
2010
|
+
/**
|
|
2011
|
+
* <p>The maximum number of results to return.</p>
|
|
2012
|
+
*/
|
|
2013
|
+
MaxResults?: number;
|
|
2014
|
+
}
|
|
2015
|
+
export interface SearchAnalysesResponse {
|
|
2016
|
+
/**
|
|
2017
|
+
* <p>Metadata describing the analyses that you searched for.</p>
|
|
2018
|
+
*/
|
|
2019
|
+
AnalysisSummaryList?: AnalysisSummary[];
|
|
2020
|
+
/**
|
|
2021
|
+
* <p>A pagination token that can be used in a subsequent request.
|
|
2022
|
+
* </p>
|
|
2023
|
+
*/
|
|
2024
|
+
NextToken?: string;
|
|
2025
|
+
/**
|
|
2026
|
+
* <p>The HTTP status of the request.</p>
|
|
2027
|
+
*/
|
|
2028
|
+
Status?: number;
|
|
2029
|
+
/**
|
|
2030
|
+
* <p>The Amazon Web Services request ID for this operation.</p>
|
|
2031
|
+
*/
|
|
2032
|
+
RequestId?: string;
|
|
2033
|
+
}
|
|
2034
|
+
export interface SearchDashboardsRequest {
|
|
2035
|
+
/**
|
|
2036
|
+
* <p>The ID of the Amazon Web Services account that contains the user whose dashboards you're searching
|
|
2037
|
+
* for. </p>
|
|
2038
|
+
*/
|
|
2039
|
+
AwsAccountId: string | undefined;
|
|
2040
|
+
/**
|
|
2041
|
+
* <p>The filters to apply to the search. Currently, you can search only by user name, for
|
|
2042
|
+
* example, <code>"Filters": [ { "Name": "QUICKSIGHT_USER", "Operator": "StringEquals",
|
|
2043
|
+
* "Value": "arn:aws:quicksight:us-east-1:1:user/default/UserName1" } ]</code>
|
|
2044
|
+
* </p>
|
|
2045
|
+
*/
|
|
2046
|
+
Filters: DashboardSearchFilter[] | undefined;
|
|
2047
|
+
/**
|
|
2048
|
+
* <p>The token for the next set of results, or null if there are no more results.</p>
|
|
2049
|
+
*/
|
|
2050
|
+
NextToken?: string;
|
|
2051
|
+
/**
|
|
2052
|
+
* <p>The maximum number of results to be returned per request.</p>
|
|
2053
|
+
*/
|
|
2054
|
+
MaxResults?: number;
|
|
2055
|
+
}
|
|
2056
|
+
export interface SearchDashboardsResponse {
|
|
2057
|
+
/**
|
|
2058
|
+
* <p>The list of dashboards owned by the user specified in <code>Filters</code> in your
|
|
2059
|
+
* request.</p>
|
|
2060
|
+
*/
|
|
2061
|
+
DashboardSummaryList?: DashboardSummary[];
|
|
2062
|
+
/**
|
|
2063
|
+
* <p>The token for the next set of results, or null if there are no more results.</p>
|
|
2064
|
+
*/
|
|
2065
|
+
NextToken?: string;
|
|
2066
|
+
/**
|
|
2067
|
+
* <p>The HTTP status of the request.</p>
|
|
2068
|
+
*/
|
|
2069
|
+
Status?: number;
|
|
2070
|
+
/**
|
|
2071
|
+
* <p>The Amazon Web Services request ID for this operation.</p>
|
|
2072
|
+
*/
|
|
2073
|
+
RequestId?: string;
|
|
2074
|
+
}
|
|
2075
|
+
export interface SearchFoldersRequest {
|
|
2076
|
+
/**
|
|
2077
|
+
* <p>The ID for the Amazon Web Services account that contains the folder.</p>
|
|
2078
|
+
*/
|
|
2079
|
+
AwsAccountId: string | undefined;
|
|
2080
|
+
/**
|
|
2081
|
+
* <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>
|
|
2082
|
+
*/
|
|
2083
|
+
Filters: FolderSearchFilter[] | undefined;
|
|
2084
|
+
/**
|
|
2085
|
+
* <p>The token for the next set of results, or null if there are no more results.</p>
|
|
2086
|
+
*/
|
|
2087
|
+
NextToken?: string;
|
|
2088
|
+
/**
|
|
2089
|
+
* <p>The maximum number of results to be returned per request.</p>
|
|
2090
|
+
*/
|
|
2091
|
+
MaxResults?: number;
|
|
2092
|
+
}
|
|
2093
|
+
export interface SearchFoldersResponse {
|
|
2094
|
+
/**
|
|
2095
|
+
* <p>The HTTP status of the request.</p>
|
|
2096
|
+
*/
|
|
2097
|
+
Status?: number;
|
|
2098
|
+
/**
|
|
2099
|
+
* <p>A structure that contains all of the folders in the Amazon Web Services account. This structure provides basic information about the folders.</p>
|
|
2100
|
+
*/
|
|
2101
|
+
FolderSummaryList?: FolderSummary[];
|
|
2102
|
+
/**
|
|
2103
|
+
* <p>The token for the next set of results, or null if there are no more results.</p>
|
|
2104
|
+
*/
|
|
2105
|
+
NextToken?: string;
|
|
2106
|
+
/**
|
|
2107
|
+
* <p>The Amazon Web Services request ID for this operation.</p>
|
|
2108
|
+
*/
|
|
2109
|
+
RequestId?: string;
|
|
2110
|
+
}
|
|
2111
|
+
export interface SearchGroupsRequest {
|
|
2112
|
+
/**
|
|
2113
|
+
* <p>The ID for the Amazon Web Services account that the group is in. Currently, you use the ID for the
|
|
2114
|
+
* Amazon Web Services account that contains your Amazon QuickSight account.</p>
|
|
2115
|
+
*/
|
|
2116
|
+
AwsAccountId: string | undefined;
|
|
2117
|
+
/**
|
|
2118
|
+
* <p>A pagination token that can be used in a subsequent request.</p>
|
|
2119
|
+
*/
|
|
2120
|
+
NextToken?: string;
|
|
2121
|
+
/**
|
|
2122
|
+
* <p>The maximum number of results to return from this request.</p>
|
|
2123
|
+
*/
|
|
2124
|
+
MaxResults?: number;
|
|
2125
|
+
/**
|
|
2126
|
+
* <p>The namespace that you want to search.</p>
|
|
2127
|
+
*/
|
|
2128
|
+
Namespace: string | undefined;
|
|
2129
|
+
/**
|
|
2130
|
+
* <p>The structure for the search filters that you want to apply to your search.</p>
|
|
2131
|
+
*/
|
|
2132
|
+
Filters: GroupSearchFilter[] | undefined;
|
|
2133
|
+
}
|
|
2134
|
+
export interface SearchGroupsResponse {
|
|
2135
|
+
/**
|
|
2136
|
+
* <p>A list of groups in a specified namespace that match the filters you set in your <code>SearchGroups</code> request.</p>
|
|
2137
|
+
*/
|
|
2138
|
+
GroupList?: Group[];
|
|
2139
|
+
/**
|
|
2140
|
+
* <p>A pagination token that can be used in a subsequent request.</p>
|
|
2141
|
+
*/
|
|
2142
|
+
NextToken?: string;
|
|
2143
|
+
/**
|
|
2144
|
+
* <p>The Amazon Web Services request ID for this operation.</p>
|
|
2145
|
+
*/
|
|
2146
|
+
RequestId?: string;
|
|
2147
|
+
/**
|
|
2148
|
+
* <p>The HTTP status of the request.</p>
|
|
2149
|
+
*/
|
|
2150
|
+
Status?: number;
|
|
2151
|
+
}
|
|
2152
|
+
export interface TagResourceRequest {
|
|
2153
|
+
/**
|
|
2154
|
+
* <p>The Amazon Resource Name (ARN) of the resource that you want to tag.</p>
|
|
2155
|
+
*/
|
|
2156
|
+
ResourceArn: string | undefined;
|
|
2157
|
+
/**
|
|
2158
|
+
* <p>Contains a map of the key-value pairs for the resource tag or tags assigned to the resource.</p>
|
|
2159
|
+
*/
|
|
2160
|
+
Tags: Tag[] | undefined;
|
|
2161
|
+
}
|
|
2162
|
+
export interface TagResourceResponse {
|
|
2163
|
+
/**
|
|
2164
|
+
* <p>The Amazon Web Services request ID for this operation.</p>
|
|
2165
|
+
*/
|
|
2166
|
+
RequestId?: string;
|
|
2167
|
+
/**
|
|
2168
|
+
* <p>The HTTP status of the request.</p>
|
|
2169
|
+
*/
|
|
2170
|
+
Status?: number;
|
|
2171
|
+
}
|
|
2172
|
+
export interface UntagResourceRequest {
|
|
2173
|
+
/**
|
|
2174
|
+
* <p>The Amazon Resource Name (ARN) of the resource that you want to untag.</p>
|
|
2175
|
+
*/
|
|
2176
|
+
ResourceArn: string | undefined;
|
|
2177
|
+
/**
|
|
2178
|
+
* <p>The keys of the key-value pairs for the resource tag or tags assigned to the resource.</p>
|
|
2179
|
+
*/
|
|
2180
|
+
TagKeys: string[] | undefined;
|
|
2181
|
+
}
|
|
2182
|
+
export interface UntagResourceResponse {
|
|
2183
|
+
/**
|
|
2184
|
+
* <p>The Amazon Web Services request ID for this operation.</p>
|
|
2185
|
+
*/
|
|
2186
|
+
RequestId?: string;
|
|
2187
|
+
/**
|
|
2188
|
+
* <p>The HTTP status of the request.</p>
|
|
2189
|
+
*/
|
|
2190
|
+
Status?: number;
|
|
2191
|
+
}
|
|
2192
|
+
export interface UpdateAccountCustomizationRequest {
|
|
2193
|
+
/**
|
|
2194
|
+
* <p>The ID for the Amazon Web Services account that you want to update Amazon QuickSight customizations
|
|
2195
|
+
* for.</p>
|
|
2196
|
+
*/
|
|
2197
|
+
AwsAccountId: string | undefined;
|
|
2198
|
+
/**
|
|
2199
|
+
* <p>The namespace that you want to update Amazon QuickSight customizations for.</p>
|
|
2200
|
+
*/
|
|
2201
|
+
Namespace?: string;
|
|
2202
|
+
/**
|
|
2203
|
+
* <p>The Amazon QuickSight customizations you're updating in the current Amazon Web Services Region. </p>
|
|
2204
|
+
*/
|
|
2205
|
+
AccountCustomization: AccountCustomization | undefined;
|
|
2206
|
+
}
|
|
2207
|
+
export interface UpdateAccountCustomizationResponse {
|
|
2208
|
+
/**
|
|
2209
|
+
* <p>The Amazon Resource Name (ARN) for the updated customization for this Amazon Web Services account.</p>
|
|
2210
|
+
*/
|
|
2211
|
+
Arn?: string;
|
|
2212
|
+
/**
|
|
2213
|
+
* <p>The ID for the Amazon Web Services account that you want to update Amazon QuickSight customizations
|
|
2214
|
+
* for.</p>
|
|
2215
|
+
*/
|
|
2216
|
+
AwsAccountId?: string;
|
|
2217
|
+
/**
|
|
2218
|
+
* <p>The namespace associated with the customization that you're updating.</p>
|
|
2219
|
+
*/
|
|
2220
|
+
Namespace?: string;
|
|
2221
|
+
/**
|
|
2222
|
+
* <p>The Amazon QuickSight customizations you're updating in the current Amazon Web Services Region. </p>
|
|
2223
|
+
*/
|
|
2224
|
+
AccountCustomization?: AccountCustomization;
|
|
2225
|
+
/**
|
|
2226
|
+
* <p>The Amazon Web Services request ID for this operation.</p>
|
|
2227
|
+
*/
|
|
2228
|
+
RequestId?: string;
|
|
2229
|
+
/**
|
|
2230
|
+
* <p>The HTTP status of the request.</p>
|
|
2231
|
+
*/
|
|
2232
|
+
Status?: number;
|
|
2233
|
+
}
|
|
2234
|
+
export interface UpdateAccountSettingsRequest {
|
|
2235
|
+
/**
|
|
2236
|
+
* <p>The ID for the Amazon Web Services account that contains the Amazon QuickSight settings that you want to
|
|
2237
|
+
* list.</p>
|
|
2238
|
+
*/
|
|
2239
|
+
AwsAccountId: string | undefined;
|
|
2240
|
+
/**
|
|
2241
|
+
* <p>The default namespace for this Amazon Web Services account. Currently, the default is
|
|
2242
|
+
* <code>default</code>. Identity and Access Management (IAM) users that
|
|
2243
|
+
* register for the first time with Amazon QuickSight provide an email address that becomes
|
|
2244
|
+
* associated with the default namespace.
|
|
2245
|
+
* </p>
|
|
2246
|
+
*/
|
|
2247
|
+
DefaultNamespace: string | undefined;
|
|
2248
|
+
/**
|
|
2249
|
+
* <p>The email address that you want Amazon QuickSight to send notifications to regarding your
|
|
2250
|
+
* Amazon Web Services account or Amazon QuickSight subscription.</p>
|
|
2251
|
+
*/
|
|
2252
|
+
NotificationEmail?: string;
|
|
2253
|
+
}
|
|
2254
|
+
export interface UpdateAccountSettingsResponse {
|
|
2255
|
+
/**
|
|
2256
|
+
* <p>The Amazon Web Services request ID for this operation.</p>
|
|
2257
|
+
*/
|
|
2258
|
+
RequestId?: string;
|
|
2259
|
+
/**
|
|
2260
|
+
* <p>The HTTP status of the request.</p>
|
|
2261
|
+
*/
|
|
2262
|
+
Status?: number;
|
|
2263
|
+
}
|
|
2264
|
+
export interface UpdateAnalysisRequest {
|
|
2265
|
+
/**
|
|
2266
|
+
* <p>The ID of the Amazon Web Services account that contains the analysis that you're updating.</p>
|
|
2267
|
+
*/
|
|
2268
|
+
AwsAccountId: string | undefined;
|
|
2269
|
+
/**
|
|
2270
|
+
* <p>The ID for the analysis that you're updating. This ID displays in the URL of the
|
|
2271
|
+
* analysis.</p>
|
|
2272
|
+
*/
|
|
2273
|
+
AnalysisId: string | undefined;
|
|
2274
|
+
/**
|
|
2275
|
+
* <p>A descriptive name for the analysis that you're updating. This name displays for the
|
|
2276
|
+
* analysis in the Amazon QuickSight console.</p>
|
|
2277
|
+
*/
|
|
2278
|
+
Name: string | undefined;
|
|
2279
|
+
/**
|
|
2280
|
+
* <p>The parameter names and override values that you want to use. An analysis can have
|
|
2281
|
+
* any parameter type, and some parameters might accept multiple values. </p>
|
|
2282
|
+
*/
|
|
2283
|
+
Parameters?: _Parameters;
|
|
2284
|
+
/**
|
|
2285
|
+
* <p>A source entity to use for the analysis that you're updating. This metadata structure
|
|
2286
|
+
* contains details that describe a source template and one or more datasets.</p>
|
|
2287
|
+
*/
|
|
2288
|
+
SourceEntity: AnalysisSourceEntity | undefined;
|
|
2289
|
+
/**
|
|
2290
|
+
* <p>The Amazon Resource Name (ARN) for the theme to apply to the analysis that you're
|
|
2291
|
+
* creating. To see the theme in the Amazon QuickSight console, make sure that you have access to
|
|
2292
|
+
* it.</p>
|
|
2293
|
+
*/
|
|
2294
|
+
ThemeArn?: string;
|
|
2295
|
+
}
|
|
2296
|
+
export interface UpdateAnalysisResponse {
|
|
2297
|
+
/**
|
|
2298
|
+
* <p>The ARN of the analysis that you're updating.</p>
|
|
2299
|
+
*/
|
|
2300
|
+
Arn?: string;
|
|
2301
|
+
/**
|
|
2302
|
+
* <p>The ID of the analysis.</p>
|
|
2303
|
+
*/
|
|
2304
|
+
AnalysisId?: string;
|
|
2305
|
+
/**
|
|
2306
|
+
* <p>The update status of the last update that was made to the analysis.</p>
|
|
2307
|
+
*/
|
|
2308
|
+
UpdateStatus?: ResourceStatus | string;
|
|
2309
|
+
/**
|
|
2310
|
+
* <p>The HTTP status of the request.</p>
|
|
2311
|
+
*/
|
|
2312
|
+
Status?: number;
|
|
2313
|
+
/**
|
|
2314
|
+
* <p>The Amazon Web Services request ID for this operation.</p>
|
|
2315
|
+
*/
|
|
2316
|
+
RequestId?: string;
|
|
2317
|
+
}
|
|
2318
|
+
export interface UpdateAnalysisPermissionsRequest {
|
|
2319
|
+
/**
|
|
2320
|
+
* <p>The ID of the Amazon Web Services account that contains the analysis whose permissions you're
|
|
2321
|
+
* updating. You must be using the Amazon Web Services account that the analysis is in.</p>
|
|
2322
|
+
*/
|
|
2323
|
+
AwsAccountId: string | undefined;
|
|
2324
|
+
/**
|
|
2325
|
+
* <p>The ID of the analysis whose permissions you're updating. The ID is part of the
|
|
2326
|
+
* analysis URL.</p>
|
|
2327
|
+
*/
|
|
2328
|
+
AnalysisId: string | undefined;
|
|
2329
|
+
/**
|
|
2330
|
+
* <p>A structure that describes the permissions to add and the principal to add them
|
|
2331
|
+
* to.</p>
|
|
2332
|
+
*/
|
|
2333
|
+
GrantPermissions?: ResourcePermission[];
|
|
2334
|
+
/**
|
|
2335
|
+
* <p>A structure that describes the permissions to remove and the principal to remove them
|
|
2336
|
+
* from.</p>
|
|
2337
|
+
*/
|
|
2338
|
+
RevokePermissions?: ResourcePermission[];
|
|
2339
|
+
}
|
|
2340
|
+
export interface UpdateAnalysisPermissionsResponse {
|
|
2341
|
+
/**
|
|
2342
|
+
* <p>The Amazon Resource Name (ARN) of the analysis that you updated.</p>
|
|
2343
|
+
*/
|
|
2344
|
+
AnalysisArn?: string;
|
|
2345
|
+
/**
|
|
2346
|
+
* <p>The ID of the analysis that you updated permissions for.</p>
|
|
2347
|
+
*/
|
|
2348
|
+
AnalysisId?: string;
|
|
2349
|
+
/**
|
|
2350
|
+
* <p>A structure that describes the principals and the resource-level permissions on an
|
|
2351
|
+
* analysis.</p>
|
|
2352
|
+
*/
|
|
2353
|
+
Permissions?: ResourcePermission[];
|
|
2354
|
+
/**
|
|
2355
|
+
* <p>The Amazon Web Services request ID for this operation.</p>
|
|
2356
|
+
*/
|
|
2357
|
+
RequestId?: string;
|
|
2358
|
+
/**
|
|
2359
|
+
* <p>The HTTP status of the request.</p>
|
|
2360
|
+
*/
|
|
2361
|
+
Status?: number;
|
|
2362
|
+
}
|
|
2363
|
+
export interface UpdateDashboardRequest {
|
|
2364
|
+
/**
|
|
2365
|
+
* <p>The ID of the Amazon Web Services account that contains the dashboard that you're
|
|
2366
|
+
* updating.</p>
|
|
2367
|
+
*/
|
|
2368
|
+
AwsAccountId: string | undefined;
|
|
2369
|
+
/**
|
|
2370
|
+
* <p>The ID for the dashboard.</p>
|
|
2371
|
+
*/
|
|
2372
|
+
DashboardId: string | undefined;
|
|
2373
|
+
/**
|
|
2374
|
+
* <p>The display name of the dashboard.</p>
|
|
2375
|
+
*/
|
|
2376
|
+
Name: string | undefined;
|
|
2377
|
+
/**
|
|
2378
|
+
* <p>The entity that you are using as a source when you update the dashboard. In
|
|
2379
|
+
* <code>SourceEntity</code>, you specify the type of object you're using as source. You
|
|
2380
|
+
* can only update a dashboard from a template, so you use a <code>SourceTemplate</code>
|
|
2381
|
+
* entity. If you need to update a dashboard from an analysis, first convert the analysis
|
|
2382
|
+
* to a template by using the <code>
|
|
2383
|
+
* <a href="https://docs.aws.amazon.com/quicksight/latest/APIReference/API_CreateTemplate.html">CreateTemplate</a>
|
|
2384
|
+
* </code> API operation. For
|
|
2385
|
+
* <code>SourceTemplate</code>, specify the Amazon Resource Name (ARN) of the source
|
|
2386
|
+
* template. The <code>SourceTemplate</code> ARN can contain any Amazon Web Services account and any
|
|
2387
|
+
* Amazon QuickSight-supported Amazon Web Services Region. </p>
|
|
2388
|
+
* <p>Use the <code>DataSetReferences</code> entity within <code>SourceTemplate</code> to
|
|
2389
|
+
* list the replacement datasets for the placeholders listed in the original. The schema in
|
|
2390
|
+
* each dataset must match its placeholder. </p>
|
|
2391
|
+
*/
|
|
2392
|
+
SourceEntity: DashboardSourceEntity | undefined;
|
|
2393
|
+
/**
|
|
2394
|
+
* <p>A structure that contains the parameters of the dashboard. These are parameter
|
|
2395
|
+
* overrides for a dashboard. A dashboard can have any type of parameters, and some
|
|
2396
|
+
* parameters might accept multiple values.</p>
|
|
2397
|
+
*/
|
|
2398
|
+
Parameters?: _Parameters;
|
|
2399
|
+
/**
|
|
2400
|
+
* <p>A description for the first version of the dashboard being created.</p>
|
|
2401
|
+
*/
|
|
2402
|
+
VersionDescription?: string;
|
|
2403
|
+
/**
|
|
2404
|
+
* <p>Options for publishing the dashboard when you create it:</p>
|
|
2405
|
+
* <ul>
|
|
2406
|
+
* <li>
|
|
2407
|
+
* <p>
|
|
2408
|
+
* <code>AvailabilityStatus</code> for <code>AdHocFilteringOption</code> - This
|
|
2409
|
+
* status can be either <code>ENABLED</code> or <code>DISABLED</code>. When this is
|
|
2410
|
+
* set to <code>DISABLED</code>, Amazon QuickSight disables the left filter pane on the
|
|
2411
|
+
* published dashboard, which can be used for ad hoc (one-time) filtering. This
|
|
2412
|
+
* option is <code>ENABLED</code> by default. </p>
|
|
2413
|
+
* </li>
|
|
2414
|
+
* <li>
|
|
2415
|
+
* <p>
|
|
2416
|
+
* <code>AvailabilityStatus</code> for <code>ExportToCSVOption</code> - This
|
|
2417
|
+
* status can be either <code>ENABLED</code> or <code>DISABLED</code>. The visual
|
|
2418
|
+
* option to export data to .CSV format isn't enabled when this is set to
|
|
2419
|
+
* <code>DISABLED</code>. This option is <code>ENABLED</code> by default. </p>
|
|
2420
|
+
* </li>
|
|
2421
|
+
* <li>
|
|
2422
|
+
* <p>
|
|
2423
|
+
* <code>VisibilityState</code> for <code>SheetControlsOption</code> - This
|
|
2424
|
+
* visibility state can be either <code>COLLAPSED</code> or <code>EXPANDED</code>.
|
|
2425
|
+
* This option is <code>COLLAPSED</code> by default. </p>
|
|
2426
|
+
* </li>
|
|
2427
|
+
* </ul>
|
|
2428
|
+
*/
|
|
2429
|
+
DashboardPublishOptions?: DashboardPublishOptions;
|
|
2430
|
+
/**
|
|
2431
|
+
* <p>The Amazon Resource Name (ARN) of the theme that is being used for this dashboard. If
|
|
2432
|
+
* you add a value for this field, it overrides the value that was originally associated
|
|
2433
|
+
* with the entity. The theme ARN must exist in the same Amazon Web Services account where you create the
|
|
2434
|
+
* dashboard.</p>
|
|
2435
|
+
*/
|
|
2436
|
+
ThemeArn?: string;
|
|
2437
|
+
}
|
|
2438
|
+
export interface UpdateDashboardResponse {
|
|
2439
|
+
/**
|
|
2440
|
+
* <p>The Amazon Resource Name (ARN) of the resource.</p>
|
|
2441
|
+
*/
|
|
2442
|
+
Arn?: string;
|
|
2443
|
+
/**
|
|
2444
|
+
* <p>The ARN of the dashboard, including the version number.</p>
|
|
2445
|
+
*/
|
|
2446
|
+
VersionArn?: string;
|
|
2447
|
+
/**
|
|
2448
|
+
* <p>The ID for the dashboard.</p>
|
|
2449
|
+
*/
|
|
2450
|
+
DashboardId?: string;
|
|
2451
|
+
/**
|
|
2452
|
+
* <p>The creation status of the request.</p>
|
|
2453
|
+
*/
|
|
2454
|
+
CreationStatus?: ResourceStatus | string;
|
|
2455
|
+
/**
|
|
2456
|
+
* <p>The HTTP status of the request.</p>
|
|
2457
|
+
*/
|
|
2458
|
+
Status?: number;
|
|
2459
|
+
/**
|
|
2460
|
+
* <p>The Amazon Web Services request ID for this operation.</p>
|
|
2461
|
+
*/
|
|
2462
|
+
RequestId?: string;
|
|
2463
|
+
}
|
|
2464
|
+
export interface UpdateDashboardPermissionsRequest {
|
|
2465
|
+
/**
|
|
2466
|
+
* <p>The ID of the Amazon Web Services account that contains the dashboard whose permissions you're
|
|
2467
|
+
* updating.</p>
|
|
2468
|
+
*/
|
|
2469
|
+
AwsAccountId: string | undefined;
|
|
2470
|
+
/**
|
|
2471
|
+
* <p>The ID for the dashboard.</p>
|
|
2472
|
+
*/
|
|
2473
|
+
DashboardId: string | undefined;
|
|
2474
|
+
/**
|
|
2475
|
+
* <p>The permissions that you want to grant on this resource.</p>
|
|
2476
|
+
*/
|
|
2477
|
+
GrantPermissions?: ResourcePermission[];
|
|
2478
|
+
/**
|
|
2479
|
+
* <p>The permissions that you want to revoke from this resource.</p>
|
|
2480
|
+
*/
|
|
2481
|
+
RevokePermissions?: ResourcePermission[];
|
|
2482
|
+
/**
|
|
2483
|
+
* <p>Grants link permissions to all users in a defined namespace.</p>
|
|
2484
|
+
*/
|
|
2485
|
+
GrantLinkPermissions?: ResourcePermission[];
|
|
2486
|
+
/**
|
|
2487
|
+
* <p>Revokes link permissions from all users in a defined namespace.</p>
|
|
2488
|
+
*/
|
|
2489
|
+
RevokeLinkPermissions?: ResourcePermission[];
|
|
2490
|
+
}
|
|
2491
|
+
export interface UpdateDashboardPermissionsResponse {
|
|
2492
|
+
/**
|
|
2493
|
+
* <p>The Amazon Resource Name (ARN) of the dashboard.</p>
|
|
2494
|
+
*/
|
|
2495
|
+
DashboardArn?: string;
|
|
2496
|
+
/**
|
|
2497
|
+
* <p>The ID for the dashboard.</p>
|
|
2498
|
+
*/
|
|
2499
|
+
DashboardId?: string;
|
|
2500
|
+
/**
|
|
2501
|
+
* <p>Information about the permissions on the dashboard.</p>
|
|
2502
|
+
*/
|
|
2503
|
+
Permissions?: ResourcePermission[];
|
|
2504
|
+
/**
|
|
2505
|
+
* <p>The Amazon Web Services request ID for this operation.</p>
|
|
2506
|
+
*/
|
|
2507
|
+
RequestId?: string;
|
|
2508
|
+
/**
|
|
2509
|
+
* <p>The HTTP status of the request.</p>
|
|
2510
|
+
*/
|
|
2511
|
+
Status?: number;
|
|
2512
|
+
/**
|
|
2513
|
+
* <p>Updates the permissions of a shared link to an Amazon QuickSight dashboard.</p>
|
|
2514
|
+
*/
|
|
2515
|
+
LinkSharingConfiguration?: LinkSharingConfiguration;
|
|
2516
|
+
}
|
|
2517
|
+
export interface UpdateDashboardPublishedVersionRequest {
|
|
2518
|
+
/**
|
|
2519
|
+
* <p>The ID of the Amazon Web Services account that contains the dashboard that you're
|
|
2520
|
+
* updating.</p>
|
|
2521
|
+
*/
|
|
2522
|
+
AwsAccountId: string | undefined;
|
|
2523
|
+
/**
|
|
2524
|
+
* <p>The ID for the dashboard.</p>
|
|
2525
|
+
*/
|
|
2526
|
+
DashboardId: string | undefined;
|
|
2527
|
+
/**
|
|
2528
|
+
* <p>The version number of the dashboard.</p>
|
|
2529
|
+
*/
|
|
2530
|
+
VersionNumber: number | undefined;
|
|
2531
|
+
}
|
|
2532
|
+
export interface UpdateDashboardPublishedVersionResponse {
|
|
2533
|
+
/**
|
|
2534
|
+
* <p>The ID for the dashboard.</p>
|
|
2535
|
+
*/
|
|
2536
|
+
DashboardId?: string;
|
|
2537
|
+
/**
|
|
2538
|
+
* <p>The Amazon Resource Name (ARN) of the dashboard.</p>
|
|
2539
|
+
*/
|
|
2540
|
+
DashboardArn?: string;
|
|
2541
|
+
/**
|
|
2542
|
+
* <p>The HTTP status of the request.</p>
|
|
2543
|
+
*/
|
|
2544
|
+
Status?: number;
|
|
2545
|
+
/**
|
|
2546
|
+
* <p>The Amazon Web Services request ID for this operation.</p>
|
|
2547
|
+
*/
|
|
2548
|
+
RequestId?: string;
|
|
2549
|
+
}
|
|
2550
|
+
export interface UpdateDataSetRequest {
|
|
2551
|
+
/**
|
|
2552
|
+
* <p>The Amazon Web Services account ID.</p>
|
|
2553
|
+
*/
|
|
2554
|
+
AwsAccountId: string | undefined;
|
|
2555
|
+
/**
|
|
2556
|
+
* <p>The ID for the dataset that you want to update. This ID is unique per Amazon Web Services Region for each
|
|
2557
|
+
* Amazon Web Services account.</p>
|
|
2558
|
+
*/
|
|
2559
|
+
DataSetId: string | undefined;
|
|
2560
|
+
/**
|
|
2561
|
+
* <p>The display name for the dataset.</p>
|
|
2562
|
+
*/
|
|
2563
|
+
Name: string | undefined;
|
|
2564
|
+
/**
|
|
2565
|
+
* <p>Declares the physical tables that are available in the underlying data sources.</p>
|
|
2566
|
+
*/
|
|
2567
|
+
PhysicalTableMap: Record<string, PhysicalTable> | undefined;
|
|
2568
|
+
/**
|
|
2569
|
+
* <p>Configures the combination and transformation of the data from the physical tables.</p>
|
|
2570
|
+
*/
|
|
2571
|
+
LogicalTableMap?: Record<string, LogicalTable>;
|
|
2572
|
+
/**
|
|
2573
|
+
* <p>Indicates whether you want to import the data into SPICE.</p>
|
|
2574
|
+
*/
|
|
2575
|
+
ImportMode: DataSetImportMode | string | undefined;
|
|
2576
|
+
/**
|
|
2577
|
+
* <p>Groupings of columns that work together in certain Amazon QuickSight features. Currently, only geospatial hierarchy is supported.</p>
|
|
2578
|
+
*/
|
|
2579
|
+
ColumnGroups?: ColumnGroup[];
|
|
2580
|
+
/**
|
|
2581
|
+
* <p>The folder that contains fields and nested subfolders for your dataset.</p>
|
|
2582
|
+
*/
|
|
2583
|
+
FieldFolders?: Record<string, FieldFolder>;
|
|
2584
|
+
/**
|
|
2585
|
+
* <p>The row-level security configuration for the data you want to create.</p>
|
|
2586
|
+
*/
|
|
2587
|
+
RowLevelPermissionDataSet?: RowLevelPermissionDataSet;
|
|
2588
|
+
/**
|
|
2589
|
+
* <p>The configuration of tags on a dataset to set row-level security. Row-level security tags are currently supported for anonymous embedding only.</p>
|
|
2590
|
+
*/
|
|
2591
|
+
RowLevelPermissionTagConfiguration?: RowLevelPermissionTagConfiguration;
|
|
2592
|
+
/**
|
|
2593
|
+
* <p>A set of one or more definitions of a <code>
|
|
2594
|
+
* <a href="https://docs.aws.amazon.com/quicksight/latest/APIReference/API_ColumnLevelPermissionRule.html">ColumnLevelPermissionRule</a>
|
|
2595
|
+
* </code>.</p>
|
|
2596
|
+
*/
|
|
2597
|
+
ColumnLevelPermissionRules?: ColumnLevelPermissionRule[];
|
|
2598
|
+
/**
|
|
2599
|
+
* <p>The usage configuration to apply to child datasets that reference this dataset as a source.</p>
|
|
2600
|
+
*/
|
|
2601
|
+
DataSetUsageConfiguration?: DataSetUsageConfiguration;
|
|
2602
|
+
}
|
|
2603
|
+
export interface UpdateDataSetResponse {
|
|
2604
|
+
/**
|
|
2605
|
+
* <p>The Amazon Resource Name (ARN) of the dataset.</p>
|
|
2606
|
+
*/
|
|
2607
|
+
Arn?: string;
|
|
2608
|
+
/**
|
|
2609
|
+
* <p>The ID for the dataset that you want to create. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.</p>
|
|
2610
|
+
*/
|
|
2611
|
+
DataSetId?: string;
|
|
2612
|
+
/**
|
|
2613
|
+
* <p>The ARN for the ingestion, which is triggered as a result of dataset creation if the import
|
|
2614
|
+
* mode is SPICE.</p>
|
|
2615
|
+
*/
|
|
2616
|
+
IngestionArn?: string;
|
|
2617
|
+
/**
|
|
2618
|
+
* <p>The ID of the ingestion, which is triggered as a result of dataset creation if the import
|
|
2619
|
+
* mode is SPICE.</p>
|
|
2620
|
+
*/
|
|
2621
|
+
IngestionId?: string;
|
|
2622
|
+
/**
|
|
2623
|
+
* <p>The Amazon Web Services request ID for this operation.</p>
|
|
2624
|
+
*/
|
|
2625
|
+
RequestId?: string;
|
|
2626
|
+
/**
|
|
2627
|
+
* <p>The HTTP status of the request.</p>
|
|
2628
|
+
*/
|
|
2629
|
+
Status?: number;
|
|
2630
|
+
}
|
|
2631
|
+
export interface UpdateDataSetPermissionsRequest {
|
|
2632
|
+
/**
|
|
2633
|
+
* <p>The Amazon Web Services account ID.</p>
|
|
2634
|
+
*/
|
|
2635
|
+
AwsAccountId: string | undefined;
|
|
2636
|
+
/**
|
|
2637
|
+
* <p>The ID for the dataset whose permissions you want to update. This ID is unique per
|
|
2638
|
+
* Amazon Web Services Region for each Amazon Web Services account.</p>
|
|
2639
|
+
*/
|
|
2640
|
+
DataSetId: string | undefined;
|
|
2641
|
+
/**
|
|
2642
|
+
* <p>The resource permissions that you want to grant to the dataset.</p>
|
|
2643
|
+
*/
|
|
2644
|
+
GrantPermissions?: ResourcePermission[];
|
|
2645
|
+
/**
|
|
2646
|
+
* <p>The resource permissions that you want to revoke from the dataset.</p>
|
|
2647
|
+
*/
|
|
2648
|
+
RevokePermissions?: ResourcePermission[];
|
|
2649
|
+
}
|
|
2650
|
+
export interface UpdateDataSetPermissionsResponse {
|
|
2651
|
+
/**
|
|
2652
|
+
* <p>The Amazon Resource Name (ARN) of the dataset.</p>
|
|
2653
|
+
*/
|
|
2654
|
+
DataSetArn?: string;
|
|
2655
|
+
/**
|
|
2656
|
+
* <p>The ID for the dataset whose permissions you want to update. This ID is unique per
|
|
2657
|
+
* Amazon Web Services Region for each Amazon Web Services account.</p>
|
|
2658
|
+
*/
|
|
2659
|
+
DataSetId?: string;
|
|
2660
|
+
/**
|
|
2661
|
+
* <p>The Amazon Web Services request ID for this operation.</p>
|
|
2662
|
+
*/
|
|
2663
|
+
RequestId?: string;
|
|
2664
|
+
/**
|
|
2665
|
+
* <p>The HTTP status of the request.</p>
|
|
2666
|
+
*/
|
|
2667
|
+
Status?: number;
|
|
2668
|
+
}
|
|
2669
|
+
export interface UpdateDataSourceRequest {
|
|
2670
|
+
/**
|
|
2671
|
+
* <p>The Amazon Web Services account ID.</p>
|
|
2672
|
+
*/
|
|
2673
|
+
AwsAccountId: string | undefined;
|
|
2674
|
+
/**
|
|
2675
|
+
* <p>The ID of the data source. This ID is unique per Amazon Web Services Region for each Amazon Web Services account. </p>
|
|
2676
|
+
*/
|
|
2677
|
+
DataSourceId: string | undefined;
|
|
2678
|
+
/**
|
|
2679
|
+
* <p>A display name for the data source.</p>
|
|
2680
|
+
*/
|
|
2681
|
+
Name: string | undefined;
|
|
2682
|
+
/**
|
|
2683
|
+
* <p>The parameters that Amazon QuickSight uses to connect to your underlying source.</p>
|
|
2684
|
+
*/
|
|
2685
|
+
DataSourceParameters?: DataSourceParameters;
|
|
2686
|
+
/**
|
|
2687
|
+
* <p>The credentials that Amazon QuickSight that uses to connect to your underlying source. Currently,
|
|
2688
|
+
* only credentials based on user name and password are supported.</p>
|
|
2689
|
+
*/
|
|
2690
|
+
Credentials?: DataSourceCredentials;
|
|
2691
|
+
/**
|
|
2692
|
+
* <p>Use this parameter only when you want Amazon QuickSight to use a VPC connection when connecting to
|
|
2693
|
+
* your underlying source.</p>
|
|
2694
|
+
*/
|
|
2695
|
+
VpcConnectionProperties?: VpcConnectionProperties;
|
|
2696
|
+
/**
|
|
2697
|
+
* <p>Secure Socket Layer (SSL) properties that apply when Amazon QuickSight connects to your underlying
|
|
2698
|
+
* source.</p>
|
|
2699
|
+
*/
|
|
2700
|
+
SslProperties?: SslProperties;
|
|
2701
|
+
}
|
|
2702
|
+
export interface UpdateDataSourceResponse {
|
|
2703
|
+
/**
|
|
2704
|
+
* <p>The Amazon Resource Name (ARN) of the data source.</p>
|
|
2705
|
+
*/
|
|
2706
|
+
Arn?: string;
|
|
2707
|
+
/**
|
|
2708
|
+
* <p>The ID of the data source. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.</p>
|
|
2709
|
+
*/
|
|
2710
|
+
DataSourceId?: string;
|
|
2711
|
+
/**
|
|
2712
|
+
* <p>The update status of the data source's last update.</p>
|
|
2713
|
+
*/
|
|
2714
|
+
UpdateStatus?: ResourceStatus | string;
|
|
2715
|
+
/**
|
|
2716
|
+
* <p>The Amazon Web Services request ID for this operation.</p>
|
|
2717
|
+
*/
|
|
2718
|
+
RequestId?: string;
|
|
2719
|
+
/**
|
|
2720
|
+
* <p>The HTTP status of the request.</p>
|
|
2721
|
+
*/
|
|
2722
|
+
Status?: number;
|
|
2723
|
+
}
|
|
2724
|
+
export interface UpdateDataSourcePermissionsRequest {
|
|
2725
|
+
/**
|
|
2726
|
+
* <p>The Amazon Web Services account ID.</p>
|
|
2727
|
+
*/
|
|
2728
|
+
AwsAccountId: string | undefined;
|
|
2729
|
+
/**
|
|
2730
|
+
* <p>The ID of the data source. This ID is unique per Amazon Web Services Region for each Amazon Web Services account. </p>
|
|
2731
|
+
*/
|
|
2732
|
+
DataSourceId: string | undefined;
|
|
2733
|
+
/**
|
|
2734
|
+
* <p>A list of resource permissions that you want to grant on the data source.</p>
|
|
2735
|
+
*/
|
|
2736
|
+
GrantPermissions?: ResourcePermission[];
|
|
2737
|
+
/**
|
|
2738
|
+
* <p>A list of resource permissions that you want to revoke on the data source.</p>
|
|
2739
|
+
*/
|
|
2740
|
+
RevokePermissions?: ResourcePermission[];
|
|
2741
|
+
}
|
|
2742
|
+
export interface UpdateDataSourcePermissionsResponse {
|
|
2743
|
+
/**
|
|
2744
|
+
* <p>The Amazon Resource Name (ARN) of the data source.</p>
|
|
2745
|
+
*/
|
|
2746
|
+
DataSourceArn?: string;
|
|
2747
|
+
/**
|
|
2748
|
+
* <p>The ID of the data source. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.</p>
|
|
2749
|
+
*/
|
|
2750
|
+
DataSourceId?: string;
|
|
2751
|
+
/**
|
|
2752
|
+
* <p>The Amazon Web Services request ID for this operation.</p>
|
|
2753
|
+
*/
|
|
2754
|
+
RequestId?: string;
|
|
2755
|
+
/**
|
|
2756
|
+
* <p>The HTTP status of the request.</p>
|
|
2757
|
+
*/
|
|
2758
|
+
Status?: number;
|
|
2759
|
+
}
|
|
2760
|
+
export interface UpdateFolderRequest {
|
|
2761
|
+
/**
|
|
2762
|
+
* <p>The ID for the Amazon Web Services account that contains the folder to update.</p>
|
|
2763
|
+
*/
|
|
2764
|
+
AwsAccountId: string | undefined;
|
|
2765
|
+
/**
|
|
2766
|
+
* <p>The ID of the folder.</p>
|
|
2767
|
+
*/
|
|
2768
|
+
FolderId: string | undefined;
|
|
2769
|
+
/**
|
|
2770
|
+
* <p>The name of the folder.</p>
|
|
2771
|
+
*/
|
|
2772
|
+
Name: string | undefined;
|
|
2773
|
+
}
|
|
2774
|
+
export interface UpdateFolderResponse {
|
|
2775
|
+
/**
|
|
2776
|
+
* <p>The HTTP status of the request.</p>
|
|
2777
|
+
*/
|
|
2778
|
+
Status?: number;
|
|
2779
|
+
/**
|
|
2780
|
+
* <p>The Amazon Resource Name (ARN) of the folder.</p>
|
|
2781
|
+
*/
|
|
2782
|
+
Arn?: string;
|
|
2783
|
+
/**
|
|
2784
|
+
* <p>The ID of the folder.</p>
|
|
2785
|
+
*/
|
|
2786
|
+
FolderId?: string;
|
|
2787
|
+
/**
|
|
2788
|
+
* <p>The Amazon Web Services request ID for this operation.</p>
|
|
2789
|
+
*/
|
|
2790
|
+
RequestId?: string;
|
|
2791
|
+
}
|
|
2792
|
+
export interface UpdateFolderPermissionsRequest {
|
|
2793
|
+
/**
|
|
2794
|
+
* <p>The ID for the Amazon Web Services account that contains the folder to update.</p>
|
|
2795
|
+
*/
|
|
2796
|
+
AwsAccountId: string | undefined;
|
|
2797
|
+
/**
|
|
2798
|
+
* <p>The ID of the folder.</p>
|
|
2799
|
+
*/
|
|
2800
|
+
FolderId: string | undefined;
|
|
2801
|
+
/**
|
|
2802
|
+
* <p>The permissions that you want to grant on a resource.</p>
|
|
2803
|
+
*/
|
|
2804
|
+
GrantPermissions?: ResourcePermission[];
|
|
2805
|
+
/**
|
|
2806
|
+
* <p>The permissions that you want to revoke from a resource.</p>
|
|
2807
|
+
*/
|
|
2808
|
+
RevokePermissions?: ResourcePermission[];
|
|
2809
|
+
}
|
|
2810
|
+
export interface UpdateFolderPermissionsResponse {
|
|
2811
|
+
/**
|
|
2812
|
+
* <p>The HTTP status of the request.</p>
|
|
2813
|
+
*/
|
|
2814
|
+
Status?: number;
|
|
2815
|
+
/**
|
|
2816
|
+
* <p>The Amazon Resource Name (ARN) of the folder.</p>
|
|
2817
|
+
*/
|
|
2818
|
+
Arn?: string;
|
|
2819
|
+
/**
|
|
2820
|
+
* <p>The ID of the folder.</p>
|
|
2821
|
+
*/
|
|
2822
|
+
FolderId?: string;
|
|
2823
|
+
/**
|
|
2824
|
+
* <p>Information about the permissions for the folder.</p>
|
|
2825
|
+
*/
|
|
2826
|
+
Permissions?: ResourcePermission[];
|
|
2827
|
+
/**
|
|
2828
|
+
* <p>The Amazon Web Services request ID for this operation.</p>
|
|
2829
|
+
*/
|
|
2830
|
+
RequestId?: string;
|
|
2831
|
+
}
|
|
2832
|
+
export interface UpdateGroupRequest {
|
|
2833
|
+
/**
|
|
2834
|
+
* <p>The name of the group that you want to update.</p>
|
|
2835
|
+
*/
|
|
2836
|
+
GroupName: string | undefined;
|
|
2837
|
+
/**
|
|
2838
|
+
* <p>The description for the group that you want to update.</p>
|
|
2839
|
+
*/
|
|
2840
|
+
Description?: string;
|
|
2841
|
+
/**
|
|
2842
|
+
* <p>The ID for the Amazon Web Services account that the group is in. Currently, you use the ID for the
|
|
2843
|
+
* Amazon Web Services account that contains your Amazon QuickSight account.</p>
|
|
2844
|
+
*/
|
|
2845
|
+
AwsAccountId: string | undefined;
|
|
2846
|
+
/**
|
|
2847
|
+
* <p>The namespace of the group that you want to update.</p>
|
|
2848
|
+
*/
|
|
2849
|
+
Namespace: string | undefined;
|
|
2850
|
+
}
|
|
2851
|
+
export interface UpdateGroupResponse {
|
|
2852
|
+
/**
|
|
2853
|
+
* <p>The name of the group.</p>
|
|
2854
|
+
*/
|
|
2855
|
+
Group?: Group;
|
|
2856
|
+
/**
|
|
2857
|
+
* <p>The Amazon Web Services request ID for this operation.</p>
|
|
2858
|
+
*/
|
|
2859
|
+
RequestId?: string;
|
|
2860
|
+
/**
|
|
2861
|
+
* <p>The HTTP status of the request.</p>
|
|
2862
|
+
*/
|
|
2863
|
+
Status?: number;
|
|
2864
|
+
}
|
|
2865
|
+
export interface UpdateIAMPolicyAssignmentRequest {
|
|
2866
|
+
/**
|
|
2867
|
+
* <p>The ID of the Amazon Web Services account that contains the IAM policy assignment. </p>
|
|
2868
|
+
*/
|
|
2869
|
+
AwsAccountId: string | undefined;
|
|
2870
|
+
/**
|
|
2871
|
+
* <p>The name of the assignment, also called a rule. This name must be unique within an Amazon Web Services account.</p>
|
|
2872
|
+
*/
|
|
2873
|
+
AssignmentName: string | undefined;
|
|
2874
|
+
/**
|
|
2875
|
+
* <p>The namespace of the assignment.</p>
|
|
2876
|
+
*/
|
|
2877
|
+
Namespace: string | undefined;
|
|
2878
|
+
/**
|
|
2879
|
+
* <p>The status of the assignment. Possible values are as follows:</p>
|
|
2880
|
+
* <ul>
|
|
2881
|
+
* <li>
|
|
2882
|
+
* <p>
|
|
2883
|
+
* <code>ENABLED</code> - Anything specified in this assignment is used when creating the data
|
|
2884
|
+
* source.</p>
|
|
2885
|
+
* </li>
|
|
2886
|
+
* <li>
|
|
2887
|
+
* <p>
|
|
2888
|
+
* <code>DISABLED</code> - This assignment isn't used when creating the data source.</p>
|
|
2889
|
+
* </li>
|
|
2890
|
+
* <li>
|
|
2891
|
+
* <p>
|
|
2892
|
+
* <code>DRAFT</code> - This assignment is an unfinished draft and isn't used when creating the
|
|
2893
|
+
* data source.</p>
|
|
2894
|
+
* </li>
|
|
2895
|
+
* </ul>
|
|
2896
|
+
*/
|
|
2897
|
+
AssignmentStatus?: AssignmentStatus | string;
|
|
2898
|
+
/**
|
|
2899
|
+
* <p>The ARN for the IAM policy to apply to the Amazon QuickSight users and groups
|
|
2900
|
+
* specified in this assignment.</p>
|
|
2901
|
+
*/
|
|
2902
|
+
PolicyArn?: string;
|
|
2903
|
+
/**
|
|
2904
|
+
* <p>The Amazon QuickSight users, groups, or both that you want to assign the policy to.</p>
|
|
2905
|
+
*/
|
|
2906
|
+
Identities?: Record<string, string[]>;
|
|
2907
|
+
}
|
|
2908
|
+
export interface UpdateIAMPolicyAssignmentResponse {
|
|
2909
|
+
/**
|
|
2910
|
+
* <p>The name of the assignment or rule.</p>
|
|
2911
|
+
*/
|
|
2912
|
+
AssignmentName?: string;
|
|
2913
|
+
/**
|
|
2914
|
+
* <p>The ID of the assignment.</p>
|
|
2915
|
+
*/
|
|
2916
|
+
AssignmentId?: string;
|
|
2917
|
+
/**
|
|
2918
|
+
* <p>The ARN for the IAM policy applied to the Amazon QuickSight users and groups specified in this
|
|
2919
|
+
* assignment.</p>
|
|
2920
|
+
*/
|
|
2921
|
+
PolicyArn?: string;
|
|
2922
|
+
/**
|
|
2923
|
+
* <p>The Amazon QuickSight users, groups, or both that the IAM policy is assigned to.</p>
|
|
2924
|
+
*/
|
|
2925
|
+
Identities?: Record<string, string[]>;
|
|
2926
|
+
/**
|
|
2927
|
+
* <p>The status of the assignment. Possible values are as follows:</p>
|
|
2928
|
+
* <ul>
|
|
2929
|
+
* <li>
|
|
2930
|
+
* <p>
|
|
2931
|
+
* <code>ENABLED</code> - Anything specified in this assignment is used when creating the data
|
|
2932
|
+
* source.</p>
|
|
2933
|
+
* </li>
|
|
2934
|
+
* <li>
|
|
2935
|
+
* <p>
|
|
2936
|
+
* <code>DISABLED</code> - This assignment isn't used when creating the data source.</p>
|
|
2937
|
+
* </li>
|
|
2938
|
+
* <li>
|
|
2939
|
+
* <p>
|
|
2940
|
+
* <code>DRAFT</code> - This assignment is an unfinished draft and isn't used when creating the
|
|
2941
|
+
* data source.</p>
|
|
2942
|
+
* </li>
|
|
2943
|
+
* </ul>
|
|
2944
|
+
*/
|
|
2945
|
+
AssignmentStatus?: AssignmentStatus | string;
|
|
2946
|
+
/**
|
|
2947
|
+
* <p>The Amazon Web Services request ID for this operation.</p>
|
|
2948
|
+
*/
|
|
2949
|
+
RequestId?: string;
|
|
2950
|
+
/**
|
|
2951
|
+
* <p>The HTTP status of the request.</p>
|
|
2952
|
+
*/
|
|
2953
|
+
Status?: number;
|
|
2954
|
+
}
|
|
2955
|
+
export interface UpdateIpRestrictionRequest {
|
|
2956
|
+
/**
|
|
2957
|
+
* <p>The ID of the Amazon Web Services account that contains the IP rules.</p>
|
|
2958
|
+
*/
|
|
2959
|
+
AwsAccountId: string | undefined;
|
|
2960
|
+
/**
|
|
2961
|
+
* <p>A map that describes the updated IP rules with CIDR ranges and descriptions.</p>
|
|
2962
|
+
*/
|
|
2963
|
+
IpRestrictionRuleMap?: Record<string, string>;
|
|
2964
|
+
/**
|
|
2965
|
+
* <p>A value that specifies whether IP rules are turned on.</p>
|
|
2966
|
+
*/
|
|
2967
|
+
Enabled?: boolean;
|
|
2968
|
+
}
|
|
2969
|
+
export interface UpdateIpRestrictionResponse {
|
|
2970
|
+
/**
|
|
2971
|
+
* <p>The ID of the Amazon Web Services account that contains the IP rules.</p>
|
|
2972
|
+
*/
|
|
2973
|
+
AwsAccountId?: string;
|
|
2974
|
+
/**
|
|
2975
|
+
* <p>The Amazon Web Services request ID for this operation.</p>
|
|
2976
|
+
*/
|
|
2977
|
+
RequestId?: string;
|
|
2978
|
+
/**
|
|
2979
|
+
* <p>The HTTP status of the request. </p>
|
|
2980
|
+
*/
|
|
2981
|
+
Status?: number;
|
|
2982
|
+
}
|
|
2983
|
+
export interface UpdatePublicSharingSettingsRequest {
|
|
2984
|
+
/**
|
|
2985
|
+
* <p>The Amazon Web Services account ID associated with your Amazon QuickSight subscription.</p>
|
|
2986
|
+
*/
|
|
2987
|
+
AwsAccountId: string | undefined;
|
|
2988
|
+
/**
|
|
2989
|
+
* <p>A Boolean value that indicates whether public sharing is turned on for an Amazon QuickSight account.</p>
|
|
2990
|
+
*/
|
|
2991
|
+
PublicSharingEnabled?: boolean;
|
|
2992
|
+
}
|
|
2993
|
+
export interface UpdatePublicSharingSettingsResponse {
|
|
2994
|
+
/**
|
|
2995
|
+
* <p>The Amazon Web Services request ID for this operation.</p>
|
|
2996
|
+
*/
|
|
2997
|
+
RequestId?: string;
|
|
2998
|
+
/**
|
|
2999
|
+
* <p>The HTTP status of the request.</p>
|
|
3000
|
+
*/
|
|
3001
|
+
Status?: number;
|
|
3002
|
+
}
|
|
3003
|
+
export interface UpdateTemplateRequest {
|
|
3004
|
+
/**
|
|
3005
|
+
* <p>The ID of the Amazon Web Services account that contains the template that you're updating.</p>
|
|
3006
|
+
*/
|
|
3007
|
+
AwsAccountId: string | undefined;
|
|
3008
|
+
/**
|
|
3009
|
+
* <p>The ID for the template.</p>
|
|
3010
|
+
*/
|
|
3011
|
+
TemplateId: string | undefined;
|
|
3012
|
+
/**
|
|
3013
|
+
* <p>The entity that you are using as a source when you update the template. In
|
|
3014
|
+
* <code>SourceEntity</code>, you specify the type of object you're using as source:
|
|
3015
|
+
* <code>SourceTemplate</code> for a template or <code>SourceAnalysis</code> for an
|
|
3016
|
+
* analysis. Both of these require an Amazon Resource Name (ARN). For
|
|
3017
|
+
* <code>SourceTemplate</code>, specify the ARN of the source template. For
|
|
3018
|
+
* <code>SourceAnalysis</code>, specify the ARN of the source analysis. The <code>SourceTemplate</code>
|
|
3019
|
+
* ARN can contain any Amazon Web Services account and any Amazon QuickSight-supported Amazon Web Services Region;. </p>
|
|
3020
|
+
* <p>Use the <code>DataSetReferences</code> entity within <code>SourceTemplate</code> or
|
|
3021
|
+
* <code>SourceAnalysis</code> to list the replacement datasets for the placeholders listed
|
|
3022
|
+
* in the original. The schema in each dataset must match its placeholder. </p>
|
|
3023
|
+
*/
|
|
3024
|
+
SourceEntity: TemplateSourceEntity | undefined;
|
|
3025
|
+
/**
|
|
3026
|
+
* <p>A description of the current template version that is being updated. Every time you call
|
|
3027
|
+
* <code>UpdateTemplate</code>, you create a new version of the template. Each version
|
|
3028
|
+
* of the template maintains a description of the version in the
|
|
3029
|
+
* <code>VersionDescription</code> field.</p>
|
|
3030
|
+
*/
|
|
3031
|
+
VersionDescription?: string;
|
|
3032
|
+
/**
|
|
3033
|
+
* <p>The name for the template.</p>
|
|
3034
|
+
*/
|
|
3035
|
+
Name?: string;
|
|
3036
|
+
}
|
|
3037
|
+
export interface UpdateTemplateResponse {
|
|
3038
|
+
/**
|
|
3039
|
+
* <p>The ID for the template.</p>
|
|
3040
|
+
*/
|
|
3041
|
+
TemplateId?: string;
|
|
3042
|
+
/**
|
|
3043
|
+
* <p>The Amazon Resource Name (ARN) for the template.</p>
|
|
3044
|
+
*/
|
|
3045
|
+
Arn?: string;
|
|
3046
|
+
/**
|
|
3047
|
+
* <p>The ARN for the template, including the version information of the first version.</p>
|
|
3048
|
+
*/
|
|
3049
|
+
VersionArn?: string;
|
|
3050
|
+
/**
|
|
3051
|
+
* <p>The creation status of the template.</p>
|
|
3052
|
+
*/
|
|
3053
|
+
CreationStatus?: ResourceStatus | string;
|
|
3054
|
+
/**
|
|
3055
|
+
* <p>The HTTP status of the request.</p>
|
|
3056
|
+
*/
|
|
3057
|
+
Status?: number;
|
|
3058
|
+
/**
|
|
3059
|
+
* <p>The Amazon Web Services request ID for this operation.</p>
|
|
3060
|
+
*/
|
|
3061
|
+
RequestId?: string;
|
|
3062
|
+
}
|
|
3063
|
+
export interface UpdateTemplateAliasRequest {
|
|
3064
|
+
/**
|
|
3065
|
+
* <p>The ID of the Amazon Web Services account that contains the template alias that you're updating.</p>
|
|
3066
|
+
*/
|
|
3067
|
+
AwsAccountId: string | undefined;
|
|
3068
|
+
/**
|
|
3069
|
+
* <p>The ID for the template.</p>
|
|
3070
|
+
*/
|
|
3071
|
+
TemplateId: string | undefined;
|
|
3072
|
+
/**
|
|
3073
|
+
* <p>The alias of the template that you want to update. If you name a specific alias, you update
|
|
3074
|
+
* the version that the alias points to. You can specify the latest version of the template
|
|
3075
|
+
* by providing the keyword <code>$LATEST</code> in the <code>AliasName</code> parameter.
|
|
3076
|
+
* The keyword <code>$PUBLISHED</code> doesn't apply to templates.</p>
|
|
3077
|
+
*/
|
|
3078
|
+
AliasName: string | undefined;
|
|
3079
|
+
/**
|
|
3080
|
+
* <p>The version number of the template.</p>
|
|
3081
|
+
*/
|
|
3082
|
+
TemplateVersionNumber: number | undefined;
|
|
3083
|
+
}
|
|
3084
|
+
export interface UpdateTemplateAliasResponse {
|
|
3085
|
+
/**
|
|
3086
|
+
* <p>The template alias.</p>
|
|
3087
|
+
*/
|
|
3088
|
+
TemplateAlias?: TemplateAlias;
|
|
3089
|
+
/**
|
|
3090
|
+
* <p>The HTTP status of the request.</p>
|
|
3091
|
+
*/
|
|
3092
|
+
Status?: number;
|
|
3093
|
+
/**
|
|
3094
|
+
* <p>The Amazon Web Services request ID for this operation.</p>
|
|
3095
|
+
*/
|
|
3096
|
+
RequestId?: string;
|
|
3097
|
+
}
|
|
3098
|
+
export interface UpdateTemplatePermissionsRequest {
|
|
3099
|
+
/**
|
|
3100
|
+
* <p>The ID of the Amazon Web Services account that contains the template.</p>
|
|
3101
|
+
*/
|
|
3102
|
+
AwsAccountId: string | undefined;
|
|
3103
|
+
/**
|
|
3104
|
+
* <p>The ID for the template.</p>
|
|
3105
|
+
*/
|
|
3106
|
+
TemplateId: string | undefined;
|
|
3107
|
+
/**
|
|
3108
|
+
* <p>A list of resource permissions to be granted on the template. </p>
|
|
3109
|
+
*/
|
|
3110
|
+
GrantPermissions?: ResourcePermission[];
|
|
3111
|
+
/**
|
|
3112
|
+
* <p>A list of resource permissions to be revoked from the template. </p>
|
|
3113
|
+
*/
|
|
3114
|
+
RevokePermissions?: ResourcePermission[];
|
|
3115
|
+
}
|
|
3116
|
+
export interface UpdateTemplatePermissionsResponse {
|
|
3117
|
+
/**
|
|
3118
|
+
* <p>The ID for the template.</p>
|
|
3119
|
+
*/
|
|
3120
|
+
TemplateId?: string;
|
|
3121
|
+
/**
|
|
3122
|
+
* <p>The Amazon Resource Name (ARN) of the template.</p>
|
|
3123
|
+
*/
|
|
3124
|
+
TemplateArn?: string;
|
|
3125
|
+
/**
|
|
3126
|
+
* <p>A list of resource permissions to be set on the template.</p>
|
|
3127
|
+
*/
|
|
3128
|
+
Permissions?: ResourcePermission[];
|
|
3129
|
+
/**
|
|
3130
|
+
* <p>The Amazon Web Services request ID for this operation.</p>
|
|
3131
|
+
*/
|
|
3132
|
+
RequestId?: string;
|
|
3133
|
+
/**
|
|
3134
|
+
* <p>The HTTP status of the request.</p>
|
|
3135
|
+
*/
|
|
3136
|
+
Status?: number;
|
|
3137
|
+
}
|
|
3138
|
+
export interface UpdateThemeRequest {
|
|
3139
|
+
/**
|
|
3140
|
+
* <p>The ID of the Amazon Web Services account that contains the theme that you're updating.</p>
|
|
3141
|
+
*/
|
|
3142
|
+
AwsAccountId: string | undefined;
|
|
3143
|
+
/**
|
|
3144
|
+
* <p>The ID for the theme.</p>
|
|
3145
|
+
*/
|
|
3146
|
+
ThemeId: string | undefined;
|
|
3147
|
+
/**
|
|
3148
|
+
* <p>The name for the theme.</p>
|
|
3149
|
+
*/
|
|
3150
|
+
Name?: string;
|
|
3151
|
+
/**
|
|
3152
|
+
* <p>The theme ID, defined by Amazon QuickSight, that a custom theme inherits from.
|
|
3153
|
+
* All themes initially inherit from a default Amazon QuickSight theme.</p>
|
|
3154
|
+
*/
|
|
3155
|
+
BaseThemeId: string | undefined;
|
|
3156
|
+
/**
|
|
3157
|
+
* <p>A description of the theme version that you're updating Every time that you call
|
|
3158
|
+
* <code>UpdateTheme</code>, you create a new version of the theme. Each version of the
|
|
3159
|
+
* theme maintains a description of the version in <code>VersionDescription</code>.</p>
|
|
3160
|
+
*/
|
|
3161
|
+
VersionDescription?: string;
|
|
3162
|
+
/**
|
|
3163
|
+
* <p>The theme configuration, which contains the theme display properties.</p>
|
|
3164
|
+
*/
|
|
3165
|
+
Configuration?: ThemeConfiguration;
|
|
3166
|
+
}
|
|
3167
|
+
export interface UpdateThemeResponse {
|
|
3168
|
+
/**
|
|
3169
|
+
* <p>The ID for the theme.</p>
|
|
3170
|
+
*/
|
|
3171
|
+
ThemeId?: string;
|
|
3172
|
+
/**
|
|
3173
|
+
* <p>The Amazon Resource Name (ARN) for the theme.</p>
|
|
3174
|
+
*/
|
|
3175
|
+
Arn?: string;
|
|
3176
|
+
/**
|
|
3177
|
+
* <p>The Amazon Resource Name (ARN) for the new version of the theme.</p>
|
|
3178
|
+
*/
|
|
3179
|
+
VersionArn?: string;
|
|
3180
|
+
/**
|
|
3181
|
+
* <p>The creation status of the theme.</p>
|
|
3182
|
+
*/
|
|
3183
|
+
CreationStatus?: ResourceStatus | string;
|
|
3184
|
+
/**
|
|
3185
|
+
* <p>The HTTP status of the request.</p>
|
|
3186
|
+
*/
|
|
3187
|
+
Status?: number;
|
|
3188
|
+
/**
|
|
3189
|
+
* <p>The Amazon Web Services request ID for this operation.</p>
|
|
3190
|
+
*/
|
|
3191
|
+
RequestId?: string;
|
|
3192
|
+
}
|
|
3193
|
+
export interface UpdateThemeAliasRequest {
|
|
3194
|
+
/**
|
|
3195
|
+
* <p>The ID of the Amazon Web Services account that contains the theme alias that you're updating.</p>
|
|
3196
|
+
*/
|
|
3197
|
+
AwsAccountId: string | undefined;
|
|
3198
|
+
/**
|
|
3199
|
+
* <p>The ID for the theme.</p>
|
|
3200
|
+
*/
|
|
3201
|
+
ThemeId: string | undefined;
|
|
3202
|
+
/**
|
|
3203
|
+
* <p>The name of the theme alias that you want to update.</p>
|
|
3204
|
+
*/
|
|
3205
|
+
AliasName: string | undefined;
|
|
3206
|
+
/**
|
|
3207
|
+
* <p>The version number of the theme that the alias should reference.</p>
|
|
3208
|
+
*/
|
|
3209
|
+
ThemeVersionNumber: number | undefined;
|
|
3210
|
+
}
|
|
3211
|
+
export interface UpdateThemeAliasResponse {
|
|
3212
|
+
/**
|
|
3213
|
+
* <p>Information about the theme alias.</p>
|
|
3214
|
+
*/
|
|
3215
|
+
ThemeAlias?: ThemeAlias;
|
|
3216
|
+
/**
|
|
3217
|
+
* <p>The HTTP status of the request.</p>
|
|
3218
|
+
*/
|
|
3219
|
+
Status?: number;
|
|
3220
|
+
/**
|
|
3221
|
+
* <p>The Amazon Web Services request ID for this operation.</p>
|
|
3222
|
+
*/
|
|
3223
|
+
RequestId?: string;
|
|
3224
|
+
}
|
|
3225
|
+
export interface UpdateThemePermissionsRequest {
|
|
3226
|
+
/**
|
|
3227
|
+
* <p>The ID of the Amazon Web Services account that contains the theme.</p>
|
|
3228
|
+
*/
|
|
3229
|
+
AwsAccountId: string | undefined;
|
|
3230
|
+
/**
|
|
3231
|
+
* <p>The ID for the theme.</p>
|
|
3232
|
+
*/
|
|
3233
|
+
ThemeId: string | undefined;
|
|
3234
|
+
/**
|
|
3235
|
+
* <p>A list of resource permissions to be granted for the theme.</p>
|
|
3236
|
+
*/
|
|
3237
|
+
GrantPermissions?: ResourcePermission[];
|
|
3238
|
+
/**
|
|
3239
|
+
* <p>A list of resource permissions to be revoked from the theme.</p>
|
|
3240
|
+
*/
|
|
3241
|
+
RevokePermissions?: ResourcePermission[];
|
|
3242
|
+
}
|
|
3243
|
+
export interface UpdateThemePermissionsResponse {
|
|
3244
|
+
/**
|
|
3245
|
+
* <p>The ID for the theme.</p>
|
|
3246
|
+
*/
|
|
3247
|
+
ThemeId?: string;
|
|
3248
|
+
/**
|
|
3249
|
+
* <p>The Amazon Resource Name (ARN) of the theme.</p>
|
|
3250
|
+
*/
|
|
3251
|
+
ThemeArn?: string;
|
|
3252
|
+
/**
|
|
3253
|
+
* <p>The resulting list of resource permissions for the theme.</p>
|
|
3254
|
+
*/
|
|
3255
|
+
Permissions?: ResourcePermission[];
|
|
3256
|
+
/**
|
|
3257
|
+
* <p>The Amazon Web Services request ID for this operation.</p>
|
|
3258
|
+
*/
|
|
3259
|
+
RequestId?: string;
|
|
3260
|
+
/**
|
|
3261
|
+
* <p>The HTTP status of the request.</p>
|
|
3262
|
+
*/
|
|
3263
|
+
Status?: number;
|
|
3264
|
+
}
|
|
3265
|
+
export interface UpdateUserRequest {
|
|
3266
|
+
/**
|
|
3267
|
+
* <p>The Amazon QuickSight user name that you want to update.</p>
|
|
3268
|
+
*/
|
|
3269
|
+
UserName: string | undefined;
|
|
3270
|
+
/**
|
|
3271
|
+
* <p>The ID for the Amazon Web Services account that the user is in. Currently, you use the ID for the
|
|
3272
|
+
* Amazon Web Services account that contains your Amazon QuickSight account.</p>
|
|
3273
|
+
*/
|
|
3274
|
+
AwsAccountId: string | undefined;
|
|
3275
|
+
/**
|
|
3276
|
+
* <p>The namespace. Currently, you should set this to <code>default</code>.</p>
|
|
3277
|
+
*/
|
|
3278
|
+
Namespace: string | undefined;
|
|
3279
|
+
/**
|
|
3280
|
+
* <p>The email address of the user that you want to update.</p>
|
|
3281
|
+
*/
|
|
3282
|
+
Email: string | undefined;
|
|
3283
|
+
/**
|
|
3284
|
+
* <p>The Amazon QuickSight role of the user. The role can be one of the
|
|
3285
|
+
* following default security cohorts:</p>
|
|
3286
|
+
* <ul>
|
|
3287
|
+
* <li>
|
|
3288
|
+
* <p>
|
|
3289
|
+
* <code>READER</code>: A user who has read-only access to dashboards.</p>
|
|
3290
|
+
* </li>
|
|
3291
|
+
* <li>
|
|
3292
|
+
* <p>
|
|
3293
|
+
* <code>AUTHOR</code>: A user who can create data sources, datasets, analyses, and
|
|
3294
|
+
* dashboards.</p>
|
|
3295
|
+
* </li>
|
|
3296
|
+
* <li>
|
|
3297
|
+
* <p>
|
|
3298
|
+
* <code>ADMIN</code>: A user who is an author, who can also manage Amazon QuickSight
|
|
3299
|
+
* settings.</p>
|
|
3300
|
+
* </li>
|
|
3301
|
+
* </ul>
|
|
3302
|
+
* <p>The name of the Amazon QuickSight role is invisible to the user except for the console
|
|
3303
|
+
* screens dealing with permissions.</p>
|
|
3304
|
+
*/
|
|
3305
|
+
Role: UserRole | string | undefined;
|
|
3306
|
+
/**
|
|
3307
|
+
* <p>(Enterprise edition only) The name of the custom permissions profile that you want to
|
|
3308
|
+
* assign to this user. Customized permissions allows you to control a user's access by
|
|
3309
|
+
* restricting access the following operations:</p>
|
|
3310
|
+
* <ul>
|
|
3311
|
+
* <li>
|
|
3312
|
+
* <p>Create and update data sources</p>
|
|
3313
|
+
* </li>
|
|
3314
|
+
* <li>
|
|
3315
|
+
* <p>Create and update datasets</p>
|
|
3316
|
+
* </li>
|
|
3317
|
+
* <li>
|
|
3318
|
+
* <p>Create and update email reports</p>
|
|
3319
|
+
* </li>
|
|
3320
|
+
* <li>
|
|
3321
|
+
* <p>Subscribe to email reports</p>
|
|
3322
|
+
* </li>
|
|
3323
|
+
* </ul>
|
|
3324
|
+
* <p>A set of custom permissions includes any combination of these restrictions. Currently,
|
|
3325
|
+
* you need to create the profile names for custom permission sets by using the Amazon QuickSight
|
|
3326
|
+
* console. Then, you use the <code>RegisterUser</code> API operation to assign the named set of
|
|
3327
|
+
* permissions to a Amazon QuickSight user. </p>
|
|
3328
|
+
* <p>Amazon QuickSight custom permissions are applied through IAM policies. Therefore, they
|
|
3329
|
+
* override the permissions typically granted by assigning Amazon QuickSight users to one of the
|
|
3330
|
+
* default security cohorts in Amazon QuickSight (admin, author, reader).</p>
|
|
3331
|
+
* <p>This feature is available only to Amazon QuickSight Enterprise edition subscriptions.</p>
|
|
3332
|
+
*/
|
|
3333
|
+
CustomPermissionsName?: string;
|
|
3334
|
+
/**
|
|
3335
|
+
* <p>A flag that you use to indicate that you want to remove all custom permissions
|
|
3336
|
+
* from this user. Using this parameter resets the user to the state
|
|
3337
|
+
* it was in before a custom permissions profile was applied. This parameter defaults to
|
|
3338
|
+
* NULL and it doesn't accept any other value.</p>
|
|
3339
|
+
*/
|
|
3340
|
+
UnapplyCustomPermissions?: boolean;
|
|
3341
|
+
/**
|
|
3342
|
+
* <p>The type of supported external login provider that provides identity to let a user federate into Amazon QuickSight with an associated Identity and Access Management(IAM) role. The type of supported external login provider can be one of the following.</p>
|
|
3343
|
+
* <ul>
|
|
3344
|
+
* <li>
|
|
3345
|
+
* <p>
|
|
3346
|
+
* <code>COGNITO</code>: Amazon Cognito. The provider URL is cognito-identity.amazonaws.com. When choosing the <code>COGNITO</code> provider type, don’t use the "CustomFederationProviderUrl" parameter which is only needed when the external provider is custom.</p>
|
|
3347
|
+
* </li>
|
|
3348
|
+
* <li>
|
|
3349
|
+
* <p>
|
|
3350
|
+
* <code>CUSTOM_OIDC</code>: Custom OpenID Connect (OIDC) provider. When choosing <code>CUSTOM_OIDC</code> type, use the <code>CustomFederationProviderUrl</code> parameter to provide the custom OIDC provider URL.</p>
|
|
3351
|
+
* </li>
|
|
3352
|
+
* <li>
|
|
3353
|
+
* <p>
|
|
3354
|
+
* <code>NONE</code>: This clears all the previously saved external login information for a user. Use the
|
|
3355
|
+
* <code>
|
|
3356
|
+
* <a href="https://docs.aws.amazon.com/quicksight/latest/APIReference/API_DescribeUser.html">DescribeUser</a>
|
|
3357
|
+
* </code>
|
|
3358
|
+
* API operation to check the external login information.</p>
|
|
3359
|
+
* </li>
|
|
3360
|
+
* </ul>
|
|
3361
|
+
*/
|
|
3362
|
+
ExternalLoginFederationProviderType?: string;
|
|
3363
|
+
/**
|
|
3364
|
+
* <p>The URL of the custom OpenID Connect (OIDC) provider that provides identity to let a user federate
|
|
3365
|
+
* into Amazon QuickSight with an associated Identity and Access Management(IAM) role. This parameter should
|
|
3366
|
+
* only be used when <code>ExternalLoginFederationProviderType</code> parameter is set to <code>CUSTOM_OIDC</code>.</p>
|
|
3367
|
+
*/
|
|
3368
|
+
CustomFederationProviderUrl?: string;
|
|
3369
|
+
/**
|
|
3370
|
+
* <p>The identity ID for a user in the external login provider.</p>
|
|
3371
|
+
*/
|
|
3372
|
+
ExternalLoginId?: string;
|
|
3373
|
+
}
|
|
3374
|
+
export interface UpdateUserResponse {
|
|
3375
|
+
/**
|
|
3376
|
+
* <p>The Amazon QuickSight user.</p>
|
|
3377
|
+
*/
|
|
3378
|
+
User?: User;
|
|
3379
|
+
/**
|
|
3380
|
+
* <p>The Amazon Web Services request ID for this operation.</p>
|
|
3381
|
+
*/
|
|
3382
|
+
RequestId?: string;
|
|
3383
|
+
/**
|
|
3384
|
+
* <p>The HTTP status of the request.</p>
|
|
3385
|
+
*/
|
|
3386
|
+
Status?: number;
|
|
3387
|
+
}
|
|
3388
|
+
/**
|
|
3389
|
+
* @internal
|
|
3390
|
+
*/
|
|
3391
|
+
export declare const ThemeErrorFilterSensitiveLog: (obj: ThemeError) => any;
|
|
3392
|
+
/**
|
|
3393
|
+
* @internal
|
|
3394
|
+
*/
|
|
3395
|
+
export declare const ThemeVersionFilterSensitiveLog: (obj: ThemeVersion) => any;
|
|
3396
|
+
/**
|
|
3397
|
+
* @internal
|
|
3398
|
+
*/
|
|
3399
|
+
export declare const ThemeFilterSensitiveLog: (obj: Theme) => any;
|
|
3400
|
+
/**
|
|
3401
|
+
* @internal
|
|
3402
|
+
*/
|
|
3403
|
+
export declare const DescribeThemeResponseFilterSensitiveLog: (obj: DescribeThemeResponse) => any;
|
|
3404
|
+
/**
|
|
3405
|
+
* @internal
|
|
3406
|
+
*/
|
|
3407
|
+
export declare const DescribeThemeAliasRequestFilterSensitiveLog: (obj: DescribeThemeAliasRequest) => any;
|
|
3408
|
+
/**
|
|
3409
|
+
* @internal
|
|
3410
|
+
*/
|
|
3411
|
+
export declare const DescribeThemeAliasResponseFilterSensitiveLog: (obj: DescribeThemeAliasResponse) => any;
|
|
3412
|
+
/**
|
|
3413
|
+
* @internal
|
|
3414
|
+
*/
|
|
3415
|
+
export declare const DescribeThemePermissionsRequestFilterSensitiveLog: (obj: DescribeThemePermissionsRequest) => any;
|
|
3416
|
+
/**
|
|
3417
|
+
* @internal
|
|
3418
|
+
*/
|
|
3419
|
+
export declare const DescribeThemePermissionsResponseFilterSensitiveLog: (obj: DescribeThemePermissionsResponse) => any;
|
|
3420
|
+
/**
|
|
3421
|
+
* @internal
|
|
3422
|
+
*/
|
|
3423
|
+
export declare const DescribeUserRequestFilterSensitiveLog: (obj: DescribeUserRequest) => any;
|
|
3424
|
+
/**
|
|
3425
|
+
* @internal
|
|
3426
|
+
*/
|
|
3427
|
+
export declare const UserFilterSensitiveLog: (obj: User) => any;
|
|
3428
|
+
/**
|
|
3429
|
+
* @internal
|
|
3430
|
+
*/
|
|
3431
|
+
export declare const DescribeUserResponseFilterSensitiveLog: (obj: DescribeUserResponse) => any;
|
|
3432
|
+
/**
|
|
3433
|
+
* @internal
|
|
3434
|
+
*/
|
|
3435
|
+
export declare const MemberIdArnPairFilterSensitiveLog: (obj: MemberIdArnPair) => any;
|
|
3436
|
+
/**
|
|
3437
|
+
* @internal
|
|
3438
|
+
*/
|
|
3439
|
+
export declare const FolderSearchFilterFilterSensitiveLog: (obj: FolderSearchFilter) => any;
|
|
3440
|
+
/**
|
|
3441
|
+
* @internal
|
|
3442
|
+
*/
|
|
3443
|
+
export declare const FolderSummaryFilterSensitiveLog: (obj: FolderSummary) => any;
|
|
3444
|
+
/**
|
|
3445
|
+
* @internal
|
|
3446
|
+
*/
|
|
3447
|
+
export declare const SessionTagFilterSensitiveLog: (obj: SessionTag) => any;
|
|
3448
|
+
/**
|
|
3449
|
+
* @internal
|
|
3450
|
+
*/
|
|
3451
|
+
export declare const GenerateEmbedUrlForAnonymousUserRequestFilterSensitiveLog: (obj: GenerateEmbedUrlForAnonymousUserRequest) => any;
|
|
3452
|
+
/**
|
|
3453
|
+
* @internal
|
|
3454
|
+
*/
|
|
3455
|
+
export declare const GenerateEmbedUrlForAnonymousUserResponseFilterSensitiveLog: (obj: GenerateEmbedUrlForAnonymousUserResponse) => any;
|
|
3456
|
+
/**
|
|
3457
|
+
* @internal
|
|
3458
|
+
*/
|
|
3459
|
+
export declare const RegisteredUserDashboardEmbeddingConfigurationFilterSensitiveLog: (obj: RegisteredUserDashboardEmbeddingConfiguration) => any;
|
|
3460
|
+
/**
|
|
3461
|
+
* @internal
|
|
3462
|
+
*/
|
|
3463
|
+
export declare const RegisteredUserDashboardVisualEmbeddingConfigurationFilterSensitiveLog: (obj: RegisteredUserDashboardVisualEmbeddingConfiguration) => any;
|
|
3464
|
+
/**
|
|
3465
|
+
* @internal
|
|
3466
|
+
*/
|
|
3467
|
+
export declare const RegisteredUserQSearchBarEmbeddingConfigurationFilterSensitiveLog: (obj: RegisteredUserQSearchBarEmbeddingConfiguration) => any;
|
|
3468
|
+
/**
|
|
3469
|
+
* @internal
|
|
3470
|
+
*/
|
|
3471
|
+
export declare const RegisteredUserQuickSightConsoleEmbeddingConfigurationFilterSensitiveLog: (obj: RegisteredUserQuickSightConsoleEmbeddingConfiguration) => any;
|
|
3472
|
+
/**
|
|
3473
|
+
* @internal
|
|
3474
|
+
*/
|
|
3475
|
+
export declare const RegisteredUserEmbeddingExperienceConfigurationFilterSensitiveLog: (obj: RegisteredUserEmbeddingExperienceConfiguration) => any;
|
|
3476
|
+
/**
|
|
3477
|
+
* @internal
|
|
3478
|
+
*/
|
|
3479
|
+
export declare const GenerateEmbedUrlForRegisteredUserRequestFilterSensitiveLog: (obj: GenerateEmbedUrlForRegisteredUserRequest) => any;
|
|
3480
|
+
/**
|
|
3481
|
+
* @internal
|
|
3482
|
+
*/
|
|
3483
|
+
export declare const GenerateEmbedUrlForRegisteredUserResponseFilterSensitiveLog: (obj: GenerateEmbedUrlForRegisteredUserResponse) => any;
|
|
3484
|
+
/**
|
|
3485
|
+
* @internal
|
|
3486
|
+
*/
|
|
3487
|
+
export declare const GetDashboardEmbedUrlRequestFilterSensitiveLog: (obj: GetDashboardEmbedUrlRequest) => any;
|
|
3488
|
+
/**
|
|
3489
|
+
* @internal
|
|
3490
|
+
*/
|
|
3491
|
+
export declare const GetDashboardEmbedUrlResponseFilterSensitiveLog: (obj: GetDashboardEmbedUrlResponse) => any;
|
|
3492
|
+
/**
|
|
3493
|
+
* @internal
|
|
3494
|
+
*/
|
|
3495
|
+
export declare const GetSessionEmbedUrlRequestFilterSensitiveLog: (obj: GetSessionEmbedUrlRequest) => any;
|
|
3496
|
+
/**
|
|
3497
|
+
* @internal
|
|
3498
|
+
*/
|
|
3499
|
+
export declare const GetSessionEmbedUrlResponseFilterSensitiveLog: (obj: GetSessionEmbedUrlResponse) => any;
|
|
3500
|
+
/**
|
|
3501
|
+
* @internal
|
|
3502
|
+
*/
|
|
3503
|
+
export declare const GroupSearchFilterFilterSensitiveLog: (obj: GroupSearchFilter) => any;
|
|
3504
|
+
/**
|
|
3505
|
+
* @internal
|
|
3506
|
+
*/
|
|
3507
|
+
export declare const IAMPolicyAssignmentSummaryFilterSensitiveLog: (obj: IAMPolicyAssignmentSummary) => any;
|
|
3508
|
+
/**
|
|
3509
|
+
* @internal
|
|
3510
|
+
*/
|
|
3511
|
+
export declare const ListAnalysesRequestFilterSensitiveLog: (obj: ListAnalysesRequest) => any;
|
|
3512
|
+
/**
|
|
3513
|
+
* @internal
|
|
3514
|
+
*/
|
|
3515
|
+
export declare const ListAnalysesResponseFilterSensitiveLog: (obj: ListAnalysesResponse) => any;
|
|
3516
|
+
/**
|
|
3517
|
+
* @internal
|
|
3518
|
+
*/
|
|
3519
|
+
export declare const ListDashboardsRequestFilterSensitiveLog: (obj: ListDashboardsRequest) => any;
|
|
3520
|
+
/**
|
|
3521
|
+
* @internal
|
|
3522
|
+
*/
|
|
3523
|
+
export declare const ListDashboardsResponseFilterSensitiveLog: (obj: ListDashboardsResponse) => any;
|
|
3524
|
+
/**
|
|
3525
|
+
* @internal
|
|
3526
|
+
*/
|
|
3527
|
+
export declare const ListDashboardVersionsRequestFilterSensitiveLog: (obj: ListDashboardVersionsRequest) => any;
|
|
3528
|
+
/**
|
|
3529
|
+
* @internal
|
|
3530
|
+
*/
|
|
3531
|
+
export declare const ListDashboardVersionsResponseFilterSensitiveLog: (obj: ListDashboardVersionsResponse) => any;
|
|
3532
|
+
/**
|
|
3533
|
+
* @internal
|
|
3534
|
+
*/
|
|
3535
|
+
export declare const ListDataSetsRequestFilterSensitiveLog: (obj: ListDataSetsRequest) => any;
|
|
3536
|
+
/**
|
|
3537
|
+
* @internal
|
|
3538
|
+
*/
|
|
3539
|
+
export declare const ListDataSetsResponseFilterSensitiveLog: (obj: ListDataSetsResponse) => any;
|
|
3540
|
+
/**
|
|
3541
|
+
* @internal
|
|
3542
|
+
*/
|
|
3543
|
+
export declare const ListDataSourcesRequestFilterSensitiveLog: (obj: ListDataSourcesRequest) => any;
|
|
3544
|
+
/**
|
|
3545
|
+
* @internal
|
|
3546
|
+
*/
|
|
3547
|
+
export declare const ListDataSourcesResponseFilterSensitiveLog: (obj: ListDataSourcesResponse) => any;
|
|
3548
|
+
/**
|
|
3549
|
+
* @internal
|
|
3550
|
+
*/
|
|
3551
|
+
export declare const ListFolderMembersRequestFilterSensitiveLog: (obj: ListFolderMembersRequest) => any;
|
|
3552
|
+
/**
|
|
3553
|
+
* @internal
|
|
3554
|
+
*/
|
|
3555
|
+
export declare const ListFolderMembersResponseFilterSensitiveLog: (obj: ListFolderMembersResponse) => any;
|
|
3556
|
+
/**
|
|
3557
|
+
* @internal
|
|
3558
|
+
*/
|
|
3559
|
+
export declare const ListFoldersRequestFilterSensitiveLog: (obj: ListFoldersRequest) => any;
|
|
3560
|
+
/**
|
|
3561
|
+
* @internal
|
|
3562
|
+
*/
|
|
3563
|
+
export declare const ListFoldersResponseFilterSensitiveLog: (obj: ListFoldersResponse) => any;
|
|
3564
|
+
/**
|
|
3565
|
+
* @internal
|
|
3566
|
+
*/
|
|
3567
|
+
export declare const ListGroupMembershipsRequestFilterSensitiveLog: (obj: ListGroupMembershipsRequest) => any;
|
|
3568
|
+
/**
|
|
3569
|
+
* @internal
|
|
3570
|
+
*/
|
|
3571
|
+
export declare const ListGroupMembershipsResponseFilterSensitiveLog: (obj: ListGroupMembershipsResponse) => any;
|
|
3572
|
+
/**
|
|
3573
|
+
* @internal
|
|
3574
|
+
*/
|
|
3575
|
+
export declare const ListGroupsRequestFilterSensitiveLog: (obj: ListGroupsRequest) => any;
|
|
3576
|
+
/**
|
|
3577
|
+
* @internal
|
|
3578
|
+
*/
|
|
3579
|
+
export declare const ListGroupsResponseFilterSensitiveLog: (obj: ListGroupsResponse) => any;
|
|
3580
|
+
/**
|
|
3581
|
+
* @internal
|
|
3582
|
+
*/
|
|
3583
|
+
export declare const ListIAMPolicyAssignmentsRequestFilterSensitiveLog: (obj: ListIAMPolicyAssignmentsRequest) => any;
|
|
3584
|
+
/**
|
|
3585
|
+
* @internal
|
|
3586
|
+
*/
|
|
3587
|
+
export declare const ListIAMPolicyAssignmentsResponseFilterSensitiveLog: (obj: ListIAMPolicyAssignmentsResponse) => any;
|
|
3588
|
+
/**
|
|
3589
|
+
* @internal
|
|
3590
|
+
*/
|
|
3591
|
+
export declare const ListIAMPolicyAssignmentsForUserRequestFilterSensitiveLog: (obj: ListIAMPolicyAssignmentsForUserRequest) => any;
|
|
3592
|
+
/**
|
|
3593
|
+
* @internal
|
|
3594
|
+
*/
|
|
3595
|
+
export declare const ListIAMPolicyAssignmentsForUserResponseFilterSensitiveLog: (obj: ListIAMPolicyAssignmentsForUserResponse) => any;
|
|
3596
|
+
/**
|
|
3597
|
+
* @internal
|
|
3598
|
+
*/
|
|
3599
|
+
export declare const ListIngestionsRequestFilterSensitiveLog: (obj: ListIngestionsRequest) => any;
|
|
3600
|
+
/**
|
|
3601
|
+
* @internal
|
|
3602
|
+
*/
|
|
3603
|
+
export declare const ListIngestionsResponseFilterSensitiveLog: (obj: ListIngestionsResponse) => any;
|
|
3604
|
+
/**
|
|
3605
|
+
* @internal
|
|
3606
|
+
*/
|
|
3607
|
+
export declare const ListNamespacesRequestFilterSensitiveLog: (obj: ListNamespacesRequest) => any;
|
|
3608
|
+
/**
|
|
3609
|
+
* @internal
|
|
3610
|
+
*/
|
|
3611
|
+
export declare const ListNamespacesResponseFilterSensitiveLog: (obj: ListNamespacesResponse) => any;
|
|
3612
|
+
/**
|
|
3613
|
+
* @internal
|
|
3614
|
+
*/
|
|
3615
|
+
export declare const ListTagsForResourceRequestFilterSensitiveLog: (obj: ListTagsForResourceRequest) => any;
|
|
3616
|
+
/**
|
|
3617
|
+
* @internal
|
|
3618
|
+
*/
|
|
3619
|
+
export declare const ListTagsForResourceResponseFilterSensitiveLog: (obj: ListTagsForResourceResponse) => any;
|
|
3620
|
+
/**
|
|
3621
|
+
* @internal
|
|
3622
|
+
*/
|
|
3623
|
+
export declare const ListTemplateAliasesRequestFilterSensitiveLog: (obj: ListTemplateAliasesRequest) => any;
|
|
3624
|
+
/**
|
|
3625
|
+
* @internal
|
|
3626
|
+
*/
|
|
3627
|
+
export declare const ListTemplateAliasesResponseFilterSensitiveLog: (obj: ListTemplateAliasesResponse) => any;
|
|
3628
|
+
/**
|
|
3629
|
+
* @internal
|
|
3630
|
+
*/
|
|
3631
|
+
export declare const ListTemplatesRequestFilterSensitiveLog: (obj: ListTemplatesRequest) => any;
|
|
3632
|
+
/**
|
|
3633
|
+
* @internal
|
|
3634
|
+
*/
|
|
3635
|
+
export declare const TemplateSummaryFilterSensitiveLog: (obj: TemplateSummary) => any;
|
|
3636
|
+
/**
|
|
3637
|
+
* @internal
|
|
3638
|
+
*/
|
|
3639
|
+
export declare const ListTemplatesResponseFilterSensitiveLog: (obj: ListTemplatesResponse) => any;
|
|
3640
|
+
/**
|
|
3641
|
+
* @internal
|
|
3642
|
+
*/
|
|
3643
|
+
export declare const ListTemplateVersionsRequestFilterSensitiveLog: (obj: ListTemplateVersionsRequest) => any;
|
|
3644
|
+
/**
|
|
3645
|
+
* @internal
|
|
3646
|
+
*/
|
|
3647
|
+
export declare const TemplateVersionSummaryFilterSensitiveLog: (obj: TemplateVersionSummary) => any;
|
|
3648
|
+
/**
|
|
3649
|
+
* @internal
|
|
3650
|
+
*/
|
|
3651
|
+
export declare const ListTemplateVersionsResponseFilterSensitiveLog: (obj: ListTemplateVersionsResponse) => any;
|
|
3652
|
+
/**
|
|
3653
|
+
* @internal
|
|
3654
|
+
*/
|
|
3655
|
+
export declare const ListThemeAliasesRequestFilterSensitiveLog: (obj: ListThemeAliasesRequest) => any;
|
|
3656
|
+
/**
|
|
3657
|
+
* @internal
|
|
3658
|
+
*/
|
|
3659
|
+
export declare const ListThemeAliasesResponseFilterSensitiveLog: (obj: ListThemeAliasesResponse) => any;
|
|
3660
|
+
/**
|
|
3661
|
+
* @internal
|
|
3662
|
+
*/
|
|
3663
|
+
export declare const ListThemesRequestFilterSensitiveLog: (obj: ListThemesRequest) => any;
|
|
3664
|
+
/**
|
|
3665
|
+
* @internal
|
|
3666
|
+
*/
|
|
3667
|
+
export declare const ThemeSummaryFilterSensitiveLog: (obj: ThemeSummary) => any;
|
|
3668
|
+
/**
|
|
3669
|
+
* @internal
|
|
3670
|
+
*/
|
|
3671
|
+
export declare const ListThemesResponseFilterSensitiveLog: (obj: ListThemesResponse) => any;
|
|
3672
|
+
/**
|
|
3673
|
+
* @internal
|
|
3674
|
+
*/
|
|
3675
|
+
export declare const ListThemeVersionsRequestFilterSensitiveLog: (obj: ListThemeVersionsRequest) => any;
|
|
3676
|
+
/**
|
|
3677
|
+
* @internal
|
|
3678
|
+
*/
|
|
3679
|
+
export declare const ThemeVersionSummaryFilterSensitiveLog: (obj: ThemeVersionSummary) => any;
|
|
3680
|
+
/**
|
|
3681
|
+
* @internal
|
|
3682
|
+
*/
|
|
3683
|
+
export declare const ListThemeVersionsResponseFilterSensitiveLog: (obj: ListThemeVersionsResponse) => any;
|
|
3684
|
+
/**
|
|
3685
|
+
* @internal
|
|
3686
|
+
*/
|
|
3687
|
+
export declare const ListUserGroupsRequestFilterSensitiveLog: (obj: ListUserGroupsRequest) => any;
|
|
3688
|
+
/**
|
|
3689
|
+
* @internal
|
|
3690
|
+
*/
|
|
3691
|
+
export declare const ListUserGroupsResponseFilterSensitiveLog: (obj: ListUserGroupsResponse) => any;
|
|
3692
|
+
/**
|
|
3693
|
+
* @internal
|
|
3694
|
+
*/
|
|
3695
|
+
export declare const ListUsersRequestFilterSensitiveLog: (obj: ListUsersRequest) => any;
|
|
3696
|
+
/**
|
|
3697
|
+
* @internal
|
|
3698
|
+
*/
|
|
3699
|
+
export declare const ListUsersResponseFilterSensitiveLog: (obj: ListUsersResponse) => any;
|
|
3700
|
+
/**
|
|
3701
|
+
* @internal
|
|
3702
|
+
*/
|
|
3703
|
+
export declare const RegisterUserRequestFilterSensitiveLog: (obj: RegisterUserRequest) => any;
|
|
3704
|
+
/**
|
|
3705
|
+
* @internal
|
|
3706
|
+
*/
|
|
3707
|
+
export declare const RegisterUserResponseFilterSensitiveLog: (obj: RegisterUserResponse) => any;
|
|
3708
|
+
/**
|
|
3709
|
+
* @internal
|
|
3710
|
+
*/
|
|
3711
|
+
export declare const RestoreAnalysisRequestFilterSensitiveLog: (obj: RestoreAnalysisRequest) => any;
|
|
3712
|
+
/**
|
|
3713
|
+
* @internal
|
|
3714
|
+
*/
|
|
3715
|
+
export declare const RestoreAnalysisResponseFilterSensitiveLog: (obj: RestoreAnalysisResponse) => any;
|
|
3716
|
+
/**
|
|
3717
|
+
* @internal
|
|
3718
|
+
*/
|
|
3719
|
+
export declare const SearchAnalysesRequestFilterSensitiveLog: (obj: SearchAnalysesRequest) => any;
|
|
3720
|
+
/**
|
|
3721
|
+
* @internal
|
|
3722
|
+
*/
|
|
3723
|
+
export declare const SearchAnalysesResponseFilterSensitiveLog: (obj: SearchAnalysesResponse) => any;
|
|
3724
|
+
/**
|
|
3725
|
+
* @internal
|
|
3726
|
+
*/
|
|
3727
|
+
export declare const SearchDashboardsRequestFilterSensitiveLog: (obj: SearchDashboardsRequest) => any;
|
|
3728
|
+
/**
|
|
3729
|
+
* @internal
|
|
3730
|
+
*/
|
|
3731
|
+
export declare const SearchDashboardsResponseFilterSensitiveLog: (obj: SearchDashboardsResponse) => any;
|
|
3732
|
+
/**
|
|
3733
|
+
* @internal
|
|
3734
|
+
*/
|
|
3735
|
+
export declare const SearchFoldersRequestFilterSensitiveLog: (obj: SearchFoldersRequest) => any;
|
|
3736
|
+
/**
|
|
3737
|
+
* @internal
|
|
3738
|
+
*/
|
|
3739
|
+
export declare const SearchFoldersResponseFilterSensitiveLog: (obj: SearchFoldersResponse) => any;
|
|
3740
|
+
/**
|
|
3741
|
+
* @internal
|
|
3742
|
+
*/
|
|
3743
|
+
export declare const SearchGroupsRequestFilterSensitiveLog: (obj: SearchGroupsRequest) => any;
|
|
3744
|
+
/**
|
|
3745
|
+
* @internal
|
|
3746
|
+
*/
|
|
3747
|
+
export declare const SearchGroupsResponseFilterSensitiveLog: (obj: SearchGroupsResponse) => any;
|
|
3748
|
+
/**
|
|
3749
|
+
* @internal
|
|
3750
|
+
*/
|
|
3751
|
+
export declare const TagResourceRequestFilterSensitiveLog: (obj: TagResourceRequest) => any;
|
|
3752
|
+
/**
|
|
3753
|
+
* @internal
|
|
3754
|
+
*/
|
|
3755
|
+
export declare const TagResourceResponseFilterSensitiveLog: (obj: TagResourceResponse) => any;
|
|
3756
|
+
/**
|
|
3757
|
+
* @internal
|
|
3758
|
+
*/
|
|
3759
|
+
export declare const UntagResourceRequestFilterSensitiveLog: (obj: UntagResourceRequest) => any;
|
|
3760
|
+
/**
|
|
3761
|
+
* @internal
|
|
3762
|
+
*/
|
|
3763
|
+
export declare const UntagResourceResponseFilterSensitiveLog: (obj: UntagResourceResponse) => any;
|
|
3764
|
+
/**
|
|
3765
|
+
* @internal
|
|
3766
|
+
*/
|
|
3767
|
+
export declare const UpdateAccountCustomizationRequestFilterSensitiveLog: (obj: UpdateAccountCustomizationRequest) => any;
|
|
3768
|
+
/**
|
|
3769
|
+
* @internal
|
|
3770
|
+
*/
|
|
3771
|
+
export declare const UpdateAccountCustomizationResponseFilterSensitiveLog: (obj: UpdateAccountCustomizationResponse) => any;
|
|
3772
|
+
/**
|
|
3773
|
+
* @internal
|
|
3774
|
+
*/
|
|
3775
|
+
export declare const UpdateAccountSettingsRequestFilterSensitiveLog: (obj: UpdateAccountSettingsRequest) => any;
|
|
3776
|
+
/**
|
|
3777
|
+
* @internal
|
|
3778
|
+
*/
|
|
3779
|
+
export declare const UpdateAccountSettingsResponseFilterSensitiveLog: (obj: UpdateAccountSettingsResponse) => any;
|
|
3780
|
+
/**
|
|
3781
|
+
* @internal
|
|
3782
|
+
*/
|
|
3783
|
+
export declare const UpdateAnalysisRequestFilterSensitiveLog: (obj: UpdateAnalysisRequest) => any;
|
|
3784
|
+
/**
|
|
3785
|
+
* @internal
|
|
3786
|
+
*/
|
|
3787
|
+
export declare const UpdateAnalysisResponseFilterSensitiveLog: (obj: UpdateAnalysisResponse) => any;
|
|
3788
|
+
/**
|
|
3789
|
+
* @internal
|
|
3790
|
+
*/
|
|
3791
|
+
export declare const UpdateAnalysisPermissionsRequestFilterSensitiveLog: (obj: UpdateAnalysisPermissionsRequest) => any;
|
|
3792
|
+
/**
|
|
3793
|
+
* @internal
|
|
3794
|
+
*/
|
|
3795
|
+
export declare const UpdateAnalysisPermissionsResponseFilterSensitiveLog: (obj: UpdateAnalysisPermissionsResponse) => any;
|
|
3796
|
+
/**
|
|
3797
|
+
* @internal
|
|
3798
|
+
*/
|
|
3799
|
+
export declare const UpdateDashboardRequestFilterSensitiveLog: (obj: UpdateDashboardRequest) => any;
|
|
3800
|
+
/**
|
|
3801
|
+
* @internal
|
|
3802
|
+
*/
|
|
3803
|
+
export declare const UpdateDashboardResponseFilterSensitiveLog: (obj: UpdateDashboardResponse) => any;
|
|
3804
|
+
/**
|
|
3805
|
+
* @internal
|
|
3806
|
+
*/
|
|
3807
|
+
export declare const UpdateDashboardPermissionsRequestFilterSensitiveLog: (obj: UpdateDashboardPermissionsRequest) => any;
|
|
3808
|
+
/**
|
|
3809
|
+
* @internal
|
|
3810
|
+
*/
|
|
3811
|
+
export declare const UpdateDashboardPermissionsResponseFilterSensitiveLog: (obj: UpdateDashboardPermissionsResponse) => any;
|
|
3812
|
+
/**
|
|
3813
|
+
* @internal
|
|
3814
|
+
*/
|
|
3815
|
+
export declare const UpdateDashboardPublishedVersionRequestFilterSensitiveLog: (obj: UpdateDashboardPublishedVersionRequest) => any;
|
|
3816
|
+
/**
|
|
3817
|
+
* @internal
|
|
3818
|
+
*/
|
|
3819
|
+
export declare const UpdateDashboardPublishedVersionResponseFilterSensitiveLog: (obj: UpdateDashboardPublishedVersionResponse) => any;
|
|
3820
|
+
/**
|
|
3821
|
+
* @internal
|
|
3822
|
+
*/
|
|
3823
|
+
export declare const UpdateDataSetRequestFilterSensitiveLog: (obj: UpdateDataSetRequest) => any;
|
|
3824
|
+
/**
|
|
3825
|
+
* @internal
|
|
3826
|
+
*/
|
|
3827
|
+
export declare const UpdateDataSetResponseFilterSensitiveLog: (obj: UpdateDataSetResponse) => any;
|
|
3828
|
+
/**
|
|
3829
|
+
* @internal
|
|
3830
|
+
*/
|
|
3831
|
+
export declare const UpdateDataSetPermissionsRequestFilterSensitiveLog: (obj: UpdateDataSetPermissionsRequest) => any;
|
|
3832
|
+
/**
|
|
3833
|
+
* @internal
|
|
3834
|
+
*/
|
|
3835
|
+
export declare const UpdateDataSetPermissionsResponseFilterSensitiveLog: (obj: UpdateDataSetPermissionsResponse) => any;
|
|
3836
|
+
/**
|
|
3837
|
+
* @internal
|
|
3838
|
+
*/
|
|
3839
|
+
export declare const UpdateDataSourceRequestFilterSensitiveLog: (obj: UpdateDataSourceRequest) => any;
|
|
3840
|
+
/**
|
|
3841
|
+
* @internal
|
|
3842
|
+
*/
|
|
3843
|
+
export declare const UpdateDataSourceResponseFilterSensitiveLog: (obj: UpdateDataSourceResponse) => any;
|
|
3844
|
+
/**
|
|
3845
|
+
* @internal
|
|
3846
|
+
*/
|
|
3847
|
+
export declare const UpdateDataSourcePermissionsRequestFilterSensitiveLog: (obj: UpdateDataSourcePermissionsRequest) => any;
|
|
3848
|
+
/**
|
|
3849
|
+
* @internal
|
|
3850
|
+
*/
|
|
3851
|
+
export declare const UpdateDataSourcePermissionsResponseFilterSensitiveLog: (obj: UpdateDataSourcePermissionsResponse) => any;
|
|
3852
|
+
/**
|
|
3853
|
+
* @internal
|
|
3854
|
+
*/
|
|
3855
|
+
export declare const UpdateFolderRequestFilterSensitiveLog: (obj: UpdateFolderRequest) => any;
|
|
3856
|
+
/**
|
|
3857
|
+
* @internal
|
|
3858
|
+
*/
|
|
3859
|
+
export declare const UpdateFolderResponseFilterSensitiveLog: (obj: UpdateFolderResponse) => any;
|
|
3860
|
+
/**
|
|
3861
|
+
* @internal
|
|
3862
|
+
*/
|
|
3863
|
+
export declare const UpdateFolderPermissionsRequestFilterSensitiveLog: (obj: UpdateFolderPermissionsRequest) => any;
|
|
3864
|
+
/**
|
|
3865
|
+
* @internal
|
|
3866
|
+
*/
|
|
3867
|
+
export declare const UpdateFolderPermissionsResponseFilterSensitiveLog: (obj: UpdateFolderPermissionsResponse) => any;
|
|
3868
|
+
/**
|
|
3869
|
+
* @internal
|
|
3870
|
+
*/
|
|
3871
|
+
export declare const UpdateGroupRequestFilterSensitiveLog: (obj: UpdateGroupRequest) => any;
|
|
3872
|
+
/**
|
|
3873
|
+
* @internal
|
|
3874
|
+
*/
|
|
3875
|
+
export declare const UpdateGroupResponseFilterSensitiveLog: (obj: UpdateGroupResponse) => any;
|
|
3876
|
+
/**
|
|
3877
|
+
* @internal
|
|
3878
|
+
*/
|
|
3879
|
+
export declare const UpdateIAMPolicyAssignmentRequestFilterSensitiveLog: (obj: UpdateIAMPolicyAssignmentRequest) => any;
|
|
3880
|
+
/**
|
|
3881
|
+
* @internal
|
|
3882
|
+
*/
|
|
3883
|
+
export declare const UpdateIAMPolicyAssignmentResponseFilterSensitiveLog: (obj: UpdateIAMPolicyAssignmentResponse) => any;
|
|
3884
|
+
/**
|
|
3885
|
+
* @internal
|
|
3886
|
+
*/
|
|
3887
|
+
export declare const UpdateIpRestrictionRequestFilterSensitiveLog: (obj: UpdateIpRestrictionRequest) => any;
|
|
3888
|
+
/**
|
|
3889
|
+
* @internal
|
|
3890
|
+
*/
|
|
3891
|
+
export declare const UpdateIpRestrictionResponseFilterSensitiveLog: (obj: UpdateIpRestrictionResponse) => any;
|
|
3892
|
+
/**
|
|
3893
|
+
* @internal
|
|
3894
|
+
*/
|
|
3895
|
+
export declare const UpdatePublicSharingSettingsRequestFilterSensitiveLog: (obj: UpdatePublicSharingSettingsRequest) => any;
|
|
3896
|
+
/**
|
|
3897
|
+
* @internal
|
|
3898
|
+
*/
|
|
3899
|
+
export declare const UpdatePublicSharingSettingsResponseFilterSensitiveLog: (obj: UpdatePublicSharingSettingsResponse) => any;
|
|
3900
|
+
/**
|
|
3901
|
+
* @internal
|
|
3902
|
+
*/
|
|
3903
|
+
export declare const UpdateTemplateRequestFilterSensitiveLog: (obj: UpdateTemplateRequest) => any;
|
|
3904
|
+
/**
|
|
3905
|
+
* @internal
|
|
3906
|
+
*/
|
|
3907
|
+
export declare const UpdateTemplateResponseFilterSensitiveLog: (obj: UpdateTemplateResponse) => any;
|
|
3908
|
+
/**
|
|
3909
|
+
* @internal
|
|
3910
|
+
*/
|
|
3911
|
+
export declare const UpdateTemplateAliasRequestFilterSensitiveLog: (obj: UpdateTemplateAliasRequest) => any;
|
|
3912
|
+
/**
|
|
3913
|
+
* @internal
|
|
3914
|
+
*/
|
|
3915
|
+
export declare const UpdateTemplateAliasResponseFilterSensitiveLog: (obj: UpdateTemplateAliasResponse) => any;
|
|
3916
|
+
/**
|
|
3917
|
+
* @internal
|
|
3918
|
+
*/
|
|
3919
|
+
export declare const UpdateTemplatePermissionsRequestFilterSensitiveLog: (obj: UpdateTemplatePermissionsRequest) => any;
|
|
3920
|
+
/**
|
|
3921
|
+
* @internal
|
|
3922
|
+
*/
|
|
3923
|
+
export declare const UpdateTemplatePermissionsResponseFilterSensitiveLog: (obj: UpdateTemplatePermissionsResponse) => any;
|
|
3924
|
+
/**
|
|
3925
|
+
* @internal
|
|
3926
|
+
*/
|
|
3927
|
+
export declare const UpdateThemeRequestFilterSensitiveLog: (obj: UpdateThemeRequest) => any;
|
|
3928
|
+
/**
|
|
3929
|
+
* @internal
|
|
3930
|
+
*/
|
|
3931
|
+
export declare const UpdateThemeResponseFilterSensitiveLog: (obj: UpdateThemeResponse) => any;
|
|
3932
|
+
/**
|
|
3933
|
+
* @internal
|
|
3934
|
+
*/
|
|
3935
|
+
export declare const UpdateThemeAliasRequestFilterSensitiveLog: (obj: UpdateThemeAliasRequest) => any;
|
|
3936
|
+
/**
|
|
3937
|
+
* @internal
|
|
3938
|
+
*/
|
|
3939
|
+
export declare const UpdateThemeAliasResponseFilterSensitiveLog: (obj: UpdateThemeAliasResponse) => any;
|
|
3940
|
+
/**
|
|
3941
|
+
* @internal
|
|
3942
|
+
*/
|
|
3943
|
+
export declare const UpdateThemePermissionsRequestFilterSensitiveLog: (obj: UpdateThemePermissionsRequest) => any;
|
|
3944
|
+
/**
|
|
3945
|
+
* @internal
|
|
3946
|
+
*/
|
|
3947
|
+
export declare const UpdateThemePermissionsResponseFilterSensitiveLog: (obj: UpdateThemePermissionsResponse) => any;
|
|
3948
|
+
/**
|
|
3949
|
+
* @internal
|
|
3950
|
+
*/
|
|
3951
|
+
export declare const UpdateUserRequestFilterSensitiveLog: (obj: UpdateUserRequest) => any;
|
|
3952
|
+
/**
|
|
3953
|
+
* @internal
|
|
3954
|
+
*/
|
|
3955
|
+
export declare const UpdateUserResponseFilterSensitiveLog: (obj: UpdateUserResponse) => any;
|