@aws-sdk/client-quicksight 3.325.0 → 3.327.0

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

@@ -0,0 +1,102 @@
+import { EndpointParameterInstructions } from "@aws-sdk/middleware-endpoint";
+import { Command as $Command } from "@aws-sdk/smithy-client";
+import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@aws-sdk/types";
+import { DeleteVPCConnectionRequest, DeleteVPCConnectionResponse } from "../models/models_2";
+import { QuickSightClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../QuickSightClient";
+/**
+ * @public
+ *
+ * The input for {@link DeleteVPCConnectionCommand}.
+ */
+export interface DeleteVPCConnectionCommandInput extends DeleteVPCConnectionRequest {
+}
+/**
+ * @public
+ *
+ * The output of {@link DeleteVPCConnectionCommand}.
+ */
+export interface DeleteVPCConnectionCommandOutput extends DeleteVPCConnectionResponse, __MetadataBearer {
+}
+/**
+ * @public
+ * <p>Deletes a VPC connection.</p>
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { QuickSightClient, DeleteVPCConnectionCommand } from "@aws-sdk/client-quicksight"; // ES Modules import
+ * // const { QuickSightClient, DeleteVPCConnectionCommand } = require("@aws-sdk/client-quicksight"); // CommonJS import
+ * const client = new QuickSightClient(config);
+ * const input = { // DeleteVPCConnectionRequest
+ *   AwsAccountId: "STRING_VALUE", // required
+ *   VPCConnectionId: "STRING_VALUE", // required
+ * };
+ * const command = new DeleteVPCConnectionCommand(input);
+ * const response = await client.send(command);
+ * // { // DeleteVPCConnectionResponse
+ * //   Arn: "STRING_VALUE",
+ * //   VPCConnectionId: "STRING_VALUE",
+ * //   DeletionStatus: "CREATION_IN_PROGRESS" || "CREATION_SUCCESSFUL" || "CREATION_FAILED" || "UPDATE_IN_PROGRESS" || "UPDATE_SUCCESSFUL" || "UPDATE_FAILED" || "DELETION_IN_PROGRESS" || "DELETION_FAILED" || "DELETED",
+ * //   AvailabilityStatus: "AVAILABLE" || "UNAVAILABLE" || "PARTIALLY_AVAILABLE",
+ * //   RequestId: "STRING_VALUE",
+ * //   Status: Number("int"),
+ * // };
+ *
+ * ```
+ *
+ * @param DeleteVPCConnectionCommandInput - {@link DeleteVPCConnectionCommandInput}
+ * @returns {@link DeleteVPCConnectionCommandOutput}
+ * @see {@link DeleteVPCConnectionCommandInput} for command's `input` shape.
+ * @see {@link DeleteVPCConnectionCommandOutput} 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 QuickSight service, that your policies have the
+ * 			correct permissions, and that you are using the correct credentials.</p>
+ *
+ * @throws {@link ConflictException} (client fault)
+ *  <p>Updating or deleting a resource can cause an inconsistent state.</p>
+ *
+ * @throws {@link InternalFailureException} (server fault)
+ *  <p>An internal failure occurred.</p>
+ *
+ * @throws {@link InvalidParameterValueException} (client fault)
+ *  <p>One or more parameters has a value that isn't valid.</p>
+ *
+ * @throws {@link ResourceNotFoundException} (client fault)
+ *  <p>One or more resources can't be found.</p>
+ *
+ * @throws {@link ThrottlingException} (client fault)
+ *  <p>Access is throttled.</p>
+ *
+ * @throws {@link UnsupportedUserEditionException} (client fault)
+ *  <p>This error indicates that you are calling an operation on an Amazon QuickSight
+ * 			subscription where the edition doesn't include support for that operation. Amazon
+ * 			Amazon QuickSight currently has Standard Edition and Enterprise Edition. Not every operation and
+ * 			capability is available in every edition.</p>
+ *
+ * @throws {@link QuickSightServiceException}
+ * <p>Base exception class for all service exceptions from QuickSight service.</p>
+ *
+ */
+export declare class DeleteVPCConnectionCommand extends $Command<DeleteVPCConnectionCommandInput, DeleteVPCConnectionCommandOutput, QuickSightClientResolvedConfig> {
+    readonly input: DeleteVPCConnectionCommandInput;
+    static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
+    constructor(input: DeleteVPCConnectionCommandInput);
+    /**
+     * @internal
+     */
+    resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: QuickSightClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DeleteVPCConnectionCommandInput, DeleteVPCConnectionCommandOutput>;
+    /**
+     * @internal
+     */
+    private serialize;
+    /**
+     * @internal
+     */
+    private deserialize;
+}

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

@@ -89,6 +89,18 @@ export interface DescribeAccountCustomizationCommandOutput extends DescribeAccou
  * };
  * const command = new DescribeAccountCustomizationCommand(input);
  * const response = await client.send(command);
