@aws-sdk/client-quicksight 3.1062.0 → 3.1063.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +56 -0
- package/dist-cjs/index.js +195 -0
- package/dist-cjs/models/errors.js +54 -54
- package/dist-cjs/schemas/schemas_0.js +569 -225
- package/dist-es/QuickSight.js +20 -0
- package/dist-es/commands/BatchDeleteKnowledgeBaseCommand.js +16 -0
- package/dist-es/commands/DeleteKnowledgeBaseCommand.js +16 -0
- package/dist-es/commands/DescribeKnowledgeBaseCommand.js +16 -0
- package/dist-es/commands/DescribeKnowledgeBasePermissionsCommand.js +16 -0
- package/dist-es/commands/ListKnowledgeBasesCommand.js +16 -0
- package/dist-es/commands/ListUsersIndexCapacityCommand.js +16 -0
- package/dist-es/commands/SearchKnowledgeBasesCommand.js +16 -0
- package/dist-es/commands/UpdateKnowledgeBasePermissionsCommand.js +16 -0
- package/dist-es/commands/index.js +8 -0
- package/dist-es/models/enums.js +63 -0
- package/dist-es/models/errors.js +48 -48
- package/dist-es/pagination/ListKnowledgeBasesPaginator.js +4 -0
- package/dist-es/pagination/SearchKnowledgeBasesPaginator.js +4 -0
- package/dist-es/pagination/index.js +2 -0
- package/dist-es/schemas/schemas_0.js +532 -189
- package/dist-types/QuickSight.d.ts +70 -0
- package/dist-types/QuickSightClient.d.ts +10 -2
- package/dist-types/commands/BatchDeleteKnowledgeBaseCommand.d.ts +117 -0
- package/dist-types/commands/DeleteKnowledgeBaseCommand.d.ts +110 -0
- package/dist-types/commands/DescribeDataSetCommand.d.ts +2 -1
- package/dist-types/commands/DescribeDataSetPermissionsCommand.d.ts +1 -1
- package/dist-types/commands/DescribeDataSetRefreshPropertiesCommand.d.ts +1 -1
- package/dist-types/commands/DescribeDataSourceCommand.d.ts +1 -1
- package/dist-types/commands/DescribeDataSourcePermissionsCommand.d.ts +1 -2
- package/dist-types/commands/DescribeKnowledgeBaseCommand.d.ts +157 -0
- package/dist-types/commands/DescribeKnowledgeBasePermissionsCommand.d.ts +115 -0
- package/dist-types/commands/ListKnowledgeBasesCommand.d.ts +117 -0
- package/dist-types/commands/ListUsersIndexCapacityCommand.d.ts +127 -0
- package/dist-types/commands/SearchKnowledgeBasesCommand.d.ts +131 -0
- package/dist-types/commands/StartDashboardSnapshotJobCommand.d.ts +1 -1
- package/dist-types/commands/StartDashboardSnapshotJobScheduleCommand.d.ts +1 -1
- package/dist-types/commands/TagResourceCommand.d.ts +1 -1
- package/dist-types/commands/UntagResourceCommand.d.ts +1 -1
- package/dist-types/commands/UpdateAccountCustomPermissionCommand.d.ts +1 -1
- package/dist-types/commands/UpdateAccountCustomizationCommand.d.ts +1 -1
- package/dist-types/commands/UpdateAccountSettingsCommand.d.ts +1 -1
- package/dist-types/commands/UpdateActionConnectorCommand.d.ts +1 -1
- package/dist-types/commands/UpdateActionConnectorPermissionsCommand.d.ts +1 -1
- package/dist-types/commands/UpdateAgentCommand.d.ts +1 -1
- package/dist-types/commands/UpdateAgentPermissionsCommand.d.ts +1 -1
- package/dist-types/commands/UpdateAnalysisCommand.d.ts +1 -1
- package/dist-types/commands/UpdateAnalysisPermissionsCommand.d.ts +1 -1
- package/dist-types/commands/UpdateApplicationWithTokenExchangeGrantCommand.d.ts +1 -1
- package/dist-types/commands/UpdateBrandCommand.d.ts +1 -1
- package/dist-types/commands/UpdateKnowledgeBasePermissionsCommand.d.ts +134 -0
- package/dist-types/commands/index.d.ts +8 -0
- package/dist-types/models/enums.d.ts +159 -0
- package/dist-types/models/errors.d.ts +53 -53
- package/dist-types/models/models_2.d.ts +106 -144
- package/dist-types/models/models_3.d.ts +184 -154
- package/dist-types/models/models_4.d.ts +1367 -1363
- package/dist-types/models/models_5.d.ts +860 -4
- package/dist-types/pagination/ListKnowledgeBasesPaginator.d.ts +7 -0
- package/dist-types/pagination/SearchKnowledgeBasesPaginator.d.ts +7 -0
- package/dist-types/pagination/index.d.ts +2 -0
- package/dist-types/schemas/schemas_0.d.ts +41 -0
- package/dist-types/ts3.4/QuickSight.d.ts +150 -0
- package/dist-types/ts3.4/QuickSightClient.d.ts +48 -0
- package/dist-types/ts3.4/commands/BatchDeleteKnowledgeBaseCommand.d.ts +53 -0
- package/dist-types/ts3.4/commands/DeleteKnowledgeBaseCommand.d.ts +53 -0
- package/dist-types/ts3.4/commands/DescribeDataSetCommand.d.ts +2 -4
- package/dist-types/ts3.4/commands/DescribeDataSetPermissionsCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/DescribeDataSetRefreshPropertiesCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/DescribeDataSourceCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/DescribeDataSourcePermissionsCommand.d.ts +4 -2
- package/dist-types/ts3.4/commands/DescribeKnowledgeBaseCommand.d.ts +53 -0
- package/dist-types/ts3.4/commands/DescribeKnowledgeBasePermissionsCommand.d.ts +53 -0
- package/dist-types/ts3.4/commands/ListKnowledgeBasesCommand.d.ts +53 -0
- package/dist-types/ts3.4/commands/ListUsersIndexCapacityCommand.d.ts +53 -0
- package/dist-types/ts3.4/commands/SearchKnowledgeBasesCommand.d.ts +53 -0
- package/dist-types/ts3.4/commands/StartDashboardSnapshotJobCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/StartDashboardSnapshotJobScheduleCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/TagResourceCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/UntagResourceCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/UpdateAccountCustomPermissionCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/UpdateAccountCustomizationCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/UpdateAccountSettingsCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/UpdateActionConnectorCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/UpdateActionConnectorPermissionsCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/UpdateAgentCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/UpdateAgentPermissionsCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/UpdateAnalysisCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/UpdateAnalysisPermissionsCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/UpdateApplicationWithTokenExchangeGrantCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/UpdateBrandCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/UpdateKnowledgeBasePermissionsCommand.d.ts +53 -0
- package/dist-types/ts3.4/commands/index.d.ts +8 -0
- package/dist-types/ts3.4/models/enums.d.ts +85 -0
- package/dist-types/ts3.4/models/errors.d.ts +28 -28
- package/dist-types/ts3.4/models/models_2.d.ts +27 -34
- package/dist-types/ts3.4/models/models_3.d.ts +47 -44
- package/dist-types/ts3.4/models/models_4.d.ts +219 -195
- package/dist-types/ts3.4/models/models_5.d.ts +209 -0
- package/dist-types/ts3.4/pagination/ListKnowledgeBasesPaginator.d.ts +11 -0
- package/dist-types/ts3.4/pagination/SearchKnowledgeBasesPaginator.d.ts +11 -0
- package/dist-types/ts3.4/pagination/index.d.ts +2 -0
- package/dist-types/ts3.4/schemas/schemas_0.d.ts +41 -0
- package/package.json +5 -5
|
@@ -1,8 +1,160 @@
|
|
|
1
1
|
import type { DocumentType as __DocumentType } from "@smithy/types";
|
|
2
|
-
import type {
|
|
3
|
-
import type {
|
|
4
|
-
import type {
|
|
5
|
-
import type { CustomInstructions, CustomPermissions, DashboardCustomizationSummaryConfigurations, DashboardSearchFilter, DashboardSummary, DashboardVersionSummary, DashboardVisualResult, DataSetConfiguration, DataSetSearchFilter, DataSetSummary, DataSource, DataSourceSearchFilter, DataSourceSummary, Group, GroupMember, Permission, RefreshSchedule,
|
|
2
|
+
import type { AssetBundleExportFormat, AssetBundleImportFailureAction, AssignmentStatus, DataSetStatus, DataSourceType, EmbeddingIdentityType, FieldName, FilterOperator, FlowPublishState, FolderFilterAttribute, FolderType, GeneratedAnswerStatus, GroupFilterAttribute, GroupFilterOperator, IdentityStore, IdentityType, ImageExtractionStatus, IncludeFolderMembers, IncludeGeneratedAnswer, IncludeQuickSightQIndex, IngestionErrorType, IngestionRequestSource, IngestionRequestType, IngestionStatus, KbIngestionStatus, KnowledgeBaseSearchFilterName, KnowledgeBaseSearchOperator, KnowledgeBaseSortByField, NamespaceErrorType, NamespaceStatus, NetworkInterfaceStatus, OAuthClientAuthenticationType, PersonalizationMode, QAResultType, QDataKeyType, QSearchStatus, ResourceStatus, Role, SearchFilterOperator, SelfUpgradeRequestStatus, SelfUpgradeStatus, SharingModel, SortOrder, SpaceQuickSightResourceType, SpaceQuickSightSearchFilterName, SpaceSearchOperator, TemplateErrorType, ThemeErrorType, ThemeType, TopicFilterAttribute, TopicFilterOperator, TopicRefreshStatus, TopicUserExperienceVersion, UserIndexCapacitySortBy, UserIndexCapacitySortOrder, UserRole, VideoExtractionStatus, VideoExtractionType, VPCConnectionAvailabilityStatus, VPCConnectionResourceStatus } from "./enums";
|
|
3
|
+
import type { ActionConnectorSearchFilter, ActionConnectorSummary, ActiveIAMPolicyAssignment, AgentSearchFilter, AgentSummary, AmazonQInQuickSightConsoleConfigurations, AmazonQInQuickSightDashboardConfigurations, Entity, Sheet } from "./models_0";
|
|
4
|
+
import type { AnalysisSearchFilter, AnalysisSummary, AnonymousUserEmbeddingExperienceConfiguration, AssetBundleCloudFormationOverridePropertyConfiguration, AssetBundleExportJobSummary, AssetBundleExportJobValidationStrategy, AssetBundleImportJobOverrideParameters, AssetBundleImportJobOverridePermissions, AssetBundleImportJobOverrideTags, AssetBundleImportJobOverrideValidationStrategy, AssetBundleImportJobSummary, AssetBundleImportSource, AudioExtractionConfiguration, AuthorizedTargetsByService, BookmarksConfigurations, BrandSummary, CapacityBytesRangeFilter, DashboardVisualId, DataSetRefreshProperties, ResourcePermission, SharedViewConfigurations, Tag, VpcConnectionProperties } from "./models_2";
|
|
5
|
+
import type { CustomInstructions, CustomPermissions, DashboardCustomizationSummaryConfigurations, DashboardSearchFilter, DashboardSummary, DashboardVersionSummary, DashboardVisualResult, DataSet, DataSetConfiguration, DataSetSearchFilter, DataSetSummary, DataSource, DataSourceSearchFilter, DataSourceSummary, Group, GroupMember, Permission, RefreshSchedule, TemplateAlias, TemplateVersionDefinition, ThemeAlias, ThemeConfiguration, TopicDetails, TopicRefreshSchedule } from "./models_3";
|
|
6
|
+
/**
|
|
7
|
+
* @public
|
|
8
|
+
*/
|
|
9
|
+
export interface DescribeDataSetResponse {
|
|
10
|
+
/**
|
|
11
|
+
* <p>Information on the dataset.</p>
|
|
12
|
+
* @public
|
|
13
|
+
*/
|
|
14
|
+
DataSet?: DataSet | undefined;
|
|
15
|
+
/**
|
|
16
|
+
* <p>The Amazon Web Services request ID for this operation.</p>
|
|
17
|
+
* @public
|
|
18
|
+
*/
|
|
19
|
+
RequestId?: string | undefined;
|
|
20
|
+
/**
|
|
21
|
+
* <p>The HTTP status of the request.</p>
|
|
22
|
+
* @public
|
|
23
|
+
*/
|
|
24
|
+
Status?: number | undefined;
|
|
25
|
+
}
|
|
26
|
+
/**
|
|
27
|
+
* @public
|
|
28
|
+
*/
|
|
29
|
+
export interface DescribeDataSetPermissionsRequest {
|
|
30
|
+
/**
|
|
31
|
+
* <p>The Amazon Web Services account ID.</p>
|
|
32
|
+
* @public
|
|
33
|
+
*/
|
|
34
|
+
AwsAccountId: string | undefined;
|
|
35
|
+
/**
|
|
36
|
+
* <p>The ID for the dataset that you want to describe. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.</p>
|
|
37
|
+
* @public
|
|
38
|
+
*/
|
|
39
|
+
DataSetId: string | undefined;
|
|
40
|
+
}
|
|
41
|
+
/**
|
|
42
|
+
* @public
|
|
43
|
+
*/
|
|
44
|
+
export interface DescribeDataSetPermissionsResponse {
|
|
45
|
+
/**
|
|
46
|
+
* <p>The Amazon Resource Name (ARN) of the dataset.</p>
|
|
47
|
+
* @public
|
|
48
|
+
*/
|
|
49
|
+
DataSetArn?: string | undefined;
|
|
50
|
+
/**
|
|
51
|
+
* <p>The ID for the dataset that you want to describe. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.</p>
|
|
52
|
+
* @public
|
|
53
|
+
*/
|
|
54
|
+
DataSetId?: string | undefined;
|
|
55
|
+
/**
|
|
56
|
+
* <p>A list of resource permissions on the dataset.</p>
|
|
57
|
+
* @public
|
|
58
|
+
*/
|
|
59
|
+
Permissions?: ResourcePermission[] | undefined;
|
|
60
|
+
/**
|
|
61
|
+
* <p>The Amazon Web Services request ID for this operation.</p>
|
|
62
|
+
* @public
|
|
63
|
+
*/
|
|
64
|
+
RequestId?: string | undefined;
|
|
65
|
+
/**
|
|
66
|
+
* <p>The HTTP status of the request.</p>
|
|
67
|
+
* @public
|
|
68
|
+
*/
|
|
69
|
+
Status?: number | undefined;
|
|
70
|
+
}
|
|
71
|
+
/**
|
|
72
|
+
* @public
|
|
73
|
+
*/
|
|
74
|
+
export interface DescribeDataSetRefreshPropertiesRequest {
|
|
75
|
+
/**
|
|
76
|
+
* <p>The Amazon Web Services account ID.</p>
|
|
77
|
+
* @public
|
|
78
|
+
*/
|
|
79
|
+
AwsAccountId: string | undefined;
|
|
80
|
+
/**
|
|
81
|
+
* <p>The ID of the dataset.</p>
|
|
82
|
+
* @public
|
|
83
|
+
*/
|
|
84
|
+
DataSetId: string | undefined;
|
|
85
|
+
}
|
|
86
|
+
/**
|
|
87
|
+
* @public
|
|
88
|
+
*/
|
|
89
|
+
export interface DescribeDataSetRefreshPropertiesResponse {
|
|
90
|
+
/**
|
|
91
|
+
* <p>The Amazon Web Services request ID for this operation.</p>
|
|
92
|
+
* @public
|
|
93
|
+
*/
|
|
94
|
+
RequestId?: string | undefined;
|
|
95
|
+
/**
|
|
96
|
+
* <p>The HTTP status of the request.</p>
|
|
97
|
+
* @public
|
|
98
|
+
*/
|
|
99
|
+
Status?: number | undefined;
|
|
100
|
+
/**
|
|
101
|
+
* <p>The dataset refresh properties.</p>
|
|
102
|
+
* @public
|
|
103
|
+
*/
|
|
104
|
+
DataSetRefreshProperties?: DataSetRefreshProperties | undefined;
|
|
105
|
+
}
|
|
106
|
+
/**
|
|
107
|
+
* @public
|
|
108
|
+
*/
|
|
109
|
+
export interface DescribeDataSourceRequest {
|
|
110
|
+
/**
|
|
111
|
+
* <p>The Amazon Web Services account ID.</p>
|
|
112
|
+
* @public
|
|
113
|
+
*/
|
|
114
|
+
AwsAccountId: string | undefined;
|
|
115
|
+
/**
|
|
116
|
+
* <p>The ID of the data source. This ID is unique per Amazon Web Services Region for each
|
|
117
|
+
* Amazon Web Services account.</p>
|
|
118
|
+
* @public
|
|
119
|
+
*/
|
|
120
|
+
DataSourceId: string | undefined;
|
|
121
|
+
}
|
|
122
|
+
/**
|
|
123
|
+
* @public
|
|
124
|
+
*/
|
|
125
|
+
export interface DescribeDataSourceResponse {
|
|
126
|
+
/**
|
|
127
|
+
* <p>The information on the data source.</p>
|
|
128
|
+
* @public
|
|
129
|
+
*/
|
|
130
|
+
DataSource?: DataSource | undefined;
|
|
131
|
+
/**
|
|
132
|
+
* <p>The Amazon Web Services request ID for this operation.</p>
|
|
133
|
+
* @public
|
|
134
|
+
*/
|
|
135
|
+
RequestId?: string | undefined;
|
|
136
|
+
/**
|
|
137
|
+
* <p>The HTTP status of the request.</p>
|
|
138
|
+
* @public
|
|
139
|
+
*/
|
|
140
|
+
Status?: number | undefined;
|
|
141
|
+
}
|
|
142
|
+
/**
|
|
143
|
+
* @public
|
|
144
|
+
*/
|
|
145
|
+
export interface DescribeDataSourcePermissionsRequest {
|
|
146
|
+
/**
|
|
147
|
+
* <p>The Amazon Web Services account ID.</p>
|
|
148
|
+
* @public
|
|
149
|
+
*/
|
|
150
|
+
AwsAccountId: string | undefined;
|
|
151
|
+
/**
|
|
152
|
+
* <p>The ID of the data source. This ID is unique per Amazon Web Services Region for each
|
|
153
|
+
* Amazon Web Services account.</p>
|
|
154
|
+
* @public
|
|
155
|
+
*/
|
|
156
|
+
DataSourceId: string | undefined;
|
|
157
|
+
}
|
|
6
158
|
/**
|
|
7
159
|
* @public
|
|
8
160
|
*/
|
|
@@ -860,218 +1012,229 @@ export interface DescribeKeyRegistrationResponse {
|
|
|
860
1012
|
/**
|
|
861
1013
|
* @public
|
|
862
1014
|
*/
|
|
863
|
-
export interface
|
|
1015
|
+
export interface DescribeKnowledgeBaseRequest {
|
|
864
1016
|
/**
|
|
865
|
-
* <p>The ID
|
|
1017
|
+
* <p>The ID of the Amazon Web Services account that contains the knowledge base.</p>
|
|
866
1018
|
* @public
|
|
867
1019
|
*/
|
|
868
1020
|
AwsAccountId: string | undefined;
|
|
869
1021
|
/**
|
|
870
|
-
* <p>The
|
|
1022
|
+
* <p>The unique identifier for the knowledge base.</p>
|
|
871
1023
|
* @public
|
|
872
1024
|
*/
|
|
873
|
-
|
|
1025
|
+
KnowledgeBaseId: string | undefined;
|
|
874
1026
|
}
|
|
875
1027
|
/**
|
|
876
|
-
* <p>
|
|
1028
|
+
* <p>A summary of an ingestion job for a knowledge base.</p>
|
|
877
1029
|
* @public
|
|
878
1030
|
*/
|
|
879
|
-
export interface
|
|
1031
|
+
export interface KnowledgeBaseIngestionSummary {
|
|
880
1032
|
/**
|
|
881
|
-
* <p>The
|
|
1033
|
+
* <p>The unique identifier for the ingestion job.</p>
|
|
882
1034
|
* @public
|
|
883
1035
|
*/
|
|
884
|
-
|
|
1036
|
+
IngestionId: string | undefined;
|
|
885
1037
|
/**
|
|
886
|
-
* <p>The
|
|
1038
|
+
* <p>The status of the ingestion job.</p>
|
|
887
1039
|
* @public
|
|
888
1040
|
*/
|
|
889
|
-
|
|
890
|
-
}
|
|
891
|
-
/**
|
|
892
|
-
* <p>The error type.</p>
|
|
893
|
-
* @public
|
|
894
|
-
*/
|
|
895
|
-
export interface NamespaceInfoV2 {
|
|
1041
|
+
IngestionStatus: KbIngestionStatus | undefined;
|
|
896
1042
|
/**
|
|
897
|
-
* <p>The
|
|
1043
|
+
* <p>The start time of the ingestion job.</p>
|
|
898
1044
|
* @public
|
|
899
1045
|
*/
|
|
900
|
-
|
|
1046
|
+
StartTime?: Date | undefined;
|
|
901
1047
|
/**
|
|
902
|
-
* <p>The
|
|
1048
|
+
* <p>The end time of the ingestion job.</p>
|
|
903
1049
|
* @public
|
|
904
1050
|
*/
|
|
905
|
-
|
|
1051
|
+
EndTime?: Date | undefined;
|
|
1052
|
+
}
|
|
1053
|
+
/**
|
|
1054
|
+
* <p>The template configuration for a knowledge base.</p>
|
|
1055
|
+
* @public
|
|
1056
|
+
*/
|
|
1057
|
+
export interface KbTemplateConfiguration {
|
|
906
1058
|
/**
|
|
907
|
-
* <p>The
|
|
1059
|
+
* <p>The template document that defines the knowledge base behavior.</p>
|
|
908
1060
|
* @public
|
|
909
1061
|
*/
|
|
910
|
-
|
|
1062
|
+
template?: __DocumentType | undefined;
|
|
1063
|
+
}
|
|
1064
|
+
/**
|
|
1065
|
+
* <p>The configuration settings for a knowledge base.</p>
|
|
1066
|
+
* @public
|
|
1067
|
+
*/
|
|
1068
|
+
export interface KnowledgeBaseConfiguration {
|
|
911
1069
|
/**
|
|
912
|
-
* <p>The
|
|
1070
|
+
* <p>The template configuration for the knowledge base.</p>
|
|
913
1071
|
* @public
|
|
914
1072
|
*/
|
|
915
|
-
|
|
1073
|
+
templateConfiguration?: KbTemplateConfiguration | undefined;
|
|
916
1074
|
/**
|
|
917
|
-
* <p>
|
|
1075
|
+
* <p>Indicates whether event notifications are enabled for the knowledge base.</p>
|
|
918
1076
|
* @public
|
|
919
1077
|
*/
|
|
920
|
-
|
|
1078
|
+
eventEnabled?: boolean | undefined;
|
|
1079
|
+
}
|
|
1080
|
+
/**
|
|
1081
|
+
* <p>The configuration for image extraction from knowledge base documents.</p>
|
|
1082
|
+
* @public
|
|
1083
|
+
*/
|
|
1084
|
+
export interface ImageExtractionConfiguration {
|
|
921
1085
|
/**
|
|
922
|
-
* <p>
|
|
1086
|
+
* <p>The status of image extraction. Valid values are ENABLED and DISABLED.</p>
|
|
923
1087
|
* @public
|
|
924
1088
|
*/
|
|
925
|
-
|
|
1089
|
+
imageExtractionStatus: ImageExtractionStatus | undefined;
|
|
1090
|
+
}
|
|
1091
|
+
/**
|
|
1092
|
+
* <p>The configuration for video extraction from knowledge base documents.</p>
|
|
1093
|
+
* @public
|
|
1094
|
+
*/
|
|
1095
|
+
export interface VideoExtractionConfiguration {
|
|
926
1096
|
/**
|
|
927
|
-
* <p>The
|
|
1097
|
+
* <p>The status of video extraction. Valid values are ENABLED and DISABLED.</p>
|
|
928
1098
|
* @public
|
|
929
1099
|
*/
|
|
930
|
-
|
|
1100
|
+
videoExtractionStatus: VideoExtractionStatus | undefined;
|
|
931
1101
|
/**
|
|
932
|
-
* <p>The
|
|
1102
|
+
* <p>The type of video extraction to perform.</p>
|
|
933
1103
|
* @public
|
|
934
1104
|
*/
|
|
935
|
-
|
|
1105
|
+
videoExtractionType?: VideoExtractionType | undefined;
|
|
936
1106
|
}
|
|
937
1107
|
/**
|
|
1108
|
+
* <p>The configuration for media extraction from knowledge base documents.</p>
|
|
938
1109
|
* @public
|
|
939
1110
|
*/
|
|
940
|
-
export interface
|
|
1111
|
+
export interface MediaExtractionConfiguration {
|
|
941
1112
|
/**
|
|
942
|
-
* <p>The
|
|
943
|
-
* the namespace ARN, name, Amazon Web Services Region, creation status, and identity store. <code>DescribeNamespace</code> also
|
|
944
|
-
* works for namespaces that are in the process of being created. For incomplete namespaces,
|
|
945
|
-
* this API operation lists the namespace error types and messages associated with the creation process.</p>
|
|
1113
|
+
* <p>The configuration for image extraction.</p>
|
|
946
1114
|
* @public
|
|
947
1115
|
*/
|
|
948
|
-
|
|
1116
|
+
imageExtractionConfiguration?: ImageExtractionConfiguration | undefined;
|
|
949
1117
|
/**
|
|
950
|
-
* <p>The
|
|
1118
|
+
* <p>The configuration for audio extraction.</p>
|
|
951
1119
|
* @public
|
|
952
1120
|
*/
|
|
953
|
-
|
|
1121
|
+
audioExtractionConfiguration?: AudioExtractionConfiguration | undefined;
|
|
954
1122
|
/**
|
|
955
|
-
* <p>The
|
|
1123
|
+
* <p>The configuration for video extraction.</p>
|
|
956
1124
|
* @public
|
|
957
1125
|
*/
|
|
958
|
-
|
|
1126
|
+
videoExtractionConfiguration?: VideoExtractionConfiguration | undefined;
|
|
959
1127
|
}
|
|
960
1128
|
/**
|
|
1129
|
+
* <p>A knowledge base resource that provides data from connected sources for AI-powered experiences in Amazon QuickSight.</p>
|
|
961
1130
|
* @public
|
|
962
1131
|
*/
|
|
963
|
-
export interface
|
|
1132
|
+
export interface KnowledgeBase {
|
|
964
1133
|
/**
|
|
965
|
-
* <p>The Amazon
|
|
1134
|
+
* <p>The Amazon Resource Name (ARN) of the knowledge base.</p>
|
|
966
1135
|
* @public
|
|
967
1136
|
*/
|
|
968
|
-
|
|
1137
|
+
KnowledgeBaseArn: string | undefined;
|
|
969
1138
|
/**
|
|
970
|
-
* <p>The
|
|
1139
|
+
* <p>The unique identifier for the knowledge base.</p>
|
|
971
1140
|
* @public
|
|
972
1141
|
*/
|
|
973
|
-
|
|
974
|
-
}
|
|
975
|
-
/**
|
|
976
|
-
* <p>An OAuth client application that is used to authenticate connections to a data source through an OAuth identity provider.</p>
|
|
977
|
-
* @public
|
|
978
|
-
*/
|
|
979
|
-
export interface OAuthClientApplication {
|
|
1142
|
+
KnowledgeBaseId: string | undefined;
|
|
980
1143
|
/**
|
|
981
|
-
* <p>The
|
|
1144
|
+
* <p>The name of the knowledge base.</p>
|
|
982
1145
|
* @public
|
|
983
1146
|
*/
|
|
984
|
-
|
|
1147
|
+
Name: string | undefined;
|
|
985
1148
|
/**
|
|
986
|
-
* <p>The
|
|
1149
|
+
* <p>The status of the knowledge base.</p>
|
|
987
1150
|
* @public
|
|
988
1151
|
*/
|
|
989
|
-
|
|
1152
|
+
Status: DataSetStatus | undefined;
|
|
990
1153
|
/**
|
|
991
|
-
* <p>The
|
|
1154
|
+
* <p>The ARN of the data source associated with the knowledge base.</p>
|
|
992
1155
|
* @public
|
|
993
1156
|
*/
|
|
994
|
-
|
|
1157
|
+
DataSourceArn: string | undefined;
|
|
995
1158
|
/**
|
|
996
|
-
* <p>The
|
|
1159
|
+
* <p>The configuration settings for the knowledge base.</p>
|
|
997
1160
|
* @public
|
|
998
1161
|
*/
|
|
999
|
-
|
|
1162
|
+
KnowledgeBaseConfiguration: KnowledgeBaseConfiguration | undefined;
|
|
1000
1163
|
/**
|
|
1001
|
-
* <p>The
|
|
1164
|
+
* <p>The media extraction configuration for the knowledge base.</p>
|
|
1002
1165
|
* @public
|
|
1003
1166
|
*/
|
|
1004
|
-
|
|
1167
|
+
MediaExtractionConfiguration?: MediaExtractionConfiguration | undefined;
|
|
1005
1168
|
/**
|
|
1006
|
-
* <p>The
|
|
1169
|
+
* <p>The type of the knowledge base.</p>
|
|
1007
1170
|
* @public
|
|
1008
1171
|
*/
|
|
1009
|
-
|
|
1172
|
+
Type?: string | undefined;
|
|
1010
1173
|
/**
|
|
1011
|
-
* <p>The
|
|
1174
|
+
* <p>The date and time that the knowledge base was created.</p>
|
|
1012
1175
|
* @public
|
|
1013
1176
|
*/
|
|
1014
|
-
|
|
1177
|
+
CreatedAt?: Date | undefined;
|
|
1015
1178
|
/**
|
|
1016
|
-
* <p>
|
|
1179
|
+
* <p>The date and time that the knowledge base was last updated.</p>
|
|
1017
1180
|
* @public
|
|
1018
1181
|
*/
|
|
1019
|
-
|
|
1182
|
+
UpdatedAt?: Date | undefined;
|
|
1020
1183
|
/**
|
|
1021
|
-
* <p>The
|
|
1184
|
+
* <p>The description of the knowledge base.</p>
|
|
1022
1185
|
* @public
|
|
1023
1186
|
*/
|
|
1024
|
-
|
|
1187
|
+
Description?: string | undefined;
|
|
1025
1188
|
/**
|
|
1026
|
-
* <p>
|
|
1189
|
+
* <p>Indicates whether email notifications are enabled for ingestion failures.</p>
|
|
1027
1190
|
* @public
|
|
1028
1191
|
*/
|
|
1029
|
-
|
|
1192
|
+
IsEmailNotificationOptedForIngestionFailures?: boolean | undefined;
|
|
1030
1193
|
/**
|
|
1031
|
-
* <p>
|
|
1194
|
+
* <p>A summary of the first completed ingestion for the knowledge base.</p>
|
|
1032
1195
|
* @public
|
|
1033
1196
|
*/
|
|
1034
|
-
|
|
1035
|
-
}
|
|
1036
|
-
/**
|
|
1037
|
-
* @public
|
|
1038
|
-
*/
|
|
1039
|
-
export interface DescribeOAuthClientApplicationResponse {
|
|
1197
|
+
FirstCompletedIngestionSummary?: KnowledgeBaseIngestionSummary | undefined;
|
|
1040
1198
|
/**
|
|
1041
|
-
* <p>
|
|
1199
|
+
* <p>A summary of the first incomplete ingestion for the knowledge base.</p>
|
|
1042
1200
|
* @public
|
|
1043
1201
|
*/
|
|
1044
|
-
|
|
1202
|
+
FirstIncompleteIngestionSummary?: KnowledgeBaseIngestionSummary | undefined;
|
|
1045
1203
|
/**
|
|
1046
|
-
* <p>
|
|
1204
|
+
* <p>A summary of the most recent ingestion for the knowledge base.</p>
|
|
1047
1205
|
* @public
|
|
1048
1206
|
*/
|
|
1049
|
-
|
|
1207
|
+
LatestIngestionSummary?: KnowledgeBaseIngestionSummary | undefined;
|
|
1050
1208
|
/**
|
|
1051
|
-
* <p>The
|
|
1209
|
+
* <p>The size of the knowledge base in bytes.</p>
|
|
1052
1210
|
* @public
|
|
1053
1211
|
*/
|
|
1054
|
-
|
|
1055
|
-
}
|
|
1056
|
-
/**
|
|
1057
|
-
* @public
|
|
1058
|
-
*/
|
|
1059
|
-
export interface DescribeQPersonalizationConfigurationRequest {
|
|
1212
|
+
KnowledgeBaseSizeBytes?: number | undefined;
|
|
1060
1213
|
/**
|
|
1061
|
-
* <p>The
|
|
1214
|
+
* <p>The number of documents in the knowledge base.</p>
|
|
1062
1215
|
* @public
|
|
1063
1216
|
*/
|
|
1064
|
-
|
|
1217
|
+
DocumentCount?: number | undefined;
|
|
1218
|
+
/**
|
|
1219
|
+
* <p>The ARN of the primary owner of the knowledge base.</p>
|
|
1220
|
+
* @public
|
|
1221
|
+
*/
|
|
1222
|
+
PrimaryOwnerArn?: string | undefined;
|
|
1223
|
+
/**
|
|
1224
|
+
* <p>The username of the primary owner of the knowledge base.</p>
|
|
1225
|
+
* @public
|
|
1226
|
+
*/
|
|
1227
|
+
PrimaryOwnerUsername?: string | undefined;
|
|
1065
1228
|
}
|
|
1066
1229
|
/**
|
|
1067
1230
|
* @public
|
|
1068
1231
|
*/
|
|
1069
|
-
export interface
|
|
1232
|
+
export interface DescribeKnowledgeBaseResponse {
|
|
1070
1233
|
/**
|
|
1071
|
-
* <p>
|
|
1234
|
+
* <p>The knowledge base.</p>
|
|
1072
1235
|
* @public
|
|
1073
1236
|
*/
|
|
1074
|
-
|
|
1237
|
+
KnowledgeBase: KnowledgeBase | undefined;
|
|
1075
1238
|
/**
|
|
1076
1239
|
* <p>The Amazon Web Services request ID for this operation.</p>
|
|
1077
1240
|
* @public
|
|
@@ -1086,22 +1249,37 @@ export interface DescribeQPersonalizationConfigurationResponse {
|
|
|
1086
1249
|
/**
|
|
1087
1250
|
* @public
|
|
1088
1251
|
*/
|
|
1089
|
-
export interface
|
|
1252
|
+
export interface DescribeKnowledgeBasePermissionsRequest {
|
|
1090
1253
|
/**
|
|
1091
|
-
* <p>The ID of the Amazon Web Services account that contains the
|
|
1254
|
+
* <p>The ID of the Amazon Web Services account that contains the knowledge base.</p>
|
|
1092
1255
|
* @public
|
|
1093
1256
|
*/
|
|
1094
1257
|
AwsAccountId: string | undefined;
|
|
1258
|
+
/**
|
|
1259
|
+
* <p>The unique identifier for the knowledge base.</p>
|
|
1260
|
+
* @public
|
|
1261
|
+
*/
|
|
1262
|
+
KnowledgeBaseId: string | undefined;
|
|
1095
1263
|
}
|
|
1096
1264
|
/**
|
|
1097
1265
|
* @public
|
|
1098
1266
|
*/
|
|
1099
|
-
export interface
|
|
1267
|
+
export interface DescribeKnowledgeBasePermissionsResponse {
|
|
1100
1268
|
/**
|
|
1101
|
-
* <p>The
|
|
1269
|
+
* <p>The Amazon Resource Name (ARN) of the knowledge base.</p>
|
|
1102
1270
|
* @public
|
|
1103
1271
|
*/
|
|
1104
|
-
|
|
1272
|
+
KnowledgeBaseArn: string | undefined;
|
|
1273
|
+
/**
|
|
1274
|
+
* <p>The unique identifier for the knowledge base.</p>
|
|
1275
|
+
* @public
|
|
1276
|
+
*/
|
|
1277
|
+
KnowledgeBaseId: string | undefined;
|
|
1278
|
+
/**
|
|
1279
|
+
* <p>The resource permissions for the knowledge base.</p>
|
|
1280
|
+
* @public
|
|
1281
|
+
*/
|
|
1282
|
+
Permissions?: ResourcePermission[] | undefined;
|
|
1105
1283
|
/**
|
|
1106
1284
|
* <p>The Amazon Web Services request ID for this operation.</p>
|
|
1107
1285
|
* @public
|
|
@@ -1116,77 +1294,92 @@ export interface DescribeQuickSightQSearchConfigurationResponse {
|
|
|
1116
1294
|
/**
|
|
1117
1295
|
* @public
|
|
1118
1296
|
*/
|
|
1119
|
-
export interface
|
|
1297
|
+
export interface DescribeNamespaceRequest {
|
|
1120
1298
|
/**
|
|
1121
|
-
* <p>The Amazon Web Services account
|
|
1299
|
+
* <p>The ID for the Amazon Web Services account that contains the Quick Sight namespace that you want to describe.</p>
|
|
1122
1300
|
* @public
|
|
1123
1301
|
*/
|
|
1124
1302
|
AwsAccountId: string | undefined;
|
|
1125
1303
|
/**
|
|
1126
|
-
* <p>The
|
|
1304
|
+
* <p>The namespace that you want to describe.</p>
|
|
1127
1305
|
* @public
|
|
1128
1306
|
*/
|
|
1129
|
-
|
|
1307
|
+
Namespace: string | undefined;
|
|
1308
|
+
}
|
|
1309
|
+
/**
|
|
1310
|
+
* <p>Errors that occur during namespace creation.</p>
|
|
1311
|
+
* @public
|
|
1312
|
+
*/
|
|
1313
|
+
export interface NamespaceError {
|
|
1130
1314
|
/**
|
|
1131
|
-
* <p>The
|
|
1315
|
+
* <p>The error type.</p>
|
|
1132
1316
|
* @public
|
|
1133
1317
|
*/
|
|
1134
|
-
|
|
1318
|
+
Type?: NamespaceErrorType | undefined;
|
|
1319
|
+
/**
|
|
1320
|
+
* <p>The message for the error.</p>
|
|
1321
|
+
* @public
|
|
1322
|
+
*/
|
|
1323
|
+
Message?: string | undefined;
|
|
1135
1324
|
}
|
|
1136
1325
|
/**
|
|
1326
|
+
* <p>The error type.</p>
|
|
1137
1327
|
* @public
|
|
1138
1328
|
*/
|
|
1139
|
-
export interface
|
|
1329
|
+
export interface NamespaceInfoV2 {
|
|
1140
1330
|
/**
|
|
1141
|
-
* <p>The
|
|
1331
|
+
* <p>The name of the error.</p>
|
|
1142
1332
|
* @public
|
|
1143
1333
|
*/
|
|
1144
|
-
|
|
1334
|
+
Name?: string | undefined;
|
|
1145
1335
|
/**
|
|
1146
|
-
* <p>The
|
|
1336
|
+
* <p>The namespace ARN.</p>
|
|
1147
1337
|
* @public
|
|
1148
1338
|
*/
|
|
1149
|
-
|
|
1339
|
+
Arn?: string | undefined;
|
|
1150
1340
|
/**
|
|
1151
|
-
* <p>The Amazon Web Services
|
|
1341
|
+
* <p>The namespace Amazon Web Services Region.</p>
|
|
1152
1342
|
* @public
|
|
1153
1343
|
*/
|
|
1154
|
-
|
|
1344
|
+
CapacityRegion?: string | undefined;
|
|
1155
1345
|
/**
|
|
1156
|
-
* <p>The
|
|
1346
|
+
* <p>The creation status of a namespace that is not yet completely created.</p>
|
|
1157
1347
|
* @public
|
|
1158
1348
|
*/
|
|
1159
|
-
|
|
1160
|
-
}
|
|
1161
|
-
/**
|
|
1162
|
-
* @public
|
|
1163
|
-
*/
|
|
1164
|
-
export interface DescribeRoleCustomPermissionRequest {
|
|
1349
|
+
CreationStatus?: NamespaceStatus | undefined;
|
|
1165
1350
|
/**
|
|
1166
|
-
* <p>The
|
|
1351
|
+
* <p>The identity store used for the namespace.</p>
|
|
1167
1352
|
* @public
|
|
1168
1353
|
*/
|
|
1169
|
-
|
|
1354
|
+
IdentityStore?: IdentityStore | undefined;
|
|
1170
1355
|
/**
|
|
1171
|
-
* <p>
|
|
1356
|
+
* <p>An error that occurred when the namespace was created.</p>
|
|
1172
1357
|
* @public
|
|
1173
1358
|
*/
|
|
1174
|
-
|
|
1359
|
+
NamespaceError?: NamespaceError | undefined;
|
|
1175
1360
|
/**
|
|
1176
|
-
* <p>The
|
|
1361
|
+
* <p>The Amazon Resource Name (ARN) for the IAM Identity Center application.</p>
|
|
1177
1362
|
* @public
|
|
1178
1363
|
*/
|
|
1179
|
-
|
|
1364
|
+
IamIdentityCenterApplicationArn?: string | undefined;
|
|
1365
|
+
/**
|
|
1366
|
+
* <p>The Amazon Resource Name (ARN) for the IAM Identity Center instance.</p>
|
|
1367
|
+
* @public
|
|
1368
|
+
*/
|
|
1369
|
+
IamIdentityCenterInstanceArn?: string | undefined;
|
|
1180
1370
|
}
|
|
1181
1371
|
/**
|
|
1182
1372
|
* @public
|
|
1183
1373
|
*/
|
|
1184
|
-
export interface
|
|
1374
|
+
export interface DescribeNamespaceResponse {
|
|
1185
1375
|
/**
|
|
1186
|
-
* <p>The
|
|
1376
|
+
* <p>The information about the namespace that you're describing. The response includes
|
|
1377
|
+
* the namespace ARN, name, Amazon Web Services Region, creation status, and identity store. <code>DescribeNamespace</code> also
|
|
1378
|
+
* works for namespaces that are in the process of being created. For incomplete namespaces,
|
|
1379
|
+
* this API operation lists the namespace error types and messages associated with the creation process.</p>
|
|
1187
1380
|
* @public
|
|
1188
1381
|
*/
|
|
1189
|
-
|
|
1382
|
+
Namespace?: NamespaceInfoV2 | undefined;
|
|
1190
1383
|
/**
|
|
1191
1384
|
* <p>The Amazon Web Services request ID for this operation.</p>
|
|
1192
1385
|
* @public
|
|
@@ -1201,181 +1394,422 @@ export interface DescribeRoleCustomPermissionResponse {
|
|
|
1201
1394
|
/**
|
|
1202
1395
|
* @public
|
|
1203
1396
|
*/
|
|
1204
|
-
export interface
|
|
1397
|
+
export interface DescribeOAuthClientApplicationRequest {
|
|
1205
1398
|
/**
|
|
1206
|
-
* <p>The
|
|
1399
|
+
* <p>The Amazon Web Services account ID.</p>
|
|
1207
1400
|
* @public
|
|
1208
1401
|
*/
|
|
1209
1402
|
AwsAccountId: string | undefined;
|
|
1210
1403
|
/**
|
|
1211
|
-
* <p>The
|
|
1404
|
+
* <p>The ID of the OAuthClientApplication that you want to describe.</p>
|
|
1212
1405
|
* @public
|
|
1213
1406
|
*/
|
|
1214
|
-
|
|
1407
|
+
OAuthClientApplicationId: string | undefined;
|
|
1215
1408
|
}
|
|
1216
1409
|
/**
|
|
1217
|
-
* <p>
|
|
1410
|
+
* <p>An OAuth client application that is used to authenticate connections to a data source through an OAuth identity provider.</p>
|
|
1218
1411
|
* @public
|
|
1219
1412
|
*/
|
|
1220
|
-
export interface
|
|
1413
|
+
export interface OAuthClientApplication {
|
|
1221
1414
|
/**
|
|
1222
|
-
* <p>
|
|
1223
|
-
* <ul>
|
|
1224
|
-
* <li>
|
|
1225
|
-
* <p>
|
|
1226
|
-
* <code>AUTO_APPROVAL</code>: All the self-upgrade requests will be auto approved.</p>
|
|
1227
|
-
* </li>
|
|
1228
|
-
* <li>
|
|
1229
|
-
* <p>
|
|
1230
|
-
* <code>ADMIN_APPROVAL</code>: All the self-upgrade requests will require admin approval.</p>
|
|
1231
|
-
* </li>
|
|
1232
|
-
* </ul>
|
|
1415
|
+
* <p>The ID of the OAuthClientApplication. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.</p>
|
|
1233
1416
|
* @public
|
|
1234
1417
|
*/
|
|
1235
|
-
|
|
1236
|
-
}
|
|
1237
|
-
/**
|
|
1238
|
-
* @public
|
|
1239
|
-
*/
|
|
1240
|
-
export interface DescribeSelfUpgradeConfigurationResponse {
|
|
1418
|
+
OAuthClientApplicationId?: string | undefined;
|
|
1241
1419
|
/**
|
|
1242
|
-
* <p>The
|
|
1420
|
+
* <p>The display name of the OAuthClientApplication.</p>
|
|
1243
1421
|
* @public
|
|
1244
1422
|
*/
|
|
1245
|
-
|
|
1423
|
+
Name?: string | undefined;
|
|
1246
1424
|
/**
|
|
1247
|
-
* <p>The
|
|
1425
|
+
* <p>The OAuth client authentication type used by the OAuthClientApplication. Valid values are <code>TOKEN</code>.</p>
|
|
1248
1426
|
* @public
|
|
1249
1427
|
*/
|
|
1250
|
-
|
|
1428
|
+
OAuthClientAuthenticationType?: OAuthClientAuthenticationType | undefined;
|
|
1251
1429
|
/**
|
|
1252
|
-
* <p>The
|
|
1430
|
+
* <p>The token endpoint URL of the identity provider that is used to obtain access tokens.</p>
|
|
1253
1431
|
* @public
|
|
1254
1432
|
*/
|
|
1255
|
-
|
|
1256
|
-
}
|
|
1257
|
-
/**
|
|
1258
|
-
* @public
|
|
1259
|
-
*/
|
|
1260
|
-
export interface DescribeSpaceRequest {
|
|
1433
|
+
OAuthTokenEndpointUrl?: string | undefined;
|
|
1261
1434
|
/**
|
|
1262
|
-
* <p>The
|
|
1435
|
+
* <p>The authorization endpoint URL of the identity provider that is used to obtain authorization codes.</p>
|
|
1263
1436
|
* @public
|
|
1264
1437
|
*/
|
|
1265
|
-
|
|
1438
|
+
OAuthAuthorizationEndpointUrl?: string | undefined;
|
|
1266
1439
|
/**
|
|
1267
|
-
* <p>The
|
|
1440
|
+
* <p>The OAuth scopes that are requested when the OAuthClientApplication obtains an access token from the identity provider.</p>
|
|
1268
1441
|
* @public
|
|
1269
1442
|
*/
|
|
1270
|
-
|
|
1443
|
+
OAuthScopes?: string | undefined;
|
|
1271
1444
|
/**
|
|
1272
|
-
* <p>The
|
|
1445
|
+
* <p>The type of data source that the OAuthClientApplication is used with. Valid values are <code>SNOWFLAKE</code>.</p>
|
|
1273
1446
|
* @public
|
|
1274
1447
|
*/
|
|
1275
|
-
|
|
1448
|
+
DataSourceType?: DataSourceType | undefined;
|
|
1449
|
+
/**
|
|
1450
|
+
* <p>VPC connection properties.</p>
|
|
1451
|
+
* @public
|
|
1452
|
+
*/
|
|
1453
|
+
IdentityProviderVpcConnectionProperties?: VpcConnectionProperties | undefined;
|
|
1454
|
+
/**
|
|
1455
|
+
* <p>The time that the OAuthClientApplication was created.</p>
|
|
1456
|
+
* @public
|
|
1457
|
+
*/
|
|
1458
|
+
CreatedTime?: Date | undefined;
|
|
1459
|
+
/**
|
|
1460
|
+
* <p>The time that the OAuthClientApplication was last updated.</p>
|
|
1461
|
+
* @public
|
|
1462
|
+
*/
|
|
1463
|
+
LastUpdatedTime?: Date | undefined;
|
|
1464
|
+
/**
|
|
1465
|
+
* <p>The Amazon Resource Name (ARN) of the OAuthClientApplication.</p>
|
|
1466
|
+
* @public
|
|
1467
|
+
*/
|
|
1468
|
+
Arn?: string | undefined;
|
|
1276
1469
|
}
|
|
1277
1470
|
/**
|
|
1278
|
-
* <p>A contributor to an Amazon QuickSight space.</p>
|
|
1279
1471
|
* @public
|
|
1280
1472
|
*/
|
|
1281
|
-
export interface
|
|
1473
|
+
export interface DescribeOAuthClientApplicationResponse {
|
|
1282
1474
|
/**
|
|
1283
|
-
* <p>The
|
|
1475
|
+
* <p>The information about the OAuthClientApplication.</p>
|
|
1284
1476
|
* @public
|
|
1285
1477
|
*/
|
|
1286
|
-
|
|
1478
|
+
OAuthClientApplication?: OAuthClientApplication | undefined;
|
|
1287
1479
|
/**
|
|
1288
|
-
* <p>The
|
|
1480
|
+
* <p>The Amazon Web Services request ID for this operation.</p>
|
|
1289
1481
|
* @public
|
|
1290
1482
|
*/
|
|
1291
|
-
|
|
1483
|
+
RequestId?: string | undefined;
|
|
1292
1484
|
/**
|
|
1293
|
-
* <p>The
|
|
1485
|
+
* <p>The HTTP status of the request.</p>
|
|
1294
1486
|
* @public
|
|
1295
1487
|
*/
|
|
1296
|
-
|
|
1488
|
+
Status?: number | undefined;
|
|
1297
1489
|
}
|
|
1298
1490
|
/**
|
|
1299
|
-
* <p>The details of a QuickSight resource in a space.</p>
|
|
1300
1491
|
* @public
|
|
1301
1492
|
*/
|
|
1302
|
-
export
|
|
1493
|
+
export interface DescribeQPersonalizationConfigurationRequest {
|
|
1494
|
+
/**
|
|
1495
|
+
* <p>The ID of the Amazon Web Services account that contains the personalization configuration that the user wants described.</p>
|
|
1496
|
+
* @public
|
|
1497
|
+
*/
|
|
1498
|
+
AwsAccountId: string | undefined;
|
|
1499
|
+
}
|
|
1303
1500
|
/**
|
|
1304
1501
|
* @public
|
|
1305
1502
|
*/
|
|
1306
|
-
export
|
|
1503
|
+
export interface DescribeQPersonalizationConfigurationResponse {
|
|
1307
1504
|
/**
|
|
1308
|
-
* <p>
|
|
1505
|
+
* <p>A value that indicates whether personalization is enabled or not.</p>
|
|
1309
1506
|
* @public
|
|
1310
1507
|
*/
|
|
1311
|
-
|
|
1312
|
-
resourceArn: string;
|
|
1313
|
-
$unknown?: never;
|
|
1314
|
-
}
|
|
1508
|
+
PersonalizationMode?: PersonalizationMode | undefined;
|
|
1315
1509
|
/**
|
|
1510
|
+
* <p>The Amazon Web Services request ID for this operation.</p>
|
|
1316
1511
|
* @public
|
|
1317
1512
|
*/
|
|
1318
|
-
|
|
1319
|
-
resourceArn?: never;
|
|
1320
|
-
$unknown: [string, any];
|
|
1321
|
-
}
|
|
1513
|
+
RequestId?: string | undefined;
|
|
1322
1514
|
/**
|
|
1323
|
-
*
|
|
1324
|
-
*
|
|
1515
|
+
* <p>The HTTP status of the request.</p>
|
|
1516
|
+
* @public
|
|
1325
1517
|
*/
|
|
1326
|
-
|
|
1327
|
-
resourceArn: (value: string) => T;
|
|
1328
|
-
_: (name: string, value: any) => T;
|
|
1329
|
-
}
|
|
1518
|
+
Status?: number | undefined;
|
|
1330
1519
|
}
|
|
1331
1520
|
/**
|
|
1332
|
-
* <p>A QuickSight resource that is associated with a space.</p>
|
|
1333
1521
|
* @public
|
|
1334
1522
|
*/
|
|
1335
|
-
export interface
|
|
1336
|
-
/**
|
|
1337
|
-
* <p>The type of the QuickSight resource.</p>
|
|
1338
|
-
* @public
|
|
1339
|
-
*/
|
|
1340
|
-
resourceType: SpaceQuickSightResourceType | undefined;
|
|
1523
|
+
export interface DescribeQuickSightQSearchConfigurationRequest {
|
|
1341
1524
|
/**
|
|
1342
|
-
* <p>The
|
|
1525
|
+
* <p>The ID of the Amazon Web Services account that contains the Quick Sight Q Search configuration that the user wants described.</p>
|
|
1343
1526
|
* @public
|
|
1344
1527
|
*/
|
|
1345
|
-
|
|
1528
|
+
AwsAccountId: string | undefined;
|
|
1346
1529
|
}
|
|
1347
1530
|
/**
|
|
1348
|
-
* <p>The details of an Amazon QuickSight space.</p>
|
|
1349
1531
|
* @public
|
|
1350
1532
|
*/
|
|
1351
|
-
export interface
|
|
1533
|
+
export interface DescribeQuickSightQSearchConfigurationResponse {
|
|
1352
1534
|
/**
|
|
1353
|
-
* <p>The
|
|
1535
|
+
* <p>The status of Quick Sight Q Search configuration.</p>
|
|
1354
1536
|
* @public
|
|
1355
1537
|
*/
|
|
1356
|
-
|
|
1538
|
+
QSearchStatus?: QSearchStatus | undefined;
|
|
1357
1539
|
/**
|
|
1358
|
-
* <p>The
|
|
1540
|
+
* <p>The Amazon Web Services request ID for this operation.</p>
|
|
1359
1541
|
* @public
|
|
1360
1542
|
*/
|
|
1361
|
-
|
|
1543
|
+
RequestId?: string | undefined;
|
|
1362
1544
|
/**
|
|
1363
|
-
* <p>The
|
|
1545
|
+
* <p>The HTTP status of the request.</p>
|
|
1364
1546
|
* @public
|
|
1365
1547
|
*/
|
|
1366
|
-
|
|
1548
|
+
Status?: number | undefined;
|
|
1549
|
+
}
|
|
1550
|
+
/**
|
|
1551
|
+
* @public
|
|
1552
|
+
*/
|
|
1553
|
+
export interface DescribeRefreshScheduleRequest {
|
|
1367
1554
|
/**
|
|
1368
|
-
* <p>The
|
|
1555
|
+
* <p>The Amazon Web Services account ID.</p>
|
|
1369
1556
|
* @public
|
|
1370
1557
|
*/
|
|
1371
|
-
|
|
1558
|
+
AwsAccountId: string | undefined;
|
|
1372
1559
|
/**
|
|
1373
|
-
* <p>The
|
|
1560
|
+
* <p>The ID of the dataset.</p>
|
|
1374
1561
|
* @public
|
|
1375
1562
|
*/
|
|
1376
|
-
|
|
1563
|
+
DataSetId: string | undefined;
|
|
1377
1564
|
/**
|
|
1378
|
-
* <p>The
|
|
1565
|
+
* <p>The ID of the refresh schedule.</p>
|
|
1566
|
+
* @public
|
|
1567
|
+
*/
|
|
1568
|
+
ScheduleId: string | undefined;
|
|
1569
|
+
}
|
|
1570
|
+
/**
|
|
1571
|
+
* @public
|
|
1572
|
+
*/
|
|
1573
|
+
export interface DescribeRefreshScheduleResponse {
|
|
1574
|
+
/**
|
|
1575
|
+
* <p>The refresh schedule.</p>
|
|
1576
|
+
* @public
|
|
1577
|
+
*/
|
|
1578
|
+
RefreshSchedule?: RefreshSchedule | undefined;
|
|
1579
|
+
/**
|
|
1580
|
+
* <p>The HTTP status of the request.</p>
|
|
1581
|
+
* @public
|
|
1582
|
+
*/
|
|
1583
|
+
Status?: number | undefined;
|
|
1584
|
+
/**
|
|
1585
|
+
* <p>The Amazon Web Services request ID for this operation.</p>
|
|
1586
|
+
* @public
|
|
1587
|
+
*/
|
|
1588
|
+
RequestId?: string | undefined;
|
|
1589
|
+
/**
|
|
1590
|
+
* <p>The Amazon Resource Name (ARN) for the refresh schedule.</p>
|
|
1591
|
+
* @public
|
|
1592
|
+
*/
|
|
1593
|
+
Arn?: string | undefined;
|
|
1594
|
+
}
|
|
1595
|
+
/**
|
|
1596
|
+
* @public
|
|
1597
|
+
*/
|
|
1598
|
+
export interface DescribeRoleCustomPermissionRequest {
|
|
1599
|
+
/**
|
|
1600
|
+
* <p>The name of the role whose permissions you want described.</p>
|
|
1601
|
+
* @public
|
|
1602
|
+
*/
|
|
1603
|
+
Role: Role | undefined;
|
|
1604
|
+
/**
|
|
1605
|
+
* <p>The ID for the Amazon Web Services account that you want to create a group in. The Amazon Web Services account ID that you provide must be the same Amazon Web Services account that contains your Amazon Quick Sight account.</p>
|
|
1606
|
+
* @public
|
|
1607
|
+
*/
|
|
1608
|
+
AwsAccountId: string | undefined;
|
|
1609
|
+
/**
|
|
1610
|
+
* <p>The namespace that contains the role.</p>
|
|
1611
|
+
* @public
|
|
1612
|
+
*/
|
|
1613
|
+
Namespace: string | undefined;
|
|
1614
|
+
}
|
|
1615
|
+
/**
|
|
1616
|
+
* @public
|
|
1617
|
+
*/
|
|
1618
|
+
export interface DescribeRoleCustomPermissionResponse {
|
|
1619
|
+
/**
|
|
1620
|
+
* <p>The name of the custom permission that is described.</p>
|
|
1621
|
+
* @public
|
|
1622
|
+
*/
|
|
1623
|
+
CustomPermissionsName?: string | undefined;
|
|
1624
|
+
/**
|
|
1625
|
+
* <p>The Amazon Web Services request ID for this operation.</p>
|
|
1626
|
+
* @public
|
|
1627
|
+
*/
|
|
1628
|
+
RequestId?: string | undefined;
|
|
1629
|
+
/**
|
|
1630
|
+
* <p>The HTTP status of the request.</p>
|
|
1631
|
+
* @public
|
|
1632
|
+
*/
|
|
1633
|
+
Status?: number | undefined;
|
|
1634
|
+
}
|
|
1635
|
+
/**
|
|
1636
|
+
* @public
|
|
1637
|
+
*/
|
|
1638
|
+
export interface DescribeSelfUpgradeConfigurationRequest {
|
|
1639
|
+
/**
|
|
1640
|
+
* <p>The ID of the Amazon Web Services account that contains the Quick self-upgrade configuration.</p>
|
|
1641
|
+
* @public
|
|
1642
|
+
*/
|
|
1643
|
+
AwsAccountId: string | undefined;
|
|
1644
|
+
/**
|
|
1645
|
+
* <p>The Quick namespace that you want to describe the Quick self-upgrade configuration for.</p>
|
|
1646
|
+
* @public
|
|
1647
|
+
*/
|
|
1648
|
+
Namespace: string | undefined;
|
|
1649
|
+
}
|
|
1650
|
+
/**
|
|
1651
|
+
* <p>The self-upgrade configuration for the Quick account.</p>
|
|
1652
|
+
* @public
|
|
1653
|
+
*/
|
|
1654
|
+
export interface SelfUpgradeConfiguration {
|
|
1655
|
+
/**
|
|
1656
|
+
* <p>Status set for the self-upgrade configuration for the Quick account. It can contain the following values:</p>
|
|
1657
|
+
* <ul>
|
|
1658
|
+
* <li>
|
|
1659
|
+
* <p>
|
|
1660
|
+
* <code>AUTO_APPROVAL</code>: All the self-upgrade requests will be auto approved.</p>
|
|
1661
|
+
* </li>
|
|
1662
|
+
* <li>
|
|
1663
|
+
* <p>
|
|
1664
|
+
* <code>ADMIN_APPROVAL</code>: All the self-upgrade requests will require admin approval.</p>
|
|
1665
|
+
* </li>
|
|
1666
|
+
* </ul>
|
|
1667
|
+
* @public
|
|
1668
|
+
*/
|
|
1669
|
+
SelfUpgradeStatus?: SelfUpgradeStatus | undefined;
|
|
1670
|
+
}
|
|
1671
|
+
/**
|
|
1672
|
+
* @public
|
|
1673
|
+
*/
|
|
1674
|
+
export interface DescribeSelfUpgradeConfigurationResponse {
|
|
1675
|
+
/**
|
|
1676
|
+
* <p>The self-upgrade configuration for the Quick account.</p>
|
|
1677
|
+
* @public
|
|
1678
|
+
*/
|
|
1679
|
+
SelfUpgradeConfiguration?: SelfUpgradeConfiguration | undefined;
|
|
1680
|
+
/**
|
|
1681
|
+
* <p>The Amazon Web Services request ID for this operation.</p>
|
|
1682
|
+
* @public
|
|
1683
|
+
*/
|
|
1684
|
+
RequestId?: string | undefined;
|
|
1685
|
+
/**
|
|
1686
|
+
* <p>The HTTP status of the request.</p>
|
|
1687
|
+
* @public
|
|
1688
|
+
*/
|
|
1689
|
+
Status?: number | undefined;
|
|
1690
|
+
}
|
|
1691
|
+
/**
|
|
1692
|
+
* @public
|
|
1693
|
+
*/
|
|
1694
|
+
export interface DescribeSpaceRequest {
|
|
1695
|
+
/**
|
|
1696
|
+
* <p>The ID of the Amazon Web Services account that contains the space.</p>
|
|
1697
|
+
* @public
|
|
1698
|
+
*/
|
|
1699
|
+
AwsAccountId: string | undefined;
|
|
1700
|
+
/**
|
|
1701
|
+
* <p>The ID of the space that you want to describe.</p>
|
|
1702
|
+
* @public
|
|
1703
|
+
*/
|
|
1704
|
+
SpaceId: string | undefined;
|
|
1705
|
+
/**
|
|
1706
|
+
* <p>The maximum number of contributors to include in the response.</p>
|
|
1707
|
+
* @public
|
|
1708
|
+
*/
|
|
1709
|
+
MaxContributors?: number | undefined;
|
|
1710
|
+
}
|
|
1711
|
+
/**
|
|
1712
|
+
* <p>A contributor to an Amazon QuickSight space.</p>
|
|
1713
|
+
* @public
|
|
1714
|
+
*/
|
|
1715
|
+
export interface SpaceContributor {
|
|
1716
|
+
/**
|
|
1717
|
+
* <p>The user name of the contributor.</p>
|
|
1718
|
+
* @public
|
|
1719
|
+
*/
|
|
1720
|
+
userName?: string | undefined;
|
|
1721
|
+
/**
|
|
1722
|
+
* <p>The raw file size in bytes contributed by the user.</p>
|
|
1723
|
+
* @public
|
|
1724
|
+
*/
|
|
1725
|
+
rawFileSizeBytes: number | undefined;
|
|
1726
|
+
/**
|
|
1727
|
+
* <p>The percentage of total contributions made by the user.</p>
|
|
1728
|
+
* @public
|
|
1729
|
+
*/
|
|
1730
|
+
percentage?: number | undefined;
|
|
1731
|
+
}
|
|
1732
|
+
/**
|
|
1733
|
+
* <p>The details of a QuickSight resource in a space.</p>
|
|
1734
|
+
* @public
|
|
1735
|
+
*/
|
|
1736
|
+
export type SpaceQuickSightResourceDetails = SpaceQuickSightResourceDetails.ResourceArnMember | SpaceQuickSightResourceDetails.$UnknownMember;
|
|
1737
|
+
/**
|
|
1738
|
+
* @public
|
|
1739
|
+
*/
|
|
1740
|
+
export declare namespace SpaceQuickSightResourceDetails {
|
|
1741
|
+
/**
|
|
1742
|
+
* <p>The ARN of the QuickSight resource.</p>
|
|
1743
|
+
* @public
|
|
1744
|
+
*/
|
|
1745
|
+
interface ResourceArnMember {
|
|
1746
|
+
resourceArn: string;
|
|
1747
|
+
$unknown?: never;
|
|
1748
|
+
}
|
|
1749
|
+
/**
|
|
1750
|
+
* @public
|
|
1751
|
+
*/
|
|
1752
|
+
interface $UnknownMember {
|
|
1753
|
+
resourceArn?: never;
|
|
1754
|
+
$unknown: [string, any];
|
|
1755
|
+
}
|
|
1756
|
+
/**
|
|
1757
|
+
* @deprecated unused in schema-serde mode.
|
|
1758
|
+
*
|
|
1759
|
+
*/
|
|
1760
|
+
interface Visitor<T> {
|
|
1761
|
+
resourceArn: (value: string) => T;
|
|
1762
|
+
_: (name: string, value: any) => T;
|
|
1763
|
+
}
|
|
1764
|
+
}
|
|
1765
|
+
/**
|
|
1766
|
+
* <p>A QuickSight resource that is associated with a space.</p>
|
|
1767
|
+
* @public
|
|
1768
|
+
*/
|
|
1769
|
+
export interface SpaceQuickSightResource {
|
|
1770
|
+
/**
|
|
1771
|
+
* <p>The type of the QuickSight resource.</p>
|
|
1772
|
+
* @public
|
|
1773
|
+
*/
|
|
1774
|
+
resourceType: SpaceQuickSightResourceType | undefined;
|
|
1775
|
+
/**
|
|
1776
|
+
* <p>The details of the QuickSight resource.</p>
|
|
1777
|
+
* @public
|
|
1778
|
+
*/
|
|
1779
|
+
resourceDetails: SpaceQuickSightResourceDetails | undefined;
|
|
1780
|
+
}
|
|
1781
|
+
/**
|
|
1782
|
+
* <p>The details of an Amazon QuickSight space.</p>
|
|
1783
|
+
* @public
|
|
1784
|
+
*/
|
|
1785
|
+
export interface SpaceDetails {
|
|
1786
|
+
/**
|
|
1787
|
+
* <p>The display name of the space.</p>
|
|
1788
|
+
* @public
|
|
1789
|
+
*/
|
|
1790
|
+
name?: string | undefined;
|
|
1791
|
+
/**
|
|
1792
|
+
* <p>The description of the space.</p>
|
|
1793
|
+
* @public
|
|
1794
|
+
*/
|
|
1795
|
+
description?: string | undefined;
|
|
1796
|
+
/**
|
|
1797
|
+
* <p>The resources in the space.</p>
|
|
1798
|
+
* @public
|
|
1799
|
+
*/
|
|
1800
|
+
resources?: SpaceQuickSightResource[] | undefined;
|
|
1801
|
+
/**
|
|
1802
|
+
* <p>The date and time that the space was created.</p>
|
|
1803
|
+
* @public
|
|
1804
|
+
*/
|
|
1805
|
+
createdAt?: Date | undefined;
|
|
1806
|
+
/**
|
|
1807
|
+
* <p>The date and time that the space was last updated.</p>
|
|
1808
|
+
* @public
|
|
1809
|
+
*/
|
|
1810
|
+
updatedAt?: Date | undefined;
|
|
1811
|
+
/**
|
|
1812
|
+
* <p>The total consumed source size in bytes.</p>
|
|
1379
1813
|
* @public
|
|
1380
1814
|
*/
|
|
1381
1815
|
consumedSourceSize?: number | undefined;
|
|
@@ -3986,24 +4420,127 @@ export interface IAMPolicyAssignmentSummary {
|
|
|
3986
4420
|
AssignmentStatus?: AssignmentStatus | undefined;
|
|
3987
4421
|
}
|
|
3988
4422
|
/**
|
|
4423
|
+
* <p>A filter to apply when searching knowledge bases.</p>
|
|
3989
4424
|
* @public
|
|
3990
4425
|
*/
|
|
3991
|
-
export interface
|
|
4426
|
+
export interface KnowledgeBaseSearchFilter {
|
|
3992
4427
|
/**
|
|
3993
|
-
* <p>The
|
|
4428
|
+
* <p>The name of the field to filter on.</p>
|
|
3994
4429
|
* @public
|
|
3995
4430
|
*/
|
|
3996
|
-
|
|
4431
|
+
name: KnowledgeBaseSearchFilterName | undefined;
|
|
3997
4432
|
/**
|
|
3998
|
-
* <p>The
|
|
4433
|
+
* <p>The comparison operator to use for the filter.</p>
|
|
3999
4434
|
* @public
|
|
4000
4435
|
*/
|
|
4001
|
-
|
|
4436
|
+
operator: KnowledgeBaseSearchOperator | undefined;
|
|
4002
4437
|
/**
|
|
4003
|
-
* <p>
|
|
4438
|
+
* <p>The value to filter on.</p>
|
|
4004
4439
|
* @public
|
|
4005
4440
|
*/
|
|
4006
|
-
|
|
4441
|
+
value: string | undefined;
|
|
4442
|
+
}
|
|
4443
|
+
/**
|
|
4444
|
+
* <p>The sort configuration for searching knowledge bases.</p>
|
|
4445
|
+
* @public
|
|
4446
|
+
*/
|
|
4447
|
+
export interface KnowledgeBaseSortBy {
|
|
4448
|
+
/**
|
|
4449
|
+
* <p>The field to sort by.</p>
|
|
4450
|
+
* @public
|
|
4451
|
+
*/
|
|
4452
|
+
sortByField: KnowledgeBaseSortByField | undefined;
|
|
4453
|
+
/**
|
|
4454
|
+
* <p>The sort order (ascending or descending).</p>
|
|
4455
|
+
* @public
|
|
4456
|
+
*/
|
|
4457
|
+
sortOrder: SortOrder | undefined;
|
|
4458
|
+
}
|
|
4459
|
+
/**
|
|
4460
|
+
* <p>A summary of a knowledge base, including its identifier, name, status, and metadata.</p>
|
|
4461
|
+
* @public
|
|
4462
|
+
*/
|
|
4463
|
+
export interface KnowledgeBaseSummary {
|
|
4464
|
+
/**
|
|
4465
|
+
* <p>The Amazon Resource Name (ARN) of the knowledge base.</p>
|
|
4466
|
+
* @public
|
|
4467
|
+
*/
|
|
4468
|
+
KnowledgeBaseArn: string | undefined;
|
|
4469
|
+
/**
|
|
4470
|
+
* <p>The unique identifier for the knowledge base.</p>
|
|
4471
|
+
* @public
|
|
4472
|
+
*/
|
|
4473
|
+
KnowledgeBaseId: string | undefined;
|
|
4474
|
+
/**
|
|
4475
|
+
* <p>The name of the knowledge base.</p>
|
|
4476
|
+
* @public
|
|
4477
|
+
*/
|
|
4478
|
+
Name: string | undefined;
|
|
4479
|
+
/**
|
|
4480
|
+
* <p>The status of the knowledge base.</p>
|
|
4481
|
+
* @public
|
|
4482
|
+
*/
|
|
4483
|
+
Status: DataSetStatus | undefined;
|
|
4484
|
+
/**
|
|
4485
|
+
* <p>The ARN of the data source associated with the knowledge base.</p>
|
|
4486
|
+
* @public
|
|
4487
|
+
*/
|
|
4488
|
+
DataSourceArn: string | undefined;
|
|
4489
|
+
/**
|
|
4490
|
+
* <p>The type of the knowledge base.</p>
|
|
4491
|
+
* @public
|
|
4492
|
+
*/
|
|
4493
|
+
Type?: string | undefined;
|
|
4494
|
+
/**
|
|
4495
|
+
* <p>The date and time that the knowledge base was created.</p>
|
|
4496
|
+
* @public
|
|
4497
|
+
*/
|
|
4498
|
+
CreatedAt?: Date | undefined;
|
|
4499
|
+
/**
|
|
4500
|
+
* <p>The date and time that the knowledge base was last updated.</p>
|
|
4501
|
+
* @public
|
|
4502
|
+
*/
|
|
4503
|
+
UpdatedAt?: Date | undefined;
|
|
4504
|
+
/**
|
|
4505
|
+
* <p>The size of the knowledge base in bytes.</p>
|
|
4506
|
+
* @public
|
|
4507
|
+
*/
|
|
4508
|
+
KnowledgeBaseSizeBytes?: number | undefined;
|
|
4509
|
+
/**
|
|
4510
|
+
* <p>The number of documents in the knowledge base.</p>
|
|
4511
|
+
* @public
|
|
4512
|
+
*/
|
|
4513
|
+
DocumentCount?: number | undefined;
|
|
4514
|
+
/**
|
|
4515
|
+
* <p>The ARN of the primary owner of the knowledge base.</p>
|
|
4516
|
+
* @public
|
|
4517
|
+
*/
|
|
4518
|
+
PrimaryOwnerArn?: string | undefined;
|
|
4519
|
+
/**
|
|
4520
|
+
* <p>The username of the primary owner of the knowledge base.</p>
|
|
4521
|
+
* @public
|
|
4522
|
+
*/
|
|
4523
|
+
PrimaryOwnerUsername?: string | undefined;
|
|
4524
|
+
}
|
|
4525
|
+
/**
|
|
4526
|
+
* @public
|
|
4527
|
+
*/
|
|
4528
|
+
export interface ListActionConnectorsRequest {
|
|
4529
|
+
/**
|
|
4530
|
+
* <p>The Amazon Web Services account ID for which to list action connectors.</p>
|
|
4531
|
+
* @public
|
|
4532
|
+
*/
|
|
4533
|
+
AwsAccountId: string | undefined;
|
|
4534
|
+
/**
|
|
4535
|
+
* <p>The maximum number of action connectors to return in a single response. Valid range is 1 to 100.</p>
|
|
4536
|
+
* @public
|
|
4537
|
+
*/
|
|
4538
|
+
MaxResults?: number | undefined;
|
|
4539
|
+
/**
|
|
4540
|
+
* <p>A pagination token to retrieve the next set of results. Use the token returned from a previous call to continue listing action connectors.</p>
|
|
4541
|
+
* @public
|
|
4542
|
+
*/
|
|
4543
|
+
NextToken?: string | undefined;
|
|
4007
4544
|
}
|
|
4008
4545
|
/**
|
|
4009
4546
|
* @public
|
|
@@ -4978,6 +5515,51 @@ export interface ListIngestionsResponse {
|
|
|
4978
5515
|
*/
|
|
4979
5516
|
Status?: number | undefined;
|
|
4980
5517
|
}
|
|
5518
|
+
/**
|
|
5519
|
+
* @public
|
|
5520
|
+
*/
|
|
5521
|
+
export interface ListKnowledgeBasesRequest {
|
|
5522
|
+
/**
|
|
5523
|
+
* <p>The ID of the Amazon Web Services account that contains the knowledge base.</p>
|
|
5524
|
+
* @public
|
|
5525
|
+
*/
|
|
5526
|
+
AwsAccountId: string | undefined;
|
|
5527
|
+
/**
|
|
5528
|
+
* <p>The maximum number of results to return.</p>
|
|
5529
|
+
* @public
|
|
5530
|
+
*/
|
|
5531
|
+
MaxResults?: number | undefined;
|
|
5532
|
+
/**
|
|
5533
|
+
* <p>The token for the next set of results, or null if there are no more results.</p>
|
|
5534
|
+
* @public
|
|
5535
|
+
*/
|
|
5536
|
+
NextToken?: string | undefined;
|
|
5537
|
+
}
|
|
5538
|
+
/**
|
|
5539
|
+
* @public
|
|
5540
|
+
*/
|
|
5541
|
+
export interface ListKnowledgeBasesResponse {
|
|
5542
|
+
/**
|
|
5543
|
+
* <p>A list of knowledge base summaries.</p>
|
|
5544
|
+
* @public
|
|
5545
|
+
*/
|
|
5546
|
+
KnowledgeBaseSummaries: KnowledgeBaseSummary[] | undefined;
|
|
5547
|
+
/**
|
|
5548
|
+
* <p>The token for the next set of results, or null if there are no more results.</p>
|
|
5549
|
+
* @public
|
|
5550
|
+
*/
|
|
5551
|
+
NextToken?: string | undefined;
|
|
5552
|
+
/**
|
|
5553
|
+
* <p>The Amazon Web Services request ID for this operation.</p>
|
|
5554
|
+
* @public
|
|
5555
|
+
*/
|
|
5556
|
+
RequestId?: string | undefined;
|
|
5557
|
+
/**
|
|
5558
|
+
* <p>The HTTP status of the request.</p>
|
|
5559
|
+
* @public
|
|
5560
|
+
*/
|
|
5561
|
+
Status?: number | undefined;
|
|
5562
|
+
}
|
|
4981
5563
|
/**
|
|
4982
5564
|
* @public
|
|
4983
5565
|
*/
|
|
@@ -6225,6 +6807,173 @@ export interface ListUsersResponse {
|
|
|
6225
6807
|
*/
|
|
6226
6808
|
Status?: number | undefined;
|
|
6227
6809
|
}
|
|
6810
|
+
/**
|
|
6811
|
+
* <p>A filter that matches users by username or email prefix.</p>
|
|
6812
|
+
* @public
|
|
6813
|
+
*/
|
|
6814
|
+
export interface UserNameOrEmailFilter {
|
|
6815
|
+
/**
|
|
6816
|
+
* <p>The prefix to match against username or email (starts-with match).</p>
|
|
6817
|
+
* @public
|
|
6818
|
+
*/
|
|
6819
|
+
prefix: string | undefined;
|
|
6820
|
+
}
|
|
6821
|
+
/**
|
|
6822
|
+
* <p>A filter for user index capacity queries. Only one filter type can be specified per request.</p>
|
|
6823
|
+
* @public
|
|
6824
|
+
*/
|
|
6825
|
+
export type UserIndexCapacityFilter = UserIndexCapacityFilter.TotalCapacityBytesMember | UserIndexCapacityFilter.UserNameOrEmailMember | UserIndexCapacityFilter.$UnknownMember;
|
|
6826
|
+
/**
|
|
6827
|
+
* @public
|
|
6828
|
+
*/
|
|
6829
|
+
export declare namespace UserIndexCapacityFilter {
|
|
6830
|
+
/**
|
|
6831
|
+
* <p>Filter users by username or email prefix.</p>
|
|
6832
|
+
* @public
|
|
6833
|
+
*/
|
|
6834
|
+
interface UserNameOrEmailMember {
|
|
6835
|
+
userNameOrEmail: UserNameOrEmailFilter;
|
|
6836
|
+
totalCapacityBytes?: never;
|
|
6837
|
+
$unknown?: never;
|
|
6838
|
+
}
|
|
6839
|
+
/**
|
|
6840
|
+
* <p>Filter users by total capacity range in bytes.</p>
|
|
6841
|
+
* @public
|
|
6842
|
+
*/
|
|
6843
|
+
interface TotalCapacityBytesMember {
|
|
6844
|
+
userNameOrEmail?: never;
|
|
6845
|
+
totalCapacityBytes: CapacityBytesRangeFilter;
|
|
6846
|
+
$unknown?: never;
|
|
6847
|
+
}
|
|
6848
|
+
/**
|
|
6849
|
+
* @public
|
|
6850
|
+
*/
|
|
6851
|
+
interface $UnknownMember {
|
|
6852
|
+
userNameOrEmail?: never;
|
|
6853
|
+
totalCapacityBytes?: never;
|
|
6854
|
+
$unknown: [string, any];
|
|
6855
|
+
}
|
|
6856
|
+
/**
|
|
6857
|
+
* @deprecated unused in schema-serde mode.
|
|
6858
|
+
*
|
|
6859
|
+
*/
|
|
6860
|
+
interface Visitor<T> {
|
|
6861
|
+
userNameOrEmail: (value: UserNameOrEmailFilter) => T;
|
|
6862
|
+
totalCapacityBytes: (value: CapacityBytesRangeFilter) => T;
|
|
6863
|
+
_: (name: string, value: any) => T;
|
|
6864
|
+
}
|
|
6865
|
+
}
|
|
6866
|
+
/**
|
|
6867
|
+
* @public
|
|
6868
|
+
*/
|
|
6869
|
+
export interface ListUsersIndexCapacityRequest {
|
|
6870
|
+
/**
|
|
6871
|
+
* <p>The ID of the Amazon Web Services account that contains the index capacity data.</p>
|
|
6872
|
+
* @public
|
|
6873
|
+
*/
|
|
6874
|
+
awsAccountId: string | undefined;
|
|
6875
|
+
/**
|
|
6876
|
+
* <p>The namespace to scope the user search to. Required when the userNameOrEmail filter is present.</p>
|
|
6877
|
+
* @public
|
|
6878
|
+
*/
|
|
6879
|
+
namespace?: string | undefined;
|
|
6880
|
+
/**
|
|
6881
|
+
* <p>Filters to apply. Only one filter is supported per request. The userNameOrEmail and totalCapacityBytes filters are mutually exclusive.</p>
|
|
6882
|
+
* @public
|
|
6883
|
+
*/
|
|
6884
|
+
filters?: UserIndexCapacityFilter[] | undefined;
|
|
6885
|
+
/**
|
|
6886
|
+
* <p>The field to sort results by.</p>
|
|
6887
|
+
* @public
|
|
6888
|
+
*/
|
|
6889
|
+
sortBy?: UserIndexCapacitySortBy | undefined;
|
|
6890
|
+
/**
|
|
6891
|
+
* <p>The sort order for results. Defaults to DESC if not specified.</p>
|
|
6892
|
+
* @public
|
|
6893
|
+
*/
|
|
6894
|
+
sortOrder?: UserIndexCapacitySortOrder | undefined;
|
|
6895
|
+
/**
|
|
6896
|
+
* <p>The maximum number of results to return per page.</p>
|
|
6897
|
+
* @public
|
|
6898
|
+
*/
|
|
6899
|
+
maxResults?: number | undefined;
|
|
6900
|
+
/**
|
|
6901
|
+
* <p>The token for the next set of results, received from a previous call.</p>
|
|
6902
|
+
* @public
|
|
6903
|
+
*/
|
|
6904
|
+
nextToken?: string | undefined;
|
|
6905
|
+
}
|
|
6906
|
+
/**
|
|
6907
|
+
* <p>A summary of a user's index capacity consumption.</p>
|
|
6908
|
+
* @public
|
|
6909
|
+
*/
|
|
6910
|
+
export interface UserIndexCapacity {
|
|
6911
|
+
/**
|
|
6912
|
+
* <p>The ARN of the user.</p>
|
|
6913
|
+
* @public
|
|
6914
|
+
*/
|
|
6915
|
+
userArn?: string | undefined;
|
|
6916
|
+
/**
|
|
6917
|
+
* <p>The username of the user.</p>
|
|
6918
|
+
* @public
|
|
6919
|
+
*/
|
|
6920
|
+
userName?: string | undefined;
|
|
6921
|
+
/**
|
|
6922
|
+
* <p>The email address of the user.</p>
|
|
6923
|
+
* @public
|
|
6924
|
+
*/
|
|
6925
|
+
email?: string | undefined;
|
|
6926
|
+
/**
|
|
6927
|
+
* <p>The role of the user.</p>
|
|
6928
|
+
* @public
|
|
6929
|
+
*/
|
|
6930
|
+
role?: string | undefined;
|
|
6931
|
+
/**
|
|
6932
|
+
* <p>The total index capacity consumed by the user in bytes.</p>
|
|
6933
|
+
* @public
|
|
6934
|
+
*/
|
|
6935
|
+
totalCapacityBytes?: number | undefined;
|
|
6936
|
+
/**
|
|
6937
|
+
* <p>The total index capacity consumed by the user's knowledge bases in bytes.</p>
|
|
6938
|
+
* @public
|
|
6939
|
+
*/
|
|
6940
|
+
totalKBCapacityBytes?: number | undefined;
|
|
6941
|
+
/**
|
|
6942
|
+
* <p>The total index capacity consumed by the user's spaces in bytes.</p>
|
|
6943
|
+
* @public
|
|
6944
|
+
*/
|
|
6945
|
+
totalSpaceCapacityBytes?: number | undefined;
|
|
6946
|
+
/**
|
|
6947
|
+
* <p>The number of knowledge bases owned by the user.</p>
|
|
6948
|
+
* @public
|
|
6949
|
+
*/
|
|
6950
|
+
kbCount?: number | undefined;
|
|
6951
|
+
/**
|
|
6952
|
+
* <p>The number of spaces owned by the user.</p>
|
|
6953
|
+
* @public
|
|
6954
|
+
*/
|
|
6955
|
+
spaceCount?: number | undefined;
|
|
6956
|
+
}
|
|
6957
|
+
/**
|
|
6958
|
+
* @public
|
|
6959
|
+
*/
|
|
6960
|
+
export interface ListUsersIndexCapacityResponse {
|
|
6961
|
+
/**
|
|
6962
|
+
* <p>The list of users with their index capacity metrics.</p>
|
|
6963
|
+
* @public
|
|
6964
|
+
*/
|
|
6965
|
+
users?: UserIndexCapacity[] | undefined;
|
|
6966
|
+
/**
|
|
6967
|
+
* <p>The token for the next set of results, or null if there are no more results.</p>
|
|
6968
|
+
* @public
|
|
6969
|
+
*/
|
|
6970
|
+
nextToken?: string | undefined;
|
|
6971
|
+
/**
|
|
6972
|
+
* <p>The Amazon Web Services request ID for this operation.</p>
|
|
6973
|
+
* @public
|
|
6974
|
+
*/
|
|
6975
|
+
requestId?: string | undefined;
|
|
6976
|
+
}
|
|
6228
6977
|
/**
|
|
6229
6978
|
* @public
|
|
6230
6979
|
*/
|
|
@@ -6863,1024 +7612,221 @@ export interface SearchDashboardsRequest {
|
|
|
6863
7612
|
* <p>The maximum number of results to be returned per request.</p>
|
|
6864
7613
|
* @public
|
|
6865
7614
|
*/
|
|
6866
|
-
MaxResults?: number | undefined;
|
|
6867
|
-
}
|
|
6868
|
-
/**
|
|
6869
|
-
* @public
|
|
6870
|
-
*/
|
|
6871
|
-
export interface SearchDashboardsResponse {
|
|
6872
|
-
/**
|
|
6873
|
-
* <p>The list of dashboards owned by the user specified in <code>Filters</code> in your
|
|
6874
|
-
* request.</p>
|
|
6875
|
-
* @public
|
|
6876
|
-
*/
|
|
6877
|
-
DashboardSummaryList?: DashboardSummary[] | undefined;
|
|
6878
|
-
/**
|
|
6879
|
-
* <p>The token for the next set of results, or null if there are no more results.</p>
|
|
6880
|
-
* @public
|
|
6881
|
-
*/
|
|
6882
|
-
NextToken?: string | undefined;
|
|
6883
|
-
/**
|
|
6884
|
-
* <p>The HTTP status of the request.</p>
|
|
6885
|
-
* @public
|
|
6886
|
-
*/
|
|
6887
|
-
Status?: number | undefined;
|
|
6888
|
-
/**
|
|
6889
|
-
* <p>The Amazon Web Services request ID for this operation.</p>
|
|
6890
|
-
* @public
|
|
6891
|
-
*/
|
|
6892
|
-
RequestId?: string | undefined;
|
|
6893
|
-
}
|
|
6894
|
-
/**
|
|
6895
|
-
* @public
|
|
6896
|
-
*/
|
|
6897
|
-
export interface SearchDataSetsRequest {
|
|
6898
|
-
/**
|
|
6899
|
-
* <p>The Amazon Web Services account ID.</p>
|
|
6900
|
-
* @public
|
|
6901
|
-
*/
|
|
6902
|
-
AwsAccountId: string | undefined;
|
|
6903
|
-
/**
|
|
6904
|
-
* <p>The filters to apply to the search.</p>
|
|
6905
|
-
* @public
|
|
6906
|
-
*/
|
|
6907
|
-
Filters: DataSetSearchFilter[] | undefined;
|
|
6908
|
-
/**
|
|
6909
|
-
* <p>A pagination token that can be used in a subsequent request.</p>
|
|
6910
|
-
* @public
|
|
6911
|
-
*/
|
|
6912
|
-
NextToken?: string | undefined;
|
|
6913
|
-
/**
|
|
6914
|
-
* <p>The maximum number of results to be returned per request.</p>
|
|
6915
|
-
* @public
|
|
6916
|
-
*/
|
|
6917
|
-
MaxResults?: number | undefined;
|
|
6918
|
-
}
|
|
6919
|
-
/**
|
|
6920
|
-
* @public
|
|
6921
|
-
*/
|
|
6922
|
-
export interface SearchDataSetsResponse {
|
|
6923
|
-
/**
|
|
6924
|
-
* <p>A <code>DataSetSummaries</code> object that returns a summary of a dataset.</p>
|
|
6925
|
-
* @public
|
|
6926
|
-
*/
|
|
6927
|
-
DataSetSummaries?: DataSetSummary[] | undefined;
|
|
6928
|
-
/**
|
|
6929
|
-
* <p>A pagination token that can be used in a subsequent request.</p>
|
|
6930
|
-
* @public
|
|
6931
|
-
*/
|
|
6932
|
-
NextToken?: string | undefined;
|
|
6933
|
-
/**
|
|
6934
|
-
* <p>The HTTP status of the request.</p>
|
|
6935
|
-
* @public
|
|
6936
|
-
*/
|
|
6937
|
-
Status?: number | undefined;
|
|
6938
|
-
/**
|
|
6939
|
-
* <p>The Amazon Web Services request ID for this operation.</p>
|
|
6940
|
-
* @public
|
|
6941
|
-
*/
|
|
6942
|
-
RequestId?: string | undefined;
|
|
6943
|
-
}
|
|
6944
|
-
/**
|
|
6945
|
-
* @public
|
|
6946
|
-
*/
|
|
6947
|
-
export interface SearchDataSourcesRequest {
|
|
6948
|
-
/**
|
|
6949
|
-
* <p>The Amazon Web Services account ID.</p>
|
|
6950
|
-
* @public
|
|
6951
|
-
*/
|
|
6952
|
-
AwsAccountId: string | undefined;
|
|
6953
|
-
/**
|
|
6954
|
-
* <p>The filters to apply to the search.</p>
|
|
6955
|
-
* @public
|
|
6956
|
-
*/
|
|
6957
|
-
Filters: DataSourceSearchFilter[] | undefined;
|
|
6958
|
-
/**
|
|
6959
|
-
* <p>A pagination token that can be used in a subsequent request.</p>
|
|
6960
|
-
* @public
|
|
6961
|
-
*/
|
|
6962
|
-
NextToken?: string | undefined;
|
|
6963
|
-
/**
|
|
6964
|
-
* <p>The maximum number of results to be returned per request.</p>
|
|
6965
|
-
* @public
|
|
6966
|
-
*/
|
|
6967
|
-
MaxResults?: number | undefined;
|
|
6968
|
-
}
|
|
6969
|
-
/**
|
|
6970
|
-
* @public
|
|
6971
|
-
*/
|
|
6972
|
-
export interface SearchDataSourcesResponse {
|
|
6973
|
-
/**
|
|
6974
|
-
* <p>A <code>DataSourceSummaries</code> object that returns a summary of a data
|
|
6975
|
-
* source.</p>
|
|
6976
|
-
* @public
|
|
6977
|
-
*/
|
|
6978
|
-
DataSourceSummaries?: DataSourceSummary[] | undefined;
|
|
6979
|
-
/**
|
|
6980
|
-
* <p>A pagination token that can be used in a subsequent request.</p>
|
|
6981
|
-
* @public
|
|
6982
|
-
*/
|
|
6983
|
-
NextToken?: string | undefined;
|
|
6984
|
-
/**
|
|
6985
|
-
* <p>The HTTP status of the request.</p>
|
|
6986
|
-
* @public
|
|
6987
|
-
*/
|
|
6988
|
-
Status?: number | undefined;
|
|
6989
|
-
/**
|
|
6990
|
-
* <p>The Amazon Web Services request ID for this operation.</p>
|
|
6991
|
-
* @public
|
|
6992
|
-
*/
|
|
6993
|
-
RequestId?: string | undefined;
|
|
6994
|
-
}
|
|
6995
|
-
/**
|
|
6996
|
-
* <p>A structure that contains the filter information when searching flows.</p>
|
|
6997
|
-
* @public
|
|
6998
|
-
*/
|
|
6999
|
-
export interface SearchFlowsFilter {
|
|
7000
|
-
/**
|
|
7001
|
-
* <p>The name of the value that you want to use as a filter, for example <code>"Name":
|
|
7002
|
-
* "DIRECT_QUICKSIGHT_SOLE_OWNER"</code>.</p>
|
|
7003
|
-
* <p>Valid values are defined as follows:</p>
|
|
7004
|
-
* <ul>
|
|
7005
|
-
* <li>
|
|
7006
|
-
* <p>
|
|
7007
|
-
* <code>assetName</code>: Any flows whose names have a substring match to this value will be returned.</p>
|
|
7008
|
-
* </li>
|
|
7009
|
-
* <li>
|
|
7010
|
-
* <p>
|
|
7011
|
-
* <code>assetDescription</code>: Any flows whose descriptions have a substring match to this value will be returned.</p>
|
|
7012
|
-
* </li>
|
|
7013
|
-
* <li>
|
|
7014
|
-
* <p>
|
|
7015
|
-
* <code>DIRECT_QUICKSIGHT_SOLE_OWNER</code>: Provide an ARN of a user or group, and any analyses with that ARN listed as the only owner of the analysis are returned. Implicit permissions from folders or groups are not considered.</p>
|
|
7016
|
-
* </li>
|
|
7017
|
-
* <li>
|
|
7018
|
-
* <p>
|
|
7019
|
-
* <code>DIRECT_QUICKSIGHT_OWNER</code>: Provide an ARN of a user or group, and any analyses with that ARN listed as one of the owners of the analyses are returned. Implicit permissions from folders or groups are not considered.</p>
|
|
7020
|
-
* </li>
|
|
7021
|
-
* <li>
|
|
7022
|
-
* <p>
|
|
7023
|
-
* <code>DIRECT_QUICKSIGHT_VIEWER_OR_OWNER</code>: Provide an ARN of a user or group, and any analyses with that ARN listed as one of the owners or viewers of the analyses are returned. Implicit permissions from folders or groups are not considered. </p>
|
|
7024
|
-
* </li>
|
|
7025
|
-
* </ul>
|
|
7026
|
-
* @public
|
|
7027
|
-
*/
|
|
7028
|
-
Name: FieldName | undefined;
|
|
7029
|
-
/**
|
|
7030
|
-
* <p>The comparison operator that you want to use as a filter, for example <code>"Operator": "StringEquals"</code>. Valid values are <code>"StringEquals"</code> and <code>"StringLike"</code>.</p>
|
|
7031
|
-
* @public
|
|
7032
|
-
*/
|
|
7033
|
-
Operator: SearchFilterOperator | undefined;
|
|
7034
|
-
/**
|
|
7035
|
-
* <p>The value of the named item, in this case <code>DIRECT_QUICKSIGHT_SOLE_OWNER</code>, that you want
|
|
7036
|
-
* to use as a filter, for example <code>"Value"</code>. An example is
|
|
7037
|
-
* <code>"arn:aws:quicksight:us-east-1:1:user/default/UserName1"</code>.</p>
|
|
7038
|
-
* @public
|
|
7039
|
-
*/
|
|
7040
|
-
Value: string | undefined;
|
|
7041
|
-
}
|
|
7042
|
-
/**
|
|
7043
|
-
* @public
|
|
7044
|
-
*/
|
|
7045
|
-
export interface SearchFlowsInput {
|
|
7046
|
-
/**
|
|
7047
|
-
* <p>The ID of the Amazon Web Services account where you are searching for flows from.</p>
|
|
7048
|
-
* @public
|
|
7049
|
-
*/
|
|
7050
|
-
AwsAccountId: string | undefined;
|
|
7051
|
-
/**
|
|
7052
|
-
* <p>The filters applied to the search when searching for flows in the Amazon Web Services account.</p>
|
|
7053
|
-
* @public
|
|
7054
|
-
*/
|
|
7055
|
-
Filters: SearchFlowsFilter[] | undefined;
|
|
7056
|
-
/**
|
|
7057
|
-
* <p>The token to request the next set of results, or null if you want to retrieve the first set.</p>
|
|
7058
|
-
* @public
|
|
7059
|
-
*/
|
|
7060
|
-
NextToken?: string | undefined;
|
|
7061
|
-
/**
|
|
7062
|
-
* <p>The maximum number of results to be returned per request.</p>
|
|
7063
|
-
* @public
|
|
7064
|
-
*/
|
|
7065
|
-
MaxResults?: number | undefined;
|
|
7066
|
-
}
|
|
7067
|
-
/**
|
|
7068
|
-
* @public
|
|
7069
|
-
*/
|
|
7070
|
-
export interface SearchFlowsOutput {
|
|
7071
|
-
/**
|
|
7072
|
-
* <p>The list of flows found against the search.</p>
|
|
7073
|
-
* @public
|
|
7074
|
-
*/
|
|
7075
|
-
FlowSummaryList: FlowSummary[] | undefined;
|
|
7076
|
-
/**
|
|
7077
|
-
* <p>The token for the next set of results, or null if there are no more results.</p>
|
|
7078
|
-
* @public
|
|
7079
|
-
*/
|
|
7080
|
-
NextToken?: string | undefined;
|
|
7081
|
-
/**
|
|
7082
|
-
* <p>The Amazon Web Services request ID for this operation.</p>
|
|
7083
|
-
* @public
|
|
7084
|
-
*/
|
|
7085
|
-
RequestId?: string | undefined;
|
|
7086
|
-
/**
|
|
7087
|
-
* <p>The HTTP status of the request.</p>
|
|
7088
|
-
* @public
|
|
7089
|
-
*/
|
|
7090
|
-
Status?: number | undefined;
|
|
7091
|
-
}
|
|
7092
|
-
/**
|
|
7093
|
-
* @public
|
|
7094
|
-
*/
|
|
7095
|
-
export interface SearchFoldersRequest {
|
|
7096
|
-
/**
|
|
7097
|
-
* <p>The ID for the Amazon Web Services account that contains the folder.</p>
|
|
7098
|
-
* @public
|
|
7099
|
-
*/
|
|
7100
|
-
AwsAccountId: string | undefined;
|
|
7101
|
-
/**
|
|
7102
|
-
* <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>
|
|
7103
|
-
* @public
|
|
7104
|
-
*/
|
|
7105
|
-
Filters: FolderSearchFilter[] | undefined;
|
|
7106
|
-
/**
|
|
7107
|
-
* <p>The token for the next set of results, or null if there are no more results.</p>
|
|
7108
|
-
* @public
|
|
7109
|
-
*/
|
|
7110
|
-
NextToken?: string | undefined;
|
|
7111
|
-
/**
|
|
7112
|
-
* <p>The maximum number of results to be returned per request.</p>
|
|
7113
|
-
* @public
|
|
7114
|
-
*/
|
|
7115
|
-
MaxResults?: number | undefined;
|
|
7116
|
-
}
|
|
7117
|
-
/**
|
|
7118
|
-
* @public
|
|
7119
|
-
*/
|
|
7120
|
-
export interface SearchFoldersResponse {
|
|
7121
|
-
/**
|
|
7122
|
-
* <p>The HTTP status of the request.</p>
|
|
7123
|
-
* @public
|
|
7124
|
-
*/
|
|
7125
|
-
Status?: number | undefined;
|
|
7126
|
-
/**
|
|
7127
|
-
* <p>A structure that contains all of the folders in the Amazon Web Services account. This structure provides basic information about the folders.</p>
|
|
7128
|
-
* @public
|
|
7129
|
-
*/
|
|
7130
|
-
FolderSummaryList?: FolderSummary[] | undefined;
|
|
7131
|
-
/**
|
|
7132
|
-
* <p>The token for the next set of results, or null if there are no more results.</p>
|
|
7133
|
-
* @public
|
|
7134
|
-
*/
|
|
7135
|
-
NextToken?: string | undefined;
|
|
7136
|
-
/**
|
|
7137
|
-
* <p>The Amazon Web Services request ID for this operation.</p>
|
|
7138
|
-
* @public
|
|
7139
|
-
*/
|
|
7140
|
-
RequestId?: string | undefined;
|
|
7141
|
-
}
|
|
7142
|
-
/**
|
|
7143
|
-
* @public
|
|
7144
|
-
*/
|
|
7145
|
-
export interface SearchGroupsRequest {
|
|
7146
|
-
/**
|
|
7147
|
-
* <p>The ID for the Amazon Web Services account that the group is in. Currently, you use the ID for the
|
|
7148
|
-
* Amazon Web Services account that contains your Amazon Quick Sight account.</p>
|
|
7149
|
-
* @public
|
|
7150
|
-
*/
|
|
7151
|
-
AwsAccountId: string | undefined;
|
|
7152
|
-
/**
|
|
7153
|
-
* <p>A pagination token that can be used in a subsequent request.</p>
|
|
7154
|
-
* @public
|
|
7155
|
-
*/
|
|
7156
|
-
NextToken?: string | undefined;
|
|
7157
|
-
/**
|
|
7158
|
-
* <p>The maximum number of results to return from this request.</p>
|
|
7159
|
-
* @public
|
|
7160
|
-
*/
|
|
7161
|
-
MaxResults?: number | undefined;
|
|
7162
|
-
/**
|
|
7163
|
-
* <p>The namespace that you want to search.</p>
|
|
7164
|
-
* @public
|
|
7165
|
-
*/
|
|
7166
|
-
Namespace: string | undefined;
|
|
7167
|
-
/**
|
|
7168
|
-
* <p>The structure for the search filters that you want to apply to your search.</p>
|
|
7169
|
-
* @public
|
|
7170
|
-
*/
|
|
7171
|
-
Filters: GroupSearchFilter[] | undefined;
|
|
7172
|
-
}
|
|
7173
|
-
/**
|
|
7174
|
-
* @public
|
|
7175
|
-
*/
|
|
7176
|
-
export interface SearchGroupsResponse {
|
|
7177
|
-
/**
|
|
7178
|
-
* <p>A list of groups in a specified namespace that match the filters you set in your <code>SearchGroups</code> request.</p>
|
|
7179
|
-
* @public
|
|
7180
|
-
*/
|
|
7181
|
-
GroupList?: Group[] | undefined;
|
|
7182
|
-
/**
|
|
7183
|
-
* <p>A pagination token that can be used in a subsequent request.</p>
|
|
7184
|
-
* @public
|
|
7185
|
-
*/
|
|
7186
|
-
NextToken?: string | undefined;
|
|
7187
|
-
/**
|
|
7188
|
-
* <p>The Amazon Web Services request ID for this operation.</p>
|
|
7189
|
-
* @public
|
|
7190
|
-
*/
|
|
7191
|
-
RequestId?: string | undefined;
|
|
7192
|
-
/**
|
|
7193
|
-
* <p>The HTTP status of the request.</p>
|
|
7194
|
-
* @public
|
|
7195
|
-
*/
|
|
7196
|
-
Status?: number | undefined;
|
|
7197
|
-
}
|
|
7198
|
-
/**
|
|
7199
|
-
* <p>A filter to use when searching for spaces.</p>
|
|
7200
|
-
* @public
|
|
7201
|
-
*/
|
|
7202
|
-
export interface SpaceQuicksightSearchFilter {
|
|
7203
|
-
/**
|
|
7204
|
-
* <p>The name of the filter field to use.</p>
|
|
7205
|
-
* @public
|
|
7206
|
-
*/
|
|
7207
|
-
name: SpaceQuickSightSearchFilterName | undefined;
|
|
7208
|
-
/**
|
|
7209
|
-
* <p>The comparison operator to use for the filter.</p>
|
|
7210
|
-
* @public
|
|
7211
|
-
*/
|
|
7212
|
-
operator: SpaceSearchOperator | undefined;
|
|
7213
|
-
/**
|
|
7214
|
-
* <p>The value to use for the filter.</p>
|
|
7215
|
-
* @public
|
|
7216
|
-
*/
|
|
7217
|
-
value: string | undefined;
|
|
7218
|
-
}
|
|
7219
|
-
/**
|
|
7220
|
-
* @public
|
|
7221
|
-
*/
|
|
7222
|
-
export interface SearchSpacesRequest {
|
|
7223
|
-
/**
|
|
7224
|
-
* <p>The ID of the Amazon Web Services account that contains the spaces.</p>
|
|
7225
|
-
* @public
|
|
7226
|
-
*/
|
|
7227
|
-
AwsAccountId: string | undefined;
|
|
7228
|
-
/**
|
|
7229
|
-
* <p>The token for the next set of results, or null if there are no more results.</p>
|
|
7230
|
-
* @public
|
|
7231
|
-
*/
|
|
7232
|
-
NextToken?: string | undefined;
|
|
7233
|
-
/**
|
|
7234
|
-
* <p>The maximum number of results to return.</p>
|
|
7235
|
-
* @public
|
|
7236
|
-
*/
|
|
7237
|
-
MaxResults?: number | undefined;
|
|
7238
|
-
/**
|
|
7239
|
-
* <p>The filters to apply to the search.</p>
|
|
7240
|
-
* @public
|
|
7241
|
-
*/
|
|
7242
|
-
Filters: SpaceQuicksightSearchFilter[] | undefined;
|
|
7243
|
-
}
|
|
7244
|
-
/**
|
|
7245
|
-
* @public
|
|
7246
|
-
*/
|
|
7247
|
-
export interface SearchSpacesResponse {
|
|
7248
|
-
/**
|
|
7249
|
-
* <p>The ID of the space.</p>
|
|
7250
|
-
* @public
|
|
7251
|
-
*/
|
|
7252
|
-
spaceId: string | undefined;
|
|
7253
|
-
/**
|
|
7254
|
-
* <p>The ARN of the space.</p>
|
|
7255
|
-
* @public
|
|
7256
|
-
*/
|
|
7257
|
-
spaceArn?: string | undefined;
|
|
7258
|
-
/**
|
|
7259
|
-
* <p>A list of space summaries that match the search criteria.</p>
|
|
7260
|
-
* @public
|
|
7261
|
-
*/
|
|
7262
|
-
SpaceSummaries: SpaceSummary[] | undefined;
|
|
7263
|
-
/**
|
|
7264
|
-
* <p>The token for the next set of results, or null if there are no more results.</p>
|
|
7265
|
-
* @public
|
|
7266
|
-
*/
|
|
7267
|
-
NextToken?: string | undefined;
|
|
7268
|
-
/**
|
|
7269
|
-
* <p>The Amazon Web Services request ID for this operation.</p>
|
|
7270
|
-
* @public
|
|
7271
|
-
*/
|
|
7272
|
-
RequestId?: string | undefined;
|
|
7273
|
-
}
|
|
7274
|
-
/**
|
|
7275
|
-
* <p>The filter that is used to search for a topic.</p>
|
|
7276
|
-
* @public
|
|
7277
|
-
*/
|
|
7278
|
-
export interface TopicSearchFilter {
|
|
7279
|
-
/**
|
|
7280
|
-
* <p>The operator like equals or like.</p>
|
|
7281
|
-
* @public
|
|
7282
|
-
*/
|
|
7283
|
-
Operator: TopicFilterOperator | undefined;
|
|
7284
|
-
/**
|
|
7285
|
-
* <p>The name of the topic search filter.</p>
|
|
7286
|
-
* @public
|
|
7287
|
-
*/
|
|
7288
|
-
Name: TopicFilterAttribute | undefined;
|
|
7289
|
-
/**
|
|
7290
|
-
* <p>The value of the topic search filter.</p>
|
|
7291
|
-
* @public
|
|
7292
|
-
*/
|
|
7293
|
-
Value: string | undefined;
|
|
7294
|
-
}
|
|
7295
|
-
/**
|
|
7296
|
-
* @public
|
|
7297
|
-
*/
|
|
7298
|
-
export interface SearchTopicsRequest {
|
|
7299
|
-
/**
|
|
7300
|
-
* <p>The ID of the Amazon Web Services account that contains the topic that you want to find.</p>
|
|
7301
|
-
* @public
|
|
7302
|
-
*/
|
|
7303
|
-
AwsAccountId: string | undefined;
|
|
7304
|
-
/**
|
|
7305
|
-
* <p>The filters that you want to use to search for the topic.</p>
|
|
7306
|
-
* @public
|
|
7307
|
-
*/
|
|
7308
|
-
Filters: TopicSearchFilter[] | undefined;
|
|
7309
|
-
/**
|
|
7310
|
-
* <p>The token for the next set of results, or null if there are no more results.</p>
|
|
7311
|
-
* @public
|
|
7312
|
-
*/
|
|
7313
|
-
NextToken?: string | undefined;
|
|
7314
|
-
/**
|
|
7315
|
-
* <p>The maximum number of results to be returned per request.</p>
|
|
7316
|
-
* @public
|
|
7317
|
-
*/
|
|
7318
|
-
MaxResults?: number | undefined;
|
|
7319
|
-
}
|
|
7320
|
-
/**
|
|
7321
|
-
* @public
|
|
7322
|
-
*/
|
|
7323
|
-
export interface SearchTopicsResponse {
|
|
7324
|
-
/**
|
|
7325
|
-
* <p>A list of topic summaries that is returned by the search topic request.</p>
|
|
7326
|
-
* @public
|
|
7327
|
-
*/
|
|
7328
|
-
TopicSummaryList?: TopicSummary[] | undefined;
|
|
7329
|
-
/**
|
|
7330
|
-
* <p>The token for the next set of results, or null if there are no more results.</p>
|
|
7331
|
-
* @public
|
|
7332
|
-
*/
|
|
7333
|
-
NextToken?: string | undefined;
|
|
7334
|
-
/**
|
|
7335
|
-
* <p>The HTTP status of the request.</p>
|
|
7336
|
-
* @public
|
|
7337
|
-
*/
|
|
7338
|
-
Status?: number | undefined;
|
|
7339
|
-
/**
|
|
7340
|
-
* <p>The Amazon Web Services request ID for this operation.</p>
|
|
7341
|
-
* @public
|
|
7342
|
-
*/
|
|
7343
|
-
RequestId?: string | undefined;
|
|
7344
|
-
}
|
|
7345
|
-
/**
|
|
7346
|
-
* @public
|
|
7347
|
-
*/
|
|
7348
|
-
export interface StartAssetBundleExportJobRequest {
|
|
7349
|
-
/**
|
|
7350
|
-
* <p>The ID of the Amazon Web Services account to export assets from.</p>
|
|
7351
|
-
* @public
|
|
7352
|
-
*/
|
|
7353
|
-
AwsAccountId: string | undefined;
|
|
7354
|
-
/**
|
|
7355
|
-
* <p>The ID of the job. This ID is unique while the job is running. After the job is
|
|
7356
|
-
* completed, you can reuse this ID for another job.</p>
|
|
7357
|
-
* @public
|
|
7358
|
-
*/
|
|
7359
|
-
AssetBundleExportJobId: string | undefined;
|
|
7360
|
-
/**
|
|
7361
|
-
* <p>An array of resource ARNs to export. The following resources are supported.</p>
|
|
7362
|
-
* <ul>
|
|
7363
|
-
* <li>
|
|
7364
|
-
* <p>
|
|
7365
|
-
* <code>Analysis</code>
|
|
7366
|
-
* </p>
|
|
7367
|
-
* </li>
|
|
7368
|
-
* <li>
|
|
7369
|
-
* <p>
|
|
7370
|
-
* <code>Dashboard</code>
|
|
7371
|
-
* </p>
|
|
7372
|
-
* </li>
|
|
7373
|
-
* <li>
|
|
7374
|
-
* <p>
|
|
7375
|
-
* <code>DataSet</code>
|
|
7376
|
-
* </p>
|
|
7377
|
-
* </li>
|
|
7378
|
-
* <li>
|
|
7379
|
-
* <p>
|
|
7380
|
-
* <code>DataSource</code>
|
|
7381
|
-
* </p>
|
|
7382
|
-
* </li>
|
|
7383
|
-
* <li>
|
|
7384
|
-
* <p>
|
|
7385
|
-
* <code>RefreshSchedule</code>
|
|
7386
|
-
* </p>
|
|
7387
|
-
* </li>
|
|
7388
|
-
* <li>
|
|
7389
|
-
* <p>
|
|
7390
|
-
* <code>Theme</code>
|
|
7391
|
-
* </p>
|
|
7392
|
-
* </li>
|
|
7393
|
-
* <li>
|
|
7394
|
-
* <p>
|
|
7395
|
-
* <code>VPCConnection</code>
|
|
7396
|
-
* </p>
|
|
7397
|
-
* </li>
|
|
7398
|
-
* </ul>
|
|
7399
|
-
* <p>The API caller must have the necessary permissions in their IAM role to
|
|
7400
|
-
* access each resource before the resources can be exported.</p>
|
|
7401
|
-
* @public
|
|
7402
|
-
*/
|
|
7403
|
-
ResourceArns: string[] | undefined;
|
|
7404
|
-
/**
|
|
7405
|
-
* <p>A Boolean that determines whether all dependencies of each resource ARN are recursively
|
|
7406
|
-
* exported with the job. For example, say you provided a Dashboard ARN to the
|
|
7407
|
-
* <code>ResourceArns</code> parameter. If you set <code>IncludeAllDependencies</code> to
|
|
7408
|
-
* <code>TRUE</code>, any theme, dataset, and data source resource that is a dependency of
|
|
7409
|
-
* the dashboard is also exported.</p>
|
|
7410
|
-
* @public
|
|
7411
|
-
*/
|
|
7412
|
-
IncludeAllDependencies?: boolean | undefined;
|
|
7413
|
-
/**
|
|
7414
|
-
* <p>The export data format.</p>
|
|
7415
|
-
* @public
|
|
7416
|
-
*/
|
|
7417
|
-
ExportFormat: AssetBundleExportFormat | undefined;
|
|
7418
|
-
/**
|
|
7419
|
-
* <p>An optional collection of structures that generate CloudFormation parameters to
|
|
7420
|
-
* override the existing resource property values when the resource is exported to a new
|
|
7421
|
-
* CloudFormation template.</p>
|
|
7422
|
-
* <p>Use this field if the <code>ExportFormat</code> field of a
|
|
7423
|
-
* <code>StartAssetBundleExportJobRequest</code> API call is set to
|
|
7424
|
-
* <code>CLOUDFORMATION_JSON</code>.</p>
|
|
7425
|
-
* @public
|
|
7426
|
-
*/
|
|
7427
|
-
CloudFormationOverridePropertyConfiguration?: AssetBundleCloudFormationOverridePropertyConfiguration | undefined;
|
|
7428
|
-
/**
|
|
7429
|
-
* <p>A Boolean that determines whether all permissions for each resource ARN are exported
|
|
7430
|
-
* with the job. If you set <code>IncludePermissions</code> to <code>TRUE</code>, any
|
|
7431
|
-
* permissions associated with each resource are exported. </p>
|
|
7432
|
-
* @public
|
|
7433
|
-
*/
|
|
7434
|
-
IncludePermissions?: boolean | undefined;
|
|
7435
|
-
/**
|
|
7436
|
-
* <p> A Boolean that determines whether all tags for each resource ARN are exported with the
|
|
7437
|
-
* job. If you set <code>IncludeTags</code> to <code>TRUE</code>, any tags associated with
|
|
7438
|
-
* each resource are exported.</p>
|
|
7439
|
-
* @public
|
|
7440
|
-
*/
|
|
7441
|
-
IncludeTags?: boolean | undefined;
|
|
7442
|
-
/**
|
|
7443
|
-
* <p>An optional parameter that determines which validation strategy to use for the export
|
|
7444
|
-
* job. If <code>StrictModeForAllResources</code> is set to <code>TRUE</code>, strict
|
|
7445
|
-
* validation for every error is enforced. If it is set to <code>FALSE</code>, validation is
|
|
7446
|
-
* skipped for specific UI errors that are shown as warnings. The default value for
|
|
7447
|
-
* <code>StrictModeForAllResources</code> is <code>FALSE</code>.</p>
|
|
7448
|
-
* @public
|
|
7449
|
-
*/
|
|
7450
|
-
ValidationStrategy?: AssetBundleExportJobValidationStrategy | undefined;
|
|
7451
|
-
/**
|
|
7452
|
-
* <p>A Boolean that determines if the exported asset carries over information about the
|
|
7453
|
-
* folders that the asset is a member of. </p>
|
|
7454
|
-
* @public
|
|
7455
|
-
*/
|
|
7456
|
-
IncludeFolderMemberships?: boolean | undefined;
|
|
7457
|
-
/**
|
|
7458
|
-
* <p>A setting that indicates whether you want to include folder assets. You can also use
|
|
7459
|
-
* this setting to recusrsively include all subfolders of an exported folder.</p>
|
|
7460
|
-
* @public
|
|
7461
|
-
*/
|
|
7462
|
-
IncludeFolderMembers?: IncludeFolderMembers | undefined;
|
|
7463
|
-
}
|
|
7464
|
-
/**
|
|
7465
|
-
* @public
|
|
7466
|
-
*/
|
|
7467
|
-
export interface StartAssetBundleExportJobResponse {
|
|
7468
|
-
/**
|
|
7469
|
-
* <p>The Amazon Resource Name (ARN) for the export job.</p>
|
|
7470
|
-
* @public
|
|
7471
|
-
*/
|
|
7472
|
-
Arn?: string | undefined;
|
|
7473
|
-
/**
|
|
7474
|
-
* <p>The ID of the job. This ID is unique while the job is running. After the job is
|
|
7475
|
-
* completed, you can reuse this ID for another job.</p>
|
|
7476
|
-
* @public
|
|
7477
|
-
*/
|
|
7478
|
-
AssetBundleExportJobId?: string | undefined;
|
|
7479
|
-
/**
|
|
7480
|
-
* <p>The Amazon Web Services response ID for this operation.</p>
|
|
7481
|
-
* @public
|
|
7482
|
-
*/
|
|
7483
|
-
RequestId?: string | undefined;
|
|
7484
|
-
/**
|
|
7485
|
-
* <p>The HTTP status of the response.</p>
|
|
7486
|
-
* @public
|
|
7487
|
-
*/
|
|
7488
|
-
Status?: number | undefined;
|
|
7489
|
-
}
|
|
7490
|
-
/**
|
|
7491
|
-
* @public
|
|
7492
|
-
*/
|
|
7493
|
-
export interface StartAssetBundleImportJobRequest {
|
|
7494
|
-
/**
|
|
7495
|
-
* <p>The ID of the Amazon Web Services account to import assets into. </p>
|
|
7496
|
-
* @public
|
|
7497
|
-
*/
|
|
7498
|
-
AwsAccountId: string | undefined;
|
|
7499
|
-
/**
|
|
7500
|
-
* <p>The ID of the job. This ID is unique while the job is running. After the job is
|
|
7501
|
-
* completed, you can reuse this ID for another job.</p>
|
|
7502
|
-
* @public
|
|
7503
|
-
*/
|
|
7504
|
-
AssetBundleImportJobId: string | undefined;
|
|
7505
|
-
/**
|
|
7506
|
-
* <p>The source of the asset bundle zip file that contains the data that you want to import.
|
|
7507
|
-
* The file must be in <code>QUICKSIGHT_JSON</code> format. </p>
|
|
7508
|
-
* @public
|
|
7509
|
-
*/
|
|
7510
|
-
AssetBundleImportSource: AssetBundleImportSource | undefined;
|
|
7511
|
-
/**
|
|
7512
|
-
* <p>Optional overrides that are applied to the resource configuration before import.</p>
|
|
7513
|
-
* @public
|
|
7514
|
-
*/
|
|
7515
|
-
OverrideParameters?: AssetBundleImportJobOverrideParameters | undefined;
|
|
7516
|
-
/**
|
|
7517
|
-
* <p>The failure action for the import job.</p>
|
|
7518
|
-
* <p>If you choose <code>ROLLBACK</code>, failed import jobs will attempt to undo any asset
|
|
7519
|
-
* changes caused by the failed job.</p>
|
|
7520
|
-
* <p>If you choose <code>DO_NOTHING</code>, failed import jobs will not attempt to roll back
|
|
7521
|
-
* any asset changes caused by the failed job, possibly keeping the Amazon Quick Sight account
|
|
7522
|
-
* in an inconsistent state.</p>
|
|
7523
|
-
* @public
|
|
7524
|
-
*/
|
|
7525
|
-
FailureAction?: AssetBundleImportFailureAction | undefined;
|
|
7526
|
-
/**
|
|
7527
|
-
* <p>Optional permission overrides that are applied to the resource configuration before
|
|
7528
|
-
* import.</p>
|
|
7529
|
-
* @public
|
|
7530
|
-
*/
|
|
7531
|
-
OverridePermissions?: AssetBundleImportJobOverridePermissions | undefined;
|
|
7532
|
-
/**
|
|
7533
|
-
* <p>Optional tag overrides that are applied to the resource configuration before
|
|
7534
|
-
* import.</p>
|
|
7535
|
-
* @public
|
|
7536
|
-
*/
|
|
7537
|
-
OverrideTags?: AssetBundleImportJobOverrideTags | undefined;
|
|
7538
|
-
/**
|
|
7539
|
-
* <p>An optional validation strategy override for all analyses and dashboards that is applied
|
|
7540
|
-
* to the resource configuration before import. </p>
|
|
7541
|
-
* @public
|
|
7542
|
-
*/
|
|
7543
|
-
OverrideValidationStrategy?: AssetBundleImportJobOverrideValidationStrategy | undefined;
|
|
7544
|
-
}
|
|
7545
|
-
/**
|
|
7546
|
-
* @public
|
|
7547
|
-
*/
|
|
7548
|
-
export interface StartAssetBundleImportJobResponse {
|
|
7549
|
-
/**
|
|
7550
|
-
* <p>The Amazon Resource Name (ARN) for the import job.</p>
|
|
7551
|
-
* @public
|
|
7552
|
-
*/
|
|
7553
|
-
Arn?: string | undefined;
|
|
7554
|
-
/**
|
|
7555
|
-
* <p>The ID of the job. This ID is unique while the job is running. After the job is
|
|
7556
|
-
* completed, you can reuse this ID for another job.</p>
|
|
7557
|
-
* @public
|
|
7558
|
-
*/
|
|
7559
|
-
AssetBundleImportJobId?: string | undefined;
|
|
7560
|
-
/**
|
|
7561
|
-
* <p>The Amazon Web Services response ID for this operation.</p>
|
|
7562
|
-
* @public
|
|
7563
|
-
*/
|
|
7564
|
-
RequestId?: string | undefined;
|
|
7565
|
-
/**
|
|
7566
|
-
* <p>The HTTP status of the response.</p>
|
|
7567
|
-
* @public
|
|
7568
|
-
*/
|
|
7569
|
-
Status?: number | undefined;
|
|
7570
|
-
}
|
|
7571
|
-
/**
|
|
7572
|
-
* @public
|
|
7573
|
-
*/
|
|
7574
|
-
export interface StartAutomationJobRequest {
|
|
7575
|
-
/**
|
|
7576
|
-
* <p>The ID of the Amazon Web Services account that contains the automation.</p>
|
|
7577
|
-
* @public
|
|
7578
|
-
*/
|
|
7579
|
-
AwsAccountId: string | undefined;
|
|
7580
|
-
/**
|
|
7581
|
-
* <p>The ID of the automation group that contains the automation to run.</p>
|
|
7582
|
-
* @public
|
|
7583
|
-
*/
|
|
7584
|
-
AutomationGroupId: string | undefined;
|
|
7585
|
-
/**
|
|
7586
|
-
* <p>The ID of the automation to run.</p>
|
|
7587
|
-
* @public
|
|
7588
|
-
*/
|
|
7589
|
-
AutomationId: string | undefined;
|
|
7590
|
-
/**
|
|
7591
|
-
* <p>The input payload for the automation job, provided as a JSON string.</p>
|
|
7592
|
-
* @public
|
|
7593
|
-
*/
|
|
7594
|
-
InputPayload?: string | undefined;
|
|
7595
|
-
}
|
|
7596
|
-
/**
|
|
7597
|
-
* @public
|
|
7598
|
-
*/
|
|
7599
|
-
export interface StartAutomationJobResponse {
|
|
7600
|
-
/**
|
|
7601
|
-
* <p>The Amazon Resource Name (ARN) of the automation job.</p>
|
|
7602
|
-
* @public
|
|
7603
|
-
*/
|
|
7604
|
-
Arn: string | undefined;
|
|
7605
|
-
/**
|
|
7606
|
-
* <p>The ID of the automation job that was started.</p>
|
|
7607
|
-
* @public
|
|
7608
|
-
*/
|
|
7609
|
-
JobId: string | undefined;
|
|
7610
|
-
/**
|
|
7611
|
-
* <p>The HTTP status of the request.</p>
|
|
7612
|
-
* @public
|
|
7613
|
-
*/
|
|
7614
|
-
Status?: number | undefined;
|
|
7615
|
-
/**
|
|
7616
|
-
* <p>The Amazon Web Services request ID for this operation.</p>
|
|
7617
|
-
* @public
|
|
7618
|
-
*/
|
|
7619
|
-
RequestId?: string | undefined;
|
|
7620
|
-
}
|
|
7621
|
-
/**
|
|
7622
|
-
* <p>A structure that contains information on the anonymous user configuration.</p>
|
|
7623
|
-
* @public
|
|
7624
|
-
*/
|
|
7625
|
-
export interface SnapshotAnonymousUser {
|
|
7626
|
-
/**
|
|
7627
|
-
* <p>The tags to be used for row-level security (RLS). Make sure that the relevant datasets have RLS tags configured before you start a snapshot export job. You can configure the RLS tags of a dataset with a <code>DataSet$RowLevelPermissionTagConfiguration</code> API call.</p>
|
|
7628
|
-
* <p>These are not the tags that are used for Amazon Web Services resource tagging. For more information on row level security in Amazon Quick Sight, see <a href="https://docs.aws.amazon.com/quicksight/latest/user/quicksight-dev-rls-tags.html">Using Row-Level Security (RLS) with Tags</a>in the <i>Amazon Quick User Guide</i>.</p>
|
|
7629
|
-
* @public
|
|
7630
|
-
*/
|
|
7631
|
-
RowLevelPermissionTags?: SessionTag[] | undefined;
|
|
7632
|
-
}
|
|
7633
|
-
/**
|
|
7634
|
-
* <p>A structure that contains information about the users that the dashboard snapshot is generated for.</p>
|
|
7635
|
-
* <important>
|
|
7636
|
-
* <p>When using identity-enhanced session credentials, set the UserConfiguration request attribute to null. Otherwise, the request will be invalid.</p>
|
|
7637
|
-
* </important>
|
|
7638
|
-
* @public
|
|
7639
|
-
*/
|
|
7640
|
-
export interface SnapshotUserConfiguration {
|
|
7641
|
-
/**
|
|
7642
|
-
* <p>An array of records that describe the anonymous users that the dashboard snapshot is generated for.</p>
|
|
7643
|
-
* @public
|
|
7644
|
-
*/
|
|
7645
|
-
AnonymousUsers?: SnapshotAnonymousUser[] | undefined;
|
|
7646
|
-
}
|
|
7647
|
-
/**
|
|
7648
|
-
* @public
|
|
7649
|
-
*/
|
|
7650
|
-
export interface StartDashboardSnapshotJobRequest {
|
|
7651
|
-
/**
|
|
7652
|
-
* <p>The ID of the Amazon Web Services account that the dashboard snapshot job is executed in.</p>
|
|
7653
|
-
* @public
|
|
7654
|
-
*/
|
|
7655
|
-
AwsAccountId: string | undefined;
|
|
7656
|
-
/**
|
|
7657
|
-
* <p>The ID of the dashboard that you want to start a snapshot job for.
|
|
7658
|
-
* </p>
|
|
7659
|
-
* @public
|
|
7660
|
-
*/
|
|
7661
|
-
DashboardId: string | undefined;
|
|
7662
|
-
/**
|
|
7663
|
-
* <p>An ID for the dashboard snapshot job. This ID is unique to the dashboard while the job is running. This ID can be used to poll the status of a job with a <code>DescribeDashboardSnapshotJob</code> while the job runs. You can reuse this ID for another job 24 hours after the current job is completed.</p>
|
|
7664
|
-
* @public
|
|
7665
|
-
*/
|
|
7666
|
-
SnapshotJobId: string | undefined;
|
|
7667
|
-
/**
|
|
7668
|
-
* <p>A structure that contains information about the users that the dashboard snapshot is generated for. The users can be either anonymous users or registered users. Anonymous users cannot be used together with registered users.</p>
|
|
7669
|
-
* <important>
|
|
7670
|
-
* <p>When using identity-enhanced session credentials, set the UserConfiguration request attribute to null. Otherwise, the request will be invalid.</p>
|
|
7671
|
-
* </important>
|
|
7672
|
-
* @public
|
|
7673
|
-
*/
|
|
7674
|
-
UserConfiguration?: SnapshotUserConfiguration | undefined;
|
|
7675
|
-
/**
|
|
7676
|
-
* <p>A structure that describes the configuration of the dashboard snapshot.</p>
|
|
7677
|
-
* @public
|
|
7678
|
-
*/
|
|
7679
|
-
SnapshotConfiguration: SnapshotConfiguration | undefined;
|
|
7615
|
+
MaxResults?: number | undefined;
|
|
7680
7616
|
}
|
|
7681
7617
|
/**
|
|
7682
7618
|
* @public
|
|
7683
7619
|
*/
|
|
7684
|
-
export interface
|
|
7620
|
+
export interface SearchDashboardsResponse {
|
|
7685
7621
|
/**
|
|
7686
|
-
* <p>The
|
|
7622
|
+
* <p>The list of dashboards owned by the user specified in <code>Filters</code> in your
|
|
7623
|
+
* request.</p>
|
|
7687
7624
|
* @public
|
|
7688
7625
|
*/
|
|
7689
|
-
|
|
7626
|
+
DashboardSummaryList?: DashboardSummary[] | undefined;
|
|
7690
7627
|
/**
|
|
7691
|
-
* <p>The
|
|
7628
|
+
* <p>The token for the next set of results, or null if there are no more results.</p>
|
|
7692
7629
|
* @public
|
|
7693
7630
|
*/
|
|
7694
|
-
|
|
7631
|
+
NextToken?: string | undefined;
|
|
7695
7632
|
/**
|
|
7696
|
-
* <p>
|
|
7697
|
-
* The Amazon Web Services request ID for this operation.
|
|
7698
|
-
* </p>
|
|
7633
|
+
* <p>The HTTP status of the request.</p>
|
|
7699
7634
|
* @public
|
|
7700
7635
|
*/
|
|
7701
|
-
|
|
7636
|
+
Status?: number | undefined;
|
|
7702
7637
|
/**
|
|
7703
|
-
* <p>The
|
|
7638
|
+
* <p>The Amazon Web Services request ID for this operation.</p>
|
|
7704
7639
|
* @public
|
|
7705
7640
|
*/
|
|
7706
|
-
|
|
7641
|
+
RequestId?: string | undefined;
|
|
7707
7642
|
}
|
|
7708
7643
|
/**
|
|
7709
7644
|
* @public
|
|
7710
7645
|
*/
|
|
7711
|
-
export interface
|
|
7646
|
+
export interface SearchDataSetsRequest {
|
|
7712
7647
|
/**
|
|
7713
|
-
* <p>The
|
|
7648
|
+
* <p>The Amazon Web Services account ID.</p>
|
|
7714
7649
|
* @public
|
|
7715
7650
|
*/
|
|
7716
7651
|
AwsAccountId: string | undefined;
|
|
7717
7652
|
/**
|
|
7718
|
-
* <p>The
|
|
7719
|
-
* </p>
|
|
7653
|
+
* <p>The filters to apply to the search.</p>
|
|
7720
7654
|
* @public
|
|
7721
7655
|
*/
|
|
7722
|
-
|
|
7656
|
+
Filters: DataSetSearchFilter[] | undefined;
|
|
7723
7657
|
/**
|
|
7724
|
-
* <p>
|
|
7658
|
+
* <p>A pagination token that can be used in a subsequent request.</p>
|
|
7725
7659
|
* @public
|
|
7726
7660
|
*/
|
|
7727
|
-
|
|
7661
|
+
NextToken?: string | undefined;
|
|
7662
|
+
/**
|
|
7663
|
+
* <p>The maximum number of results to be returned per request.</p>
|
|
7664
|
+
* @public
|
|
7665
|
+
*/
|
|
7666
|
+
MaxResults?: number | undefined;
|
|
7728
7667
|
}
|
|
7729
7668
|
/**
|
|
7730
7669
|
* @public
|
|
7731
7670
|
*/
|
|
7732
|
-
export interface
|
|
7671
|
+
export interface SearchDataSetsResponse {
|
|
7733
7672
|
/**
|
|
7734
|
-
* <p>
|
|
7735
|
-
* The Amazon Web Services request ID for this operation.
|
|
7736
|
-
* </p>
|
|
7673
|
+
* <p>A <code>DataSetSummaries</code> object that returns a summary of a dataset.</p>
|
|
7737
7674
|
* @public
|
|
7738
7675
|
*/
|
|
7739
|
-
|
|
7676
|
+
DataSetSummaries?: DataSetSummary[] | undefined;
|
|
7740
7677
|
/**
|
|
7741
|
-
* <p>
|
|
7678
|
+
* <p>A pagination token that can be used in a subsequent request.</p>
|
|
7742
7679
|
* @public
|
|
7743
7680
|
*/
|
|
7744
|
-
|
|
7745
|
-
}
|
|
7746
|
-
/**
|
|
7747
|
-
* @public
|
|
7748
|
-
*/
|
|
7749
|
-
export interface TagResourceRequest {
|
|
7681
|
+
NextToken?: string | undefined;
|
|
7750
7682
|
/**
|
|
7751
|
-
* <p>The
|
|
7683
|
+
* <p>The HTTP status of the request.</p>
|
|
7752
7684
|
* @public
|
|
7753
7685
|
*/
|
|
7754
|
-
|
|
7686
|
+
Status?: number | undefined;
|
|
7755
7687
|
/**
|
|
7756
|
-
* <p>
|
|
7757
|
-
* resource.</p>
|
|
7688
|
+
* <p>The Amazon Web Services request ID for this operation.</p>
|
|
7758
7689
|
* @public
|
|
7759
7690
|
*/
|
|
7760
|
-
|
|
7691
|
+
RequestId?: string | undefined;
|
|
7761
7692
|
}
|
|
7762
7693
|
/**
|
|
7763
7694
|
* @public
|
|
7764
7695
|
*/
|
|
7765
|
-
export interface
|
|
7696
|
+
export interface SearchDataSourcesRequest {
|
|
7766
7697
|
/**
|
|
7767
|
-
* <p>The Amazon Web Services
|
|
7698
|
+
* <p>The Amazon Web Services account ID.</p>
|
|
7768
7699
|
* @public
|
|
7769
7700
|
*/
|
|
7770
|
-
|
|
7701
|
+
AwsAccountId: string | undefined;
|
|
7771
7702
|
/**
|
|
7772
|
-
* <p>The
|
|
7703
|
+
* <p>The filters to apply to the search.</p>
|
|
7773
7704
|
* @public
|
|
7774
7705
|
*/
|
|
7775
|
-
|
|
7776
|
-
}
|
|
7777
|
-
/**
|
|
7778
|
-
* @public
|
|
7779
|
-
*/
|
|
7780
|
-
export interface UntagResourceRequest {
|
|
7706
|
+
Filters: DataSourceSearchFilter[] | undefined;
|
|
7781
7707
|
/**
|
|
7782
|
-
* <p>
|
|
7708
|
+
* <p>A pagination token that can be used in a subsequent request.</p>
|
|
7783
7709
|
* @public
|
|
7784
7710
|
*/
|
|
7785
|
-
|
|
7711
|
+
NextToken?: string | undefined;
|
|
7786
7712
|
/**
|
|
7787
|
-
* <p>The
|
|
7788
|
-
* resource.</p>
|
|
7713
|
+
* <p>The maximum number of results to be returned per request.</p>
|
|
7789
7714
|
* @public
|
|
7790
7715
|
*/
|
|
7791
|
-
|
|
7716
|
+
MaxResults?: number | undefined;
|
|
7792
7717
|
}
|
|
7793
7718
|
/**
|
|
7794
7719
|
* @public
|
|
7795
7720
|
*/
|
|
7796
|
-
export interface
|
|
7721
|
+
export interface SearchDataSourcesResponse {
|
|
7797
7722
|
/**
|
|
7798
|
-
* <p>
|
|
7723
|
+
* <p>A <code>DataSourceSummaries</code> object that returns a summary of a data
|
|
7724
|
+
* source.</p>
|
|
7799
7725
|
* @public
|
|
7800
7726
|
*/
|
|
7801
|
-
|
|
7727
|
+
DataSourceSummaries?: DataSourceSummary[] | undefined;
|
|
7728
|
+
/**
|
|
7729
|
+
* <p>A pagination token that can be used in a subsequent request.</p>
|
|
7730
|
+
* @public
|
|
7731
|
+
*/
|
|
7732
|
+
NextToken?: string | undefined;
|
|
7802
7733
|
/**
|
|
7803
7734
|
* <p>The HTTP status of the request.</p>
|
|
7804
7735
|
* @public
|
|
7805
7736
|
*/
|
|
7806
7737
|
Status?: number | undefined;
|
|
7738
|
+
/**
|
|
7739
|
+
* <p>The Amazon Web Services request ID for this operation.</p>
|
|
7740
|
+
* @public
|
|
7741
|
+
*/
|
|
7742
|
+
RequestId?: string | undefined;
|
|
7807
7743
|
}
|
|
7808
7744
|
/**
|
|
7745
|
+
* <p>A structure that contains the filter information when searching flows.</p>
|
|
7809
7746
|
* @public
|
|
7810
7747
|
*/
|
|
7811
|
-
export interface
|
|
7748
|
+
export interface SearchFlowsFilter {
|
|
7812
7749
|
/**
|
|
7813
|
-
* <p>The
|
|
7814
|
-
*
|
|
7750
|
+
* <p>The name of the value that you want to use as a filter, for example <code>"Name":
|
|
7751
|
+
* "DIRECT_QUICKSIGHT_SOLE_OWNER"</code>.</p>
|
|
7752
|
+
* <p>Valid values are defined as follows:</p>
|
|
7753
|
+
* <ul>
|
|
7754
|
+
* <li>
|
|
7755
|
+
* <p>
|
|
7756
|
+
* <code>assetName</code>: Any flows whose names have a substring match to this value will be returned.</p>
|
|
7757
|
+
* </li>
|
|
7758
|
+
* <li>
|
|
7759
|
+
* <p>
|
|
7760
|
+
* <code>assetDescription</code>: Any flows whose descriptions have a substring match to this value will be returned.</p>
|
|
7761
|
+
* </li>
|
|
7762
|
+
* <li>
|
|
7763
|
+
* <p>
|
|
7764
|
+
* <code>DIRECT_QUICKSIGHT_SOLE_OWNER</code>: Provide an ARN of a user or group, and any analyses with that ARN listed as the only owner of the analysis are returned. Implicit permissions from folders or groups are not considered.</p>
|
|
7765
|
+
* </li>
|
|
7766
|
+
* <li>
|
|
7767
|
+
* <p>
|
|
7768
|
+
* <code>DIRECT_QUICKSIGHT_OWNER</code>: Provide an ARN of a user or group, and any analyses with that ARN listed as one of the owners of the analyses are returned. Implicit permissions from folders or groups are not considered.</p>
|
|
7769
|
+
* </li>
|
|
7770
|
+
* <li>
|
|
7771
|
+
* <p>
|
|
7772
|
+
* <code>DIRECT_QUICKSIGHT_VIEWER_OR_OWNER</code>: Provide an ARN of a user or group, and any analyses with that ARN listed as one of the owners or viewers of the analyses are returned. Implicit permissions from folders or groups are not considered. </p>
|
|
7773
|
+
* </li>
|
|
7774
|
+
* </ul>
|
|
7815
7775
|
* @public
|
|
7816
7776
|
*/
|
|
7817
|
-
|
|
7777
|
+
Name: FieldName | undefined;
|
|
7818
7778
|
/**
|
|
7819
|
-
* <p>The
|
|
7779
|
+
* <p>The comparison operator that you want to use as a filter, for example <code>"Operator": "StringEquals"</code>. Valid values are <code>"StringEquals"</code> and <code>"StringLike"</code>.</p>
|
|
7820
7780
|
* @public
|
|
7821
7781
|
*/
|
|
7822
|
-
|
|
7782
|
+
Operator: SearchFilterOperator | undefined;
|
|
7823
7783
|
/**
|
|
7824
|
-
* <p>The
|
|
7784
|
+
* <p>The value of the named item, in this case <code>DIRECT_QUICKSIGHT_SOLE_OWNER</code>, that you want
|
|
7785
|
+
* to use as a filter, for example <code>"Value"</code>. An example is
|
|
7786
|
+
* <code>"arn:aws:quicksight:us-east-1:1:user/default/UserName1"</code>.</p>
|
|
7825
7787
|
* @public
|
|
7826
7788
|
*/
|
|
7827
|
-
|
|
7789
|
+
Value: string | undefined;
|
|
7828
7790
|
}
|
|
7829
7791
|
/**
|
|
7830
7792
|
* @public
|
|
7831
7793
|
*/
|
|
7832
|
-
export interface
|
|
7833
|
-
/**
|
|
7834
|
-
* <p>The Amazon Resource Name (ARN) for the updated customization for this Amazon Web Services account.</p>
|
|
7835
|
-
* @public
|
|
7836
|
-
*/
|
|
7837
|
-
Arn?: string | undefined;
|
|
7838
|
-
/**
|
|
7839
|
-
* <p>The ID for the Amazon Web Services account that you want to update Quick Sight customizations
|
|
7840
|
-
* for.</p>
|
|
7841
|
-
* @public
|
|
7842
|
-
*/
|
|
7843
|
-
AwsAccountId?: string | undefined;
|
|
7794
|
+
export interface SearchFlowsInput {
|
|
7844
7795
|
/**
|
|
7845
|
-
* <p>The
|
|
7796
|
+
* <p>The ID of the Amazon Web Services account where you are searching for flows from.</p>
|
|
7846
7797
|
* @public
|
|
7847
7798
|
*/
|
|
7848
|
-
|
|
7799
|
+
AwsAccountId: string | undefined;
|
|
7849
7800
|
/**
|
|
7850
|
-
* <p>The
|
|
7801
|
+
* <p>The filters applied to the search when searching for flows in the Amazon Web Services account.</p>
|
|
7851
7802
|
* @public
|
|
7852
7803
|
*/
|
|
7853
|
-
|
|
7804
|
+
Filters: SearchFlowsFilter[] | undefined;
|
|
7854
7805
|
/**
|
|
7855
|
-
* <p>The
|
|
7806
|
+
* <p>The token to request the next set of results, or null if you want to retrieve the first set.</p>
|
|
7856
7807
|
* @public
|
|
7857
7808
|
*/
|
|
7858
|
-
|
|
7809
|
+
NextToken?: string | undefined;
|
|
7859
7810
|
/**
|
|
7860
|
-
* <p>The
|
|
7811
|
+
* <p>The maximum number of results to be returned per request.</p>
|
|
7861
7812
|
* @public
|
|
7862
7813
|
*/
|
|
7863
|
-
|
|
7814
|
+
MaxResults?: number | undefined;
|
|
7864
7815
|
}
|
|
7865
7816
|
/**
|
|
7866
7817
|
* @public
|
|
7867
7818
|
*/
|
|
7868
|
-
export interface
|
|
7819
|
+
export interface SearchFlowsOutput {
|
|
7869
7820
|
/**
|
|
7870
|
-
* <p>The
|
|
7821
|
+
* <p>The list of flows found against the search.</p>
|
|
7871
7822
|
* @public
|
|
7872
7823
|
*/
|
|
7873
|
-
|
|
7824
|
+
FlowSummaryList: FlowSummary[] | undefined;
|
|
7874
7825
|
/**
|
|
7875
|
-
* <p>The
|
|
7826
|
+
* <p>The token for the next set of results, or null if there are no more results.</p>
|
|
7876
7827
|
* @public
|
|
7877
7828
|
*/
|
|
7878
|
-
|
|
7879
|
-
}
|
|
7880
|
-
/**
|
|
7881
|
-
* @public
|
|
7882
|
-
*/
|
|
7883
|
-
export interface UpdateAccountCustomPermissionResponse {
|
|
7829
|
+
NextToken?: string | undefined;
|
|
7884
7830
|
/**
|
|
7885
7831
|
* <p>The Amazon Web Services request ID for this operation.</p>
|
|
7886
7832
|
* @public
|
|
@@ -7895,110 +7841,105 @@ export interface UpdateAccountCustomPermissionResponse {
|
|
|
7895
7841
|
/**
|
|
7896
7842
|
* @public
|
|
7897
7843
|
*/
|
|
7898
|
-
export interface
|
|
7844
|
+
export interface SearchFoldersRequest {
|
|
7899
7845
|
/**
|
|
7900
|
-
* <p>The ID for the Amazon Web Services account that contains the
|
|
7901
|
-
* list.</p>
|
|
7846
|
+
* <p>The ID for the Amazon Web Services account that contains the folder.</p>
|
|
7902
7847
|
* @public
|
|
7903
7848
|
*/
|
|
7904
7849
|
AwsAccountId: string | undefined;
|
|
7905
7850
|
/**
|
|
7906
|
-
* <p>The
|
|
7907
|
-
* <code>default</code>. IAM users that
|
|
7908
|
-
* register for the first time with Amazon Quick Sight provide an email address that becomes
|
|
7909
|
-
* associated with the default namespace.
|
|
7910
|
-
* </p>
|
|
7851
|
+
* <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>
|
|
7911
7852
|
* @public
|
|
7912
7853
|
*/
|
|
7913
|
-
|
|
7854
|
+
Filters: FolderSearchFilter[] | undefined;
|
|
7914
7855
|
/**
|
|
7915
|
-
* <p>The
|
|
7916
|
-
* Amazon Web Services account or Quick Sight subscription.</p>
|
|
7856
|
+
* <p>The token for the next set of results, or null if there are no more results.</p>
|
|
7917
7857
|
* @public
|
|
7918
7858
|
*/
|
|
7919
|
-
|
|
7859
|
+
NextToken?: string | undefined;
|
|
7920
7860
|
/**
|
|
7921
|
-
* <p>
|
|
7861
|
+
* <p>The maximum number of results to be returned per request.</p>
|
|
7922
7862
|
* @public
|
|
7923
7863
|
*/
|
|
7924
|
-
|
|
7864
|
+
MaxResults?: number | undefined;
|
|
7925
7865
|
}
|
|
7926
7866
|
/**
|
|
7927
7867
|
* @public
|
|
7928
7868
|
*/
|
|
7929
|
-
export interface
|
|
7869
|
+
export interface SearchFoldersResponse {
|
|
7930
7870
|
/**
|
|
7931
|
-
* <p>The
|
|
7871
|
+
* <p>The HTTP status of the request.</p>
|
|
7932
7872
|
* @public
|
|
7933
7873
|
*/
|
|
7934
|
-
|
|
7874
|
+
Status?: number | undefined;
|
|
7935
7875
|
/**
|
|
7936
|
-
* <p>
|
|
7876
|
+
* <p>A structure that contains all of the folders in the Amazon Web Services account. This structure provides basic information about the folders.</p>
|
|
7937
7877
|
* @public
|
|
7938
7878
|
*/
|
|
7939
|
-
|
|
7879
|
+
FolderSummaryList?: FolderSummary[] | undefined;
|
|
7880
|
+
/**
|
|
7881
|
+
* <p>The token for the next set of results, or null if there are no more results.</p>
|
|
7882
|
+
* @public
|
|
7883
|
+
*/
|
|
7884
|
+
NextToken?: string | undefined;
|
|
7885
|
+
/**
|
|
7886
|
+
* <p>The Amazon Web Services request ID for this operation.</p>
|
|
7887
|
+
* @public
|
|
7888
|
+
*/
|
|
7889
|
+
RequestId?: string | undefined;
|
|
7940
7890
|
}
|
|
7941
7891
|
/**
|
|
7942
7892
|
* @public
|
|
7943
7893
|
*/
|
|
7944
|
-
export interface
|
|
7894
|
+
export interface SearchGroupsRequest {
|
|
7945
7895
|
/**
|
|
7946
|
-
* <p>The Amazon Web Services account
|
|
7896
|
+
* <p>The ID for the Amazon Web Services account that the group is in. Currently, you use the ID for the
|
|
7897
|
+
* Amazon Web Services account that contains your Amazon Quick Sight account.</p>
|
|
7947
7898
|
* @public
|
|
7948
7899
|
*/
|
|
7949
7900
|
AwsAccountId: string | undefined;
|
|
7950
7901
|
/**
|
|
7951
|
-
* <p>
|
|
7952
|
-
* @public
|
|
7953
|
-
*/
|
|
7954
|
-
ActionConnectorId: string | undefined;
|
|
7955
|
-
/**
|
|
7956
|
-
* <p>The new name for the action connector.</p>
|
|
7902
|
+
* <p>A pagination token that can be used in a subsequent request.</p>
|
|
7957
7903
|
* @public
|
|
7958
7904
|
*/
|
|
7959
|
-
|
|
7905
|
+
NextToken?: string | undefined;
|
|
7960
7906
|
/**
|
|
7961
|
-
* <p>The
|
|
7907
|
+
* <p>The maximum number of results to return from this request.</p>
|
|
7962
7908
|
* @public
|
|
7963
7909
|
*/
|
|
7964
|
-
|
|
7910
|
+
MaxResults?: number | undefined;
|
|
7965
7911
|
/**
|
|
7966
|
-
* <p>The
|
|
7912
|
+
* <p>The namespace that you want to search.</p>
|
|
7967
7913
|
* @public
|
|
7968
7914
|
*/
|
|
7969
|
-
|
|
7915
|
+
Namespace: string | undefined;
|
|
7970
7916
|
/**
|
|
7971
|
-
* <p>The
|
|
7917
|
+
* <p>The structure for the search filters that you want to apply to your search.</p>
|
|
7972
7918
|
* @public
|
|
7973
7919
|
*/
|
|
7974
|
-
|
|
7920
|
+
Filters: GroupSearchFilter[] | undefined;
|
|
7975
7921
|
}
|
|
7976
7922
|
/**
|
|
7977
7923
|
* @public
|
|
7978
7924
|
*/
|
|
7979
|
-
export interface
|
|
7925
|
+
export interface SearchGroupsResponse {
|
|
7980
7926
|
/**
|
|
7981
|
-
* <p>
|
|
7927
|
+
* <p>A list of groups in a specified namespace that match the filters you set in your <code>SearchGroups</code> request.</p>
|
|
7982
7928
|
* @public
|
|
7983
7929
|
*/
|
|
7984
|
-
|
|
7930
|
+
GroupList?: Group[] | undefined;
|
|
7985
7931
|
/**
|
|
7986
|
-
* <p>
|
|
7932
|
+
* <p>A pagination token that can be used in a subsequent request.</p>
|
|
7987
7933
|
* @public
|
|
7988
7934
|
*/
|
|
7989
|
-
|
|
7935
|
+
NextToken?: string | undefined;
|
|
7990
7936
|
/**
|
|
7991
7937
|
* <p>The Amazon Web Services request ID for this operation.</p>
|
|
7992
7938
|
* @public
|
|
7993
7939
|
*/
|
|
7994
7940
|
RequestId?: string | undefined;
|
|
7995
7941
|
/**
|
|
7996
|
-
* <p>The status of the
|
|
7997
|
-
* @public
|
|
7998
|
-
*/
|
|
7999
|
-
UpdateStatus?: ResourceStatus | undefined;
|
|
8000
|
-
/**
|
|
8001
|
-
* <p>The HTTP status code of the request.</p>
|
|
7942
|
+
* <p>The HTTP status of the request.</p>
|
|
8002
7943
|
* @public
|
|
8003
7944
|
*/
|
|
8004
7945
|
Status?: number | undefined;
|
|
@@ -8006,162 +7947,199 @@ export interface UpdateActionConnectorResponse {
|
|
|
8006
7947
|
/**
|
|
8007
7948
|
* @public
|
|
8008
7949
|
*/
|
|
8009
|
-
export interface
|
|
7950
|
+
export interface SearchKnowledgeBasesRequest {
|
|
8010
7951
|
/**
|
|
8011
|
-
* <p>The Amazon Web Services account
|
|
7952
|
+
* <p>The ID of the Amazon Web Services account that contains the knowledge base.</p>
|
|
8012
7953
|
* @public
|
|
8013
7954
|
*/
|
|
8014
7955
|
AwsAccountId: string | undefined;
|
|
8015
7956
|
/**
|
|
8016
|
-
* <p>The
|
|
7957
|
+
* <p>The token for the next set of results, or null if there are no more results.</p>
|
|
7958
|
+
* @public
|
|
7959
|
+
*/
|
|
7960
|
+
NextToken?: string | undefined;
|
|
7961
|
+
/**
|
|
7962
|
+
* <p>The maximum number of results to return.</p>
|
|
8017
7963
|
* @public
|
|
8018
7964
|
*/
|
|
8019
|
-
|
|
7965
|
+
MaxResults?: number | undefined;
|
|
8020
7966
|
/**
|
|
8021
|
-
* <p>The
|
|
7967
|
+
* <p>The filters to apply when searching knowledge bases.</p>
|
|
8022
7968
|
* @public
|
|
8023
7969
|
*/
|
|
8024
|
-
|
|
7970
|
+
Filters?: KnowledgeBaseSearchFilter[] | undefined;
|
|
8025
7971
|
/**
|
|
8026
|
-
* <p>The
|
|
7972
|
+
* <p>The sort configuration for the search results.</p>
|
|
8027
7973
|
* @public
|
|
8028
7974
|
*/
|
|
8029
|
-
|
|
7975
|
+
SortBy?: KnowledgeBaseSortBy | undefined;
|
|
8030
7976
|
}
|
|
8031
7977
|
/**
|
|
8032
7978
|
* @public
|
|
8033
7979
|
*/
|
|
8034
|
-
export interface
|
|
7980
|
+
export interface SearchKnowledgeBasesResponse {
|
|
8035
7981
|
/**
|
|
8036
|
-
* <p>
|
|
7982
|
+
* <p>A list of knowledge base summaries.</p>
|
|
8037
7983
|
* @public
|
|
8038
7984
|
*/
|
|
8039
|
-
|
|
7985
|
+
KnowledgeBaseSummaries: KnowledgeBaseSummary[] | undefined;
|
|
8040
7986
|
/**
|
|
8041
|
-
* <p>The
|
|
7987
|
+
* <p>The token for the next set of results, or null if there are no more results.</p>
|
|
8042
7988
|
* @public
|
|
8043
7989
|
*/
|
|
8044
|
-
|
|
7990
|
+
NextToken?: string | undefined;
|
|
8045
7991
|
/**
|
|
8046
7992
|
* <p>The Amazon Web Services request ID for this operation.</p>
|
|
8047
7993
|
* @public
|
|
8048
7994
|
*/
|
|
8049
7995
|
RequestId?: string | undefined;
|
|
8050
7996
|
/**
|
|
8051
|
-
* <p>The HTTP status
|
|
7997
|
+
* <p>The HTTP status of the request.</p>
|
|
8052
7998
|
* @public
|
|
8053
7999
|
*/
|
|
8054
8000
|
Status?: number | undefined;
|
|
8001
|
+
}
|
|
8002
|
+
/**
|
|
8003
|
+
* <p>A filter to use when searching for spaces.</p>
|
|
8004
|
+
* @public
|
|
8005
|
+
*/
|
|
8006
|
+
export interface SpaceQuicksightSearchFilter {
|
|
8055
8007
|
/**
|
|
8056
|
-
* <p>The
|
|
8008
|
+
* <p>The name of the filter field to use.</p>
|
|
8057
8009
|
* @public
|
|
8058
8010
|
*/
|
|
8059
|
-
|
|
8011
|
+
name: SpaceQuickSightSearchFilterName | undefined;
|
|
8012
|
+
/**
|
|
8013
|
+
* <p>The comparison operator to use for the filter.</p>
|
|
8014
|
+
* @public
|
|
8015
|
+
*/
|
|
8016
|
+
operator: SpaceSearchOperator | undefined;
|
|
8017
|
+
/**
|
|
8018
|
+
* <p>The value to use for the filter.</p>
|
|
8019
|
+
* @public
|
|
8020
|
+
*/
|
|
8021
|
+
value: string | undefined;
|
|
8060
8022
|
}
|
|
8061
8023
|
/**
|
|
8062
8024
|
* @public
|
|
8063
8025
|
*/
|
|
8064
|
-
export interface
|
|
8026
|
+
export interface SearchSpacesRequest {
|
|
8065
8027
|
/**
|
|
8066
|
-
* <p>The
|
|
8028
|
+
* <p>The ID of the Amazon Web Services account that contains the spaces.</p>
|
|
8067
8029
|
* @public
|
|
8068
8030
|
*/
|
|
8069
|
-
|
|
8031
|
+
AwsAccountId: string | undefined;
|
|
8070
8032
|
/**
|
|
8071
|
-
* <p>The
|
|
8033
|
+
* <p>The token for the next set of results, or null if there are no more results.</p>
|
|
8072
8034
|
* @public
|
|
8073
8035
|
*/
|
|
8074
|
-
|
|
8036
|
+
NextToken?: string | undefined;
|
|
8075
8037
|
/**
|
|
8076
|
-
* <p>The
|
|
8038
|
+
* <p>The maximum number of results to return.</p>
|
|
8077
8039
|
* @public
|
|
8078
8040
|
*/
|
|
8079
|
-
|
|
8041
|
+
MaxResults?: number | undefined;
|
|
8080
8042
|
/**
|
|
8081
|
-
* <p>
|
|
8043
|
+
* <p>The filters to apply to the search.</p>
|
|
8082
8044
|
* @public
|
|
8083
8045
|
*/
|
|
8084
|
-
|
|
8046
|
+
Filters: SpaceQuicksightSearchFilter[] | undefined;
|
|
8047
|
+
}
|
|
8048
|
+
/**
|
|
8049
|
+
* @public
|
|
8050
|
+
*/
|
|
8051
|
+
export interface SearchSpacesResponse {
|
|
8085
8052
|
/**
|
|
8086
|
-
* <p>The
|
|
8053
|
+
* <p>The ID of the space.</p>
|
|
8087
8054
|
* @public
|
|
8088
8055
|
*/
|
|
8089
|
-
|
|
8056
|
+
spaceId: string | undefined;
|
|
8090
8057
|
/**
|
|
8091
|
-
* <p>
|
|
8058
|
+
* <p>The ARN of the space.</p>
|
|
8092
8059
|
* @public
|
|
8093
8060
|
*/
|
|
8094
|
-
|
|
8061
|
+
spaceArn?: string | undefined;
|
|
8095
8062
|
/**
|
|
8096
|
-
* <p>
|
|
8063
|
+
* <p>A list of space summaries that match the search criteria.</p>
|
|
8097
8064
|
* @public
|
|
8098
8065
|
*/
|
|
8099
|
-
|
|
8066
|
+
SpaceSummaries: SpaceSummary[] | undefined;
|
|
8100
8067
|
/**
|
|
8101
|
-
* <p>The
|
|
8068
|
+
* <p>The token for the next set of results, or null if there are no more results.</p>
|
|
8102
8069
|
* @public
|
|
8103
8070
|
*/
|
|
8104
|
-
|
|
8071
|
+
NextToken?: string | undefined;
|
|
8105
8072
|
/**
|
|
8106
|
-
* <p>The Amazon
|
|
8073
|
+
* <p>The Amazon Web Services request ID for this operation.</p>
|
|
8107
8074
|
* @public
|
|
8108
8075
|
*/
|
|
8109
|
-
|
|
8076
|
+
RequestId?: string | undefined;
|
|
8077
|
+
}
|
|
8078
|
+
/**
|
|
8079
|
+
* <p>The filter that is used to search for a topic.</p>
|
|
8080
|
+
* @public
|
|
8081
|
+
*/
|
|
8082
|
+
export interface TopicSearchFilter {
|
|
8110
8083
|
/**
|
|
8111
|
-
* <p>The
|
|
8084
|
+
* <p>The operator like equals or like.</p>
|
|
8112
8085
|
* @public
|
|
8113
8086
|
*/
|
|
8114
|
-
|
|
8087
|
+
Operator: TopicFilterOperator | undefined;
|
|
8115
8088
|
/**
|
|
8116
|
-
* <p>The
|
|
8089
|
+
* <p>The name of the topic search filter.</p>
|
|
8117
8090
|
* @public
|
|
8118
8091
|
*/
|
|
8119
|
-
|
|
8092
|
+
Name: TopicFilterAttribute | undefined;
|
|
8120
8093
|
/**
|
|
8121
|
-
* <p>The
|
|
8094
|
+
* <p>The value of the topic search filter.</p>
|
|
8122
8095
|
* @public
|
|
8123
8096
|
*/
|
|
8124
|
-
|
|
8097
|
+
Value: string | undefined;
|
|
8125
8098
|
}
|
|
8126
8099
|
/**
|
|
8127
8100
|
* @public
|
|
8128
8101
|
*/
|
|
8129
|
-
export interface
|
|
8102
|
+
export interface SearchTopicsRequest {
|
|
8130
8103
|
/**
|
|
8131
|
-
* <p>The Amazon
|
|
8104
|
+
* <p>The ID of the Amazon Web Services account that contains the topic that you want to find.</p>
|
|
8132
8105
|
* @public
|
|
8133
8106
|
*/
|
|
8134
|
-
|
|
8107
|
+
AwsAccountId: string | undefined;
|
|
8135
8108
|
/**
|
|
8136
|
-
* <p>The
|
|
8109
|
+
* <p>The filters that you want to use to search for the topic.</p>
|
|
8137
8110
|
* @public
|
|
8138
8111
|
*/
|
|
8139
|
-
|
|
8112
|
+
Filters: TopicSearchFilter[] | undefined;
|
|
8140
8113
|
/**
|
|
8141
|
-
* <p>The
|
|
8114
|
+
* <p>The token for the next set of results, or null if there are no more results.</p>
|
|
8142
8115
|
* @public
|
|
8143
8116
|
*/
|
|
8144
|
-
|
|
8117
|
+
NextToken?: string | undefined;
|
|
8145
8118
|
/**
|
|
8146
|
-
* <p>
|
|
8119
|
+
* <p>The maximum number of results to be returned per request.</p>
|
|
8147
8120
|
* @public
|
|
8148
8121
|
*/
|
|
8149
|
-
|
|
8122
|
+
MaxResults?: number | undefined;
|
|
8123
|
+
}
|
|
8124
|
+
/**
|
|
8125
|
+
* @public
|
|
8126
|
+
*/
|
|
8127
|
+
export interface SearchTopicsResponse {
|
|
8150
8128
|
/**
|
|
8151
|
-
* <p>A list of
|
|
8129
|
+
* <p>A list of topic summaries that is returned by the search topic request.</p>
|
|
8152
8130
|
* @public
|
|
8153
8131
|
*/
|
|
8154
|
-
|
|
8132
|
+
TopicSummaryList?: TopicSummary[] | undefined;
|
|
8155
8133
|
/**
|
|
8156
|
-
* <p>
|
|
8134
|
+
* <p>The token for the next set of results, or null if there are no more results.</p>
|
|
8157
8135
|
* @public
|
|
8158
8136
|
*/
|
|
8159
|
-
|
|
8137
|
+
NextToken?: string | undefined;
|
|
8160
8138
|
/**
|
|
8161
|
-
* <p>
|
|
8139
|
+
* <p>The HTTP status of the request.</p>
|
|
8162
8140
|
* @public
|
|
8163
8141
|
*/
|
|
8164
|
-
|
|
8142
|
+
Status?: number | undefined;
|
|
8165
8143
|
/**
|
|
8166
8144
|
* <p>The Amazon Web Services request ID for this operation.</p>
|
|
8167
8145
|
* @public
|
|
@@ -8171,191 +8149,225 @@ export interface UpdateAgentResponse {
|
|
|
8171
8149
|
/**
|
|
8172
8150
|
* @public
|
|
8173
8151
|
*/
|
|
8174
|
-
export interface
|
|
8175
|
-
/**
|
|
8176
|
-
* <p>The unique identifier for the agent.</p>
|
|
8177
|
-
* @public
|
|
8178
|
-
*/
|
|
8179
|
-
AgentId: string | undefined;
|
|
8152
|
+
export interface StartAssetBundleExportJobRequest {
|
|
8180
8153
|
/**
|
|
8181
|
-
* <p>The ID of the Amazon Web Services account
|
|
8154
|
+
* <p>The ID of the Amazon Web Services account to export assets from.</p>
|
|
8182
8155
|
* @public
|
|
8183
8156
|
*/
|
|
8184
8157
|
AwsAccountId: string | undefined;
|
|
8185
8158
|
/**
|
|
8186
|
-
* <p>The
|
|
8159
|
+
* <p>The ID of the job. This ID is unique while the job is running. After the job is
|
|
8160
|
+
* completed, you can reuse this ID for another job.</p>
|
|
8187
8161
|
* @public
|
|
8188
8162
|
*/
|
|
8189
|
-
|
|
8163
|
+
AssetBundleExportJobId: string | undefined;
|
|
8190
8164
|
/**
|
|
8191
|
-
* <p>
|
|
8165
|
+
* <p>An array of resource ARNs to export. The following resources are supported.</p>
|
|
8166
|
+
* <ul>
|
|
8167
|
+
* <li>
|
|
8168
|
+
* <p>
|
|
8169
|
+
* <code>Analysis</code>
|
|
8170
|
+
* </p>
|
|
8171
|
+
* </li>
|
|
8172
|
+
* <li>
|
|
8173
|
+
* <p>
|
|
8174
|
+
* <code>Dashboard</code>
|
|
8175
|
+
* </p>
|
|
8176
|
+
* </li>
|
|
8177
|
+
* <li>
|
|
8178
|
+
* <p>
|
|
8179
|
+
* <code>DataSet</code>
|
|
8180
|
+
* </p>
|
|
8181
|
+
* </li>
|
|
8182
|
+
* <li>
|
|
8183
|
+
* <p>
|
|
8184
|
+
* <code>DataSource</code>
|
|
8185
|
+
* </p>
|
|
8186
|
+
* </li>
|
|
8187
|
+
* <li>
|
|
8188
|
+
* <p>
|
|
8189
|
+
* <code>RefreshSchedule</code>
|
|
8190
|
+
* </p>
|
|
8191
|
+
* </li>
|
|
8192
|
+
* <li>
|
|
8193
|
+
* <p>
|
|
8194
|
+
* <code>Theme</code>
|
|
8195
|
+
* </p>
|
|
8196
|
+
* </li>
|
|
8197
|
+
* <li>
|
|
8198
|
+
* <p>
|
|
8199
|
+
* <code>VPCConnection</code>
|
|
8200
|
+
* </p>
|
|
8201
|
+
* </li>
|
|
8202
|
+
* </ul>
|
|
8203
|
+
* <p>The API caller must have the necessary permissions in their IAM role to
|
|
8204
|
+
* access each resource before the resources can be exported.</p>
|
|
8192
8205
|
* @public
|
|
8193
8206
|
*/
|
|
8194
|
-
|
|
8195
|
-
}
|
|
8196
|
-
/**
|
|
8197
|
-
* @public
|
|
8198
|
-
*/
|
|
8199
|
-
export interface UpdateAgentPermissionsResponse {
|
|
8207
|
+
ResourceArns: string[] | undefined;
|
|
8200
8208
|
/**
|
|
8201
|
-
* <p>
|
|
8209
|
+
* <p>A Boolean that determines whether all dependencies of each resource ARN are recursively
|
|
8210
|
+
* exported with the job. For example, say you provided a Dashboard ARN to the
|
|
8211
|
+
* <code>ResourceArns</code> parameter. If you set <code>IncludeAllDependencies</code> to
|
|
8212
|
+
* <code>TRUE</code>, any theme, dataset, and data source resource that is a dependency of
|
|
8213
|
+
* the dashboard is also exported.</p>
|
|
8202
8214
|
* @public
|
|
8203
8215
|
*/
|
|
8204
|
-
|
|
8216
|
+
IncludeAllDependencies?: boolean | undefined;
|
|
8205
8217
|
/**
|
|
8206
|
-
* <p>The
|
|
8218
|
+
* <p>The export data format.</p>
|
|
8207
8219
|
* @public
|
|
8208
8220
|
*/
|
|
8209
|
-
|
|
8221
|
+
ExportFormat: AssetBundleExportFormat | undefined;
|
|
8210
8222
|
/**
|
|
8211
|
-
* <p>
|
|
8223
|
+
* <p>An optional collection of structures that generate CloudFormation parameters to
|
|
8224
|
+
* override the existing resource property values when the resource is exported to a new
|
|
8225
|
+
* CloudFormation template.</p>
|
|
8226
|
+
* <p>Use this field if the <code>ExportFormat</code> field of a
|
|
8227
|
+
* <code>StartAssetBundleExportJobRequest</code> API call is set to
|
|
8228
|
+
* <code>CLOUDFORMATION_JSON</code>.</p>
|
|
8212
8229
|
* @public
|
|
8213
8230
|
*/
|
|
8214
|
-
|
|
8231
|
+
CloudFormationOverridePropertyConfiguration?: AssetBundleCloudFormationOverridePropertyConfiguration | undefined;
|
|
8215
8232
|
/**
|
|
8216
|
-
* <p>
|
|
8233
|
+
* <p>A Boolean that determines whether all permissions for each resource ARN are exported
|
|
8234
|
+
* with the job. If you set <code>IncludePermissions</code> to <code>TRUE</code>, any
|
|
8235
|
+
* permissions associated with each resource are exported. </p>
|
|
8217
8236
|
* @public
|
|
8218
8237
|
*/
|
|
8219
|
-
|
|
8220
|
-
}
|
|
8221
|
-
/**
|
|
8222
|
-
* @public
|
|
8223
|
-
*/
|
|
8224
|
-
export interface UpdateAnalysisRequest {
|
|
8238
|
+
IncludePermissions?: boolean | undefined;
|
|
8225
8239
|
/**
|
|
8226
|
-
* <p>
|
|
8240
|
+
* <p> A Boolean that determines whether all tags for each resource ARN are exported with the
|
|
8241
|
+
* job. If you set <code>IncludeTags</code> to <code>TRUE</code>, any tags associated with
|
|
8242
|
+
* each resource are exported.</p>
|
|
8227
8243
|
* @public
|
|
8228
8244
|
*/
|
|
8229
|
-
|
|
8245
|
+
IncludeTags?: boolean | undefined;
|
|
8230
8246
|
/**
|
|
8231
|
-
* <p>
|
|
8232
|
-
*
|
|
8247
|
+
* <p>An optional parameter that determines which validation strategy to use for the export
|
|
8248
|
+
* job. If <code>StrictModeForAllResources</code> is set to <code>TRUE</code>, strict
|
|
8249
|
+
* validation for every error is enforced. If it is set to <code>FALSE</code>, validation is
|
|
8250
|
+
* skipped for specific UI errors that are shown as warnings. The default value for
|
|
8251
|
+
* <code>StrictModeForAllResources</code> is <code>FALSE</code>.</p>
|
|
8233
8252
|
* @public
|
|
8234
8253
|
*/
|
|
8235
|
-
|
|
8254
|
+
ValidationStrategy?: AssetBundleExportJobValidationStrategy | undefined;
|
|
8236
8255
|
/**
|
|
8237
|
-
* <p>A
|
|
8238
|
-
*
|
|
8256
|
+
* <p>A Boolean that determines if the exported asset carries over information about the
|
|
8257
|
+
* folders that the asset is a member of. </p>
|
|
8239
8258
|
* @public
|
|
8240
8259
|
*/
|
|
8241
|
-
|
|
8260
|
+
IncludeFolderMemberships?: boolean | undefined;
|
|
8242
8261
|
/**
|
|
8243
|
-
* <p>
|
|
8244
|
-
*
|
|
8262
|
+
* <p>A setting that indicates whether you want to include folder assets. You can also use
|
|
8263
|
+
* this setting to recusrsively include all subfolders of an exported folder.</p>
|
|
8245
8264
|
* @public
|
|
8246
8265
|
*/
|
|
8247
|
-
|
|
8266
|
+
IncludeFolderMembers?: IncludeFolderMembers | undefined;
|
|
8267
|
+
}
|
|
8268
|
+
/**
|
|
8269
|
+
* @public
|
|
8270
|
+
*/
|
|
8271
|
+
export interface StartAssetBundleExportJobResponse {
|
|
8248
8272
|
/**
|
|
8249
|
-
* <p>
|
|
8250
|
-
* contains details that describe a source template and one or more datasets.</p>
|
|
8273
|
+
* <p>The Amazon Resource Name (ARN) for the export job.</p>
|
|
8251
8274
|
* @public
|
|
8252
8275
|
*/
|
|
8253
|
-
|
|
8276
|
+
Arn?: string | undefined;
|
|
8254
8277
|
/**
|
|
8255
|
-
* <p>The
|
|
8256
|
-
*
|
|
8257
|
-
* it.</p>
|
|
8278
|
+
* <p>The ID of the job. This ID is unique while the job is running. After the job is
|
|
8279
|
+
* completed, you can reuse this ID for another job.</p>
|
|
8258
8280
|
* @public
|
|
8259
8281
|
*/
|
|
8260
|
-
|
|
8282
|
+
AssetBundleExportJobId?: string | undefined;
|
|
8261
8283
|
/**
|
|
8262
|
-
* <p>The
|
|
8263
|
-
* <p>A definition is the data model of all features in a Dashboard, Template, or Analysis.</p>
|
|
8284
|
+
* <p>The Amazon Web Services response ID for this operation.</p>
|
|
8264
8285
|
* @public
|
|
8265
8286
|
*/
|
|
8266
|
-
|
|
8287
|
+
RequestId?: string | undefined;
|
|
8267
8288
|
/**
|
|
8268
|
-
* <p>The
|
|
8289
|
+
* <p>The HTTP status of the response.</p>
|
|
8269
8290
|
* @public
|
|
8270
8291
|
*/
|
|
8271
|
-
|
|
8292
|
+
Status?: number | undefined;
|
|
8272
8293
|
}
|
|
8273
8294
|
/**
|
|
8274
8295
|
* @public
|
|
8275
8296
|
*/
|
|
8276
|
-
export interface
|
|
8277
|
-
/**
|
|
8278
|
-
* <p>The ARN of the analysis that you're updating.</p>
|
|
8279
|
-
* @public
|
|
8280
|
-
*/
|
|
8281
|
-
Arn?: string | undefined;
|
|
8297
|
+
export interface StartAssetBundleImportJobRequest {
|
|
8282
8298
|
/**
|
|
8283
|
-
* <p>The ID of the
|
|
8299
|
+
* <p>The ID of the Amazon Web Services account to import assets into. </p>
|
|
8284
8300
|
* @public
|
|
8285
8301
|
*/
|
|
8286
|
-
|
|
8302
|
+
AwsAccountId: string | undefined;
|
|
8287
8303
|
/**
|
|
8288
|
-
* <p>The
|
|
8304
|
+
* <p>The ID of the job. This ID is unique while the job is running. After the job is
|
|
8305
|
+
* completed, you can reuse this ID for another job.</p>
|
|
8289
8306
|
* @public
|
|
8290
8307
|
*/
|
|
8291
|
-
|
|
8308
|
+
AssetBundleImportJobId: string | undefined;
|
|
8292
8309
|
/**
|
|
8293
|
-
* <p>The
|
|
8310
|
+
* <p>The source of the asset bundle zip file that contains the data that you want to import.
|
|
8311
|
+
* The file must be in <code>QUICKSIGHT_JSON</code> format. </p>
|
|
8294
8312
|
* @public
|
|
8295
8313
|
*/
|
|
8296
|
-
|
|
8314
|
+
AssetBundleImportSource: AssetBundleImportSource | undefined;
|
|
8297
8315
|
/**
|
|
8298
|
-
* <p>
|
|
8316
|
+
* <p>Optional overrides that are applied to the resource configuration before import.</p>
|
|
8299
8317
|
* @public
|
|
8300
8318
|
*/
|
|
8301
|
-
|
|
8302
|
-
}
|
|
8303
|
-
/**
|
|
8304
|
-
* @public
|
|
8305
|
-
*/
|
|
8306
|
-
export interface UpdateAnalysisPermissionsRequest {
|
|
8319
|
+
OverrideParameters?: AssetBundleImportJobOverrideParameters | undefined;
|
|
8307
8320
|
/**
|
|
8308
|
-
* <p>The
|
|
8309
|
-
*
|
|
8321
|
+
* <p>The failure action for the import job.</p>
|
|
8322
|
+
* <p>If you choose <code>ROLLBACK</code>, failed import jobs will attempt to undo any asset
|
|
8323
|
+
* changes caused by the failed job.</p>
|
|
8324
|
+
* <p>If you choose <code>DO_NOTHING</code>, failed import jobs will not attempt to roll back
|
|
8325
|
+
* any asset changes caused by the failed job, possibly keeping the Amazon Quick Sight account
|
|
8326
|
+
* in an inconsistent state.</p>
|
|
8310
8327
|
* @public
|
|
8311
8328
|
*/
|
|
8312
|
-
|
|
8329
|
+
FailureAction?: AssetBundleImportFailureAction | undefined;
|
|
8313
8330
|
/**
|
|
8314
|
-
* <p>
|
|
8315
|
-
*
|
|
8331
|
+
* <p>Optional permission overrides that are applied to the resource configuration before
|
|
8332
|
+
* import.</p>
|
|
8316
8333
|
* @public
|
|
8317
8334
|
*/
|
|
8318
|
-
|
|
8335
|
+
OverridePermissions?: AssetBundleImportJobOverridePermissions | undefined;
|
|
8319
8336
|
/**
|
|
8320
|
-
* <p>
|
|
8321
|
-
*
|
|
8337
|
+
* <p>Optional tag overrides that are applied to the resource configuration before
|
|
8338
|
+
* import.</p>
|
|
8322
8339
|
* @public
|
|
8323
8340
|
*/
|
|
8324
|
-
|
|
8341
|
+
OverrideTags?: AssetBundleImportJobOverrideTags | undefined;
|
|
8325
8342
|
/**
|
|
8326
|
-
* <p>
|
|
8327
|
-
*
|
|
8343
|
+
* <p>An optional validation strategy override for all analyses and dashboards that is applied
|
|
8344
|
+
* to the resource configuration before import. </p>
|
|
8328
8345
|
* @public
|
|
8329
8346
|
*/
|
|
8330
|
-
|
|
8347
|
+
OverrideValidationStrategy?: AssetBundleImportJobOverrideValidationStrategy | undefined;
|
|
8331
8348
|
}
|
|
8332
8349
|
/**
|
|
8333
8350
|
* @public
|
|
8334
8351
|
*/
|
|
8335
|
-
export interface
|
|
8336
|
-
/**
|
|
8337
|
-
* <p>The Amazon Resource Name (ARN) of the analysis that you updated.</p>
|
|
8338
|
-
* @public
|
|
8339
|
-
*/
|
|
8340
|
-
AnalysisArn?: string | undefined;
|
|
8352
|
+
export interface StartAssetBundleImportJobResponse {
|
|
8341
8353
|
/**
|
|
8342
|
-
* <p>The
|
|
8354
|
+
* <p>The Amazon Resource Name (ARN) for the import job.</p>
|
|
8343
8355
|
* @public
|
|
8344
8356
|
*/
|
|
8345
|
-
|
|
8357
|
+
Arn?: string | undefined;
|
|
8346
8358
|
/**
|
|
8347
|
-
* <p>
|
|
8348
|
-
*
|
|
8359
|
+
* <p>The ID of the job. This ID is unique while the job is running. After the job is
|
|
8360
|
+
* completed, you can reuse this ID for another job.</p>
|
|
8349
8361
|
* @public
|
|
8350
8362
|
*/
|
|
8351
|
-
|
|
8363
|
+
AssetBundleImportJobId?: string | undefined;
|
|
8352
8364
|
/**
|
|
8353
|
-
* <p>The Amazon Web Services
|
|
8365
|
+
* <p>The Amazon Web Services response ID for this operation.</p>
|
|
8354
8366
|
* @public
|
|
8355
8367
|
*/
|
|
8356
8368
|
RequestId?: string | undefined;
|
|
8357
8369
|
/**
|
|
8358
|
-
* <p>The HTTP status of the
|
|
8370
|
+
* <p>The HTTP status of the response.</p>
|
|
8359
8371
|
* @public
|
|
8360
8372
|
*/
|
|
8361
8373
|
Status?: number | undefined;
|
|
@@ -8363,70 +8375,62 @@ export interface UpdateAnalysisPermissionsResponse {
|
|
|
8363
8375
|
/**
|
|
8364
8376
|
* @public
|
|
8365
8377
|
*/
|
|
8366
|
-
export interface
|
|
8378
|
+
export interface StartAutomationJobRequest {
|
|
8367
8379
|
/**
|
|
8368
|
-
* <p>The ID of the Amazon Web Services account
|
|
8380
|
+
* <p>The ID of the Amazon Web Services account that contains the automation.</p>
|
|
8369
8381
|
* @public
|
|
8370
8382
|
*/
|
|
8371
8383
|
AwsAccountId: string | undefined;
|
|
8372
8384
|
/**
|
|
8373
|
-
* <p>The
|
|
8385
|
+
* <p>The ID of the automation group that contains the automation to run.</p>
|
|
8374
8386
|
* @public
|
|
8375
8387
|
*/
|
|
8376
|
-
|
|
8377
|
-
}
|
|
8378
|
-
/**
|
|
8379
|
-
* @public
|
|
8380
|
-
*/
|
|
8381
|
-
export interface UpdateApplicationWithTokenExchangeGrantResponse {
|
|
8388
|
+
AutomationGroupId: string | undefined;
|
|
8382
8389
|
/**
|
|
8383
|
-
* <p>The
|
|
8390
|
+
* <p>The ID of the automation to run.</p>
|
|
8384
8391
|
* @public
|
|
8385
8392
|
*/
|
|
8386
|
-
|
|
8393
|
+
AutomationId: string | undefined;
|
|
8387
8394
|
/**
|
|
8388
|
-
* <p>The
|
|
8395
|
+
* <p>The input payload for the automation job, provided as a JSON string.</p>
|
|
8389
8396
|
* @public
|
|
8390
8397
|
*/
|
|
8391
|
-
|
|
8398
|
+
InputPayload?: string | undefined;
|
|
8392
8399
|
}
|
|
8393
8400
|
/**
|
|
8394
8401
|
* @public
|
|
8395
8402
|
*/
|
|
8396
|
-
export interface
|
|
8403
|
+
export interface StartAutomationJobResponse {
|
|
8397
8404
|
/**
|
|
8398
|
-
* <p>The
|
|
8405
|
+
* <p>The Amazon Resource Name (ARN) of the automation job.</p>
|
|
8399
8406
|
* @public
|
|
8400
8407
|
*/
|
|
8401
|
-
|
|
8408
|
+
Arn: string | undefined;
|
|
8402
8409
|
/**
|
|
8403
|
-
* <p>The ID of the
|
|
8410
|
+
* <p>The ID of the automation job that was started.</p>
|
|
8404
8411
|
* @public
|
|
8405
8412
|
*/
|
|
8406
|
-
|
|
8413
|
+
JobId: string | undefined;
|
|
8407
8414
|
/**
|
|
8408
|
-
* <p>The
|
|
8415
|
+
* <p>The HTTP status of the request.</p>
|
|
8409
8416
|
* @public
|
|
8410
8417
|
*/
|
|
8411
|
-
|
|
8412
|
-
}
|
|
8413
|
-
/**
|
|
8414
|
-
* @public
|
|
8415
|
-
*/
|
|
8416
|
-
export interface UpdateBrandResponse {
|
|
8418
|
+
Status?: number | undefined;
|
|
8417
8419
|
/**
|
|
8418
8420
|
* <p>The Amazon Web Services request ID for this operation.</p>
|
|
8419
8421
|
* @public
|
|
8420
8422
|
*/
|
|
8421
8423
|
RequestId?: string | undefined;
|
|
8424
|
+
}
|
|
8425
|
+
/**
|
|
8426
|
+
* <p>A structure that contains information on the anonymous user configuration.</p>
|
|
8427
|
+
* @public
|
|
8428
|
+
*/
|
|
8429
|
+
export interface SnapshotAnonymousUser {
|
|
8422
8430
|
/**
|
|
8423
|
-
* <p>The
|
|
8424
|
-
*
|
|
8425
|
-
*/
|
|
8426
|
-
BrandDetail?: BrandDetail | undefined;
|
|
8427
|
-
/**
|
|
8428
|
-
* <p>The definition of the brand.</p>
|
|
8431
|
+
* <p>The tags to be used for row-level security (RLS). Make sure that the relevant datasets have RLS tags configured before you start a snapshot export job. You can configure the RLS tags of a dataset with a <code>DataSet$RowLevelPermissionTagConfiguration</code> API call.</p>
|
|
8432
|
+
* <p>These are not the tags that are used for Amazon Web Services resource tagging. For more information on row level security in Amazon Quick Sight, see <a href="https://docs.aws.amazon.com/quicksight/latest/user/quicksight-dev-rls-tags.html">Using Row-Level Security (RLS) with Tags</a>in the <i>Amazon Quick User Guide</i>.</p>
|
|
8429
8433
|
* @public
|
|
8430
8434
|
*/
|
|
8431
|
-
|
|
8435
|
+
RowLevelPermissionTags?: SessionTag[] | undefined;
|
|
8432
8436
|
}
|