| Copyright | (c) 2013-2015 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 |
Network.AWS.ECS.RunTask
Description
Start a task using random placement and the default Amazon ECS
scheduler. To use your own scheduler or place a task on a specific
container instance, use StartTask instead.
The count parameter is limited to 10 tasks per call.
See: AWS API Reference for RunTask.
- runTask :: Text -> RunTask
- data RunTask
- rtOverrides :: Lens' RunTask (Maybe TaskOverride)
- rtCluster :: Lens' RunTask (Maybe Text)
- rtCount :: Lens' RunTask (Maybe Int)
- rtStartedBy :: Lens' RunTask (Maybe Text)
- rtTaskDefinition :: Lens' RunTask Text
- runTaskResponse :: Int -> RunTaskResponse
- data RunTaskResponse
- rtrsFailures :: Lens' RunTaskResponse [Failure]
- rtrsTasks :: Lens' RunTaskResponse [Task]
- rtrsResponseStatus :: Lens' RunTaskResponse Int
Creating a Request
Creates a value of RunTask with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
See: runTask smart constructor.
Request Lenses
rtOverrides :: Lens' RunTask (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.
rtCluster :: Lens' RunTask (Maybe Text) Source
The short name or full Amazon Resource Name (ARN) of the cluster on which to run your task. If you do not specify a cluster, the default cluster is assumed..
rtCount :: Lens' RunTask (Maybe Int) Source
The number of instantiations of the specified task to place on your cluster.
The count parameter is limited to 10 tasks per call.
rtStartedBy :: Lens' RunTask (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.
rtTaskDefinition :: Lens' RunTask Text Source
The family and revision ('family:revision') or full Amazon Resource
Name (ARN) of the task definition to run. If a revision is not
specified, the latest ACTIVE revision is used.
Destructuring the Response
Arguments
| :: Int | |
| -> RunTaskResponse |
Creates a value of RunTaskResponse with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
data RunTaskResponse Source
See: runTaskResponse smart constructor.
Response Lenses
rtrsFailures :: Lens' RunTaskResponse [Failure] Source
Any failures associated with the call.
rtrsTasks :: Lens' RunTaskResponse [Task] Source
A full description of the tasks that were run. Each task that was successfully placed on your cluster are described here.
rtrsResponseStatus :: Lens' RunTaskResponse Int Source
The response status code.