@aws-sdk/client-quicksight 3.1048.0 → 3.1050.0

package/dist-types/models/models_4.d.ts

@@ -1,7 +1,217 @@
-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";
+import type { AssetBundleExportFormat, AssetBundleImportFailureAction, AssignmentStatus, DashboardsQAStatus, DataSetImportMode, EmbeddingIdentityType, FieldName, FilterOperator, FlowPublishState, FolderFilterAttribute, FolderType, GeneratedAnswerStatus, GroupFilterAttribute, GroupFilterOperator, IdentityStore, IdentityType, IncludeFolderMembers, IncludeGeneratedAnswer, IncludeQuickSightQIndex, NamespaceErrorType, NamespaceStatus, 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";
 import type { AccountCustomization, ActionConnectorSearchFilter, ActionConnectorSummary, ActiveIAMPolicyAssignment, AmazonQInQuickSightConsoleConfigurations, AmazonQInQuickSightDashboardConfigurations, Entity, Sheet } from "./models_0";
-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, LinkSharingConfiguration, ResourcePermission, SharedViewConfigurations, SslProperties, Tag, ValidationStrategy, VpcConnectionProperties } from "./models_2";
-import type { CustomInstructions, CustomPermissions, DashboardCustomizationSummaryConfigurations, DashboardSearchFilter, DashboardSummary, DashboardVersionSummary, DashboardVisualResult, DataSetConfiguration, DataSetSearchFilter, DataSetSummary, DataSource, DataSourceCredentials, DataSourceSearchFilter, DataSourceSummary, FieldFolder, Group, GroupMember, Ingestion, LogicalTable, NamespaceInfoV2, PerformanceConfiguration, PhysicalTable, RefreshSchedule, RegisteredCustomerManagedKey, RowLevelPermissionDataSet, RowLevelPermissionTagConfiguration, SemanticModelConfiguration, SnapshotConfiguration, TemplateAlias, TemplateSourceEntity, TemplateVersionDefinition, ThemeAlias, ThemeConfiguration, TopicDetails, TopicRefreshSchedule } from "./models_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, DataSetRefreshProperties, DataSourceParameters, LinkSharingConfiguration, ResourcePermission, SharedViewConfigurations, SslProperties, Tag, ValidationStrategy, VpcConnectionProperties } from "./models_2";
+import type { CustomInstructions, CustomPermissions, DashboardCustomizationSummaryConfigurations, DashboardSearchFilter, DashboardSummary, DashboardVersionSummary, DashboardVisualResult, DataSetConfiguration, DatasetParameter, DataSetSearchFilter, DataSetSummary, DataSetUsageConfiguration, DataSource, DataSourceCredentials, DataSourceSearchFilter, DataSourceSummary, FieldFolder, Group, GroupMember, Ingestion, LogicalTable, PerformanceConfiguration, PhysicalTable, QDataKey, RefreshSchedule, RegisteredCustomerManagedKey, RowLevelPermissionDataSet, RowLevelPermissionTagConfiguration, SemanticModelConfiguration, SnapshotConfiguration, TemplateAlias, TemplateSourceEntity, TemplateVersionDefinition, ThemeAlias, ThemeConfiguration, TopicDetails, TopicRefreshSchedule } from "./models_3";
+/**
+ * @public
+ */
+export interface DescribeKeyRegistrationResponse {
+    /**
+     * <p>The ID of the Amazon Web Services account that contains the customer managed key registration specified in the request.</p>
+     * @public
+     */
+    AwsAccountId?: string | undefined;
+    /**
+     * <p>A list of <code>RegisteredCustomerManagedKey</code> objects in a Quick Sight account.</p>
+     * @public
+     */
+    KeyRegistration?: RegisteredCustomerManagedKey[] | undefined;
+    /**
+     * <p>A list of <code>QDataKey</code> objects in a Quick Sight account.</p>
+     * @public
+     */
+    QDataKey?: QDataKey | undefined;
+    /**
+     * <p>The Amazon Web Services request ID for this operation.</p>
+     * @public
+     */
+    RequestId?: string | undefined;
+    /**
+     * <p>The HTTP status of the request.</p>
+     * @public
+     */
+    Status?: number | undefined;
+}
+/**
+ * @public
+ */
+export interface DescribeNamespaceRequest {
+    /**
+     * <p>The ID for the Amazon Web Services account that contains the Quick Sight namespace that you want to describe.</p>
+     * @public
+     */
+    AwsAccountId: string | undefined;
+    /**
+     * <p>The namespace that you want to describe.</p>
+     * @public
+     */
+    Namespace: string | undefined;
+}
+/**
+ * <p>Errors that occur during namespace creation.</p>
+ * @public
+ */
+export interface NamespaceError {
+    /**
+     * <p>The error type.</p>
+     * @public
+     */
+    Type?: NamespaceErrorType | undefined;
+    /**
+     * <p>The message for the error.</p>
+     * @public
+     */
+    Message?: string | undefined;
+}
+/**
+ * <p>The error type.</p>
+ * @public
+ */
+export interface NamespaceInfoV2 {
+    /**
+     * <p>The name of the error.</p>
+     * @public
+     */
+    Name?: string | undefined;
+    /**
+     * <p>The namespace ARN.</p>
+     * @public
+     */
+    Arn?: string | undefined;
+    /**
+     * <p>The namespace Amazon Web Services Region.</p>
+     * @public
+     */
+    CapacityRegion?: string | undefined;
+    /**
+     * <p>The creation status of a namespace that is not yet completely created.</p>
+     * @public
+     */
+    CreationStatus?: NamespaceStatus | undefined;
+    /**
+     * <p>The identity store used for the namespace.</p>
+     * @public
+     */
+    IdentityStore?: IdentityStore | undefined;
+    /**
+     * <p>An error that occurred when the namespace was created.</p>
+     * @public
+     */
+    NamespaceError?: NamespaceError | undefined;
+    /**
+     * <p>The Amazon Resource Name (ARN) for the IAM Identity Center application.</p>
+     * @public
+     */
+    IamIdentityCenterApplicationArn?: string | undefined;
+    /**
+     * <p>The Amazon Resource Name (ARN) for the IAM Identity Center instance.</p>
+     * @public
+     */
+    IamIdentityCenterInstanceArn?: string | undefined;
+}
+/**
+ * @public
+ */
+export interface DescribeNamespaceResponse {
+    /**
+     * <p>The information about the namespace that you're describing. The response includes
+     *         the namespace ARN, name, Amazon Web Services Region, creation status, and identity store. <code>DescribeNamespace</code> also
+     *         works for namespaces that are in the process of being created. For incomplete namespaces,
+     *         this API operation lists the namespace error types and messages associated with the creation process.</p>
+     * @public
+     */
+    Namespace?: NamespaceInfoV2 | undefined;
+    /**
+     * <p>The Amazon Web Services request ID for this operation.</p>
+     * @public
+     */
+    RequestId?: string | undefined;
+    /**
+     * <p>The HTTP status of the request.</p>
+     * @public
+     */
+    Status?: number | undefined;
+}
+/**
+ * @public
+ */
+export interface DescribeQPersonalizationConfigurationRequest {
+    /**
+     * <p>The ID of the Amazon Web Services account that contains the personalization configuration that the user wants described.</p>
+     * @public
+     */
+    AwsAccountId: string | undefined;
+}
+/**
+ * @public
+ */
+export interface DescribeQPersonalizationConfigurationResponse {
+    /**
+     * <p>A value that indicates whether personalization is enabled or not.</p>
+     * @public
+     */
+    PersonalizationMode?: PersonalizationMode | undefined;
+    /**
+     * <p>The Amazon Web Services request ID for this operation.</p>
+     * @public
+     */
+    RequestId?: string | undefined;
+    /**
+     * <p>The HTTP status of the request.</p>
+     * @public
+     */
+    Status?: number | undefined;
+}
+/**
+ * @public
+ */
+export interface DescribeQuickSightQSearchConfigurationRequest {
+    /**
+     * <p>The ID of the Amazon Web Services account that contains the Quick Sight Q Search configuration that the user wants described.</p>
+     * @public
+     */
+    AwsAccountId: string | undefined;
+}
+/**
+ * @public
+ */
+export interface DescribeQuickSightQSearchConfigurationResponse {
+    /**
+     * <p>The status of Quick Sight Q Search configuration.</p>
+     * @public
+     */
+    QSearchStatus?: QSearchStatus | undefined;
+    /**
+     * <p>The Amazon Web Services request ID for this operation.</p>
+     * @public
+     */
+    RequestId?: string | undefined;
+    /**
+     * <p>The HTTP status of the request.</p>
+     * @public
+     */
+    Status?: number | undefined;
+}
+/**
+ * @public
+ */
+export interface DescribeRefreshScheduleRequest {
+    /**
+     * <p>The Amazon Web Services account ID.</p>
+     * @public
+     */
+    AwsAccountId: string | undefined;
+    /**
+     * <p>The ID of the dataset.</p>
+     * @public
+     */
+    DataSetId: string | undefined;
+    /**
+     * <p>The ID of the refresh schedule.</p>
+     * @public
+     */
+    ScheduleId: string | undefined;
+}
 /**
  * @public
  */
