Network.AWS.ECS.RunTask

Starts a new task using the specified task definition.

You can allow Amazon ECS to place tasks for you, or you can customize how Amazon ECS places tasks using placement constraints and placement strategies. For more information, see Scheduling Tasks in the Amazon Elastic Container Service Developer Guide .

Alternatively, you can use StartTask to use your own scheduler or place tasks manually on specific container instances.

The Amazon ECS API follows an eventual consistency model, due to the distributed nature of the system supporting the API. This means that the result of an API command you run that affects your Amazon ECS resources might not be immediately visible to all subsequent commands you run. You should keep this in mind when you carry out an API command that immediately follows a previous API command.

To manage eventual consistency, you can do the following:

• Confirm the state of the resource before you run a command to modify it. Run the DescribeTasks command using an exponential backoff algorithm to ensure that you allow enough time for the previous command to propagate through the system. To do this, run the DescribeTasks command repeatedly, starting with a couple of seconds of wait time, and increasing gradually up to five minutes of wait time.
• Add wait time between subsequent commands, even if the DescribeTasks command returns an accurate response. Apply an exponential backoff algorithm starting with a couple of seconds of wait time, and increase gradually up to about five minutes of wait time.

Creating a Request

runTask

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 - 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.
• rtGroup - The name of the task group to associate with the task. The default value is the family name of the task definition (for example, family:my-family-name).
• rtCluster - 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.
• rtPlatformVersion - The platform version on which to run your task. If one is not specified, the latest version is used by default.
• rtCount - The number of instantiations of the specified task to place on your cluster. You can specify up to 10 tasks per call.
• rtPlacementConstraints - An array of placement constraint objects to use for the task. You can specify up to 10 constraints per task (including constraints in the task definition and those specified at run time).
• rtPlacementStrategy - The placement strategy objects to use for the task. You can specify a maximum of five strategy rules per task.
• rtStartedBy - 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.
• rtLaunchType - The launch type on which to run your task.
• rtNetworkConfiguration - The network configuration for the task. This parameter is required for task definitions that use the awsvpc network mode to receive their own Elastic Network Interface, and it is not supported for other network modes. For more information, see Task Networking in the Amazon Elastic Container Service Developer Guide .
• rtTaskDefinition - The family and revision (family:revision ) or full ARN of the task definition to run. If a revision is not specified, the latest ACTIVE revision is used.

data RunTask

See: runTask smart constructor.

Instances

Eq RunTask

Methods

(==) :: RunTask -> RunTask -> Bool

(/=) :: RunTask -> RunTask -> Bool

Data RunTask

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> RunTask -> c RunTask

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c RunTask

toConstr :: RunTask -> Constr

dataTypeOf :: RunTask -> DataType

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c RunTask)

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c RunTask)

gmapT :: (forall b. Data b => b -> b) -> RunTask -> RunTask

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> RunTask -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> RunTask -> r

gmapQ :: (forall d. Data d => d -> u) -> RunTask -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> RunTask -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> RunTask -> m RunTask

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> RunTask -> m RunTask

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> RunTask -> m RunTask

Read RunTask

Methods

readsPrec :: Int -> ReadS RunTask

readList :: ReadS [RunTask]

readPrec :: ReadPrec RunTask

readListPrec :: ReadPrec [RunTask]

Show RunTask

Methods

showsPrec :: Int -> RunTask -> ShowS

show :: RunTask -> String

showList :: [RunTask] -> ShowS

Generic RunTask

Associated Types

type Rep RunTask :: * -> *

Methods

from :: RunTask -> Rep RunTask x

to :: Rep RunTask x -> RunTask

Hashable RunTask

Methods

hashWithSalt :: Int -> RunTask -> Int

hash :: RunTask -> Int

ToJSON RunTask

Methods

toJSON :: RunTask -> Value

toEncoding :: RunTask -> Encoding

toJSONList :: [RunTask] -> Value

toEncodingList :: [RunTask] -> Encoding

NFData RunTask

Methods

rnf :: RunTask -> ()

AWSRequest RunTask

Associated Types

type Rs RunTask :: *

Methods

request :: RunTask -> Request RunTask

response :: (MonadResource m, MonadThrow m) => Logger -> Service -> Proxy * RunTask -> ClientResponse -> m (Response RunTask)

ToHeaders RunTask

Methods

toHeaders :: RunTask -> [Header]

ToPath RunTask

Methods

toPath :: RunTask -> ByteString

ToQuery RunTask

Methods

toQuery :: RunTask -> QueryString

type Rep RunTask

type Rep RunTask = D1 * (MetaData "RunTask" "Network.AWS.ECS.RunTask" "amazonka-ecs-1.6.0-7CQHGOTku8B1VmTRp9KDXq" False) (C1 * (MetaCons "RunTask'" PrefixI True) ((:*:) * ((:*:) * ((:*:) * (S1 * (MetaSel (Just Symbol "_rtOverrides") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe TaskOverride))) (S1 * (MetaSel (Just Symbol "_rtGroup") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text)))) ((:*:) * (S1 * (MetaSel (Just Symbol "_rtCluster") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) ((:*:) * (S1 * (MetaSel (Just Symbol "_rtPlatformVersion") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) (S1 * (MetaSel (Just Symbol "_rtCount") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Int)))))) ((:*:) * ((:*:) * (S1 * (MetaSel (Just Symbol "_rtPlacementConstraints") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe [PlacementConstraint]))) ((:*:) * (S1 * (MetaSel (Just Symbol "_rtPlacementStrategy") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe [PlacementStrategy]))) (S1 * (MetaSel (Just Symbol "_rtStartedBy") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))))) ((:*:) * (S1 * (MetaSel (Just Symbol "_rtLaunchType") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe LaunchType))) ((:*:) * (S1 * (MetaSel (Just Symbol "_rtNetworkConfiguration") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe NetworkConfiguration))) (S1 * (MetaSel (Just Symbol "_rtTaskDefinition") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * Text)))))))

