quicksight/aws.sdk.kotlin.services.quicksight.model/CreateAnalysisRequest

CreateAnalysisRequest

class CreateAnalysisRequest

Types

object Companion

Properties

val analysisId: String?

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

val awsAccountId: String?

The ID of the Amazon Web Services account where you are creating an analysis.

val definition: AnalysisDefinition?

The definition of an analysis.

val folderArns: List<String>?

When you create the analysis, Amazon QuickSight adds the analysis to these folders.

val name: String?

A descriptive name for the analysis that you're creating. This name displays for the analysis in the Amazon QuickSight console.

val parameters: Parameters?

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.

val permissions: List<ResourcePermission>?

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 Identity and Access Management (IAM) action information for each principal listed by Amazon Resource Name (ARN).

val sourceEntity: AnalysisSourceEntity?

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.

val tags: List<Tag>?

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

val themeArn: String?

The ARN for the theme to apply to the analysis that you're creating. To see the theme in the Amazon QuickSight console, make sure that you have access to it.

validationStrategy

val validationStrategy: ValidationStrategy?

The option to relax the validation needed to create an analysis with definition objects. This skips the validation step for specific errors.

Functions

inline fun copy(block: CreateAnalysisRequest.Builder.() -> Unit = {}): CreateAnalysisRequest

open operator override fun equals(other: Any?): Boolean

open override fun hashCode(): Int

open override fun toString(): String