We recommend new projects start with resources from the AWS provider.
AWS Native v0.126.0 published on Monday, Sep 30, 2024 by Pulumi
aws-native.quicksight.getTemplate
Explore with Pulumi AI
We recommend new projects start with resources from the AWS provider.
AWS Native v0.126.0 published on Monday, Sep 30, 2024 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)
// Output-based functions aren't available in Java yet
fn::invoke:
function: aws-native:quicksight:getTemplate
arguments:
# arguments dictionary
The following arguments are supported:
- Aws
Account 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.
- Template
Id string - An ID for the template that you want to create. This template is unique per AWS Region ; in each AWS account.
- Aws
Account 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.
- Template
Id string - An ID for the template that you want to create. This template is unique per AWS Region ; in each AWS account.
- aws
Account 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.
- template
Id String - An ID for the template that you want to create. This template is unique per AWS Region ; in each AWS account.
- aws
Account 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.
- template
Id 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.
- aws
Account 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.
- template
Id 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
- Created
Time string - Last
Updated 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
- Created
Time string - Last
Updated stringTime - Name string
- A display name for the template.
- Permissions
[]Template
Resource 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
Template
Version
- arn String
- created
Time String - last
Updated StringTime - name String
- A display name for the template.
- permissions
List<Template
Resource 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
Template
Version
- arn string
- created
Time string - last
Updated stringTime - name string
- A display name for the template.
- permissions
Template
Resource 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
Template
Version
- arn str
- created_
time str - last_
updated_ strtime - name str
- A display name for the template.
- permissions
Sequence[Template
Resource 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
Template
Version
- arn String
- created
Time String - last
Updated 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
- Data
Type string - Geographic
Role string - Name string
- Data
Type string - Geographic
Role string - Name string
- data
Type String - geographic
Role String - name String
- data
Type string - geographic
Role string - name string
- data_
type str - geographic_
role str - name str
- data
Type String - geographic
Role String - name String
TemplateDataSetConfiguration
- Column
Group []TemplateSchema List Column Group Schema - Data
Set TemplateSchema Data Set Schema - Dataset schema.
- Placeholder string
- column
Group TemplateSchema List Column Group Schema[] - data
Set TemplateSchema Data Set Schema - Dataset schema.
- placeholder string
- column
Group List<Property Map>Schema List - data
Set 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
Template
Error Type - Type of error.
- Violated
Entities []TemplateEntity
- message String
- type
Template
Error Type - Type of error.
- violated
Entities List<TemplateEntity>
- message string
- type
Template
Error Type - Type of error.
- violated
Entities TemplateEntity[]
- message str
- type
Template
Error Type - Type of error.
- violated_
entities Sequence[TemplateEntity]
TemplateErrorType
TemplateResourcePermission
TemplateResourceStatus
TemplateSheet
TemplateVersion
- Created
Time string - Data
Set 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> - Source
Entity 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
- Theme
Arn string - Version
Number double
- Created
Time string - Data
Set []TemplateConfigurations Data Set Configuration - Description string
- Errors
[]Template
Error - Sheets
[]Template
Sheet - Source
Entity stringArn - Status
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
- Theme
Arn string - Version
Number float64
- created
Time String - data
Set List<TemplateConfigurations Data Set Configuration> - description String
- errors
List<Template
Error> - sheets
List<Template
Sheet> - source
Entity StringArn - status
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
- theme
Arn String - version
Number Double
- created
Time string - data
Set TemplateConfigurations Data Set Configuration[] - description string
- errors
Template
Error[] - sheets
Template
Sheet[] - source
Entity stringArn - status
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
- theme
Arn string - version
Number number
- created_
time str - data_
set_ Sequence[Templateconfigurations Data Set Configuration] - description str
- errors
Sequence[Template
Error] - sheets
Sequence[Template
Sheet] - source_
entity_ strarn - status
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
- theme_
arn str - version_
number float
- created
Time String - data
Set List<Property Map>Configurations - description String
- errors List<Property Map>
- sheets List<Property Map>
- source
Entity 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
- theme
Arn String - version
Number 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 Native v0.126.0 published on Monday, Sep 30, 2024 by Pulumi