import { Command as $Command } from "@smithy/smithy-client"; import type { MetadataBearer as __MetadataBearer } from "@smithy/types"; import type { DescribeAnalysisRequest, DescribeAnalysisResponse } from "../models/models_3"; import type { QuickSightClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../QuickSightClient"; /** * @public */ export type { __MetadataBearer }; export { $Command }; /** * @public * * The input for {@link DescribeAnalysisCommand}. */ export interface DescribeAnalysisCommandInput extends DescribeAnalysisRequest { } /** * @public * * The output of {@link DescribeAnalysisCommand}. */ export interface DescribeAnalysisCommandOutput extends DescribeAnalysisResponse, __MetadataBearer { } declare const DescribeAnalysisCommand_base: { new (input: DescribeAnalysisCommandInput): import("@smithy/smithy-client").CommandImpl; new (input: DescribeAnalysisCommandInput): import("@smithy/smithy-client").CommandImpl; getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions; }; /** *

Provides a summary of the metadata for an analysis.

* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript * import { QuickSightClient, DescribeAnalysisCommand } from "@aws-sdk/client-quicksight"; // ES Modules import * // const { QuickSightClient, DescribeAnalysisCommand } = 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 = { // DescribeAnalysisRequest * AwsAccountId: "STRING_VALUE", // required * AnalysisId: "STRING_VALUE", // required * }; * 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", * // Images: [ // SheetImageList * // { // SheetImage * // SheetImageId: "STRING_VALUE", // required * // Source: { // SheetImageSource * // SheetImageStaticFileSource: { // SheetImageStaticFileSource * // StaticFileId: "STRING_VALUE", // required * // }, * // }, * // Scaling: { // SheetImageScalingConfiguration * // ScalingType: "SCALE_TO_WIDTH" || "SCALE_TO_HEIGHT" || "SCALE_TO_CONTAINER" || "SCALE_NONE", * // }, * // Tooltip: { // SheetImageTooltipConfiguration * // TooltipText: { // SheetImageTooltipText * // PlainText: "STRING_VALUE", * // }, * // Visibility: "HIDDEN" || "VISIBLE", * // }, * // ImageContentAltText: "STRING_VALUE", * // Interactions: { // ImageInteractionOptions * // ImageMenuOption: { // ImageMenuOption * // AvailabilityStatus: "ENABLED" || "DISABLED", * // }, * // }, * // Actions: [ // ImageCustomActionList * // { // ImageCustomAction * // CustomActionId: "STRING_VALUE", // required * // Name: "STRING_VALUE", // required * // Status: "ENABLED" || "DISABLED", * // Trigger: "CLICK" || "MENU", // required * // ActionOperations: [ // ImageCustomActionOperationList // required * // { // ImageCustomActionOperation * // NavigationOperation: { // CustomActionNavigationOperation * // LocalNavigationConfiguration: { // LocalNavigationConfiguration * // TargetSheetId: "STRING_VALUE", // required * // }, * // }, * // URLOperation: { // CustomActionURLOperation * // URLTemplate: "STRING_VALUE", // required * // URLTarget: "NEW_TAB" || "NEW_WINDOW" || "SAME_TAB", // required * // }, * // SetParametersOperation: { // CustomActionSetParametersOperation * // ParameterValueConfigurations: [ // SetParameterValueConfigurationList // required * // { // SetParameterValueConfiguration * // DestinationParameterName: "STRING_VALUE", // required * // Value: { // DestinationParameterValueConfiguration * // CustomValuesConfiguration: { // CustomValuesConfiguration * // IncludeNullValue: true || false, * // CustomValues: { // CustomParameterValues * // StringValues: [ // StringDefaultValueList * // "STRING_VALUE", * // ], * // IntegerValues: [ // IntegerDefaultValueList * // Number("long"), * // ], * // DecimalValues: [ // DecimalDefaultValueList * // Number("double"), * // ], * // DateTimeValues: [ // DateTimeDefaultValueList * // new Date("TIMESTAMP"), * // ], * // }, * // }, * // SelectAllValueOptions: "ALL_VALUES", * // SourceParameterName: "STRING_VALUE", * // SourceField: "STRING_VALUE", * // SourceColumn: { // ColumnIdentifier * // DataSetIdentifier: "STRING_VALUE", // required * // ColumnName: "STRING_VALUE", // required * // }, * // }, * // }, * // ], * // }, * // }, * // ], * // }, * // ], * // }, * // ], * // }, * // ], * // }, * // Status: Number("int"), * // RequestId: "STRING_VALUE", * // }; * * ``` * * @param DescribeAnalysisCommandInput - {@link DescribeAnalysisCommandInput} * @returns {@link DescribeAnalysisCommandOutput} * @see {@link DescribeAnalysisCommandInput} for command's `input` shape. * @see {@link DescribeAnalysisCommandOutput} for command's `response` shape. * @see {@link QuickSightClientResolvedConfig | config} for QuickSightClient's `config` shape. * * @throws {@link AccessDeniedException} (client fault) *

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.

* * @throws {@link InternalFailureException} (server fault) *

An internal failure occurred.

* * @throws {@link InvalidParameterValueException} (client fault) *

One or more parameters has a value that isn't valid.

* * @throws {@link ResourceNotFoundException} (client fault) *

One or more resources can't be found.

* * @throws {@link ThrottlingException} (client fault) *

Access is throttled.

* * @throws {@link UnsupportedUserEditionException} (client fault) *

This error indicates that you are calling an operation on an Amazon Quick Suite * subscription where the edition doesn't include support for that operation. Amazon * Quick Suite currently has Standard Edition and Enterprise Edition. Not every operation and * capability is available in every edition.

* * @throws {@link QuickSightServiceException} *

Base exception class for all service exceptions from QuickSight service.

* * * @public */ export declare class DescribeAnalysisCommand extends DescribeAnalysisCommand_base { /** @internal type navigation helper, not in runtime. */ protected static __types: { api: { input: DescribeAnalysisRequest; output: DescribeAnalysisResponse; }; sdk: { input: DescribeAnalysisCommandInput; output: DescribeAnalysisCommandOutput; }; }; }