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

AWS Native is in preview. AWS Classic is fully supported.

AWS Native v0.109.0 published on Wednesday, Jun 26, 2024 by Pulumi
pulumi/pulumi-aws-native

aws-native.connect.getTaskTemplate

Explore with Pulumi AI

aws-native logo

AWS Native is in preview. AWS Classic is fully supported.

AWS Native v0.109.0 published on Wednesday, Jun 26, 2024 by Pulumi
pulumi/pulumi-aws-native

    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>
    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]
    func LookupTaskTemplate(ctx *Context, args *LookupTaskTemplateArgs, opts ...InvokeOption) (*LookupTaskTemplateResult, error)
func LookupTaskTemplateOutput(ctx *Context, args *LookupTaskTemplateOutputArgs, opts ...InvokeOption) LookupTaskTemplateResultOutput

    > 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)
}
    public static CompletableFuture<GetTaskTemplateResult> getTaskTemplate(GetTaskTemplateArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

    fn::invoke:
  function: aws-native:connect:getTaskTemplate
  arguments:
    # arguments dictionary

    The following arguments are supported:

    Arn string
    The identifier (arn) of the task template.
    Arn string
    The identifier (arn) of the task template.
    arn String
    The identifier (arn) of the task template.
    arn string
    The identifier (arn) of the task template.
    arn str
    The identifier (arn) of the task template.
    arn 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.
    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.
    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.
    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.
    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.
    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.
    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 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

    TaskTemplateDefaultFieldValue

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

    TaskTemplateField

    Id Pulumi.AwsNative.Connect.Inputs.TaskTemplateFieldIdentifier
    The unique identifier for the field.
    Type 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 TaskTemplateFieldIdentifier
    The unique identifier for the field.
    Type 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 TaskTemplateFieldIdentifier
    The unique identifier for the field.
    type 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 TaskTemplateFieldIdentifier
    The unique identifier for the field.
    type 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 TaskTemplateFieldIdentifier
    The unique identifier for the field.
    type 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 Property Map
    The unique identifier for the field.
    type "NAME" | "DESCRIPTION" | "SCHEDULED_TIME" | "QUICK_CONNECT" | "URL" | "NUMBER" | "TEXT" | "TEXT_AREA" | "DATE_TIME" | "BOOLEAN" | "SINGLE_SELECT" | "EMAIL"
    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 string
    The name of the task template field
    Name string
    The name of the task template field
    name String
    The name of the task template field
    name string
    The name of the task template field
    name str
    The name of the task template field
    name String
    The name of the task template field

    TaskTemplateFieldType

    TaskTemplateInvisibleFieldInfo

    TaskTemplateReadOnlyFieldInfo

    TaskTemplateRequiredFieldInfo

    TaskTemplateStatus

    Package Details

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

    AWS Native is in preview. AWS Classic is fully supported.

    AWS Native v0.109.0 published on Wednesday, Jun 26, 2024 by Pulumi
    pulumi/pulumi-aws-native