1. Packages
  2. AWS Cloud Control
  3. API Docs
  4. quicksight
  5. getTemplate

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.27.0 published on Monday, Apr 14, 2025 by Pulumi

aws-native.quicksight.getTemplate

Explore with Pulumi AI

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.27.0 published on Monday, Apr 14, 2025 by Pulumi

Definition of the AWS::QuickSight::Template Resource Type.

Using getTemplate

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getTemplate(args: GetTemplateArgs, opts?: InvokeOptions): Promise<GetTemplateResult>
function getTemplateOutput(args: GetTemplateOutputArgs, opts?: InvokeOptions): Output<GetTemplateResult>
Copy
def get_template(aws_account_id: Optional[str] = None,
                 template_id: Optional[str] = None,
                 opts: Optional[InvokeOptions] = None) -> GetTemplateResult
def get_template_output(aws_account_id: Optional[pulumi.Input[str]] = None,
                 template_id: Optional[pulumi.Input[str]] = None,
                 opts: Optional[InvokeOptions] = None) -> Output[GetTemplateResult]
Copy
func LookupTemplate(ctx *Context, args *LookupTemplateArgs, opts ...InvokeOption) (*LookupTemplateResult, error)
func LookupTemplateOutput(ctx *Context, args *LookupTemplateOutputArgs, opts ...InvokeOption) LookupTemplateResultOutput
Copy

> Note: This function is named LookupTemplate in the Go SDK.

