@aws-sdk/client-quicksight 3.1020.0 → 3.1022.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 +14 -0
- package/dist-cjs/index.js +48 -0
- package/dist-cjs/schemas/schemas_0.js +186 -82
- package/dist-es/QuickSight.js +4 -0
- package/dist-es/commands/DescribeAutomationJobCommand.js +16 -0
- package/dist-es/commands/StartAutomationJobCommand.js +16 -0
- package/dist-es/commands/index.js +2 -0
- package/dist-es/index.js +1 -0
- package/dist-es/models/enums.js +17 -0
- package/dist-es/models/models_5.js +1 -0
- package/dist-es/schemas/schemas_0.js +160 -56
- package/dist-types/QuickSight.d.ts +14 -0
- package/dist-types/QuickSightClient.d.ts +4 -2
- package/dist-types/commands/BatchCreateTopicReviewedAnswerCommand.d.ts +1 -1
- package/dist-types/commands/CreateAnalysisCommand.d.ts +2007 -161
- package/dist-types/commands/CreateCustomPermissionsCommand.d.ts +3 -0
- package/dist-types/commands/CreateDashboardCommand.d.ts +2007 -161
- package/dist-types/commands/CreateDataSourceCommand.d.ts +9 -4
- package/dist-types/commands/CreateTemplateCommand.d.ts +2007 -161
- package/dist-types/commands/DescribeAnalysisDefinitionCommand.d.ts +2007 -161
- package/dist-types/commands/DescribeAssetBundleImportJobCommand.d.ts +2 -2
- package/dist-types/commands/DescribeAutomationJobCommand.d.ts +104 -0
- package/dist-types/commands/DescribeCustomPermissionsCommand.d.ts +3 -0
- package/dist-types/commands/DescribeDashboardDefinitionCommand.d.ts +2007 -161
- package/dist-types/commands/DescribeDataSourceCommand.d.ts +4 -4
- package/dist-types/commands/DescribeTemplateAliasCommand.d.ts +1 -2
- package/dist-types/commands/DescribeTemplateCommand.d.ts +1 -1
- package/dist-types/commands/DescribeTemplateDefinitionCommand.d.ts +2007 -161
- package/dist-types/commands/ListCustomPermissionsCommand.d.ts +3 -0
- package/dist-types/commands/ListDataSourcesCommand.d.ts +4 -4
- package/dist-types/commands/ListTopicReviewedAnswersCommand.d.ts +2 -1
- package/dist-types/commands/StartAssetBundleImportJobCommand.d.ts +2 -2
- package/dist-types/commands/StartAutomationJobCommand.d.ts +101 -0
- package/dist-types/commands/UpdateAnalysisCommand.d.ts +2007 -161
- package/dist-types/commands/UpdateCustomPermissionsCommand.d.ts +3 -0
- package/dist-types/commands/UpdateDashboardCommand.d.ts +2007 -161
- package/dist-types/commands/UpdateDataSourceCommand.d.ts +9 -4
- package/dist-types/commands/UpdateTemplateCommand.d.ts +2007 -161
- package/dist-types/commands/UpdateUserCustomPermissionCommand.d.ts +2 -1
- package/dist-types/commands/UpdateVPCConnectionCommand.d.ts +1 -1
- package/dist-types/commands/index.d.ts +2 -0
- package/dist-types/index.d.ts +1 -0
- package/dist-types/models/enums.d.ts +41 -0
- package/dist-types/models/models_0.d.ts +16 -16
- package/dist-types/models/models_1.d.ts +84 -30
- package/dist-types/models/models_2.d.ts +96 -213
- package/dist-types/models/models_3.d.ts +334 -230
- package/dist-types/models/models_4.d.ts +282 -250
- package/dist-types/models/models_5.d.ts +248 -0
- package/dist-types/schemas/schemas_0.d.ts +10 -0
- package/dist-types/ts3.4/QuickSight.d.ts +34 -0
- package/dist-types/ts3.4/QuickSightClient.d.ts +12 -0
- package/dist-types/ts3.4/commands/BatchCreateTopicReviewedAnswerCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/DescribeAutomationJobCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/DescribeTemplateAliasCommand.d.ts +4 -2
- package/dist-types/ts3.4/commands/DescribeTemplateCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/ListTopicReviewedAnswersCommand.d.ts +2 -4
- package/dist-types/ts3.4/commands/StartAutomationJobCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/UpdateUserCustomPermissionCommand.d.ts +2 -4
- package/dist-types/ts3.4/commands/UpdateVPCConnectionCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/index.d.ts +2 -0
- package/dist-types/ts3.4/index.d.ts +1 -0
- package/dist-types/ts3.4/models/enums.d.ts +23 -0
- package/dist-types/ts3.4/models/models_0.d.ts +4 -4
- package/dist-types/ts3.4/models/models_1.d.ts +21 -8
- package/dist-types/ts3.4/models/models_2.d.ts +22 -137
- package/dist-types/ts3.4/models/models_3.d.ts +171 -43
- package/dist-types/ts3.4/models/models_4.d.ts +56 -60
- package/dist-types/ts3.4/models/models_5.d.ts +62 -0
- package/dist-types/ts3.4/schemas/schemas_0.d.ts +10 -0
- package/package.json +6 -6
|
@@ -1,6 +1,216 @@
|
|
|
1
|
-
import type { AssetBundleExportFormat, AssetBundleExportJobStatus, AssetBundleImportFailureAction, AssetBundleImportJobStatus, AssignmentStatus, AuthorSpecifiedAggregation, CategoryFilterFunction, CategoryFilterType, ColumnDataRole, ColumnDataSubType, ColumnDataType, ConstantType, DashboardErrorType, DashboardFilterAttribute, DashboardsQAStatus, DataSetFilterAttribute, DataSetImportMode, DataSetUseAs, DataSourceErrorInfoType, DataSourceFilterAttribute, DataSourceType, DayOfWeek, DefaultAggregation, DisplayFormat, FileFormat, FilterClass, FilterOperator, FolderType, HorizontalTextAlignment, IdentityStore, IncludeFolderMembers, IngestionErrorType, IngestionRequestSource, IngestionRequestType, IngestionStatus, IngestionType, MemberType, NamedEntityAggType, NamedFilterAggType, NamedFilterType, NamespaceErrorType, NamespaceStatus, NullFilterType, PersonalizationMode, PropertyRole, PropertyUsage, QDataKeyType, QSearchStatus, RefreshInterval, ResourceStatus, Role, RowLevelPermissionFormatVersion, RowLevelPermissionPolicy, SelfUpgradeStatus, ServiceType, SharingModel, SnapshotJobStatus, Status,
|
|
1
|
+
import type { AssetBundleExportFormat, AssetBundleExportJobStatus, AssetBundleImportFailureAction, AssetBundleImportJobStatus, AssignmentStatus, AuthorSpecifiedAggregation, AutomationJobStatus, CategoryFilterFunction, CategoryFilterType, ColumnDataRole, ColumnDataSubType, ColumnDataType, ConstantType, DashboardErrorType, DashboardFilterAttribute, DashboardsQAStatus, DataSetFilterAttribute, DataSetImportMode, DataSetUseAs, DataSourceErrorInfoType, DataSourceFilterAttribute, DataSourceType, DayOfWeek, DefaultAggregation, DisplayFormat, FileFormat, FilterClass, FilterOperator, FolderType, HorizontalTextAlignment, IdentityStore, IncludeFolderMembers, IngestionErrorType, IngestionRequestSource, IngestionRequestType, IngestionStatus, IngestionType, JoinType, MemberType, NamedEntityAggType, NamedFilterAggType, NamedFilterType, NamespaceErrorType, NamespaceStatus, NullFilterType, PersonalizationMode, PropertyRole, PropertyUsage, QDataKeyType, QSearchStatus, RefreshInterval, ResourceStatus, Role, RowLevelPermissionFormatVersion, RowLevelPermissionPolicy, SelfUpgradeStatus, ServiceType, SharingModel, SnapshotJobStatus, Status, TextQualifier, TextTransform, TopicRelativeDateFilterFunction, TopicScheduleType, TopicTimeGranularity, TopicUserExperienceVersion, VPCConnectionAvailabilityStatus, VPCConnectionResourceStatus } from "./enums";
|
|
2
2
|
import type { AccountCustomization, AccountInfo, AccountSettings, ActionConnector, Analysis, AnalysisDefaults, AnalysisError, AssetOptions, CalculatedField, ColumnConfiguration, Entity, FilterGroup, FontConfiguration, ParameterDeclaration, QueryExecutionOptions, Sheet } from "./models_0";
|
|
3
|
-
import type { _Parameters, AnalysisDefinition, AnonymousUserSnapshotJobResult, AssetBundleCloudFormationOverridePropertyConfiguration, AssetBundleExportJobError, AssetBundleExportJobValidationStrategy, AssetBundleExportJobWarning, AssetBundleImportJobError, AssetBundleImportJobOverrideParameters, AssetBundleImportJobOverridePermissions, AssetBundleImportJobOverrideTags, AssetBundleImportJobOverrideValidationStrategy, AssetBundleImportJobWarning, AssetBundleImportSourceDescription, BorderStyle, BrandDefinition, BrandDetail, Capabilities, CellValueSynonym, CollectiveConstant, ColumnGroup, ColumnGroupSchema, ColumnLevelPermissionRule, ColumnSchema, ComparativeOrder, DashboardPublishOptions, DashboardVersionDefinition, DataPrepConfiguration, DatasetParameter, DataSetReference, DataSetRefreshProperties, DataSetUsageConfiguration, DataSourceParameters, DisplayFormatOptions, FieldFolder,
|
|
3
|
+
import type { _Parameters, AnalysisDefinition, AnonymousUserSnapshotJobResult, AssetBundleCloudFormationOverridePropertyConfiguration, AssetBundleExportJobError, AssetBundleExportJobValidationStrategy, AssetBundleExportJobWarning, AssetBundleImportJobError, AssetBundleImportJobOverrideParameters, AssetBundleImportJobOverridePermissions, AssetBundleImportJobOverrideTags, AssetBundleImportJobOverrideValidationStrategy, AssetBundleImportJobWarning, AssetBundleImportSourceDescription, BorderStyle, BrandDefinition, BrandDetail, Capabilities, CastColumnTypeOperation, CellValueSynonym, CollectiveConstant, ColumnGroup, ColumnGroupSchema, ColumnLevelPermissionRule, ColumnSchema, ComparativeOrder, CreateColumnsOperation, DashboardPublishOptions, DashboardVersionDefinition, DataPrepConfiguration, DatasetParameter, DataSetReference, DataSetRefreshProperties, DataSetUsageConfiguration, DataSourceParameters, DisplayFormatOptions, FieldFolder, FilterOperation, InputColumn, LinkSharingConfiguration, OverrideDatasetParameterOperation, ProjectOperation, RenameColumnOperation, ResourcePermission, SheetDefinition, SnapshotFile, SnapshotJobResultFileGroup, SnapshotS3DestinationConfiguration, SslProperties, StaticFile, Tag, TagColumnOperation, TooltipSheetDefinition, UntagColumnOperation, ValidationStrategy, VpcConnectionProperties } from "./models_2";
|
|
4
|
+
/**
|
|
5
|
+
* <p>A data transformation on a logical table. This is a variant type structure. For this
|
|
6
|
+
* structure to be valid, only one of the attributes can be non-null.</p>
|
|
7
|
+
* @public
|
|
8
|
+
*/
|
|
9
|
+
export type TransformOperation = TransformOperation.CastColumnTypeOperationMember | TransformOperation.CreateColumnsOperationMember | TransformOperation.FilterOperationMember | TransformOperation.OverrideDatasetParameterOperationMember | TransformOperation.ProjectOperationMember | TransformOperation.RenameColumnOperationMember | TransformOperation.TagColumnOperationMember | TransformOperation.UntagColumnOperationMember | TransformOperation.$UnknownMember;
|
|
10
|
+
/**
|
|
11
|
+
* @public
|
|
12
|
+
*/
|
|
13
|
+
export declare namespace TransformOperation {
|
|
14
|
+
/**
|
|
15
|
+
* <p>An operation that projects columns. Operations that come after a projection can only
|
|
16
|
+
* refer to projected columns.</p>
|
|
17
|
+
* @public
|
|
18
|
+
*/
|
|
19
|
+
interface ProjectOperationMember {
|
|
20
|
+
ProjectOperation: ProjectOperation;
|
|
21
|
+
FilterOperation?: never;
|
|
22
|
+
CreateColumnsOperation?: never;
|
|
23
|
+
RenameColumnOperation?: never;
|
|
24
|
+
CastColumnTypeOperation?: never;
|
|
25
|
+
TagColumnOperation?: never;
|
|
26
|
+
UntagColumnOperation?: never;
|
|
27
|
+
OverrideDatasetParameterOperation?: never;
|
|
28
|
+
$unknown?: never;
|
|
29
|
+
}
|
|
30
|
+
/**
|
|
31
|
+
* <p>An operation that filters rows based on some condition.</p>
|
|
32
|
+
* @public
|
|
33
|
+
*/
|
|
34
|
+
interface FilterOperationMember {
|
|
35
|
+
ProjectOperation?: never;
|
|
36
|
+
FilterOperation: FilterOperation;
|
|
37
|
+
CreateColumnsOperation?: never;
|
|
38
|
+
RenameColumnOperation?: never;
|
|
39
|
+
CastColumnTypeOperation?: never;
|
|
40
|
+
TagColumnOperation?: never;
|
|
41
|
+
UntagColumnOperation?: never;
|
|
42
|
+
OverrideDatasetParameterOperation?: never;
|
|
43
|
+
$unknown?: never;
|
|
44
|
+
}
|
|
45
|
+
/**
|
|
46
|
+
* <p>An operation that creates calculated columns. Columns created in one such operation
|
|
47
|
+
* form a lexical closure.</p>
|
|
48
|
+
* @public
|
|
49
|
+
*/
|
|
50
|
+
interface CreateColumnsOperationMember {
|
|
51
|
+
ProjectOperation?: never;
|
|
52
|
+
FilterOperation?: never;
|
|
53
|
+
CreateColumnsOperation: CreateColumnsOperation;
|
|
54
|
+
RenameColumnOperation?: never;
|
|
55
|
+
CastColumnTypeOperation?: never;
|
|
56
|
+
TagColumnOperation?: never;
|
|
57
|
+
UntagColumnOperation?: never;
|
|
58
|
+
OverrideDatasetParameterOperation?: never;
|
|
59
|
+
$unknown?: never;
|
|
60
|
+
}
|
|
61
|
+
/**
|
|
62
|
+
* <p>An operation that renames a column.</p>
|
|
63
|
+
* @public
|
|
64
|
+
*/
|
|
65
|
+
interface RenameColumnOperationMember {
|
|
66
|
+
ProjectOperation?: never;
|
|
67
|
+
FilterOperation?: never;
|
|
68
|
+
CreateColumnsOperation?: never;
|
|
69
|
+
RenameColumnOperation: RenameColumnOperation;
|
|
70
|
+
CastColumnTypeOperation?: never;
|
|
71
|
+
TagColumnOperation?: never;
|
|
72
|
+
UntagColumnOperation?: never;
|
|
73
|
+
OverrideDatasetParameterOperation?: never;
|
|
74
|
+
$unknown?: never;
|
|
75
|
+
}
|
|
76
|
+
/**
|
|
77
|
+
* <p>A transform operation that casts a column to a different type.</p>
|
|
78
|
+
* @public
|
|
79
|
+
*/
|
|
80
|
+
interface CastColumnTypeOperationMember {
|
|
81
|
+
ProjectOperation?: never;
|
|
82
|
+
FilterOperation?: never;
|
|
83
|
+
CreateColumnsOperation?: never;
|
|
84
|
+
RenameColumnOperation?: never;
|
|
85
|
+
CastColumnTypeOperation: CastColumnTypeOperation;
|
|
86
|
+
TagColumnOperation?: never;
|
|
87
|
+
UntagColumnOperation?: never;
|
|
88
|
+
OverrideDatasetParameterOperation?: never;
|
|
89
|
+
$unknown?: never;
|
|
90
|
+
}
|
|
91
|
+
/**
|
|
92
|
+
* <p>An operation that tags a column with additional information.</p>
|
|
93
|
+
* @public
|
|
94
|
+
*/
|
|
95
|
+
interface TagColumnOperationMember {
|
|
96
|
+
ProjectOperation?: never;
|
|
97
|
+
FilterOperation?: never;
|
|
98
|
+
CreateColumnsOperation?: never;
|
|
99
|
+
RenameColumnOperation?: never;
|
|
100
|
+
CastColumnTypeOperation?: never;
|
|
101
|
+
TagColumnOperation: TagColumnOperation;
|
|
102
|
+
UntagColumnOperation?: never;
|
|
103
|
+
OverrideDatasetParameterOperation?: never;
|
|
104
|
+
$unknown?: never;
|
|
105
|
+
}
|
|
106
|
+
/**
|
|
107
|
+
* <p>A transform operation that removes tags associated with a column.</p>
|
|
108
|
+
* @public
|
|
109
|
+
*/
|
|
110
|
+
interface UntagColumnOperationMember {
|
|
111
|
+
ProjectOperation?: never;
|
|
112
|
+
FilterOperation?: never;
|
|
113
|
+
CreateColumnsOperation?: never;
|
|
114
|
+
RenameColumnOperation?: never;
|
|
115
|
+
CastColumnTypeOperation?: never;
|
|
116
|
+
TagColumnOperation?: never;
|
|
117
|
+
UntagColumnOperation: UntagColumnOperation;
|
|
118
|
+
OverrideDatasetParameterOperation?: never;
|
|
119
|
+
$unknown?: never;
|
|
120
|
+
}
|
|
121
|
+
/**
|
|
122
|
+
* <p>A transform operation that overrides the dataset parameter values that are defined in another dataset.</p>
|
|
123
|
+
* @public
|
|
124
|
+
*/
|
|
125
|
+
interface OverrideDatasetParameterOperationMember {
|
|
126
|
+
ProjectOperation?: never;
|
|
127
|
+
FilterOperation?: never;
|
|
128
|
+
CreateColumnsOperation?: never;
|
|
129
|
+
RenameColumnOperation?: never;
|
|
130
|
+
CastColumnTypeOperation?: never;
|
|
131
|
+
TagColumnOperation?: never;
|
|
132
|
+
UntagColumnOperation?: never;
|
|
133
|
+
OverrideDatasetParameterOperation: OverrideDatasetParameterOperation;
|
|
134
|
+
$unknown?: never;
|
|
135
|
+
}
|
|
136
|
+
/**
|
|
137
|
+
* @public
|
|
138
|
+
*/
|
|
139
|
+
interface $UnknownMember {
|
|
140
|
+
ProjectOperation?: never;
|
|
141
|
+
FilterOperation?: never;
|
|
142
|
+
CreateColumnsOperation?: never;
|
|
143
|
+
RenameColumnOperation?: never;
|
|
144
|
+
CastColumnTypeOperation?: never;
|
|
145
|
+
TagColumnOperation?: never;
|
|
146
|
+
UntagColumnOperation?: never;
|
|
147
|
+
OverrideDatasetParameterOperation?: never;
|
|
148
|
+
$unknown: [string, any];
|
|
149
|
+
}
|
|
150
|
+
/**
|
|
151
|
+
* @deprecated unused in schema-serde mode.
|
|
152
|
+
*
|
|
153
|
+
*/
|
|
154
|
+
interface Visitor<T> {
|
|
155
|
+
ProjectOperation: (value: ProjectOperation) => T;
|
|
156
|
+
FilterOperation: (value: FilterOperation) => T;
|
|
157
|
+
CreateColumnsOperation: (value: CreateColumnsOperation) => T;
|
|
158
|
+
RenameColumnOperation: (value: RenameColumnOperation) => T;
|
|
159
|
+
CastColumnTypeOperation: (value: CastColumnTypeOperation) => T;
|
|
160
|
+
TagColumnOperation: (value: TagColumnOperation) => T;
|
|
161
|
+
UntagColumnOperation: (value: UntagColumnOperation) => T;
|
|
162
|
+
OverrideDatasetParameterOperation: (value: OverrideDatasetParameterOperation) => T;
|
|
163
|
+
_: (name: string, value: any) => T;
|
|
164
|
+
}
|
|
165
|
+
}
|
|
166
|
+
/**
|
|
167
|
+
* <p>Properties associated with the columns participating in a join.</p>
|
|
168
|
+
* @public
|
|
169
|
+
*/
|
|
170
|
+
export interface JoinKeyProperties {
|
|
171
|
+
/**
|
|
172
|
+
* <p>A value that indicates that a row in a table is uniquely identified by the columns in
|
|
173
|
+
* a join key. This is used by Quick Sight to optimize query performance.</p>
|
|
174
|
+
* @public
|
|
175
|
+
*/
|
|
176
|
+
UniqueKey?: boolean | undefined;
|
|
177
|
+
}
|
|
178
|
+
/**
|
|
179
|
+
* <p>The instructions associated with a join. </p>
|
|
180
|
+
* @public
|
|
181
|
+
*/
|
|
182
|
+
export interface JoinInstruction {
|
|
183
|
+
/**
|
|
184
|
+
* <p>The operand on the left side of a join.</p>
|
|
185
|
+
* @public
|
|
186
|
+
*/
|
|
187
|
+
LeftOperand: string | undefined;
|
|
188
|
+
/**
|
|
189
|
+
* <p>The operand on the right side of a join.</p>
|
|
190
|
+
* @public
|
|
191
|
+
*/
|
|
192
|
+
RightOperand: string | undefined;
|
|
193
|
+
/**
|
|
194
|
+
* <p>Join key properties of the left operand.</p>
|
|
195
|
+
* @public
|
|
196
|
+
*/
|
|
197
|
+
LeftJoinKeyProperties?: JoinKeyProperties | undefined;
|
|
198
|
+
/**
|
|
199
|
+
* <p>Join key properties of the right operand.</p>
|
|
200
|
+
* @public
|
|
201
|
+
*/
|
|
202
|
+
RightJoinKeyProperties?: JoinKeyProperties | undefined;
|
|
203
|
+
/**
|
|
204
|
+
* <p>The type of join that it is.</p>
|
|
205
|
+
* @public
|
|
206
|
+
*/
|
|
207
|
+
Type: JoinType | undefined;
|
|
208
|
+
/**
|
|
209
|
+
* <p>The join instructions provided in the <code>ON</code> clause of a join.</p>
|
|
210
|
+
* @public
|
|
211
|
+
*/
|
|
212
|
+
OnClause: string | undefined;
|
|
213
|
+
}
|
|
4
214
|
/**
|
|
5
215
|
* <p>Information about the source of a logical table. This is a variant type structure. For
|
|
6
216
|
* this structure to be valid, only one of the attributes can be non-null.</p>
|
|
@@ -653,6 +863,34 @@ export interface KeyPairCredentials {
|
|
|
653
863
|
*/
|
|
654
864
|
PrivateKeyPassphrase?: string | undefined;
|
|
655
865
|
}
|
|
866
|
+
/**
|
|
867
|
+
* <p>The OAuth 2.0 client credentials used for authenticating a data source connection.
|
|
868
|
+
* Use this structure to provide a client ID, client secret, and username directly
|
|
869
|
+
* instead of referencing a secret stored in Amazon Secrets Manager. This structure
|
|
870
|
+
* supports data sources that use two-legged OAuth (2LO) authentication, such as
|
|
871
|
+
* Snowflake.</p>
|
|
872
|
+
* @public
|
|
873
|
+
*/
|
|
874
|
+
export interface OAuthClientCredentials {
|
|
875
|
+
/**
|
|
876
|
+
* <p>The client ID of the OAuth 2.0 application that is registered with the data source
|
|
877
|
+
* provider.</p>
|
|
878
|
+
* @public
|
|
879
|
+
*/
|
|
880
|
+
ClientId?: string | undefined;
|
|
881
|
+
/**
|
|
882
|
+
* <p>The client secret of the OAuth 2.0 application that is registered with the data source
|
|
883
|
+
* provider.</p>
|
|
884
|
+
* @public
|
|
885
|
+
*/
|
|
886
|
+
ClientSecret?: string | undefined;
|
|
887
|
+
/**
|
|
888
|
+
* <p>The username of the account that is used for OAuth 2.0 client credentials
|
|
889
|
+
* authentication with the data source provider.</p>
|
|
890
|
+
* @public
|
|
891
|
+
*/
|
|
892
|
+
Username?: string | undefined;
|
|
893
|
+
}
|
|
656
894
|
/**
|
|
657
895
|
* <p>The credentials for authenticating with a web proxy server.</p>
|
|
658
896
|
* @public
|
|
@@ -706,6 +944,15 @@ export interface DataSourceCredentials {
|
|
|
706
944
|
* @public
|
|
707
945
|
*/
|
|
708
946
|
WebProxyCredentials?: WebProxyCredentials | undefined;
|
|
947
|
+
/**
|
|
948
|
+
* <p>The OAuth client credentials for connecting to a data source using OAuth 2.0 client
|
|
949
|
+
* credentials (2LO) authentication. For more information, see
|
|
950
|
+
* <code>
|
|
951
|
+
* <a href="https://docs.aws.amazon.com/quicksight/latest/APIReference/API_OAuthClientCredentials.html">OAuthClientCredentials</a>
|
|
952
|
+
* </code>.</p>
|
|
953
|
+
* @public
|
|
954
|
+
*/
|
|
955
|
+
OAuthClientCredentials?: OAuthClientCredentials | undefined;
|
|
709
956
|
}
|
|
710
957
|
/**
|
|
711
958
|
* @public
|
|
@@ -1567,6 +1814,11 @@ export interface TemplateVersionDefinition {
|
|
|
1567
1814
|
* @public
|
|
1568
1815
|
*/
|
|
1569
1816
|
Sheets?: SheetDefinition[] | undefined;
|
|
1817
|
+
/**
|
|
1818
|
+
* <p>An array of tooltip sheet definitions for a template.</p>
|
|
1819
|
+
* @public
|
|
1820
|
+
*/
|
|
1821
|
+
TooltipSheets?: TooltipSheetDefinition[] | undefined;
|
|
1570
1822
|
/**
|
|
1571
1823
|
* <p>An array of calculated field definitions for the template.</p>
|
|
1572
1824
|
* @public
|
|
@@ -6125,6 +6377,86 @@ export interface DescribeAssetBundleImportJobResponse {
|
|
|
6125
6377
|
*/
|
|
6126
6378
|
Warnings?: AssetBundleImportJobWarning[] | undefined;
|
|
6127
6379
|
}
|
|
6380
|
+
/**
|
|
6381
|
+
* @public
|
|
6382
|
+
*/
|
|
6383
|
+
export interface DescribeAutomationJobRequest {
|
|
6384
|
+
/**
|
|
6385
|
+
* <p>The ID of the Amazon Web Services account that contains the automation job.</p>
|
|
6386
|
+
* @public
|
|
6387
|
+
*/
|
|
6388
|
+
AwsAccountId: string | undefined;
|
|
6389
|
+
/**
|
|
6390
|
+
* <p>The ID of the automation group that contains the automation.</p>
|
|
6391
|
+
* @public
|
|
6392
|
+
*/
|
|
6393
|
+
AutomationGroupId: string | undefined;
|
|
6394
|
+
/**
|
|
6395
|
+
* <p>The ID of the automation that the job belongs to.</p>
|
|
6396
|
+
* @public
|
|
6397
|
+
*/
|
|
6398
|
+
AutomationId: string | undefined;
|
|
6399
|
+
/**
|
|
6400
|
+
* <p>A Boolean value that indicates whether to include the input payload in the response. If set to <code>true</code>, the input payload will be included. If set to <code>false</code>, the input payload will be returned as <code>null</code>.</p>
|
|
6401
|
+
* @public
|
|
6402
|
+
*/
|
|
6403
|
+
IncludeInputPayload?: boolean | undefined;
|
|
6404
|
+
/**
|
|
6405
|
+
* <p>A Boolean value that indicates whether to include the output payload in the response. If set to <code>true</code>, the output payload will be included. If set to <code>false</code>, the output payload will be returned as <code>null</code>.</p>
|
|
6406
|
+
* @public
|
|
6407
|
+
*/
|
|
6408
|
+
IncludeOutputPayload?: boolean | undefined;
|
|
6409
|
+
/**
|
|
6410
|
+
* <p>The ID of the automation job to describe.</p>
|
|
6411
|
+
* @public
|
|
6412
|
+
*/
|
|
6413
|
+
JobId: string | undefined;
|
|
6414
|
+
}
|
|
6415
|
+
/**
|
|
6416
|
+
* @public
|
|
6417
|
+
*/
|
|
6418
|
+
export interface DescribeAutomationJobResponse {
|
|
6419
|
+
/**
|
|
6420
|
+
* <p>The Amazon Resource Name (ARN) of the automation job.</p>
|
|
6421
|
+
* @public
|
|
6422
|
+
*/
|
|
6423
|
+
Arn: string | undefined;
|
|
6424
|
+
/**
|
|
6425
|
+
* <p>The time that the automation job was created.</p>
|
|
6426
|
+
* @public
|
|
6427
|
+
*/
|
|
6428
|
+
CreatedAt?: Date | undefined;
|
|
6429
|
+
/**
|
|
6430
|
+
* <p>The time that the automation job started running.</p>
|
|
6431
|
+
* @public
|
|
6432
|
+
*/
|
|
6433
|
+
StartedAt?: Date | undefined;
|
|
6434
|
+
/**
|
|
6435
|
+
* <p>The time that the automation job finished running.</p>
|
|
6436
|
+
* @public
|
|
6437
|
+
*/
|
|
6438
|
+
EndedAt?: Date | undefined;
|
|
6439
|
+
/**
|
|
6440
|
+
* <p>The current status of the automation job.</p>
|
|
6441
|
+
* @public
|
|
6442
|
+
*/
|
|
6443
|
+
JobStatus: AutomationJobStatus | undefined;
|
|
6444
|
+
/**
|
|
6445
|
+
* <p>The input payload that was provided when the automation job was started. This field is only included when <code>IncludeInputPayload</code> is set to <code>true</code> in the request.</p>
|
|
6446
|
+
* @public
|
|
6447
|
+
*/
|
|
6448
|
+
InputPayload?: string | undefined;
|
|
6449
|
+
/**
|
|
6450
|
+
* <p>The output payload that was generated by the automation job. This field is only included when <code>IncludeOutputPayload</code> is set to <code>true</code> in the request.</p>
|
|
6451
|
+
* @public
|
|
6452
|
+
*/
|
|
6453
|
+
OutputPayload?: string | undefined;
|
|
6454
|
+
/**
|
|
6455
|
+
* <p>The Amazon Web Services request ID for this operation.</p>
|
|
6456
|
+
* @public
|
|
6457
|
+
*/
|
|
6458
|
+
RequestId?: string | undefined;
|
|
6459
|
+
}
|
|
6128
6460
|
/**
|
|
6129
6461
|
* @public
|
|
6130
6462
|
*/
|
|
@@ -8042,231 +8374,3 @@ export interface DescribeSelfUpgradeConfigurationResponse {
|
|
|
8042
8374
|
*/
|
|
8043
8375
|
Status?: number | undefined;
|
|
8044
8376
|
}
|
|
8045
|
-
/**
|
|
8046
|
-
* @public
|
|
8047
|
-
*/
|
|
8048
|
-
export interface DescribeTemplateRequest {
|
|
8049
|
-
/**
|
|
8050
|
-
* <p>The ID of the Amazon Web Services account that contains the template that you're describing.</p>
|
|
8051
|
-
* @public
|
|
8052
|
-
*/
|
|
8053
|
-
AwsAccountId: string | undefined;
|
|
8054
|
-
/**
|
|
8055
|
-
* <p>The ID for the template.</p>
|
|
8056
|
-
* @public
|
|
8057
|
-
*/
|
|
8058
|
-
TemplateId: string | undefined;
|
|
8059
|
-
/**
|
|
8060
|
-
* <p>(Optional) The number for the version to describe. If a <code>VersionNumber</code> parameter
|
|
8061
|
-
* value isn't provided, the latest version of the template is described.</p>
|
|
8062
|
-
* @public
|
|
8063
|
-
*/
|
|
8064
|
-
VersionNumber?: number | undefined;
|
|
8065
|
-
/**
|
|
8066
|
-
* <p>The alias of the template that you want to describe. If you name a specific alias, you
|
|
8067
|
-
* describe the version that the alias points to. You can specify the latest version of the
|
|
8068
|
-
* template by providing the keyword <code>$LATEST</code> in the <code>AliasName</code>
|
|
8069
|
-
* parameter. The keyword <code>$PUBLISHED</code> doesn't apply to templates.</p>
|
|
8070
|
-
* @public
|
|
8071
|
-
*/
|
|
8072
|
-
AliasName?: string | undefined;
|
|
8073
|
-
}
|
|
8074
|
-
/**
|
|
8075
|
-
* <p>List of errors that occurred when the template version creation failed.</p>
|
|
8076
|
-
* @public
|
|
8077
|
-
*/
|
|
8078
|
-
export interface TemplateError {
|
|
8079
|
-
/**
|
|
8080
|
-
* <p>Type of error.</p>
|
|
8081
|
-
* @public
|
|
8082
|
-
*/
|
|
8083
|
-
Type?: TemplateErrorType | undefined;
|
|
8084
|
-
/**
|
|
8085
|
-
* <p>Description of the error type.</p>
|
|
8086
|
-
* @public
|
|
8087
|
-
*/
|
|
8088
|
-
Message?: string | undefined;
|
|
8089
|
-
/**
|
|
8090
|
-
* <p>An error path that shows which entities caused the template error.</p>
|
|
8091
|
-
* @public
|
|
8092
|
-
*/
|
|
8093
|
-
ViolatedEntities?: Entity[] | undefined;
|
|
8094
|
-
}
|
|
8095
|
-
/**
|
|
8096
|
-
* <p>A version of a template.</p>
|
|
8097
|
-
* @public
|
|
8098
|
-
*/
|
|
8099
|
-
export interface TemplateVersion {
|
|
8100
|
-
/**
|
|
8101
|
-
* <p>The time that this template version was created.</p>
|
|
8102
|
-
* @public
|
|
8103
|
-
*/
|
|
8104
|
-
CreatedTime?: Date | undefined;
|
|
8105
|
-
/**
|
|
8106
|
-
* <p>Errors associated with this template version.</p>
|
|
8107
|
-
* @public
|
|
8108
|
-
*/
|
|
8109
|
-
Errors?: TemplateError[] | undefined;
|
|
8110
|
-
/**
|
|
8111
|
-
* <p>The version number of the template version.</p>
|
|
8112
|
-
* @public
|
|
8113
|
-
*/
|
|
8114
|
-
VersionNumber?: number | undefined;
|
|
8115
|
-
/**
|
|
8116
|
-
* <p>The status that is associated with the template.</p>
|
|
8117
|
-
* <ul>
|
|
8118
|
-
* <li>
|
|
8119
|
-
* <p>
|
|
8120
|
-
* <code>CREATION_IN_PROGRESS</code>
|
|
8121
|
-
* </p>
|
|
8122
|
-
* </li>
|
|
8123
|
-
* <li>
|
|
8124
|
-
* <p>
|
|
8125
|
-
* <code>CREATION_SUCCESSFUL</code>
|
|
8126
|
-
* </p>
|
|
8127
|
-
* </li>
|
|
8128
|
-
* <li>
|
|
8129
|
-
* <p>
|
|
8130
|
-
* <code>CREATION_FAILED</code>
|
|
8131
|
-
* </p>
|
|
8132
|
-
* </li>
|
|
8133
|
-
* <li>
|
|
8134
|
-
* <p>
|
|
8135
|
-
* <code>UPDATE_IN_PROGRESS</code>
|
|
8136
|
-
* </p>
|
|
8137
|
-
* </li>
|
|
8138
|
-
* <li>
|
|
8139
|
-
* <p>
|
|
8140
|
-
* <code>UPDATE_SUCCESSFUL</code>
|
|
8141
|
-
* </p>
|
|
8142
|
-
* </li>
|
|
8143
|
-
* <li>
|
|
8144
|
-
* <p>
|
|
8145
|
-
* <code>UPDATE_FAILED</code>
|
|
8146
|
-
* </p>
|
|
8147
|
-
* </li>
|
|
8148
|
-
* <li>
|
|
8149
|
-
* <p>
|
|
8150
|
-
* <code>DELETED</code>
|
|
8151
|
-
* </p>
|
|
8152
|
-
* </li>
|
|
8153
|
-
* </ul>
|
|
8154
|
-
* @public
|
|
8155
|
-
*/
|
|
8156
|
-
Status?: ResourceStatus | undefined;
|
|
8157
|
-
/**
|
|
8158
|
-
* <p>Schema of the dataset identified by the placeholder. Any dashboard created from this
|
|
8159
|
-
* template should be bound to new datasets matching the same schema described through this
|
|
8160
|
-
* API operation.</p>
|
|
8161
|
-
* @public
|
|
8162
|
-
*/
|
|
8163
|
-
DataSetConfigurations?: DataSetConfiguration[] | undefined;
|
|
8164
|
-
/**
|
|
8165
|
-
* <p>The description of the template.</p>
|
|
8166
|
-
* @public
|
|
8167
|
-
*/
|
|
8168
|
-
Description?: string | undefined;
|
|
8169
|
-
/**
|
|
8170
|
-
* <p>The Amazon Resource Name (ARN) of an analysis or template that was used to create this
|
|
8171
|
-
* template.</p>
|
|
8172
|
-
* @public
|
|
8173
|
-
*/
|
|
8174
|
-
SourceEntityArn?: string | undefined;
|
|
8175
|
-
/**
|
|
8176
|
-
* <p>The ARN of the theme associated with this version of the template.</p>
|
|
8177
|
-
* @public
|
|
8178
|
-
*/
|
|
8179
|
-
ThemeArn?: string | undefined;
|
|
8180
|
-
/**
|
|
8181
|
-
* <p>A list of the associated sheets with the unique identifier and name of each sheet.</p>
|
|
8182
|
-
* @public
|
|
8183
|
-
*/
|
|
8184
|
-
Sheets?: Sheet[] | undefined;
|
|
8185
|
-
}
|
|
8186
|
-
/**
|
|
8187
|
-
* <p>A template object. A <i>template</i> is an entity in Quick Sight that
|
|
8188
|
-
* encapsulates the metadata required to create an analysis and that you can use to create
|
|
8189
|
-
* a dashboard. A template adds a layer of abstraction by using placeholders to replace the
|
|
8190
|
-
* dataset associated with an analysis. You can use templates to create dashboards by
|
|
8191
|
-
* replacing dataset placeholders with datasets that follow the same schema that was used
|
|
8192
|
-
* to create the source analysis and template.</p>
|
|
8193
|
-
* <p>You can share templates across Amazon Web Services accounts by allowing users in other Amazon Web Services accounts to
|
|
8194
|
-
* create a template or a dashboard from an existing template.</p>
|
|
8195
|
-
* @public
|
|
8196
|
-
*/
|
|
8197
|
-
export interface Template {
|
|
8198
|
-
/**
|
|
8199
|
-
* <p>The Amazon Resource Name (ARN) of the template.</p>
|
|
8200
|
-
* @public
|
|
8201
|
-
*/
|
|
8202
|
-
Arn?: string | undefined;
|
|
8203
|
-
/**
|
|
8204
|
-
* <p>The display name of the template.</p>
|
|
8205
|
-
* @public
|
|
8206
|
-
*/
|
|
8207
|
-
Name?: string | undefined;
|
|
8208
|
-
/**
|
|
8209
|
-
* <p>A structure describing the versions of the template.</p>
|
|
8210
|
-
* @public
|
|
8211
|
-
*/
|
|
8212
|
-
Version?: TemplateVersion | undefined;
|
|
8213
|
-
/**
|
|
8214
|
-
* <p>The ID for the template. This is unique per Amazon Web Services Region for each Amazon Web Services account.</p>
|
|
8215
|
-
* @public
|
|
8216
|
-
*/
|
|
8217
|
-
TemplateId?: string | undefined;
|
|
8218
|
-
/**
|
|
8219
|
-
* <p>Time when this was last updated.</p>
|
|
8220
|
-
* @public
|
|
8221
|
-
*/
|
|
8222
|
-
LastUpdatedTime?: Date | undefined;
|
|
8223
|
-
/**
|
|
8224
|
-
* <p>Time when this was created.</p>
|
|
8225
|
-
* @public
|
|
8226
|
-
*/
|
|
8227
|
-
CreatedTime?: Date | undefined;
|
|
8228
|
-
}
|
|
8229
|
-
/**
|
|
8230
|
-
* @public
|
|
8231
|
-
*/
|
|
8232
|
-
export interface DescribeTemplateResponse {
|
|
8233
|
-
/**
|
|
8234
|
-
* <p>The template structure for the object you want to describe.</p>
|
|
8235
|
-
* @public
|
|
8236
|
-
*/
|
|
8237
|
-
Template?: Template | undefined;
|
|
8238
|
-
/**
|
|
8239
|
-
* <p>The HTTP status of the request.</p>
|
|
8240
|
-
* @public
|
|
8241
|
-
*/
|
|
8242
|
-
Status?: number | undefined;
|
|
8243
|
-
/**
|
|
8244
|
-
* <p>The Amazon Web Services request ID for this operation.</p>
|
|
8245
|
-
* @public
|
|
8246
|
-
*/
|
|
8247
|
-
RequestId?: string | undefined;
|
|
8248
|
-
}
|
|
8249
|
-
/**
|
|
8250
|
-
* @public
|
|
8251
|
-
*/
|
|
8252
|
-
export interface DescribeTemplateAliasRequest {
|
|
8253
|
-
/**
|
|
8254
|
-
* <p>The ID of the Amazon Web Services account that contains the template alias that you're
|
|
8255
|
-
* describing.</p>
|
|
8256
|
-
* @public
|
|
8257
|
-
*/
|
|
8258
|
-
AwsAccountId: string | undefined;
|
|
8259
|
-
/**
|
|
8260
|
-
* <p>The ID for the template.</p>
|
|
8261
|
-
* @public
|
|
8262
|
-
*/
|
|
8263
|
-
TemplateId: string | undefined;
|
|
8264
|
-
/**
|
|
8265
|
-
* <p>The name of the template alias that you want to describe. If you name a specific alias, you
|
|
8266
|
-
* describe the version that the alias points to. You can specify the latest version of the
|
|
8267
|
-
* template by providing the keyword <code>$LATEST</code> in the <code>AliasName</code>
|
|
8268
|
-
* parameter. The keyword <code>$PUBLISHED</code> doesn't apply to templates.</p>
|
|
8269
|
-
* @public
|
|
8270
|
-
*/
|
|
8271
|
-
AliasName: string | undefined;
|
|
8272
|
-
}
|