/* eslint-disable */ /** * This file was automatically generated by json-schema-to-typescript. * DO NOT MODIFY IT BY HAND. Instead, modify the source JSONSchema file, * and run json-schema-to-typescript to regenerate this file. */ export type AnalysisErrorType = | "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"; export type ResourceStatus = | "CREATION_IN_PROGRESS" | "CREATION_SUCCESSFUL" | "CREATION_FAILED" | "UPDATE_IN_PROGRESS" | "UPDATE_SUCCESSFUL" | "UPDATE_FAILED" | "DELETED"; /** * Definition of the AWS::QuickSight::Analysis Resource Type. */ export interface AwsQuicksightAnalysis { AnalysisId: string; /** *
The Amazon Resource Name (ARN) of the analysis.
*/ Arn?: string; AwsAccountId: string; /** *The time that the analysis was created.
*/ CreatedTime?: string; /** *The ARNs of the datasets of the analysis.
* * @minItems 0 * @maxItems 100 */ DataSetArns?: string[]; /** *Errors associated with the analysis.
* * @minItems 1 */ Errors?: [AnalysisError, ...AnalysisError[]]; /** *The time that the analysis was last updated.
*/ LastUpdatedTime?: string; /** *The descriptive name of the analysis.
*/ Name?: string; Parameters?: Parameters; /** *A structure that describes the principals and the resource-level permissions on an
* analysis. You can use the Permissions structure to grant permissions by
* providing a list of AWS Identity and Access Management (IAM) action information for each
* principal listed by Amazon Resource Name (ARN).
To specify no permissions, omit Permissions.
A list of the associated sheets with the unique identifier and name of each sheet.
* * @minItems 0 * @maxItems 20 */ Sheets?: | [] | [Sheet] | [Sheet, Sheet] | [Sheet, Sheet, Sheet] | [Sheet, Sheet, Sheet, Sheet] | [Sheet, Sheet, Sheet, Sheet, Sheet] | [Sheet, Sheet, Sheet, Sheet, Sheet, Sheet] | [Sheet, Sheet, Sheet, Sheet, Sheet, Sheet, Sheet] | [Sheet, Sheet, Sheet, Sheet, Sheet, Sheet, Sheet, Sheet] | [Sheet, Sheet, Sheet, Sheet, Sheet, Sheet, Sheet, Sheet, Sheet] | [Sheet, Sheet, Sheet, Sheet, Sheet, Sheet, Sheet, Sheet, Sheet, Sheet] | [Sheet, Sheet, Sheet, Sheet, Sheet, Sheet, Sheet, Sheet, Sheet, Sheet, Sheet] | [Sheet, Sheet, Sheet, Sheet, Sheet, Sheet, Sheet, Sheet, Sheet, Sheet, Sheet, Sheet] | [Sheet, Sheet, Sheet, Sheet, Sheet, Sheet, Sheet, Sheet, Sheet, Sheet, Sheet, Sheet, Sheet] | [Sheet, Sheet, Sheet, Sheet, Sheet, Sheet, Sheet, Sheet, Sheet, Sheet, Sheet, Sheet, Sheet, Sheet] | [Sheet, Sheet, Sheet, Sheet, Sheet, Sheet, Sheet, Sheet, Sheet, Sheet, Sheet, Sheet, Sheet, Sheet, Sheet] | [Sheet, Sheet, Sheet, Sheet, Sheet, Sheet, Sheet, Sheet, Sheet, Sheet, Sheet, Sheet, Sheet, Sheet, Sheet, Sheet] | [ Sheet, Sheet, Sheet, Sheet, Sheet, Sheet, Sheet, Sheet, Sheet, Sheet, Sheet, Sheet, Sheet, Sheet, Sheet, Sheet, Sheet ] | [ Sheet, Sheet, Sheet, Sheet, Sheet, Sheet, Sheet, Sheet, Sheet, Sheet, Sheet, Sheet, Sheet, Sheet, Sheet, Sheet, Sheet, Sheet ] | [ Sheet, Sheet, Sheet, Sheet, Sheet, Sheet, Sheet, Sheet, Sheet, Sheet, Sheet, Sheet, Sheet, Sheet, Sheet, Sheet, Sheet, Sheet, Sheet ] | [ Sheet, Sheet, Sheet, Sheet, Sheet, Sheet, Sheet, Sheet, Sheet, Sheet, Sheet, Sheet, Sheet, Sheet, Sheet, Sheet, Sheet, Sheet, Sheet, Sheet ]; SourceEntity: AnalysisSourceEntity; Status?: ResourceStatus; /** *Contains a map of the key-value pairs for the resource tag or tags assigned to the * analysis.
* * @minItems 1 * @maxItems 200 */ Tags?: [Tag, ...Tag[]]; /** *The ARN of the theme of the analysis.
*/ ThemeArn?: string; } /** *A metadata error structure for an analysis.
*/ export interface AnalysisError { Type?: AnalysisErrorType; /** *The message associated with the analysis error.
*/ Message?: string; } /** *A list of QuickSight parameters and the list's override values.
*/ export interface Parameters { /** *String parameters.
* * @minItems 0 * @maxItems 100 */ StringParameters?: StringParameter[]; /** *Decimal parameters.
* * @minItems 0 * @maxItems 100 */ DecimalParameters?: DecimalParameter[]; /** *Integer parameters.
* * @minItems 0 * @maxItems 100 */ IntegerParameters?: IntegerParameter[]; /** *Date-time parameters.
* * @minItems 0 * @maxItems 100 */ DateTimeParameters?: DateTimeParameter[]; } /** *A string parameter.
*/ export interface StringParameter { /** *The values of a string parameter.
*/ Values: string[]; /** *A display name for a string parameter.
*/ Name: string; } /** *A decimal parameter.
*/ export interface DecimalParameter { /** *The values for the decimal parameter.
*/ Values: number[]; /** *A display name for the decimal parameter.
*/ Name: string; } /** *An integer parameter.
*/ export interface IntegerParameter { /** *The values for the integer parameter.
*/ Values: number[]; /** *The name of the integer parameter.
*/ Name: string; } /** *A date-time parameter.
*/ export interface DateTimeParameter { /** *The values for the date-time parameter.
*/ Values: string[]; /** *A display name for the date-time parameter.
*/ Name: string; } /** *Permission for the resource.
*/ export interface ResourcePermission { /** *The IAM action to grant or revoke permissions on.
* * @minItems 1 * @maxItems 16 */ Actions: | [string] | [string, string] | [string, string, string] | [string, string, string, string] | [string, string, string, string, string] | [string, string, string, string, string, string] | [string, string, string, string, string, string, string] | [string, string, string, string, string, string, string, string] | [string, string, string, string, string, string, string, string, string] | [string, string, string, string, string, string, string, string, string, string] | [string, string, string, string, string, string, string, string, string, string, string] | [string, string, string, string, string, string, string, string, string, string, string, string] | [string, string, string, string, string, string, string, string, string, string, string, string, string] | [string, string, string, string, string, string, string, string, string, string, string, string, string, string] | [ string, string, string, string, string, string, string, string, string, string, string, string, string, string, string ] | [ string, string, string, string, string, string, string, string, string, string, string, string, string, string, string, string ]; /** *The Amazon Resource Name (ARN) of the principal. This can be one of the * following:
*The ARN of an Amazon QuickSight user or group associated with a data source or dataset. (This is common.)
*The ARN of an Amazon QuickSight user, group, or namespace associated with an analysis, dashboard, template, or theme. (This is common.)
*The ARN of an AWS account root: This is an IAM ARN rather than a QuickSight * ARN. Use this option only to share resources (templates) across AWS accounts. * (This is less common.)
*A sheet, which is an object that contains a set of visuals that * are viewed together on one page in the Amazon QuickSight console. Every analysis and dashboard * contains at least one sheet. Each sheet contains at least one visualization widget, for * example a chart, pivot table, or narrative insight. Sheets can be associated with other * components, such as controls, filters, and so on.
*/ export interface Sheet { /** *The unique identifier associated with a sheet.
*/ SheetId?: string; /** *The name of a sheet. This name is displayed on the sheet's tab in the QuickSight * console.
*/ Name?: string; } /** *The source entity of an analysis.
*/ export interface AnalysisSourceEntity { SourceTemplate?: AnalysisSourceTemplate; } /** *The source template of an analysis.
*/ export interface AnalysisSourceTemplate { /** *The dataset references of the source template of an analysis.
* * @minItems 1 */ DataSetReferences: [DataSetReference, ...DataSetReference[]]; /** *The Amazon Resource Name (ARN) of the source template of an analysis.
*/ Arn: string; } /** *Dataset reference.
*/ export interface DataSetReference { /** *Dataset Amazon Resource Name (ARN).
*/ DataSetArn: string; /** *Dataset placeholder.
*/ DataSetPlaceholder: string; } /** *The key or keys of the key-value pairs for the resource tag or tags assigned to the * resource.
*/ export interface Tag { /** *Tag value.
*/ Value: string; /** *Tag key.
*/ Key: string; }