Method: Aws::QuickSight::Client#create_analysis

Defined in:

lib/aws-sdk-quicksight/client.rb

#create_analysis(params = {}) ⇒ Types::CreateAnalysisResponse

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

Examples:

Response structure

resp.arn #=> String
resp.analysis_id #=> String
resp.creation_status #=> String, one of "CREATION_IN_PROGRESS", "CREATION_SUCCESSFUL", "CREATION_FAILED", "UPDATE_IN_PROGRESS", "UPDATE_SUCCESSFUL", "UPDATE_FAILED", "DELETED"
resp.status #=> Integer
resp.request_id #=> String

Parameters:

• params (Hash) (defaults to: {}) —

  ({})

Options Hash (params):

• :aws_account_id (required, String) —

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

• :analysis_id (required, String) —

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

• :name (required, String) —

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

• :parameters (Types::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 (Array<Types::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).

  To specify no permissions, omit ‘Permissions`.

• :source_entity (Types::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.

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

• :theme_arn (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.

• :tags (Array<Types::Tag>) —

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

• :definition (Types::AnalysisDefinition) —

  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.

• :validation_strategy (Types::ValidationStrategy) —

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

• :folder_arns (Array<String>) —

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

Returns:

• (Types::CreateAnalysisResponse) —

  Returns a response object which responds to the following methods:

  • #arn => String

  • #analysis_id => String

  • #creation_status => String

  • #status => Integer

  • #request_id => String

See Also:

• AWS API Documentation

# File 'lib/aws-sdk-quicksight/client.rb', line 1827

def create_analysis(params = {}, options = {})
  req = build_request(:create_analysis, params)
  req.send_request(options)
end