start_task ¶

def start_task(
    self,
    container_instances: "capo_ecs.types.string_list.StringList",
    task_definition: "capo_ecs.types.string.String",
    *,
    config_overrides: Optional[ECSClientConfig] = None,
    cluster: Optional["capo_ecs.types.string.String"] = None,
    enable_ecs_managed_tags: Optional["capo_ecs.types.boolean.Boolean"] = None,
    enable_execute_command: Optional["capo_ecs.types.boolean.Boolean"] = None,
    group: Optional["capo_ecs.types.string.String"] = None,
    network_configuration: Optional[
        "capo_ecs.types.network_configuration.NetworkConfiguration"
    ] = None,
    overrides: Optional["capo_ecs.types.task_override.TaskOverride"] = None,
    propagate_tags: Optional["capo_ecs.types.propagate_tags.PropagateTags"] = None,
    reference_id: Optional["capo_ecs.types.string.String"] = None,
    started_by: Optional["capo_ecs.types.string.String"] = None,
    tags: Optional["capo_ecs.types.tags.Tags"] = None,
    volume_configurations: Optional[
        "capo_ecs.types.task_volume_configurations.TaskVolumeConfigurations"
    ] = None,
) -> "capo_ecs.types.start_task_response.StartTaskResponse":
    """<p>Starts a new task from the specified task definition on the specified container instance or instances.</p> <note> <p>On March 21, 2024, a change was made to resolve the task definition revision before authorization. When a task definition revision is not specified, authorization will occur using the latest revision of a task definition.</p> </note> <note> <p>Amazon Elastic Inference (EI) is no longer available to customers.</p> </note> <p>Alternatively, you can use<code>RunTask</code> to place tasks for you. For more information, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/scheduling_tasks.html">Scheduling Tasks</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p> <p>You can attach Amazon EBS volumes to Amazon ECS tasks by configuring the volume when creating or updating a service. For more information, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ebs-volumes.html#ebs-volume-types">Amazon EBS volumes</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p>

    Args:
        cluster: <p>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.</p>
        container_instances: <p>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.</p>
        enable_ecs_managed_tags: <p>Specifies whether to use Amazon ECS managed tags for the task. For more information, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-using-tags.html">Tagging Your Amazon ECS Resources</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p>
        enable_execute_command: <p>Whether or not the execute command functionality is turned on for the task. If <code>true</code>, this turns on the execute command functionality on all containers in the task.</p>
        group: <p>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).</p>
        network_configuration: <p>The VPC subnet and security group configuration for tasks that receive their own elastic network interface by using the <code>awsvpc</code> networking mode.</p>
        overrides: <p>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 <code>command</code> 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 <code>environment</code> override.</p> <note> <p>A total of 8192 characters are allowed for overrides. This limit includes the JSON formatting characters of the override structure.</p> </note>
        propagate_tags: <p>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.</p>
        reference_id: <p>This parameter is only used by Amazon ECS. It is not intended for use by customers.</p>
        started_by: <p>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 <code>startedBy</code> parameter. You can then identify which tasks belong to that job by filtering the results of a <a href="https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_ListTasks.html">ListTasks</a> call with the <code>startedBy</code> value. Up to 36 letters (uppercase and lowercase), numbers, hyphens (-), forward slash (/), and underscores (_) are allowed.</p> <p>If a task is started by an Amazon ECS service, the <code>startedBy</code> parameter contains the deployment ID of the service that starts it.</p>
        tags: <p>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.</p> <p>The following basic restrictions apply to tags:</p> <ul> <li> <p>Maximum number of tags per resource - 50</p> </li> <li> <p>For each resource, each tag key must be unique, and each tag key can have only one value.</p> </li> <li> <p>Maximum key length - 128 Unicode characters in UTF-8</p> </li> <li> <p>Maximum value length - 256 Unicode characters in UTF-8</p> </li> <li> <p>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: + - = . _ : / @.</p> </li> <li> <p>Tag keys and values are case-sensitive.</p> </li> <li> <p>Do not use <code>aws:</code>, <code>AWS:</code>, 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.</p> </li> </ul>
        task_definition: <p>The <code>family</code> and <code>revision</code> (<code>family:revision</code>) or full ARN of the task definition to start. If a <code>revision</code> isn't specified, the latest <code>ACTIVE</code> revision is used.</p>
        volume_configurations: <p>The details of the volume that was <code>configuredAtLaunch</code>. You can configure the size, volumeType, IOPS, throughput, snapshot and encryption in <a href="https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_TaskManagedEBSVolumeConfiguration.html">TaskManagedEBSVolumeConfiguration</a>. The <code>name</code> of the volume must match the <code>name</code> from the task definition.</p>

    Raises:
        capo_ecs.errors.access_denied_exception.AccessDeniedException: <p>You don't have authorization to perform the requested action.</p>
        capo_ecs.errors.client_exception.ClientException: <p>These errors are usually caused by a client action. This client action might be using an action or resource on behalf of a user that doesn't have permissions to use the action or resource. Or, it might be specifying an identifier that isn't valid.</p>
        capo_ecs.errors.cluster_not_found_exception.ClusterNotFoundException: <p>The specified cluster wasn't found. You can view your available clusters with <a href="https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_ListClusters.html">ListClusters</a>. Amazon ECS clusters are Region specific.</p>
        capo_ecs.errors.invalid_parameter_exception.InvalidParameterException: <p>The specified parameter isn't valid. Review the available parameters for the API request.</p> <p>For more information about service event errors, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-event-messages-list.html">Amazon ECS service event messages</a>. </p>
        capo_ecs.errors.namespace_not_found_exception.NamespaceNotFoundException: <p>The specified namespace wasn't found.</p>
        capo_ecs.errors.server_exception.ServerException: <p>These errors are usually caused by a server issue.</p>
        capo_ecs.errors.unsupported_feature_exception.UnsupportedFeatureException: <p>The specified task isn't supported in this Region.</p>
        capo_ecs.errors.UnknownServiceError: The service returned an error code this client does not model.

    Examples:
        To start a new task
        This example starts a new task in the cluster "MyCluster" on the specified container instance using the latest revision of the "hello-world" task definition.

        >>> client.start_task(cluster='MyCluster', container_instances=['4c543eed-f83f-47da-b1d8-3d23f1da4c64'], task_definition='hello-world')
    """

    def _handler(
        req: "OperationRequest[capo_ecs.types.start_task_request.StartTaskRequest]",
    ) -> OperationResponse["capo_ecs.types.start_task_response.StartTaskResponse"]:
        import capo_ecs._operations.amazon_ec2_container_service_v20141113.start_task

        output, http_response = (
            capo_ecs._operations.amazon_ec2_container_service_v20141113.start_task.start_task(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    def _redact_input(
        input_: "capo_ecs.types.start_task_request.StartTaskRequest",
    ) -> dict[str, Any]:
        import capo_ecs.types.start_task_request

        return capo_ecs.types.start_task_request.redact_sensitive(input_)

    def _redact_output(
        output: "capo_ecs.types.start_task_response.StartTaskResponse",
    ) -> dict[str, Any]:
        import capo_ecs.types.start_task_response

        return capo_ecs.types.start_task_response.redact_sensitive(output)

    interceptors_, options_ = self.operation_options(
        config_overrides,
        OperationLogging(
            "StartTask", redact_input=_redact_input, redact_output=_redact_output
        ),
    )
    input_: capo_ecs.types.start_task_request.StartTaskRequest = {
        "container_instances": container_instances,
        "task_definition": task_definition,
    }
    if cluster is not None:
        input_["cluster"] = cluster
    if enable_ecs_managed_tags is not None:
        input_["enable_ecs_managed_tags"] = enable_ecs_managed_tags
    if enable_execute_command is not None:
        input_["enable_execute_command"] = enable_execute_command
    if group is not None:
        input_["group"] = group
    if network_configuration is not None:
        input_["network_configuration"] = network_configuration
    if overrides is not None:
        input_["overrides"] = overrides
    if propagate_tags is not None:
        input_["propagate_tags"] = propagate_tags
    if reference_id is not None:
        input_["reference_id"] = reference_id
    if started_by is not None:
        input_["started_by"] = started_by
    if tags is not None:
        input_["tags"] = tags
    if volume_configurations is not None:
        input_["volume_configurations"] = volume_configurations

    response = execute_pipeline(
        OperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    response.response.close()
    return response.output