public static class GetTemplate 
{
    public static Task<GetTemplateResult> InvokeAsync(GetTemplateArgs args, InvokeOptions? opts = null)
    public static Output<GetTemplateResult> Invoke(GetTemplateInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetTemplateResult> getTemplate(GetTemplateArgs args, InvokeOptions options)
public static Output<GetTemplateResult> getTemplate(GetTemplateArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: aws-native:quicksight:getTemplate
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

AwsAccountId This property is required. string
The ID for the AWS account that the group is in. You use the ID for the AWS account that contains your Amazon QuickSight account.
TemplateId This property is required. string
An ID for the template that you want to create. This template is unique per AWS Region ; in each AWS account.
AwsAccountId This property is required. string
The ID for the AWS account that the group is in. You use the ID for the AWS account that contains your Amazon QuickSight account.
TemplateId This property is required. string
An ID for the template that you want to create. This template is unique per AWS Region ; in each AWS account.
awsAccountId This property is required. String
The ID for the AWS account that the group is in. You use the ID for the AWS account that contains your Amazon QuickSight account.
templateId This property is required. String
An ID for the template that you want to create. This template is unique per AWS Region ; in each AWS account.
awsAccountId This property is required. string
The ID for the AWS account that the group is in. You use the ID for the AWS account that contains your Amazon QuickSight account.
templateId This property is required. string
An ID for the template that you want to create. This template is unique per AWS Region ; in each AWS account.
aws_account_id This property is required. str
The ID for the AWS account that the group is in. You use the ID for the AWS account that contains your Amazon QuickSight account.
template_id This property is required. str
An ID for the template that you want to create. This template is unique per AWS Region ; in each AWS account.
awsAccountId This property is required. String
The ID for the AWS account that the group is in. You use the ID for the AWS account that contains your Amazon QuickSight account.
templateId This property is required. String
An ID for the template that you want to create. This template is unique per AWS Region ; in each AWS account.

getTemplate Result

The following output properties are available:

Arn string
CreatedTime string
LastUpdatedTime string
Name string
A display name for the template.
Permissions List<Pulumi.AwsNative.QuickSight.Outputs.TemplateResourcePermission>
A list of resource permissions to be set on the template.
Tags List<Pulumi.AwsNative.Outputs.Tag>
Contains a map of the key-value pairs for the resource tag or tags assigned to the resource.
Version Pulumi.AwsNative.QuickSight.Outputs.TemplateVersion
Arn string
CreatedTime string
LastUpdatedTime string
Name string
A display name for the template.
Permissions []TemplateResourcePermission
A list of resource permissions to be set on the template.
Tags Tag
Contains a map of the key-value pairs for the resource tag or tags assigned to the resource.
Version TemplateVersion
arn String
createdTime String
lastUpdatedTime String
name String
A display name for the template.
permissions List<TemplateResourcePermission>
A list of resource permissions to be set on the template.
tags List<Tag>
Contains a map of the key-value pairs for the resource tag or tags assigned to the resource.
version TemplateVersion
arn string
createdTime string
lastUpdatedTime string
name string
A display name for the template.
permissions TemplateResourcePermission[]
A list of resource permissions to be set on the template.
tags Tag[]
Contains a map of the key-value pairs for the resource tag or tags assigned to the resource.
version TemplateVersion
arn str
created_time str
last_updated_time str
name str
A display name for the template.
permissions Sequence[TemplateResourcePermission]
A list of resource permissions to be set on the template.
tags Sequence[root_Tag]
Contains a map of the key-value pairs for the resource tag or tags assigned to the resource.
version TemplateVersion
arn String
createdTime String
lastUpdatedTime String
name String
A display name for the template.
permissions List<Property Map>
A list of resource permissions to be set on the template.
tags List<Property Map>
Contains a map of the key-value pairs for the resource tag or tags assigned to the resource.
version Property Map

Supporting Types

Tag

Key This property is required. string
The key name of the tag
Value This property is required. string
The value of the tag
Key This property is required. string
The key name of the tag
Value This property is required. string
The value of the tag
key This property is required. String
The key name of the tag
value This property is required. String
The value of the tag
key This property is required. string
The key name of the tag
value This property is required. string
The value of the tag
key This property is required. str
The key name of the tag
value This property is required. str
The value of the tag
key This property is required. String
The key name of the tag
value This property is required. String
The value of the tag

TemplateColumnGroupColumnSchema

Name string
Name string
name String
name string
name str
name String

TemplateColumnGroupSchema

TemplateColumnSchema

DataType string
GeographicRole string
Name string
DataType string
GeographicRole string
Name string
dataType String
geographicRole String
name String
dataType string
geographicRole string
name string
dataType String
geographicRole String
name String

TemplateDataSetConfiguration

TemplateDataSetSchema

TemplateEntity

Path string
The hierarchical path of the entity within the analysis, template, or dashboard definition tree.
Path string
The hierarchical path of the entity within the analysis, template, or dashboard definition tree.
path String
The hierarchical path of the entity within the analysis, template, or dashboard definition tree.
path string
The hierarchical path of the entity within the analysis, template, or dashboard definition tree.
path str
The hierarchical path of the entity within the analysis, template, or dashboard definition tree.
path String
The hierarchical path of the entity within the analysis, template, or dashboard definition tree.

TemplateError

TemplateErrorType

TemplateResourcePermission

Actions This property is required. List<string>
Principal This property is required. string
Actions This property is required. []string
Principal This property is required. string
actions This property is required. List<String>
principal This property is required. String
actions This property is required. string[]
principal This property is required. string
actions This property is required. Sequence[str]
principal This property is required. str
actions This property is required. List<String>
principal This property is required. String

TemplateResourceStatus

TemplateSheet

Name string
SheetId string
Name string
SheetId string
name String
sheetId String
name string
sheetId string
name str
sheet_id str
name String
sheetId String

TemplateVersion

CreatedTime string
DataSetConfigurations []TemplateDataSetConfiguration
Description string
Errors []TemplateError
Sheets []TemplateSheet
SourceEntityArn string
Status TemplateResourceStatus
The status that is associated with the template.

  • CREATION_IN_PROGRESS
  • CREATION_SUCCESSFUL
  • CREATION_FAILED
  • UPDATE_IN_PROGRESS
  • UPDATE_SUCCESSFUL
  • UPDATE_FAILED
  • DELETED
ThemeArn string
VersionNumber float64
createdTime String
dataSetConfigurations List<TemplateDataSetConfiguration>
description String
errors List<TemplateError>
sheets List<TemplateSheet>
sourceEntityArn String
status TemplateResourceStatus
The status that is associated with the template.

  • CREATION_IN_PROGRESS
  • CREATION_SUCCESSFUL
  • CREATION_FAILED
  • UPDATE_IN_PROGRESS
  • UPDATE_SUCCESSFUL
  • UPDATE_FAILED
  • DELETED
themeArn String
versionNumber Double
createdTime string
dataSetConfigurations TemplateDataSetConfiguration[]
description string
errors TemplateError[]
sheets TemplateSheet[]
sourceEntityArn string
status TemplateResourceStatus
The status that is associated with the template.

  • CREATION_IN_PROGRESS
  • CREATION_SUCCESSFUL
  • CREATION_FAILED
  • UPDATE_IN_PROGRESS
  • UPDATE_SUCCESSFUL
  • UPDATE_FAILED
  • DELETED
themeArn string
versionNumber number
created_time str
data_set_configurations Sequence[TemplateDataSetConfiguration]
description str
errors Sequence[TemplateError]
sheets Sequence[TemplateSheet]
source_entity_arn str
status TemplateResourceStatus
The status that is associated with the template.

  • CREATION_IN_PROGRESS
  • CREATION_SUCCESSFUL
  • CREATION_FAILED
  • UPDATE_IN_PROGRESS
  • UPDATE_SUCCESSFUL
  • UPDATE_FAILED
  • DELETED
theme_arn str
version_number float
createdTime String
dataSetConfigurations List<Property Map>
description String
errors List<Property Map>
sheets List<Property Map>
sourceEntityArn String
status "CREATION_IN_PROGRESS" | "CREATION_SUCCESSFUL" | "CREATION_FAILED" | "UPDATE_IN_PROGRESS" | "UPDATE_SUCCESSFUL" | "UPDATE_FAILED" | "DELETED"
The status that is associated with the template.

  • CREATION_IN_PROGRESS
  • CREATION_SUCCESSFUL
  • CREATION_FAILED
  • UPDATE_IN_PROGRESS
  • UPDATE_SUCCESSFUL
  • UPDATE_FAILED
  • DELETED
themeArn String
versionNumber Number

Package Details

Repository
AWS Native pulumi/pulumi-aws-native
License
Apache-2.0

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.27.0 published on Monday, Apr 14, 2025 by Pulumi