AWS CLI Command Reference

[ aws . iotsitewise ]

create-task

Description

Creates a new task in the specified workspace. A task defines a reusable containerized compute workload that can be referenced by one or more pipeline compute nodes.

Specify a `containerTaskConfiguration <https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_ContainerTaskConfiguration.html>`__ for custom container workloads with configurable ECR image, processing type, processing unit, and environment variables.

See also: AWS API Documentation

Synopsis

  create-task
--workspace-name <value>
--task-name <value>
[--description <value>]
--task-configuration <value>
[--tags <value>]
[--client-token <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]
[--cli-binary-format <value>]
[--no-cli-pager]
[--cli-auto-prompt]
[--no-cli-auto-prompt]
[--cli-error-format <value>]

Options

--workspace-name (string) [required]

The name of the workspace.

Constraints:

  • min: 1
  • max: 64
  • pattern: ^[a-zA-Z0-9_-]+$

--task-name (string) [required]

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

Constraints:

  • min: 1
  • max: 64
  • pattern: [a-zA-Z0-9_-]+

--description (string)

A description of the task.

Constraints:

  • min: 1
  • max: 2048
  • pattern: [^\u0000-\u001F\u007F]+

--task-configuration (tagged union structure) [required]

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

Note

This is a Tagged Union structure. Only one of the following top level keys can be set: containerTaskConfiguration.

containerTaskConfiguration -> (structure)

Configuration for running a custom container image on managed compute.

ecrUri -> (string) [required]

The Amazon ECR image URI for the task container.

Constraints:

  • min: 1
  • max: 1024
  • pattern: ((\d{12}\.dkr\.ecr\.[a-z0-9-]+\.[a-z.]+)|public\.ecr\.aws/[a-z][a-z0-9]+([._-][a-z0-9]+)*)/[a-z0-9]+((\.||__|_|-+)[a-z0-9]+)*(/[a-z0-9]+((\.||__|_|-+)[a-z0-9]+)*)*(:[a-zA-Z0-9._-]+|@sha256:[a-f0-9]{64})?

taskExecutionRole -> (string) [required]

The ARN of the IAM role that grants the containerized workload permissions to access AWS resources.

Constraints:

  • min: 20
  • max: 2048
  • pattern: arn:aws(-cn|-us-gov)?:iam::\d{12}:role/[\w+=,.@/-]+

processingType -> (string) [required]

The processing type for compute resources.

Possible values:

  • GENERIC_COMPUTE_PROCESSING
  • HARDWARE_ACCELERATED_PROCESSING

processingUnit -> (string) [required]

The processing unit allocation that determines the vCPU, memory, and GPU resources.

Possible values:

  • UNITS_2
  • UNITS_4
  • UNITS_8
  • UNITS_12
  • UNITS_16
  • UNITS_24
  • UNITS_32
  • UNITS_36
  • UNITS_48
  • UNITS_60
  • UNITS_64
  • UNITS_72
  • UNITS_84
  • UNITS_96

ephemeralStorageConfiguration -> (structure)

Ephemeral storage configuration for the container task.

storageClass -> (string) [required]

Storage type that determines I/O performance family and level.

Possible values:

  • STANDARD_1
  • STANDARD_2
  • THROUGHPUT_1
  • THROUGHPUT_2

storageSizeInGiB -> (integer) [required]

Storage volume size in GiB.

Constraints:

  • min: 1
  • max: 16384

command -> (list)

The command to execute in the container.

(string)

timeoutSeconds -> (long)

The timeout in seconds for task execution. Default: 3600 (1 hour).

Constraints:

  • min: 60
  • max: 86400

environmentVariables -> (map)

Environment variables passed to the container at runtime.

Constraints:

  • min: 0
  • max: 20

key -> (string)

Environment variable name following POSIX naming rules Must not start with AWS_ prefix (case-insensitive)

Constraints:

  • min: 1
  • max: 255
  • pattern: (?!(?i)AWS_)[a-zA-Z_][a-zA-Z0-9_]*

value -> (string)

Environment variable value

Constraints:

  • min: 0
  • max: 1024

mounts -> (list)

Mounts attached to the container filesystem. Each mount exposes an external data source as a local directory inside the container. The service assigns each mount a container path based on the mount name. The container reads files through that path as if the data were on the local filesystem.

Constraints:

  • min: 0
  • max: 5

(structure)

Attaches a data source to the container filesystem for a task at a customer-supplied relative path under the service-owned mount root.

name -> (string) [required]

A unique name for the mount within the task.

Constraints:

  • min: 1
  • max: 64
  • pattern: [a-zA-Z0-9_-]+

relativePath -> (string) [required]

The relative path under the service-owned mount root where this mount is attached inside the container.

