AnalysisArgs

data class AnalysisArgs(val analysisId: Output<String>? = null, val awsAccountId: Output<String>? = null, val definition: Output<AnalysisDefinitionArgs>? = null, val errors: Output<List<AnalysisErrorArgs>>? = null, val name: Output<String>? = null, val parameters: Output<AnalysisParametersArgs>? = null, val permissions: Output<List<AnalysisResourcePermissionArgs>>? = null, val sheets: Output<List<AnalysisSheetArgs>>? = null, val sourceEntity: Output<AnalysisSourceEntityArgs>? = null, val status: Output<AnalysisResourceStatus>? = null, val tags: Output<List<TagArgs>>? = null, val themeArn: Output<String>? = null, val validationStrategy: Output<AnalysisValidationStrategyArgs>? = null) : ConvertibleToJava<AnalysisArgs>

Definition of the AWS::QuickSight::Analysis Resource Type.

Constructors

Link copied to clipboard
constructor(analysisId: Output<String>? = null, awsAccountId: Output<String>? = null, definition: Output<AnalysisDefinitionArgs>? = null, errors: Output<List<AnalysisErrorArgs>>? = null, name: Output<String>? = null, parameters: Output<AnalysisParametersArgs>? = null, permissions: Output<List<AnalysisResourcePermissionArgs>>? = null, sheets: Output<List<AnalysisSheetArgs>>? = null, sourceEntity: Output<AnalysisSourceEntityArgs>? = null, status: Output<AnalysisResourceStatus>? = null, tags: Output<List<TagArgs>>? = null, themeArn: Output<String>? = null, validationStrategy: Output<AnalysisValidationStrategyArgs>? = null)

Properties

Link copied to clipboard
val analysisId: Output<String>? = null

The ID for the analysis that you're creating. This ID displays in the URL of the analysis.

Link copied to clipboard
val awsAccountId: Output<String>? = null

The ID of the AWS account where you are creating an analysis.

Link copied to clipboard
val definition: Output<AnalysisDefinitionArgs>? = null
Link copied to clipboard
val errors: Output<List<AnalysisErrorArgs>>? = null

Errors associated with the analysis.

Link copied to clipboard
val name: Output<String>? = null

The descriptive name of the analysis.

Link copied to clipboard
val parameters: Output<AnalysisParametersArgs>? = null

The parameter names and override values that you want to use. An analysis can have any parameter type, and some parameters might accept multiple values.

Link copied to clipboard

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 .

Link copied to clipboard
val sheets: Output<List<AnalysisSheetArgs>>? = null

A list of the associated sheets with the unique identifier and name of each sheet.

Link copied to clipboard

A source entity to use for the analysis that you're creating. This metadata structure contains details that describe a source template and one or more datasets. Either a SourceEntity or a Definition must be provided in order for the request to be valid.

Link copied to clipboard
val status: Output<AnalysisResourceStatus>? = null

Status associated with the analysis.

Link copied to clipboard
val tags: Output<List<TagArgs>>? = null

Contains a map of the key-value pairs for the resource tag or tags assigned to the analysis.

Link copied to clipboard
val themeArn: Output<String>? = null

The ARN of the theme of the analysis.

Link copied to clipboard

The option to relax the validation that is required to create and update analyses, dashboards, and templates with definition objects. When you set this value to LENIENT , validation is skipped for specific errors.

Functions

Link copied to clipboard
open override fun toJava(): AnalysisArgs