Starts a new task using the specified task definition.
See https://www.paws-r-sdk.com/docs/ecs_run_task/ for full documentation.
ecs_run_task(
capacityProviderStrategy = NULL,
cluster = NULL,
count = NULL,
enableECSManagedTags = NULL,
enableExecuteCommand = NULL,
group = NULL,
launchType = NULL,
networkConfiguration = NULL,
overrides = NULL,
placementConstraints = NULL,
placementStrategy = NULL,
platformVersion = NULL,
propagateTags = NULL,
referenceId = NULL,
startedBy = NULL,
tags = NULL,
taskDefinition,
clientToken = NULL,
volumeConfigurations = NULL
)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.
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.
The number of instantiations of the specified task to place on your cluster. You can specify up to 10 tasks for each call.
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.
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.
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).
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 Developer Guide.
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.
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.
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.
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).
The placement strategy objects to use for the task. You can specify a maximum of 5 strategy rules for each task.
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.
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 thetag_resource API
action.
An error will be received if you specify the SERVICE option when
running a task.
The reference ID to use for the task. The reference ID can have a maximum length of 1024 characters.
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 list_tasks call with the
startedBy value. Up to 128 letters (uppercase and lowercase), numbers,
hyphens (-), forward slash (/), 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.
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.
[required] 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.
The full ARN value must match the value that you specified as the
Resource of the principal's permissions policy.
When you specify a task definition, you must either specify a specific revision, or all revisions in the ARN.
To specify a specific revision, include the revision number in the ARN.
For example, to specify revision 2, use
arn:aws:ecs:us-east-1:111122223333:task-definition/TaskFamilyName:2.
To specify all revisions, use the wildcard (*) in the ARN. For example,
to specify all revisions, use
arn:aws:ecs:us-east-1:111122223333:task-definition/TaskFamilyName:*.
For more information, see Policy Resources for Amazon ECS in the Amazon Elastic Container Service Developer Guide.
An identifier that you provide to ensure the idempotency of the request. It must be unique and is case sensitive. Up to 64 characters are allowed. The valid characters are characters in the range of 33-126, inclusive. For more information, see Ensuring idempotency.
The details of the volume that was configuredAtLaunch. You can
configure the size, volumeType, IOPS, throughput, snapshot and
encryption in in
TaskManagedEBSVolumeConfiguration.
The name of the volume must match the name from the task definition.