Constraints:

  • min: 1
  • max: 1024
  • pattern: ((?!.*(^|/)\.\.?(/|$))(?!.*//)[a-zA-Z0-9._-][a-zA-Z0-9._/-]*[a-zA-Z0-9._-]|[a-zA-Z0-9_-])

source -> (tagged union structure) [required]

The data source for the mount.

Note

This is a Tagged Union structure. Only one of the following top level keys can be set: s3AccessPoint.

s3AccessPoint -> (structure)

Configuration for a mount that reads from an Amazon S3 access point.

accessPointArn -> (string) [required]

The Amazon Resource Name (ARN) of the S3 access point.

Constraints:

  • min: 4
  • max: 128
  • pattern: arn:aws(-cn|-us-gov)?:s3:[a-z0-9-]*:\d{12}:accesspoint[/:][a-zA-Z0-9._-]+

prefix -> (string)

An optional key prefix to scope the mount to a subset of objects at the access point.

Constraints:

  • min: 1
  • max: 1024

storageType -> (string) [required]

The type of storage used for the mount.

Possible values:

  • SHARED_STORAGE

JSON Syntax:

{
  "containerTaskConfiguration": {
    "ecrUri": "string",
    "taskExecutionRole": "string",
    "processingType": "GENERIC_COMPUTE_PROCESSING"|"HARDWARE_ACCELERATED_PROCESSING",
    "processingUnit": "UNITS_2"|"UNITS_4"|"UNITS_8"|"UNITS_12"|"UNITS_16"|"UNITS_24"|"UNITS_32"|"UNITS_36"|"UNITS_48"|"UNITS_60"|"UNITS_64"|"UNITS_72"|"UNITS_84"|"UNITS_96",
    "ephemeralStorageConfiguration": {
      "storageClass": "STANDARD_1"|"STANDARD_2"|"THROUGHPUT_1"|"THROUGHPUT_2",
      "storageSizeInGiB": integer
    },
    "command": ["string", ...],
    "timeoutSeconds": long,
    "environmentVariables": {"string": "string"
      ...},
    "mounts": [
      {
        "name": "string",
        "relativePath": "string",
        "source": {
          "s3AccessPoint": {
            "accessPointArn": "string",
            "prefix": "string"
          }
        },
        "storageType": "SHARED_STORAGE"
      }
      ...
    ]
  }
}

--tags (map)

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.

Constraints:

  • min: 1
  • max: 50

key -> (string)

Constraints:

  • min: 1
  • max: 128

value -> (string)

Constraints:

  • min: 0
  • max: 256

Shorthand Syntax:

KeyName1=string,KeyName2=string

JSON Syntax:

{"string": "string"
  ...}

--client-token (string)

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.

Constraints:

  • min: 36
  • max: 64
  • pattern: \S{36,64}

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.

Global Options

--debug (boolean)

Turn on debug logging.

--endpoint-url (string)

Override command’s default URL with the given URL.

--no-verify-ssl (boolean)

By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.

--no-paginate (boolean)

Disable automatic pagination. If automatic pagination is disabled, the AWS CLI will only make one call, for the first page of results.

--output (string)

The formatting style for command output.

  • json
  • text
  • table
  • yaml
  • yaml-stream
  • off

--query (string)

A JMESPath query to use in filtering the response data.

--profile (string)

Use a specific profile from your credential file.

--region (string)

The region to use. Overrides config/env settings.

--version (string)

Display the version of this tool.

--color (string)

Turn on/off color output.

  • on
  • off
  • auto

--no-sign-request (boolean)

Do not sign requests. Credentials will not be loaded if this argument is provided.

--ca-bundle (string)

The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.

--cli-read-timeout (int)

The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.

--cli-connect-timeout (int)

The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.

--cli-binary-format (string)

The formatting style to be used for binary blobs. The default format is base64. The base64 format expects binary blobs to be provided as a base64 encoded string. The raw-in-base64-out format preserves compatibility with AWS CLI V1 behavior and binary values must be passed literally. When providing contents from a file that map to a binary blob fileb:// will always be treated as binary and use the file contents directly regardless of the cli-binary-format setting. When using file:// the file contents will need to properly formatted for the configured cli-binary-format.

  • base64
  • raw-in-base64-out

--no-cli-pager (boolean)

Disable cli pager for output.

--cli-auto-prompt (boolean)

Automatically prompt for CLI input parameters.

--no-cli-auto-prompt (boolean)

Disable automatically prompt for CLI input parameters.

--cli-error-format (string)

The formatting style for error output. By default, errors are displayed in enhanced format.

  • legacy
  • json
  • yaml
  • text
  • table
  • enhanced

Output

taskName -> (string)

The name of the created task.

Constraints:

  • min: 1
  • max: 64
  • pattern: [a-zA-Z0-9_-]+

taskArn -> (string)

The ARN of the created task.

Constraints:

  • min: 1
  • max: 1600
  • pattern: ^arn:aws(-cn|-us-gov)?:[a-zA-Z0-9-:\/_\.]+$

version -> (string)

The version of the newly created task.

Constraints:

  • min: 1
  • max: 10
  • pattern: ^(0|([1-9]{1}\d*))$

status -> (structure)

The current lifecycle status of the task.

error -> (structure)

Contains associated error information, if any.

code -> (string)

The error code.

Possible values:

  • VALIDATION_ERROR
  • INTERNAL_FAILURE

message -> (string)

The error message.

state -> (string)

The current status of the resource.

Possible values:

  • CREATING
  • ACTIVE
  • UPDATING
  • DELETING
  • FAILED
© Copyright 2026, Amazon Web Services. Created using Sphinx.