/* 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 DashboardUIState = "EXPANDED" | "COLLAPSED";
export type DashboardBehavior = "ENABLED" | "DISABLED";
export type ResourceStatus =
  | "CREATION_IN_PROGRESS"
  | "CREATION_SUCCESSFUL"
  | "CREATION_FAILED"
  | "UPDATE_IN_PROGRESS"
  | "UPDATE_SUCCESSFUL"
  | "UPDATE_FAILED"
  | "DELETED";
export type DashboardErrorType =
  | "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";

/**
 * Definition of the AWS::QuickSight::Dashboard Resource Type.
 */
export interface AwsQuicksightDashboard {
  /**
   * <p>The Amazon Resource Name (ARN) of the resource.</p>
   */
  Arn?: string;
  AwsAccountId: string;
  /**
   * <p>The time that this dataset was created.</p>
   */
  CreatedTime?: string;
  DashboardId: string;
  DashboardPublishOptions?: DashboardPublishOptions;
  /**
   * <p>The last time that this dataset was published.</p>
   */
  LastPublishedTime?: string;
  /**
   * <p>The last time that this dataset was updated.</p>
   */
  LastUpdatedTime?: string;
  /**
   * <p>The display name of the dashboard.</p>
   */
  Name?: string;
  Parameters?: Parameters;
  /**
   * <p>A structure that contains the permissions of the dashboard. You can use this structure
   *             for granting permissions by providing a list of IAM action information for each
   *             principal ARN. </p>
   *
   *         <p>To specify no permissions, omit the permissions list.</p>
   *
   * @minItems 1
   * @maxItems 64
   */
  Permissions?: [ResourcePermission, ...ResourcePermission[]];
  SourceEntity: DashboardSourceEntity;
  /**
   * <p>Contains a map of the key-value pairs for the resource tag or tags assigned to the
   *             dashboard.</p>
   *
   * @minItems 1
   * @maxItems 200
   */
  Tags?: [Tag, ...Tag[]];
  /**
   * <p>The Amazon Resource Name (ARN) of the theme that is being used for this dashboard. If
   *             you add a value for this field, it overrides the value that is used in the source
   *             entity. The theme ARN must exist in the same AWS account where you create the
   *             dashboard.</p>
   */
  ThemeArn?: string;
  Version?: DashboardVersion;
  /**
   * <p>A description for the first version of the dashboard being created.</p>
   */
  VersionDescription?: string;
}
/**
 * <p>Dashboard publish options.</p>
 */
export interface DashboardPublishOptions {
  SheetControlsOption?: SheetControlsOption;
  ExportToCSVOption?: ExportToCSVOption;
  AdHocFilteringOption?: AdHocFilteringOption;
}
/**
 * <p>Sheet controls option.</p>
 */
export interface SheetControlsOption {
  VisibilityState?: DashboardUIState;
}
/**
 * <p>Export to .csv option.</p>
 */
export interface ExportToCSVOption {
  AvailabilityStatus?: DashboardBehavior;
}
/**
 * <p>Ad hoc (one-time) filtering option.</p>
 */
export interface AdHocFilteringOption {
  AvailabilityStatus?: DashboardBehavior;
}
/**
 * <p>A list of QuickSight parameters and the list's override values.</p>
 */
export interface Parameters {
  /**
   * <p>String parameters.</p>
   *
   * @minItems 0
   * @maxItems 100
   */
  StringParameters?: StringParameter[];
  /**
   * <p>Decimal parameters.</p>
   *
   * @minItems 0
   * @maxItems 100
   */
  DecimalParameters?: DecimalParameter[];
  /**
   * <p>Integer parameters.</p>
   *
   * @minItems 0
   * @maxItems 100
   */
  IntegerParameters?: IntegerParameter[];
  /**
   * <p>Date-time parameters.</p>
   *
   * @minItems 0
   * @maxItems 100
   */
  DateTimeParameters?: DateTimeParameter[];
}
/**
 * <p>A string parameter.</p>
 */
export interface StringParameter {
  /**
   * <p>The values of a string parameter.</p>
   */
  Values: string[];
  /**
   * <p>A display name for a string parameter.</p>
   */
  Name: string;
}
/**
 * <p>A decimal parameter.</p>
 */
