libZSservicesZSamazonka-ecsZSamazonka-ecs
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

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

Creating a Request

data StartTask Source #

See: newStartTask smart constructor.

Constructors

StartTask' 

Fields

  • overrides :: 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.

    A total of 8192 characters are allowed for overrides. This limit includes the JSON formatting characters of the override structure.

  • group' :: 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).

  • cluster :: 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.

  • propagateTags :: Maybe 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.

  • enableECSManagedTags :: Maybe Bool

    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.

  • referenceId :: Maybe Text

    The reference ID to use for the task.

  • startedBy :: 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.

  • networkConfiguration :: Maybe NetworkConfiguration

    The VPC subnet and security group configuration for tasks that receive their own elastic network interface by using the awsvpc networking mode.

  • enableExecuteCommand :: Maybe Bool

    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.

  • tags :: Maybe [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 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.
  • containerInstances :: [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.

  • taskDefinition :: 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.

Instances

Instances details
Eq StartTask Source # 
Instance details

Defined in Amazonka.ECS.StartTask

Read StartTask Source # 
Instance details

Defined in Amazonka.ECS.StartTask

Show StartTask Source # 
Instance details

Defined in Amazonka.ECS.StartTask

Generic StartTask Source # 
Instance details

Defined in Amazonka.ECS.StartTask

Associated Types

type Rep StartTask :: Type -> Type #

NFData StartTask Source # 
Instance details

Defined in Amazonka.ECS.StartTask

Methods

rnf :: StartTask -> () #

Hashable StartTask Source # 
Instance details

Defined in Amazonka.ECS.StartTask

ToJSON StartTask Source # 
Instance details

Defined in Amazonka.ECS.StartTask

AWSRequest StartTask Source # 
Instance details

Defined in Amazonka.ECS.StartTask

Associated Types

type AWSResponse StartTask #

ToHeaders StartTask Source # 
Instance details

Defined in Amazonka.ECS.StartTask

Methods

toHeaders :: StartTask -> [Header] #

ToPath StartTask Source # 
Instance details

Defined in Amazonka.ECS.StartTask

ToQuery StartTask Source # 
Instance details

Defined in Amazonka.ECS.StartTask

type Rep StartTask Source # 
Instance details

Defined in Amazonka.ECS.StartTask

type Rep StartTask = D1 ('MetaData "StartTask" "Amazonka.ECS.StartTask" "libZSservicesZSamazonka-ecsZSamazonka-ecs" 'False) (C1 ('MetaCons "StartTask'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "overrides") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe TaskOverride)) :*: (S1 ('MetaSel ('Just "group'") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "cluster") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :*: (S1 ('MetaSel ('Just "propagateTags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe PropagateTags)) :*: (S1 ('MetaSel ('Just "enableECSManagedTags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: S1 ('MetaSel ('Just "referenceId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))) :*: ((S1 ('MetaSel ('Just "startedBy") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "networkConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe NetworkConfiguration)) :*: S1 ('MetaSel ('Just "enableExecuteCommand") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)))) :*: (S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Tag])) :*: (S1 ('MetaSel ('Just "containerInstances") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [Text]) :*: S1 ('MetaSel ('Just "taskDefinition") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))))
type AWSResponse StartTask Source # 
Instance details

Defined in Amazonka.ECS.StartTask

newStartTask Source #

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:overrides: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 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.

A total of 8192 characters are allowed for overrides. This limit includes the JSON formatting characters of the override structure.

$sel:group':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).

$sel:cluster:StartTask', startTask_cluster - 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.

$sel:propagateTags: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 are not propagated.

$sel:enableECSManagedTags:StartTask', startTask_enableECSManagedTags - 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.

$sel:referenceId:StartTask', startTask_referenceId - The reference ID to use for the task.

$sel:startedBy: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, then the startedBy parameter contains the deployment ID of the service that starts it.

$sel:networkConfiguration: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.

$sel:enableExecuteCommand: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.

$sel:tags: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 on which you would like to place your task. You can specify up to 10 container instances.

$sel:taskDefinition:StartTask', startTask_taskDefinition - 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.

Request Lenses

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 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.

A total of 8192 characters are allowed for overrides. This limit includes the JSON formatting characters of the override structure.

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_cluster :: Lens' StartTask (Maybe Text) Source #

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.

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 are not propagated.

startTask_enableECSManagedTags :: Lens' StartTask (Maybe Bool) Source #

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.

startTask_referenceId :: Lens' StartTask (Maybe Text) Source #

The reference ID to use for the task.

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, then the startedBy parameter contains the deployment ID of the service that starts it.

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_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_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 on which 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 is not specified, the latest ACTIVE revision is used.

Destructuring the Response

data StartTaskResponse Source #

See: newStartTaskResponse smart constructor.

Constructors

StartTaskResponse' 

Fields

  • failures :: Maybe [Failure]

    Any failures associated with the call.

  • tasks :: Maybe [Task]

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

  • httpStatus :: Int

    The response's http status code.

Instances

Instances details
Eq StartTaskResponse Source # 
Instance details

Defined in Amazonka.ECS.StartTask

Read StartTaskResponse Source # 
Instance details

Defined in Amazonka.ECS.StartTask

Show StartTaskResponse Source # 
Instance details

Defined in Amazonka.ECS.StartTask

Generic StartTaskResponse Source # 
Instance details

Defined in Amazonka.ECS.StartTask

Associated Types

type Rep StartTaskResponse :: Type -> Type #

NFData StartTaskResponse Source # 
Instance details

Defined in Amazonka.ECS.StartTask

Methods

rnf :: StartTaskResponse -> () #

type Rep StartTaskResponse Source # 
Instance details

Defined in Amazonka.ECS.StartTask

type Rep StartTaskResponse = D1 ('MetaData "StartTaskResponse" "Amazonka.ECS.StartTask" "libZSservicesZSamazonka-ecsZSamazonka-ecs" 'False) (C1 ('MetaCons "StartTaskResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "failures") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Failure])) :*: (S1 ('MetaSel ('Just "tasks") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Task])) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newStartTaskResponse Source #

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.