You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

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

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing UpdateAnalysisRequest as input to an Aws::Client method, you can use a vanilla 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",
}

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#analysis_id ⇒ String

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

Returns:

  • (String) —

    The ID for the analysis that you\'re updating.

#aws_account_id ⇒ String

The ID of the AWS account that contains the analysis that you\'re updating.

Returns:

  • (String) —

    The ID of the AWS account that contains the analysis that you\'re updating.

#name ⇒ String

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

Returns:

  • (String) —

    A descriptive name for the analysis that you\'re updating.

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

Returns:

  • (Types::Parameters) —

    The parameter names and override values that you want to use.

#source_entity ⇒ Types::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.

Returns:

#theme_arn ⇒ String

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

Returns:

  • (String) —

    The Amazon Resource Name (ARN) for the theme to apply to the analysis that you\'re creating.