@aws-sdk/client-quicksight 3.957.0 → 3.960.0

package/dist-types/commands/UpdateSelfUpgradeConfigurationCommand.d.ts

@@ -0,0 +1,104 @@
+import { Command as $Command } from "@smithy/smithy-client";
+import type { MetadataBearer as __MetadataBearer } from "@smithy/types";
+import type { UpdateSelfUpgradeConfigurationRequest, UpdateSelfUpgradeConfigurationResponse } from "../models/models_4";
+import type { QuickSightClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../QuickSightClient";
+/**
+ * @public
+ */
+export type { __MetadataBearer };
+export { $Command };
+/**
+ * @public
+ *
+ * The input for {@link UpdateSelfUpgradeConfigurationCommand}.
+ */
+export interface UpdateSelfUpgradeConfigurationCommandInput extends UpdateSelfUpgradeConfigurationRequest {
+}
+/**
+ * @public
+ *
+ * The output of {@link UpdateSelfUpgradeConfigurationCommand}.
+ */
+export interface UpdateSelfUpgradeConfigurationCommandOutput extends UpdateSelfUpgradeConfigurationResponse, __MetadataBearer {
+}
+declare const UpdateSelfUpgradeConfigurationCommand_base: {
+    new (input: UpdateSelfUpgradeConfigurationCommandInput): import("@smithy/smithy-client").CommandImpl<UpdateSelfUpgradeConfigurationCommandInput, UpdateSelfUpgradeConfigurationCommandOutput, QuickSightClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    new (input: UpdateSelfUpgradeConfigurationCommandInput): import("@smithy/smithy-client").CommandImpl<UpdateSelfUpgradeConfigurationCommandInput, UpdateSelfUpgradeConfigurationCommandOutput, QuickSightClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
+};
+/**
+ * <p>Updates the self-upgrade configuration for a Quick Suite account.</p>
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { QuickSightClient, UpdateSelfUpgradeConfigurationCommand } from "@aws-sdk/client-quicksight"; // ES Modules import
+ * // const { QuickSightClient, UpdateSelfUpgradeConfigurationCommand } = require("@aws-sdk/client-quicksight"); // CommonJS import
+ * // import type { QuickSightClientConfig } from "@aws-sdk/client-quicksight";
+ * const config = {}; // type is QuickSightClientConfig
+ * const client = new QuickSightClient(config);
+ * const input = { // UpdateSelfUpgradeConfigurationRequest
+ *   AwsAccountId: "STRING_VALUE", // required
+ *   Namespace: "STRING_VALUE", // required
+ *   SelfUpgradeStatus: "AUTO_APPROVAL" || "ADMIN_APPROVAL", // required
+ * };
+ * const command = new UpdateSelfUpgradeConfigurationCommand(input);
+ * const response = await client.send(command);
+ * // { // UpdateSelfUpgradeConfigurationResponse
+ * //   RequestId: "STRING_VALUE",
+ * //   Status: Number("int"),
+ * // };
+ *
+ * ```
+ *
+ * @param UpdateSelfUpgradeConfigurationCommandInput - {@link UpdateSelfUpgradeConfigurationCommandInput}
+ * @returns {@link UpdateSelfUpgradeConfigurationCommandOutput}
+ * @see {@link UpdateSelfUpgradeConfigurationCommandInput} for command's `input` shape.
+ * @see {@link UpdateSelfUpgradeConfigurationCommandOutput} for command's `response` shape.
+ * @see {@link QuickSightClientResolvedConfig | config} for QuickSightClient's `config` shape.
+ *
+ * @throws {@link AccessDeniedException} (client fault)
+ *  <p>You don't have access to this item. The provided credentials couldn't be
+ * 			validated. You might not be authorized to carry out the request. Make sure that your
+ * 			account is authorized to use the Amazon Quick Sight service, that your policies have the
+ * 			correct permissions, and that you are using the correct credentials.</p>
+ *
+ * @throws {@link InternalFailureException} (server fault)
+ *  <p>An internal failure occurred.</p>
+ *
+ * @throws {@link InvalidParameterException} (client fault)
+ *  <p>One or more parameter has a value that isn't valid.</p>
+ *
+ * @throws {@link InvalidParameterValueException} (client fault)
+ *  <p>One or more parameters has a value that isn't valid.</p>
+ *
+ * @throws {@link PreconditionNotMetException} (client fault)
+ *  <p>One or more preconditions aren't met.</p>
+ *
+ * @throws {@link ResourceNotFoundException} (client fault)
+ *  <p>One or more resources can't be found.</p>
+ *
+ * @throws {@link ResourceUnavailableException} (server fault)
+ *  <p>This resource is currently unavailable.</p>
+ *
+ * @throws {@link ThrottlingException} (client fault)
+ *  <p>Access is throttled.</p>
+ *
+ * @throws {@link QuickSightServiceException}
+ * <p>Base exception class for all service exceptions from QuickSight service.</p>
+ *
+ *
+ * @public
+ */
+export declare class UpdateSelfUpgradeConfigurationCommand extends UpdateSelfUpgradeConfigurationCommand_base {
+    /** @internal type navigation helper, not in runtime. */
+    protected static __types: {
+        api: {
+            input: UpdateSelfUpgradeConfigurationRequest;
+            output: UpdateSelfUpgradeConfigurationResponse;
+        };
+        sdk: {
+            input: UpdateSelfUpgradeConfigurationCommandInput;
+            output: UpdateSelfUpgradeConfigurationCommandOutput;
+        };
+    };
+}

package/dist-types/commands/index.d.ts

@@ -100,6 +100,7 @@ export * from "./DescribeQPersonalizationConfigurationCommand";
 export * from "./DescribeQuickSightQSearchConfigurationCommand";
 export * from "./DescribeRefreshScheduleCommand";
 export * from "./DescribeRoleCustomPermissionCommand";
+export * from "./DescribeSelfUpgradeConfigurationCommand";
 export * from "./DescribeTemplateAliasCommand";
 export * from "./DescribeTemplateCommand";
 export * from "./DescribeTemplateDefinitionCommand";
@@ -144,6 +145,7 @@ export * from "./ListIngestionsCommand";
 export * from "./ListNamespacesCommand";
 export * from "./ListRefreshSchedulesCommand";
 export * from "./ListRoleMembershipsCommand";
+export * from "./ListSelfUpgradesCommand";
 export * from "./ListTagsForResourceCommand";
 export * from "./ListTemplateAliasesCommand";
 export * from "./ListTemplateVersionsCommand";
@@ -212,6 +214,8 @@ export * from "./UpdateQuickSightQSearchConfigurationCommand";
 export * from "./UpdateRefreshScheduleCommand";
 export * from "./UpdateRoleCustomPermissionCommand";
 export * from "./UpdateSPICECapacityConfigurationCommand";
+export * from "./UpdateSelfUpgradeCommand";
+export * from "./UpdateSelfUpgradeConfigurationCommand";
 export * from "./UpdateTemplateAliasCommand";
 export * from "./UpdateTemplateCommand";
 export * from "./UpdateTemplatePermissionsCommand";

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

@@ -3571,6 +3571,18 @@ export declare const QSearchStatus: {
  * @public
  */
 export type QSearchStatus = (typeof QSearchStatus)[keyof typeof QSearchStatus];
+/**
+ * @public
+ * @enum
+ */
+export declare const SelfUpgradeStatus: {
+    readonly ADMIN_APPROVAL: "ADMIN_APPROVAL";
+    readonly AUTO_APPROVAL: "AUTO_APPROVAL";
+};
+/**
+ * @public
+ */
+export type SelfUpgradeStatus = (typeof SelfUpgradeStatus)[keyof typeof SelfUpgradeStatus];
 /**
  * @public
  * @enum
@@ -3792,6 +3804,21 @@ export declare const IncludeQuickSightQIndex: {
  * @public
  */
 export type IncludeQuickSightQIndex = (typeof IncludeQuickSightQIndex)[keyof typeof IncludeQuickSightQIndex];
+/**
+ * @public
+ * @enum
+ */
+export declare const SelfUpgradeRequestStatus: {
+    readonly APPROVED: "APPROVED";
+    readonly DENIED: "DENIED";
+    readonly PENDING: "PENDING";
+    readonly UPDATE_FAILED: "UPDATE_FAILED";
+    readonly VERIFY_FAILED: "VERIFY_FAILED";
+};
+/**
+ * @public
+ */
+export type SelfUpgradeRequestStatus = (typeof SelfUpgradeRequestStatus)[keyof typeof SelfUpgradeRequestStatus];
 /**
  * @public
  * @enum
@@ -3858,3 +3885,16 @@ export declare const TopicFilterOperator: {
  * @public
  */
 export type TopicFilterOperator = (typeof TopicFilterOperator)[keyof typeof TopicFilterOperator];
+/**
+ * @public
+ * @enum
+ */
+export declare const SelfUpgradeAdminAction: {
+    readonly APPROVE: "APPROVE";
+    readonly DENY: "DENY";
+    readonly VERIFY: "VERIFY";
+};
+/**
+ * @public
+ */
+export type SelfUpgradeAdminAction = (typeof SelfUpgradeAdminAction)[keyof typeof SelfUpgradeAdminAction];

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

@@ -325,6 +325,24 @@ export declare class InvalidNextTokenException extends __BaseException {
      */
     constructor(opts: __ExceptionOptionType<InvalidNextTokenException, __BaseException>);
 }
+/**
+ * <p>One or more parameter has a value that isn't valid.</p>
+ * @public
+ */
+export declare class InvalidParameterException extends __BaseException {
+    readonly name: "InvalidParameterException";
+    readonly $fault: "client";
+    Message?: string | undefined;
+    /**
+     * <p>The Amazon Web Services request ID for this request.</p>
+     * @public
+     */
+    RequestId?: string | undefined;
+    /**
+     * @internal
+     */
+    constructor(opts: __ExceptionOptionType<InvalidParameterException, __BaseException>);
+}
 /**
  * <p>The domain specified isn't on the allow list. All domains for embedded dashboards must be
  * 			added to the approved list by an Amazon Quick Suite admin.</p>

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

@@ -6022,6 +6022,11 @@ export interface Capabilities {
      * @public
      */
     Research?: CapabilityState | undefined;
+    /**
+     * <p>The ability to enable users to upgrade their user role.</p>
+     * @public
+     */
+    SelfUpgradeUserRole?: CapabilityState | undefined;
 }
 /**
  * <p>A transform operation that casts a column to a different type.</p>

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

@@ -1,4 +1,4 @@
-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, FileFormat, FilterClass, FilterOperator, FolderType, HorizontalTextAlignment, IdentityStore, IncludeFolderMembers, IngestionErrorType, IngestionRequestSource, IngestionRequestType, IngestionStatus, IngestionType, MemberType, NamedEntityAggType, NamedFilterAggType, NamedFilterType, NamespaceErrorType, NamespaceStatus, NullFilterType, PersonalizationMode, PropertyRole, PropertyUsage, QDataKeyType, QSearchStatus, RefreshInterval, ResourceStatus, Role, RowLevelPermissionFormatVersion, RowLevelPermissionPolicy, ServiceType, SharingModel, SnapshotJobStatus, Status, TemplateErrorType, TextQualifier, TextTransform, TopicRelativeDateFilterFunction, TopicScheduleType, TopicTimeGranularity, TopicUserExperienceVersion, VPCConnectionAvailabilityStatus, VPCConnectionResourceStatus } from "./enums";
+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, FileFormat, FilterClass, FilterOperator, FolderType, HorizontalTextAlignment, IdentityStore, IncludeFolderMembers, IngestionErrorType, IngestionRequestSource, IngestionRequestType, IngestionStatus, IngestionType, MemberType, NamedEntityAggType, NamedFilterAggType, NamedFilterType, NamespaceErrorType, NamespaceStatus, NullFilterType, PersonalizationMode, PropertyRole, PropertyUsage, QDataKeyType, QSearchStatus, RefreshInterval, ResourceStatus, Role, RowLevelPermissionFormatVersion, RowLevelPermissionPolicy, SelfUpgradeStatus, ServiceType, SharingModel, SnapshotJobStatus, Status, TemplateErrorType, TextQualifier, TextTransform, TopicRelativeDateFilterFunction, TopicScheduleType, TopicTimeGranularity, TopicUserExperienceVersion, VPCConnectionAvailabilityStatus, VPCConnectionResourceStatus } from "./enums";
 import { type AccountCustomization, type AccountInfo, type AccountSettings, type ActionConnector, type Analysis, type AnalysisDefaults, type AssetOptions, type FontConfiguration, type QueryExecutionOptions, AnalysisError, CalculatedField, ColumnConfiguration, Entity, FilterGroup, ParameterDeclaration, Sheet } from "./models_0";
 import { type _Parameters, type AnalysisDefinition, type AssetBundleCloudFormationOverridePropertyConfiguration, type AssetBundleExportJobValidationStrategy, type AssetBundleImportJobOverrideParameters, type AssetBundleImportJobOverridePermissions, type AssetBundleImportJobOverrideTags, type AssetBundleImportJobOverrideValidationStrategy, type AssetBundleImportSourceDescription, type BorderStyle, type BrandDefinition, type BrandDetail, type Capabilities, type CollectiveConstant, type ComparativeOrder, type DashboardPublishOptions, type DashboardVersionDefinition, type DataPrepConfiguration, type DataSetRefreshProperties, type DataSetUsageConfiguration, type DisplayFormatOptions, type LinkSharingConfiguration, type SslProperties, type ValidationStrategy, type VpcConnectionProperties, AnonymousUserSnapshotJobResult, AssetBundleExportJobError, AssetBundleExportJobWarning, AssetBundleImportJobError, AssetBundleImportJobWarning, CellValueSynonym, ColumnGroup, ColumnGroupSchema, ColumnLevelPermissionRule, ColumnSchema, DatasetParameter, DataSetReference, DataSourceParameters, FieldFolder, InputColumn, LogicalTable, ResourcePermission, SheetDefinition, SnapshotFile, SnapshotJobResultFileGroup, SnapshotS3DestinationConfiguration, StaticFile, Tag } from "./models_2";
 /**
@@ -7940,6 +7940,62 @@ export interface DescribeRoleCustomPermissionResponse {
      */
     Status?: number | undefined;
 }
