@aws-sdk/client-quicksight 3.936.0 → 3.938.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/index.js +101 -23
- package/dist-es/models/enums.js +3 -0
- package/dist-es/schemas/schemas_0.js +97 -23
- package/dist-types/commands/CreateAnalysisCommand.d.ts +47 -1
- package/dist-types/commands/CreateDashboardCommand.d.ts +47 -1
- package/dist-types/commands/CreateDataSourceCommand.d.ts +1 -2
- package/dist-types/commands/CreateTemplateCommand.d.ts +47 -1
- package/dist-types/commands/CreateThemeCommand.d.ts +84 -0
- package/dist-types/commands/DescribeAnalysisDefinitionCommand.d.ts +47 -1
- package/dist-types/commands/DescribeDashboardDefinitionCommand.d.ts +47 -1
- package/dist-types/commands/DescribeTemplateDefinitionCommand.d.ts +47 -1
- package/dist-types/commands/DescribeThemeCommand.d.ts +84 -0
- package/dist-types/commands/DescribeVPCConnectionCommand.d.ts +1 -1
- package/dist-types/commands/GenerateEmbedUrlForRegisteredUserCommand.d.ts +1 -0
- package/dist-types/commands/GenerateEmbedUrlForRegisteredUserWithIdentityCommand.d.ts +1 -0
- package/dist-types/commands/UpdateAnalysisCommand.d.ts +47 -1
- package/dist-types/commands/UpdateDashboardCommand.d.ts +47 -1
- package/dist-types/commands/UpdateTemplateCommand.d.ts +47 -1
- package/dist-types/commands/UpdateThemeCommand.d.ts +84 -0
- package/dist-types/models/enums.d.ts +11 -0
- package/dist-types/models/models_0.d.ts +82 -33
- package/dist-types/models/models_1.d.ts +35 -78
- package/dist-types/models/models_2.d.ts +88 -104
- package/dist-types/models/models_3.d.ts +218 -167
- package/dist-types/models/models_4.d.ts +179 -4
- package/dist-types/schemas/schemas_0.d.ts +6 -0
- package/dist-types/ts3.4/commands/CreateDataSourceCommand.d.ts +4 -2
- package/dist-types/ts3.4/commands/DescribeVPCConnectionCommand.d.ts +1 -1
- package/dist-types/ts3.4/models/enums.d.ts +4 -0
- package/dist-types/ts3.4/models/models_0.d.ts +18 -8
- package/dist-types/ts3.4/models/models_1.d.ts +9 -21
- package/dist-types/ts3.4/models/models_2.d.ts +22 -22
- package/dist-types/ts3.4/models/models_3.d.ts +49 -37
- package/dist-types/ts3.4/models/models_4.d.ts +41 -4
- package/dist-types/ts3.4/schemas/schemas_0.d.ts +6 -0
- package/package.json +1 -1
|
@@ -1,6 +1,82 @@
|
|
|
1
|
-
import { ActionConnectorType, AggType, AssetBundleExportFormat, AssetBundleExportJobAnalysisPropertyToOverride, AssetBundleExportJobDashboardPropertyToOverride, AssetBundleExportJobDataSetPropertyToOverride, AssetBundleExportJobDataSourcePropertyToOverride, AssetBundleExportJobFolderPropertyToOverride, AssetBundleExportJobRefreshSchedulePropertyToOverride, AssetBundleExportJobStatus, AssetBundleExportJobThemePropertyToOverride, AssetBundleExportJobVPCConnectionPropertyToOverride, AssetBundleImportFailureAction, AssetBundleImportJobStatus, AuthenticationMethodOption, AuthenticationType, AuthorizationCodeGrantCredentialsSource, BrandStatus, BrandVersionStatus, CapabilityState, ClientCredentialsSource, ColumnDataSubType, ColumnDataType, ColumnOrderingType, ColumnTagName, ComparisonMethodType, ConnectionAuthType, ConstantType, ContributionAnalysisDirection, ContributionAnalysisSortType, DashboardBehavior, DashboardUIState, DataSetDateComparisonFilterOperator, DataSetImportMode, DataSetNumericComparisonFilterOperator, DatasetParameterValueType, DataSetStringComparisonFilterOperator, DataSetStringListFilterOperator, DataSetUseAs,
|
|
1
|
+
import { ActionConnectorType, AggType, AnonymousUserDashboardEmbeddingConfigurationDisabledFeature, AnonymousUserDashboardEmbeddingConfigurationEnabledFeature, AssetBundleExportFormat, AssetBundleExportJobAnalysisPropertyToOverride, AssetBundleExportJobDashboardPropertyToOverride, AssetBundleExportJobDataSetPropertyToOverride, AssetBundleExportJobDataSourcePropertyToOverride, AssetBundleExportJobFolderPropertyToOverride, AssetBundleExportJobRefreshSchedulePropertyToOverride, AssetBundleExportJobStatus, AssetBundleExportJobThemePropertyToOverride, AssetBundleExportJobVPCConnectionPropertyToOverride, AssetBundleImportFailureAction, AssetBundleImportJobStatus, AuthenticationMethodOption, AuthenticationType, AuthorizationCodeGrantCredentialsSource, BrandStatus, BrandVersionStatus, CapabilityState, ClientCredentialsSource, ColumnDataSubType, ColumnDataType, ColumnOrderingType, ColumnTagName, ComparisonMethodType, ConnectionAuthType, ConstantType, ContributionAnalysisDirection, ContributionAnalysisSortType, DashboardBehavior, DashboardUIState, DataSetDateComparisonFilterOperator, DataSetImportMode, DataSetNumericComparisonFilterOperator, DatasetParameterValueType, DataSetStringComparisonFilterOperator, DataSetStringListFilterOperator, DataSetUseAs, DisplayFormat, Edition, FileFormat, FilterClass, GeoSpatialCountryCode, GeoSpatialDataRole, InputColumnDataType, JoinOperationType, JoinType, LookbackWindowSizeUnit, NullFilterOption, NumberScale, RefreshFailureAlertStatus, ResourceStatus, ReviewedAnswerErrorCode, RowLevelPermissionFormatVersion, RowLevelPermissionPolicy, ServiceType, SnapshotFileFormatType, SnapshotFileSheetSelectionScope, StarburstProductType, Status, TextQualifier, TimeGranularity, TopicIRFilterFunction, TopicIRFilterType, TopicNumericSeparatorSymbol, TopicSortDirection, TopicTimeGranularity, UndefinedSpecifiedValueType, ValidationStrategyMode, WebCrawlerAuthType } from "./enums";
|
|
2
2
|
import { AccountCustomization, AdHocFilteringOption, AggFunction, AggregateOperation, AggregationPartitionBy, AmazonElasticsearchParameters, AmazonOpenSearchParameters, AnalysisDefaults, AssetOptions, CalculatedField, ColumnConfiguration, DataPrepAggregationFunction, DataSetColumnIdMapping, DataSetIdentifierDeclaration, FilterGroup, ParameterDeclaration, TransformOperationSource, VisualMenuOption } from "./models_0";
|
|
3
|
-
import { AnalysisDefinition, AnalysisSourceEntity, Anchor,
|
|
3
|
+
import { AnalysisDefinition, AnalysisSourceEntity, Anchor, AnonymousUserDashboardFeatureConfigurations, DataSetReference, SheetDefinition, StaticFile } from "./models_1";
|
|
4
|
+
/**
|
|
5
|
+
* <p>Information about the dashboard that you want to embed.</p>
|
|
6
|
+
* @public
|
|
7
|
+
*/
|
|
8
|
+
export interface AnonymousUserDashboardEmbeddingConfiguration {
|
|
9
|
+
/**
|
|
10
|
+
* <p>The dashboard ID for the dashboard that you want the user to see first. This ID is
|
|
11
|
+
* included in the output URL. When the URL in response is accessed, Amazon Quick Sight
|
|
12
|
+
* renders this dashboard.</p>
|
|
13
|
+
* <p>The Amazon Resource Name (ARN) of this dashboard must be included in the
|
|
14
|
+
* <code>AuthorizedResourceArns</code> parameter. Otherwise, the request will fail with
|
|
15
|
+
* <code>InvalidParameterValueException</code>.</p>
|
|
16
|
+
* @public
|
|
17
|
+
*/
|
|
18
|
+
InitialDashboardId: string | undefined;
|
|
19
|
+
/**
|
|
20
|
+
* <p>A list of all enabled features of a specified anonymous dashboard.</p>
|
|
21
|
+
* @public
|
|
22
|
+
*/
|
|
23
|
+
EnabledFeatures?: AnonymousUserDashboardEmbeddingConfigurationEnabledFeature[] | undefined;
|
|
24
|
+
/**
|
|
25
|
+
* <p>A list of all disabled features of a specified anonymous dashboard.</p>
|
|
26
|
+
* @public
|
|
27
|
+
*/
|
|
28
|
+
DisabledFeatures?: AnonymousUserDashboardEmbeddingConfigurationDisabledFeature[] | undefined;
|
|
29
|
+
/**
|
|
30
|
+
* <p>The feature configuration for an embedded dashboard.</p>
|
|
31
|
+
* @public
|
|
32
|
+
*/
|
|
33
|
+
FeatureConfigurations?: AnonymousUserDashboardFeatureConfigurations | undefined;
|
|
34
|
+
}
|
|
35
|
+
/**
|
|
36
|
+
* <p>A structure that contains the following elements:</p>
|
|
37
|
+
* <ul>
|
|
38
|
+
* <li>
|
|
39
|
+
* <p>The <code>DashboardId</code> of the dashboard that has the visual that you
|
|
40
|
+
* want to embed.</p>
|
|
41
|
+
* </li>
|
|
42
|
+
* <li>
|
|
43
|
+
* <p>The <code>SheetId</code> of the sheet that has the visual that you want to
|
|
44
|
+
* embed.</p>
|
|
45
|
+
* </li>
|
|
46
|
+
* <li>
|
|
47
|
+
* <p>The <code>VisualId</code> of the visual that you want to embed.</p>
|
|
48
|
+
* </li>
|
|
49
|
+
* </ul>
|
|
50
|
+
* <p>The <code>DashboardId</code>, <code>SheetId</code>, and <code>VisualId</code> can be
|
|
51
|
+
* found in the <code>IDs for developers</code> section of the <code>Embed visual</code>
|
|
52
|
+
* pane of the visual's on-visual menu of the Amazon Quick Sight console. You can also get
|
|
53
|
+
* the <code>DashboardId</code> with a <code>ListDashboards</code> API operation.</p>
|
|
54
|
+
* @public
|
|
55
|
+
*/
|
|
56
|
+
export interface DashboardVisualId {
|
|
57
|
+
/**
|
|
58
|
+
* <p>The ID of the dashboard that has the visual that you want to embed. The
|
|
59
|
+
* <code>DashboardId</code> can be found in the <code>IDs for developers</code> section
|
|
60
|
+
* of the <code>Embed visual</code> pane of the visual's on-visual menu of the Quick Suite console. You can also get the <code>DashboardId</code> with a
|
|
61
|
+
* <code>ListDashboards</code> API operation.</p>
|
|
62
|
+
* @public
|
|
63
|
+
*/
|
|
64
|
+
DashboardId: string | undefined;
|
|
65
|
+
/**
|
|
66
|
+
* <p>The ID of the sheet that the has visual that you want to embed. The
|
|
67
|
+
* <code>SheetId</code> can be found in the <code>IDs for developers</code> section of
|
|
68
|
+
* the <code>Embed visual</code> pane of the visual's on-visual menu of the Quick Suite console.</p>
|
|
69
|
+
* @public
|
|
70
|
+
*/
|
|
71
|
+
SheetId: string | undefined;
|
|
72
|
+
/**
|
|
73
|
+
* <p>The ID of the visual that you want to embed. The <code>VisualID</code> can be found in
|
|
74
|
+
* the <code>IDs for developers</code> section of the <code>Embed visual</code> pane of the
|
|
75
|
+
* visual's on-visual menu of the Amazon Quick Sight console.</p>
|
|
76
|
+
* @public
|
|
77
|
+
*/
|
|
78
|
+
VisualId: string | undefined;
|
|
79
|
+
}
|
|
4
80
|
/**
|
|
5
81
|
* <p>The experience that you are embedding. You can use this object to generate a url that
|
|
6
82
|
* embeds a visual into your application.</p>
|
|
@@ -4736,11 +4812,21 @@ export interface BookmarksConfigurations {
|
|
|
4736
4812
|
* @public
|
|
4737
4813
|
*/
|
|
4738
4814
|
export interface BorderStyle {
|
|
4815
|
+
/**
|
|
4816
|
+
* <p>The option to add color for tile borders for visuals.</p>
|
|
4817
|
+
* @public
|
|
4818
|
+
*/
|
|
4819
|
+
Color?: string | undefined;
|
|
4739
4820
|
/**
|
|
4740
4821
|
* <p>The option to enable display of borders for visuals.</p>
|
|
4741
4822
|
* @public
|
|
4742
4823
|
*/
|
|
4743
4824
|
Show?: boolean | undefined;
|
|
4825
|
+
/**
|
|
4826
|
+
* <p>The option to set the width of tile borders for visuals.</p>
|
|
4827
|
+
* @public
|
|
4828
|
+
*/
|
|
4829
|
+
Width?: string | undefined;
|
|
4744
4830
|
}
|
|
4745
4831
|
/**
|
|
4746
4832
|
* <p>The source of the image.</p>
|
|
@@ -8629,105 +8715,3 @@ export interface WebProxyCredentials {
|
|
|
8629
8715
|
*/
|
|
8630
8716
|
WebProxyPassword: string | undefined;
|
|
8631
8717
|
}
|
|
8632
|
-
/**
|
|
8633
|
-
* <p>Data source credentials. This is a variant type structure. For this structure to be
|
|
8634
|
-
* valid, only one of the attributes can be non-null.</p>
|
|
8635
|
-
* @public
|
|
8636
|
-
*/
|
|
8637
|
-
export interface DataSourceCredentials {
|
|
8638
|
-
/**
|
|
8639
|
-
* <p>Credential pair. For more information, see
|
|
8640
|
-
* <code>
|
|
8641
|
-
* <a href="https://docs.aws.amazon.com/quicksight/latest/APIReference/API_CredentialPair.html">CredentialPair</a>
|
|
8642
|
-
* </code>.</p>
|
|
8643
|
-
* @public
|
|
8644
|
-
*/
|
|
8645
|
-
CredentialPair?: CredentialPair | undefined;
|
|
8646
|
-
/**
|
|
8647
|
-
* <p>The Amazon Resource Name (ARN) of a data source that has the credential pair that you
|
|
8648
|
-
* want to use. When <code>CopySourceArn</code> is not null, the credential pair from the
|
|
8649
|
-
* data source in the ARN is used as the credentials for the
|
|
8650
|
-
* <code>DataSourceCredentials</code> structure.</p>
|
|
8651
|
-
* @public
|
|
8652
|
-
*/
|
|
8653
|
-
CopySourceArn?: string | undefined;
|
|
8654
|
-
/**
|
|
8655
|
-
* <p>The Amazon Resource Name (ARN) of the secret associated with the data source in Amazon Secrets Manager.</p>
|
|
8656
|
-
* @public
|
|
8657
|
-
*/
|
|
8658
|
-
SecretArn?: string | undefined;
|
|
8659
|
-
/**
|
|
8660
|
-
* <p>The credentials for connecting through a web proxy server.</p>
|
|
8661
|
-
* @public
|
|
8662
|
-
*/
|
|
8663
|
-
WebProxyCredentials?: WebProxyCredentials | undefined;
|
|
8664
|
-
}
|
|
8665
|
-
/**
|
|
8666
|
-
* @public
|
|
8667
|
-
*/
|
|
8668
|
-
export interface CreateDataSourceRequest {
|
|
8669
|
-
/**
|
|
8670
|
-
* <p>The Amazon Web Services account ID.</p>
|
|
8671
|
-
* @public
|
|
8672
|
-
*/
|
|
8673
|
-
AwsAccountId: string | undefined;
|
|
8674
|
-
/**
|
|
8675
|
-
* <p>An ID for the data source. This ID is unique per Amazon Web Services Region for each
|
|
8676
|
-
* Amazon Web Services account. </p>
|
|
8677
|
-
* @public
|
|
8678
|
-
*/
|
|
8679
|
-
DataSourceId: string | undefined;
|
|
8680
|
-
/**
|
|
8681
|
-
* <p>A display name for the data source.</p>
|
|
8682
|
-
* @public
|
|
8683
|
-
*/
|
|
8684
|
-
Name: string | undefined;
|
|
8685
|
-
/**
|
|
8686
|
-
* <p>The type of the data source. To return a list of all data sources, use
|
|
8687
|
-
* <code>ListDataSources</code>.</p>
|
|
8688
|
-
* <p>Use <code>AMAZON_ELASTICSEARCH</code> for Amazon OpenSearch Service.</p>
|
|
8689
|
-
* @public
|
|
8690
|
-
*/
|
|
8691
|
-
Type: DataSourceType | undefined;
|
|
8692
|
-
/**
|
|
8693
|
-
* <p>The parameters that Amazon Quick Sight uses to connect to your underlying
|
|
8694
|
-
* source.</p>
|
|
8695
|
-
* @public
|
|
8696
|
-
*/
|
|
8697
|
-
DataSourceParameters?: DataSourceParameters | undefined;
|
|
8698
|
-
/**
|
|
8699
|
-
* <p>The credentials Amazon Quick Sight that uses to connect to your underlying source.
|
|
8700
|
-
* Currently, only credentials based on user name and password are supported.</p>
|
|
8701
|
-
* @public
|
|
8702
|
-
*/
|
|
8703
|
-
Credentials?: DataSourceCredentials | undefined;
|
|
8704
|
-
/**
|
|
8705
|
-
* <p>A list of resource permissions on the data source.</p>
|
|
8706
|
-
* @public
|
|
8707
|
-
*/
|
|
8708
|
-
Permissions?: ResourcePermission[] | undefined;
|
|
8709
|
-
/**
|
|
8710
|
-
* <p>Use this parameter only when you want Amazon Quick Sight to use a VPC connection when
|
|
8711
|
-
* connecting to your underlying source.</p>
|
|
8712
|
-
* @public
|
|
8713
|
-
*/
|
|
8714
|
-
VpcConnectionProperties?: VpcConnectionProperties | undefined;
|
|
8715
|
-
/**
|
|
8716
|
-
* <p>Secure Socket Layer (SSL) properties that apply when Amazon Quick Sight connects to
|
|
8717
|
-
* your underlying source.</p>
|
|
8718
|
-
* @public
|
|
8719
|
-
*/
|
|
8720
|
-
SslProperties?: SslProperties | undefined;
|
|
8721
|
-
/**
|
|
8722
|
-
* <p>Contains a map of the key-value pairs for the resource tag or tags assigned to the
|
|
8723
|
-
* data source.</p>
|
|
8724
|
-
* @public
|
|
8725
|
-
*/
|
|
8726
|
-
Tags?: Tag[] | undefined;
|
|
8727
|
-
/**
|
|
8728
|
-
* <p>When you create the data source, Amazon Quick Sight adds the data source to these
|
|
8729
|
-
* folders.</p>
|
|
8730
|
-
* @public
|
|
8731
|
-
*/
|
|
8732
|
-
FolderArns?: string[] | undefined;
|
|
8733
|
-
}
|
|
@@ -1,7 +1,109 @@
|
|
|
1
|
-
import { AssetBundleExportFormat, AssetBundleExportJobStatus, AssetBundleImportFailureAction, AssetBundleImportJobStatus, AssignmentStatus, AuthorSpecifiedAggregation, CategoryFilterFunction, CategoryFilterType, ColumnDataRole, ColumnDataSubType, ColumnDataType, ConstantType, DashboardErrorType, DashboardFilterAttribute, DashboardsQAStatus, DataSetFilterAttribute, DataSetImportMode, DataSetUseAs, DataSourceErrorInfoType, DataSourceFilterAttribute, DataSourceType, DayOfWeek, DefaultAggregation, DisplayFormat, FilterClass, FilterOperator, FolderType, IdentityStore, IdentityType, IncludeFolderMembers, IngestionErrorType, IngestionRequestSource, IngestionRequestType, IngestionStatus, IngestionType, MemberType, NamedEntityAggType, NamedFilterAggType, NamedFilterType, NamespaceErrorType, NamespaceStatus,
|
|
2
|
-
import { AccountCustomization, AccountInfo, AccountSettings, ActionConnector, Analysis, AnalysisDefaults, AnalysisError, AssetOptions, CalculatedField, ColumnConfiguration, Entity, FilterGroup, ParameterDeclaration, QueryExecutionOptions, Sheet } from "./models_0";
|
|
1
|
+
import { AssetBundleExportFormat, AssetBundleExportJobStatus, AssetBundleImportFailureAction, AssetBundleImportJobStatus, AssignmentStatus, AuthorSpecifiedAggregation, CategoryFilterFunction, CategoryFilterType, ColumnDataRole, ColumnDataSubType, ColumnDataType, ConstantType, DashboardErrorType, DashboardFilterAttribute, DashboardsQAStatus, DataSetFilterAttribute, DataSetImportMode, DataSetUseAs, DataSourceErrorInfoType, DataSourceFilterAttribute, DataSourceType, DayOfWeek, DefaultAggregation, DisplayFormat, FilterClass, FilterOperator, FolderType, HorizontalTextAlignment, IdentityStore, IdentityType, IncludeFolderMembers, IngestionErrorType, IngestionRequestSource, IngestionRequestType, IngestionStatus, IngestionType, MemberType, NamedEntityAggType, NamedFilterAggType, NamedFilterType, NamespaceErrorType, NamespaceStatus, NullFilterType, PersonalizationMode, PropertyRole, PropertyUsage, QDataKeyType, QSearchStatus, RefreshInterval, ResourceStatus, Role, ServiceType, SharingModel, SnapshotJobStatus, TemplateErrorType, TextTransform, ThemeErrorType, ThemeType, TopicRefreshStatus, TopicRelativeDateFilterFunction, TopicScheduleType, TopicTimeGranularity, TopicUserExperienceVersion, UserRole, VPCConnectionAvailabilityStatus, VPCConnectionResourceStatus } from "./enums";
|
|
2
|
+
import { AccountCustomization, AccountInfo, AccountSettings, ActionConnector, Analysis, AnalysisDefaults, AnalysisError, AssetOptions, CalculatedField, ColumnConfiguration, Entity, FilterGroup, FontConfiguration, ParameterDeclaration, QueryExecutionOptions, Sheet } from "./models_0";
|
|
3
3
|
import { AnalysisDefinition, DataSetReference, SheetDefinition, StaticFile } from "./models_1";
|
|
4
|
-
import { _Parameters, 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, DataSetRefreshProperties, DataSetUsageConfiguration, DataSourceParameters, DisplayFormatOptions, FieldFolder, LinkSharingConfiguration, LogicalTable, PerformanceConfiguration, PhysicalTable, ResourcePermission, RowLevelPermissionDataSet, RowLevelPermissionTagConfiguration, SemanticModelConfiguration, SnapshotFile, SnapshotS3DestinationConfiguration, SslProperties, Tag, ValidationStrategy, VpcConnectionProperties } from "./models_2";
|
|
4
|
+
import { _Parameters, AnonymousUserSnapshotJobResult, AssetBundleCloudFormationOverridePropertyConfiguration, AssetBundleExportJobError, AssetBundleExportJobValidationStrategy, AssetBundleExportJobWarning, AssetBundleImportJobError, AssetBundleImportJobOverrideParameters, AssetBundleImportJobOverridePermissions, AssetBundleImportJobOverrideTags, AssetBundleImportJobOverrideValidationStrategy, AssetBundleImportJobWarning, AssetBundleImportSourceDescription, BorderStyle, BrandDefinition, BrandDetail, Capabilities, CellValueSynonym, CollectiveConstant, ColumnGroup, ColumnGroupSchema, ColumnLevelPermissionRule, ColumnSchema, ComparativeOrder, CredentialPair, DashboardPublishOptions, DashboardVersionDefinition, DataPrepConfiguration, DatasetParameter, DataSetRefreshProperties, DataSetUsageConfiguration, DataSourceParameters, DisplayFormatOptions, FieldFolder, LinkSharingConfiguration, LogicalTable, PerformanceConfiguration, PhysicalTable, ResourcePermission, RowLevelPermissionDataSet, RowLevelPermissionTagConfiguration, SemanticModelConfiguration, SnapshotFile, SnapshotS3DestinationConfiguration, SslProperties, Tag, ValidationStrategy, VpcConnectionProperties, WebProxyCredentials } from "./models_2";
|
|
5
|
+
/**
|
|
6
|
+
* <p>Data source credentials. This is a variant type structure. For this structure to be
|
|
7
|
+
* valid, only one of the attributes can be non-null.</p>
|
|
8
|
+
* @public
|
|
9
|
+
*/
|
|
10
|
+
export interface DataSourceCredentials {
|
|
11
|
+
/**
|
|
12
|
+
* <p>Credential pair. For more information, see
|
|
13
|
+
* <code>
|
|
14
|
+
* <a href="https://docs.aws.amazon.com/quicksight/latest/APIReference/API_CredentialPair.html">CredentialPair</a>
|
|
15
|
+
* </code>.</p>
|
|
16
|
+
* @public
|
|
17
|
+
*/
|
|
18
|
+
CredentialPair?: CredentialPair | undefined;
|
|
19
|
+
/**
|
|
20
|
+
* <p>The Amazon Resource Name (ARN) of a data source that has the credential pair that you
|
|
21
|
+
* want to use. When <code>CopySourceArn</code> is not null, the credential pair from the
|
|
22
|
+
* data source in the ARN is used as the credentials for the
|
|
23
|
+
* <code>DataSourceCredentials</code> structure.</p>
|
|
24
|
+
* @public
|
|
25
|
+
*/
|
|
26
|
+
CopySourceArn?: string | undefined;
|
|
27
|
+
/**
|
|
28
|
+
* <p>The Amazon Resource Name (ARN) of the secret associated with the data source in Amazon Secrets Manager.</p>
|
|
29
|
+
* @public
|
|
30
|
+
*/
|
|
31
|
+
SecretArn?: string | undefined;
|
|
32
|
+
/**
|
|
33
|
+
* <p>The credentials for connecting through a web proxy server.</p>
|
|
34
|
+
* @public
|
|
35
|
+
*/
|
|
36
|
+
WebProxyCredentials?: WebProxyCredentials | undefined;
|
|
37
|
+
}
|
|
38
|
+
/**
|
|
39
|
+
* @public
|
|
40
|
+
*/
|
|
41
|
+
export interface CreateDataSourceRequest {
|
|
42
|
+
/**
|
|
43
|
+
* <p>The Amazon Web Services account ID.</p>
|
|
44
|
+
* @public
|
|
45
|
+
*/
|
|
46
|
+
AwsAccountId: string | undefined;
|
|
47
|
+
/**
|
|
48
|
+
* <p>An ID for the data source. This ID is unique per Amazon Web Services Region for each
|
|
49
|
+
* Amazon Web Services account. </p>
|
|
50
|
+
* @public
|
|
51
|
+
*/
|
|
52
|
+
DataSourceId: string | undefined;
|
|
53
|
+
/**
|
|
54
|
+
* <p>A display name for the data source.</p>
|
|
55
|
+
* @public
|
|
56
|
+
*/
|
|
57
|
+
Name: string | undefined;
|
|
58
|
+
/**
|
|
59
|
+
* <p>The type of the data source. To return a list of all data sources, use
|
|
60
|
+
* <code>ListDataSources</code>.</p>
|
|
61
|
+
* <p>Use <code>AMAZON_ELASTICSEARCH</code> for Amazon OpenSearch Service.</p>
|
|
62
|
+
* @public
|
|
63
|
+
*/
|
|
64
|
+
Type: DataSourceType | undefined;
|
|
65
|
+
/**
|
|
66
|
+
* <p>The parameters that Amazon Quick Sight uses to connect to your underlying
|
|
67
|
+
* source.</p>
|
|
68
|
+
* @public
|
|
69
|
+
*/
|
|
70
|
+
DataSourceParameters?: DataSourceParameters | undefined;
|
|
71
|
+
/**
|
|
72
|
+
* <p>The credentials Amazon Quick Sight that uses to connect to your underlying source.
|
|
73
|
+
* Currently, only credentials based on user name and password are supported.</p>
|
|
74
|
+
* @public
|
|
75
|
+
*/
|
|
76
|
+
Credentials?: DataSourceCredentials | undefined;
|
|
77
|
+
/**
|
|
78
|
+
* <p>A list of resource permissions on the data source.</p>
|
|
79
|
+
* @public
|
|
80
|
+
*/
|
|
81
|
+
Permissions?: ResourcePermission[] | undefined;
|
|
82
|
+
/**
|
|
83
|
+
* <p>Use this parameter only when you want Amazon Quick Sight to use a VPC connection when
|
|
84
|
+
* connecting to your underlying source.</p>
|
|
85
|
+
* @public
|
|
86
|
+
*/
|
|
87
|
+
VpcConnectionProperties?: VpcConnectionProperties | undefined;
|
|
88
|
+
/**
|
|
89
|
+
* <p>Secure Socket Layer (SSL) properties that apply when Amazon Quick Sight connects to
|
|
90
|
+
* your underlying source.</p>
|
|
91
|
+
* @public
|
|
92
|
+
*/
|
|
93
|
+
SslProperties?: SslProperties | undefined;
|
|
94
|
+
/**
|
|
95
|
+
* <p>Contains a map of the key-value pairs for the resource tag or tags assigned to the
|
|
96
|
+
* data source.</p>
|
|
97
|
+
* @public
|
|
98
|
+
*/
|
|
99
|
+
Tags?: Tag[] | undefined;
|
|
100
|
+
/**
|
|
101
|
+
* <p>When you create the data source, Amazon Quick Sight adds the data source to these
|
|
102
|
+
* folders.</p>
|
|
103
|
+
* @public
|
|
104
|
+
*/
|
|
105
|
+
FolderArns?: string[] | undefined;
|
|
106
|
+
}
|
|
5
107
|
/**
|
|
6
108
|
* @public
|
|
7
109
|
*/
|
|
@@ -1082,16 +1184,47 @@ export interface DataColorPalette {
|
|
|
1082
1184
|
*/
|
|
1083
1185
|
EmptyFillColor?: string | undefined;
|
|
1084
1186
|
}
|
|
1187
|
+
/**
|
|
1188
|
+
* <p>The background configuration for sheets.</p>
|
|
1189
|
+
* @public
|
|
1190
|
+
*/
|
|
1191
|
+
export interface SheetBackgroundStyle {
|
|
1192
|
+
/**
|
|
1193
|
+
* <p>The solid color background option for sheets.</p>
|
|
1194
|
+
* @public
|
|
1195
|
+
*/
|
|
1196
|
+
Color?: string | undefined;
|
|
1197
|
+
/**
|
|
1198
|
+
* <p>The gradient background option for sheets.</p>
|
|
1199
|
+
* @public
|
|
1200
|
+
*/
|
|
1201
|
+
Gradient?: string | undefined;
|
|
1202
|
+
}
|
|
1085
1203
|
/**
|
|
1086
1204
|
* <p>Display options related to tiles on a sheet.</p>
|
|
1087
1205
|
* @public
|
|
1088
1206
|
*/
|
|
1089
1207
|
export interface TileStyle {
|
|
1208
|
+
/**
|
|
1209
|
+
* <p>The background color of a tile.</p>
|
|
1210
|
+
* @public
|
|
1211
|
+
*/
|
|
1212
|
+
BackgroundColor?: string | undefined;
|
|
1090
1213
|
/**
|
|
1091
1214
|
* <p>The border around a tile.</p>
|
|
1092
1215
|
* @public
|
|
1093
1216
|
*/
|
|
1094
1217
|
Border?: BorderStyle | undefined;
|
|
1218
|
+
/**
|
|
1219
|
+
* <p>The border radius of a tile.</p>
|
|
1220
|
+
* @public
|
|
1221
|
+
*/
|
|
1222
|
+
BorderRadius?: string | undefined;
|
|
1223
|
+
/**
|
|
1224
|
+
* <p>The padding of a tile.</p>
|
|
1225
|
+
* @public
|
|
1226
|
+
*/
|
|
1227
|
+
Padding?: string | undefined;
|
|
1095
1228
|
}
|
|
1096
1229
|
/**
|
|
1097
1230
|
* <p>The display options for gutter spacing between tiles on a sheet.</p>
|
|
@@ -1147,6 +1280,11 @@ export interface SheetStyle {
|
|
|
1147
1280
|
* @public
|
|
1148
1281
|
*/
|
|
1149
1282
|
TileLayout?: TileLayoutStyle | undefined;
|
|
1283
|
+
/**
|
|
1284
|
+
* <p>The background for sheets.</p>
|
|
1285
|
+
* @public
|
|
1286
|
+
*/
|
|
1287
|
+
Background?: SheetBackgroundStyle | undefined;
|
|
1150
1288
|
}
|
|
1151
1289
|
/**
|
|
1152
1290
|
* <p>Determines the font settings.</p>
|
|
@@ -1159,6 +1297,48 @@ export interface Font {
|
|
|
1159
1297
|
*/
|
|
1160
1298
|
FontFamily?: string | undefined;
|
|
1161
1299
|
}
|
|
1300
|
+
/**
|
|
1301
|
+
* <p>Configures the display properties of the visual sub-title.</p>
|
|
1302
|
+
* @public
|
|
1303
|
+
*/
|
|
1304
|
+
export interface VisualSubtitleFontConfiguration {
|
|
1305
|
+
/**
|
|
1306
|
+
* <p>Configures the display properties of the given text.</p>
|
|
1307
|
+
* @public
|
|
1308
|
+
*/
|
|
1309
|
+
FontConfiguration?: FontConfiguration | undefined;
|
|
1310
|
+
/**
|
|
1311
|
+
* <p>Determines the alignment of visual sub-title.</p>
|
|
1312
|
+
* @public
|
|
1313
|
+
*/
|
|
1314
|
+
TextAlignment?: HorizontalTextAlignment | undefined;
|
|
1315
|
+
/**
|
|
1316
|
+
* <p>Determines the text transformation of visual sub-title.</p>
|
|
1317
|
+
* @public
|
|
1318
|
+
*/
|
|
1319
|
+
TextTransform?: TextTransform | undefined;
|
|
1320
|
+
}
|
|
1321
|
+
/**
|
|
1322
|
+
* <p>Configures the display properties of the visual title.</p>
|
|
1323
|
+
* @public
|
|
1324
|
+
*/
|
|
1325
|
+
export interface VisualTitleFontConfiguration {
|
|
1326
|
+
/**
|
|
1327
|
+
* <p>Configures the display properties of the given text.</p>
|
|
1328
|
+
* @public
|
|
1329
|
+
*/
|
|
1330
|
+
FontConfiguration?: FontConfiguration | undefined;
|
|
1331
|
+
/**
|
|
1332
|
+
* <p>Determines the alignment of visual title.</p>
|
|
1333
|
+
* @public
|
|
1334
|
+
*/
|
|
1335
|
+
TextAlignment?: HorizontalTextAlignment | undefined;
|
|
1336
|
+
/**
|
|
1337
|
+
* <p>Determines the text transformation of visual title.</p>
|
|
1338
|
+
* @public
|
|
1339
|
+
*/
|
|
1340
|
+
TextTransform?: TextTransform | undefined;
|
|
1341
|
+
}
|
|
1162
1342
|
/**
|
|
1163
1343
|
* <p>Determines the typography options.</p>
|
|
1164
1344
|
* @public
|
|
@@ -1169,6 +1349,41 @@ export interface Typography {
|
|
|
1169
1349
|
* @public
|
|
1170
1350
|
*/
|
|
1171
1351
|
FontFamilies?: Font[] | undefined;
|
|
1352
|
+
/**
|
|
1353
|
+
* <p>Configures the display properties of the given text.</p>
|
|
1354
|
+
* @public
|
|
1355
|
+
*/
|
|
1356
|
+
AxisTitleFontConfiguration?: FontConfiguration | undefined;
|
|
1357
|
+
/**
|
|
1358
|
+
* <p>Configures the display properties of the given text.</p>
|
|
1359
|
+
* @public
|
|
1360
|
+
*/
|
|
1361
|
+
AxisLabelFontConfiguration?: FontConfiguration | undefined;
|
|
1362
|
+
/**
|
|
1363
|
+
* <p>Configures the display properties of the given text.</p>
|
|
1364
|
+
* @public
|
|
1365
|
+
*/
|
|
1366
|
+
LegendTitleFontConfiguration?: FontConfiguration | undefined;
|
|
1367
|
+
/**
|
|
1368
|
+
* <p>Configures the display properties of the given text.</p>
|
|
1369
|
+
* @public
|
|
1370
|
+
*/
|
|
1371
|
+
LegendValueFontConfiguration?: FontConfiguration | undefined;
|
|
1372
|
+
/**
|
|
1373
|
+
* <p>Configures the display properties of the given text.</p>
|
|
1374
|
+
* @public
|
|
1375
|
+
*/
|
|
1376
|
+
DataLabelFontConfiguration?: FontConfiguration | undefined;
|
|
1377
|
+
/**
|
|
1378
|
+
* <p>Configures the display properties of the visual title.</p>
|
|
1379
|
+
* @public
|
|
1380
|
+
*/
|
|
1381
|
+
VisualTitleFontConfiguration?: VisualTitleFontConfiguration | undefined;
|
|
1382
|
+
/**
|
|
1383
|
+
* <p>Configures the display properties of the visual sub-title.</p>
|
|
1384
|
+
* @public
|
|
1385
|
+
*/
|
|
1386
|
+
VisualSubtitleFontConfiguration?: VisualSubtitleFontConfiguration | undefined;
|
|
1172
1387
|
}
|
|
1173
1388
|
/**
|
|
1174
1389
|
* <p>The theme colors that apply to UI and to charts, excluding data colors. The colors
|
|
@@ -8097,167 +8312,3 @@ export interface DescribeUserResponse {
|
|
|
8097
8312
|
*/
|
|
8098
8313
|
Status?: number | undefined;
|
|
8099
8314
|
}
|
|
8100
|
-
/**
|
|
8101
|
-
* @public
|
|
8102
|
-
*/
|
|
8103
|
-
export interface DescribeVPCConnectionRequest {
|
|
8104
|
-
/**
|
|
8105
|
-
* <p>The Amazon Web Services account ID of the account that contains the VPC connection that
|
|
8106
|
-
* you want described.</p>
|
|
8107
|
-
* @public
|
|
8108
|
-
*/
|
|
8109
|
-
AwsAccountId: string | undefined;
|
|
8110
|
-
/**
|
|
8111
|
-
* <p>The ID of the VPC connection that
|
|
8112
|
-
* you're creating. This ID is a unique identifier for each Amazon Web Services Region in an Amazon Web Services account.</p>
|
|
8113
|
-
* @public
|
|
8114
|
-
*/
|
|
8115
|
-
VPCConnectionId: string | undefined;
|
|
8116
|
-
}
|
|
8117
|
-
/**
|
|
8118
|
-
* <p>The structure that contains information about a network interface.</p>
|
|
8119
|
-
* @public
|
|
8120
|
-
*/
|
|
8121
|
-
export interface NetworkInterface {
|
|
8122
|
-
/**
|
|
8123
|
-
* <p>The subnet ID associated with the network interface.</p>
|
|
8124
|
-
* @public
|
|
8125
|
-
*/
|
|
8126
|
-
SubnetId?: string | undefined;
|
|
8127
|
-
/**
|
|
8128
|
-
* <p>The availability zone that the network interface resides in.</p>
|
|
8129
|
-
* @public
|
|
8130
|
-
*/
|
|
8131
|
-
AvailabilityZone?: string | undefined;
|
|
8132
|
-
/**
|
|
8133
|
-
* <p>An error message.</p>
|
|
8134
|
-
* @public
|
|
8135
|
-
*/
|
|
8136
|
-
ErrorMessage?: string | undefined;
|
|
8137
|
-
/**
|
|
8138
|
-
* <p>The status of the network interface.</p>
|
|
8139
|
-
* @public
|
|
8140
|
-
*/
|
|
8141
|
-
Status?: NetworkInterfaceStatus | undefined;
|
|
8142
|
-
/**
|
|
8143
|
-
* <p>The network interface ID.</p>
|
|
8144
|
-
* @public
|
|
8145
|
-
*/
|
|
8146
|
-
NetworkInterfaceId?: string | undefined;
|
|
8147
|
-
}
|
|
8148
|
-
/**
|
|
8149
|
-
* <p>The structure of a VPC connection.</p>
|
|
8150
|
-
* @public
|
|
8151
|
-
*/
|
|
8152
|
-
export interface VPCConnection {
|
|
8153
|
-
/**
|
|
8154
|
-
* <p>The ID of the VPC connection that you're creating. This ID is a unique identifier for each Amazon Web Services Region in an
|
|
8155
|
-
* Amazon Web Services account.</p>
|
|
8156
|
-
* @public
|
|
8157
|
-
*/
|
|
8158
|
-
VPCConnectionId?: string | undefined;
|
|
8159
|
-
/**
|
|
8160
|
-
* <p>The Amazon Resource Name (ARN) of the VPC connection.</p>
|
|
8161
|
-
* @public
|
|
8162
|
-
*/
|
|
8163
|
-
Arn?: string | undefined;
|
|
8164
|
-
/**
|
|
8165
|
-
* <p>The display name for the VPC connection.</p>
|
|
8166
|
-
* @public
|
|
8167
|
-
*/
|
|
8168
|
-
Name?: string | undefined;
|
|
8169
|
-
/**
|
|
8170
|
-
* <p>The Amazon EC2 VPC ID associated with the VPC connection.</p>
|
|
8171
|
-
* @public
|
|
8172
|
-
*/
|
|
8173
|
-
VPCId?: string | undefined;
|
|
8174
|
-
/**
|
|
8175
|
-
* <p>The Amazon EC2 security group IDs associated with the VPC connection.</p>
|
|
8176
|
-
* @public
|
|
8177
|
-
*/
|
|
8178
|
-
SecurityGroupIds?: string[] | undefined;
|
|
8179
|
-
/**
|
|
8180
|
-
* <p>A list of IP addresses of DNS resolver endpoints for the VPC connection.</p>
|
|
8181
|
-
* @public
|
|
8182
|
-
*/
|
|
8183
|
-
DnsResolvers?: string[] | undefined;
|
|
8184
|
-
/**
|
|
8185
|
-
* <p>The status of the VPC connection.</p>
|
|
8186
|
-
* @public
|
|
8187
|
-
*/
|
|
8188
|
-
Status?: VPCConnectionResourceStatus | undefined;
|
|
8189
|
-
/**
|
|
8190
|
-
* <p>The availability status of the VPC connection.</p>
|
|
8191
|
-
* @public
|
|
8192
|
-
*/
|
|
8193
|
-
AvailabilityStatus?: VPCConnectionAvailabilityStatus | undefined;
|
|
8194
|
-
/**
|
|
8195
|
-
* <p>A list of network interfaces.</p>
|
|
8196
|
-
* @public
|
|
8197
|
-
*/
|
|
8198
|
-
NetworkInterfaces?: NetworkInterface[] | undefined;
|
|
8199
|
-
/**
|
|
8200
|
-
* <p>The ARN of the
|
|
8201
|
-
* IAM role associated with the VPC
|
|
8202
|
-
* connection.</p>
|
|
8203
|
-
* @public
|
|
8204
|
-
*/
|
|
8205
|
-
RoleArn?: string | undefined;
|
|
8206
|
-
/**
|
|
8207
|
-
* <p>The time that the VPC connection was created.</p>
|
|
8208
|
-
* @public
|
|
8209
|
-
*/
|
|
8210
|
-
CreatedTime?: Date | undefined;
|
|
8211
|
-
/**
|
|
8212
|
-
* <p>The time that the VPC connection was last updated.</p>
|
|
8213
|
-
* @public
|
|
8214
|
-
*/
|
|
8215
|
-
LastUpdatedTime?: Date | undefined;
|
|
8216
|
-
}
|
|
8217
|
-
/**
|
|
8218
|
-
* @public
|
|
8219
|
-
*/
|
|
8220
|
-
export interface DescribeVPCConnectionResponse {
|
|
8221
|
-
/**
|
|
8222
|
-
* <p>A response object that provides information for the specified VPC connection.</p>
|
|
8223
|
-
* @public
|
|
8224
|
-
*/
|
|
8225
|
-
VPCConnection?: VPCConnection | undefined;
|
|
8226
|
-
/**
|
|
8227
|
-
* <p>The Amazon Web Services request ID for this operation.</p>
|
|
8228
|
-
* @public
|
|
8229
|
-
*/
|
|
8230
|
-
RequestId?: string | undefined;
|
|
8231
|
-
/**
|
|
8232
|
-
* <p>The HTTP status of the request.</p>
|
|
8233
|
-
* @public
|
|
8234
|
-
*/
|
|
8235
|
-
Status?: number | undefined;
|
|
8236
|
-
}
|
|
8237
|
-
/**
|
|
8238
|
-
* <p>An entry that appears when a <code>KeyRegistration</code> update to Quick Sight fails.</p>
|
|
8239
|
-
* @public
|
|
8240
|
-
*/
|
|
8241
|
-
export interface FailedKeyRegistrationEntry {
|
|
8242
|
-
/**
|
|
8243
|
-
* <p>The ARN of the KMS key that failed to update.</p>
|
|
8244
|
-
* @public
|
|
8245
|
-
*/
|
|
8246
|
-
KeyArn?: string | undefined;
|
|
8247
|
-
/**
|
|
8248
|
-
* <p>A message that provides information about why a <code>FailedKeyRegistrationEntry</code> error occurred.</p>
|
|
8249
|
-
* @public
|
|
8250
|
-
*/
|
|
8251
|
-
Message: string | undefined;
|
|
8252
|
-
/**
|
|
8253
|
-
* <p>The HTTP status of a <code>FailedKeyRegistrationEntry</code> error.</p>
|
|
8254
|
-
* @public
|
|
8255
|
-
*/
|
|
8256
|
-
StatusCode: number | undefined;
|
|
8257
|
-
/**
|
|
8258
|
-
* <p>A boolean that indicates whether a <code>FailedKeyRegistrationEntry</code> resulted from user error. If the value of this property is <code>True</code>, the error was caused by user error. If the value of this property is <code>False</code>, the error occurred on the backend. If your job continues fail and with a <code>False</code>
|
|
8259
|
-
* <code>SenderFault</code> value, contact Amazon Web Services Support.</p>
|
|
8260
|
-
* @public
|
|
8261
|
-
*/
|
|
8262
|
-
SenderFault: boolean | undefined;
|
|
8263
|
-
}
|