type Rs RunTask

type Rs RunTask = RunTaskResponse

Request Lenses

rtOverrides :: Lens' RunTask (Maybe TaskOverride)

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.

rtGroup :: Lens' RunTask (Maybe Text)

The name of the task group to associate with the task. The default value is the family name of the task definition (for example, family:my-family-name).

rtCluster :: Lens' RunTask (Maybe Text)

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.

rtPlatformVersion :: Lens' RunTask (Maybe Text)

The platform version on which to run your task. If one is not specified, the latest version is used by default.

rtCount :: Lens' RunTask (Maybe Int)

The number of instantiations of the specified task to place on your cluster. You can specify up to 10 tasks per call.

rtPlacementConstraints :: Lens' RunTask [PlacementConstraint]

An array of placement constraint objects to use for the task. You can specify up to 10 constraints per task (including constraints in the task definition and those specified at run time).

rtPlacementStrategy :: Lens' RunTask [PlacementStrategy]

The placement strategy objects to use for the task. You can specify a maximum of five strategy rules per task.

rtStartedBy :: Lens' RunTask (Maybe Text)

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.

rtLaunchType :: Lens' RunTask (Maybe LaunchType)

The launch type on which to run your task.

rtNetworkConfiguration :: Lens' RunTask (Maybe NetworkConfiguration)

The network configuration for the task. This parameter is required for task definitions that use the awsvpc network mode to receive their own Elastic Network Interface, and it is not supported for other network modes. For more information, see Task Networking in the Amazon Elastic Container Service Developer Guide .

rtTaskDefinition :: Lens' RunTask Text

The family and revision (family:revision ) or full ARN of the task definition to run. If a revision is not specified, the latest ACTIVE revision is used.

Destructuring the Response

runTaskResponse

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 - Any failures associated with the call.
• rtrsTasks - A full description of the tasks that were run. The tasks that were successfully placed on your cluster are described here.
• rtrsResponseStatus - -- | The response status code.

data RunTaskResponse

See: runTaskResponse smart constructor.

Instances

Eq RunTaskResponse

Methods

(==) :: RunTaskResponse -> RunTaskResponse -> Bool

(/=) :: RunTaskResponse -> RunTaskResponse -> Bool

Data RunTaskResponse

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> RunTaskResponse -> c RunTaskResponse

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c RunTaskResponse

toConstr :: RunTaskResponse -> Constr

dataTypeOf :: RunTaskResponse -> DataType

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c RunTaskResponse)

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c RunTaskResponse)

gmapT :: (forall b. Data b => b -> b) -> RunTaskResponse -> RunTaskResponse

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> RunTaskResponse -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> RunTaskResponse -> r

gmapQ :: (forall d. Data d => d -> u) -> RunTaskResponse -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> RunTaskResponse -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> RunTaskResponse -> m RunTaskResponse

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> RunTaskResponse -> m RunTaskResponse

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> RunTaskResponse -> m RunTaskResponse

Read RunTaskResponse

Methods

readsPrec :: Int -> ReadS RunTaskResponse

readList :: ReadS [RunTaskResponse]

readPrec :: ReadPrec RunTaskResponse

readListPrec :: ReadPrec [RunTaskResponse]

Show RunTaskResponse

Methods

showsPrec :: Int -> RunTaskResponse -> ShowS

show :: RunTaskResponse -> String

showList :: [RunTaskResponse] -> ShowS

Generic RunTaskResponse

Associated Types

type Rep RunTaskResponse :: * -> *

Methods

from :: RunTaskResponse -> Rep RunTaskResponse x

to :: Rep RunTaskResponse x -> RunTaskResponse

NFData RunTaskResponse

Methods

rnf :: RunTaskResponse -> ()

type Rep RunTaskResponse

type Rep RunTaskResponse = D1 * (MetaData "RunTaskResponse" "Network.AWS.ECS.RunTask" "amazonka-ecs-1.6.0-7CQHGOTku8B1VmTRp9KDXq" False) (C1 * (MetaCons "RunTaskResponse'" PrefixI True) ((:*:) * (S1 * (MetaSel (Just Symbol "_rtrsFailures") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe [Failure]))) ((:*:) * (S1 * (MetaSel (Just Symbol "_rtrsTasks") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe [Task]))) (S1 * (MetaSel (Just Symbol "_rtrsResponseStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * Int)))))

Response Lenses

rtrsFailures :: Lens' RunTaskResponse [Failure]

Any failures associated with the call.

rtrsTasks :: Lens' RunTaskResponse [Task]

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

rtrsResponseStatus :: Lens' RunTaskResponse Int

• - | The response status code.