| Copyright | (c) 2013-2023 Brendan Hay |
|---|---|
| License | Mozilla Public License, v. 2.0. |
| Maintainer | Brendan Hay |
| Stability | auto-generated |
| Portability | non-portable (GHC extensions) |
| Safe Haskell | Safe-Inferred |
| Language | Haskell2010 |
Amazonka.ECS.RunTask
Description
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. This is because of 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. 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.
Synopsis
- data RunTask = RunTask' {
- capacityProviderStrategy :: Maybe [CapacityProviderStrategyItem]
- cluster :: Maybe Text
- count :: Maybe Int
- enableECSManagedTags :: Maybe Bool
- enableExecuteCommand :: Maybe Bool
- group' :: Maybe Text
- launchType :: Maybe LaunchType
- networkConfiguration :: Maybe NetworkConfiguration
- overrides :: Maybe TaskOverride
- placementConstraints :: Maybe [PlacementConstraint]
- placementStrategy :: Maybe [PlacementStrategy]
- platformVersion :: Maybe Text
- propagateTags :: Maybe PropagateTags
- referenceId :: Maybe Text
- startedBy :: Maybe Text
- tags :: Maybe [Tag]
- taskDefinition :: Text
- newRunTask :: Text -> RunTask
- runTask_capacityProviderStrategy :: Lens' RunTask (Maybe [CapacityProviderStrategyItem])
- runTask_cluster :: Lens' RunTask (Maybe Text)
- runTask_count :: Lens' RunTask (Maybe Int)
- runTask_enableECSManagedTags :: Lens' RunTask (Maybe Bool)
- runTask_enableExecuteCommand :: Lens' RunTask (Maybe Bool)
- runTask_group :: Lens' RunTask (Maybe Text)
- runTask_launchType :: Lens' RunTask (Maybe LaunchType)
- runTask_networkConfiguration :: Lens' RunTask (Maybe NetworkConfiguration)
- runTask_overrides :: Lens' RunTask (Maybe TaskOverride)
- runTask_placementConstraints :: Lens' RunTask (Maybe [PlacementConstraint])
- runTask_placementStrategy :: Lens' RunTask (Maybe [PlacementStrategy])
- runTask_platformVersion :: Lens' RunTask (Maybe Text)
- runTask_propagateTags :: Lens' RunTask (Maybe PropagateTags)
- runTask_referenceId :: Lens' RunTask (Maybe Text)
- runTask_startedBy :: Lens' RunTask (Maybe Text)
- runTask_tags :: Lens' RunTask (Maybe [Tag])
- runTask_taskDefinition :: Lens' RunTask Text
- data RunTaskResponse = RunTaskResponse' {}
- newRunTaskResponse :: Int -> RunTaskResponse
- runTaskResponse_failures :: Lens' RunTaskResponse (Maybe [Failure])
- runTaskResponse_tasks :: Lens' RunTaskResponse (Maybe [Task])
- runTaskResponse_httpStatus :: Lens' RunTaskResponse Int
Creating a Request
See: newRunTask smart constructor.
Constructors
| RunTask' | |
Fields
| |
Instances
Create a value of RunTask with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
RunTask, runTask_capacityProviderStrategy - The capacity provider strategy to use for the task.
If a capacityProviderStrategy is specified, the launchType parameter
must be omitted. If no capacityProviderStrategy or launchType is
specified, the defaultCapacityProviderStrategy for the cluster is
used.
When you use cluster auto scaling, you must specify
capacityProviderStrategy and not launchType.
A capacity provider strategy may contain a maximum of 6 capacity providers.
$sel:cluster:RunTask', runTask_cluster - The short name or full Amazon Resource Name (ARN) of the cluster to run
your task on. If you do not specify a cluster, the default cluster is
assumed.
$sel:count:RunTask', runTask_count - The number of instantiations of the specified task to place on your
cluster. You can specify up to 10 tasks for each call.
RunTask, runTask_enableECSManagedTags - Specifies whether to use Amazon ECS managed tags for the task. For more
information, see
Tagging Your Amazon ECS Resources
in the Amazon Elastic Container Service Developer Guide.
RunTask, runTask_enableExecuteCommand - Determines whether to use the execute command functionality for the
containers in this task. If true, this enables execute command
functionality on all containers in the task.
If true, then the task definition must have a task role, or you must
provide one as an override.
RunTask, runTask_group - 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).
RunTask, runTask_launchType - The infrastructure to run your standalone task on. For more information,
see
Amazon ECS launch types
in the Amazon Elastic Container Service Developer Guide.
The FARGATE launch type runs your tasks on Fargate On-Demand
infrastructure.
Fargate Spot infrastructure is available for use but a capacity provider strategy must be used. For more information, see Fargate capacity providers in the Amazon ECS User Guide for Fargate.
The EC2 launch type runs your tasks on Amazon EC2 instances registered
to your cluster.
The EXTERNAL launch type runs your tasks on your on-premises server or
virtual machine (VM) capacity registered to your cluster.
A task can use either a launch type or a capacity provider strategy. If
a launchType is specified, the capacityProviderStrategy parameter
must be omitted.
When you use cluster auto scaling, you must specify
capacityProviderStrategy and not launchType.
RunTask, runTask_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 isn't supported for other network
modes. For more information, see
Task networking
in the Amazon Elastic Container Service Developer Guide.
RunTask, runTask_overrides - 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's
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.
RunTask, runTask_placementConstraints - An array of placement constraint objects to use for the task. You can
specify up to 10 constraints for each task (including constraints in the
task definition and those specified at runtime).
RunTask, runTask_placementStrategy - The placement strategy objects to use for the task. You can specify a
maximum of 5 strategy rules for each task.
RunTask, runTask_platformVersion - The platform version the task uses. A platform version is only specified
for tasks hosted on Fargate. If one isn't specified, the LATEST
platform version is used. For more information, see
Fargate platform versions
in the Amazon Elastic Container Service Developer Guide.
RunTask, runTask_propagateTags - Specifies whether to propagate the tags from the task definition to the
task. If no value is specified, the tags aren't propagated. Tags can
only be propagated to the task during task creation. To add tags to a
task after task creation, use the TagResource API action.
An error will be received if you specify the SERVICE option when
running a task.
$sel:referenceId:RunTask', runTask_referenceId - The reference ID to use for the task. The reference ID can have a
maximum length of 1024 characters.
RunTask, runTask_startedBy - 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.
RunTask, runTask_tags - The metadata that you apply to the task to help you categorize and
organize them. Each tag consists of a key and an optional value, both of
which you define.
The following basic restrictions apply to tags:
- Maximum number of tags per resource - 50
- For each resource, each tag key must be unique, and each tag key can have only one value.
- Maximum key length - 128 Unicode characters in UTF-8
- Maximum value length - 256 Unicode characters in UTF-8
- If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.
- Tag keys and values are case-sensitive.
- Do not use
aws:,AWS:, or any upper or lowercase combination of such as a prefix for either keys or values as it is reserved for Amazon Web Services use. You cannot edit or delete tag keys or values with this prefix. Tags with this prefix do not count against your tags per resource limit.
RunTask, runTask_taskDefinition - The family and revision (family:revision) or full ARN of the task
definition to run. If a revision isn't specified, the latest ACTIVE
revision is used.
When you create an IAM policy for run-task, you can set the resource to be the latest task definition revision, or a specific revision.
The full ARN value must match the value that you specified as the
Resource of the IAM principal's permissions policy.
When you specify the policy resource as the latest task definition
version (by setting the Resource in the policy to
arn:aws:ecs:us-east-1:111122223333:task-definition/TaskFamilyName),
then set this value to
arn:aws:ecs:us-east-1:111122223333:task-definition/TaskFamilyName.
When you specify the policy resource as a specific task definition
version (by setting the Resource in the policy to
arn:aws:ecs:us-east-1:111122223333:task-definition/TaskFamilyName:1
or
arn:aws:ecs:us-east-1:111122223333:task-definition/TaskFamilyName:*),
then set this value to
arn:aws:ecs:us-east-1:111122223333:task-definition/TaskFamilyName:1.
For more information, see Policy Resources for Amazon ECS in the Amazon Elastic Container Service developer Guide.
Request Lenses
runTask_capacityProviderStrategy :: Lens' RunTask (Maybe [CapacityProviderStrategyItem]) Source #
The capacity provider strategy to use for the task.
If a capacityProviderStrategy is specified, the launchType parameter
must be omitted. If no capacityProviderStrategy or launchType is
specified, the defaultCapacityProviderStrategy for the cluster is
used.
When you use cluster auto scaling, you must specify
capacityProviderStrategy and not launchType.
A capacity provider strategy may contain a maximum of 6 capacity providers.
runTask_cluster :: Lens' RunTask (Maybe Text) Source #
The short name or full Amazon Resource Name (ARN) of the cluster to run your task on. If you do not specify a cluster, the default cluster is assumed.
runTask_count :: Lens' RunTask (Maybe Int) Source #
The number of instantiations of the specified task to place on your cluster. You can specify up to 10 tasks for each call.
runTask_enableECSManagedTags :: Lens' RunTask (Maybe Bool) Source #
Specifies whether to use Amazon ECS managed tags for the task. For more information, see Tagging Your Amazon ECS Resources in the Amazon Elastic Container Service Developer Guide.
runTask_enableExecuteCommand :: Lens' RunTask (Maybe Bool) Source #
Determines whether to use the execute command functionality for the
containers in this task. If true, this enables execute command
functionality on all containers in the task.
If true, then the task definition must have a task role, or you must
provide one as an override.
runTask_group :: Lens' RunTask (Maybe Text) Source #
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).
runTask_launchType :: Lens' RunTask (Maybe LaunchType) Source #
The infrastructure to run your standalone task on. For more information, see Amazon ECS launch types in the Amazon Elastic Container Service Developer Guide.
The FARGATE launch type runs your tasks on Fargate On-Demand
infrastructure.
Fargate Spot infrastructure is available for use but a capacity provider strategy must be used. For more information, see Fargate capacity providers in the Amazon ECS User Guide for Fargate.
The EC2 launch type runs your tasks on Amazon EC2 instances registered
to your cluster.
The EXTERNAL launch type runs your tasks on your on-premises server or
virtual machine (VM) capacity registered to your cluster.
A task can use either a launch type or a capacity provider strategy. If
a launchType is specified, the capacityProviderStrategy parameter
must be omitted.
When you use cluster auto scaling, you must specify
capacityProviderStrategy and not launchType.
runTask_networkConfiguration :: Lens' RunTask (Maybe NetworkConfiguration) Source #
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 isn't supported for other network
modes. For more information, see
Task networking
in the Amazon Elastic Container Service Developer Guide.
runTask_overrides :: 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's
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.
runTask_placementConstraints :: Lens' RunTask (Maybe [PlacementConstraint]) Source #
An array of placement constraint objects to use for the task. You can specify up to 10 constraints for each task (including constraints in the task definition and those specified at runtime).
runTask_placementStrategy :: Lens' RunTask (Maybe [PlacementStrategy]) Source #
The placement strategy objects to use for the task. You can specify a maximum of 5 strategy rules for each task.
runTask_platformVersion :: Lens' RunTask (Maybe Text) Source #
The platform version the task uses. A platform version is only specified
for tasks hosted on Fargate. If one isn't specified, the LATEST
platform version is used. For more information, see
Fargate platform versions
in the Amazon Elastic Container Service Developer Guide.
runTask_propagateTags :: Lens' RunTask (Maybe PropagateTags) Source #
Specifies whether to propagate the tags from the task definition to the task. If no value is specified, the tags aren't propagated. Tags can only be propagated to the task during task creation. To add tags to a task after task creation, use the TagResource API action.
An error will be received if you specify the SERVICE option when
running a task.
runTask_referenceId :: Lens' RunTask (Maybe Text) Source #
The reference ID to use for the task. The reference ID can have a maximum length of 1024 characters.
runTask_startedBy :: 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. 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.
runTask_tags :: Lens' RunTask (Maybe [Tag]) Source #
The metadata that you apply to the task to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define.
The following basic restrictions apply to tags:
- Maximum number of tags per resource - 50
- For each resource, each tag key must be unique, and each tag key can have only one value.
- Maximum key length - 128 Unicode characters in UTF-8
- Maximum value length - 256 Unicode characters in UTF-8
- If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.
- Tag keys and values are case-sensitive.
- Do not use
aws:,AWS:, or any upper or lowercase combination of such as a prefix for either keys or values as it is reserved for Amazon Web Services use. You cannot edit or delete tag keys or values with this prefix. Tags with this prefix do not count against your tags per resource limit.
runTask_taskDefinition :: Lens' RunTask Text Source #
The family and revision (family:revision) or full ARN of the task
definition to run. If a revision isn't specified, the latest ACTIVE
revision is used.
When you create an IAM policy for run-task, you can set the resource to be the latest task definition revision, or a specific revision.
The full ARN value must match the value that you specified as the
Resource of the IAM principal's permissions policy.
When you specify the policy resource as the latest task definition
version (by setting the Resource in the policy to
arn:aws:ecs:us-east-1:111122223333:task-definition/TaskFamilyName),
then set this value to
arn:aws:ecs:us-east-1:111122223333:task-definition/TaskFamilyName.
When you specify the policy resource as a specific task definition
version (by setting the Resource in the policy to
arn:aws:ecs:us-east-1:111122223333:task-definition/TaskFamilyName:1
or
arn:aws:ecs:us-east-1:111122223333:task-definition/TaskFamilyName:*),
then set this value to
arn:aws:ecs:us-east-1:111122223333:task-definition/TaskFamilyName:1.
For more information, see Policy Resources for Amazon ECS in the Amazon Elastic Container Service developer Guide.
Destructuring the Response
data RunTaskResponse Source #
See: newRunTaskResponse smart constructor.
Constructors
| RunTaskResponse' | |
Instances
Arguments
| :: Int | |
| -> RunTaskResponse |
Create a value of RunTaskResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:failures:RunTaskResponse', runTaskResponse_failures - Any failures associated with the call.
$sel:tasks:RunTaskResponse', runTaskResponse_tasks - A full description of the tasks that were run. The tasks that were
successfully placed on your cluster are described here.
$sel:httpStatus:RunTaskResponse', runTaskResponse_httpStatus - The response's http status code.
Response Lenses
runTaskResponse_failures :: Lens' RunTaskResponse (Maybe [Failure]) Source #
Any failures associated with the call.
runTaskResponse_tasks :: Lens' RunTaskResponse (Maybe [Task]) Source #
A full description of the tasks that were run. The tasks that were successfully placed on your cluster are described here.
runTaskResponse_httpStatus :: Lens' RunTaskResponse Int Source #
The response's http status code.