export interface DecimalParameter {
  /**
   * <p>The values for the decimal parameter.</p>
   */
  Values: number[];
  /**
   * <p>A display name for the decimal parameter.</p>
   */
  Name: string;
}
/**
 * <p>An integer parameter.</p>
 */
export interface IntegerParameter {
  /**
   * <p>The values for the integer parameter.</p>
   */
  Values: number[];
  /**
   * <p>The name of the integer parameter.</p>
   */
  Name: string;
}
/**
 * <p>A date-time parameter.</p>
 */
export interface DateTimeParameter {
  /**
   * <p>The values for the date-time parameter.</p>
   */
  Values: string[];
  /**
   * <p>A display name for the date-time parameter.</p>
   */
  Name: string;
}
/**
 * <p>Permission for the resource.</p>
 */
export interface ResourcePermission {
  /**
   * <p>The IAM action to grant or revoke permissions on.</p>
   *
   * @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
      ];
  /**
   * <p>The Amazon Resource Name (ARN) of the principal. This can be one of the
   *             following:</p>
   *         <ul>
   *             <li>
   *                 <p>The ARN of an Amazon QuickSight user or group associated with a data source or dataset. (This is common.)</p>
   *             </li>
   *             <li>
   *                 <p>The ARN of an Amazon QuickSight user, group, or namespace associated with an analysis, dashboard, template, or theme. (This is common.)</p>
   *             </li>
   *             <li>
   *                 <p>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.) </p>
   *             </li>
   *          </ul>
   */
  Principal: string;
}
/**
 * <p>Dashboard source entity.</p>
 */
export interface DashboardSourceEntity {
  SourceTemplate?: DashboardSourceTemplate;
}
/**
 * <p>Dashboard source template.</p>
 */
export interface DashboardSourceTemplate {
  /**
   * <p>Dataset references.</p>
   *
   * @minItems 1
   */
  DataSetReferences: [DataSetReference, ...DataSetReference[]];
  /**
   * <p>The Amazon Resource Name (ARN) of the resource.</p>
   */
  Arn: string;
}
/**
 * <p>Dataset reference.</p>
 */
export interface DataSetReference {
  /**
   * <p>Dataset Amazon Resource Name (ARN).</p>
   */
  DataSetArn: string;
  /**
   * <p>Dataset placeholder.</p>
   */
  DataSetPlaceholder: string;
}
/**
 * <p>The key or keys of the key-value pairs for the resource tag or tags assigned to the
 *             resource.</p>
 */
export interface Tag {
  /**
   * <p>Tag value.</p>
   */
  Value: string;
  /**
   * <p>Tag key.</p>
   */
  Key: string;
}
/**
 * <p>Dashboard version.</p>
 */
export interface DashboardVersion {
  Status?: ResourceStatus;
  /**
   * <p>Errors associated with this dashboard version.</p>
   *
   * @minItems 1
   */
  Errors?: [DashboardError, ...DashboardError[]];
  /**
   * <p>The time that this dashboard version was created.</p>
   */
  CreatedTime?: string;
  /**
   * <p>Description.</p>
   */
  Description?: string;
  /**
   * <p>The Amazon Resource Numbers (ARNs) for the datasets that are associated with this
   *             version of the dashboard.</p>
   *
   * @minItems 0
   * @maxItems 100
   */
  DataSetArns?: string[];
  /**
   * <p>The ARN of the theme associated with a version of the dashboard.</p>
   */
  ThemeArn?: string;
  /**
   * <p>The Amazon Resource Name (ARN) of the resource.</p>
   */
  Arn?: string;
  /**
   * <p>Source entity ARN.</p>
   */
  SourceEntityArn?: string;
  /**
   * <p>Version number for this version of the dashboard.</p>
   */
  VersionNumber?: number;
  /**
   * <p>A list of the associated sheets with the unique identifier and name of each sheet.</p>
   *
   * @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
      ];
}
/**
 * <p>Dashboard error.</p>
 */
export interface DashboardError {
  Type?: DashboardErrorType;
  /**
   * <p>Message.</p>
   */
  Message?: string;
}
/**
 * <p>A <i>sheet</i>, 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.</p>
 */
export interface Sheet {
  /**
   * <p>The unique identifier associated with a sheet.</p>
   */
  SheetId?: string;
  /**
   * <p>The name of a sheet. This name is displayed on the sheet's tab in the QuickSight
   *             console.</p>
   */
  Name?: string;
}