amazonka-ecs-1.4.4: Amazon EC2 Container Service SDK.

Copyright (c) 2013-2016 Brendan Hay Mozilla Public License, v. 2.0. Brendan Hay auto-generated non-portable (GHC extensions) None Haskell2010

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.

Synopsis

# Creating a Request

Arguments

 :: Text rtTaskDefinition -> RunTask

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:

• rtOverrides
• rtCluster
• rtCount
• rtStartedBy
• rtTaskDefinition

See: runTask smart constructor.

Instances

# Request Lenses

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.

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..

The number of instantiations of the specified task to place on your cluster.

The count parameter is limited to 10 tasks per call.

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. Up to 36 letters (uppercase and lowercase), numbers, hyphens, and underscores are allowed.

If a task is started by an Amazon ECS service, then the startedBy parameter contains the deployment ID of the service that starts it.

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 rtrsResponseStatus -> 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:

• rtrsFailures
• rtrsTasks
• rtrsResponseStatus

See: runTaskResponse smart constructor.

Instances

# Response Lenses

Any failures associated with the call.

A full description of the tasks that were run. Each task that was successfully placed on your cluster are described here.

The response status code.