paws.analytics (version 0.7.0)

quicksight_create_analysis: Creates an analysis in Amazon QuickSight

Description

Creates an analysis in Amazon QuickSight. Analyses can be created either from a template or from an AnalysisDefinition.

See https://www.paws-r-sdk.com/docs/quicksight_create_analysis/ for full documentation.

Usage

quicksight_create_analysis(
  AwsAccountId,
  AnalysisId,
  Name,
  Parameters = NULL,
  Permissions = NULL,
  SourceEntity = NULL,
  ThemeArn = NULL,
  Tags = NULL,
  Definition = NULL,
  ValidationStrategy = NULL,
  FolderArns = NULL
)

Arguments

AwsAccountId

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

AnalysisId

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

Name

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

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.

Permissions

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).

To specify no permissions, omit Permissions.

SourceEntity

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.

ThemeArn

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.

Tags

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

Definition

The definition of an analysis.

A definition is the data model of all features in a Dashboard, Template, or Analysis.

Either a SourceEntity or a Definition must be provided in order for the request to be valid.

ValidationStrategy

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

FolderArns

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