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

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

{
  aws_account_id: "AwsAccountId", # required
  template_id: "RestrictiveResourceId", # required
  version_number: 1,
  alias_name: "AliasName",
}

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#alias_nameString

The alias of the template that you want to describe. If you name a specific alias, you describe the version that the alias points to. You can specify the latest version of the template by providing the keyword $LATEST in the AliasName parameter. The keyword $PUBLISHED doesn't apply to templates.

Returns:

  • (String)


6424
6425
6426
6427
6428
6429
6430
6431
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/types.rb', line 6424

class DescribeTemplateRequest < Struct.new(
  :aws_account_id,
  :template_id,
  :version_number,
  :alias_name)
  SENSITIVE = []
  include Aws::Structure
end

#aws_account_idString

The ID of the Amazon Web Services account that contains the template that you're describing.

Returns:

  • (String)


6424
6425
6426
6427
6428
6429
6430
6431
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/types.rb', line 6424

class DescribeTemplateRequest < Struct.new(
  :aws_account_id,
  :template_id,
  :version_number,
  :alias_name)
  SENSITIVE = []
  include Aws::Structure
end

#template_idString

The ID for the template.

Returns:

  • (String)


6424
6425
6426
6427
6428
6429
6430
6431
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/types.rb', line 6424

class DescribeTemplateRequest < Struct.new(
  :aws_account_id,
  :template_id,
  :version_number,
  :alias_name)
  SENSITIVE = []
  include Aws::Structure
end

#version_numberInteger

(Optional) The number for the version to describe. If a VersionNumber parameter value isn't provided, the latest version of the template is described.

Returns:

  • (Integer)


6424
6425
6426
6427
6428
6429
6430
6431
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/types.rb', line 6424

class DescribeTemplateRequest < Struct.new(
  :aws_account_id,
  :template_id,
  :version_number,
  :alias_name)
  SENSITIVE = []
  include Aws::Structure
end