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

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 UpdateTemplateRequest data as a hash:

{
  aws_account_id: "AwsAccountId", # required
  template_id: "RestrictiveResourceId", # required
  source_entity: { # required
    source_analysis: {
      arn: "Arn", # required
      data_set_references: [ # required
        {
          data_set_placeholder: "NonEmptyString", # required
          data_set_arn: "Arn", # required
        },
      ],
    },
    source_template: {
      arn: "Arn", # required
    },
  },
  version_description: "VersionDescription",
  name: "TemplateName",
}

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#aws_account_idString

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

Returns:

  • (String)


8999
9000
9001
9002
9003
9004
9005
9006
9007
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/types.rb', line 8999

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

#nameString

The name for the template.

Returns:

  • (String)


8999
9000
9001
9002
9003
9004
9005
9006
9007
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/types.rb', line 8999

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

#source_entityTypes::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 AWS Account and any QuickSight-supported AWS 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.



8999
9000
9001
9002
9003
9004
9005
9006
9007
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/types.rb', line 8999

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

#template_idString

The ID for the template.

Returns:

  • (String)


8999
9000
9001
9002
9003
9004
9005
9006
9007
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/types.rb', line 8999

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

#version_descriptionString

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)


8999
9000
9001
9002
9003
9004
9005
9006
9007
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/types.rb', line 8999

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