@@ -8278,288 +8488,3 @@ export interface UpdateTemplatePermissionsRequest {
      */
     RevokePermissions?: ResourcePermission[] | undefined;
 }
-/**
- * @public
- */
-export interface UpdateTemplatePermissionsResponse {
-    /**
-     * <p>The ID for the template.</p>
-     * @public
-     */
-    TemplateId?: string | undefined;
-    /**
-     * <p>The Amazon Resource Name (ARN) of the template.</p>
-     * @public
-     */
-    TemplateArn?: string | undefined;
-    /**
-     * <p>A list of resource permissions to be set on the template.</p>
-     * @public
-     */
-    Permissions?: ResourcePermission[] | undefined;
-    /**
-     * <p>The Amazon Web Services request ID for this operation.</p>
-     * @public
-     */
-    RequestId?: string | undefined;
-    /**
-     * <p>The HTTP status of the request.</p>
-     * @public
-     */
-    Status?: number | undefined;
-}
-/**
- * @public
- */
-export interface UpdateThemeRequest {
-    /**
-     * <p>The ID of the Amazon Web Services account that contains the theme that you're updating.</p>
-     * @public
-     */
-    AwsAccountId: string | undefined;
-    /**
-     * <p>The ID for the theme.</p>
-     * @public
-     */
-    ThemeId: string | undefined;
-    /**
-     * <p>The name for the theme.</p>
-     * @public
-     */
-    Name?: string | undefined;
-    /**
-     * <p>The theme ID, defined by Amazon Quick Sight, that a custom theme inherits from.
-     * 		All themes initially inherit from a default Quick Sight theme.</p>
-     * @public
-     */
-    BaseThemeId: string | undefined;
-    /**
-     * <p>A description of the theme version that you're updating Every time that you call
-     * 				<code>UpdateTheme</code>, you create a new version of the theme. Each version of the
-     * 			theme maintains a description of the version in <code>VersionDescription</code>.</p>
-     * @public
-     */
-    VersionDescription?: string | undefined;
-    /**
-     * <p>The theme configuration, which contains the theme display properties.</p>
-     * @public
-     */
-    Configuration?: ThemeConfiguration | undefined;
-}
-/**
- * @public
- */
-export interface UpdateThemeResponse {
-    /**
-     * <p>The ID for the theme.</p>
-     * @public
-     */
-    ThemeId?: string | undefined;
-    /**
-     * <p>The Amazon Resource Name (ARN) for the theme.</p>
-     * @public
-     */
-    Arn?: string | undefined;
-    /**
-     * <p>The Amazon Resource Name (ARN) for the new version of the theme.</p>
-     * @public
-     */
-    VersionArn?: string | undefined;
-    /**
-     * <p>The creation status of the theme.</p>
-     * @public
-     */
-    CreationStatus?: ResourceStatus | undefined;
-    /**
-     * <p>The HTTP status of the request.</p>
-     * @public
-     */
-    Status?: number | undefined;
-    /**
-     * <p>The Amazon Web Services request ID for this operation.</p>
-     * @public
-     */
-    RequestId?: string | undefined;
-}
-/**
- * @public
- */
-export interface UpdateThemeAliasRequest {
-    /**
-     * <p>The ID of the Amazon Web Services account that contains the theme alias that you're updating.</p>
-     * @public
-     */
-    AwsAccountId: string | undefined;
-    /**
-     * <p>The ID for the theme.</p>
-     * @public
-     */
-    ThemeId: string | undefined;
-    /**
-     * <p>The name of the theme alias that you want to update.</p>
-     * @public
-     */
-    AliasName: string | undefined;
-    /**
-     * <p>The version number of the theme that the alias should reference.</p>
-     * @public
-     */
-    ThemeVersionNumber: number | undefined;
-}
-/**
- * @public
- */
-export interface UpdateThemeAliasResponse {
-    /**
-     * <p>Information about the theme alias.</p>
-     * @public
-     */
-    ThemeAlias?: ThemeAlias | undefined;
-    /**
-     * <p>The HTTP status of the request.</p>
-     * @public
-     */
-    Status?: number | undefined;
-    /**
-     * <p>The Amazon Web Services request ID for this operation.</p>
-     * @public
-     */
-    RequestId?: string | undefined;
-}
-/**
- * @public
- */
-export interface UpdateThemePermissionsRequest {
-    /**
-     * <p>The ID of the Amazon Web Services account that contains the theme.</p>
-     * @public
-     */
-    AwsAccountId: string | undefined;
-    /**
-     * <p>The ID for the theme.</p>
-     * @public
-     */
-    ThemeId: string | undefined;
-    /**
-     * <p>A list of resource permissions to be granted for the theme.</p>
-     * @public
-     */
-    GrantPermissions?: ResourcePermission[] | undefined;
-    /**
-     * <p>A list of resource permissions to be revoked from the theme.</p>
-     * @public
-     */
-    RevokePermissions?: ResourcePermission[] | undefined;
-}
-/**
- * @public
- */
-export interface UpdateThemePermissionsResponse {
-    /**
-     * <p>The ID for the theme.</p>
-     * @public
-     */
-    ThemeId?: string | undefined;
-    /**
-     * <p>The Amazon Resource Name (ARN) of the theme.</p>
-     * @public
-     */
-    ThemeArn?: string | undefined;
-    /**
-     * <p>The resulting list of resource permissions for the theme.</p>
-     * @public
-     */
-    Permissions?: ResourcePermission[] | undefined;
-    /**
-     * <p>The Amazon Web Services request ID for this operation.</p>
-     * @public
-     */
-    RequestId?: string | undefined;
-    /**
-     * <p>The HTTP status of the request.</p>
-     * @public
-     */
-    Status?: number | undefined;
-}
-/**
- * @public
- */
-export interface UpdateTopicRequest {
-    /**
-     * <p>The ID of the Amazon Web Services account that contains the topic that you want to
-     *          update.</p>
-     * @public
-     */
-    AwsAccountId: string | undefined;
-    /**
-     * <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>
-     * @public
-     */
-    TopicId: string | undefined;
-    /**
-     * <p>The definition of the topic that you want to update.</p>
-     * @public
-     */
-    Topic: TopicDetails | undefined;
-    /**
-     * <p>Custom instructions for the topic.</p>
-     * @public
-     */
-    CustomInstructions?: CustomInstructions | undefined;
-}
-/**
- * @public
- */
-export interface UpdateTopicResponse {
-    /**
-     * <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>
-     * @public
-     */
-    TopicId?: string | undefined;
-    /**
-     * <p>The Amazon Resource Name (ARN) of the topic.</p>
-     * @public
-     */
-    Arn?: string | undefined;
-    /**
-     * <p>The Amazon Resource Name (ARN) of the topic refresh.</p>
-     * @public
-     */
-    RefreshArn?: string | undefined;
-    /**
-     * <p>The Amazon Web Services request ID for this operation.</p>
-     * @public
-     */
-    RequestId?: string | undefined;
-    /**
-     * <p>The HTTP status of the request.</p>
-     * @public
-     */
-    Status?: number | undefined;
-}
-/**
- * @public
- */
-export interface UpdateTopicPermissionsRequest {
-    /**
-     * <p>The ID of the Amazon Web Services account that contains the topic that you want to update
-     *          the permissions for.</p>
-     * @public
-     */
-    AwsAccountId: string | undefined;
-    /**
-     * <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>
-     * @public
-     */
-    TopicId: string | undefined;
-    /**
-     * <p>The resource permissions that you want to grant to the topic.</p>
-     * @public
-     */
-    GrantPermissions?: ResourcePermission[] | undefined;
-    /**
-     * <p>The resource permissions that you want to revoke from the topic.</p>
-     * @public
-     */
-    RevokePermissions?: ResourcePermission[] | undefined;
-}