Class: Aws::QuickSight::Types::CreateAnalysisRequest

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/types.rb

Overview

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#analysis_idString

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

Returns:

  • (String)


5342
5343
5344
5345
5346
5347
5348
5349
5350
5351
5352
5353
5354
5355
5356
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/types.rb', line 5342

class CreateAnalysisRequest < Struct.new(
  :aws_account_id,
  :analysis_id,
  :name,
  :parameters,
  :permissions,
  :source_entity,
  :theme_arn,
  :tags,
  :definition,
  :validation_strategy,
  :folder_arns)
  SENSITIVE = []
  include Aws::Structure
end

#aws_account_idString

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

Returns:

  • (String)


5342
5343
5344
5345
5346
5347
5348
5349
5350
5351
5352
5353
5354
5355
5356
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/types.rb', line 5342

class CreateAnalysisRequest < Struct.new(
  :aws_account_id,
  :analysis_id,
  :name,
  :parameters,
  :permissions,
  :source_entity,
  :theme_arn,
  :tags,
  :definition,
  :validation_strategy,
  :folder_arns)
  SENSITIVE = []
  include Aws::Structure
end

#definitionTypes::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.



5342
5343
5344
5345
5346
5347
5348
5349
5350
5351
5352
5353
5354
5355
5356
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/types.rb', line 5342

class CreateAnalysisRequest < Struct.new(
  :aws_account_id,
  :analysis_id,
  :name,
  :parameters,
  :permissions,
  :source_entity,
  :theme_arn,
  :tags,
  :definition,
  :validation_strategy,
  :folder_arns)
  SENSITIVE = []
  include Aws::Structure
end

#folder_arnsArray<String>

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

Returns:

  • (Array<String>)


5342
5343
5344
5345
5346
5347
5348
5349
5350
5351
5352
5353
5354
5355
5356
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/types.rb', line 5342

class CreateAnalysisRequest < Struct.new(
  :aws_account_id,
  :analysis_id,
  :name,
  :parameters,
  :permissions,
  :source_entity,
  :theme_arn,
  :tags,
  :definition,
  :validation_strategy,
  :folder_arns)
  SENSITIVE = []
  include Aws::Structure
end

#nameString

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

Returns:

  • (String)


5342
5343
5344
5345
5346
5347
5348
5349
5350
5351
5352
5353
5354
5355
5356
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/types.rb', line 5342

class CreateAnalysisRequest < Struct.new(
  :aws_account_id,
  :analysis_id,
  :name,
  :parameters,
  :permissions,
  :source_entity,
  :theme_arn,
  :tags,
  :definition,
  :validation_strategy,
  :folder_arns)
  SENSITIVE = []
  include Aws::Structure
end

#parametersTypes::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.

Returns:



5342
5343
5344
5345
5346
5347
5348
5349
5350
5351
5352
5353
5354
5355
5356
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/types.rb', line 5342

class CreateAnalysisRequest < Struct.new(
  :aws_account_id,
  :analysis_id,
  :name,
  :parameters,
  :permissions,
  :source_entity,
  :theme_arn,
  :tags,
  :definition,
  :validation_strategy,
  :folder_arns)
  SENSITIVE = []
  include Aws::Structure
end

#permissionsArray<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.

Returns:



5342
5343
5344
5345
5346
5347
5348
5349
5350
5351
5352
5353
5354
5355
5356
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/types.rb', line 5342

class CreateAnalysisRequest < Struct.new(
  :aws_account_id,
  :analysis_id,
  :name,
  :parameters,
  :permissions,
  :source_entity,
  :theme_arn,
  :tags,
  :definition,
  :validation_strategy,
  :folder_arns)
  SENSITIVE = []
  include Aws::Structure
end

#source_entityTypes::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.



5342
5343
5344
5345
5346
5347
5348
5349
5350
5351
5352
5353
5354
5355
5356
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/types.rb', line 5342

class CreateAnalysisRequest < Struct.new(
  :aws_account_id,
  :analysis_id,
  :name,
  :parameters,
  :permissions,
  :source_entity,
  :theme_arn,
  :tags,
  :definition,
  :validation_strategy,
  :folder_arns)
  SENSITIVE = []
  include Aws::Structure
end

#tagsArray<Types::Tag>

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

Returns:



5342
5343
5344
5345
5346
5347
5348
5349
5350
5351
5352
5353
5354
5355
5356
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/types.rb', line 5342

class CreateAnalysisRequest < Struct.new(
  :aws_account_id,
  :analysis_id,
  :name,
  :parameters,
  :permissions,
  :source_entity,
  :theme_arn,
  :tags,
  :definition,
  :validation_strategy,
  :folder_arns)
  SENSITIVE = []
  include Aws::Structure
end

#theme_arnString

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.

Returns:

  • (String)


5342
5343
5344
5345
5346
5347
5348
5349
5350
5351
5352
5353
5354
5355
5356
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/types.rb', line 5342

class CreateAnalysisRequest < Struct.new(
  :aws_account_id,
  :analysis_id,
  :name,
  :parameters,
  :permissions,
  :source_entity,
  :theme_arn,
  :tags,
  :definition,
  :validation_strategy,
  :folder_arns)
  SENSITIVE = []
  include Aws::Structure
end

#validation_strategyTypes::ValidationStrategy

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



5342
5343
5344
5345
5346
5347
5348
5349
5350
5351
5352
5353
5354
5355
5356
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/types.rb', line 5342

class CreateAnalysisRequest < Struct.new(
  :aws_account_id,
  :analysis_id,
  :name,
  :parameters,
  :permissions,
  :source_entity,
  :theme_arn,
  :tags,
  :definition,
  :validation_strategy,
  :folder_arns)
  SENSITIVE = []
  include Aws::Structure
end