1. Packages
  2. AWS Cloud Control
  3. API Docs
  4. connect
  5. getTaskTemplate

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.connect.getTaskTemplate

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

Resource Type definition for AWS::Connect::TaskTemplate.

Using getTaskTemplate

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 getTaskTemplate(args: GetTaskTemplateArgs, opts?: InvokeOptions): Promise<GetTaskTemplateResult>
function getTaskTemplateOutput(args: GetTaskTemplateOutputArgs, opts?: InvokeOptions): Output<GetTaskTemplateResult>
Copy
def get_task_template(arn: Optional[str] = None,
                      opts: Optional[InvokeOptions] = None) -> GetTaskTemplateResult
def get_task_template_output(arn: Optional[pulumi.Input[str]] = None,
                      opts: Optional[InvokeOptions] = None) -> Output[GetTaskTemplateResult]
Copy
func LookupTaskTemplate(ctx *Context, args *LookupTaskTemplateArgs, opts ...InvokeOption) (*LookupTaskTemplateResult, error)
func LookupTaskTemplateOutput(ctx *Context, args *LookupTaskTemplateOutputArgs, opts ...InvokeOption) LookupTaskTemplateResultOutput
Copy

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

public static class GetTaskTemplate 
{
    public static Task<GetTaskTemplateResult> InvokeAsync(GetTaskTemplateArgs args, InvokeOptions? opts = null)
    public static Output<GetTaskTemplateResult> Invoke(GetTaskTemplateInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetTaskTemplateResult> getTaskTemplate(GetTaskTemplateArgs args, InvokeOptions options)
public static Output<GetTaskTemplateResult> getTaskTemplate(GetTaskTemplateArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: aws-native:connect:getTaskTemplate
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

Arn This property is required. string
The identifier (arn) of the task template.
Arn This property is required. string
The identifier (arn) of the task template.
arn This property is required. String
The identifier (arn) of the task template.
arn This property is required. string
The identifier (arn) of the task template.
arn This property is required. str
The identifier (arn) of the task template.
arn This property is required. String
The identifier (arn) of the task template.

getTaskTemplate Result

The following output properties are available:

Arn string
The identifier (arn) of the task template.
ClientToken string
A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
Constraints Pulumi.AwsNative.Connect.Outputs.ConstraintsProperties
The constraints for the task template
ContactFlowArn string
The identifier of the contact flow.
Defaults List<Pulumi.AwsNative.Connect.Outputs.TaskTemplateDefaultFieldValue>
The default values for fields when a task is created by referencing this template.
Description string
The description of the task template.
Fields List<Pulumi.AwsNative.Connect.Outputs.TaskTemplateField>
The list of task template's fields
InstanceArn string
The identifier (arn) of the instance.
Name string
The name of the task template.
SelfAssignContactFlowArn string
The identifier of the contact flow.
Status Pulumi.AwsNative.Connect.TaskTemplateStatus
The status of the task template.
Tags List<Pulumi.AwsNative.Outputs.Tag>
One or more tags.
Arn string
The identifier (arn) of the task template.
ClientToken string
A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
Constraints ConstraintsProperties
The constraints for the task template
ContactFlowArn string
The identifier of the contact flow.
Defaults []TaskTemplateDefaultFieldValue
The default values for fields when a task is created by referencing this template.
Description string
The description of the task template.
Fields []TaskTemplateField
The list of task template's fields
InstanceArn string
The identifier (arn) of the instance.
Name string
The name of the task template.
SelfAssignContactFlowArn string
The identifier of the contact flow.
Status TaskTemplateStatus
The status of the task template.
Tags Tag
One or more tags.
arn String
The identifier (arn) of the task template.
clientToken String
A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
constraints ConstraintsProperties
The constraints for the task template
contactFlowArn String
The identifier of the contact flow.
defaults List<TaskTemplateDefaultFieldValue>
The default values for fields when a task is created by referencing this template.
description String
The description of the task template.
fields List<TaskTemplateField>
The list of task template's fields
instanceArn String
The identifier (arn) of the instance.
name String
The name of the task template.
selfAssignContactFlowArn String
The identifier of the contact flow.
status TaskTemplateStatus
The status of the task template.
tags List<Tag>
One or more tags.
arn string
The identifier (arn) of the task template.
clientToken string
A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
constraints ConstraintsProperties
The constraints for the task template
contactFlowArn string
The identifier of the contact flow.
defaults TaskTemplateDefaultFieldValue[]
The default values for fields when a task is created by referencing this template.
description string
The description of the task template.
fields TaskTemplateField[]
The list of task template's fields
instanceArn string
The identifier (arn) of the instance.
name string
The name of the task template.
selfAssignContactFlowArn string
The identifier of the contact flow.
status TaskTemplateStatus
The status of the task template.
tags Tag[]
One or more tags.
arn str
The identifier (arn) of the task template.
client_token str
A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
constraints ConstraintsProperties
The constraints for the task template
contact_flow_arn str
The identifier of the contact flow.
defaults Sequence[TaskTemplateDefaultFieldValue]
The default values for fields when a task is created by referencing this template.
description str
The description of the task template.
fields Sequence[TaskTemplateField]
The list of task template's fields
instance_arn str
The identifier (arn) of the instance.
name str
The name of the task template.
self_assign_contact_flow_arn str
The identifier of the contact flow.
status TaskTemplateStatus
The status of the task template.
tags Sequence[root_Tag]
One or more tags.
arn String
The identifier (arn) of the task template.
clientToken String
A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
constraints Property Map
The constraints for the task template
contactFlowArn String
The identifier of the contact flow.
defaults List<Property Map>
The default values for fields when a task is created by referencing this template.
description String
The description of the task template.
fields List<Property Map>
The list of task template's fields
instanceArn String
The identifier (arn) of the instance.
name String
The name of the task template.
selfAssignContactFlowArn String
The identifier of the contact flow.
status "ACTIVE" | "INACTIVE"
The status of the task template.
tags List<Property Map>
One or more tags.

Supporting Types

ConstraintsProperties

InvisibleFields List<Pulumi.AwsNative.Connect.Inputs.TaskTemplateInvisibleFieldInfo>
Lists the fields that are invisible to agents.
ReadOnlyFields List<Pulumi.AwsNative.Connect.Inputs.TaskTemplateReadOnlyFieldInfo>
Lists the fields that are read-only to agents, and cannot be edited.
RequiredFields List<Pulumi.AwsNative.Connect.Inputs.TaskTemplateRequiredFieldInfo>
Lists the fields that are required to be filled by agents.
InvisibleFields []TaskTemplateInvisibleFieldInfo
Lists the fields that are invisible to agents.
ReadOnlyFields []TaskTemplateReadOnlyFieldInfo
Lists the fields that are read-only to agents, and cannot be edited.
RequiredFields []TaskTemplateRequiredFieldInfo
Lists the fields that are required to be filled by agents.
invisibleFields List<TaskTemplateInvisibleFieldInfo>
Lists the fields that are invisible to agents.
readOnlyFields List<TaskTemplateReadOnlyFieldInfo>
Lists the fields that are read-only to agents, and cannot be edited.
requiredFields List<TaskTemplateRequiredFieldInfo>
Lists the fields that are required to be filled by agents.
invisibleFields TaskTemplateInvisibleFieldInfo[]
Lists the fields that are invisible to agents.
readOnlyFields TaskTemplateReadOnlyFieldInfo[]
Lists the fields that are read-only to agents, and cannot be edited.
requiredFields TaskTemplateRequiredFieldInfo[]
Lists the fields that are required to be filled by agents.
invisible_fields Sequence[TaskTemplateInvisibleFieldInfo]
Lists the fields that are invisible to agents.
read_only_fields Sequence[TaskTemplateReadOnlyFieldInfo]
Lists the fields that are read-only to agents, and cannot be edited.
required_fields Sequence[TaskTemplateRequiredFieldInfo]
Lists the fields that are required to be filled by agents.
invisibleFields List<Property Map>
Lists the fields that are invisible to agents.
readOnlyFields List<Property Map>
Lists the fields that are read-only to agents, and cannot be edited.
requiredFields List<Property Map>
Lists the fields that are required to be filled by agents.

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

TaskTemplateDefaultFieldValue

DefaultValue This property is required. string
Default value for the field.
Id This property is required. Pulumi.AwsNative.Connect.Inputs.TaskTemplateFieldIdentifier
Identifier of a field.
DefaultValue This property is required. string
Default value for the field.
Id This property is required. TaskTemplateFieldIdentifier
Identifier of a field.
defaultValue This property is required. String
Default value for the field.
id This property is required. TaskTemplateFieldIdentifier
Identifier of a field.
defaultValue This property is required. string
Default value for the field.
id This property is required. TaskTemplateFieldIdentifier
Identifier of a field.
default_value This property is required. str
Default value for the field.
id This property is required. TaskTemplateFieldIdentifier
Identifier of a field.
defaultValue This property is required. String
Default value for the field.
id This property is required. Property Map
Identifier of a field.

TaskTemplateField

Id This property is required. Pulumi.AwsNative.Connect.Inputs.TaskTemplateFieldIdentifier
The unique identifier for the field.
Type This property is required. Pulumi.AwsNative.Connect.TaskTemplateFieldType
Indicates the type of field. Following are the valid field types: NAME DESCRIPTION | SCHEDULED_TIME | QUICK_CONNECT | URL | NUMBER | TEXT | TEXT_AREA | DATE_TIME | BOOLEAN | SINGLE_SELECT | EMAIL
Description string
The description of the task template's field
SingleSelectOptions List<string>
list of field options to be used with single select
Id This property is required. TaskTemplateFieldIdentifier
The unique identifier for the field.
Type This property is required. TaskTemplateFieldType
Indicates the type of field. Following are the valid field types: NAME DESCRIPTION | SCHEDULED_TIME | QUICK_CONNECT | URL | NUMBER | TEXT | TEXT_AREA | DATE_TIME | BOOLEAN | SINGLE_SELECT | EMAIL
Description string
The description of the task template's field
SingleSelectOptions []string
list of field options to be used with single select
id This property is required. TaskTemplateFieldIdentifier
The unique identifier for the field.
type This property is required. TaskTemplateFieldType
Indicates the type of field. Following are the valid field types: NAME DESCRIPTION | SCHEDULED_TIME | QUICK_CONNECT | URL | NUMBER | TEXT | TEXT_AREA | DATE_TIME | BOOLEAN | SINGLE_SELECT | EMAIL
description String
The description of the task template's field
singleSelectOptions List<String>
list of field options to be used with single select
id This property is required. TaskTemplateFieldIdentifier
The unique identifier for the field.
type This property is required. TaskTemplateFieldType
Indicates the type of field. Following are the valid field types: NAME DESCRIPTION | SCHEDULED_TIME | QUICK_CONNECT | URL | NUMBER | TEXT | TEXT_AREA | DATE_TIME | BOOLEAN | SINGLE_SELECT | EMAIL
description string
The description of the task template's field
singleSelectOptions string[]
list of field options to be used with single select
id This property is required. TaskTemplateFieldIdentifier
The unique identifier for the field.
type This property is required. TaskTemplateFieldType
Indicates the type of field. Following are the valid field types: NAME DESCRIPTION | SCHEDULED_TIME | QUICK_CONNECT | URL | NUMBER | TEXT | TEXT_AREA | DATE_TIME | BOOLEAN | SINGLE_SELECT | EMAIL
description str
The description of the task template's field
single_select_options Sequence[str]
list of field options to be used with single select
id This property is required. Property Map
The unique identifier for the field.
type This property is required. "NAME" | "DESCRIPTION" | "SCHEDULED_TIME" | "QUICK_CONNECT" | "URL" | "NUMBER" | "TEXT" | "TEXT_AREA" | "DATE_TIME" | "BOOLEAN" | "SINGLE_SELECT" | "EMAIL" | "EXPIRY_DURATION" | "SELF_ASSIGN"
Indicates the type of field. Following are the valid field types: NAME DESCRIPTION | SCHEDULED_TIME | QUICK_CONNECT | URL | NUMBER | TEXT | TEXT_AREA | DATE_TIME | BOOLEAN | SINGLE_SELECT | EMAIL
description String
The description of the task template's field
singleSelectOptions List<String>
list of field options to be used with single select

TaskTemplateFieldIdentifier

Name This property is required. string
The name of the task template field
Name This property is required. string
The name of the task template field
name This property is required. String
The name of the task template field
name This property is required. string
The name of the task template field
name This property is required. str
The name of the task template field
name This property is required. String
The name of the task template field

TaskTemplateFieldType

TaskTemplateInvisibleFieldInfo

Id This property is required. TaskTemplateFieldIdentifier
id This property is required. TaskTemplateFieldIdentifier
id This property is required. TaskTemplateFieldIdentifier
id This property is required. TaskTemplateFieldIdentifier
id This property is required. Property Map

TaskTemplateReadOnlyFieldInfo

Id This property is required. TaskTemplateFieldIdentifier
id This property is required. TaskTemplateFieldIdentifier
id This property is required. TaskTemplateFieldIdentifier
id This property is required. TaskTemplateFieldIdentifier
id This property is required. Property Map

TaskTemplateRequiredFieldInfo

Id This property is required. TaskTemplateFieldIdentifier
id This property is required. TaskTemplateFieldIdentifier
id This property is required. TaskTemplateFieldIdentifier
id This property is required. TaskTemplateFieldIdentifier
id This property is required. Property Map

TaskTemplateStatus

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