2026/09/01 - AWS IoT SiteWise - 5 updated api methods
Changes AWS IoT SiteWise Scenario Discovery now supports mounting Amazon S3 data directly into pipeline task containers via S3 Access Points, and configuring additional ephemeral storage per task. Mount configurations can be overridden at execution time. See the API guide for details.
{'taskConfiguration': {'containerTaskConfiguration': {'ephemeralStorageConfiguration': {'storageClass': 'STANDARD_1 '
'| '
'STANDARD_2 '
'| '
'THROUGHPUT_1 '
'| '
'THROUGHPUT_2',
'storageSizeInGiB': 'integer'},
'mounts': [{'name': 'string',
'relativePath': 'string',
'source': {'s3AccessPoint': {'accessPointArn': 'string',
'prefix': 'string'}},
'storageType': 'SHARED_STORAGE'}]}}}
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 for custom container workloads with configurable ECR image, processing type, processing unit, and environment variables.
See also: AWS API Documentation
Request Syntax
client.create_task(
workspaceName='string',
taskName='string',
description='string',
taskConfiguration={
'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': 123
},
'command': [
'string',
],
'timeoutSeconds': 123,
'environmentVariables': {
'string': 'string'
},
'mounts': [
{
'name': 'string',
'relativePath': 'string',
'source': {
's3AccessPoint': {
'accessPointArn': 'string',
'prefix': 'string'
}
},
'storageType': 'SHARED_STORAGE'
},
]
}
},
tags={
'string': 'string'
},
clientToken='string'
)
string
[REQUIRED]
The name of the workspace.
string
[REQUIRED]
The name of the task to create. Must be unique within the workspace.
string
A description of the task.
dict
[REQUIRED]
The task execution configuration. Specify a containerTaskConfiguration for custom container workloads.
containerTaskConfiguration (dict) --
Configuration for running a custom container image on managed compute.
ecrUri (string) -- [REQUIRED]
The Amazon ECR image URI for the task container.
taskExecutionRole (string) -- [REQUIRED]
The ARN of the IAM role that grants the containerized workload permissions to access AWS resources.
processingType (string) -- [REQUIRED]
The processing type for compute resources.
processingUnit (string) -- [REQUIRED]
The processing unit allocation that determines the vCPU, memory, and GPU resources.
ephemeralStorageConfiguration (dict) --
Ephemeral storage configuration for the container task.
storageClass (string) -- [REQUIRED]
Storage type that determines I/O performance family and level.
storageSizeInGiB (integer) -- [REQUIRED]
Storage volume size in GiB.
command (list) --
The command to execute in the container.
(string) --
timeoutSeconds (integer) --
The timeout in seconds for task execution. Default: 3600 (1 hour).
environmentVariables (dict) --
Environment variables passed to the container at runtime.
(string) --
Environment variable name following POSIX naming rules Must not start with AWS_ prefix (case-insensitive)
(string) --
Environment variable value
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.
(dict) --
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.
relativePath (string) -- [REQUIRED]
The relative path under the service-owned mount root where this mount is attached inside the container.
source (dict) -- [REQUIRED]
The data source for the mount.
s3AccessPoint (dict) --
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.
prefix (string) --
An optional key prefix to scope the mount to a subset of objects at the access point.
storageType (string) -- [REQUIRED]
The type of storage used for the mount.
dict
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.
(string) --
(string) --
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.
This field is autopopulated if not provided.
dict
Response Syntax
{
'taskName': 'string',
'taskArn': 'string',
'version': 'string',
'status': {
'error': {
'code': 'VALIDATION_ERROR'|'INTERNAL_FAILURE',
'message': 'string'
},
'state': 'CREATING'|'ACTIVE'|'UPDATING'|'DELETING'|'FAILED'
}
}
Response Structure
(dict) --
Response structure for CreateTask operation.
taskName (string) --
The name of the created task.
taskArn (string) --
The ARN of the created task.
version (string) --
The version of the newly created task.
status (dict) --
The current lifecycle status of the task.
error (dict) --
Contains associated error information, if any.
code (string) --
The error code.
message (string) --
The error message.
state (string) --
The current status of the resource.
{'computeNodeExecutionDetails': {'executionMounts': [{'name': 'string',
'relativePath': 'string',
'source': {'s3AccessPoint': {'accessPointArn': 'string',
'prefix': 'string'}},
'storageType': 'SHARED_STORAGE'}]},
'requestMountOverrides': {'computeNodes': {'string': [{'name': 'string',
'relativePath': 'string',
'source': {'s3AccessPoint': {'accessPointArn': 'string',
'prefix': 'string'}},
'storageType': 'SHARED_STORAGE'}]}}}
Retrieves detailed information about a specific pipeline execution, including the overall execution status and the status of each individual compute node. Use this operation to monitor execution progress and inspect per-node results, environment variables, and error details.
See also: AWS API Documentation
Request Syntax
client.describe_pipeline_execution(
workspaceName='string',
pipelineName='string',
pipelineExecutionId='string',
nextToken='string',
maxResults=123
)
string
[REQUIRED]
The name of the workspace.
string
[REQUIRED]
The name of the pipeline.
string
[REQUIRED]
The unique identifier of the pipeline execution.
string
The token to be used for the next set of paginated results.
integer
The maximum number of compute nodes to return per request. This is an upper bound; the actual number of results may be less. Default: 50.
dict
Response Syntax
{
'pipelineExecutionId': 'string',
'pipelineName': 'string',
'workspaceName': 'string',
'pipelineVersion': 'string',
'status': {
'state': 'NOT_STARTED'|'RUNNING'|'SUCCEEDED'|'FAILED'|'CANCELLING'|'CANCELLED',
'stateDetails': {
'code': 'VALIDATION_ERROR'|'INTERNAL_FAILURE'|'EXECUTION_ERROR'|'TIMED_OUT',
'message': 'string',
'details': [
{
'code': 'VALIDATION_ERROR'|'INTERNAL_FAILURE'|'EXECUTION_ERROR'|'TIMED_OUT',
'message': 'string'
},
]
}
},
'startTime': datetime(2015, 1, 1),
'endTime': datetime(2015, 1, 1),
'requestEnvironmentVariables': {
'global': {
'string': 'string'
},
'computeNodes': {
'string': {
'string': 'string'
}
}
},
'requestMountOverrides': {
'computeNodes': {
'string': [
{
'name': 'string',
'relativePath': 'string',
'source': {
's3AccessPoint': {
'accessPointArn': 'string',
'prefix': 'string'
}
},
'storageType': 'SHARED_STORAGE'
},
]
}
},
'executionPriority': 123,
'computeNodeExecutionDetails': [
{
'computeNodeName': 'string',
'taskName': 'string',
'taskArn': 'string',
'taskVersion': 'string',
'dependsOn': [
'string',
],
'status': {
'state': 'NOT_STARTED'|'QUEUED'|'RUNNING'|'SUCCEEDED'|'FAILED',
'stateDetails': {
'code': 'VALIDATION_ERROR'|'INTERNAL_FAILURE'|'EXECUTION_ERROR'|'TIMED_OUT',
'message': 'string',
'details': [
{
'code': 'VALIDATION_ERROR'|'INTERNAL_FAILURE'|'EXECUTION_ERROR'|'TIMED_OUT',
'message': 'string'
},
]
}
},
'startTime': datetime(2015, 1, 1),
'endTime': datetime(2015, 1, 1),
'executionEnvironmentVariables': {
'string': 'string'
},
'executionMounts': [
{
'name': 'string',
'relativePath': 'string',
'source': {
's3AccessPoint': {
'accessPointArn': 'string',
'prefix': 'string'
}
},
'storageType': 'SHARED_STORAGE'
},
]
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
Response structure for DescribePipelineExecution operation.
pipelineExecutionId (string) --
The unique identifier of the pipeline execution.
pipelineName (string) --
The name of the pipeline.
workspaceName (string) --
The name of the workspace.
pipelineVersion (string) --
The pipeline version this execution ran against.
status (dict) --
The current execution status of the pipeline.
state (string) --
Current state of the pipeline execution.
stateDetails (dict) --
Additional information about the execution outcome. Populated when the execution has terminated (failed or cancelled).
code (string) --
Classification of the failure. Present when the execution failed.
message (string) --
Human-readable description of the outcome. For a failed execution, this describes why it failed; for a cancelled execution, this is the reason you supplied when calling CancelPipelineExecution.
details (list) --
Per-step error entries to help diagnose a failed execution. Present when the execution failed.
(dict) --
Contains a detailed error entry for granular troubleshooting of pipeline failures.
code (string) --
The error code.
message (string) --
The associated error message.
startTime (datetime) --
The time the pipeline execution started, in Unix epoch time.
endTime (datetime) --
The time the pipeline execution completed, in Unix epoch time.
requestEnvironmentVariables (dict) --
The environment variables provided as input for the pipeline execution.
global (dict) --
Global environment variables that apply to all compute nodes in the pipeline execution.
(string) --
Environment variable name following POSIX naming rules Must not start with AWS_ prefix (case-insensitive)
(string) --
Environment variable value
computeNodes (dict) --
Per-compute-node environment variable overrides. Each entry maps a compute node name to its environment variable overrides.
(string) --
The compute node name from the pipeline definition.
(dict) --
Environment variable overrides specific to this compute node.
(string) --
Environment variable name following POSIX naming rules Must not start with AWS_ prefix (case-insensitive)
(string) --
Environment variable value
requestMountOverrides (dict) --
The mount overrides provided as input for the pipeline execution. Present when mount overrides were supplied at execution time.
computeNodes (dict) --
The mount overrides for each compute node, keyed by compute node name.
(string) --
The compute node name from the pipeline definition.
(list) --
The mount overrides applied to this compute node for this execution. Each entry is merged into the compute node's task-defined mounts by mount name: a matching name replaces the task-defined mount, a new name adds a mount, and task-defined mounts not referenced remain unchanged.
(dict) --
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) --
A unique name for the mount within the task.
relativePath (string) --
The relative path under the service-owned mount root where this mount is attached inside the container.
source (dict) --
The data source for the mount.
s3AccessPoint (dict) --
Configuration for a mount that reads from an Amazon S3 access point.
accessPointArn (string) --
The Amazon Resource Name (ARN) of the S3 access point.
prefix (string) --
An optional key prefix to scope the mount to a subset of objects at the access point.
storageType (string) --
The type of storage used for the mount.
executionPriority (integer) --
Scheduling priority for the execution. When not specified, defaults to lowest priority.
computeNodeExecutionDetails (list) --
A list of compute node execution details within this pipeline execution.
(dict) --
Contains detailed execution information for a compute node within a pipeline execution.
computeNodeName (string) --
The name of the compute node.
taskName (string) --
The name of the task executed for this compute node.
taskArn (string) --
The ARN of the task.
taskVersion (string) --
The task version that executed for this compute node.
dependsOn (list) --
A list of compute node names that this node depends on.
(string) --
Reusable resource name with alphanumeric, hyphen, and underscore characters.
status (dict) --
The current execution status of the compute node.
state (string) --
Current state of the compute node execution.
stateDetails (dict) --
Additional information about the compute node's failure. Populated when the compute node has failed.
code (string) --
Classification of the failure.
message (string) --
Human-readable description of why the compute node failed.
details (list) --
Detailed error entries to help diagnose the failure.
(dict) --
Contains a detailed error entry for granular troubleshooting of pipeline failures.
code (string) --
The error code.
message (string) --
The associated error message.
startTime (datetime) --
The time the compute node execution started, in Unix epoch time.
endTime (datetime) --
The time the compute node execution completed, in Unix epoch time.
executionEnvironmentVariables (dict) --
The fully resolved environment variables used for this compute node execution.
(string) --
The environment variable name.
(string) --
The environment variable value.
executionMounts (list) --
The fully resolved mounts used for this compute node execution, after merging task-defined mounts with any execution-level mount overrides. Each mount attaches an external data source to the container filesystem at a relative path under the service-owned mount root.
(dict) --
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) --
A unique name for the mount within the task.
relativePath (string) --
The relative path under the service-owned mount root where this mount is attached inside the container.
source (dict) --
The data source for the mount.
s3AccessPoint (dict) --
Configuration for a mount that reads from an Amazon S3 access point.
accessPointArn (string) --
The Amazon Resource Name (ARN) of the S3 access point.
prefix (string) --
An optional key prefix to scope the mount to a subset of objects at the access point.
storageType (string) --
The type of storage used for the mount.
nextToken (string) --
The token to be used for the next set of paginated results.
{'taskConfiguration': {'containerTaskConfiguration': {'ephemeralStorageConfiguration': {'storageClass': 'STANDARD_1 '
'| '
'STANDARD_2 '
'| '
'THROUGHPUT_1 '
'| '
'THROUGHPUT_2',
'storageSizeInGiB': 'integer'},
'mounts': [{'name': 'string',
'relativePath': 'string',
'source': {'s3AccessPoint': {'accessPointArn': 'string',
'prefix': 'string'}},
'storageType': 'SHARED_STORAGE'}]}}}
Retrieves detailed information about a specific task in a workspace.
See also: AWS API Documentation
Request Syntax
client.describe_task(
workspaceName='string',
taskName='string',
taskVersion='string'
)
string
[REQUIRED]
The name of the workspace.
string
[REQUIRED]
The name of the task.
string
The version number of the task to retrieve. If not specified, returns the latest version.
dict
Response Syntax
{
'workspaceName': 'string',
'taskName': 'string',
'description': 'string',
'taskArn': 'string',
'version': 'string',
'taskConfiguration': {
'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': 123
},
'command': [
'string',
],
'timeoutSeconds': 123,
'environmentVariables': {
'string': 'string'
},
'mounts': [
{
'name': 'string',
'relativePath': 'string',
'source': {
's3AccessPoint': {
'accessPointArn': 'string',
'prefix': 'string'
}
},
'storageType': 'SHARED_STORAGE'
},
]
}
},
'status': {
'error': {
'code': 'VALIDATION_ERROR'|'INTERNAL_FAILURE',
'message': 'string'
},
'state': 'CREATING'|'ACTIVE'|'UPDATING'|'DELETING'|'FAILED'
},
'createdAt': datetime(2015, 1, 1),
'updatedAt': datetime(2015, 1, 1)
}
Response Structure
(dict) --
Response structure for DescribeTask operation.
workspaceName (string) --
The name of the workspace.
taskName (string) --
The name of the task.
description (string) --
The description of the task.
taskArn (string) --
The ARN of the task.
version (string) --
The version of the task.
taskConfiguration (dict) --
The task execution configuration. Contains a containerTaskConfiguration for custom container workloads.
containerTaskConfiguration (dict) --
Configuration for running a custom container image on managed compute.
ecrUri (string) --
The Amazon ECR image URI for the task container.
taskExecutionRole (string) --
The ARN of the IAM role that grants the containerized workload permissions to access AWS resources.
processingType (string) --
The processing type for compute resources.
processingUnit (string) --
The processing unit allocation that determines the vCPU, memory, and GPU resources.
ephemeralStorageConfiguration (dict) --
Ephemeral storage configuration for the container task.
storageClass (string) --
Storage type that determines I/O performance family and level.
storageSizeInGiB (integer) --
Storage volume size in GiB.
command (list) --
The command to execute in the container.
(string) --
timeoutSeconds (integer) --
The timeout in seconds for task execution. Default: 3600 (1 hour).
environmentVariables (dict) --
Environment variables passed to the container at runtime.
(string) --
Environment variable name following POSIX naming rules Must not start with AWS_ prefix (case-insensitive)
(string) --
Environment variable value
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.
(dict) --
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) --
A unique name for the mount within the task.
relativePath (string) --
The relative path under the service-owned mount root where this mount is attached inside the container.
source (dict) --
The data source for the mount.
s3AccessPoint (dict) --
Configuration for a mount that reads from an Amazon S3 access point.
accessPointArn (string) --
The Amazon Resource Name (ARN) of the S3 access point.
prefix (string) --
An optional key prefix to scope the mount to a subset of objects at the access point.
storageType (string) --
The type of storage used for the mount.
status (dict) --
The current lifecycle status of the task.
error (dict) --
Contains associated error information, if any.
code (string) --
The error code.
message (string) --
The error message.
state (string) --
The current status of the resource.
createdAt (datetime) --
The time the task was created, in Unix epoch time.
updatedAt (datetime) --
The time the task was last updated, in Unix epoch time.
{'executionMountOverrides': {'computeNodes': {'string': [{'name': 'string',
'relativePath': 'string',
'source': {'s3AccessPoint': {'accessPointArn': 'string',
'prefix': 'string'}},
'storageType': 'SHARED_STORAGE'}]}}}
Starts execution of a pipeline in the specified workspace. Each compute node runs according to the DAG dependency order defined in the pipeline. Nodes without dependencies start immediately, while dependent nodes wait for all upstream nodes to complete successfully.
You can provide runtime environment variable overrides that take the highest priority in the environment variable hierarchy, without modifying the pipeline definition.
See also: AWS API Documentation
Request Syntax
client.start_pipeline_execution(
workspaceName='string',
pipelineName='string',
executionEnvironmentVariableOverrides={
'global': {
'string': 'string'
},
'computeNodes': {
'string': {
'string': 'string'
}
}
},
executionMountOverrides={
'computeNodes': {
'string': [
{
'name': 'string',
'relativePath': 'string',
'source': {
's3AccessPoint': {
'accessPointArn': 'string',
'prefix': 'string'
}
},
'storageType': 'SHARED_STORAGE'
},
]
}
},
executionPriority=123,
clientToken='string'
)
string
[REQUIRED]
The name of the workspace containing the pipeline.
string
[REQUIRED]
The name of the pipeline to execute.
dict
Runtime environment variable overrides for the execution. Includes global variables that apply to all compute nodes and computeNodes for per-node overrides. These take the highest priority in the environment variable hierarchy.
global (dict) --
Global environment variables that apply to all compute nodes in the pipeline execution.
(string) --
Environment variable name following POSIX naming rules Must not start with AWS_ prefix (case-insensitive)
(string) --
Environment variable value
computeNodes (dict) --
Per-compute-node environment variable overrides. Each entry maps a compute node name to its environment variable overrides.
(string) --
The compute node name from the pipeline definition.
(dict) --
Environment variable overrides specific to this compute node.
(string) --
Environment variable name following POSIX naming rules Must not start with AWS_ prefix (case-insensitive)
(string) --
Environment variable value
dict
Runtime mount overrides for the execution. Overrides are merged by mount name into each listed compute node's task-defined mounts: a matching name replaces the task-defined mount, a new name adds a mount, and task-defined mounts not referenced remain unchanged. Compute nodes not listed use their task-defined mounts as-is.
computeNodes (dict) -- [REQUIRED]
The mount overrides for each compute node, keyed by compute node name.
(string) --
The compute node name from the pipeline definition.
(list) --
The mount overrides applied to this compute node for this execution. Each entry is merged into the compute node's task-defined mounts by mount name: a matching name replaces the task-defined mount, a new name adds a mount, and task-defined mounts not referenced remain unchanged.
(dict) --
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.
relativePath (string) -- [REQUIRED]
The relative path under the service-owned mount root where this mount is attached inside the container.
source (dict) -- [REQUIRED]
The data source for the mount.
s3AccessPoint (dict) --
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.
prefix (string) --
An optional key prefix to scope the mount to a subset of objects at the access point.
storageType (string) -- [REQUIRED]
The type of storage used for the mount.
integer
Scheduling priority for the execution. Lower values indicate higher priority. Defaults to 2 when not specified.
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.
This field is autopopulated if not provided.
dict
Response Syntax
{
'pipelineExecutionId': 'string'
}
Response Structure
(dict) --
Response structure for StartPipelineExecution operation.
pipelineExecutionId (string) --
The unique identifier of the created pipeline execution.
{'taskConfiguration': {'containerTaskConfiguration': {'ephemeralStorageConfiguration': {'storageClass': 'STANDARD_1 '
'| '
'STANDARD_2 '
'| '
'THROUGHPUT_1 '
'| '
'THROUGHPUT_2',
'storageSizeInGiB': 'integer'},
'mounts': [{'name': 'string',
'relativePath': 'string',
'source': {'s3AccessPoint': {'accessPointArn': 'string',
'prefix': 'string'}},
'storageType': 'SHARED_STORAGE'}]}}}
Updates an existing task in the specified workspace. Only the fields provided in the request are updated; fields not included in the request are preserved unchanged.
See also: AWS API Documentation
Request Syntax
client.update_task(
workspaceName='string',
taskName='string',
description='string',
taskConfiguration={
'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': 123
},
'command': [
'string',
],
'timeoutSeconds': 123,
'environmentVariables': {
'string': 'string'
},
'mounts': [
{
'name': 'string',
'relativePath': 'string',
'source': {
's3AccessPoint': {
'accessPointArn': 'string',
'prefix': 'string'
}
},
'storageType': 'SHARED_STORAGE'
},
]
}
}
)
string
[REQUIRED]
The name of the workspace.
string
[REQUIRED]
The name of the task to update.
string
A new description for the task.
dict
The updated task execution configuration.
containerTaskConfiguration (dict) --
Configuration for running a custom container image on managed compute.
ecrUri (string) -- [REQUIRED]
The Amazon ECR image URI for the task container.
taskExecutionRole (string) -- [REQUIRED]
The ARN of the IAM role that grants the containerized workload permissions to access AWS resources.
processingType (string) -- [REQUIRED]
The processing type for compute resources.
processingUnit (string) -- [REQUIRED]
The processing unit allocation that determines the vCPU, memory, and GPU resources.
ephemeralStorageConfiguration (dict) --
Ephemeral storage configuration for the container task.
storageClass (string) -- [REQUIRED]
Storage type that determines I/O performance family and level.
storageSizeInGiB (integer) -- [REQUIRED]
Storage volume size in GiB.
command (list) --
The command to execute in the container.
(string) --
timeoutSeconds (integer) --
The timeout in seconds for task execution. Default: 3600 (1 hour).
environmentVariables (dict) --
Environment variables passed to the container at runtime.
(string) --
Environment variable name following POSIX naming rules Must not start with AWS_ prefix (case-insensitive)
(string) --
Environment variable value
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.
(dict) --
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.
relativePath (string) -- [REQUIRED]
The relative path under the service-owned mount root where this mount is attached inside the container.
source (dict) -- [REQUIRED]
The data source for the mount.
s3AccessPoint (dict) --
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.
prefix (string) --
An optional key prefix to scope the mount to a subset of objects at the access point.
storageType (string) -- [REQUIRED]
The type of storage used for the mount.
dict
Response Syntax
{
'version': 'string',
'status': {
'error': {
'code': 'VALIDATION_ERROR'|'INTERNAL_FAILURE',
'message': 'string'
},
'state': 'CREATING'|'ACTIVE'|'UPDATING'|'DELETING'|'FAILED'
}
}
Response Structure
(dict) --
Response structure for UpdateTask operation.
version (string) --
The new version of the task created by this update.
status (dict) --
The current lifecycle status of the task.
error (dict) --
Contains associated error information, if any.
code (string) --
The error code.
message (string) --
The error message.
state (string) --
The current status of the resource.