| 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.StartTask
Description
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.
Synopsis
- data StartTask = StartTask' {
- cluster :: Maybe Text
- enableECSManagedTags :: Maybe Bool
- enableExecuteCommand :: Maybe Bool
- group' :: Maybe Text
- networkConfiguration :: Maybe NetworkConfiguration
- overrides :: Maybe TaskOverride
- propagateTags :: Maybe PropagateTags
- referenceId :: Maybe Text
- startedBy :: Maybe Text
- tags :: Maybe [Tag]
- containerInstances :: [Text]
- taskDefinition :: Text
- newStartTask :: Text -> StartTask
- startTask_cluster :: Lens' StartTask (Maybe Text)
- startTask_enableECSManagedTags :: Lens' StartTask (Maybe Bool)
- startTask_enableExecuteCommand :: Lens' StartTask (Maybe Bool)
- startTask_group :: Lens' StartTask (Maybe Text)
- startTask_networkConfiguration :: Lens' StartTask (Maybe NetworkConfiguration)
- startTask_overrides :: Lens' StartTask (Maybe TaskOverride)
- startTask_propagateTags :: Lens' StartTask (Maybe PropagateTags)
- startTask_referenceId :: Lens' StartTask (Maybe Text)
- startTask_startedBy :: Lens' StartTask (Maybe Text)
- startTask_tags :: Lens' StartTask (Maybe [Tag])
- startTask_containerInstances :: Lens' StartTask [Text]
- startTask_taskDefinition :: Lens' StartTask Text
- data StartTaskResponse = StartTaskResponse' {}
- newStartTaskResponse :: Int -> StartTaskResponse
- startTaskResponse_failures :: Lens' StartTaskResponse (Maybe [Failure])
- startTaskResponse_tasks :: Lens' StartTaskResponse (Maybe [Task])
- startTaskResponse_httpStatus :: Lens' StartTaskResponse Int
Creating a Request
See: newStartTask smart constructor.
Constructors
| StartTask' | |
Fields
| |
Instances
Create a value of StartTask 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:cluster:StartTask', startTask_cluster - The short name or full Amazon Resource Name (ARN) of the cluster where
to start your task. If you do not specify a cluster, the default cluster
is assumed.
StartTask, startTask_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.
StartTask, startTask_enableExecuteCommand - Whether or not the execute command functionality is enabled for the
task. If true, this enables execute command functionality on all
containers in the task.
StartTask, startTask_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).
StartTask, startTask_networkConfiguration - The VPC subnet and security group configuration for tasks that receive
their own elastic network interface by using the awsvpc networking
mode.
StartTask, startTask_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
receives. 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.
StartTask, startTask_propagateTags - Specifies whether to propagate the tags from the task definition or the
service to the task. If no value is specified, the tags aren't
propagated.
$sel:referenceId:StartTask', startTask_referenceId - The reference ID to use for the task.
StartTask, startTask_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, the startedBy parameter
contains the deployment ID of the service that starts it.
StartTask, startTask_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.
$sel:containerInstances:StartTask', startTask_containerInstances - The container instance IDs or full ARN entries for the container
instances where you would like to place your task. You can specify up to
10 container instances.
StartTask, startTask_taskDefinition - The family and revision (family:revision) or full ARN of the task
definition to start. If a revision isn't specified, the latest
ACTIVE revision is used.
Request Lenses
startTask_cluster :: Lens' StartTask (Maybe Text) Source #
The short name or full Amazon Resource Name (ARN) of the cluster where to start your task. If you do not specify a cluster, the default cluster is assumed.
startTask_enableECSManagedTags :: Lens' StartTask (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.
startTask_enableExecuteCommand :: Lens' StartTask (Maybe Bool) Source #
Whether or not the execute command functionality is enabled for the
task. If true, this enables execute command functionality on all
containers in the task.
startTask_group :: Lens' StartTask (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).
startTask_networkConfiguration :: Lens' StartTask (Maybe NetworkConfiguration) Source #
The VPC subnet and security group configuration for tasks that receive
their own elastic network interface by using the awsvpc networking
mode.
startTask_overrides :: 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
receives. 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.
startTask_propagateTags :: Lens' StartTask (Maybe PropagateTags) Source #
Specifies whether to propagate the tags from the task definition or the service to the task. If no value is specified, the tags aren't propagated.
startTask_startedBy :: 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, the startedBy parameter
contains the deployment ID of the service that starts it.
startTask_tags :: Lens' StartTask (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.
startTask_containerInstances :: Lens' StartTask [Text] Source #
The container instance IDs or full ARN entries for the container instances where you would like to place your task. You can specify up to 10 container instances.
startTask_taskDefinition :: Lens' StartTask Text Source #
The family and revision (family:revision) or full ARN of the task
definition to start. If a revision isn't specified, the latest
ACTIVE revision is used.
Destructuring the Response
data StartTaskResponse Source #
See: newStartTaskResponse smart constructor.
Constructors
| StartTaskResponse' | |
Instances
Arguments
| :: Int | |
| -> StartTaskResponse |
Create a value of StartTaskResponse 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:StartTaskResponse', startTaskResponse_failures - Any failures associated with the call.
$sel:tasks:StartTaskResponse', startTaskResponse_tasks - A full description of the tasks that were started. Each task that was
successfully placed on your container instances is described.
$sel:httpStatus:StartTaskResponse', startTaskResponse_httpStatus - The response's http status code.
Response Lenses
startTaskResponse_failures :: Lens' StartTaskResponse (Maybe [Failure]) Source #
Any failures associated with the call.
startTaskResponse_tasks :: Lens' StartTaskResponse (Maybe [Task]) Source #
A full description of the tasks that were started. Each task that was successfully placed on your container instances is described.
startTaskResponse_httpStatus :: Lens' StartTaskResponse Int Source #
The response's http status code.