+ * // { // DescribeAccountCustomizationResponse
+ * //   Arn: "STRING_VALUE",
+ * //   AwsAccountId: "STRING_VALUE",
+ * //   Namespace: "STRING_VALUE",
+ * //   AccountCustomization: { // AccountCustomization
+ * //     DefaultTheme: "STRING_VALUE",
+ * //     DefaultEmailCustomizationTemplate: "STRING_VALUE",
+ * //   },
+ * //   RequestId: "STRING_VALUE",
+ * //   Status: Number("int"),
+ * // };
+ *
  * ```
  *
  * @param DescribeAccountCustomizationCommandInput - {@link DescribeAccountCustomizationCommandInput}
@@ -118,6 +130,8 @@ export interface DescribeAccountCustomizationCommandOutput extends DescribeAccou
  * @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>
  *
  */
 export declare class DescribeAccountCustomizationCommand extends $Command<DescribeAccountCustomizationCommandInput, DescribeAccountCustomizationCommandOutput, QuickSightClientResolvedConfig> {

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

@@ -32,6 +32,19 @@ export interface DescribeAccountSettingsCommandOutput extends DescribeAccountSet
  * };
  * const command = new DescribeAccountSettingsCommand(input);
  * const response = await client.send(command);
+ * // { // DescribeAccountSettingsResponse
+ * //   AccountSettings: { // AccountSettings
+ * //     AccountName: "STRING_VALUE",
+ * //     Edition: "STANDARD" || "ENTERPRISE" || "ENTERPRISE_AND_Q",
+ * //     DefaultNamespace: "STRING_VALUE",
+ * //     NotificationEmail: "STRING_VALUE",
+ * //     PublicSharingEnabled: true || false,
+ * //     TerminationProtectionEnabled: true || false,
+ * //   },
+ * //   RequestId: "STRING_VALUE",
+ * //   Status: Number("int"),
+ * // };
+ *
  * ```
  *
  * @param DescribeAccountSettingsCommandInput - {@link DescribeAccountSettingsCommandInput}
@@ -61,6 +74,8 @@ export interface DescribeAccountSettingsCommandOutput extends DescribeAccountSet
  * @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>
  *
  */
 export declare class DescribeAccountSettingsCommand extends $Command<DescribeAccountSettingsCommandInput, DescribeAccountSettingsCommandOutput, QuickSightClientResolvedConfig> {

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

@@ -31,6 +31,18 @@ export interface DescribeAccountSubscriptionCommandOutput extends DescribeAccoun
  * };
  * const command = new DescribeAccountSubscriptionCommand(input);
  * const response = await client.send(command);
