@aws-sdk/client-quicksight 3.1031.0 → 3.1033.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/endpoint/bdd.js +49 -0
- package/dist-cjs/endpoint/endpointResolver.js +2 -2
- package/dist-cjs/index.js +7 -0
- package/dist-cjs/schemas/schemas_0.js +90 -56
- package/dist-es/endpoint/bdd.js +46 -0
- package/dist-es/endpoint/endpointResolver.js +3 -3
- package/dist-es/models/enums.js +6 -0
- package/dist-es/schemas/schemas_0.js +58 -24
- package/dist-types/commands/CreateAnalysisCommand.d.ts +136 -71
- package/dist-types/commands/CreateCustomPermissionsCommand.d.ts +1 -0
- package/dist-types/commands/CreateDashboardCommand.d.ts +136 -71
- package/dist-types/commands/CreateDataSourceCommand.d.ts +9 -1
- package/dist-types/commands/CreateTemplateCommand.d.ts +136 -71
- package/dist-types/commands/DescribeAnalysisDefinitionCommand.d.ts +136 -71
- package/dist-types/commands/DescribeAssetBundleImportJobCommand.d.ts +4 -0
- package/dist-types/commands/DescribeCustomPermissionsCommand.d.ts +1 -0
- package/dist-types/commands/DescribeDashboardDefinitionCommand.d.ts +136 -71
- package/dist-types/commands/DescribeDataSourceCommand.d.ts +9 -1
- package/dist-types/commands/DescribeRoleCustomPermissionCommand.d.ts +2 -1
- package/dist-types/commands/DescribeSelfUpgradeConfigurationCommand.d.ts +1 -1
- package/dist-types/commands/DescribeTemplateDefinitionCommand.d.ts +136 -71
- package/dist-types/commands/GenerateEmbedUrlForRegisteredUserCommand.d.ts +6 -0
- package/dist-types/commands/GenerateEmbedUrlForRegisteredUserWithIdentityCommand.d.ts +6 -0
- package/dist-types/commands/ListCustomPermissionsCommand.d.ts +1 -0
- package/dist-types/commands/ListDataSourcesCommand.d.ts +9 -1
- package/dist-types/commands/SearchDataSourcesCommand.d.ts +1 -1
- package/dist-types/commands/StartAssetBundleImportJobCommand.d.ts +4 -0
- package/dist-types/commands/UpdateAnalysisCommand.d.ts +136 -71
- package/dist-types/commands/UpdateCustomPermissionsCommand.d.ts +1 -0
- package/dist-types/commands/UpdateDashboardCommand.d.ts +136 -71
- package/dist-types/commands/UpdateDataSourceCommand.d.ts +8 -0
- package/dist-types/commands/UpdateTemplateCommand.d.ts +136 -71
- package/dist-types/commands/UpdateTopicRefreshScheduleCommand.d.ts +2 -1
- package/dist-types/commands/UpdateUserCommand.d.ts +1 -1
- package/dist-types/commands/UpdateUserCustomPermissionCommand.d.ts +1 -2
- package/dist-types/endpoint/bdd.d.ts +2 -0
- package/dist-types/models/enums.d.ts +14 -0
- package/dist-types/models/models_0.d.ts +72 -43
- package/dist-types/models/models_1.d.ts +43 -109
- package/dist-types/models/models_2.d.ts +207 -60
- package/dist-types/models/models_3.d.ts +69 -78
- package/dist-types/models/models_4.d.ts +87 -210
- package/dist-types/models/models_5.d.ts +211 -1
- package/dist-types/schemas/schemas_0.d.ts +4 -0
- package/dist-types/ts3.4/commands/DescribeRoleCustomPermissionCommand.d.ts +2 -4
- package/dist-types/ts3.4/commands/DescribeSelfUpgradeConfigurationCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/UpdateTopicRefreshScheduleCommand.d.ts +2 -4
- package/dist-types/ts3.4/commands/UpdateUserCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/UpdateUserCustomPermissionCommand.d.ts +4 -2
- package/dist-types/ts3.4/endpoint/bdd.d.ts +2 -0
- package/dist-types/ts3.4/models/enums.d.ts +8 -0
- package/dist-types/ts3.4/models/models_0.d.ts +14 -10
- package/dist-types/ts3.4/models/models_1.d.ts +11 -25
- package/dist-types/ts3.4/models/models_2.d.ts +107 -15
- package/dist-types/ts3.4/models/models_3.d.ts +19 -21
- package/dist-types/ts3.4/models/models_4.d.ts +24 -30
- package/dist-types/ts3.4/models/models_5.d.ts +32 -0
- package/dist-types/ts3.4/schemas/schemas_0.d.ts +4 -0
- package/package.json +5 -5
- package/dist-cjs/endpoint/ruleset.js +0 -7
- package/dist-es/endpoint/ruleset.js +0 -4
- package/dist-types/endpoint/ruleset.d.ts +0 -2
- package/dist-types/ts3.4/endpoint/ruleset.d.ts +0 -2
|
@@ -1,6 +1,62 @@
|
|
|
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,
|
|
1
|
+
import type { AssetBundleExportFormat, AssetBundleExportJobStatus, AssetBundleImportFailureAction, AssetBundleImportJobStatus, AssignmentStatus, AuthorSpecifiedAggregation, AutomationJobStatus, CategoryFilterFunction, CategoryFilterType, ColumnDataRole, ColumnDataSubType, ColumnDataType, ColumnTagName, 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, 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, CastColumnTypeOperation, CellValueSynonym, CollectiveConstant, ColumnGroup, ColumnGroupSchema, ColumnLevelPermissionRule, ColumnSchema, ComparativeOrder, CreateColumnsOperation, DashboardPublishOptions, DashboardVersionDefinition, DataPrepConfiguration, DatasetParameter, DataSetReference, DataSetRefreshProperties, DataSetUsageConfiguration, DataSourceParameters, DisplayFormatOptions, FieldFolder, FilterOperation, InputColumn, LinkSharingConfiguration,
|
|
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, ColumnTag, ComparativeOrder, CreateColumnsOperation, DashboardPublishOptions, DashboardVersionDefinition, DataPrepConfiguration, DatasetParameter, DataSetReference, DataSetRefreshProperties, DataSetUsageConfiguration, DataSourceParameters, DisplayFormatOptions, FieldFolder, FilterOperation, InputColumn, LinkSharingConfiguration, NewDefaultValues, ProjectOperation, RenameColumnOperation, ResourcePermission, SheetDefinition, SnapshotFile, SnapshotJobResultFileGroup, SnapshotS3DestinationConfiguration, SslProperties, StaticFile, Tag, TooltipSheetDefinition, ValidationStrategy, VpcConnectionProperties } from "./models_2";
|
|
4
|
+
/**
|
|
5
|
+
* <p>A transform operation that overrides the dataset parameter values that are defined in another dataset.</p>
|
|
6
|
+
* @public
|
|
7
|
+
*/
|
|
8
|
+
export interface OverrideDatasetParameterOperation {
|
|
9
|
+
/**
|
|
10
|
+
* <p>The name of the parameter to be overridden with different values.</p>
|
|
11
|
+
* @public
|
|
12
|
+
*/
|
|
13
|
+
ParameterName: string | undefined;
|
|
14
|
+
/**
|
|
15
|
+
* <p>The new name for the parameter.</p>
|
|
16
|
+
* @public
|
|
17
|
+
*/
|
|
18
|
+
NewParameterName?: string | undefined;
|
|
19
|
+
/**
|
|
20
|
+
* <p>The new default values for the parameter.</p>
|
|
21
|
+
* @public
|
|
22
|
+
*/
|
|
23
|
+
NewDefaultValues?: NewDefaultValues | undefined;
|
|
24
|
+
}
|
|
25
|
+
/**
|
|
26
|
+
* <p>A transform operation that tags a column with additional information.</p>
|
|
27
|
+
* @public
|
|
28
|
+
*/
|
|
29
|
+
export interface TagColumnOperation {
|
|
30
|
+
/**
|
|
31
|
+
* <p>The column that this operation acts on.</p>
|
|
32
|
+
* @public
|
|
33
|
+
*/
|
|
34
|
+
ColumnName: string | undefined;
|
|
35
|
+
/**
|
|
36
|
+
* <p>The dataset column tag, currently only used for geospatial type tagging.</p>
|
|
37
|
+
* <note>
|
|
38
|
+
* <p>This is not tags for the Amazon Web Services tagging feature.</p>
|
|
39
|
+
* </note>
|
|
40
|
+
* @public
|
|
41
|
+
*/
|
|
42
|
+
Tags: ColumnTag[] | undefined;
|
|
43
|
+
}
|
|
44
|
+
/**
|
|
45
|
+
* <p>A transform operation that removes tags associated with a column.</p>
|
|
46
|
+
* @public
|
|
47
|
+
*/
|
|
48
|
+
export interface UntagColumnOperation {
|
|
49
|
+
/**
|
|
50
|
+
* <p>The column that this operation acts on.</p>
|
|
51
|
+
* @public
|
|
52
|
+
*/
|
|
53
|
+
ColumnName: string | undefined;
|
|
54
|
+
/**
|
|
55
|
+
* <p>The column tags to remove from this column.</p>
|
|
56
|
+
* @public
|
|
57
|
+
*/
|
|
58
|
+
TagNames: ColumnTagName[] | undefined;
|
|
59
|
+
}
|
|
4
60
|
/**
|
|
5
61
|
* <p>A data transformation on a logical table. This is a variant type structure. For this
|
|
6
62
|
* structure to be valid, only one of the attributes can be non-null.</p>
|
|
@@ -3764,6 +3820,17 @@ export interface Dashboard {
|
|
|
3764
3820
|
*/
|
|
3765
3821
|
LinkEntities?: string[] | undefined;
|
|
3766
3822
|
}
|
|
3823
|
+
/**
|
|
3824
|
+
* <p>The dashboard customization summary configuration for an embedded Quick Sight dashboard.</p>
|
|
3825
|
+
* @public
|
|
3826
|
+
*/
|
|
3827
|
+
export interface DashboardCustomizationSummaryConfigurations {
|
|
3828
|
+
/**
|
|
3829
|
+
* <p>The enabled status of the dashboard customization summary configuration for an embedded Quick Sight dashboard.</p>
|
|
3830
|
+
* @public
|
|
3831
|
+
*/
|
|
3832
|
+
Enabled: boolean | undefined;
|
|
3833
|
+
}
|
|
3767
3834
|
/**
|
|
3768
3835
|
* <p>A filter that you apply when searching for dashboards. </p>
|
|
3769
3836
|
* @public
|
|
@@ -8298,79 +8365,3 @@ export interface DescribeRoleCustomPermissionRequest {
|
|
|
8298
8365
|
*/
|
|
8299
8366
|
Namespace: string | undefined;
|
|
8300
8367
|
}
|
|
8301
|
-
/**
|
|
8302
|
-
* @public
|
|
8303
|
-
*/
|
|
8304
|
-
export interface DescribeRoleCustomPermissionResponse {
|
|
8305
|
-
/**
|
|
8306
|
-
* <p>The name of the custom permission that is described.</p>
|
|
8307
|
-
* @public
|
|
8308
|
-
*/
|
|
8309
|
-
CustomPermissionsName?: string | undefined;
|
|
8310
|
-
/**
|
|
8311
|
-
* <p>The Amazon Web Services request ID for this operation.</p>
|
|
8312
|
-
* @public
|
|
8313
|
-
*/
|
|
8314
|
-
RequestId?: string | undefined;
|
|
8315
|
-
/**
|
|
8316
|
-
* <p>The HTTP status of the request.</p>
|
|
8317
|
-
* @public
|
|
8318
|
-
*/
|
|
8319
|
-
Status?: number | undefined;
|
|
8320
|
-
}
|
|
8321
|
-
/**
|
|
8322
|
-
* @public
|
|
8323
|
-
*/
|
|
8324
|
-
export interface DescribeSelfUpgradeConfigurationRequest {
|
|
8325
|
-
/**
|
|
8326
|
-
* <p>The ID of the Amazon Web Services account that contains the Quick self-upgrade configuration.</p>
|
|
8327
|
-
* @public
|
|
8328
|
-
*/
|
|
8329
|
-
AwsAccountId: string | undefined;
|
|
8330
|
-
/**
|
|
8331
|
-
* <p>The Quick namespace that you want to describe the Quick self-upgrade configuration for.</p>
|
|
8332
|
-
* @public
|
|
8333
|
-
*/
|
|
8334
|
-
Namespace: string | undefined;
|
|
8335
|
-
}
|
|
8336
|
-
/**
|
|
8337
|
-
* <p>The self-upgrade configuration for the Quick account.</p>
|
|
8338
|
-
* @public
|
|
8339
|
-
*/
|
|
8340
|
-
export interface SelfUpgradeConfiguration {
|
|
8341
|
-
/**
|
|
8342
|
-
* <p>Status set for the self-upgrade configuration for the Quick account. It can contain the following values:</p>
|
|
8343
|
-
* <ul>
|
|
8344
|
-
* <li>
|
|
8345
|
-
* <p>
|
|
8346
|
-
* <code>AUTO_APPROVAL</code>: All the self-upgrade requests will be auto approved.</p>
|
|
8347
|
-
* </li>
|
|
8348
|
-
* <li>
|
|
8349
|
-
* <p>
|
|
8350
|
-
* <code>ADMIN_APPROVAL</code>: All the self-upgrade requests will require admin approval.</p>
|
|
8351
|
-
* </li>
|
|
8352
|
-
* </ul>
|
|
8353
|
-
* @public
|
|
8354
|
-
*/
|
|
8355
|
-
SelfUpgradeStatus?: SelfUpgradeStatus | undefined;
|
|
8356
|
-
}
|
|
8357
|
-
/**
|
|
8358
|
-
* @public
|
|
8359
|
-
*/
|
|
8360
|
-
export interface DescribeSelfUpgradeConfigurationResponse {
|
|
8361
|
-
/**
|
|
8362
|
-
* <p>The self-upgrade configuration for the Quick account.</p>
|
|
8363
|
-
* @public
|
|
8364
|
-
*/
|
|
8365
|
-
SelfUpgradeConfiguration?: SelfUpgradeConfiguration | undefined;
|
|
8366
|
-
/**
|
|
8367
|
-
* <p>The Amazon Web Services request ID for this operation.</p>
|
|
8368
|
-
* @public
|
|
8369
|
-
*/
|
|
8370
|
-
RequestId?: string | undefined;
|
|
8371
|
-
/**
|
|
8372
|
-
* <p>The HTTP status of the request.</p>
|
|
8373
|
-
* @public
|
|
8374
|
-
*/
|
|
8375
|
-
Status?: number | undefined;
|
|
8376
|
-
}
|
|
@@ -1,7 +1,83 @@
|
|
|
1
1
|
import type { AssetBundleExportFormat, AssetBundleImportFailureAction, AssignmentStatus, DashboardsQAStatus, DataSetImportMode, EmbeddingIdentityType, FieldName, FilterOperator, FlowPublishState, FolderFilterAttribute, FolderType, GeneratedAnswerStatus, GroupFilterAttribute, GroupFilterOperator, IdentityType, IncludeFolderMembers, IncludeGeneratedAnswer, IncludeQuickSightQIndex, NetworkInterfaceStatus, PersonalizationMode, PurchaseMode, QAResultType, QSearchStatus, ResourceStatus, Role, SearchFilterOperator, SelfUpgradeAdminAction, SelfUpgradeRequestStatus, SelfUpgradeStatus, ServiceType, SharingModel, TemplateErrorType, ThemeErrorType, ThemeType, TopicFilterAttribute, TopicFilterOperator, TopicRefreshStatus, TopicUserExperienceVersion, UserRole, VPCConnectionAvailabilityStatus, VPCConnectionResourceStatus } from "./enums";
|
|
2
2
|
import type { AccountCustomization, ActionConnectorSearchFilter, ActionConnectorSummary, ActiveIAMPolicyAssignment, AmazonQInQuickSightConsoleConfigurations, AmazonQInQuickSightDashboardConfigurations, Entity, Sheet } from "./models_0";
|
|
3
3
|
import type { _Parameters, AnalysisDefinition, AnalysisSearchFilter, AnalysisSourceEntity, AnalysisSummary, AnonymousUserEmbeddingExperienceConfiguration, AssetBundleCloudFormationOverridePropertyConfiguration, AssetBundleExportJobSummary, AssetBundleExportJobValidationStrategy, AssetBundleImportJobOverrideParameters, AssetBundleImportJobOverridePermissions, AssetBundleImportJobOverrideTags, AssetBundleImportJobOverrideValidationStrategy, AssetBundleImportJobSummary, AssetBundleImportSource, AuthConfig, AuthorizedTargetsByService, BookmarksConfigurations, BrandDefinition, BrandDetail, BrandSummary, Capabilities, ColumnGroup, ColumnLevelPermissionRule, DashboardPublishOptions, DashboardSourceEntity, DashboardVersionDefinition, DashboardVisualId, DataPrepConfiguration, DatasetParameter, DataSetRefreshProperties, DataSetUsageConfiguration, DataSourceParameters, FieldFolder, LinkSharingConfiguration, ResourcePermission, SharedViewConfigurations, SslProperties, Tag, ValidationStrategy, VpcConnectionProperties } from "./models_2";
|
|
4
|
-
import type { CustomInstructions, CustomPermissions, DashboardSearchFilter, DashboardSummary, DashboardVersionSummary, DashboardVisualResult, DataSetConfiguration, DataSetSearchFilter, DataSetSummary, DataSource, DataSourceCredentials, DataSourceSearchFilter, DataSourceSummary, Group, GroupMember, Ingestion, LogicalTable, NamespaceInfoV2, PerformanceConfiguration, PhysicalTable, RefreshSchedule, RegisteredCustomerManagedKey, RowLevelPermissionDataSet, RowLevelPermissionTagConfiguration, SemanticModelConfiguration, SnapshotConfiguration, TemplateAlias, TemplateSourceEntity, TemplateVersionDefinition, ThemeAlias, ThemeConfiguration, TopicDetails, TopicRefreshSchedule } from "./models_3";
|
|
4
|
+
import type { CustomInstructions, CustomPermissions, DashboardCustomizationSummaryConfigurations, DashboardSearchFilter, DashboardSummary, DashboardVersionSummary, DashboardVisualResult, DataSetConfiguration, DataSetSearchFilter, DataSetSummary, DataSource, DataSourceCredentials, DataSourceSearchFilter, DataSourceSummary, Group, GroupMember, Ingestion, LogicalTable, NamespaceInfoV2, PerformanceConfiguration, PhysicalTable, RefreshSchedule, RegisteredCustomerManagedKey, RowLevelPermissionDataSet, RowLevelPermissionTagConfiguration, SemanticModelConfiguration, SnapshotConfiguration, TemplateAlias, TemplateSourceEntity, TemplateVersionDefinition, ThemeAlias, ThemeConfiguration, TopicDetails, TopicRefreshSchedule } from "./models_3";
|
|
5
|
+
/**
|
|
6
|
+
* @public
|
|
7
|
+
*/
|
|
8
|
+
export interface DescribeRoleCustomPermissionResponse {
|
|
9
|
+
/**
|
|
10
|
+
* <p>The name of the custom permission that is described.</p>
|
|
11
|
+
* @public
|
|
12
|
+
*/
|
|
13
|
+
CustomPermissionsName?: string | undefined;
|
|
14
|
+
/**
|
|
15
|
+
* <p>The Amazon Web Services request ID for this operation.</p>
|
|
16
|
+
* @public
|
|
17
|
+
*/
|
|
18
|
+
RequestId?: string | undefined;
|
|
19
|
+
/**
|
|
20
|
+
* <p>The HTTP status of the request.</p>
|
|
21
|
+
* @public
|
|
22
|
+
*/
|
|
23
|
+
Status?: number | undefined;
|
|
24
|
+
}
|
|
25
|
+
/**
|
|
26
|
+
* @public
|
|
27
|
+
*/
|
|
28
|
+
export interface DescribeSelfUpgradeConfigurationRequest {
|
|
29
|
+
/**
|
|
30
|
+
* <p>The ID of the Amazon Web Services account that contains the Quick self-upgrade configuration.</p>
|
|
31
|
+
* @public
|
|
32
|
+
*/
|
|
33
|
+
AwsAccountId: string | undefined;
|
|
34
|
+
/**
|
|
35
|
+
* <p>The Quick namespace that you want to describe the Quick self-upgrade configuration for.</p>
|
|
36
|
+
* @public
|
|
37
|
+
*/
|
|
38
|
+
Namespace: string | undefined;
|
|
39
|
+
}
|
|
40
|
+
/**
|
|
41
|
+
* <p>The self-upgrade configuration for the Quick account.</p>
|
|
42
|
+
* @public
|
|
43
|
+
*/
|
|
44
|
+
export interface SelfUpgradeConfiguration {
|
|
45
|
+
/**
|
|
46
|
+
* <p>Status set for the self-upgrade configuration for the Quick account. It can contain the following values:</p>
|
|
47
|
+
* <ul>
|
|
48
|
+
* <li>
|
|
49
|
+
* <p>
|
|
50
|
+
* <code>AUTO_APPROVAL</code>: All the self-upgrade requests will be auto approved.</p>
|
|
51
|
+
* </li>
|
|
52
|
+
* <li>
|
|
53
|
+
* <p>
|
|
54
|
+
* <code>ADMIN_APPROVAL</code>: All the self-upgrade requests will require admin approval.</p>
|
|
55
|
+
* </li>
|
|
56
|
+
* </ul>
|
|
57
|
+
* @public
|
|
58
|
+
*/
|
|
59
|
+
SelfUpgradeStatus?: SelfUpgradeStatus | undefined;
|
|
60
|
+
}
|
|
61
|
+
/**
|
|
62
|
+
* @public
|
|
63
|
+
*/
|
|
64
|
+
export interface DescribeSelfUpgradeConfigurationResponse {
|
|
65
|
+
/**
|
|
66
|
+
* <p>The self-upgrade configuration for the Quick account.</p>
|
|
67
|
+
* @public
|
|
68
|
+
*/
|
|
69
|
+
SelfUpgradeConfiguration?: SelfUpgradeConfiguration | undefined;
|
|
70
|
+
/**
|
|
71
|
+
* <p>The Amazon Web Services request ID for this operation.</p>
|
|
72
|
+
* @public
|
|
73
|
+
*/
|
|
74
|
+
RequestId?: string | undefined;
|
|
75
|
+
/**
|
|
76
|
+
* <p>The HTTP status of the request.</p>
|
|
77
|
+
* @public
|
|
78
|
+
*/
|
|
79
|
+
Status?: number | undefined;
|
|
80
|
+
}
|
|
5
81
|
/**
|
|
6
82
|
* @public
|
|
7
83
|
*/
|
|
@@ -1614,6 +1690,11 @@ export interface RegisteredUserDashboardFeatureConfigurations {
|
|
|
1614
1690
|
* @public
|
|
1615
1691
|
*/
|
|
1616
1692
|
ThresholdAlerts?: ThresholdAlertsConfigurations | undefined;
|
|
1693
|
+
/**
|
|
1694
|
+
* <p>The dashboard customization summary configuration for an embedded Quick Sight dashboard.</p>
|
|
1695
|
+
* @public
|
|
1696
|
+
*/
|
|
1697
|
+
DashboardCustomizationSummary?: DashboardCustomizationSummaryConfigurations | undefined;
|
|
1617
1698
|
}
|
|
1618
1699
|
/**
|
|
1619
1700
|
* <p>Information about the dashboard you want to embed.</p>
|
|
@@ -1730,6 +1811,11 @@ export interface RegisteredUserConsoleFeatureConfigurations {
|
|
|
1730
1811
|
* @public
|
|
1731
1812
|
*/
|
|
1732
1813
|
ThresholdAlerts?: ThresholdAlertsConfigurations | undefined;
|
|
1814
|
+
/**
|
|
1815
|
+
* <p>The dashboard customization summary configuration for an embedded Quick Sight console.</p>
|
|
1816
|
+
* @public
|
|
1817
|
+
*/
|
|
1818
|
+
DashboardCustomizationSummary?: DashboardCustomizationSummaryConfigurations | undefined;
|
|
1733
1819
|
}
|
|
1734
1820
|
/**
|
|
1735
1821
|
* <p>Information about the Amazon Quick Sight console that you want to embed.</p>
|
|
@@ -8468,212 +8554,3 @@ export interface UpdateTopicRefreshScheduleRequest {
|
|
|
8468
8554
|
*/
|
|
8469
8555
|
RefreshSchedule: TopicRefreshSchedule | undefined;
|
|
8470
8556
|
}
|
|
8471
|
-
/**
|
|
8472
|
-
* @public
|
|
8473
|
-
*/
|
|
8474
|
-
export interface UpdateTopicRefreshScheduleResponse {
|
|
8475
|
-
/**
|
|
8476
|
-
* <p>The ID of the topic that you want to modify. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.</p>
|
|
8477
|
-
* @public
|
|
8478
|
-
*/
|
|
8479
|
-
TopicId?: string | undefined;
|
|
8480
|
-
/**
|
|
8481
|
-
* <p>The Amazon Resource Name (ARN) of the topic.</p>
|
|
8482
|
-
* @public
|
|
8483
|
-
*/
|
|
8484
|
-
TopicArn?: string | undefined;
|
|
8485
|
-
/**
|
|
8486
|
-
* <p>The Amazon Resource Name (ARN) of the dataset.</p>
|
|
8487
|
-
* @public
|
|
8488
|
-
*/
|
|
8489
|
-
DatasetArn?: string | undefined;
|
|
8490
|
-
/**
|
|
8491
|
-
* <p>The HTTP status of the request.</p>
|
|
8492
|
-
* @public
|
|
8493
|
-
*/
|
|
8494
|
-
Status?: number | undefined;
|
|
8495
|
-
/**
|
|
8496
|
-
* <p>The Amazon Web Services request ID for this operation.</p>
|
|
8497
|
-
* @public
|
|
8498
|
-
*/
|
|
8499
|
-
RequestId?: string | undefined;
|
|
8500
|
-
}
|
|
8501
|
-
/**
|
|
8502
|
-
* @public
|
|
8503
|
-
*/
|
|
8504
|
-
export interface UpdateUserRequest {
|
|
8505
|
-
/**
|
|
8506
|
-
* <p>The Amazon Quick Sight user name that you want to update.</p>
|
|
8507
|
-
* @public
|
|
8508
|
-
*/
|
|
8509
|
-
UserName: string | undefined;
|
|
8510
|
-
/**
|
|
8511
|
-
* <p>The ID for the Amazon Web Services account that the user is in. Currently, you use the ID for the
|
|
8512
|
-
* Amazon Web Services account that contains your Amazon Quick Sight account.</p>
|
|
8513
|
-
* @public
|
|
8514
|
-
*/
|
|
8515
|
-
AwsAccountId: string | undefined;
|
|
8516
|
-
/**
|
|
8517
|
-
* <p>The namespace. Currently, you should set this to <code>default</code>.</p>
|
|
8518
|
-
* @public
|
|
8519
|
-
*/
|
|
8520
|
-
Namespace: string | undefined;
|
|
8521
|
-
/**
|
|
8522
|
-
* <p>The email address of the user that you want to update.</p>
|
|
8523
|
-
* @public
|
|
8524
|
-
*/
|
|
8525
|
-
Email: string | undefined;
|
|
8526
|
-
/**
|
|
8527
|
-
* <p>The Amazon Quick Sight role of the user. The role can be one of the
|
|
8528
|
-
* following default security cohorts:</p>
|
|
8529
|
-
* <ul>
|
|
8530
|
-
* <li>
|
|
8531
|
-
* <p>
|
|
8532
|
-
* <code>READER</code>: A user who has read-only access to dashboards.</p>
|
|
8533
|
-
* </li>
|
|
8534
|
-
* <li>
|
|
8535
|
-
* <p>
|
|
8536
|
-
* <code>AUTHOR</code>: A user who can create data sources, datasets, analyses, and
|
|
8537
|
-
* dashboards.</p>
|
|
8538
|
-
* </li>
|
|
8539
|
-
* <li>
|
|
8540
|
-
* <p>
|
|
8541
|
-
* <code>ADMIN</code>: A user who is an author, who can also manage Amazon Quick Sight
|
|
8542
|
-
* settings.</p>
|
|
8543
|
-
* </li>
|
|
8544
|
-
* <li>
|
|
8545
|
-
* <p>
|
|
8546
|
-
* <code>READER_PRO</code>: Reader Pro adds Generative BI capabilities to the Reader role. Reader Pros have access to Amazon Q in Quick Sight, can build stories with Amazon Q, and can generate executive summaries from dashboards.</p>
|
|
8547
|
-
* </li>
|
|
8548
|
-
* <li>
|
|
8549
|
-
* <p>
|
|
8550
|
-
* <code>AUTHOR_PRO</code>: Author Pro adds Generative BI capabilities to the Author role. Author Pros can author dashboards with natural language with Amazon Q, build stories with Amazon Q, create Topics for Q&A, and generate executive summaries from dashboards.</p>
|
|
8551
|
-
* </li>
|
|
8552
|
-
* <li>
|
|
8553
|
-
* <p>
|
|
8554
|
-
* <code>ADMIN_PRO</code>: Admin Pros are Author Pros who can also manage Amazon Quick Sight administrative settings. Admin Pro users are billed at Author Pro pricing.</p>
|
|
8555
|
-
* </li>
|
|
8556
|
-
* </ul>
|
|
8557
|
-
* <p>The name of the Quick Sight role is invisible to the user except for the console
|
|
8558
|
-
* screens dealing with permissions.</p>
|
|
8559
|
-
* @public
|
|
8560
|
-
*/
|
|
8561
|
-
Role: UserRole | undefined;
|
|
8562
|
-
/**
|
|
8563
|
-
* <p>(Enterprise edition only) The name of the custom permissions profile that you want to
|
|
8564
|
-
* assign to this user. Customized permissions allows you to control a user's access by
|
|
8565
|
-
* restricting access the following operations:</p>
|
|
8566
|
-
* <ul>
|
|
8567
|
-
* <li>
|
|
8568
|
-
* <p>Create and update data sources</p>
|
|
8569
|
-
* </li>
|
|
8570
|
-
* <li>
|
|
8571
|
-
* <p>Create and update datasets</p>
|
|
8572
|
-
* </li>
|
|
8573
|
-
* <li>
|
|
8574
|
-
* <p>Create and update email reports</p>
|
|
8575
|
-
* </li>
|
|
8576
|
-
* <li>
|
|
8577
|
-
* <p>Subscribe to email reports</p>
|
|
8578
|
-
* </li>
|
|
8579
|
-
* </ul>
|
|
8580
|
-
* <p>A set of custom permissions includes any combination of these restrictions. Currently,
|
|
8581
|
-
* you need to create the profile names for custom permission sets by using the Quick Sight
|
|
8582
|
-
* console. Then, you use the <code>RegisterUser</code> API operation to assign the named set of
|
|
8583
|
-
* permissions to a Quick Sight user. </p>
|
|
8584
|
-
* <p>Quick Sight custom permissions are applied through IAM policies. Therefore, they
|
|
8585
|
-
* override the permissions typically granted by assigning Quick Sight users to one of the
|
|
8586
|
-
* default security cohorts in Quick Sight (admin, author, reader).</p>
|
|
8587
|
-
* <p>This feature is available only to Quick Sight Enterprise edition subscriptions.</p>
|
|
8588
|
-
* @public
|
|
8589
|
-
*/
|
|
8590
|
-
CustomPermissionsName?: string | undefined;
|
|
8591
|
-
/**
|
|
8592
|
-
* <p>A flag that you use to indicate that you want to remove all custom permissions
|
|
8593
|
-
* from this user. Using this parameter resets the user to the state
|
|
8594
|
-
* it was in before a custom permissions profile was applied. This parameter defaults to
|
|
8595
|
-
* NULL and it doesn't accept any other value.</p>
|
|
8596
|
-
* @public
|
|
8597
|
-
*/
|
|
8598
|
-
UnapplyCustomPermissions?: boolean | undefined;
|
|
8599
|
-
/**
|
|
8600
|
-
* <p>The type of supported external login provider that provides identity to let a user federate into Quick Sight with an associated Identity and Access Management(IAM) role. The type of supported external login provider can be one of the following.</p>
|
|
8601
|
-
* <ul>
|
|
8602
|
-
* <li>
|
|
8603
|
-
* <p>
|
|
8604
|
-
* <code>COGNITO</code>: Amazon Cognito. The provider URL is cognito-identity.amazonaws.com. When choosing the <code>COGNITO</code> provider type, don’t use the "CustomFederationProviderUrl" parameter which is only needed when the external provider is custom.</p>
|
|
8605
|
-
* </li>
|
|
8606
|
-
* <li>
|
|
8607
|
-
* <p>
|
|
8608
|
-
* <code>CUSTOM_OIDC</code>: Custom OpenID Connect (OIDC) provider. When choosing <code>CUSTOM_OIDC</code> type, use the <code>CustomFederationProviderUrl</code> parameter to provide the custom OIDC provider URL.</p>
|
|
8609
|
-
* </li>
|
|
8610
|
-
* <li>
|
|
8611
|
-
* <p>
|
|
8612
|
-
* <code>NONE</code>: This clears all the previously saved external login information for a user. Use the
|
|
8613
|
-
* <code>
|
|
8614
|
-
* <a href="https://docs.aws.amazon.com/quicksight/latest/APIReference/API_DescribeUser.html">DescribeUser</a>
|
|
8615
|
-
* </code>
|
|
8616
|
-
* API operation to check the external login information.</p>
|
|
8617
|
-
* </li>
|
|
8618
|
-
* </ul>
|
|
8619
|
-
* @public
|
|
8620
|
-
*/
|
|
8621
|
-
ExternalLoginFederationProviderType?: string | undefined;
|
|
8622
|
-
/**
|
|
8623
|
-
* <p>The URL of the custom OpenID Connect (OIDC) provider that provides identity to let a user federate
|
|
8624
|
-
* into Quick Sight with an associated Identity and Access Management(IAM) role. This parameter should
|
|
8625
|
-
* only be used when <code>ExternalLoginFederationProviderType</code> parameter is set to <code>CUSTOM_OIDC</code>.</p>
|
|
8626
|
-
* @public
|
|
8627
|
-
*/
|
|
8628
|
-
CustomFederationProviderUrl?: string | undefined;
|
|
8629
|
-
/**
|
|
8630
|
-
* <p>The identity ID for a user in the external login provider.</p>
|
|
8631
|
-
* @public
|
|
8632
|
-
*/
|
|
8633
|
-
ExternalLoginId?: string | undefined;
|
|
8634
|
-
}
|
|
8635
|
-
/**
|
|
8636
|
-
* @public
|
|
8637
|
-
*/
|
|
8638
|
-
export interface UpdateUserResponse {
|
|
8639
|
-
/**
|
|
8640
|
-
* <p>The Amazon Quick Sight user.</p>
|
|
8641
|
-
* @public
|
|
8642
|
-
*/
|
|
8643
|
-
User?: User | undefined;
|
|
8644
|
-
/**
|
|
8645
|
-
* <p>The Amazon Web Services request ID for this operation.</p>
|
|
8646
|
-
* @public
|
|
8647
|
-
*/
|
|
8648
|
-
RequestId?: string | undefined;
|
|
8649
|
-
/**
|
|
8650
|
-
* <p>The HTTP status of the request.</p>
|
|
8651
|
-
* @public
|
|
8652
|
-
*/
|
|
8653
|
-
Status?: number | undefined;
|
|
8654
|
-
}
|
|
8655
|
-
/**
|
|
8656
|
-
* @public
|
|
8657
|
-
*/
|
|
8658
|
-
export interface UpdateUserCustomPermissionRequest {
|
|
8659
|
-
/**
|
|
8660
|
-
* <p>The username of the user that you want to update custom permissions for.</p>
|
|
8661
|
-
* @public
|
|
8662
|
-
*/
|
|
8663
|
-
UserName: string | undefined;
|
|
8664
|
-
/**
|
|
8665
|
-
* <p>The ID of the Amazon Web Services account that contains the custom permission configuration that you want to update.</p>
|
|
8666
|
-
* @public
|
|
8667
|
-
*/
|
|
8668
|
-
AwsAccountId: string | undefined;
|
|
8669
|
-
/**
|
|
8670
|
-
* <p>The namespace that the user belongs to.</p>
|
|
8671
|
-
* @public
|
|
8672
|
-
*/
|
|
8673
|
-
Namespace: string | undefined;
|
|
8674
|
-
/**
|
|
8675
|
-
* <p>The name of the custom permissions that you want to update.</p>
|
|
8676
|
-
* @public
|
|
8677
|
-
*/
|
|
8678
|
-
CustomPermissionsName: string | undefined;
|
|
8679
|
-
}
|