Class: Aws::QuickSight::Types::UpdateTemplateRequest

Inherits:

Struct

• Object
• Struct
• Aws::QuickSight::Types::UpdateTemplateRequest

Includes:

Structure

Defined in:

lib/aws-sdk-quicksight/types.rb

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #aws_account_id ⇒ String

  The ID of the Amazon Web Services account that contains the template that you’re updating.

• #definition ⇒ Types::TemplateVersionDefinition

  The definition of a template.

• #name ⇒ String

  The name for the template.

• #source_entity ⇒ Types::TemplateSourceEntity

  The entity that you are using as a source when you update the template.

• #template_id ⇒ String

  The ID for the template.

• #validation_strategy ⇒ Types::ValidationStrategy

  The option to relax the validation needed to update a template with definition objects.

• #version_description ⇒ String

  A description of the current template version that is being updated.

Instance Attribute Details

#aws_account_id ⇒ String

The ID of the Amazon Web Services account that contains the template that you’re updating.

Returns:

• (String)

# File 'lib/aws-sdk-quicksight/types.rb', line 37682

class UpdateTemplateRequest < Struct.new(
  :aws_account_id,
  :template_id,
  :source_entity,
  :version_description,
  :name,
  :definition,
  :validation_strategy)
  SENSITIVE = []
  include Aws::Structure
end

#definition ⇒ Types::TemplateVersionDefinition

The definition of a template.

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

Returns:

• (Types::TemplateVersionDefinition)

# File 'lib/aws-sdk-quicksight/types.rb', line 37682

class UpdateTemplateRequest < Struct.new(
  :aws_account_id,
  :template_id,
  :source_entity,
  :version_description,
  :name,
  :definition,
  :validation_strategy)
  SENSITIVE = []
  include Aws::Structure
end

#name ⇒ String

The name for the template.

Returns:

• (String)

# File 'lib/aws-sdk-quicksight/types.rb', line 37682

class UpdateTemplateRequest < Struct.new(
  :aws_account_id,
  :template_id,
  :source_entity,
  :version_description,
  :name,
  :definition,
  :validation_strategy)
  SENSITIVE = []
  include Aws::Structure
end

#source_entity ⇒ Types::TemplateSourceEntity

The entity that you are using as a source when you update the template. In ‘SourceEntity`, you specify the type of object you’re using as source: ‘SourceTemplate` for a template or `SourceAnalysis` for an analysis. Both of these require an Amazon Resource Name (ARN). For `SourceTemplate`, specify the ARN of the source template. For `SourceAnalysis`, specify the ARN of the source analysis. The `SourceTemplate` ARN can contain any Amazon Web Services account and any Amazon QuickSight-supported Amazon Web Services Region;.

Use the ‘DataSetReferences` entity within `SourceTemplate` or `SourceAnalysis` to list the replacement datasets for the placeholders listed in the original. The schema in each dataset must match its placeholder.

Returns:

• (Types::TemplateSourceEntity)

# File 'lib/aws-sdk-quicksight/types.rb', line 37682

class UpdateTemplateRequest < Struct.new(
  :aws_account_id,
  :template_id,
  :source_entity,
  :version_description,
  :name,
  :definition,
  :validation_strategy)
  SENSITIVE = []
  include Aws::Structure
end

#template_id ⇒ String

The ID for the template.

Returns:

• (String)

# File 'lib/aws-sdk-quicksight/types.rb', line 37682

class UpdateTemplateRequest < Struct.new(
  :aws_account_id,
  :template_id,
  :source_entity,
  :version_description,
  :name,
  :definition,
  :validation_strategy)
  SENSITIVE = []
  include Aws::Structure
end

#validation_strategy ⇒ Types::ValidationStrategy

The option to relax the validation needed to update a template with definition objects. This skips the validation step for specific errors.

Returns:

• (Types::ValidationStrategy)

# File 'lib/aws-sdk-quicksight/types.rb', line 37682

class UpdateTemplateRequest < Struct.new(
  :aws_account_id,
  :template_id,
  :source_entity,
  :version_description,
  :name,
  :definition,
  :validation_strategy)
  SENSITIVE = []
  include Aws::Structure
end

#version_description ⇒ String

A description of the current template version that is being updated. Every time you call ‘UpdateTemplate`, you create a new version of the template. Each version of the template maintains a description of the version in the `VersionDescription` field.

Returns:

• (String)

# File 'lib/aws-sdk-quicksight/types.rb', line 37682

class UpdateTemplateRequest < Struct.new(
  :aws_account_id,
  :template_id,
  :source_entity,
  :version_description,
  :name,
  :definition,
  :validation_strategy)
  SENSITIVE = []
  include Aws::Structure
end