+/**
+ * @public
+ */
+export interface DescribeSelfUpgradeConfigurationRequest {
+    /**
+     * <p>The ID of the Amazon Web Services account that contains the Quick Suite self-upgrade configuration.</p>
+     * @public
+     */
+    AwsAccountId: string | undefined;
+    /**
+     * <p>The Quick Suite namespace that you want to describe the Quick Suite self-upgrade configuration for.</p>
+     * @public
+     */
+    Namespace: string | undefined;
+}
+/**
+ * <p>The self-upgrade configuration for the Quick Suite account.</p>
+ * @public
+ */
+export interface SelfUpgradeConfiguration {
+    /**
+     * <p>Status set for the self-upgrade configuration for the Quick Suite account. It can contain the following values:</p>
+     *          <ul>
+     *             <li>
+     *                <p>
+     *                   <code>AUTO_APPROVAL</code>: All the self-upgrade requests will be auto approved.</p>
+     *             </li>
+     *             <li>
+     *                <p>
+     *                   <code>ADMIN_APPROVAL</code>: All the self-upgrade requests will require admin approval.</p>
+     *             </li>
+     *          </ul>
+     * @public
+     */
+    SelfUpgradeStatus?: SelfUpgradeStatus | undefined;
+}
+/**
+ * @public
+ */
+export interface DescribeSelfUpgradeConfigurationResponse {
+    /**
+     * <p>The self-upgrade configuration for the Quick Suite account.</p>
+     * @public
+     */
+    SelfUpgradeConfiguration?: SelfUpgradeConfiguration | 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
  */
@@ -8217,131 +8273,3 @@ export interface DescribeTemplateDefinitionRequest {
      */
     AliasName?: string | undefined;
 }
-/**
- * @public
- */
-export interface DescribeTemplateDefinitionResponse {
-    /**
-     * <p>The descriptive name of the template.</p>
-     * @public
-     */
-    Name?: string | undefined;
-    /**
-     * <p>The ID of the template described.</p>
-     * @public
-     */
-    TemplateId?: string | undefined;
-    /**
-     * <p>Errors associated with the template version.</p>
-     * @public
-     */
-    Errors?: TemplateError[] | undefined;
-    /**
-     * <p>Status associated with the template.</p>
-     *          <ul>
-     *             <li>
-     *                <p>
-     *                   <code>CREATION_IN_PROGRESS</code>
-     *                </p>
-     *             </li>
-     *             <li>
-     *                <p>
-     *                   <code>CREATION_SUCCESSFUL</code>
-     *                </p>
-     *             </li>
-     *             <li>
-     *                <p>
-     *                   <code>CREATION_FAILED</code>
-     *                </p>
-     *             </li>
-     *             <li>
-     *                <p>
-     *                   <code>UPDATE_IN_PROGRESS</code>
-     *                </p>
-     *             </li>
-     *             <li>
-     *                <p>
-     *                   <code>UPDATE_SUCCESSFUL</code>
-     *                </p>
-     *             </li>
-     *             <li>
-     *                <p>
-     *                   <code>UPDATE_FAILED</code>
-     *                </p>
-     *             </li>
-     *             <li>
-     *                <p>
-     *                   <code>DELETED</code>
-     *                </p>
-     *             </li>
-     *          </ul>
-     * @public
-     */
-    ResourceStatus?: ResourceStatus | undefined;
-    /**
-     * <p>The ARN of the theme of the template.</p>
-     * @public
-     */
-    ThemeArn?: string | undefined;
-    /**
-     * <p>The definition of the template.</p>
-     *          <p>A definition is the data model of all features in a Dashboard, Template, or Analysis.</p>
-     * @public
-     */
-    Definition?: TemplateVersionDefinition | 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 DescribeTemplatePermissionsRequest {
-    /**
-     * <p>The ID of the Amazon Web Services account that contains the template that you're describing.</p>
-     * @public
-     */
-    AwsAccountId: string | undefined;
-    /**
-     * <p>The ID for the template.</p>
-     * @public
-     */
-    TemplateId: string | undefined;
-}
-/**
- * @public
- */
-export interface DescribeTemplatePermissionsResponse {
-    /**
-     * <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;
-}