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

Network.AWS.ECS.StartTask

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

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.

Important: The list of container instances to start tasks on is limited to 10.

Synopsis

Creating a Request

startTask Source #

Arguments

:: Text	`sTaskDefinition`
-> StartTask

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:

sOverrides - 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.
sCluster - 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 - 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.
sTaskDefinition - 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 - The container instance IDs or full Amazon Resource Name (ARN) entries for the container instances on which you would like to place your task. Important: The list of container instances to start tasks on is limited to 10.

data StartTask Source #

See: startTask smart constructor.

Instances

Eq StartTask Source #
Methods (==) :: StartTask -> StartTask -> Bool # (/=) :: StartTask -> StartTask -> Bool #
Data StartTask Source #
Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> StartTask -> c StartTask # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c StartTask # toConstr :: StartTask -> Constr # dataTypeOf :: StartTask -> DataType # dataCast1 :: Typeable (* -> ) t => (forall d. Data d => c (t d)) -> Maybe (c StartTask) # dataCast2 :: Typeable ( -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c StartTask) # gmapT :: (forall b. Data b => b -> b) -> StartTask -> StartTask # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> StartTask -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> StartTask -> r # gmapQ :: (forall d. Data d => d -> u) -> StartTask -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> StartTask -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> StartTask -> m StartTask # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> StartTask -> m StartTask # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> StartTask -> m StartTask #
Read StartTask Source #
Methods readsPrec :: Int -> ReadS StartTask # readList :: ReadS [StartTask] # readPrec :: ReadPrec StartTask # readListPrec :: ReadPrec [StartTask] #
Show StartTask Source #
Methods showsPrec :: Int -> StartTask -> ShowS # show :: StartTask -> String # showList :: [StartTask] -> ShowS #
Generic StartTask Source #
Associated Types type Rep StartTask :: * -> * # Methods from :: StartTask -> Rep StartTask x # to :: Rep StartTask x -> StartTask #
Hashable StartTask Source #
Methods hashWithSalt :: Int -> StartTask -> Int # hash :: StartTask -> Int #
ToJSON StartTask Source #
Methods toJSON :: StartTask -> Value # toEncoding :: StartTask -> Encoding # toJSONList :: [StartTask] -> Value # toEncodingList :: [StartTask] -> Encoding #
NFData StartTask Source #
Methods rnf :: StartTask -> () #
AWSRequest StartTask Source #
Associated Types type Rs StartTask :: * # Methods request :: StartTask -> Request StartTask # response :: MonadResource m => Logger -> Service -> Proxy * StartTask -> ClientResponse -> m (Response StartTask) #
ToPath StartTask Source #
Methods toPath :: StartTask -> ByteString #
ToHeaders StartTask Source #
Methods toHeaders :: StartTask -> [Header] #
ToQuery StartTask Source #
Methods toQuery :: StartTask -> QueryString #
type Rep StartTask Source #
type Rep StartTask = D1 (MetaData "StartTask" "Network.AWS.ECS.StartTask" "amazonka-ecs-1.4.5-DjgJB2IQNRjDmlzh0CCqbS" False) (C1 (MetaCons "StartTask'" PrefixI True) ((::) ((::) (S1 (MetaSel (Just Symbol "_sOverrides") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe TaskOverride))) (S1 (MetaSel (Just Symbol "_sCluster") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)))) ((::) (S1 (MetaSel (Just Symbol "_sStartedBy") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) ((::) (S1 (MetaSel (Just Symbol "_sTaskDefinition") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text)) (S1 (MetaSel (Just Symbol "_sContainerInstances") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 [Text]))))))
type Rs StartTask Source #
type Rs StartTask = StartTaskResponse

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.

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

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. Important: The list of container instances to start tasks on is limited to 10.

Destructuring the Response

startTaskResponse Source #

Arguments

:: Int	`strsResponseStatus`
-> StartTaskResponse

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:

strsFailures - Any failures associated with the call.
strsTasks - A full description of the tasks that were started. Each task that was successfully placed on your container instances are described here.
strsResponseStatus - -- | The response status code.

data StartTaskResponse Source #

See: startTaskResponse smart constructor.

Instances

Eq StartTaskResponse Source #
Methods (==) :: StartTaskResponse -> StartTaskResponse -> Bool # (/=) :: StartTaskResponse -> StartTaskResponse -> Bool #
Data StartTaskResponse Source #
Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> StartTaskResponse -> c StartTaskResponse # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c StartTaskResponse # toConstr :: StartTaskResponse -> Constr # dataTypeOf :: StartTaskResponse -> DataType # dataCast1 :: Typeable (* -> ) t => (forall d. Data d => c (t d)) -> Maybe (c StartTaskResponse) # dataCast2 :: Typeable ( -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c StartTaskResponse) # gmapT :: (forall b. Data b => b -> b) -> StartTaskResponse -> StartTaskResponse # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> StartTaskResponse -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> StartTaskResponse -> r # gmapQ :: (forall d. Data d => d -> u) -> StartTaskResponse -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> StartTaskResponse -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> StartTaskResponse -> m StartTaskResponse # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> StartTaskResponse -> m StartTaskResponse # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> StartTaskResponse -> m StartTaskResponse #
Read StartTaskResponse Source #
Methods readsPrec :: Int -> ReadS StartTaskResponse # readList :: ReadS [StartTaskResponse] # readPrec :: ReadPrec StartTaskResponse # readListPrec :: ReadPrec [StartTaskResponse] #
Show StartTaskResponse Source #
Methods showsPrec :: Int -> StartTaskResponse -> ShowS # show :: StartTaskResponse -> String # showList :: [StartTaskResponse] -> ShowS #
Generic StartTaskResponse Source #
Associated Types type Rep StartTaskResponse :: * -> * # Methods from :: StartTaskResponse -> Rep StartTaskResponse x # to :: Rep StartTaskResponse x -> StartTaskResponse #
NFData StartTaskResponse Source #
Methods rnf :: StartTaskResponse -> () #
type Rep StartTaskResponse Source #
type Rep StartTaskResponse = D1 (MetaData "StartTaskResponse" "Network.AWS.ECS.StartTask" "amazonka-ecs-1.4.5-DjgJB2IQNRjDmlzh0CCqbS" False) (C1 (MetaCons "StartTaskResponse'" PrefixI True) ((::) (S1 (MetaSel (Just Symbol "_strsFailures") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [Failure]))) ((::) (S1 (MetaSel (Just Symbol "_strsTasks") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [Task]))) (S1 (MetaSel (Just Symbol "_strsResponseStatus") NoSourceUnpackedness SourceStrict DecidedUnpack) (Rec0 Int)))))

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.