We recommend new projects start with resources from the AWS provider.
AWS Cloud Control v1.26.0 published on Wednesday, Mar 12, 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.26.0 published on Wednesday, Mar 12, 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>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]func LookupTemplate(ctx *Context, args *LookupTemplateArgs, opts ...InvokeOption) (*LookupTemplateResult, error)
func LookupTemplateOutput(ctx *Context, args *LookupTemplateOutputArgs, opts ...InvokeOption) LookupTemplateResultOutput> 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)
}public static CompletableFuture<GetTemplateResult> getTemplate(GetTemplateArgs args, InvokeOptions options)
public static Output<GetTemplateResult> getTemplate(GetTemplateArgs args, InvokeOptions options)
fn::invoke:
  function: aws-native:quicksight:getTemplate
  arguments:
    # arguments dictionaryThe following arguments are supported:
- AwsAccount stringId 
- 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 string
- An ID for the template that you want to create. This template is unique per AWS Region ; in each AWS account.
- AwsAccount stringId 
- 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 string
- An ID for the template that you want to create. This template is unique per AWS Region ; in each AWS account.
- awsAccount StringId 
- 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 String
- An ID for the template that you want to create. This template is unique per AWS Region ; in each AWS account.
- awsAccount stringId 
- 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 string
- An ID for the template that you want to create. This template is unique per AWS Region ; in each AWS account.
- aws_account_ strid 
- 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 str
- An ID for the template that you want to create. This template is unique per AWS Region ; in each AWS account.
- awsAccount StringId 
- 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 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
- LastUpdated stringTime 
- Name string
- A display name for the template.
- Permissions
List<Pulumi.Aws Native. Quick Sight. Outputs. Template Resource Permission> 
- A list of resource permissions to be set on the template.
- 
List<Pulumi.Aws Native. Outputs. Tag> 
- Contains a map of the key-value pairs for the resource tag or tags assigned to the resource.
- Version
Pulumi.Aws Native. Quick Sight. Outputs. Template Version 
- Arn string
- CreatedTime string
- LastUpdated stringTime 
- Name string
- A display name for the template.
- Permissions
[]TemplateResource Permission 
- A list of resource permissions to be set on the template.
- 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
- lastUpdated StringTime 
- name String
- A display name for the template.
- permissions
List<TemplateResource Permission> 
- A list of resource permissions to be set on the template.
- 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
- lastUpdated stringTime 
- name string
- A display name for the template.
- permissions
TemplateResource Permission[] 
- A list of resource permissions to be set on the template.
- 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_ strtime 
- name str
- A display name for the template.
- permissions
Sequence[TemplateResource Permission] 
- A list of resource permissions to be set on the template.
- 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
- lastUpdated StringTime 
- name String
- A display name for the template.
- permissions List<Property Map>
- A list of resource permissions to be set on the template.
- 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
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
- data_type str
- geographic_role str
- name str
- dataType String
- geographicRole String
- name String
TemplateDataSetConfiguration   
- ColumnGroup []TemplateSchema List Column Group Schema 
- DataSet TemplateSchema Data Set Schema 
- Dataset schema.
- Placeholder string
- columnGroup TemplateSchema List Column Group Schema[] 
- dataSet TemplateSchema Data Set Schema 
- Dataset schema.
- placeholder string
- columnGroup List<Property Map>Schema List 
- dataSet Property MapSchema 
- Dataset schema.
- placeholder String
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 
- Message string
- Type
TemplateError Type 
- Type of error.
- ViolatedEntities []TemplateEntity 
- message String
- type
TemplateError Type 
- Type of error.
- violatedEntities List<TemplateEntity> 
- message string
- type
TemplateError Type 
- Type of error.
- violatedEntities TemplateEntity[] 
- message str
- type
TemplateError Type 
- Type of error.
- violated_entities Sequence[TemplateEntity] 
TemplateErrorType  
TemplateResourcePermission  
TemplateResourceStatus  
TemplateSheet 
TemplateVersion 
- CreatedTime string
- DataSet List<Pulumi.Configurations Aws Native. Quick Sight. Inputs. Template Data Set Configuration> 
- Description string
- Errors
List<Pulumi.Aws Native. Quick Sight. Inputs. Template Error> 
- Sheets
List<Pulumi.Aws Native. Quick Sight. Inputs. Template Sheet> 
- SourceEntity stringArn 
- Status
Pulumi.Aws Native. Quick Sight. Template Resource Status 
- 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
- DataSet []TemplateConfigurations Data Set Configuration 
- Description string
- Errors
[]TemplateError 
- Sheets
[]TemplateSheet 
- SourceEntity stringArn 
- Status
TemplateResource Status 
- 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
- dataSet List<TemplateConfigurations Data Set Configuration> 
- description String
- errors
List<TemplateError> 
- sheets
List<TemplateSheet> 
- sourceEntity StringArn 
- status
TemplateResource Status 
- 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
- dataSet TemplateConfigurations Data Set Configuration[] 
- description string
- errors
TemplateError[] 
- sheets
TemplateSheet[] 
- sourceEntity stringArn 
- status
TemplateResource Status 
- 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_ Sequence[Templateconfigurations Data Set Configuration] 
- description str
- errors
Sequence[TemplateError] 
- sheets
Sequence[TemplateSheet] 
- source_entity_ strarn 
- status
TemplateResource Status 
- 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
- dataSet List<Property Map>Configurations 
- description String
- errors List<Property Map>
- sheets List<Property Map>
- sourceEntity StringArn 
- 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.26.0 published on Wednesday, Mar 12, 2025 by Pulumi