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

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

AWS Cloud Control v1.44.0 published on Friday, Dec 19, 2025 by Pulumi
Schema (JSON)
pulumi/pulumi-aws-native

aws-native.cases.getTemplate

aws-native logo

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

AWS Cloud Control v1.44.0 published on Friday, Dec 19, 2025 by Pulumi
Schema (JSON)
pulumi/pulumi-aws-native

    A template in the Cases domain. This template is used to define the case object model (that is, to define what data can be captured on cases) in a Cases domain. A template must have a unique name within a domain, and it must reference existing field IDs and layout IDs.

    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(template_arn: Optional[str] = None,
                 opts: Optional[InvokeOptions] = None) -> GetTemplateResult
def get_template_output(template_arn: 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:cases:getTemplate
  arguments:
    # arguments dictionary

    The following arguments are supported:

    TemplateArn string
    The Amazon Resource Name (ARN) of the template.
    TemplateArn string
    The Amazon Resource Name (ARN) of the template.
    templateArn String
    The Amazon Resource Name (ARN) of the template.
    templateArn string
    The Amazon Resource Name (ARN) of the template.
    template_arn str
    The Amazon Resource Name (ARN) of the template.
    templateArn String
    The Amazon Resource Name (ARN) of the template.

    getTemplate Result

    The following output properties are available:

    CreatedTime string
    The time at which the template was created.
    Description string
    A description explaining the purpose and use case for this template. Should indicate what types of cases this template is designed for and any specific workflow it supports.
    LastModifiedTime string
    The time at which the template was created or last modified.
    LayoutConfiguration Pulumi.AwsNative.Cases.Outputs.TemplateLayoutConfiguration
    Name string
    A name for the template. It must be unique per domain.
    RequiredFields List<Pulumi.AwsNative.Cases.Outputs.TemplateRequiredField>
    A list of fields that must contain a value for a case to be successfully created with this template.
    Rules List<Pulumi.AwsNative.Cases.Outputs.TemplateRule>
    A list of case rules (also known as case field conditions) on a template.
    Status Pulumi.AwsNative.Cases.TemplateStatus
    Tags List<Pulumi.AwsNative.Outputs.Tag>
    The tags that you attach to this template.
    TemplateArn string
    The Amazon Resource Name (ARN) of the template.
    TemplateId string
    The unique identifier of a template.
    CreatedTime string
    The time at which the template was created.
    Description string
    A description explaining the purpose and use case for this template. Should indicate what types of cases this template is designed for and any specific workflow it supports.
    LastModifiedTime string
    The time at which the template was created or last modified.
    LayoutConfiguration TemplateLayoutConfiguration
    Name string
    A name for the template. It must be unique per domain.
    RequiredFields []TemplateRequiredField
    A list of fields that must contain a value for a case to be successfully created with this template.
    Rules []TemplateRule
    A list of case rules (also known as case field conditions) on a template.
    Status TemplateStatus
    Tags Tag
    The tags that you attach to this template.
    TemplateArn string
    The Amazon Resource Name (ARN) of the template.
    TemplateId string
    The unique identifier of a template.
    createdTime String
    The time at which the template was created.
    description String
    A description explaining the purpose and use case for this template. Should indicate what types of cases this template is designed for and any specific workflow it supports.
    lastModifiedTime String
    The time at which the template was created or last modified.
    layoutConfiguration TemplateLayoutConfiguration
    name String
    A name for the template. It must be unique per domain.
    requiredFields List<TemplateRequiredField>
    A list of fields that must contain a value for a case to be successfully created with this template.
    rules List<TemplateRule>
    A list of case rules (also known as case field conditions) on a template.
    status TemplateStatus
    tags List<Tag>
    The tags that you attach to this template.
    templateArn String
    The Amazon Resource Name (ARN) of the template.
    templateId String
    The unique identifier of a template.
    createdTime string
    The time at which the template was created.
    description string
    A description explaining the purpose and use case for this template. Should indicate what types of cases this template is designed for and any specific workflow it supports.
    lastModifiedTime string
    The time at which the template was created or last modified.
    layoutConfiguration TemplateLayoutConfiguration
    name string
    A name for the template. It must be unique per domain.
    requiredFields TemplateRequiredField[]
    A list of fields that must contain a value for a case to be successfully created with this template.
    rules TemplateRule[]
    A list of case rules (also known as case field conditions) on a template.
    status TemplateStatus
    tags Tag[]
    The tags that you attach to this template.
    templateArn string
    The Amazon Resource Name (ARN) of the template.
    templateId string
    The unique identifier of a template.
    created_time str
    The time at which the template was created.
    description str
    A description explaining the purpose and use case for this template. Should indicate what types of cases this template is designed for and any specific workflow it supports.
    last_modified_time str
    The time at which the template was created or last modified.
    layout_configuration TemplateLayoutConfiguration
    name str
    A name for the template. It must be unique per domain.
    required_fields Sequence[TemplateRequiredField]
    A list of fields that must contain a value for a case to be successfully created with this template.
    rules Sequence[TemplateRule]
    A list of case rules (also known as case field conditions) on a template.
    status TemplateStatus
    tags Sequence[root_Tag]
    The tags that you attach to this template.
    template_arn str
    The Amazon Resource Name (ARN) of the template.
    template_id str
    The unique identifier of a template.
    createdTime String
    The time at which the template was created.
    description String
    A description explaining the purpose and use case for this template. Should indicate what types of cases this template is designed for and any specific workflow it supports.
    lastModifiedTime String
    The time at which the template was created or last modified.
    layoutConfiguration Property Map
    name String
    A name for the template. It must be unique per domain.
    requiredFields List<Property Map>
    A list of fields that must contain a value for a case to be successfully created with this template.
    rules List<Property Map>
    A list of case rules (also known as case field conditions) on a template.
    status "Active" | "Inactive"
    tags List<Property Map>
    The tags that you attach to this template.
    templateArn String
    The Amazon Resource Name (ARN) of the template.
    templateId String
    The unique identifier of a template.

    Supporting Types

    Tag

    Key string
    The key name of the tag
    Value string
    The value of the tag
    Key string
    The key name of the tag
    Value string
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag
    key string
    The key name of the tag
    value string
    The value of the tag
    key str
    The key name of the tag
    value str
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag

    TemplateLayoutConfiguration

    DefaultLayout string
    The unique identifier of a layout.
    DefaultLayout string
    The unique identifier of a layout.
    defaultLayout String
    The unique identifier of a layout.
    defaultLayout string
    The unique identifier of a layout.
    default_layout str
    The unique identifier of a layout.
    defaultLayout String
    The unique identifier of a layout.

    TemplateRequiredField

    FieldId string
    The unique identifier of a field.
    FieldId string
    The unique identifier of a field.
    fieldId String
    The unique identifier of a field.
    fieldId string
    The unique identifier of a field.
    field_id str
    The unique identifier of a field.
    fieldId String
    The unique identifier of a field.

    TemplateRule

    CaseRuleId string
    The unique identifier of a case rule.
    FieldId string
    The ID of the field that this rule applies to.
    CaseRuleId string
    The unique identifier of a case rule.
    FieldId string
    The ID of the field that this rule applies to.
    caseRuleId String
    The unique identifier of a case rule.
    fieldId String
    The ID of the field that this rule applies to.
    caseRuleId string
    The unique identifier of a case rule.
    fieldId string
    The ID of the field that this rule applies to.
    case_rule_id str
    The unique identifier of a case rule.
    field_id str
    The ID of the field that this rule applies to.
    caseRuleId String
    The unique identifier of a case rule.
    fieldId String
    The ID of the field that this rule applies to.

    TemplateStatus

    Package Details

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

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

    AWS Cloud Control v1.44.0 published on Friday, Dec 19, 2025 by Pulumi
    Schema (JSON)
    pulumi/pulumi-aws-native
      Meet Neo: Your AI Platform Teammate