AWS Tools for Windows PowerShell
Command Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Synopsis

Calls the Amazon EC2 Container Service StartTask API operation.

Syntax

Start-ECSTask
-Cluster <String>
-AwsvpcConfiguration_AssignPublicIp <AssignPublicIp>
-ContainerInstance <String[]>
-Overrides_ContainerOverride <ContainerOverride[]>
-Overrides_Cpu <String>
-EnableECSManagedTag <Boolean>
-Overrides_ExecutionRoleArn <String>
-Group <String>
-Overrides_InferenceAcceleratorOverride <InferenceAcceleratorOverride[]>
-Overrides_Memory <String>
-PropagateTag <PropagateTags>
-ReferenceId <String>
-AwsvpcConfiguration_SecurityGroup <String[]>
-StartedBy <String>
-AwsvpcConfiguration_Subnet <String[]>
-Tag <Tag[]>
-TaskDefinition <String>
-Overrides_TaskRoleArn <String>
-Select <String>
-PassThru <SwitchParameter>
-Force <SwitchParameter>

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.

Parameters

-AwsvpcConfiguration_AssignPublicIp <AssignPublicIp>
Whether the task's elastic network interface receives a public IP address. The default value is DISABLED.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesNetworkConfiguration_AwsvpcConfiguration_AssignPublicIp
-AwsvpcConfiguration_SecurityGroup <String[]>
The security groups associated with the task or service. If you do not specify a security group, the default security group for the VPC is used. There is a limit of 5 security groups that can be specified per AwsVpcConfiguration.All specified security groups must be from the same VPC.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesNetworkConfiguration_AwsvpcConfiguration_SecurityGroups
-AwsvpcConfiguration_Subnet <String[]>
The subnets associated with the task or service. There is a limit of 16 subnets that can be specified per AwsVpcConfiguration.All specified subnets must be from the same VPC.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesNetworkConfiguration_AwsvpcConfiguration_Subnets
-Cluster <String>
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.
Required?False
Position?1
Accept pipeline input?True (ByValue, ByPropertyName)
-ContainerInstance <String[]>
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.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesContainerInstances
-EnableECSManagedTag <Boolean>
Specifies whether to enable Amazon ECS managed tags for the task. For more information, see Tagging Your Amazon ECS Resources in the Amazon Elastic Container Service Developer Guide.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesEnableECSManagedTags
-Force <SwitchParameter>
This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Group <String>
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).
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Overrides_ContainerOverride <ContainerOverride[]>
One or more container overrides sent to a task.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesOverrides_ContainerOverrides
-Overrides_Cpu <String>
The cpu override for the task.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Overrides_ExecutionRoleArn <String>
The Amazon Resource Name (ARN) of the task execution role that the Amazon ECS container agent and the Docker daemon can assume.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Overrides_InferenceAcceleratorOverride <InferenceAcceleratorOverride[]>
The Elastic Inference accelerator override for the task.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesOverrides_InferenceAcceleratorOverrides
-Overrides_Memory <String>
The memory override for the task.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Overrides_TaskRoleArn <String>
The Amazon Resource Name (ARN) of the IAM role that containers in this task can assume. All containers in this task are granted the permissions that are specified in this role.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-PassThru <SwitchParameter>
Changes the cmdlet behavior to return the value passed to the Cluster parameter. The -PassThru parameter is deprecated, use -Select '^Cluster' instead. This parameter will be removed in a future version.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-PropagateTag <PropagateTags>
Specifies whether to propagate the tags from the task definition or the service to the task. If no value is specified, the tags are not propagated.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesPropagateTags
-ReferenceId <String>
The reference ID to use for the task.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Select <String>
Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.ECS.Model.StartTaskResponse). Specifying the name of a property of type Amazon.ECS.Model.StartTaskResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-StartedBy <String>
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.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Tag <Tag[]>
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 AWS 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?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesTags
-TaskDefinition <String>
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.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)

Common Credential and Region Parameters

-AccessKey <String>
The AWS access key for the user account. This can be a temporary access key if the corresponding session token is supplied to the -SessionToken parameter.
Required? False
Position? Named
Accept pipeline input? True (ByPropertyName)
Aliases AK
-Credential <AWSCredentials>
An AWSCredentials object instance containing access and secret key information, and optionally a token for session-based credentials.
Required? False
Position? Named
Accept pipeline input? True (ByPropertyName)
-ProfileLocation <String>

Used to specify the name and location of the ini-format credential file (shared with the AWS CLI and other AWS SDKs)

If this optional parameter is omitted this cmdlet will search the encrypted credential file used by the AWS SDK for .NET and AWS Toolkit for Visual Studio first. If the profile is not found then the cmdlet will search in the ini-format credential file at the default location: (user's home directory)\.aws\credentials. Note that the encrypted credential file is not supported on all platforms. It will be skipped when searching for profiles on Windows Nano Server, Mac, and Linux platforms.

If this parameter is specified then this cmdlet will only search the ini-format credential file at the location given.

As the current folder can vary in a shell or during script execution it is advised that you use specify a fully qualified path instead of a relative path.

Required? False
Position? Named
Accept pipeline input? True (ByPropertyName)
Aliases AWSProfilesLocation, ProfilesLocation
-ProfileName <String>
The user-defined name of an AWS credentials or SAML-based role profile containing credential information. The profile is expected to be found in the secure credential file shared with the AWS SDK for .NET and AWS Toolkit for Visual Studio. You can also specify the name of a profile stored in the .ini-format credential file used with the AWS CLI and other AWS SDKs.
Required? False
Position? Named
Accept pipeline input? True (ByPropertyName)
Aliases AWSProfileName, StoredCredentials
-NetworkCredential <PSCredential>
Used with SAML-based authentication when ProfileName references a SAML role profile. Contains the network credentials to be supplied during authentication with the configured identity provider's endpoint. This parameter is not required if the user's default network identity can or should be used during authentication.
Required? False
Position? Named
Accept pipeline input? True (ByPropertyName)
-SecretKey <String>
The AWS secret key for the user account. This can be a temporary secret key if the corresponding session token is supplied to the -SessionToken parameter.
Required? False
Position? Named
Accept pipeline input? True (ByPropertyName)
Aliases SecretAccessKey, SK
-SessionToken <String>
The session token if the access and secret keys are temporary session-based credentials.
Required? False
Position? Named
Accept pipeline input? True (ByPropertyName)
Aliases ST
-Region <String>
The system name of the AWS region in which the operation should be invoked. For example, us-east-1, eu-west-1 etc.
Required? False
Position? Named
Accept pipeline input? True (ByPropertyName)
Aliases RegionToCall
-EndpointUrl <String>

The endpoint to make the call against.

Note: This parameter is primarily for internal AWS use and is not required/should not be specified for normal usage. The cmdlets normally determine which endpoint to call based on the region specified to the -Region parameter or set as default in the shell (via Set-DefaultAWSRegion). Only specify this parameter if you must direct the call to a specific custom endpoint.

Required? False
Position? Named
Accept pipeline input? True (ByPropertyName)

Inputs

System.String
You can pipe a String object to this cmdlet for the Cluster parameter.

Outputs

Amazon.ECS.Model.StartTaskResponse
This cmdlet returns an Amazon.ECS.Model.StartTaskResponse object containing multiple properties. The object can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack.
User Guide
Service API Reference
AWS Tools for PowerShell User Guide

Supported Version

AWS Tools for PowerShell: 2.x.y.z