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

Class: Aws::QuickSight::Types::CreateTemplateRequest

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

Overview

Note:

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

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#aws_account_id ⇒ String

The ID for the AWS account that the group is in. Currently, you use the ID for the AWS account that contains your Amazon QuickSight account.

Returns:

  • (String) —

    The ID for the AWS account that the group is in.

#name ⇒ String

A display name for the template.

Returns:

  • (String) —

    A display name for the template.

#permissions ⇒ Array<Types::ResourcePermission>

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

Returns:

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

Returns:

#tags ⇒ Array<Types::Tag>

Contains a map of the key-value pairs for the resource tag or tags assigned to the resource.

Returns:

  • (Array<Types::Tag>) —

    Contains a map of the key-value pairs for the resource tag or tags assigned to the resource.

#template_id ⇒ String

An ID for the template that you want to create. This template is unique per AWS Region in each AWS account.

Returns:

  • (String) —

    An ID for the template that you want to create.

#version_description ⇒ String

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) —

    A description of the current template version being created.