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::CreateTemplateRequest

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

{
  aws_account_id: "AwsAccountId", # required
  template_id: "RestrictiveResourceId", # required
  name: "TemplateName",
  permissions: [
    {
      principal: "Principal", # required
      actions: ["String"], # 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
    },
  },
  tags: [
    {
      key: "TagKey", # required
      value: "TagValue", # required
    },
  ],
  version_description: "VersionDescription",
}

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#aws_account_idString

The ID for the Amazon Web Services account that the group is in. You use the ID for the Amazon Web Services account that contains your Amazon QuickSight account.

Returns:

  • (String)


2728
2729
2730
2731
2732
2733
2734
2735
2736
2737
2738
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/types.rb', line 2728

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

#nameString

A display name for the template.

Returns:

  • (String)


2728
2729
2730
2731
2732
2733
2734
2735
2736
2737
2738
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/types.rb', line 2728

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

#permissionsArray<Types::ResourcePermission>

A list of resource permissions to be set on the template.

Returns:



2728
2729
2730
2731
2732
2733
2734
2735
2736
2737
2738
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/types.rb', line 2728

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

#source_entityTypes::TemplateSourceEntity

The entity that you are using as a source when you create 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.



2728
2729
2730
2731
2732
2733
2734
2735
2736
2737
2738
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/types.rb', line 2728

class CreateTemplateRequest < Struct.new(
  :aws_account_id,
  :template_id,
  :name,
  :permissions,
  :source_entity,
  :tags,
  :version_description)
  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 resource.

Returns:



2728
2729
2730
2731
2732
2733
2734
2735
2736
2737
2738
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/types.rb', line 2728

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

#template_idString

An ID for the template that you want to create. This template is unique per Amazon Web Services Region; in each Amazon Web Services account.

Returns:

  • (String)


2728
2729
2730
2731
2732
2733
2734
2735
2736
2737
2738
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/types.rb', line 2728

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

#version_descriptionString

A description of the current template version being created. This API operation creates the first version of the template. Every time UpdateTemplate is called, a new version is created. Each version of the template maintains a description of the version in the VersionDescription field.

Returns:

  • (String)


2728
2729
2730
2731
2732
2733
2734
2735
2736
2737
2738
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/types.rb', line 2728

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