Skip to content

CreateTaskRequest

Source code in docs_src/capo_iotsitewise/types/create_task_request.py
class CreateTaskRequest(TypedDict, closed=True):
    workspace_name: "capo_iotsitewise.types.workspace_name.WorkspaceName"
    """<p>The name of the workspace.</p>"""
    task_name: "capo_iotsitewise.types.resource_name.ResourceName"
    """<p>The name of the task to create. Must be unique within the workspace.</p>"""
    description: NotRequired["capo_iotsitewise.types.description.Description"]
    """<p>A description of the task.</p>"""
    task_configuration: "capo_iotsitewise.types.task_configuration.TaskConfiguration"
    """<p>The task execution configuration. Specify a <a href="https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_ContainerTaskConfiguration.html">containerTaskConfiguration</a> for custom container workloads.</p>"""
    tags: NotRequired["capo_iotsitewise.types.tag_map.TagMap"]
    """<p>A list of key-value pairs that contain metadata for the task. For more information, see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/tag-resources.html">Tagging your AWS IoT SiteWise resources</a> in the AWS IoT SiteWise User Guide.</p>"""
    client_token: NotRequired["capo_iotsitewise.types.client_token.ClientToken"]
    """<p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you retry a request that completed successfully using the same client token, the server returns the cached result from the original successful request without performing the operation again.</p>"""

client_token instance-attribute

client_token: NotRequired[ClientToken]

A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you retry a request that completed successfully using the same client token, the server returns the cached result from the original successful request without performing the operation again.

description instance-attribute

description: NotRequired[Description]

A description of the task.

tags instance-attribute

tags: NotRequired[TagMap]

A list of key-value pairs that contain metadata for the task. For more information, see Tagging your AWS IoT SiteWise resources in the AWS IoT SiteWise User Guide.

task_configuration instance-attribute

task_configuration: TaskConfiguration

The task execution configuration. Specify a containerTaskConfiguration for custom container workloads.

task_name instance-attribute

task_name: ResourceName

The name of the task to create. Must be unique within the workspace.

workspace_name instance-attribute

workspace_name: WorkspaceName

The name of the workspace.