| Safe Haskell | None |
|---|---|
| Language | Haskell2010 |
Network.AWS.ECS.StartTask
Description
Starts a new task from the specified task definition on the specified
container instance or instances. If you want 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.
http://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_StartTask.html
- data StartTask
- startTask :: Text -> StartTask
- st1Cluster :: Lens' StartTask (Maybe Text)
- st1ContainerInstances :: Lens' StartTask [Text]
- st1Overrides :: Lens' StartTask (Maybe TaskOverride)
- st1StartedBy :: Lens' StartTask (Maybe Text)
- st1TaskDefinition :: Lens' StartTask Text
- data StartTaskResponse
- startTaskResponse :: StartTaskResponse
- strFailures :: Lens' StartTaskResponse [Failure]
- strTasks :: Lens' StartTaskResponse [Task]
Request
Request constructor
StartTask constructor.
The fields accessible through corresponding lenses are:
Request lenses
st1Cluster :: Lens' StartTask (Maybe Text) Source
The short name or full Amazon Resource Name (ARN) of the cluster that you want to start your task on. If you do not specify a cluster, the default cluster is assumed..
st1ContainerInstances :: Lens' StartTask [Text] Source
The container instance UUIDs 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.
st1Overrides :: 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 command it should run instead of its default. A total of 8192 characters are allowed for overrides. This limit includes the JSON formatting characters of the override structure.
st1StartedBy :: 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.
st1TaskDefinition :: Lens' StartTask Text Source
The family and revision ('family:revision') or full Amazon Resource Name (ARN)
of the task definition that you want to start.
Response
data StartTaskResponse Source
Response constructor
startTaskResponse :: StartTaskResponse Source
StartTaskResponse constructor.
The fields accessible through corresponding lenses are:
strFailures::[Failure]strTasks::[Task]
Response lenses
strFailures :: Lens' StartTaskResponse [Failure] Source
Any failed tasks from your StartTask action are listed here.
strTasks :: Lens' StartTaskResponse [Task] Source
A full description of the tasks that were started. Each task that was successfully placed on your container instances will be described here.