@aws-sdk/client-quicksight 3.387.0 → 3.390.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/dist-cjs/commands/UpdateDashboardCommand.js +2 -2
- package/dist-cjs/endpoint/ruleset.js +1 -1
- package/dist-cjs/models/models_1.js +14 -7
- package/dist-cjs/models/models_2.js +12 -3
- package/dist-cjs/models/models_3.js +2 -6
- package/dist-cjs/models/models_4.js +6 -1
- package/dist-es/commands/UpdateDashboardCommand.js +1 -1
- package/dist-es/endpoint/ruleset.js +1 -1
- package/dist-es/models/models_1.js +10 -3
- package/dist-es/models/models_2.js +9 -0
- package/dist-es/models/models_3.js +1 -4
- package/dist-es/models/models_4.js +5 -1
- package/dist-types/commands/CreateAccountSubscriptionCommand.d.ts +1 -1
- package/dist-types/commands/CreateAnalysisCommand.d.ts +23 -5
- package/dist-types/commands/CreateDashboardCommand.d.ts +23 -5
- package/dist-types/commands/CreateTemplateCommand.d.ts +23 -5
- package/dist-types/commands/CreateTopicCommand.d.ts +4 -2
- package/dist-types/commands/DeleteAccountCustomizationCommand.d.ts +1 -1
- package/dist-types/commands/DescribeAccountSubscriptionCommand.d.ts +1 -0
- package/dist-types/commands/DescribeAnalysisDefinitionCommand.d.ts +23 -5
- package/dist-types/commands/DescribeDashboardDefinitionCommand.d.ts +23 -5
- package/dist-types/commands/DescribeTemplateDefinitionCommand.d.ts +23 -5
- package/dist-types/commands/DescribeTopicCommand.d.ts +4 -2
- package/dist-types/commands/DescribeUserCommand.d.ts +1 -1
- package/dist-types/commands/ListUsersCommand.d.ts +1 -1
- package/dist-types/commands/RegisterUserCommand.d.ts +2 -2
- package/dist-types/commands/StartDashboardSnapshotJobCommand.d.ts +9 -1
- package/dist-types/commands/UpdateAnalysisCommand.d.ts +23 -5
- package/dist-types/commands/UpdateAnalysisPermissionsCommand.d.ts +1 -1
- package/dist-types/commands/UpdateDashboardCommand.d.ts +24 -6
- package/dist-types/commands/UpdateTemplateCommand.d.ts +23 -5
- package/dist-types/commands/UpdateTopicCommand.d.ts +4 -2
- package/dist-types/commands/UpdateUserCommand.d.ts +1 -1
- package/dist-types/models/models_0.d.ts +5 -0
- package/dist-types/models/models_1.d.ts +91 -57
- package/dist-types/models/models_2.d.ts +72 -116
- package/dist-types/models/models_3.d.ts +114 -192
- package/dist-types/models/models_4.d.ts +192 -1
- package/dist-types/ts3.4/commands/DeleteAccountCustomizationCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/UpdateAnalysisPermissionsCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/UpdateDashboardCommand.d.ts +1 -1
- package/dist-types/ts3.4/models/models_0.d.ts +1 -0
- package/dist-types/ts3.4/models/models_1.d.ts +26 -20
- package/dist-types/ts3.4/models/models_2.d.ts +29 -24
- package/dist-types/ts3.4/models/models_3.d.ts +24 -38
- package/dist-types/ts3.4/models/models_4.d.ts +39 -0
- package/package.json +3 -3
|
@@ -1,7 +1,61 @@
|
|
|
1
1
|
import { ExceptionOptionType as __ExceptionOptionType } from "@smithy/smithy-client";
|
|
2
2
|
import { AccountCustomization, AdHocFilteringOption, AmazonElasticsearchParameters, AmazonOpenSearchParameters, AnalysisDefaults, CalculatedField, ColumnConfiguration, DashboardBehavior, DataSetIdentifierDeclaration, Edition, Entity, FilterGroup, NumberScale, ParameterDeclaration, ResourceStatus, Sheet, TimeGranularity } from "./models_0";
|
|
3
|
-
import { AnalysisDefinition, AnalysisSourceEntity, AssetBundleExportJobAnalysisOverrideProperties, AssetBundleExportJobDashboardOverrideProperties, AssetBundleExportJobDataSetOverrideProperties,
|
|
3
|
+
import { AnalysisDefinition, AnalysisSourceEntity, AssetBundleExportJobAnalysisOverrideProperties, AssetBundleExportJobDashboardOverrideProperties, AssetBundleExportJobDataSetOverrideProperties, AssetBundleExportJobDataSourcePropertyToOverride, DataSetReference, FilterOperator, SheetDefinition } from "./models_1";
|
|
4
4
|
import { QuickSightServiceException as __BaseException } from "./QuickSightServiceException";
|
|
5
|
+
/**
|
|
6
|
+
* @public
|
|
7
|
+
* <p>Controls how a specific <code>DataSource</code> resource is parameterized in the returned CloudFormation template.</p>
|
|
8
|
+
*/
|
|
9
|
+
export interface AssetBundleExportJobDataSourceOverrideProperties {
|
|
10
|
+
/**
|
|
11
|
+
* @public
|
|
12
|
+
* <p>The ARN of the specific <code>DataSource</code> resource whose override properties are configured in this structure.</p>
|
|
13
|
+
*/
|
|
14
|
+
Arn?: string;
|
|
15
|
+
/**
|
|
16
|
+
* @public
|
|
17
|
+
* <p>A list of <code>DataSource</code> resource properties to generate variables for in the returned CloudFormation template.</p>
|
|
18
|
+
*/
|
|
19
|
+
Properties: (AssetBundleExportJobDataSourcePropertyToOverride | string)[] | undefined;
|
|
20
|
+
}
|
|
21
|
+
/**
|
|
22
|
+
* @public
|
|
23
|
+
* @enum
|
|
24
|
+
*/
|
|
25
|
+
export declare const AssetBundleExportJobRefreshSchedulePropertyToOverride: {
|
|
26
|
+
readonly START_AFTER_DATE_TIME: "StartAfterDateTime";
|
|
27
|
+
};
|
|
28
|
+
/**
|
|
29
|
+
* @public
|
|
30
|
+
*/
|
|
31
|
+
export type AssetBundleExportJobRefreshSchedulePropertyToOverride = (typeof AssetBundleExportJobRefreshSchedulePropertyToOverride)[keyof typeof AssetBundleExportJobRefreshSchedulePropertyToOverride];
|
|
32
|
+
/**
|
|
33
|
+
* @public
|
|
34
|
+
* <p>Controls how a specific <code>RefreshSchedule</code> resource is parameterized in the returned CloudFormation template.</p>
|
|
35
|
+
*/
|
|
36
|
+
export interface AssetBundleExportJobRefreshScheduleOverrideProperties {
|
|
37
|
+
/**
|
|
38
|
+
* @public
|
|
39
|
+
* <p>The ARN of the specific <code>RefreshSchedule</code> resource whose override properties are configured in this structure.</p>
|
|
40
|
+
*/
|
|
41
|
+
Arn?: string;
|
|
42
|
+
/**
|
|
43
|
+
* @public
|
|
44
|
+
* <p>A list of <code>RefreshSchedule</code> resource properties to generate variables for in the returned CloudFormation template.</p>
|
|
45
|
+
*/
|
|
46
|
+
Properties: (AssetBundleExportJobRefreshSchedulePropertyToOverride | string)[] | undefined;
|
|
47
|
+
}
|
|
48
|
+
/**
|
|
49
|
+
* @public
|
|
50
|
+
* <p>An optional structure that configures resource ID overrides for the export job.</p>
|
|
51
|
+
*/
|
|
52
|
+
export interface AssetBundleExportJobResourceIdOverrideConfiguration {
|
|
53
|
+
/**
|
|
54
|
+
* @public
|
|
55
|
+
* <p>An option to request a CloudFormation variable for a prefix to be prepended to each resource's ID before import. The prefix is only added to the asset IDs and does not change the name of the asset.</p>
|
|
56
|
+
*/
|
|
57
|
+
PrefixForAllResources?: boolean;
|
|
58
|
+
}
|
|
5
59
|
/**
|
|
6
60
|
* @public
|
|
7
61
|
* @enum
|
|
@@ -1764,6 +1818,7 @@ export type AssignmentStatus = (typeof AssignmentStatus)[keyof typeof Assignment
|
|
|
1764
1818
|
export declare const AuthenticationMethodOption: {
|
|
1765
1819
|
readonly ACTIVE_DIRECTORY: "ACTIVE_DIRECTORY";
|
|
1766
1820
|
readonly IAM_AND_QUICKSIGHT: "IAM_AND_QUICKSIGHT";
|
|
1821
|
+
readonly IAM_IDENTITY_CENTER: "IAM_IDENTITY_CENTER";
|
|
1767
1822
|
readonly IAM_ONLY: "IAM_ONLY";
|
|
1768
1823
|
};
|
|
1769
1824
|
/**
|
|
@@ -6111,8 +6166,13 @@ export declare const DefaultAggregation: {
|
|
|
6111
6166
|
readonly COUNT: "COUNT";
|
|
6112
6167
|
readonly DISTINCT_COUNT: "DISTINCT_COUNT";
|
|
6113
6168
|
readonly MAX: "MAX";
|
|
6169
|
+
readonly MEDIAN: "MEDIAN";
|
|
6114
6170
|
readonly MIN: "MIN";
|
|
6171
|
+
readonly STDEV: "STDEV";
|
|
6172
|
+
readonly STDEVP: "STDEVP";
|
|
6115
6173
|
readonly SUM: "SUM";
|
|
6174
|
+
readonly VAR: "VAR";
|
|
6175
|
+
readonly VARP: "VARP";
|
|
6116
6176
|
};
|
|
6117
6177
|
/**
|
|
6118
6178
|
* @public
|
|
@@ -6406,6 +6466,11 @@ export interface TopicCalculatedField {
|
|
|
6406
6466
|
* names or aliases for the calculated field cell value.</p>
|
|
6407
6467
|
*/
|
|
6408
6468
|
CellValueSynonyms?: CellValueSynonym[];
|
|
6469
|
+
/**
|
|
6470
|
+
* @public
|
|
6471
|
+
* <p>The non additive for the table style target.</p>
|
|
6472
|
+
*/
|
|
6473
|
+
NonAdditive?: boolean;
|
|
6409
6474
|
}
|
|
6410
6475
|
/**
|
|
6411
6476
|
* @public
|
|
@@ -6440,9 +6505,7 @@ export interface TopicColumn {
|
|
|
6440
6505
|
/**
|
|
6441
6506
|
* @public
|
|
6442
6507
|
* <p>The type of aggregation that is performed on the column data when
|
|
6443
|
-
* it's queried
|
|
6444
|
-
* <code>MIN</code>, <code>COUNT</code>,
|
|
6445
|
-
* <code>DISTINCT_COUNT</code>, and <code>AVERAGE</code>.</p>
|
|
6508
|
+
* it's queried.</p>
|
|
6446
6509
|
*/
|
|
6447
6510
|
Aggregation?: DefaultAggregation | string;
|
|
6448
6511
|
/**
|
|
@@ -6508,6 +6571,11 @@ export interface TopicColumn {
|
|
|
6508
6571
|
* <p>The other names or aliases for the column cell value.</p>
|
|
6509
6572
|
*/
|
|
6510
6573
|
CellValueSynonyms?: CellValueSynonym[];
|
|
6574
|
+
/**
|
|
6575
|
+
* @public
|
|
6576
|
+
* <p>The non additive value for the column.</p>
|
|
6577
|
+
*/
|
|
6578
|
+
NonAdditive?: boolean;
|
|
6511
6579
|
}
|
|
6512
6580
|
/**
|
|
6513
6581
|
* @public
|
|
@@ -8081,118 +8149,6 @@ export declare const DataSourceFilterAttribute: {
|
|
|
8081
8149
|
* @public
|
|
8082
8150
|
*/
|
|
8083
8151
|
export type DataSourceFilterAttribute = (typeof DataSourceFilterAttribute)[keyof typeof DataSourceFilterAttribute];
|
|
8084
|
-
/**
|
|
8085
|
-
* @public
|
|
8086
|
-
* <p>A filter that you apply when searching for data sources.</p>
|
|
8087
|
-
*/
|
|
8088
|
-
export interface DataSourceSearchFilter {
|
|
8089
|
-
/**
|
|
8090
|
-
* @public
|
|
8091
|
-
* <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>
|
|
8092
|
-
* <p>If you set the operator value to <code>"StringEquals"</code>, you need to provide an ownership related filter in the <code>"NAME"</code> field and the arn of the user or group whose data sources you want to search in the <code>"Value"</code> field. For example, <code>"Name":"DIRECT_QUICKSIGHT_OWNER", "Operator": "StringEquals", "Value": "arn:aws:quicksight:us-east-1:1:user/default/UserName1"</code>.</p>
|
|
8093
|
-
* <p>If you set the value to <code>"StringLike"</code>, you need to provide the name of the data sources you are searching for. For example, <code>"Name":"DATASOURCE_NAME", "Operator": "StringLike", "Value": "Test"</code>. The <code>"StringLike"</code> operator only supports the <code>NAME</code> value <code>DATASOURCE_NAME</code>.</p>
|
|
8094
|
-
*/
|
|
8095
|
-
Operator: FilterOperator | string | undefined;
|
|
8096
|
-
/**
|
|
8097
|
-
* @public
|
|
8098
|
-
* <p>The name of the value that you want to use as a filter, for example, <code>"Name":
|
|
8099
|
-
* "DIRECT_QUICKSIGHT_OWNER"</code>.</p>
|
|
8100
|
-
* <p>Valid values are defined as follows:</p>
|
|
8101
|
-
* <ul>
|
|
8102
|
-
* <li>
|
|
8103
|
-
* <p>
|
|
8104
|
-
* <code>DIRECT_QUICKSIGHT_VIEWER_OR_OWNER</code>: Provide an ARN of a user or group, and any data sources with that ARN listed as one of the owners or viewers of the data sources are returned. Implicit permissions from folders or groups are not considered.</p>
|
|
8105
|
-
* </li>
|
|
8106
|
-
* <li>
|
|
8107
|
-
* <p>
|
|
8108
|
-
* <code>DIRECT_QUICKSIGHT_OWNER</code>: Provide an ARN of a user or group, and any data sources with that ARN listed as one of the owners if the data source are returned. Implicit permissions from folders or groups are not considered.</p>
|
|
8109
|
-
* </li>
|
|
8110
|
-
* <li>
|
|
8111
|
-
* <p>
|
|
8112
|
-
* <code>DIRECT_QUICKSIGHT_SOLE_OWNER</code>: Provide an ARN of a user or group, and any data sources with that ARN listed as the only owner of the data source are returned. Implicit permissions from folders or groups are not considered.</p>
|
|
8113
|
-
* </li>
|
|
8114
|
-
* <li>
|
|
8115
|
-
* <p>
|
|
8116
|
-
* <code>DATASOURCE_NAME</code>: Any data sources whose names have a substring match to the provided value are returned.</p>
|
|
8117
|
-
* </li>
|
|
8118
|
-
* </ul>
|
|
8119
|
-
*/
|
|
8120
|
-
Name: DataSourceFilterAttribute | string | undefined;
|
|
8121
|
-
/**
|
|
8122
|
-
* @public
|
|
8123
|
-
* <p>The value of the named item, for example <code>DIRECT_QUICKSIGHT_OWNER</code>, that you want
|
|
8124
|
-
* to use as a filter, for example, <code>"Value":
|
|
8125
|
-
* "arn:aws:quicksight:us-east-1:1:user/default/UserName1"</code>.</p>
|
|
8126
|
-
*/
|
|
8127
|
-
Value: string | undefined;
|
|
8128
|
-
}
|
|
8129
|
-
/**
|
|
8130
|
-
* @public
|
|
8131
|
-
* <p>A <code>DataSourceSummary</code> object that returns a summary of a data source.</p>
|
|
8132
|
-
*/
|
|
8133
|
-
export interface DataSourceSummary {
|
|
8134
|
-
/**
|
|
8135
|
-
* @public
|
|
8136
|
-
* <p>The arn of the datasource.</p>
|
|
8137
|
-
*/
|
|
8138
|
-
Arn?: string;
|
|
8139
|
-
/**
|
|
8140
|
-
* @public
|
|
8141
|
-
* <p>The unique ID of the data source.</p>
|
|
8142
|
-
*/
|
|
8143
|
-
DataSourceId?: string;
|
|
8144
|
-
/**
|
|
8145
|
-
* @public
|
|
8146
|
-
* <p>The name of the data source.</p>
|
|
8147
|
-
*/
|
|
8148
|
-
Name?: string;
|
|
8149
|
-
/**
|
|
8150
|
-
* @public
|
|
8151
|
-
* <p>The type of the data source.</p>
|
|
8152
|
-
*/
|
|
8153
|
-
Type?: DataSourceType | string;
|
|
8154
|
-
/**
|
|
8155
|
-
* @public
|
|
8156
|
-
* <p>The date and time that the data source was created. This value is expressed in MM-DD-YYYY HH:MM:SS format.</p>
|
|
8157
|
-
*/
|
|
8158
|
-
CreatedTime?: Date;
|
|
8159
|
-
/**
|
|
8160
|
-
* @public
|
|
8161
|
-
* <p>The date and time the data source was last updated. This value is expressed in MM-DD-YYYY HH:MM:SS format.</p>
|
|
8162
|
-
*/
|
|
8163
|
-
LastUpdatedTime?: Date;
|
|
8164
|
-
}
|
|
8165
|
-
/**
|
|
8166
|
-
* @public
|
|
8167
|
-
*/
|
|
8168
|
-
export interface DeleteAccountCustomizationRequest {
|
|
8169
|
-
/**
|
|
8170
|
-
* @public
|
|
8171
|
-
* <p>The ID for the Amazon Web Services account that you want to delete Amazon QuickSight customizations from in
|
|
8172
|
-
* this Amazon Web Services Region.</p>
|
|
8173
|
-
*/
|
|
8174
|
-
AwsAccountId: string | undefined;
|
|
8175
|
-
/**
|
|
8176
|
-
* @public
|
|
8177
|
-
* <p>The Amazon QuickSight namespace that you're deleting the customizations from.</p>
|
|
8178
|
-
*/
|
|
8179
|
-
Namespace?: string;
|
|
8180
|
-
}
|
|
8181
|
-
/**
|
|
8182
|
-
* @public
|
|
8183
|
-
*/
|
|
8184
|
-
export interface DeleteAccountCustomizationResponse {
|
|
8185
|
-
/**
|
|
8186
|
-
* @public
|
|
8187
|
-
* <p>The Amazon Web Services request ID for this operation.</p>
|
|
8188
|
-
*/
|
|
8189
|
-
RequestId?: string;
|
|
8190
|
-
/**
|
|
8191
|
-
* @public
|
|
8192
|
-
* <p>The HTTP status of the request.</p>
|
|
8193
|
-
*/
|
|
8194
|
-
Status?: number;
|
|
8195
|
-
}
|
|
8196
8152
|
/**
|
|
8197
8153
|
* @internal
|
|
8198
8154
|
*/
|
|
@@ -1,8 +1,120 @@
|
|
|
1
1
|
import { ExceptionOptionType as __ExceptionOptionType } from "@smithy/smithy-client";
|
|
2
2
|
import { AccountCustomization, AccountInfo, AccountSettings, ActiveIAMPolicyAssignment, Analysis, AnalysisError, Entity, ResourceStatus, Sheet } from "./models_0";
|
|
3
3
|
import { AnalysisDefinition, AnalysisSearchFilter, AnalysisSourceEntity, AnalysisSummary, AnonymousUserEmbeddingExperienceConfiguration, AnonymousUserSnapshotJobResult, DashboardVisualId, FilterOperator, SnapshotFile, SnapshotS3DestinationConfiguration } from "./models_1";
|
|
4
|
-
import { _Parameters, AssetBundleCloudFormationOverridePropertyConfiguration, AssetBundleExportFormat, AssetBundleExportJobError, AssetBundleExportJobStatus, AssetBundleExportJobSummary, AssetBundleImportFailureAction, AssetBundleImportJobError, AssetBundleImportJobOverrideParameters, AssetBundleImportJobStatus, AssetBundleImportJobSummary, AssetBundleImportSource, AssetBundleImportSourceDescription, AssignmentStatus, BookmarksConfigurations, Dashboard, DashboardError, DashboardPublishOptions, DashboardSearchFilter,
|
|
4
|
+
import { _Parameters, AssetBundleCloudFormationOverridePropertyConfiguration, AssetBundleExportFormat, AssetBundleExportJobError, AssetBundleExportJobStatus, AssetBundleExportJobSummary, AssetBundleImportFailureAction, AssetBundleImportJobError, AssetBundleImportJobOverrideParameters, AssetBundleImportJobStatus, AssetBundleImportJobSummary, AssetBundleImportSource, AssetBundleImportSourceDescription, AssignmentStatus, BookmarksConfigurations, Dashboard, DashboardError, DashboardPublishOptions, DashboardSearchFilter, DashboardSummary, DashboardVersionDefinition, DashboardVersionSummary, DataSet, DataSetConfiguration, DataSetRefreshProperties, DataSetSearchFilter, DataSetSummary, DataSource, DataSourceFilterAttribute, DataSourceType, FolderType, Group, GroupMember, IdentityStore, IngestionStatus, MemberType, NamespaceStatus, RefreshSchedule, ResourcePermission, Tag, TemplateAlias, TemplateVersionDefinition, ThemeAlias, ThemeConfiguration, TopicDetails, TopicRefreshSchedule, VPCConnectionAvailabilityStatus, VPCConnectionResourceStatus } from "./models_2";
|
|
5
5
|
import { QuickSightServiceException as __BaseException } from "./QuickSightServiceException";
|
|
6
|
+
/**
|
|
7
|
+
* @public
|
|
8
|
+
* <p>A filter that you apply when searching for data sources.</p>
|
|
9
|
+
*/
|
|
10
|
+
export interface DataSourceSearchFilter {
|
|
11
|
+
/**
|
|
12
|
+
* @public
|
|
13
|
+
* <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>
|
|
14
|
+
* <p>If you set the operator value to <code>"StringEquals"</code>, you need to provide an ownership related filter in the <code>"NAME"</code> field and the arn of the user or group whose data sources you want to search in the <code>"Value"</code> field. For example, <code>"Name":"DIRECT_QUICKSIGHT_OWNER", "Operator": "StringEquals", "Value": "arn:aws:quicksight:us-east-1:1:user/default/UserName1"</code>.</p>
|
|
15
|
+
* <p>If you set the value to <code>"StringLike"</code>, you need to provide the name of the data sources you are searching for. For example, <code>"Name":"DATASOURCE_NAME", "Operator": "StringLike", "Value": "Test"</code>. The <code>"StringLike"</code> operator only supports the <code>NAME</code> value <code>DATASOURCE_NAME</code>.</p>
|
|
16
|
+
*/
|
|
17
|
+
Operator: FilterOperator | string | undefined;
|
|
18
|
+
/**
|
|
19
|
+
* @public
|
|
20
|
+
* <p>The name of the value that you want to use as a filter, for example, <code>"Name":
|
|
21
|
+
* "DIRECT_QUICKSIGHT_OWNER"</code>.</p>
|
|
22
|
+
* <p>Valid values are defined as follows:</p>
|
|
23
|
+
* <ul>
|
|
24
|
+
* <li>
|
|
25
|
+
* <p>
|
|
26
|
+
* <code>DIRECT_QUICKSIGHT_VIEWER_OR_OWNER</code>: Provide an ARN of a user or group, and any data sources with that ARN listed as one of the owners or viewers of the data sources are returned. Implicit permissions from folders or groups are not considered.</p>
|
|
27
|
+
* </li>
|
|
28
|
+
* <li>
|
|
29
|
+
* <p>
|
|
30
|
+
* <code>DIRECT_QUICKSIGHT_OWNER</code>: Provide an ARN of a user or group, and any data sources with that ARN listed as one of the owners if the data source are returned. Implicit permissions from folders or groups are not considered.</p>
|
|
31
|
+
* </li>
|
|
32
|
+
* <li>
|
|
33
|
+
* <p>
|
|
34
|
+
* <code>DIRECT_QUICKSIGHT_SOLE_OWNER</code>: Provide an ARN of a user or group, and any data sources with that ARN listed as the only owner of the data source are returned. Implicit permissions from folders or groups are not considered.</p>
|
|
35
|
+
* </li>
|
|
36
|
+
* <li>
|
|
37
|
+
* <p>
|
|
38
|
+
* <code>DATASOURCE_NAME</code>: Any data sources whose names have a substring match to the provided value are returned.</p>
|
|
39
|
+
* </li>
|
|
40
|
+
* </ul>
|
|
41
|
+
*/
|
|
42
|
+
Name: DataSourceFilterAttribute | string | undefined;
|
|
43
|
+
/**
|
|
44
|
+
* @public
|
|
45
|
+
* <p>The value of the named item, for example <code>DIRECT_QUICKSIGHT_OWNER</code>, that you want
|
|
46
|
+
* to use as a filter, for example, <code>"Value":
|
|
47
|
+
* "arn:aws:quicksight:us-east-1:1:user/default/UserName1"</code>.</p>
|
|
48
|
+
*/
|
|
49
|
+
Value: string | undefined;
|
|
50
|
+
}
|
|
51
|
+
/**
|
|
52
|
+
* @public
|
|
53
|
+
* <p>A <code>DataSourceSummary</code> object that returns a summary of a data source.</p>
|
|
54
|
+
*/
|
|
55
|
+
export interface DataSourceSummary {
|
|
56
|
+
/**
|
|
57
|
+
* @public
|
|
58
|
+
* <p>The arn of the datasource.</p>
|
|
59
|
+
*/
|
|
60
|
+
Arn?: string;
|
|
61
|
+
/**
|
|
62
|
+
* @public
|
|
63
|
+
* <p>The unique ID of the data source.</p>
|
|
64
|
+
*/
|
|
65
|
+
DataSourceId?: string;
|
|
66
|
+
/**
|
|
67
|
+
* @public
|
|
68
|
+
* <p>The name of the data source.</p>
|
|
69
|
+
*/
|
|
70
|
+
Name?: string;
|
|
71
|
+
/**
|
|
72
|
+
* @public
|
|
73
|
+
* <p>The type of the data source.</p>
|
|
74
|
+
*/
|
|
75
|
+
Type?: DataSourceType | string;
|
|
76
|
+
/**
|
|
77
|
+
* @public
|
|
78
|
+
* <p>The date and time that the data source was created. This value is expressed in MM-DD-YYYY HH:MM:SS format.</p>
|
|
79
|
+
*/
|
|
80
|
+
CreatedTime?: Date;
|
|
81
|
+
/**
|
|
82
|
+
* @public
|
|
83
|
+
* <p>The date and time the data source was last updated. This value is expressed in MM-DD-YYYY HH:MM:SS format.</p>
|
|
84
|
+
*/
|
|
85
|
+
LastUpdatedTime?: Date;
|
|
86
|
+
}
|
|
87
|
+
/**
|
|
88
|
+
* @public
|
|
89
|
+
*/
|
|
90
|
+
export interface DeleteAccountCustomizationRequest {
|
|
91
|
+
/**
|
|
92
|
+
* @public
|
|
93
|
+
* <p>The ID for the Amazon Web Services account that you want to delete Amazon QuickSight customizations from in
|
|
94
|
+
* this Amazon Web Services Region.</p>
|
|
95
|
+
*/
|
|
96
|
+
AwsAccountId: string | undefined;
|
|
97
|
+
/**
|
|
98
|
+
* @public
|
|
99
|
+
* <p>The Amazon QuickSight namespace that you're deleting the customizations from.</p>
|
|
100
|
+
*/
|
|
101
|
+
Namespace?: string;
|
|
102
|
+
}
|
|
103
|
+
/**
|
|
104
|
+
* @public
|
|
105
|
+
*/
|
|
106
|
+
export interface DeleteAccountCustomizationResponse {
|
|
107
|
+
/**
|
|
108
|
+
* @public
|
|
109
|
+
* <p>The Amazon Web Services request ID for this operation.</p>
|
|
110
|
+
*/
|
|
111
|
+
RequestId?: string;
|
|
112
|
+
/**
|
|
113
|
+
* @public
|
|
114
|
+
* <p>The HTTP status of the request.</p>
|
|
115
|
+
*/
|
|
116
|
+
Status?: number;
|
|
117
|
+
}
|
|
6
118
|
/**
|
|
7
119
|
* @public
|
|
8
120
|
*/
|
|
@@ -3897,6 +4009,7 @@ export interface DescribeUserRequest {
|
|
|
3897
4009
|
*/
|
|
3898
4010
|
export declare const IdentityType: {
|
|
3899
4011
|
readonly IAM: "IAM";
|
|
4012
|
+
readonly IAM_IDENTITY_CENTER: "IAM_IDENTITY_CENTER";
|
|
3900
4013
|
readonly QUICKSIGHT: "QUICKSIGHT";
|
|
3901
4014
|
};
|
|
3902
4015
|
/**
|
|
@@ -7720,193 +7833,6 @@ export interface UpdateAnalysisResponse {
|
|
|
7720
7833
|
*/
|
|
7721
7834
|
RequestId?: string;
|
|
7722
7835
|
}
|
|
7723
|
-
/**
|
|
7724
|
-
* @public
|
|
7725
|
-
*/
|
|
7726
|
-
export interface UpdateAnalysisPermissionsRequest {
|
|
7727
|
-
/**
|
|
7728
|
-
* @public
|
|
7729
|
-
* <p>The ID of the Amazon Web Services account that contains the analysis whose permissions you're
|
|
7730
|
-
* updating. You must be using the Amazon Web Services account that the analysis is in.</p>
|
|
7731
|
-
*/
|
|
7732
|
-
AwsAccountId: string | undefined;
|
|
7733
|
-
/**
|
|
7734
|
-
* @public
|
|
7735
|
-
* <p>The ID of the analysis whose permissions you're updating. The ID is part of the
|
|
7736
|
-
* analysis URL.</p>
|
|
7737
|
-
*/
|
|
7738
|
-
AnalysisId: string | undefined;
|
|
7739
|
-
/**
|
|
7740
|
-
* @public
|
|
7741
|
-
* <p>A structure that describes the permissions to add and the principal to add them
|
|
7742
|
-
* to.</p>
|
|
7743
|
-
*/
|
|
7744
|
-
GrantPermissions?: ResourcePermission[];
|
|
7745
|
-
/**
|
|
7746
|
-
* @public
|
|
7747
|
-
* <p>A structure that describes the permissions to remove and the principal to remove them
|
|
7748
|
-
* from.</p>
|
|
7749
|
-
*/
|
|
7750
|
-
RevokePermissions?: ResourcePermission[];
|
|
7751
|
-
}
|
|
7752
|
-
/**
|
|
7753
|
-
* @public
|
|
7754
|
-
*/
|
|
7755
|
-
export interface UpdateAnalysisPermissionsResponse {
|
|
7756
|
-
/**
|
|
7757
|
-
* @public
|
|
7758
|
-
* <p>The Amazon Resource Name (ARN) of the analysis that you updated.</p>
|
|
7759
|
-
*/
|
|
7760
|
-
AnalysisArn?: string;
|
|
7761
|
-
/**
|
|
7762
|
-
* @public
|
|
7763
|
-
* <p>The ID of the analysis that you updated permissions for.</p>
|
|
7764
|
-
*/
|
|
7765
|
-
AnalysisId?: string;
|
|
7766
|
-
/**
|
|
7767
|
-
* @public
|
|
7768
|
-
* <p>A structure that describes the principals and the resource-level permissions on an
|
|
7769
|
-
* analysis.</p>
|
|
7770
|
-
*/
|
|
7771
|
-
Permissions?: ResourcePermission[];
|
|
7772
|
-
/**
|
|
7773
|
-
* @public
|
|
7774
|
-
* <p>The Amazon Web Services request ID for this operation.</p>
|
|
7775
|
-
*/
|
|
7776
|
-
RequestId?: string;
|
|
7777
|
-
/**
|
|
7778
|
-
* @public
|
|
7779
|
-
* <p>The HTTP status of the request.</p>
|
|
7780
|
-
*/
|
|
7781
|
-
Status?: number;
|
|
7782
|
-
}
|
|
7783
|
-
/**
|
|
7784
|
-
* @public
|
|
7785
|
-
*/
|
|
7786
|
-
export interface UpdateDashboardRequest {
|
|
7787
|
-
/**
|
|
7788
|
-
* @public
|
|
7789
|
-
* <p>The ID of the Amazon Web Services account that contains the dashboard that you're
|
|
7790
|
-
* updating.</p>
|
|
7791
|
-
*/
|
|
7792
|
-
AwsAccountId: string | undefined;
|
|
7793
|
-
/**
|
|
7794
|
-
* @public
|
|
7795
|
-
* <p>The ID for the dashboard.</p>
|
|
7796
|
-
*/
|
|
7797
|
-
DashboardId: string | undefined;
|
|
7798
|
-
/**
|
|
7799
|
-
* @public
|
|
7800
|
-
* <p>The display name of the dashboard.</p>
|
|
7801
|
-
*/
|
|
7802
|
-
Name: string | undefined;
|
|
7803
|
-
/**
|
|
7804
|
-
* @public
|
|
7805
|
-
* <p>The entity that you are using as a source when you update the dashboard. In
|
|
7806
|
-
* <code>SourceEntity</code>, you specify the type of object you're using as source. You
|
|
7807
|
-
* can only update a dashboard from a template, so you use a <code>SourceTemplate</code>
|
|
7808
|
-
* entity. If you need to update a dashboard from an analysis, first convert the analysis
|
|
7809
|
-
* to a template by using the <code>
|
|
7810
|
-
* <a href="https://docs.aws.amazon.com/quicksight/latest/APIReference/API_CreateTemplate.html">CreateTemplate</a>
|
|
7811
|
-
* </code> API operation. For
|
|
7812
|
-
* <code>SourceTemplate</code>, specify the Amazon Resource Name (ARN) of the source
|
|
7813
|
-
* template. The <code>SourceTemplate</code> ARN can contain any Amazon Web Services account and any
|
|
7814
|
-
* Amazon QuickSight-supported Amazon Web Services Region. </p>
|
|
7815
|
-
* <p>Use the <code>DataSetReferences</code> entity within <code>SourceTemplate</code> to
|
|
7816
|
-
* list the replacement datasets for the placeholders listed in the original. The schema in
|
|
7817
|
-
* each dataset must match its placeholder. </p>
|
|
7818
|
-
*/
|
|
7819
|
-
SourceEntity?: DashboardSourceEntity;
|
|
7820
|
-
/**
|
|
7821
|
-
* @public
|
|
7822
|
-
* <p>A structure that contains the parameters of the dashboard. These are parameter
|
|
7823
|
-
* overrides for a dashboard. A dashboard can have any type of parameters, and some
|
|
7824
|
-
* parameters might accept multiple values.</p>
|
|
7825
|
-
*/
|
|
7826
|
-
Parameters?: _Parameters;
|
|
7827
|
-
/**
|
|
7828
|
-
* @public
|
|
7829
|
-
* <p>A description for the first version of the dashboard being created.</p>
|
|
7830
|
-
*/
|
|
7831
|
-
VersionDescription?: string;
|
|
7832
|
-
/**
|
|
7833
|
-
* @public
|
|
7834
|
-
* <p>Options for publishing the dashboard when you create it:</p>
|
|
7835
|
-
* <ul>
|
|
7836
|
-
* <li>
|
|
7837
|
-
* <p>
|
|
7838
|
-
* <code>AvailabilityStatus</code> for <code>AdHocFilteringOption</code> - This
|
|
7839
|
-
* status can be either <code>ENABLED</code> or <code>DISABLED</code>. When this is
|
|
7840
|
-
* set to <code>DISABLED</code>, Amazon QuickSight disables the left filter pane on the
|
|
7841
|
-
* published dashboard, which can be used for ad hoc (one-time) filtering. This
|
|
7842
|
-
* option is <code>ENABLED</code> by default. </p>
|
|
7843
|
-
* </li>
|
|
7844
|
-
* <li>
|
|
7845
|
-
* <p>
|
|
7846
|
-
* <code>AvailabilityStatus</code> for <code>ExportToCSVOption</code> - This
|
|
7847
|
-
* status can be either <code>ENABLED</code> or <code>DISABLED</code>. The visual
|
|
7848
|
-
* option to export data to .CSV format isn't enabled when this is set to
|
|
7849
|
-
* <code>DISABLED</code>. This option is <code>ENABLED</code> by default. </p>
|
|
7850
|
-
* </li>
|
|
7851
|
-
* <li>
|
|
7852
|
-
* <p>
|
|
7853
|
-
* <code>VisibilityState</code> for <code>SheetControlsOption</code> - This
|
|
7854
|
-
* visibility state can be either <code>COLLAPSED</code> or <code>EXPANDED</code>.
|
|
7855
|
-
* This option is <code>COLLAPSED</code> by default. </p>
|
|
7856
|
-
* </li>
|
|
7857
|
-
* </ul>
|
|
7858
|
-
*/
|
|
7859
|
-
DashboardPublishOptions?: DashboardPublishOptions;
|
|
7860
|
-
/**
|
|
7861
|
-
* @public
|
|
7862
|
-
* <p>The Amazon Resource Name (ARN) of the theme that is being used for this dashboard. If
|
|
7863
|
-
* you add a value for this field, it overrides the value that was originally associated
|
|
7864
|
-
* with the entity. The theme ARN must exist in the same Amazon Web Services account where you create the
|
|
7865
|
-
* dashboard.</p>
|
|
7866
|
-
*/
|
|
7867
|
-
ThemeArn?: string;
|
|
7868
|
-
/**
|
|
7869
|
-
* @public
|
|
7870
|
-
* <p>The definition of a dashboard.</p>
|
|
7871
|
-
* <p>A definition is the data model of all features in a Dashboard, Template, or Analysis.</p>
|
|
7872
|
-
*/
|
|
7873
|
-
Definition?: DashboardVersionDefinition;
|
|
7874
|
-
}
|
|
7875
|
-
/**
|
|
7876
|
-
* @public
|
|
7877
|
-
*/
|
|
7878
|
-
export interface UpdateDashboardResponse {
|
|
7879
|
-
/**
|
|
7880
|
-
* @public
|
|
7881
|
-
* <p>The Amazon Resource Name (ARN) of the resource.</p>
|
|
7882
|
-
*/
|
|
7883
|
-
Arn?: string;
|
|
7884
|
-
/**
|
|
7885
|
-
* @public
|
|
7886
|
-
* <p>The ARN of the dashboard, including the version number.</p>
|
|
7887
|
-
*/
|
|
7888
|
-
VersionArn?: string;
|
|
7889
|
-
/**
|
|
7890
|
-
* @public
|
|
7891
|
-
* <p>The ID for the dashboard.</p>
|
|
7892
|
-
*/
|
|
7893
|
-
DashboardId?: string;
|
|
7894
|
-
/**
|
|
7895
|
-
* @public
|
|
7896
|
-
* <p>The creation status of the request.</p>
|
|
7897
|
-
*/
|
|
7898
|
-
CreationStatus?: ResourceStatus | string;
|
|
7899
|
-
/**
|
|
7900
|
-
* @public
|
|
7901
|
-
* <p>The HTTP status of the request.</p>
|
|
7902
|
-
*/
|
|
7903
|
-
Status?: number;
|
|
7904
|
-
/**
|
|
7905
|
-
* @public
|
|
7906
|
-
* <p>The Amazon Web Services request ID for this operation.</p>
|
|
7907
|
-
*/
|
|
7908
|
-
RequestId?: string;
|
|
7909
|
-
}
|
|
7910
7836
|
/**
|
|
7911
7837
|
* @internal
|
|
7912
7838
|
*/
|
|
@@ -7991,7 +7917,3 @@ export declare const StartDashboardSnapshotJobRequestFilterSensitiveLog: (obj: S
|
|
|
7991
7917
|
* @internal
|
|
7992
7918
|
*/
|
|
7993
7919
|
export declare const UpdateAnalysisRequestFilterSensitiveLog: (obj: UpdateAnalysisRequest) => any;
|
|
7994
|
-
/**
|
|
7995
|
-
* @internal
|
|
7996
|
-
*/
|
|
7997
|
-
export declare const UpdateDashboardRequestFilterSensitiveLog: (obj: UpdateDashboardRequest) => any;
|