+ * // { // DescribeAccountSubscriptionResponse
+ * //   AccountInfo: { // AccountInfo
+ * //     AccountName: "STRING_VALUE",
+ * //     Edition: "STANDARD" || "ENTERPRISE" || "ENTERPRISE_AND_Q",
+ * //     NotificationEmail: "STRING_VALUE",
+ * //     AuthenticationType: "STRING_VALUE",
+ * //     AccountSubscriptionStatus: "STRING_VALUE",
+ * //   },
+ * //   Status: Number("int"),
+ * //   RequestId: "STRING_VALUE",
+ * // };
+ *
  * ```
  *
  * @param DescribeAccountSubscriptionCommandInput - {@link DescribeAccountSubscriptionCommandInput}
@@ -60,6 +72,8 @@ export interface DescribeAccountSubscriptionCommandOutput extends DescribeAccoun
  * @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>
  *
  */
 export declare class DescribeAccountSubscriptionCommand extends $Command<DescribeAccountSubscriptionCommandInput, DescribeAccountSubscriptionCommandOutput, QuickSightClientResolvedConfig> {

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

@@ -32,6 +32,40 @@ export interface DescribeAnalysisCommandOutput extends DescribeAnalysisResponse,
  * };
  * const command = new DescribeAnalysisCommand(input);
  * const response = await client.send(command);
+ * // { // DescribeAnalysisResponse
+ * //   Analysis: { // Analysis
+ * //     AnalysisId: "STRING_VALUE",
+ * //     Arn: "STRING_VALUE",
+ * //     Name: "STRING_VALUE",
+ * //     Status: "CREATION_IN_PROGRESS" || "CREATION_SUCCESSFUL" || "CREATION_FAILED" || "UPDATE_IN_PROGRESS" || "UPDATE_SUCCESSFUL" || "UPDATE_FAILED" || "DELETED",
+ * //     Errors: [ // AnalysisErrorList
+ * //       { // AnalysisError
+ * //         Type: "ACCESS_DENIED" || "SOURCE_NOT_FOUND" || "DATA_SET_NOT_FOUND" || "INTERNAL_FAILURE" || "PARAMETER_VALUE_INCOMPATIBLE" || "PARAMETER_TYPE_INVALID" || "PARAMETER_NOT_FOUND" || "COLUMN_TYPE_MISMATCH" || "COLUMN_GEOGRAPHIC_ROLE_MISMATCH" || "COLUMN_REPLACEMENT_MISSING",
+ * //         Message: "STRING_VALUE",
+ * //         ViolatedEntities: [ // EntityList
+ * //           { // Entity
+ * //             Path: "STRING_VALUE",
+ * //           },
+ * //         ],
+ * //       },
+ * //     ],
+ * //     DataSetArns: [ // DataSetArnsList
+ * //       "STRING_VALUE",
+ * //     ],
+ * //     ThemeArn: "STRING_VALUE",
+ * //     CreatedTime: new Date("TIMESTAMP"),
+ * //     LastUpdatedTime: new Date("TIMESTAMP"),
+ * //     Sheets: [ // SheetList
+ * //       { // Sheet
+ * //         SheetId: "STRING_VALUE",
+ * //         Name: "STRING_VALUE",
+ * //       },
+ * //     ],
+ * //   },
+ * //   Status: Number("int"),
+ * //   RequestId: "STRING_VALUE",
+ * // };
+ *
  * ```
  *
  * @param DescribeAnalysisCommandInput - {@link DescribeAnalysisCommandInput}
@@ -64,6 +98,8 @@ export interface DescribeAnalysisCommandOutput extends DescribeAnalysisResponse,
  * 			Amazon QuickSight currently has Standard Edition and Enterprise Edition. Not every operation and
  * 			capability is available in every edition.</p>
  *
+ * @throws {@link QuickSightServiceException}
+ * <p>Base exception class for all service exceptions from QuickSight service.</p>
  *
  */
 export declare class DescribeAnalysisCommand extends $Command<DescribeAnalysisCommandInput, DescribeAnalysisCommandOutput, QuickSightClientResolvedConfig> {