@aws-sdk/client-ecs 3.1021.0 → 3.1023.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +91 -7
- package/dist-cjs/index.js +530 -33
- package/dist-cjs/models/errors.js +37 -11
- package/dist-cjs/schemas/schemas_0.js +508 -100
- package/dist-es/ECS.js +34 -0
- package/dist-es/commands/CreateDaemonCommand.js +16 -0
- package/dist-es/commands/DeleteDaemonCommand.js +16 -0
- package/dist-es/commands/DeleteDaemonTaskDefinitionCommand.js +16 -0
- package/dist-es/commands/DescribeDaemonCommand.js +16 -0
- package/dist-es/commands/DescribeDaemonDeploymentsCommand.js +16 -0
- package/dist-es/commands/DescribeDaemonRevisionsCommand.js +16 -0
- package/dist-es/commands/DescribeDaemonTaskDefinitionCommand.js +16 -0
- package/dist-es/commands/ListDaemonDeploymentsCommand.js +16 -0
- package/dist-es/commands/ListDaemonTaskDefinitionsCommand.js +16 -0
- package/dist-es/commands/ListDaemonsCommand.js +16 -0
- package/dist-es/commands/RegisterDaemonTaskDefinitionCommand.js +16 -0
- package/dist-es/commands/UpdateDaemonCommand.js +16 -0
- package/dist-es/commands/index.js +12 -0
- package/dist-es/index.js +1 -0
- package/dist-es/models/enums.js +72 -33
- package/dist-es/models/errors.js +32 -8
- package/dist-es/models/models_1.js +1 -0
- package/dist-es/schemas/schemas_0.js +500 -93
- package/dist-es/waiters/index.js +5 -0
- package/dist-es/waiters/waitForDaemonActive.js +40 -0
- package/dist-es/waiters/waitForDaemonDeploymentStopped.js +54 -0
- package/dist-es/waiters/waitForDaemonDeploymentSuccessful.js +99 -0
- package/dist-es/waiters/waitForDaemonTaskDefinitionActive.js +49 -0
- package/dist-es/waiters/waitForDaemonTaskDefinitionDeleted.js +31 -0
- package/dist-types/ECS.d.ts +116 -0
- package/dist-types/ECSClient.d.ts +14 -2
- package/dist-types/commands/CreateDaemonCommand.d.ts +150 -0
- package/dist-types/commands/CreateTaskSetCommand.d.ts +1 -1
- package/dist-types/commands/DeleteDaemonCommand.d.ts +121 -0
- package/dist-types/commands/DeleteDaemonTaskDefinitionCommand.d.ts +101 -0
- package/dist-types/commands/DeleteTaskDefinitionsCommand.d.ts +1 -0
- package/dist-types/commands/DeleteTaskSetCommand.d.ts +1 -1
- package/dist-types/commands/DeregisterContainerInstanceCommand.d.ts +1 -1
- package/dist-types/commands/DeregisterTaskDefinitionCommand.d.ts +1 -0
- package/dist-types/commands/DescribeContainerInstancesCommand.d.ts +1 -1
- package/dist-types/commands/DescribeDaemonCommand.d.ts +148 -0
- package/dist-types/commands/DescribeDaemonDeploymentsCommand.d.ts +229 -0
- package/dist-types/commands/DescribeDaemonRevisionsCommand.d.ts +155 -0
- package/dist-types/commands/DescribeDaemonTaskDefinitionCommand.d.ts +286 -0
- package/dist-types/commands/DescribeTaskDefinitionCommand.d.ts +1 -0
- package/dist-types/commands/DescribeTaskSetsCommand.d.ts +1 -1
- package/dist-types/commands/DescribeTasksCommand.d.ts +1 -1
- package/dist-types/commands/GetTaskProtectionCommand.d.ts +1 -1
- package/dist-types/commands/ListDaemonDeploymentsCommand.d.ts +145 -0
- package/dist-types/commands/ListDaemonTaskDefinitionsCommand.d.ts +129 -0
- package/dist-types/commands/ListDaemonsCommand.d.ts +133 -0
- package/dist-types/commands/ListTaskDefinitionsCommand.d.ts +2 -1
- package/dist-types/commands/ListTasksCommand.d.ts +1 -0
- package/dist-types/commands/RegisterContainerInstanceCommand.d.ts +1 -1
- package/dist-types/commands/RegisterDaemonTaskDefinitionCommand.d.ts +277 -0
- package/dist-types/commands/RegisterTaskDefinitionCommand.d.ts +2 -1
- package/dist-types/commands/RunTaskCommand.d.ts +1 -1
- package/dist-types/commands/StartTaskCommand.d.ts +1 -1
- package/dist-types/commands/StopTaskCommand.d.ts +1 -1
- package/dist-types/commands/UntagResourceCommand.d.ts +1 -1
- package/dist-types/commands/UpdateContainerAgentCommand.d.ts +1 -1
- package/dist-types/commands/UpdateContainerInstancesStateCommand.d.ts +1 -1
- package/dist-types/commands/UpdateDaemonCommand.d.ts +149 -0
- package/dist-types/commands/UpdateTaskProtectionCommand.d.ts +1 -1
- package/dist-types/commands/UpdateTaskSetCommand.d.ts +1 -1
- package/dist-types/commands/index.d.ts +12 -0
- package/dist-types/index.d.ts +1 -0
- package/dist-types/models/enums.d.ts +155 -60
- package/dist-types/models/errors.d.ts +32 -8
- package/dist-types/models/models_0.d.ts +2630 -2613
- package/dist-types/models/models_1.d.ts +1245 -0
- package/dist-types/schemas/schemas_0.d.ts +58 -0
- package/dist-types/ts3.4/ECS.d.ts +251 -0
- package/dist-types/ts3.4/ECSClient.d.ts +72 -0
- package/dist-types/ts3.4/commands/CreateDaemonCommand.d.ts +47 -0
- package/dist-types/ts3.4/commands/CreateTaskSetCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/DeleteDaemonCommand.d.ts +47 -0
- package/dist-types/ts3.4/commands/DeleteDaemonTaskDefinitionCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/DeleteTaskSetCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/DescribeDaemonCommand.d.ts +50 -0
- package/dist-types/ts3.4/commands/DescribeDaemonDeploymentsCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/DescribeDaemonRevisionsCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/DescribeDaemonTaskDefinitionCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/DescribeTaskSetsCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/DescribeTasksCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/GetTaskProtectionCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/ListDaemonDeploymentsCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/ListDaemonTaskDefinitionsCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/ListDaemonsCommand.d.ts +47 -0
- package/dist-types/ts3.4/commands/ListTaskDefinitionsCommand.d.ts +2 -4
- package/dist-types/ts3.4/commands/RegisterDaemonTaskDefinitionCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/RegisterTaskDefinitionCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/RunTaskCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/StartTaskCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/StopTaskCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/UntagResourceCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/UpdateDaemonCommand.d.ts +47 -0
- package/dist-types/ts3.4/commands/UpdateTaskProtectionCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/UpdateTaskSetCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/index.d.ts +12 -0
- package/dist-types/ts3.4/index.d.ts +1 -0
- package/dist-types/ts3.4/models/enums.d.ts +92 -40
- package/dist-types/ts3.4/models/errors.d.ts +21 -7
- package/dist-types/ts3.4/models/models_0.d.ts +338 -324
- package/dist-types/ts3.4/models/models_1.d.ts +322 -0
- package/dist-types/ts3.4/schemas/schemas_0.d.ts +58 -0
- package/dist-types/ts3.4/waiters/index.d.ts +5 -0
- package/dist-types/ts3.4/waiters/waitForDaemonActive.d.ts +11 -0
- package/dist-types/ts3.4/waiters/waitForDaemonDeploymentStopped.d.ts +11 -0
- package/dist-types/ts3.4/waiters/waitForDaemonDeploymentSuccessful.d.ts +11 -0
- package/dist-types/ts3.4/waiters/waitForDaemonTaskDefinitionActive.d.ts +11 -0
- package/dist-types/ts3.4/waiters/waitForDaemonTaskDefinitionDeleted.d.ts +11 -0
- package/dist-types/waiters/index.d.ts +5 -0
- package/dist-types/waiters/waitForDaemonActive.d.ts +14 -0
- package/dist-types/waiters/waitForDaemonDeploymentStopped.d.ts +14 -0
- package/dist-types/waiters/waitForDaemonDeploymentSuccessful.d.ts +14 -0
- package/dist-types/waiters/waitForDaemonTaskDefinitionActive.d.ts +14 -0
- package/dist-types/waiters/waitForDaemonTaskDefinitionDeleted.d.ts +14 -0
- package/package.json +1 -1
|
@@ -0,0 +1,1245 @@
|
|
|
1
|
+
import type { Compatibility, Connectivity, HealthStatus, IpcMode, LaunchType, ManagedAgentName, NetworkMode, PidMode, PropagateTags, TaskField, TaskFilesystemType, TaskSetField, TaskStopCode } from "./enums";
|
|
2
|
+
import type { Attachment, Attribute, CapacityProviderStrategyItem, ContainerDefinition, EBSTagSpecification, EnvironmentFile, EphemeralStorage, Failure, InferenceAccelerator, KeyValuePair, LoadBalancer, NetworkBinding, NetworkConfiguration, PlacementConstraint, PlacementStrategy, ProxyConfiguration, ResourceRequirement, RuntimePlatform, Scale, ServiceRegistry, Tag, TaskDefinition, TaskDefinitionPlacementConstraint, TaskSet, Volume } from "./models_0";
|
|
3
|
+
/**
|
|
4
|
+
*
|
|
5
|
+
* @public
|
|
6
|
+
*/
|
|
7
|
+
export interface ListTaskDefinitionsResponse {
|
|
8
|
+
/**
|
|
9
|
+
* <p>The list of task definition Amazon Resource Name (ARN) entries for the <code>ListTaskDefinitions</code> request.</p>
|
|
10
|
+
* @public
|
|
11
|
+
*/
|
|
12
|
+
taskDefinitionArns?: string[] | undefined;
|
|
13
|
+
/**
|
|
14
|
+
* <p>The <code>nextToken</code> value to include in a future <code>ListTaskDefinitions</code> request. When the results of a <code>ListTaskDefinitions</code> request exceed <code>maxResults</code>, this value can be used to retrieve the next page of results. This value is <code>null</code> when there are no more results to return.</p>
|
|
15
|
+
* @public
|
|
16
|
+
*/
|
|
17
|
+
nextToken?: string | undefined;
|
|
18
|
+
}
|
|
19
|
+
/**
|
|
20
|
+
*
|
|
21
|
+
* @public
|
|
22
|
+
*/
|
|
23
|
+
export interface RegisterTaskDefinitionRequest {
|
|
24
|
+
/**
|
|
25
|
+
* <p>You must specify a <code>family</code> for a task definition. You can use it track multiple versions of the same task definition. The <code>family</code> is used as a name for your task definition. Up to 255 letters (uppercase and lowercase), numbers, underscores, and hyphens are allowed.</p>
|
|
26
|
+
* @public
|
|
27
|
+
*/
|
|
28
|
+
family: string | undefined;
|
|
29
|
+
/**
|
|
30
|
+
* <p>The short name or full 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. For more information, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-iam-roles.html">IAM Roles for Tasks</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p>
|
|
31
|
+
* @public
|
|
32
|
+
*/
|
|
33
|
+
taskRoleArn?: string | undefined;
|
|
34
|
+
/**
|
|
35
|
+
* <p>The Amazon Resource Name (ARN) of the task execution role that grants the Amazon ECS container agent permission to make Amazon Web Services API calls on your behalf. For informationabout the required IAM roles for Amazon ECS, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/security-ecs-iam-role-overview.html">IAM roles for Amazon ECS</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p>
|
|
36
|
+
* @public
|
|
37
|
+
*/
|
|
38
|
+
executionRoleArn?: string | undefined;
|
|
39
|
+
/**
|
|
40
|
+
* <p>The Docker networking mode to use for the containers in the task. The valid values are <code>none</code>, <code>bridge</code>, <code>awsvpc</code>, and <code>host</code>. If no network mode is specified, the default is <code>bridge</code>.</p> <p>For Amazon ECS tasks on Fargate, the <code>awsvpc</code> network mode is required. For Amazon ECS tasks on Amazon EC2 Linux instances, any network mode can be used. For Amazon ECS tasks on Amazon EC2 Windows instances, <code><default></code> or <code>awsvpc</code> can be used. If the network mode is set to <code>none</code>, you cannot specify port mappings in your container definitions, and the tasks containers do not have external connectivity. The <code>host</code> and <code>awsvpc</code> network modes offer the highest networking performance for containers because they use the EC2 network stack instead of the virtualized network stack provided by the <code>bridge</code> mode.</p> <p>With the <code>host</code> and <code>awsvpc</code> network modes, exposed container ports are mapped directly to the corresponding host port (for the <code>host</code> network mode) or the attached elastic network interface port (for the <code>awsvpc</code> network mode), so you cannot take advantage of dynamic host port mappings. </p> <important> <p>When using the <code>host</code> network mode, you should not run containers using the root user (UID 0). It is considered best practice to use a non-root user.</p> </important> <p>If the network mode is <code>awsvpc</code>, the task is allocated an elastic network interface, and you must specify a <a href="https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_NetworkConfiguration.html">NetworkConfiguration</a> value when you create a service or run a task with the task definition. For more information, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-networking.html">Task Networking</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p> <p>If the network mode is <code>host</code>, you cannot run multiple instantiations of the same task on a single container instance when port mappings are used.</p>
|
|
41
|
+
* @public
|
|
42
|
+
*/
|
|
43
|
+
networkMode?: NetworkMode | undefined;
|
|
44
|
+
/**
|
|
45
|
+
* <p>A list of container definitions in JSON format that describe the different containers that make up your task.</p>
|
|
46
|
+
* @public
|
|
47
|
+
*/
|
|
48
|
+
containerDefinitions: ContainerDefinition[] | undefined;
|
|
49
|
+
/**
|
|
50
|
+
* <p>A list of volume definitions in JSON format that containers in your task might use.</p>
|
|
51
|
+
* @public
|
|
52
|
+
*/
|
|
53
|
+
volumes?: Volume[] | undefined;
|
|
54
|
+
/**
|
|
55
|
+
* <p>An array of placement constraint objects to use for the task. You can specify a maximum of 10 constraints for each task. This limit includes constraints in the task definition and those specified at runtime.</p>
|
|
56
|
+
* @public
|
|
57
|
+
*/
|
|
58
|
+
placementConstraints?: TaskDefinitionPlacementConstraint[] | undefined;
|
|
59
|
+
/**
|
|
60
|
+
* <p>The task launch type that Amazon ECS validates the task definition against. A client exception is returned if the task definition doesn't validate against the compatibilities specified. If no value is specified, the parameter is omitted from the response.</p>
|
|
61
|
+
* @public
|
|
62
|
+
*/
|
|
63
|
+
requiresCompatibilities?: Compatibility[] | undefined;
|
|
64
|
+
/**
|
|
65
|
+
* <p>The number of CPU units used by the task. It can be expressed as an integer using CPU units (for example, <code>1024</code>) or as a string using vCPUs (for example, <code>1 vCPU</code> or <code>1 vcpu</code>) in a task definition. String values are converted to an integer indicating the CPU units when the task definition is registered.</p> <note> <p>Task-level CPU and memory parameters are ignored for Windows containers. We recommend specifying container-level resources for Windows containers.</p> </note> <p>If you're using the EC2 launch type or external launch type, this field is optional. Supported values are between <code>128</code> CPU units (<code>0.125</code> vCPUs) and <code>196608</code> CPU units (<code>192</code> vCPUs). If you do not specify a value, the parameter is ignored.</p> <p>This field is required for Fargate. For information about the valid values, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task_definition_parameters.html#task_size">Task size</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p>
|
|
66
|
+
* @public
|
|
67
|
+
*/
|
|
68
|
+
cpu?: string | undefined;
|
|
69
|
+
/**
|
|
70
|
+
* <p>The amount of memory (in MiB) used by the task. It can be expressed as an integer using MiB (for example ,<code>1024</code>) or as a string using GB (for example, <code>1GB</code> or <code>1 GB</code>) in a task definition. String values are converted to an integer indicating the MiB when the task definition is registered.</p> <note> <p>Task-level CPU and memory parameters are ignored for Windows containers. We recommend specifying container-level resources for Windows containers.</p> </note> <p>If using the EC2 launch type, this field is optional.</p> <p>If using the Fargate launch type, this field is required and you must use one of the following values. This determines your range of supported values for the <code>cpu</code> parameter.</p> <p>The CPU units cannot be less than 1 vCPU when you use Windows containers on Fargate.</p> <ul> <li> <p>512 (0.5 GB), 1024 (1 GB), 2048 (2 GB) - Available <code>cpu</code> values: 256 (.25 vCPU)</p> </li> <li> <p>1024 (1 GB), 2048 (2 GB), 3072 (3 GB), 4096 (4 GB) - Available <code>cpu</code> values: 512 (.5 vCPU)</p> </li> <li> <p>2048 (2 GB), 3072 (3 GB), 4096 (4 GB), 5120 (5 GB), 6144 (6 GB), 7168 (7 GB), 8192 (8 GB) - Available <code>cpu</code> values: 1024 (1 vCPU)</p> </li> <li> <p>Between 4096 (4 GB) and 16384 (16 GB) in increments of 1024 (1 GB) - Available <code>cpu</code> values: 2048 (2 vCPU)</p> </li> <li> <p>Between 8192 (8 GB) and 30720 (30 GB) in increments of 1024 (1 GB) - Available <code>cpu</code> values: 4096 (4 vCPU)</p> </li> <li> <p>Between 16 GB and 60 GB in 4 GB increments - Available <code>cpu</code> values: 8192 (8 vCPU)</p> <p>This option requires Linux platform <code>1.4.0</code> or later.</p> </li> <li> <p>Between 32GB and 120 GB in 8 GB increments - Available <code>cpu</code> values: 16384 (16 vCPU)</p> <p>This option requires Linux platform <code>1.4.0</code> or later.</p> </li> </ul>
|
|
71
|
+
* @public
|
|
72
|
+
*/
|
|
73
|
+
memory?: string | undefined;
|
|
74
|
+
/**
|
|
75
|
+
* <p>The metadata that you apply to the task definition to help you categorize and organize them. Each tag consists of a key and an optional value. You define both of them.</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>
|
|
76
|
+
* @public
|
|
77
|
+
*/
|
|
78
|
+
tags?: Tag[] | undefined;
|
|
79
|
+
/**
|
|
80
|
+
* <p>The process namespace to use for the containers in the task. The valid values are <code>host</code> or <code>task</code>. On Fargate for Linux containers, the only valid value is <code>task</code>. For example, monitoring sidecars might need <code>pidMode</code> to access information about other containers running in the same task.</p> <p>If <code>host</code> is specified, all containers within the tasks that specified the <code>host</code> PID mode on the same container instance share the same process namespace with the host Amazon EC2 instance.</p> <p>If <code>task</code> is specified, all containers within the specified task share the same process namespace.</p> <p>If no value is specified, the The default is a private namespace for each container.</p> <p>If the <code>host</code> PID mode is used, there's a heightened risk of undesired process namespace exposure.</p> <note> <p>This parameter is not supported for Windows containers.</p> </note> <note> <p>This parameter is only supported for tasks that are hosted on Fargate if the tasks are using platform version <code>1.4.0</code> or later (Linux). This isn't supported for Windows containers on Fargate.</p> </note>
|
|
81
|
+
* @public
|
|
82
|
+
*/
|
|
83
|
+
pidMode?: PidMode | undefined;
|
|
84
|
+
/**
|
|
85
|
+
* <p>The IPC resource namespace to use for the containers in the task. The valid values are <code>host</code>, <code>task</code>, or <code>none</code>. If <code>host</code> is specified, then all containers within the tasks that specified the <code>host</code> IPC mode on the same container instance share the same IPC resources with the host Amazon EC2 instance. If <code>task</code> is specified, all containers within the specified task share the same IPC resources. If <code>none</code> is specified, then IPC resources within the containers of a task are private and not shared with other containers in a task or on the container instance. If no value is specified, then the IPC resource namespace sharing depends on the Docker daemon setting on the container instance.</p> <p>If the <code>host</code> IPC mode is used, be aware that there is a heightened risk of undesired IPC namespace expose.</p> <p>If you are setting namespaced kernel parameters using <code>systemControls</code> for the containers in the task, the following will apply to your IPC resource namespace. For more information, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task_definition_parameters.html">System Controls</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p> <ul> <li> <p>For tasks that use the <code>host</code> IPC mode, IPC namespace related <code>systemControls</code> are not supported.</p> </li> <li> <p>For tasks that use the <code>task</code> IPC mode, IPC namespace related <code>systemControls</code> will apply to all containers within a task.</p> </li> </ul> <note> <p>This parameter is not supported for Windows containers or tasks run on Fargate.</p> </note>
|
|
86
|
+
* @public
|
|
87
|
+
*/
|
|
88
|
+
ipcMode?: IpcMode | undefined;
|
|
89
|
+
/**
|
|
90
|
+
* <p>The configuration details for the App Mesh proxy.</p> <p>For tasks hosted on Amazon EC2 instances, the container instances require at least version <code>1.26.0</code> of the container agent and at least version <code>1.26.0-1</code> of the <code>ecs-init</code> package to use a proxy configuration. If your container instances are launched from the Amazon ECS-optimized AMI version <code>20190301</code> or later, then they contain the required versions of the container agent and <code>ecs-init</code>. For more information, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-ami-versions.html">Amazon ECS-optimized AMI versions</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p>
|
|
91
|
+
* @public
|
|
92
|
+
*/
|
|
93
|
+
proxyConfiguration?: ProxyConfiguration | undefined;
|
|
94
|
+
/**
|
|
95
|
+
* <p>The Elastic Inference accelerators to use for the containers in the task.</p>
|
|
96
|
+
* @public
|
|
97
|
+
*/
|
|
98
|
+
inferenceAccelerators?: InferenceAccelerator[] | undefined;
|
|
99
|
+
/**
|
|
100
|
+
* <p>The amount of ephemeral storage to allocate for the task. This parameter is used to expand the total amount of ephemeral storage available, beyond the default amount, for tasks hosted on Fargate. For more information, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/using_data_volumes.html">Using data volumes in tasks</a> in the <i>Amazon ECS Developer Guide</i>.</p> <note> <p>For tasks using the Fargate launch type, the task requires the following platforms:</p> <ul> <li> <p>Linux platform version <code>1.4.0</code> or later.</p> </li> <li> <p>Windows platform version <code>1.0.0</code> or later.</p> </li> </ul> </note>
|
|
101
|
+
* @public
|
|
102
|
+
*/
|
|
103
|
+
ephemeralStorage?: EphemeralStorage | undefined;
|
|
104
|
+
/**
|
|
105
|
+
* <p>The operating system that your tasks definitions run on.</p>
|
|
106
|
+
* @public
|
|
107
|
+
*/
|
|
108
|
+
runtimePlatform?: RuntimePlatform | undefined;
|
|
109
|
+
/**
|
|
110
|
+
* <p>Enables fault injection when you register your task definition and allows for fault injection requests to be accepted from the task's containers. The default value is <code>false</code>.</p>
|
|
111
|
+
* @public
|
|
112
|
+
*/
|
|
113
|
+
enableFaultInjection?: boolean | undefined;
|
|
114
|
+
}
|
|
115
|
+
/**
|
|
116
|
+
*
|
|
117
|
+
* @public
|
|
118
|
+
*/
|
|
119
|
+
export interface RegisterTaskDefinitionResponse {
|
|
120
|
+
/**
|
|
121
|
+
* <p>The full description of the registered task definition.</p>
|
|
122
|
+
* @public
|
|
123
|
+
*/
|
|
124
|
+
taskDefinition?: TaskDefinition | undefined;
|
|
125
|
+
/**
|
|
126
|
+
* <p>The list of tags associated with the task definition.</p>
|
|
127
|
+
* @public
|
|
128
|
+
*/
|
|
129
|
+
tags?: Tag[] | undefined;
|
|
130
|
+
}
|
|
131
|
+
/**
|
|
132
|
+
*
|
|
133
|
+
* @public
|
|
134
|
+
*/
|
|
135
|
+
export interface DescribeTasksRequest {
|
|
136
|
+
/**
|
|
137
|
+
* <p>The short name or full Amazon Resource Name (ARN) of the cluster that hosts the task or tasks to describe. If you do not specify a cluster, the default cluster is assumed.</p>
|
|
138
|
+
* @public
|
|
139
|
+
*/
|
|
140
|
+
cluster?: string | undefined;
|
|
141
|
+
/**
|
|
142
|
+
* <p>A list of up to 100 task IDs or full ARN entries.</p>
|
|
143
|
+
* @public
|
|
144
|
+
*/
|
|
145
|
+
tasks: string[] | undefined;
|
|
146
|
+
/**
|
|
147
|
+
* <p>Specifies whether you want to see the resource tags for the task. If <code>TAGS</code> is specified, the tags are included in the response. If this field is omitted, tags aren't included in the response.</p>
|
|
148
|
+
* @public
|
|
149
|
+
*/
|
|
150
|
+
include?: TaskField[] | undefined;
|
|
151
|
+
}
|
|
152
|
+
/**
|
|
153
|
+
* <p>Details about the managed agent status for the container.</p>
|
|
154
|
+
* @public
|
|
155
|
+
*/
|
|
156
|
+
export interface ManagedAgent {
|
|
157
|
+
/**
|
|
158
|
+
* <p>The Unix timestamp for the time when the managed agent was last started.</p>
|
|
159
|
+
* @public
|
|
160
|
+
*/
|
|
161
|
+
lastStartedAt?: Date | undefined;
|
|
162
|
+
/**
|
|
163
|
+
* <p>The name of the managed agent. When the execute command feature is turned on, the managed agent name is <code>ExecuteCommandAgent</code>.</p>
|
|
164
|
+
* @public
|
|
165
|
+
*/
|
|
166
|
+
name?: ManagedAgentName | undefined;
|
|
167
|
+
/**
|
|
168
|
+
* <p>The reason for why the managed agent is in the state it is in.</p>
|
|
169
|
+
* @public
|
|
170
|
+
*/
|
|
171
|
+
reason?: string | undefined;
|
|
172
|
+
/**
|
|
173
|
+
* <p>The last known status of the managed agent.</p>
|
|
174
|
+
* @public
|
|
175
|
+
*/
|
|
176
|
+
lastStatus?: string | undefined;
|
|
177
|
+
}
|
|
178
|
+
/**
|
|
179
|
+
* <p>An object representing the elastic network interface for tasks that use the <code>awsvpc</code> network mode.</p>
|
|
180
|
+
* @public
|
|
181
|
+
*/
|
|
182
|
+
export interface NetworkInterface {
|
|
183
|
+
/**
|
|
184
|
+
* <p>The attachment ID for the network interface.</p>
|
|
185
|
+
* @public
|
|
186
|
+
*/
|
|
187
|
+
attachmentId?: string | undefined;
|
|
188
|
+
/**
|
|
189
|
+
* <p>The private IPv4 address for the network interface.</p>
|
|
190
|
+
* @public
|
|
191
|
+
*/
|
|
192
|
+
privateIpv4Address?: string | undefined;
|
|
193
|
+
/**
|
|
194
|
+
* <p>The private IPv6 address for the network interface.</p>
|
|
195
|
+
* @public
|
|
196
|
+
*/
|
|
197
|
+
ipv6Address?: string | undefined;
|
|
198
|
+
}
|
|
199
|
+
/**
|
|
200
|
+
* <p>A Docker container that's part of a task.</p>
|
|
201
|
+
* @public
|
|
202
|
+
*/
|
|
203
|
+
export interface Container {
|
|
204
|
+
/**
|
|
205
|
+
* <p>The Amazon Resource Name (ARN) of the container.</p>
|
|
206
|
+
* @public
|
|
207
|
+
*/
|
|
208
|
+
containerArn?: string | undefined;
|
|
209
|
+
/**
|
|
210
|
+
* <p>The ARN of the task.</p>
|
|
211
|
+
* @public
|
|
212
|
+
*/
|
|
213
|
+
taskArn?: string | undefined;
|
|
214
|
+
/**
|
|
215
|
+
* <p>The name of the container.</p>
|
|
216
|
+
* @public
|
|
217
|
+
*/
|
|
218
|
+
name?: string | undefined;
|
|
219
|
+
/**
|
|
220
|
+
* <p>The image used for the container.</p>
|
|
221
|
+
* @public
|
|
222
|
+
*/
|
|
223
|
+
image?: string | undefined;
|
|
224
|
+
/**
|
|
225
|
+
* <p>The container image manifest digest.</p>
|
|
226
|
+
* @public
|
|
227
|
+
*/
|
|
228
|
+
imageDigest?: string | undefined;
|
|
229
|
+
/**
|
|
230
|
+
* <p>The ID of the Docker container.</p>
|
|
231
|
+
* @public
|
|
232
|
+
*/
|
|
233
|
+
runtimeId?: string | undefined;
|
|
234
|
+
/**
|
|
235
|
+
* <p>The last known status of the container.</p>
|
|
236
|
+
* @public
|
|
237
|
+
*/
|
|
238
|
+
lastStatus?: string | undefined;
|
|
239
|
+
/**
|
|
240
|
+
* <p>The exit code returned from the container.</p>
|
|
241
|
+
* @public
|
|
242
|
+
*/
|
|
243
|
+
exitCode?: number | undefined;
|
|
244
|
+
/**
|
|
245
|
+
* <p>A short (1024 max characters) human-readable string to provide additional details about a running or stopped container.</p>
|
|
246
|
+
* @public
|
|
247
|
+
*/
|
|
248
|
+
reason?: string | undefined;
|
|
249
|
+
/**
|
|
250
|
+
* <p>The network bindings associated with the container.</p>
|
|
251
|
+
* @public
|
|
252
|
+
*/
|
|
253
|
+
networkBindings?: NetworkBinding[] | undefined;
|
|
254
|
+
/**
|
|
255
|
+
* <p>The network interfaces associated with the container.</p>
|
|
256
|
+
* @public
|
|
257
|
+
*/
|
|
258
|
+
networkInterfaces?: NetworkInterface[] | undefined;
|
|
259
|
+
/**
|
|
260
|
+
* <p>The health status of the container. If health checks aren't configured for this container in its task definition, then it reports the health status as <code>UNKNOWN</code>.</p>
|
|
261
|
+
* @public
|
|
262
|
+
*/
|
|
263
|
+
healthStatus?: HealthStatus | undefined;
|
|
264
|
+
/**
|
|
265
|
+
* <p>The details of any Amazon ECS managed agents associated with the container.</p>
|
|
266
|
+
* @public
|
|
267
|
+
*/
|
|
268
|
+
managedAgents?: ManagedAgent[] | undefined;
|
|
269
|
+
/**
|
|
270
|
+
* <p>The number of CPU units set for the container. The value is <code>0</code> if no value was specified in the container definition when the task definition was registered.</p>
|
|
271
|
+
* @public
|
|
272
|
+
*/
|
|
273
|
+
cpu?: string | undefined;
|
|
274
|
+
/**
|
|
275
|
+
* <p>The hard limit (in MiB) of memory set for the container.</p>
|
|
276
|
+
* @public
|
|
277
|
+
*/
|
|
278
|
+
memory?: string | undefined;
|
|
279
|
+
/**
|
|
280
|
+
* <p>The soft limit (in MiB) of memory set for the container.</p>
|
|
281
|
+
* @public
|
|
282
|
+
*/
|
|
283
|
+
memoryReservation?: string | undefined;
|
|
284
|
+
/**
|
|
285
|
+
* <p>The IDs of each GPU assigned to the container.</p>
|
|
286
|
+
* @public
|
|
287
|
+
*/
|
|
288
|
+
gpuIds?: string[] | undefined;
|
|
289
|
+
}
|
|
290
|
+
/**
|
|
291
|
+
* <p>The amount of ephemeral storage to allocate for the task.</p>
|
|
292
|
+
* @public
|
|
293
|
+
*/
|
|
294
|
+
export interface TaskEphemeralStorage {
|
|
295
|
+
/**
|
|
296
|
+
* <p>The total amount, in GiB, of the ephemeral storage to set for the task. The minimum supported value is <code>20</code> GiB and the maximum supported value is <code>200</code> GiB.</p>
|
|
297
|
+
* @public
|
|
298
|
+
*/
|
|
299
|
+
sizeInGiB?: number | undefined;
|
|
300
|
+
/**
|
|
301
|
+
* <p>Specify an Key Management Service key ID to encrypt the ephemeral storage for the task.</p>
|
|
302
|
+
* @public
|
|
303
|
+
*/
|
|
304
|
+
kmsKeyId?: string | undefined;
|
|
305
|
+
}
|
|
306
|
+
/**
|
|
307
|
+
* <p>The overrides that are sent to a container. An empty container override can be passed in. An example of an empty container override is <code>\{"containerOverrides": [ ] \}</code>. If a non-empty container override is specified, the <code>name</code> parameter must be included.</p> <p>You can use Secrets Manager or Amazon Web Services Systems Manager Parameter Store to store the sensitive data. For more information, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/secrets-envvar.html">Retrieve secrets through environment variables</a> in the Amazon ECS Developer Guide.</p>
|
|
308
|
+
* @public
|
|
309
|
+
*/
|
|
310
|
+
export interface ContainerOverride {
|
|
311
|
+
/**
|
|
312
|
+
* <p>The name of the container that receives the override. This parameter is required if any override is specified.</p>
|
|
313
|
+
* @public
|
|
314
|
+
*/
|
|
315
|
+
name?: string | undefined;
|
|
316
|
+
/**
|
|
317
|
+
* <p>The command to send to the container that overrides the default command from the Docker image or the task definition. You must also specify a container name.</p>
|
|
318
|
+
* @public
|
|
319
|
+
*/
|
|
320
|
+
command?: string[] | undefined;
|
|
321
|
+
/**
|
|
322
|
+
* <p>The environment variables to send to the container. You can add new environment variables, which are added to the container at launch, or you can override the existing environment variables from the Docker image or the task definition. You must also specify a container name.</p>
|
|
323
|
+
* @public
|
|
324
|
+
*/
|
|
325
|
+
environment?: KeyValuePair[] | undefined;
|
|
326
|
+
/**
|
|
327
|
+
* <p>A list of files containing the environment variables to pass to a container, instead of the value from the container definition.</p>
|
|
328
|
+
* @public
|
|
329
|
+
*/
|
|
330
|
+
environmentFiles?: EnvironmentFile[] | undefined;
|
|
331
|
+
/**
|
|
332
|
+
* <p>The number of <code>cpu</code> units reserved for the container, instead of the default value from the task definition. You must also specify a container name.</p>
|
|
333
|
+
* @public
|
|
334
|
+
*/
|
|
335
|
+
cpu?: number | undefined;
|
|
336
|
+
/**
|
|
337
|
+
* <p>The hard limit (in MiB) of memory to present to the container, instead of the default value from the task definition. If your container attempts to exceed the memory specified here, the container is killed. You must also specify a container name.</p>
|
|
338
|
+
* @public
|
|
339
|
+
*/
|
|
340
|
+
memory?: number | undefined;
|
|
341
|
+
/**
|
|
342
|
+
* <p>The soft limit (in MiB) of memory to reserve for the container, instead of the default value from the task definition. You must also specify a container name.</p>
|
|
343
|
+
* @public
|
|
344
|
+
*/
|
|
345
|
+
memoryReservation?: number | undefined;
|
|
346
|
+
/**
|
|
347
|
+
* <p>The type and amount of a resource to assign to a container, instead of the default value from the task definition. The only supported resource is a GPU.</p>
|
|
348
|
+
* @public
|
|
349
|
+
*/
|
|
350
|
+
resourceRequirements?: ResourceRequirement[] | undefined;
|
|
351
|
+
}
|
|
352
|
+
/**
|
|
353
|
+
* <p>Details on an Elastic Inference accelerator task override. This parameter is used to override the Elastic Inference accelerator specified in the task definition. For more information, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-inference.html">Working with Amazon Elastic Inference on Amazon ECS</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p>
|
|
354
|
+
* @public
|
|
355
|
+
*/
|
|
356
|
+
export interface InferenceAcceleratorOverride {
|
|
357
|
+
/**
|
|
358
|
+
* <p>The Elastic Inference accelerator device name to override for the task. This parameter must match a <code>deviceName</code> specified in the task definition.</p>
|
|
359
|
+
* @public
|
|
360
|
+
*/
|
|
361
|
+
deviceName?: string | undefined;
|
|
362
|
+
/**
|
|
363
|
+
* <p>The Elastic Inference accelerator type to use.</p>
|
|
364
|
+
* @public
|
|
365
|
+
*/
|
|
366
|
+
deviceType?: string | undefined;
|
|
367
|
+
}
|
|
368
|
+
/**
|
|
369
|
+
* <p>The overrides that are associated with a task.</p>
|
|
370
|
+
* @public
|
|
371
|
+
*/
|
|
372
|
+
export interface TaskOverride {
|
|
373
|
+
/**
|
|
374
|
+
* <p>One or more container overrides that are sent to a task.</p>
|
|
375
|
+
* @public
|
|
376
|
+
*/
|
|
377
|
+
containerOverrides?: ContainerOverride[] | undefined;
|
|
378
|
+
/**
|
|
379
|
+
* <p>The CPU override for the task.</p>
|
|
380
|
+
* @public
|
|
381
|
+
*/
|
|
382
|
+
cpu?: string | undefined;
|
|
383
|
+
/**
|
|
384
|
+
* <p>The Elastic Inference accelerator override for the task.</p>
|
|
385
|
+
* @public
|
|
386
|
+
*/
|
|
387
|
+
inferenceAcceleratorOverrides?: InferenceAcceleratorOverride[] | undefined;
|
|
388
|
+
/**
|
|
389
|
+
* <p>The Amazon Resource Name (ARN) of the task execution role override for the task. For more information, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task_execution_IAM_role.html">Amazon ECS task execution IAM role</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p>
|
|
390
|
+
* @public
|
|
391
|
+
*/
|
|
392
|
+
executionRoleArn?: string | undefined;
|
|
393
|
+
/**
|
|
394
|
+
* <p>The memory override for the task.</p>
|
|
395
|
+
* @public
|
|
396
|
+
*/
|
|
397
|
+
memory?: string | undefined;
|
|
398
|
+
/**
|
|
399
|
+
* <p>The Amazon Resource Name (ARN) of the role that containers in this task can assume. All containers in this task are granted the permissions that are specified in this role. For more information, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-iam-roles.html">IAM Role for Tasks</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p>
|
|
400
|
+
* @public
|
|
401
|
+
*/
|
|
402
|
+
taskRoleArn?: string | undefined;
|
|
403
|
+
/**
|
|
404
|
+
* <p>The ephemeral storage setting override for the task.</p> <note> <p>This parameter is only supported for tasks hosted on Fargate that use the following platform versions:</p> <ul> <li> <p>Linux platform version <code>1.4.0</code> or later.</p> </li> <li> <p>Windows platform version <code>1.0.0</code> or later.</p> </li> </ul> </note>
|
|
405
|
+
* @public
|
|
406
|
+
*/
|
|
407
|
+
ephemeralStorage?: EphemeralStorage | undefined;
|
|
408
|
+
}
|
|
409
|
+
/**
|
|
410
|
+
* <p>Details on a task in a cluster.</p>
|
|
411
|
+
* @public
|
|
412
|
+
*/
|
|
413
|
+
export interface Task {
|
|
414
|
+
/**
|
|
415
|
+
* <p>The Elastic Network Adapter that's associated with the task if the task uses the <code>awsvpc</code> network mode.</p>
|
|
416
|
+
* @public
|
|
417
|
+
*/
|
|
418
|
+
attachments?: Attachment[] | undefined;
|
|
419
|
+
/**
|
|
420
|
+
* <p>The attributes of the task</p>
|
|
421
|
+
* @public
|
|
422
|
+
*/
|
|
423
|
+
attributes?: Attribute[] | undefined;
|
|
424
|
+
/**
|
|
425
|
+
* <p>The Availability Zone for the task.</p>
|
|
426
|
+
* @public
|
|
427
|
+
*/
|
|
428
|
+
availabilityZone?: string | undefined;
|
|
429
|
+
/**
|
|
430
|
+
* <p>The capacity provider that's associated with the task.</p>
|
|
431
|
+
* @public
|
|
432
|
+
*/
|
|
433
|
+
capacityProviderName?: string | undefined;
|
|
434
|
+
/**
|
|
435
|
+
* <p>The ARN of the cluster that hosts the task.</p>
|
|
436
|
+
* @public
|
|
437
|
+
*/
|
|
438
|
+
clusterArn?: string | undefined;
|
|
439
|
+
/**
|
|
440
|
+
* <p>The connectivity status of a task.</p>
|
|
441
|
+
* @public
|
|
442
|
+
*/
|
|
443
|
+
connectivity?: Connectivity | undefined;
|
|
444
|
+
/**
|
|
445
|
+
* <p>The Unix timestamp for the time when the task last went into <code>CONNECTED</code> status.</p>
|
|
446
|
+
* @public
|
|
447
|
+
*/
|
|
448
|
+
connectivityAt?: Date | undefined;
|
|
449
|
+
/**
|
|
450
|
+
* <p>The ARN of the container instances that host the task.</p>
|
|
451
|
+
* @public
|
|
452
|
+
*/
|
|
453
|
+
containerInstanceArn?: string | undefined;
|
|
454
|
+
/**
|
|
455
|
+
* <p>The containers that's associated with the task.</p>
|
|
456
|
+
* @public
|
|
457
|
+
*/
|
|
458
|
+
containers?: Container[] | undefined;
|
|
459
|
+
/**
|
|
460
|
+
* <p>The number of CPU units used by the task as expressed in a task definition. It can be expressed as an integer using CPU units (for example, <code>1024</code>). It can also be expressed as a string using vCPUs (for example, <code>1 vCPU</code> or <code>1 vcpu</code>). String values are converted to an integer that indicates the CPU units when the task definition is registered.</p> <p>If you're using the EC2 launch type or the external launch type, this field is optional. Supported values are between <code>128</code> CPU units (<code>0.125</code> vCPUs) and <code>196608</code> CPU units (<code>192</code> vCPUs). If you do not specify a value, the parameter is ignored.</p> <p>This field is required for Fargate. For information about the valid values, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task_definition_parameters.html#task_size">Task size</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p>
|
|
461
|
+
* @public
|
|
462
|
+
*/
|
|
463
|
+
cpu?: string | undefined;
|
|
464
|
+
/**
|
|
465
|
+
* <p>The Unix timestamp for the time when the task was created. More specifically, it's for the time when the task entered the <code>PENDING</code> state.</p>
|
|
466
|
+
* @public
|
|
467
|
+
*/
|
|
468
|
+
createdAt?: Date | undefined;
|
|
469
|
+
/**
|
|
470
|
+
* <p>The desired status of the task. For more information, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-lifecycle.html">Task Lifecycle</a>.</p>
|
|
471
|
+
* @public
|
|
472
|
+
*/
|
|
473
|
+
desiredStatus?: string | undefined;
|
|
474
|
+
/**
|
|
475
|
+
* <p>Determines whether execute command functionality is turned on for this task. If <code>true</code>, execute command functionality is turned on all the containers in the task.</p>
|
|
476
|
+
* @public
|
|
477
|
+
*/
|
|
478
|
+
enableExecuteCommand?: boolean | undefined;
|
|
479
|
+
/**
|
|
480
|
+
* <p>The Unix timestamp for the time when the task execution stopped.</p>
|
|
481
|
+
* @public
|
|
482
|
+
*/
|
|
483
|
+
executionStoppedAt?: Date | undefined;
|
|
484
|
+
/**
|
|
485
|
+
* <p>The name of the task group that's associated with the task.</p>
|
|
486
|
+
* @public
|
|
487
|
+
*/
|
|
488
|
+
group?: string | undefined;
|
|
489
|
+
/**
|
|
490
|
+
* <p>The health status for the task. It's determined by the health of the essential containers in the task. If all essential containers in the task are reporting as <code>HEALTHY</code>, the task status also reports as <code>HEALTHY</code>. If any essential containers in the task are reporting as <code>UNHEALTHY</code> or <code>UNKNOWN</code>, the task status also reports as <code>UNHEALTHY</code> or <code>UNKNOWN</code>.</p> <note> <p>The Amazon ECS container agent doesn't monitor or report on Docker health checks that are embedded in a container image and not specified in the container definition. For example, this includes those specified in a parent image or from the image's Dockerfile. Health check parameters that are specified in a container definition override any Docker health checks that are found in the container image.</p> </note>
|
|
491
|
+
* @public
|
|
492
|
+
*/
|
|
493
|
+
healthStatus?: HealthStatus | undefined;
|
|
494
|
+
/**
|
|
495
|
+
* <p>The Elastic Inference accelerator that's associated with the task.</p>
|
|
496
|
+
* @public
|
|
497
|
+
*/
|
|
498
|
+
inferenceAccelerators?: InferenceAccelerator[] | undefined;
|
|
499
|
+
/**
|
|
500
|
+
* <p>The last known status for the task. For more information, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-lifecycle.html">Task Lifecycle</a>.</p>
|
|
501
|
+
* @public
|
|
502
|
+
*/
|
|
503
|
+
lastStatus?: string | undefined;
|
|
504
|
+
/**
|
|
505
|
+
* <p>The infrastructure where your task runs on. For more information, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/launch_types.html">Amazon ECS launch types</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p>
|
|
506
|
+
* @public
|
|
507
|
+
*/
|
|
508
|
+
launchType?: LaunchType | undefined;
|
|
509
|
+
/**
|
|
510
|
+
* <p>The amount of memory (in MiB) that the task uses as expressed in a task definition. It can be expressed as an integer using MiB (for example, <code>1024</code>). If it's expressed as a string using GB (for example, <code>1GB</code> or <code>1 GB</code>), it's converted to an integer indicating the MiB when the task definition is registered.</p> <p>If you use the EC2 launch type, this field is optional.</p> <p>If you use the Fargate launch type, this field is required. You must use one of the following values. The value that you choose determines the range of supported values for the <code>cpu</code> parameter.</p> <ul> <li> <p>512 (0.5 GB), 1024 (1 GB), 2048 (2 GB) - Available <code>cpu</code> values: 256 (.25 vCPU)</p> </li> <li> <p>1024 (1 GB), 2048 (2 GB), 3072 (3 GB), 4096 (4 GB) - Available <code>cpu</code> values: 512 (.5 vCPU)</p> </li> <li> <p>2048 (2 GB), 3072 (3 GB), 4096 (4 GB), 5120 (5 GB), 6144 (6 GB), 7168 (7 GB), 8192 (8 GB) - Available <code>cpu</code> values: 1024 (1 vCPU)</p> </li> <li> <p>Between 4096 (4 GB) and 16384 (16 GB) in increments of 1024 (1 GB) - Available <code>cpu</code> values: 2048 (2 vCPU)</p> </li> <li> <p>Between 8192 (8 GB) and 30720 (30 GB) in increments of 1024 (1 GB) - Available <code>cpu</code> values: 4096 (4 vCPU)</p> </li> <li> <p>Between 16 GB and 60 GB in 4 GB increments - Available <code>cpu</code> values: 8192 (8 vCPU)</p> <p>This option requires Linux platform <code>1.4.0</code> or later.</p> </li> <li> <p>Between 32GB and 120 GB in 8 GB increments - Available <code>cpu</code> values: 16384 (16 vCPU)</p> <p>This option requires Linux platform <code>1.4.0</code> or later.</p> </li> </ul>
|
|
511
|
+
* @public
|
|
512
|
+
*/
|
|
513
|
+
memory?: string | undefined;
|
|
514
|
+
/**
|
|
515
|
+
* <p>One or more container overrides.</p>
|
|
516
|
+
* @public
|
|
517
|
+
*/
|
|
518
|
+
overrides?: TaskOverride | undefined;
|
|
519
|
+
/**
|
|
520
|
+
* <p>The platform version where your task runs on. A platform version is only specified for tasks that use the Fargate launch type. If you didn't specify one, the <code>LATEST</code> platform version is used. For more information, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/platform_versions.html">Fargate Platform Versions</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p>
|
|
521
|
+
* @public
|
|
522
|
+
*/
|
|
523
|
+
platformVersion?: string | undefined;
|
|
524
|
+
/**
|
|
525
|
+
* <p>The operating system that your tasks are running on. A platform family is specified only for tasks that use the Fargate launch type. </p> <p> All tasks that run as part of this service must use the same <code>platformFamily</code> value as the service (for example, <code>LINUX.</code>).</p>
|
|
526
|
+
* @public
|
|
527
|
+
*/
|
|
528
|
+
platformFamily?: string | undefined;
|
|
529
|
+
/**
|
|
530
|
+
* <p>The Unix timestamp for the time when the container image pull began.</p>
|
|
531
|
+
* @public
|
|
532
|
+
*/
|
|
533
|
+
pullStartedAt?: Date | undefined;
|
|
534
|
+
/**
|
|
535
|
+
* <p>The Unix timestamp for the time when the container image pull completed.</p>
|
|
536
|
+
* @public
|
|
537
|
+
*/
|
|
538
|
+
pullStoppedAt?: Date | undefined;
|
|
539
|
+
/**
|
|
540
|
+
* <p>The Unix timestamp for the time when the task started. More specifically, it's for the time when the task transitioned from the <code>PENDING</code> state to the <code>RUNNING</code> state.</p>
|
|
541
|
+
* @public
|
|
542
|
+
*/
|
|
543
|
+
startedAt?: Date | undefined;
|
|
544
|
+
/**
|
|
545
|
+
* <p>The tag specified when a task is started. If an Amazon ECS service started the task, the <code>startedBy</code> parameter contains the deployment ID of that service.</p>
|
|
546
|
+
* @public
|
|
547
|
+
*/
|
|
548
|
+
startedBy?: string | undefined;
|
|
549
|
+
/**
|
|
550
|
+
* <p>The stop code indicating why a task was stopped. The <code>stoppedReason</code> might contain additional details. </p> <p>For more information about stop code, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/stopped-task-error-codes.html">Stopped tasks error codes</a> in the <i>Amazon ECS Developer Guide</i>.</p>
|
|
551
|
+
* @public
|
|
552
|
+
*/
|
|
553
|
+
stopCode?: TaskStopCode | undefined;
|
|
554
|
+
/**
|
|
555
|
+
* <p>The Unix timestamp for the time when the task was stopped. More specifically, it's for the time when the task transitioned from the <code>RUNNING</code> state to the <code>STOPPED</code> state.</p>
|
|
556
|
+
* @public
|
|
557
|
+
*/
|
|
558
|
+
stoppedAt?: Date | undefined;
|
|
559
|
+
/**
|
|
560
|
+
* <p>The reason that the task was stopped.</p>
|
|
561
|
+
* @public
|
|
562
|
+
*/
|
|
563
|
+
stoppedReason?: string | undefined;
|
|
564
|
+
/**
|
|
565
|
+
* <p>The Unix timestamp for the time when the task stops. More specifically, it's for the time when the task transitions from the <code>RUNNING</code> state to <code>STOPPING</code>.</p>
|
|
566
|
+
* @public
|
|
567
|
+
*/
|
|
568
|
+
stoppingAt?: Date | undefined;
|
|
569
|
+
/**
|
|
570
|
+
* <p>The metadata that you apply to the task to help you categorize and organize the task. Each tag consists of a key and an optional value. You define both the key and value.</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>
|
|
571
|
+
* @public
|
|
572
|
+
*/
|
|
573
|
+
tags?: Tag[] | undefined;
|
|
574
|
+
/**
|
|
575
|
+
* <p>The Amazon Resource Name (ARN) of the task.</p>
|
|
576
|
+
* @public
|
|
577
|
+
*/
|
|
578
|
+
taskArn?: string | undefined;
|
|
579
|
+
/**
|
|
580
|
+
* <p>The ARN of the task definition that creates the task.</p>
|
|
581
|
+
* @public
|
|
582
|
+
*/
|
|
583
|
+
taskDefinitionArn?: string | undefined;
|
|
584
|
+
/**
|
|
585
|
+
* <p>The version counter for the task. Every time a task experiences a change that starts a CloudWatch event, the version counter is incremented. If you replicate your Amazon ECS task state with CloudWatch Events, you can compare the version of a task reported by the Amazon ECS API actions with the version reported in CloudWatch Events for the task (inside the <code>detail</code> object) to verify that the version in your event stream is current.</p>
|
|
586
|
+
* @public
|
|
587
|
+
*/
|
|
588
|
+
version?: number | undefined;
|
|
589
|
+
/**
|
|
590
|
+
* <p>The ephemeral storage settings for the task.</p>
|
|
591
|
+
* @public
|
|
592
|
+
*/
|
|
593
|
+
ephemeralStorage?: EphemeralStorage | undefined;
|
|
594
|
+
/**
|
|
595
|
+
* <p>The Fargate ephemeral storage settings for the task.</p>
|
|
596
|
+
* @public
|
|
597
|
+
*/
|
|
598
|
+
fargateEphemeralStorage?: TaskEphemeralStorage | undefined;
|
|
599
|
+
}
|
|
600
|
+
/**
|
|
601
|
+
*
|
|
602
|
+
* @public
|
|
603
|
+
*/
|
|
604
|
+
export interface DescribeTasksResponse {
|
|
605
|
+
/**
|
|
606
|
+
* <p>The list of tasks.</p>
|
|
607
|
+
* @public
|
|
608
|
+
*/
|
|
609
|
+
tasks?: Task[] | undefined;
|
|
610
|
+
/**
|
|
611
|
+
* <p>Any failures associated with the call.</p>
|
|
612
|
+
* @public
|
|
613
|
+
*/
|
|
614
|
+
failures?: Failure[] | undefined;
|
|
615
|
+
}
|
|
616
|
+
/**
|
|
617
|
+
* @public
|
|
618
|
+
*/
|
|
619
|
+
export interface GetTaskProtectionRequest {
|
|
620
|
+
/**
|
|
621
|
+
* <p>The short name or full Amazon Resource Name (ARN) of the cluster that hosts the service that the task sets exist in.</p>
|
|
622
|
+
* @public
|
|
623
|
+
*/
|
|
624
|
+
cluster: string | undefined;
|
|
625
|
+
/**
|
|
626
|
+
* <p>A list of up to 100 task IDs or full ARN entries.</p>
|
|
627
|
+
* @public
|
|
628
|
+
*/
|
|
629
|
+
tasks?: string[] | undefined;
|
|
630
|
+
}
|
|
631
|
+
/**
|
|
632
|
+
* <p>An object representing the protection status details for a task. You can set the protection status with the <a href="https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_UpdateTaskProtection.html">UpdateTaskProtection</a> API and get the status of tasks with the <a href="https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_GetTaskProtection.html">GetTaskProtection</a> API.</p>
|
|
633
|
+
* @public
|
|
634
|
+
*/
|
|
635
|
+
export interface ProtectedTask {
|
|
636
|
+
/**
|
|
637
|
+
* <p>The task ARN.</p>
|
|
638
|
+
* @public
|
|
639
|
+
*/
|
|
640
|
+
taskArn?: string | undefined;
|
|
641
|
+
/**
|
|
642
|
+
* <p>The protection status of the task. If scale-in protection is on for a task, the value is <code>true</code>. Otherwise, it is <code>false</code>.</p>
|
|
643
|
+
* @public
|
|
644
|
+
*/
|
|
645
|
+
protectionEnabled?: boolean | undefined;
|
|
646
|
+
/**
|
|
647
|
+
* <p>The epoch time when protection for the task will expire.</p>
|
|
648
|
+
* @public
|
|
649
|
+
*/
|
|
650
|
+
expirationDate?: Date | undefined;
|
|
651
|
+
}
|
|
652
|
+
/**
|
|
653
|
+
* @public
|
|
654
|
+
*/
|
|
655
|
+
export interface GetTaskProtectionResponse {
|
|
656
|
+
/**
|
|
657
|
+
* <p>A list of tasks with the following information.</p> <ul> <li> <p> <code>taskArn</code>: The task ARN.</p> </li> <li> <p> <code>protectionEnabled</code>: The protection status of the task. If scale-in protection is turned on for a task, the value is <code>true</code>. Otherwise, it is <code>false</code>.</p> </li> <li> <p> <code>expirationDate</code>: The epoch time when protection for the task will expire.</p> </li> </ul>
|
|
658
|
+
* @public
|
|
659
|
+
*/
|
|
660
|
+
protectedTasks?: ProtectedTask[] | undefined;
|
|
661
|
+
/**
|
|
662
|
+
* <p>Any failures associated with the call.</p>
|
|
663
|
+
* @public
|
|
664
|
+
*/
|
|
665
|
+
failures?: Failure[] | undefined;
|
|
666
|
+
}
|
|
667
|
+
/**
|
|
668
|
+
* <p>The termination policy for the Amazon EBS volume when the task exits. For more information, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ebs-volumes.html#ebs-volume-types">Amazon ECS volume termination policy</a>.</p>
|
|
669
|
+
* @public
|
|
670
|
+
*/
|
|
671
|
+
export interface TaskManagedEBSVolumeTerminationPolicy {
|
|
672
|
+
/**
|
|
673
|
+
* <p>Indicates whether the volume should be deleted on when the task stops. If a value of <code>true</code> is specified, Amazon ECS deletes the Amazon EBS volume on your behalf when the task goes into the <code>STOPPED</code> state. If no value is specified, the default value is <code>true</code> is used. When set to <code>false</code>, Amazon ECS leaves the volume in your account.</p>
|
|
674
|
+
* @public
|
|
675
|
+
*/
|
|
676
|
+
deleteOnTermination: boolean | undefined;
|
|
677
|
+
}
|
|
678
|
+
/**
|
|
679
|
+
* <p>The configuration for the Amazon EBS volume that Amazon ECS creates and manages on your behalf. These settings are used to create each Amazon EBS volume, with one volume created for each task.</p>
|
|
680
|
+
* @public
|
|
681
|
+
*/
|
|
682
|
+
export interface TaskManagedEBSVolumeConfiguration {
|
|
683
|
+
/**
|
|
684
|
+
* <p>Indicates whether the volume should be encrypted. If you turn on Region-level Amazon EBS encryption by default but set this value as <code>false</code>, the setting is overridden and the volume is encrypted with the KMS key specified for Amazon EBS encryption by default. This parameter maps 1:1 with the <code>Encrypted</code> parameter of the <a href="https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateVolume.html">CreateVolume API</a> in the <i>Amazon EC2 API Reference</i>.</p>
|
|
685
|
+
* @public
|
|
686
|
+
*/
|
|
687
|
+
encrypted?: boolean | undefined;
|
|
688
|
+
/**
|
|
689
|
+
* <p>The Amazon Resource Name (ARN) identifier of the Amazon Web Services Key Management Service key to use for Amazon EBS encryption. When a key is specified using this parameter, it overrides Amazon EBS default encryption or any KMS key that you specified for cluster-level managed storage encryption. This parameter maps 1:1 with the <code>KmsKeyId</code> parameter of the <a href="https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateVolume.html">CreateVolume API</a> in the <i>Amazon EC2 API Reference</i>. For more information about encrypting Amazon EBS volumes attached to a task, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ebs-kms-encryption.html">Encrypt data stored in Amazon EBS volumes attached to Amazon ECS tasks</a>.</p> <important> <p>Amazon Web Services authenticates the Amazon Web Services Key Management Service key asynchronously. Therefore, if you specify an ID, alias, or ARN that is invalid, the action can appear to complete, but eventually fails.</p> </important>
|
|
690
|
+
* @public
|
|
691
|
+
*/
|
|
692
|
+
kmsKeyId?: string | undefined;
|
|
693
|
+
/**
|
|
694
|
+
* <p>The volume type. This parameter maps 1:1 with the <code>VolumeType</code> parameter of the <a href="https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateVolume.html">CreateVolume API</a> in the <i>Amazon EC2 API Reference</i>. For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ebs-volume-types.html">Amazon EBS volume types</a> in the <i>Amazon EC2 User Guide</i>.</p> <p>The following are the supported volume types.</p> <ul> <li> <p>General Purpose SSD: <code>gp2</code>|<code>gp3</code> </p> </li> <li> <p>Provisioned IOPS SSD: <code>io1</code>|<code>io2</code> </p> </li> <li> <p>Throughput Optimized HDD: <code>st1</code> </p> </li> <li> <p>Cold HDD: <code>sc1</code> </p> </li> <li> <p>Magnetic: <code>standard</code> </p> <note> <p>The magnetic volume type is not supported on Fargate.</p> </note> </li> </ul>
|
|
695
|
+
* @public
|
|
696
|
+
*/
|
|
697
|
+
volumeType?: string | undefined;
|
|
698
|
+
/**
|
|
699
|
+
* <p>The size of the volume in GiB. You must specify either a volume size or a snapshot ID. If you specify a snapshot ID, the snapshot size is used for the volume size by default. You can optionally specify a volume size greater than or equal to the snapshot size. This parameter maps 1:1 with the <code>Size</code> parameter of the <a href="https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateVolume.html">CreateVolume API</a> in the <i>Amazon EC2 API Reference</i>.</p> <p>The following are the supported volume size values for each volume type.</p> <ul> <li> <p> <code>gp2</code> and <code>gp3</code>: 1-16,384</p> </li> <li> <p> <code>io1</code> and <code>io2</code>: 4-16,384</p> </li> <li> <p> <code>st1</code> and <code>sc1</code>: 125-16,384</p> </li> <li> <p> <code>standard</code>: 1-1,024</p> </li> </ul>
|
|
700
|
+
* @public
|
|
701
|
+
*/
|
|
702
|
+
sizeInGiB?: number | undefined;
|
|
703
|
+
/**
|
|
704
|
+
* <p>The snapshot that Amazon ECS uses to create the volume. You must specify either a snapshot ID or a volume size. This parameter maps 1:1 with the <code>SnapshotId</code> parameter of the <a href="https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateVolume.html">CreateVolume API</a> in the <i>Amazon EC2 API Reference</i>.</p>
|
|
705
|
+
* @public
|
|
706
|
+
*/
|
|
707
|
+
snapshotId?: string | undefined;
|
|
708
|
+
/**
|
|
709
|
+
* <p>The rate, in MiB/s, at which data is fetched from a snapshot of an existing Amazon EBS volume to create a new volume for attachment to the task. This property can be specified only if you specify a <code>snapshotId</code>. For more information, see <a href="https://docs.aws.amazon.com/ebs/latest/userguide/initalize-volume.html">Initialize Amazon EBS volumes</a> in the <i>Amazon EBS User Guide</i>.</p>
|
|
710
|
+
* @public
|
|
711
|
+
*/
|
|
712
|
+
volumeInitializationRate?: number | undefined;
|
|
713
|
+
/**
|
|
714
|
+
* <p>The number of I/O operations per second (IOPS). For <code>gp3</code>, <code>io1</code>, and <code>io2</code> volumes, this represents the number of IOPS that are provisioned for the volume. For <code>gp2</code> volumes, this represents the baseline performance of the volume and the rate at which the volume accumulates I/O credits for bursting.</p> <p>The following are the supported values for each volume type.</p> <ul> <li> <p> <code>gp3</code>: 3,000 - 16,000 IOPS</p> </li> <li> <p> <code>io1</code>: 100 - 64,000 IOPS</p> </li> <li> <p> <code>io2</code>: 100 - 256,000 IOPS</p> </li> </ul> <p>This parameter is required for <code>io1</code> and <code>io2</code> volume types. The default for <code>gp3</code> volumes is <code>3,000 IOPS</code>. This parameter is not supported for <code>st1</code>, <code>sc1</code>, or <code>standard</code> volume types.</p> <p>This parameter maps 1:1 with the <code>Iops</code> parameter of the <a href="https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateVolume.html">CreateVolume API</a> in the <i>Amazon EC2 API Reference</i>.</p>
|
|
715
|
+
* @public
|
|
716
|
+
*/
|
|
717
|
+
iops?: number | undefined;
|
|
718
|
+
/**
|
|
719
|
+
* <p>The throughput to provision for a volume, in MiB/s, with a maximum of 1,000 MiB/s. This parameter maps 1:1 with the <code>Throughput</code> parameter of the <a href="https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateVolume.html">CreateVolume API</a> in the <i>Amazon EC2 API Reference</i>.</p> <important> <p>This parameter is only supported for the <code>gp3</code> volume type.</p> </important>
|
|
720
|
+
* @public
|
|
721
|
+
*/
|
|
722
|
+
throughput?: number | undefined;
|
|
723
|
+
/**
|
|
724
|
+
* <p>The tags to apply to the volume. Amazon ECS applies service-managed tags by default. This parameter maps 1:1 with the <code>TagSpecifications.N</code> parameter of the <a href="https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateVolume.html">CreateVolume API</a> in the <i>Amazon EC2 API Reference</i>.</p>
|
|
725
|
+
* @public
|
|
726
|
+
*/
|
|
727
|
+
tagSpecifications?: EBSTagSpecification[] | undefined;
|
|
728
|
+
/**
|
|
729
|
+
* <p>The ARN of the IAM role to associate with this volume. This is the Amazon ECS infrastructure IAM role that is used to manage your Amazon Web Services infrastructure. We recommend using the Amazon ECS-managed <code>AmazonECSInfrastructureRolePolicyForVolumes</code> IAM policy with this role. For more information, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/infrastructure_IAM_role.html">Amazon ECS infrastructure IAM role</a> in the <i>Amazon ECS Developer Guide</i>.</p>
|
|
730
|
+
* @public
|
|
731
|
+
*/
|
|
732
|
+
roleArn: string | undefined;
|
|
733
|
+
/**
|
|
734
|
+
* <p>The termination policy for the volume when the task exits. This provides a way to control whether Amazon ECS terminates the Amazon EBS volume when the task stops.</p>
|
|
735
|
+
* @public
|
|
736
|
+
*/
|
|
737
|
+
terminationPolicy?: TaskManagedEBSVolumeTerminationPolicy | undefined;
|
|
738
|
+
/**
|
|
739
|
+
* <p>The Linux filesystem type for the volume. For volumes created from a snapshot, you must specify the same filesystem type that the volume was using when the snapshot was created. If there is a filesystem type mismatch, the task will fail to start.</p> <p>The available filesystem types are <code>ext3</code>, <code>ext4</code>, and <code>xfs</code>. If no value is specified, the <code>xfs</code> filesystem type is used by default.</p>
|
|
740
|
+
* @public
|
|
741
|
+
*/
|
|
742
|
+
filesystemType?: TaskFilesystemType | undefined;
|
|
743
|
+
}
|
|
744
|
+
/**
|
|
745
|
+
* <p>Configuration settings for the task volume that was <code>configuredAtLaunch</code> that weren't set during <code>RegisterTaskDef</code>.</p>
|
|
746
|
+
* @public
|
|
747
|
+
*/
|
|
748
|
+
export interface TaskVolumeConfiguration {
|
|
749
|
+
/**
|
|
750
|
+
* <p>The name of the volume. This value must match the volume name from the <code>Volume</code> object in the task definition.</p>
|
|
751
|
+
* @public
|
|
752
|
+
*/
|
|
753
|
+
name: string | undefined;
|
|
754
|
+
/**
|
|
755
|
+
* <p>The configuration for the Amazon EBS volume that Amazon ECS creates and manages on your behalf. These settings are used to create each Amazon EBS volume, with one volume created for each task. The Amazon EBS volumes are visible in your account in the Amazon EC2 console once they are created.</p>
|
|
756
|
+
* @public
|
|
757
|
+
*/
|
|
758
|
+
managedEBSVolume?: TaskManagedEBSVolumeConfiguration | undefined;
|
|
759
|
+
}
|
|
760
|
+
/**
|
|
761
|
+
*
|
|
762
|
+
* @public
|
|
763
|
+
*/
|
|
764
|
+
export interface RunTaskRequest {
|
|
765
|
+
/**
|
|
766
|
+
* <p>The capacity provider strategy to use for the task.</p> <note> <p>If you want to use Amazon ECS Managed Instances, you must use the <code>capacityProviderStrategy</code> request parameter and omit the <code>launchType</code> request parameter.</p> </note> <p>If a <code>capacityProviderStrategy</code> is specified, the <code>launchType</code> parameter must be omitted. If no <code>capacityProviderStrategy</code> or <code>launchType</code> is specified, the <code>defaultCapacityProviderStrategy</code> for the cluster is used.</p> <p>When you use cluster auto scaling, you must specify <code>capacityProviderStrategy</code> and not <code>launchType</code>. </p> <p>A capacity provider strategy can contain a maximum of 20 capacity providers.</p>
|
|
767
|
+
* @public
|
|
768
|
+
*/
|
|
769
|
+
capacityProviderStrategy?: CapacityProviderStrategyItem[] | undefined;
|
|
770
|
+
/**
|
|
771
|
+
* <p>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.</p> <p>Each account receives a default cluster the first time you use the service, but you may also create other clusters.</p>
|
|
772
|
+
* @public
|
|
773
|
+
*/
|
|
774
|
+
cluster?: string | undefined;
|
|
775
|
+
/**
|
|
776
|
+
* <p>The number of instantiations of the specified task to place on your cluster. You can specify up to 10 tasks for each call.</p>
|
|
777
|
+
* @public
|
|
778
|
+
*/
|
|
779
|
+
count?: number | undefined;
|
|
780
|
+
/**
|
|
781
|
+
* <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>
|
|
782
|
+
* @public
|
|
783
|
+
*/
|
|
784
|
+
enableECSManagedTags?: boolean | undefined;
|
|
785
|
+
/**
|
|
786
|
+
* <p>Determines whether to use the execute command functionality for the containers in this task. If <code>true</code>, this enables execute command functionality on all containers in the task.</p> <p>If <code>true</code>, then the task definition must have a task role, or you must provide one as an override.</p>
|
|
787
|
+
* @public
|
|
788
|
+
*/
|
|
789
|
+
enableExecuteCommand?: boolean | undefined;
|
|
790
|
+
/**
|
|
791
|
+
* <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, <code>family:my-family-name</code>).</p>
|
|
792
|
+
* @public
|
|
793
|
+
*/
|
|
794
|
+
group?: string | undefined;
|
|
795
|
+
/**
|
|
796
|
+
* <p>The infrastructure to run your standalone task on. For more information, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/launch_types.html">Amazon ECS launch types</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p> <note> <p>If you want to use Amazon ECS Managed Instances, you must use the <code>capacityProviderStrategy</code> request parameter and omit the <code>launchType</code> request parameter.</p> </note> <p>The <code>FARGATE</code> launch type runs your tasks on Fargate On-Demand infrastructure.</p> <note> <p>Fargate Spot infrastructure is available for use but a capacity provider strategy must be used. For more information, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/fargate-capacity-providers.html">Fargate capacity providers</a> in the <i>Amazon ECS Developer Guide</i>.</p> </note> <p>The <code>EC2</code> launch type runs your tasks on Amazon EC2 instances registered to your cluster.</p> <p>The <code>EXTERNAL</code> launch type runs your tasks on your on-premises server or virtual machine (VM) capacity registered to your cluster.</p> <p>A task can use either a launch type or a capacity provider strategy. If a <code>launchType</code> is specified, the <code>capacityProviderStrategy</code> parameter must be omitted.</p> <p>When you use cluster auto scaling, you must specify <code>capacityProviderStrategy</code> and not <code>launchType</code>. </p>
|
|
797
|
+
* @public
|
|
798
|
+
*/
|
|
799
|
+
launchType?: LaunchType | undefined;
|
|
800
|
+
/**
|
|
801
|
+
* <p>The network configuration for the task. This parameter is required for task definitions that use the <code>awsvpc</code> network mode to receive their own elastic network interface, and it isn't supported for other network modes. For more information, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-networking.html">Task networking</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p>
|
|
802
|
+
* @public
|
|
803
|
+
*/
|
|
804
|
+
networkConfiguration?: NetworkConfiguration | undefined;
|
|
805
|
+
/**
|
|
806
|
+
* <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 should receive. 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> <p>A total of 8192 characters are allowed for overrides. This limit includes the JSON formatting characters of the override structure.</p>
|
|
807
|
+
* @public
|
|
808
|
+
*/
|
|
809
|
+
overrides?: TaskOverride | undefined;
|
|
810
|
+
/**
|
|
811
|
+
* <p>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).</p>
|
|
812
|
+
* @public
|
|
813
|
+
*/
|
|
814
|
+
placementConstraints?: PlacementConstraint[] | undefined;
|
|
815
|
+
/**
|
|
816
|
+
* <p>The placement strategy objects to use for the task. You can specify a maximum of 5 strategy rules for each task.</p>
|
|
817
|
+
* @public
|
|
818
|
+
*/
|
|
819
|
+
placementStrategy?: PlacementStrategy[] | undefined;
|
|
820
|
+
/**
|
|
821
|
+
* <p>The platform version the task uses. A platform version is only specified for tasks hosted on Fargate. If one isn't specified, the <code>LATEST</code> platform version is used. For more information, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/platform_versions.html">Fargate platform versions</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p>
|
|
822
|
+
* @public
|
|
823
|
+
*/
|
|
824
|
+
platformVersion?: string | undefined;
|
|
825
|
+
/**
|
|
826
|
+
* <p>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 the<a href="https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_TagResource.html">TagResource</a> API action.</p> <note> <p>An error will be received if you specify the <code>SERVICE</code> option when running a task.</p> </note>
|
|
827
|
+
* @public
|
|
828
|
+
*/
|
|
829
|
+
propagateTags?: PropagateTags | undefined;
|
|
830
|
+
/**
|
|
831
|
+
* <p>This parameter is only used by Amazon ECS. It is not intended for use by customers.</p>
|
|
832
|
+
* @public
|
|
833
|
+
*/
|
|
834
|
+
referenceId?: string | undefined;
|
|
835
|
+
/**
|
|
836
|
+
* <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 128 letters (uppercase and lowercase), numbers, hyphens (-), forward slash (/), and underscores (_) are allowed.</p> <p>If a task is started by an Amazon ECS service, then the <code>startedBy</code> parameter contains the deployment ID of the service that starts it.</p>
|
|
837
|
+
* @public
|
|
838
|
+
*/
|
|
839
|
+
startedBy?: string | undefined;
|
|
840
|
+
/**
|
|
841
|
+
* <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>
|
|
842
|
+
* @public
|
|
843
|
+
*/
|
|
844
|
+
tags?: Tag[] | undefined;
|
|
845
|
+
/**
|
|
846
|
+
* <p>The <code>family</code> and <code>revision</code> (<code>family:revision</code>) or full ARN of the task definition to run. If a <code>revision</code> isn't specified, the latest <code>ACTIVE</code> revision is used.</p> <p>The full ARN value must match the value that you specified as the <code>Resource</code> of the principal's permissions policy.</p> <p>When you specify a task definition, you must either specify a specific revision, or all revisions in the ARN.</p> <p>To specify a specific revision, include the revision number in the ARN. For example, to specify revision 2, use <code>arn:aws:ecs:us-east-1:111122223333:task-definition/TaskFamilyName:2</code>.</p> <p>To specify all revisions, use the wildcard (*) in the ARN. For example, to specify all revisions, use <code>arn:aws:ecs:us-east-1:111122223333:task-definition/TaskFamilyName:*</code>.</p> <p>For more information, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/security_iam_service-with-iam.html#security_iam_service-with-iam-id-based-policies-resources">Policy Resources for Amazon ECS</a> in the Amazon Elastic Container Service Developer Guide.</p>
|
|
847
|
+
* @public
|
|
848
|
+
*/
|
|
849
|
+
taskDefinition: string | undefined;
|
|
850
|
+
/**
|
|
851
|
+
* <p>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 <a href="https://docs.aws.amazon.com/AmazonECS/latest/APIReference/ECS_Idempotency.html">Ensuring idempotency</a>.</p>
|
|
852
|
+
* @public
|
|
853
|
+
*/
|
|
854
|
+
clientToken?: string | undefined;
|
|
855
|
+
/**
|
|
856
|
+
* <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>
|
|
857
|
+
* @public
|
|
858
|
+
*/
|
|
859
|
+
volumeConfigurations?: TaskVolumeConfiguration[] | undefined;
|
|
860
|
+
}
|
|
861
|
+
/**
|
|
862
|
+
*
|
|
863
|
+
* @public
|
|
864
|
+
*/
|
|
865
|
+
export interface RunTaskResponse {
|
|
866
|
+
/**
|
|
867
|
+
* <p>A full description of the tasks that were run. The tasks that were successfully placed on your cluster are described here.</p>
|
|
868
|
+
* @public
|
|
869
|
+
*/
|
|
870
|
+
tasks?: Task[] | undefined;
|
|
871
|
+
/**
|
|
872
|
+
* <p>Any failures associated with the call.</p> <p>For information about how to address failures, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-event-messages.html#service-event-messages-list">Service event messages</a> and <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/api_failures_messages.html">API failure reasons</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p>
|
|
873
|
+
* @public
|
|
874
|
+
*/
|
|
875
|
+
failures?: Failure[] | undefined;
|
|
876
|
+
}
|
|
877
|
+
/**
|
|
878
|
+
*
|
|
879
|
+
* @public
|
|
880
|
+
*/
|
|
881
|
+
export interface StartTaskRequest {
|
|
882
|
+
/**
|
|
883
|
+
* <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>
|
|
884
|
+
* @public
|
|
885
|
+
*/
|
|
886
|
+
cluster?: string | undefined;
|
|
887
|
+
/**
|
|
888
|
+
* <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>
|
|
889
|
+
* @public
|
|
890
|
+
*/
|
|
891
|
+
containerInstances: string[] | undefined;
|
|
892
|
+
/**
|
|
893
|
+
* <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>
|
|
894
|
+
* @public
|
|
895
|
+
*/
|
|
896
|
+
enableECSManagedTags?: boolean | undefined;
|
|
897
|
+
/**
|
|
898
|
+
* <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>
|
|
899
|
+
* @public
|
|
900
|
+
*/
|
|
901
|
+
enableExecuteCommand?: boolean | undefined;
|
|
902
|
+
/**
|
|
903
|
+
* <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>
|
|
904
|
+
* @public
|
|
905
|
+
*/
|
|
906
|
+
group?: string | undefined;
|
|
907
|
+
/**
|
|
908
|
+
* <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>
|
|
909
|
+
* @public
|
|
910
|
+
*/
|
|
911
|
+
networkConfiguration?: NetworkConfiguration | undefined;
|
|
912
|
+
/**
|
|
913
|
+
* <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>
|
|
914
|
+
* @public
|
|
915
|
+
*/
|
|
916
|
+
overrides?: TaskOverride | undefined;
|
|
917
|
+
/**
|
|
918
|
+
* <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>
|
|
919
|
+
* @public
|
|
920
|
+
*/
|
|
921
|
+
propagateTags?: PropagateTags | undefined;
|
|
922
|
+
/**
|
|
923
|
+
* <p>This parameter is only used by Amazon ECS. It is not intended for use by customers.</p>
|
|
924
|
+
* @public
|
|
925
|
+
*/
|
|
926
|
+
referenceId?: string | undefined;
|
|
927
|
+
/**
|
|
928
|
+
* <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>
|
|
929
|
+
* @public
|
|
930
|
+
*/
|
|
931
|
+
startedBy?: string | undefined;
|
|
932
|
+
/**
|
|
933
|
+
* <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>
|
|
934
|
+
* @public
|
|
935
|
+
*/
|
|
936
|
+
tags?: Tag[] | undefined;
|
|
937
|
+
/**
|
|
938
|
+
* <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>
|
|
939
|
+
* @public
|
|
940
|
+
*/
|
|
941
|
+
taskDefinition: string | undefined;
|
|
942
|
+
/**
|
|
943
|
+
* <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>
|
|
944
|
+
* @public
|
|
945
|
+
*/
|
|
946
|
+
volumeConfigurations?: TaskVolumeConfiguration[] | undefined;
|
|
947
|
+
}
|
|
948
|
+
/**
|
|
949
|
+
*
|
|
950
|
+
* @public
|
|
951
|
+
*/
|
|
952
|
+
export interface StartTaskResponse {
|
|
953
|
+
/**
|
|
954
|
+
* <p>A full description of the tasks that were started. Each task that was successfully placed on your container instances is described.</p>
|
|
955
|
+
* @public
|
|
956
|
+
*/
|
|
957
|
+
tasks?: Task[] | undefined;
|
|
958
|
+
/**
|
|
959
|
+
* <p>Any failures associated with the call.</p>
|
|
960
|
+
* @public
|
|
961
|
+
*/
|
|
962
|
+
failures?: Failure[] | undefined;
|
|
963
|
+
}
|
|
964
|
+
/**
|
|
965
|
+
*
|
|
966
|
+
* @public
|
|
967
|
+
*/
|
|
968
|
+
export interface StopTaskRequest {
|
|
969
|
+
/**
|
|
970
|
+
* <p>The short name or full Amazon Resource Name (ARN) of the cluster that hosts the task to stop. If you do not specify a cluster, the default cluster is assumed.</p>
|
|
971
|
+
* @public
|
|
972
|
+
*/
|
|
973
|
+
cluster?: string | undefined;
|
|
974
|
+
/**
|
|
975
|
+
* <p>Thefull Amazon Resource Name (ARN) of the task.</p>
|
|
976
|
+
* @public
|
|
977
|
+
*/
|
|
978
|
+
task: string | undefined;
|
|
979
|
+
/**
|
|
980
|
+
* <p>An optional message specified when a task is stopped. For example, if you're using a custom scheduler, you can use this parameter to specify the reason for stopping the task here, and the message appears in subsequent <a href="https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_DescribeTasks.html">DescribeTasks</a>> API operations on this task.</p>
|
|
981
|
+
* @public
|
|
982
|
+
*/
|
|
983
|
+
reason?: string | undefined;
|
|
984
|
+
}
|
|
985
|
+
/**
|
|
986
|
+
*
|
|
987
|
+
* @public
|
|
988
|
+
*/
|
|
989
|
+
export interface StopTaskResponse {
|
|
990
|
+
/**
|
|
991
|
+
* <p>The task that was stopped.</p>
|
|
992
|
+
* @public
|
|
993
|
+
*/
|
|
994
|
+
task?: Task | undefined;
|
|
995
|
+
}
|
|
996
|
+
/**
|
|
997
|
+
* @public
|
|
998
|
+
*/
|
|
999
|
+
export interface UpdateTaskProtectionRequest {
|
|
1000
|
+
/**
|
|
1001
|
+
* <p>The short name or full Amazon Resource Name (ARN) of the cluster that hosts the service that the task sets exist in.</p>
|
|
1002
|
+
* @public
|
|
1003
|
+
*/
|
|
1004
|
+
cluster: string | undefined;
|
|
1005
|
+
/**
|
|
1006
|
+
* <p>A list of up to 10 task IDs or full ARN entries.</p>
|
|
1007
|
+
* @public
|
|
1008
|
+
*/
|
|
1009
|
+
tasks: string[] | undefined;
|
|
1010
|
+
/**
|
|
1011
|
+
* <p>Specify <code>true</code> to mark a task for protection and <code>false</code> to unset protection, making it eligible for termination.</p>
|
|
1012
|
+
* @public
|
|
1013
|
+
*/
|
|
1014
|
+
protectionEnabled: boolean | undefined;
|
|
1015
|
+
/**
|
|
1016
|
+
* <p>If you set <code>protectionEnabled</code> to <code>true</code>, you can specify the duration for task protection in minutes. You can specify a value from 1 minute to up to 2,880 minutes (48 hours). During this time, your task will not be terminated by scale-in events from Service Auto Scaling or deployments. After this time period lapses, <code>protectionEnabled</code> will be reset to <code>false</code>.</p> <p>If you don’t specify the time, then the task is automatically protected for 120 minutes (2 hours).</p>
|
|
1017
|
+
* @public
|
|
1018
|
+
*/
|
|
1019
|
+
expiresInMinutes?: number | undefined;
|
|
1020
|
+
}
|
|
1021
|
+
/**
|
|
1022
|
+
* @public
|
|
1023
|
+
*/
|
|
1024
|
+
export interface UpdateTaskProtectionResponse {
|
|
1025
|
+
/**
|
|
1026
|
+
* <p>A list of tasks with the following information.</p> <ul> <li> <p> <code>taskArn</code>: The task ARN.</p> </li> <li> <p> <code>protectionEnabled</code>: The protection status of the task. If scale-in protection is turned on for a task, the value is <code>true</code>. Otherwise, it is <code>false</code>.</p> </li> <li> <p> <code>expirationDate</code>: The epoch time when protection for the task will expire.</p> </li> </ul>
|
|
1027
|
+
* @public
|
|
1028
|
+
*/
|
|
1029
|
+
protectedTasks?: ProtectedTask[] | undefined;
|
|
1030
|
+
/**
|
|
1031
|
+
* <p>Any failures associated with the call.</p>
|
|
1032
|
+
* @public
|
|
1033
|
+
*/
|
|
1034
|
+
failures?: Failure[] | undefined;
|
|
1035
|
+
}
|
|
1036
|
+
/**
|
|
1037
|
+
* @public
|
|
1038
|
+
*/
|
|
1039
|
+
export interface CreateTaskSetRequest {
|
|
1040
|
+
/**
|
|
1041
|
+
* <p>The short name or full Amazon Resource Name (ARN) of the service to create the task set in.</p>
|
|
1042
|
+
* @public
|
|
1043
|
+
*/
|
|
1044
|
+
service: string | undefined;
|
|
1045
|
+
/**
|
|
1046
|
+
* <p>The short name or full Amazon Resource Name (ARN) of the cluster that hosts the service to create the task set in.</p>
|
|
1047
|
+
* @public
|
|
1048
|
+
*/
|
|
1049
|
+
cluster: string | undefined;
|
|
1050
|
+
/**
|
|
1051
|
+
* <p>An optional non-unique tag that identifies this task set in external systems. If the task set is associated with a service discovery registry, the tasks in this task set will have the <code>ECS_TASK_SET_EXTERNAL_ID</code> Cloud Map attribute set to the provided value.</p>
|
|
1052
|
+
* @public
|
|
1053
|
+
*/
|
|
1054
|
+
externalId?: string | undefined;
|
|
1055
|
+
/**
|
|
1056
|
+
* <p>The task definition for the tasks in the task set to use. If a revision isn't specified, the latest <code>ACTIVE</code> revision is used.</p>
|
|
1057
|
+
* @public
|
|
1058
|
+
*/
|
|
1059
|
+
taskDefinition: string | undefined;
|
|
1060
|
+
/**
|
|
1061
|
+
* <p>An object representing the network configuration for a task set.</p>
|
|
1062
|
+
* @public
|
|
1063
|
+
*/
|
|
1064
|
+
networkConfiguration?: NetworkConfiguration | undefined;
|
|
1065
|
+
/**
|
|
1066
|
+
* <p>A load balancer object representing the load balancer to use with the task set. The supported load balancer types are either an Application Load Balancer or a Network Load Balancer.</p>
|
|
1067
|
+
* @public
|
|
1068
|
+
*/
|
|
1069
|
+
loadBalancers?: LoadBalancer[] | undefined;
|
|
1070
|
+
/**
|
|
1071
|
+
* <p>The details of the service discovery registries to assign to this task set. For more information, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-discovery.html">Service discovery</a>.</p>
|
|
1072
|
+
* @public
|
|
1073
|
+
*/
|
|
1074
|
+
serviceRegistries?: ServiceRegistry[] | undefined;
|
|
1075
|
+
/**
|
|
1076
|
+
* <p>The launch type that new tasks in the task set uses. For more information, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/launch_types.html">Amazon ECS launch types</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p> <p>If a <code>launchType</code> is specified, the <code>capacityProviderStrategy</code> parameter must be omitted.</p>
|
|
1077
|
+
* @public
|
|
1078
|
+
*/
|
|
1079
|
+
launchType?: LaunchType | undefined;
|
|
1080
|
+
/**
|
|
1081
|
+
* <p>The capacity provider strategy to use for the task set.</p> <p>A capacity provider strategy consists of one or more capacity providers along with the <code>base</code> and <code>weight</code> to assign to them. A capacity provider must be associated with the cluster to be used in a capacity provider strategy. The <a href="https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_PutClusterCapacityProviders.html">PutClusterCapacityProviders</a> API is used to associate a capacity provider with a cluster. Only capacity providers with an <code>ACTIVE</code> or <code>UPDATING</code> status can be used.</p> <p>If a <code>capacityProviderStrategy</code> is specified, the <code>launchType</code> parameter must be omitted. If no <code>capacityProviderStrategy</code> or <code>launchType</code> is specified, the <code>defaultCapacityProviderStrategy</code> for the cluster is used.</p> <p>If specifying a capacity provider that uses an Auto Scaling group, the capacity provider must already be created. New capacity providers can be created with the <a href="https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_CreateCapacityProviderProvider.html">CreateCapacityProviderProvider</a>API operation.</p> <p>To use a Fargate capacity provider, specify either the <code>FARGATE</code> or <code>FARGATE_SPOT</code> capacity providers. The Fargate capacity providers are available to all accounts and only need to be associated with a cluster to be used.</p> <p>The <a href="https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_PutClusterCapacityProviders.html">PutClusterCapacityProviders</a> API operation is used to update the list of available capacity providers for a cluster after the cluster is created.</p>
|
|
1082
|
+
* @public
|
|
1083
|
+
*/
|
|
1084
|
+
capacityProviderStrategy?: CapacityProviderStrategyItem[] | undefined;
|
|
1085
|
+
/**
|
|
1086
|
+
* <p>The platform version that the tasks in the task set uses. A platform version is specified only for tasks using the Fargate launch type. If one isn't specified, the <code>LATEST</code> platform version is used.</p>
|
|
1087
|
+
* @public
|
|
1088
|
+
*/
|
|
1089
|
+
platformVersion?: string | undefined;
|
|
1090
|
+
/**
|
|
1091
|
+
* <p>A floating-point percentage of the desired number of tasks to place and keep running in the task set.</p>
|
|
1092
|
+
* @public
|
|
1093
|
+
*/
|
|
1094
|
+
scale?: Scale | undefined;
|
|
1095
|
+
/**
|
|
1096
|
+
* <p>An identifier that you provide to ensure the idempotency of the request. It must be unique and is case sensitive. Up to 36 ASCII characters in the range of 33-126 (inclusive) are allowed.</p>
|
|
1097
|
+
* @public
|
|
1098
|
+
*/
|
|
1099
|
+
clientToken?: string | undefined;
|
|
1100
|
+
/**
|
|
1101
|
+
* <p>The metadata that you apply to the task set to help you categorize and organize them. Each tag consists of a key and an optional value. You define both. When a service is deleted, the tags are deleted.</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>
|
|
1102
|
+
* @public
|
|
1103
|
+
*/
|
|
1104
|
+
tags?: Tag[] | undefined;
|
|
1105
|
+
}
|
|
1106
|
+
/**
|
|
1107
|
+
* @public
|
|
1108
|
+
*/
|
|
1109
|
+
export interface CreateTaskSetResponse {
|
|
1110
|
+
/**
|
|
1111
|
+
* <p>Information about a set of Amazon ECS tasks in either an CodeDeploy or an <code>EXTERNAL</code> deployment. A task set includes details such as the desired number of tasks, how many tasks are running, and whether the task set serves production traffic.</p>
|
|
1112
|
+
* @public
|
|
1113
|
+
*/
|
|
1114
|
+
taskSet?: TaskSet | undefined;
|
|
1115
|
+
}
|
|
1116
|
+
/**
|
|
1117
|
+
* @public
|
|
1118
|
+
*/
|
|
1119
|
+
export interface DeleteTaskSetRequest {
|
|
1120
|
+
/**
|
|
1121
|
+
* <p>The short name or full Amazon Resource Name (ARN) of the cluster that hosts the service that the task set found in to delete.</p>
|
|
1122
|
+
* @public
|
|
1123
|
+
*/
|
|
1124
|
+
cluster: string | undefined;
|
|
1125
|
+
/**
|
|
1126
|
+
* <p>The short name or full Amazon Resource Name (ARN) of the service that hosts the task set to delete.</p>
|
|
1127
|
+
* @public
|
|
1128
|
+
*/
|
|
1129
|
+
service: string | undefined;
|
|
1130
|
+
/**
|
|
1131
|
+
* <p>The task set ID or full Amazon Resource Name (ARN) of the task set to delete.</p>
|
|
1132
|
+
* @public
|
|
1133
|
+
*/
|
|
1134
|
+
taskSet: string | undefined;
|
|
1135
|
+
/**
|
|
1136
|
+
* <p>If <code>true</code>, you can delete a task set even if it hasn't been scaled down to zero.</p>
|
|
1137
|
+
* @public
|
|
1138
|
+
*/
|
|
1139
|
+
force?: boolean | undefined;
|
|
1140
|
+
}
|
|
1141
|
+
/**
|
|
1142
|
+
* @public
|
|
1143
|
+
*/
|
|
1144
|
+
export interface DeleteTaskSetResponse {
|
|
1145
|
+
/**
|
|
1146
|
+
* <p>Details about the task set.</p>
|
|
1147
|
+
* @public
|
|
1148
|
+
*/
|
|
1149
|
+
taskSet?: TaskSet | undefined;
|
|
1150
|
+
}
|
|
1151
|
+
/**
|
|
1152
|
+
* @public
|
|
1153
|
+
*/
|
|
1154
|
+
export interface DescribeTaskSetsRequest {
|
|
1155
|
+
/**
|
|
1156
|
+
* <p>The short name or full Amazon Resource Name (ARN) of the cluster that hosts the service that the task sets exist in.</p>
|
|
1157
|
+
* @public
|
|
1158
|
+
*/
|
|
1159
|
+
cluster: string | undefined;
|
|
1160
|
+
/**
|
|
1161
|
+
* <p>The short name or full Amazon Resource Name (ARN) of the service that the task sets exist in.</p>
|
|
1162
|
+
* @public
|
|
1163
|
+
*/
|
|
1164
|
+
service: string | undefined;
|
|
1165
|
+
/**
|
|
1166
|
+
* <p>The ID or full Amazon Resource Name (ARN) of task sets to describe.</p>
|
|
1167
|
+
* @public
|
|
1168
|
+
*/
|
|
1169
|
+
taskSets?: string[] | undefined;
|
|
1170
|
+
/**
|
|
1171
|
+
* <p>Specifies whether to see the resource tags for the task set. If <code>TAGS</code> is specified, the tags are included in the response. If this field is omitted, tags aren't included in the response.</p>
|
|
1172
|
+
* @public
|
|
1173
|
+
*/
|
|
1174
|
+
include?: TaskSetField[] | undefined;
|
|
1175
|
+
}
|
|
1176
|
+
/**
|
|
1177
|
+
* @public
|
|
1178
|
+
*/
|
|
1179
|
+
export interface DescribeTaskSetsResponse {
|
|
1180
|
+
/**
|
|
1181
|
+
* <p>The list of task sets described.</p>
|
|
1182
|
+
* @public
|
|
1183
|
+
*/
|
|
1184
|
+
taskSets?: TaskSet[] | undefined;
|
|
1185
|
+
/**
|
|
1186
|
+
* <p>Any failures associated with the call.</p>
|
|
1187
|
+
* @public
|
|
1188
|
+
*/
|
|
1189
|
+
failures?: Failure[] | undefined;
|
|
1190
|
+
}
|
|
1191
|
+
/**
|
|
1192
|
+
* @public
|
|
1193
|
+
*/
|
|
1194
|
+
export interface UpdateTaskSetRequest {
|
|
1195
|
+
/**
|
|
1196
|
+
* <p>The short name or full Amazon Resource Name (ARN) of the cluster that hosts the service that the task set is found in.</p>
|
|
1197
|
+
* @public
|
|
1198
|
+
*/
|
|
1199
|
+
cluster: string | undefined;
|
|
1200
|
+
/**
|
|
1201
|
+
* <p>The short name or full Amazon Resource Name (ARN) of the service that the task set is found in.</p>
|
|
1202
|
+
* @public
|
|
1203
|
+
*/
|
|
1204
|
+
service: string | undefined;
|
|
1205
|
+
/**
|
|
1206
|
+
* <p>The short name or full Amazon Resource Name (ARN) of the task set to update.</p>
|
|
1207
|
+
* @public
|
|
1208
|
+
*/
|
|
1209
|
+
taskSet: string | undefined;
|
|
1210
|
+
/**
|
|
1211
|
+
* <p>A floating-point percentage of the desired number of tasks to place and keep running in the task set.</p>
|
|
1212
|
+
* @public
|
|
1213
|
+
*/
|
|
1214
|
+
scale: Scale | undefined;
|
|
1215
|
+
}
|
|
1216
|
+
/**
|
|
1217
|
+
* @public
|
|
1218
|
+
*/
|
|
1219
|
+
export interface UpdateTaskSetResponse {
|
|
1220
|
+
/**
|
|
1221
|
+
* <p>Details about the task set.</p>
|
|
1222
|
+
* @public
|
|
1223
|
+
*/
|
|
1224
|
+
taskSet?: TaskSet | undefined;
|
|
1225
|
+
}
|
|
1226
|
+
/**
|
|
1227
|
+
* @public
|
|
1228
|
+
*/
|
|
1229
|
+
export interface UntagResourceRequest {
|
|
1230
|
+
/**
|
|
1231
|
+
* <p>The Amazon Resource Name (ARN) of the resource to delete tags from. Currently, the supported resources are Amazon ECS capacity providers, tasks, services, task definitions, clusters, and container instances.</p>
|
|
1232
|
+
* @public
|
|
1233
|
+
*/
|
|
1234
|
+
resourceArn: string | undefined;
|
|
1235
|
+
/**
|
|
1236
|
+
* <p>The keys of the tags to be removed.</p>
|
|
1237
|
+
* @public
|
|
1238
|
+
*/
|
|
1239
|
+
tagKeys: string[] | undefined;
|
|
1240
|
+
}
|
|
1241
|
+
/**
|
|
1242
|
+
* @public
|
|
1243
|
+
*/
|
|
1244
|
+
export interface UntagResourceResponse {
|
|
1245
|
+
}
|