AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Class: Aws::QuickSight::Types::UpdateAnalysisRequest

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

Overview

Note:

When making an API call, you may pass UpdateAnalysisRequest data as a hash:

{
  aws_account_id: "AwsAccountId", # required
  analysis_id: "RestrictiveResourceId", # required
  name: "AnalysisName", # required
  parameters: {
    string_parameters: [
      {
        name: "NonEmptyString", # required
        values: ["String"], # required
      },
    ],
    integer_parameters: [
      {
        name: "NonEmptyString", # required
        values: [1], # required
      },
    ],
    decimal_parameters: [
      {
        name: "NonEmptyString", # required
        values: [1.0], # required
      },
    ],
    date_time_parameters: [
      {
        name: "NonEmptyString", # required
        values: [Time.now], # required
      },
    ],
  },
  source_entity: { # required
    source_template: {
      data_set_references: [ # required
        {
          data_set_placeholder: "NonEmptyString", # required
          data_set_arn: "Arn", # required
        },
      ],
      arn: "Arn", # required
    },
  },
  theme_arn: "Arn",
}

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#analysis_idString

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

Returns:

  • (String)


12861
12862
12863
12864
12865
12866
12867
12868
12869
12870
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/types.rb', line 12861

class UpdateAnalysisRequest < Struct.new(
  :aws_account_id,
  :analysis_id,
  :name,
  :parameters,
  :source_entity,
  :theme_arn)
  SENSITIVE = []
  include Aws::Structure
end

#aws_account_idString

The ID of the Amazon Web Services account that contains the analysis that you're updating.

Returns:

  • (String)


12861
12862
12863
12864
12865
12866
12867
12868
12869
12870
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/types.rb', line 12861

class UpdateAnalysisRequest < Struct.new(
  :aws_account_id,
  :analysis_id,
  :name,
  :parameters,
  :source_entity,
  :theme_arn)
  SENSITIVE = []
  include Aws::Structure
end

#nameString

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

Returns:

  • (String)


12861
12862
12863
12864
12865
12866
12867
12868
12869
12870
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/types.rb', line 12861

class UpdateAnalysisRequest < Struct.new(
  :aws_account_id,
  :analysis_id,
  :name,
  :parameters,
  :source_entity,
  :theme_arn)
  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:



12861
12862
12863
12864
12865
12866
12867
12868
12869
12870
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/types.rb', line 12861

class UpdateAnalysisRequest < Struct.new(
  :aws_account_id,
  :analysis_id,
  :name,
  :parameters,
  :source_entity,
  :theme_arn)
  SENSITIVE = []
  include Aws::Structure
end

#source_entityTypes::AnalysisSourceEntity

A source entity to use for the analysis that you're updating. This metadata structure contains details that describe a source template and one or more datasets.



12861
12862
12863
12864
12865
12866
12867
12868
12869
12870
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/types.rb', line 12861

class UpdateAnalysisRequest < Struct.new(
  :aws_account_id,
  :analysis_id,
  :name,
  :parameters,
  :source_entity,
  :theme_arn)
  SENSITIVE = []
  include Aws::Structure
end

#theme_arnString

The Amazon Resource Name (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)


12861
12862
12863
12864
12865
12866
12867
12868
12869
12870
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/types.rb', line 12861

class UpdateAnalysisRequest < Struct.new(
  :aws_account_id,
  :analysis_id,
  :name,
  :parameters,
  :source_entity,
  :theme_arn)
  SENSITIVE = []
  include Aws::Structure
end