Copyright | (c) 2013-2016 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay <brendan.g.hay@gmail.com> |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | None |
Language | Haskell2010 |
Starts a new task from the specified task definition on the specified
container instance or instances. To use the default Amazon ECS scheduler
to place your task, use RunTask
instead.
The list of container instances to start tasks on is limited to 10.
- startTask :: Text -> StartTask
- data StartTask
- sOverrides :: Lens' StartTask (Maybe TaskOverride)
- sCluster :: Lens' StartTask (Maybe Text)
- sStartedBy :: Lens' StartTask (Maybe Text)
- sTaskDefinition :: Lens' StartTask Text
- sContainerInstances :: Lens' StartTask [Text]
- startTaskResponse :: Int -> StartTaskResponse
- data StartTaskResponse
- strsFailures :: Lens' StartTaskResponse [Failure]
- strsTasks :: Lens' StartTaskResponse [Task]
- strsResponseStatus :: Lens' StartTaskResponse Int
Creating a Request
Creates a value of StartTask
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
See: startTask
smart constructor.
Request Lenses
sOverrides :: Lens' StartTask (Maybe TaskOverride) Source
A list of container overrides in JSON format that specify the name of a
container in the specified task definition and the overrides it should
receive. You can override the default command for a container (that is
specified in the task definition or Docker image) with a command
override. You can also override existing environment variables (that are
specified in the task definition or Docker image) on a container or add
new environment variables to it with an environment
override.
A total of 8192 characters are allowed for overrides. This limit includes the JSON formatting characters of the override structure.
sCluster :: Lens' StartTask (Maybe Text) Source
The short name or full Amazon Resource Name (ARN) of the cluster on which to start your task. If you do not specify a cluster, the default cluster is assumed..
sStartedBy :: Lens' StartTask (Maybe Text) Source
An optional tag specified when a task is started. For example if you
automatically trigger a task to run a batch process job, you could apply
a unique identifier for that job to your task with the startedBy
parameter. You can then identify which tasks belong to that job by
filtering the results of a ListTasks call with the startedBy
value.
If a task is started by an Amazon ECS service, then the startedBy
parameter contains the deployment ID of the service that starts it.
sTaskDefinition :: Lens' StartTask Text Source
The family
and revision
('family:revision') or full Amazon Resource
Name (ARN) of the task definition to start. If a revision
is not
specified, the latest ACTIVE
revision is used.
sContainerInstances :: Lens' StartTask [Text] Source
The container instance IDs or full Amazon Resource Name (ARN) entries for the container instances on which you would like to place your task.
The list of container instances to start tasks on is limited to 10.
Destructuring the Response
Creates a value of StartTaskResponse
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
data StartTaskResponse Source
See: startTaskResponse
smart constructor.
Response Lenses
strsFailures :: Lens' StartTaskResponse [Failure] Source
Any failures associated with the call.
strsTasks :: Lens' StartTaskResponse [Task] Source
A full description of the tasks that were started. Each task that was successfully placed on your container instances are described here.
strsResponseStatus :: Lens' StartTaskResponse Int Source
The response status code.