Network.AWS.ECS.StartTask

Starts a new task from the specified task definition on the specified container instance or instances.

Alternatively, you can use RunTask to place tasks for you. For more information, see Scheduling Tasks in the Amazon Elastic Container Service Developer Guide .

Creating a Request

startTask

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.
• sGroup - 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).
• 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.
• sNetworkConfiguration - The VPC subnet and security group configuration for tasks that receive their own Elastic Network Interface by using the awsvpc networking mode.
• sTaskDefinition - The family and revision (family:revision ) or full 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 ARN entries for the container instances on which you would like to place your task. You can specify up to 10 container instances.

data StartTask

See: startTask smart constructor.

Instances

Eq StartTask

Methods

(==) :: StartTask -> StartTask -> Bool

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

Data StartTask

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

Methods

readsPrec :: Int -> ReadS StartTask

readList :: ReadS [StartTask]

readPrec :: ReadPrec StartTask

readListPrec :: ReadPrec [StartTask]

Show StartTask

Methods

showsPrec :: Int -> StartTask -> ShowS

show :: StartTask -> String

showList :: [StartTask] -> ShowS

Generic StartTask

Associated Types

type Rep StartTask :: * -> *

Methods

from :: StartTask -> Rep StartTask x

to :: Rep StartTask x -> StartTask

Hashable StartTask

Methods

hashWithSalt :: Int -> StartTask -> Int

hash :: StartTask -> Int

ToJSON StartTask

Methods

toJSON :: StartTask -> Value

toEncoding :: StartTask -> Encoding

toJSONList :: [StartTask] -> Value

toEncodingList :: [StartTask] -> Encoding

NFData StartTask

Methods

rnf :: StartTask -> ()

AWSRequest StartTask

Associated Types

type Rs StartTask :: *

Methods

request :: StartTask -> Request StartTask

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

ToHeaders StartTask

Methods

toHeaders :: StartTask -> [Header]

ToPath StartTask

Methods

toPath :: StartTask -> ByteString

ToQuery StartTask

Methods

toQuery :: StartTask -> QueryString

type Rep StartTask

type Rep StartTask = D1 * (MetaData "StartTask" "Network.AWS.ECS.StartTask" "amazonka-ecs-1.6.0-7CQHGOTku8B1VmTRp9KDXq" False) (C1 * (MetaCons "StartTask'" PrefixI True) ((:*:) * ((:*:) * (S1 * (MetaSel (Just Symbol "_sOverrides") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe TaskOverride))) ((:*:) * (S1 * (MetaSel (Just Symbol "_sGroup") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) (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 "_sNetworkConfiguration") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe NetworkConfiguration)))) ((:*:) * (S1 * (MetaSel (Just Symbol "_sTaskDefinition") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * Text)) (S1 * (MetaSel (Just Symbol "_sContainerInstances") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * [Text]))))))

type Rs StartTask

type Rs StartTask = StartTaskResponse

Request Lenses

sOverrides :: Lens' StartTask (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.

sGroup :: Lens' StartTask (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).

sCluster :: Lens' StartTask (Maybe Text)

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)

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.

sNetworkConfiguration :: Lens' StartTask (Maybe NetworkConfiguration)

The VPC subnet and security group configuration for tasks that receive their own Elastic Network Interface by using the awsvpc networking mode.

sTaskDefinition :: Lens' StartTask Text

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

sContainerInstances :: Lens' StartTask [Text]

The container instance IDs or full ARN entries for the container instances on which you would like to place your task. You can specify up to 10 container instances.

Destructuring the Response

startTaskResponse

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 is described.
• strsResponseStatus - -- | The response status code.

data StartTaskResponse

See: startTaskResponse smart constructor.

Instances

Eq StartTaskResponse

Methods

(==) :: StartTaskResponse -> StartTaskResponse -> Bool

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

Data StartTaskResponse

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

Methods

readsPrec :: Int -> ReadS StartTaskResponse

readList :: ReadS [StartTaskResponse]

readPrec :: ReadPrec StartTaskResponse

readListPrec :: ReadPrec [StartTaskResponse]

Show StartTaskResponse

Methods

showsPrec :: Int -> StartTaskResponse -> ShowS

show :: StartTaskResponse -> String

showList :: [StartTaskResponse] -> ShowS

Generic StartTaskResponse

Associated Types

type Rep StartTaskResponse :: * -> *

Methods

from :: StartTaskResponse -> Rep StartTaskResponse x

to :: Rep StartTaskResponse x -> StartTaskResponse

NFData StartTaskResponse

Methods

rnf :: StartTaskResponse -> ()

type Rep StartTaskResponse

type Rep StartTaskResponse = D1 * (MetaData "StartTaskResponse" "Network.AWS.ECS.StartTask" "amazonka-ecs-1.6.0-7CQHGOTku8B1VmTRp9KDXq" 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 DecidedStrict) (Rec0 * Int)))))

Response Lenses

strsFailures :: Lens' StartTaskResponse [Failure]

Any failures associated with the call.

strsTasks :: Lens' StartTaskResponse [Task]

A full description of the tasks that were started. Each task that was successfully placed on your container instances is described.

strsResponseStatus :: Lens' StartTaskResponse Int

• - | The response status code.