💾 Archived View for gmi.noulin.net › gitRepositories › git-off › file › src › node_modules › aws-sdk… captured on 2024-09-29 at 00:41:12. Gemini links have been rewritten to link to archived content

-=-=-=-=-=-=-

git-off

Log

Files

Refs

README

ecs.d.ts (122261B)

1 import {Request} from '../lib/request';
2 import {Response} from '../lib/response';
3 import {AWSError} from '../lib/error';
4 import {Service} from '../lib/service';
5 import {ServiceConfigurationOptions} from '../lib/service';
6 import {ConfigBase as Config} from '../lib/config';
7 interface Blob {}
8 declare class ECS extends Service {
9 /**
10 * Constructs a service object. This object has one method for each API operation.
11 */
12 constructor(options?: ECS.Types.ClientConfiguration)
13 config: Config & ECS.Types.ClientConfiguration;
14 /**
15 * Creates a new Amazon ECS cluster. By default, your account receives a default cluster when you launch your first container instance. However, you can create your own cluster with a unique name with the CreateCluster action.
16 */
17 createCluster(params: ECS.Types.CreateClusterRequest, callback?: (err: AWSError, data: ECS.Types.CreateClusterResponse) => void): Request<ECS.Types.CreateClusterResponse, AWSError>;
18 /**
19 * Creates a new Amazon ECS cluster. By default, your account receives a default cluster when you launch your first container instance. However, you can create your own cluster with a unique name with the CreateCluster action.
20 */
21 createCluster(callback?: (err: AWSError, data: ECS.Types.CreateClusterResponse) => void): Request<ECS.Types.CreateClusterResponse, AWSError>;
22 /**
23 * Runs and maintains a desired number of tasks from a specified task definition. If the number of tasks running in a service drops below desiredCount, Amazon ECS spawns another copy of the task in the specified cluster. To update an existing service, see UpdateService. In addition to maintaining the desired count of tasks in your service, you can optionally run your service behind a load balancer. The load balancer distributes traffic across the tasks that are associated with the service. For more information, see Service Load Balancing in the Amazon EC2 Container Service Developer Guide. You can optionally specify a deployment configuration for your service. During a deployment (which is triggered by changing the task definition or the desired count of a service with an UpdateService operation), the service scheduler uses the minimumHealthyPercent and maximumPercent parameters to determine the deployment strategy. The minimumHealthyPercent represents a lower limit on the number of your service's tasks that must remain in the RUNNING state during a deployment, as a percentage of the desiredCount (rounded up to the nearest integer). This parameter enables you to deploy without using additional cluster capacity. For example, if your service has a desiredCount of four tasks and a minimumHealthyPercent of 50%, the scheduler may stop two existing tasks to free up cluster capacity before starting two new tasks. Tasks for services that do not use a load balancer are considered healthy if they are in the RUNNING state; tasks for services that do use a load balancer are considered healthy if they are in the RUNNING state and the container instance it is hosted on is reported as healthy by the load balancer. The default value for minimumHealthyPercent is 50% in the console and 100% for the AWS CLI, the AWS SDKs, and the APIs. The maximumPercent parameter represents an upper limit on the number of your service's tasks that are allowed in the RUNNING or PENDING state during a deployment, as a percentage of the desiredCount (rounded down to the nearest integer). This parameter enables you to define the deployment batch size. For example, if your service has a desiredCount of four tasks and a maximumPercent value of 200%, the scheduler may start four new tasks before stopping the four older tasks (provided that the cluster resources required to do this are available). The default value for maximumPercent is 200%. When the service scheduler launches new tasks, it attempts to balance them across the Availability Zones in your cluster with the following logic: Determine which of the container instances in your cluster can support your service's task definition (for example, they have the required CPU, memory, ports, and container instance attributes). Sort the valid container instances by the fewest number of running tasks for this service in the same Availability Zone as the instance. For example, if zone A has one running service task and zones B and C each have zero, valid container instances in either zone B or C are considered optimal for placement. Place the new service task on a valid container instance in an optimal Availability Zone (based on the previous steps), favoring container instances with the fewest number of running tasks for this service.
24 */
25 createService(params: ECS.Types.CreateServiceRequest, callback?: (err: AWSError, data: ECS.Types.CreateServiceResponse) => void): Request<ECS.Types.CreateServiceResponse, AWSError>;
26 /**
27 * Runs and maintains a desired number of tasks from a specified task definition. If the number of tasks running in a service drops below desiredCount, Amazon ECS spawns another copy of the task in the specified cluster. To update an existing service, see UpdateService. In addition to maintaining the desired count of tasks in your service, you can optionally run your service behind a load balancer. The load balancer distributes traffic across the tasks that are associated with the service. For more information, see Service Load Balancing in the Amazon EC2 Container Service Developer Guide. You can optionally specify a deployment configuration for your service. During a deployment (which is triggered by changing the task definition or the desired count of a service with an UpdateService operation), the service scheduler uses the minimumHealthyPercent and maximumPercent parameters to determine the deployment strategy. The minimumHealthyPercent represents a lower limit on the number of your service's tasks that must remain in the RUNNING state during a deployment, as a percentage of the desiredCount (rounded up to the nearest integer). This parameter enables you to deploy without using additional cluster capacity. For example, if your service has a desiredCount of four tasks and a minimumHealthyPercent of 50%, the scheduler may stop two existing tasks to free up cluster capacity before starting two new tasks. Tasks for services that do not use a load balancer are considered healthy if they are in the RUNNING state; tasks for services that do use a load balancer are considered healthy if they are in the RUNNING state and the container instance it is hosted on is reported as healthy by the load balancer. The default value for minimumHealthyPercent is 50% in the console and 100% for the AWS CLI, the AWS SDKs, and the APIs. The maximumPercent parameter represents an upper limit on the number of your service's tasks that are allowed in the RUNNING or PENDING state during a deployment, as a percentage of the desiredCount (rounded down to the nearest integer). This parameter enables you to define the deployment batch size. For example, if your service has a desiredCount of four tasks and a maximumPercent value of 200%, the scheduler may start four new tasks before stopping the four older tasks (provided that the cluster resources required to do this are available). The default value for maximumPercent is 200%. When the service scheduler launches new tasks, it attempts to balance them across the Availability Zones in your cluster with the following logic: Determine which of the container instances in your cluster can support your service's task definition (for example, they have the required CPU, memory, ports, and container instance attributes). Sort the valid container instances by the fewest number of running tasks for this service in the same Availability Zone as the instance. For example, if zone A has one running service task and zones B and C each have zero, valid container instances in either zone B or C are considered optimal for placement. Place the new service task on a valid container instance in an optimal Availability Zone (based on the previous steps), favoring container instances with the fewest number of running tasks for this service.
28 */
29 createService(callback?: (err: AWSError, data: ECS.Types.CreateServiceResponse) => void): Request<ECS.Types.CreateServiceResponse, AWSError>;
30 /**
31 * Deletes the specified cluster. You must deregister all container instances from this cluster before you may delete it. You can list the container instances in a cluster with ListContainerInstances and deregister them with DeregisterContainerInstance.
32 */
33 deleteCluster(params: ECS.Types.DeleteClusterRequest, callback?: (err: AWSError, data: ECS.Types.DeleteClusterResponse) => void): Request<ECS.Types.DeleteClusterResponse, AWSError>;
34 /**
35 * Deletes the specified cluster. You must deregister all container instances from this cluster before you may delete it. You can list the container instances in a cluster with ListContainerInstances and deregister them with DeregisterContainerInstance.
36 */
37 deleteCluster(callback?: (err: AWSError, data: ECS.Types.DeleteClusterResponse) => void): Request<ECS.Types.DeleteClusterResponse, AWSError>;
38 /**
39 * Deletes a specified service within a cluster. You can delete a service if you have no running tasks in it and the desired task count is zero. If the service is actively maintaining tasks, you cannot delete it, and you must update the service to a desired task count of zero. For more information, see UpdateService. When you delete a service, if there are still running tasks that require cleanup, the service status moves from ACTIVE to DRAINING, and the service is no longer visible in the console or in ListServices API operations. After the tasks have stopped, then the service status moves from DRAINING to INACTIVE. Services in the DRAINING or INACTIVE status can still be viewed with DescribeServices API operations; however, in the future, INACTIVE services may be cleaned up and purged from Amazon ECS record keeping, and DescribeServices API operations on those services will return a ServiceNotFoundException error.
40 */
41 deleteService(params: ECS.Types.DeleteServiceRequest, callback?: (err: AWSError, data: ECS.Types.DeleteServiceResponse) => void): Request<ECS.Types.DeleteServiceResponse, AWSError>;
42 /**
43 * Deletes a specified service within a cluster. You can delete a service if you have no running tasks in it and the desired task count is zero. If the service is actively maintaining tasks, you cannot delete it, and you must update the service to a desired task count of zero. For more information, see UpdateService. When you delete a service, if there are still running tasks that require cleanup, the service status moves from ACTIVE to DRAINING, and the service is no longer visible in the console or in ListServices API operations. After the tasks have stopped, then the service status moves from DRAINING to INACTIVE. Services in the DRAINING or INACTIVE status can still be viewed with DescribeServices API operations; however, in the future, INACTIVE services may be cleaned up and purged from Amazon ECS record keeping, and DescribeServices API operations on those services will return a ServiceNotFoundException error.
44 */
45 deleteService(callback?: (err: AWSError, data: ECS.Types.DeleteServiceResponse) => void): Request<ECS.Types.DeleteServiceResponse, AWSError>;
46 /**
47 * Deregisters an Amazon ECS container instance from the specified cluster. This instance is no longer available to run tasks. If you intend to use the container instance for some other purpose after deregistration, you should stop all of the tasks running on the container instance before deregistration to avoid any orphaned tasks from consuming resources. Deregistering a container instance removes the instance from a cluster, but it does not terminate the EC2 instance; if you are finished using the instance, be sure to terminate it in the Amazon EC2 console to stop billing. If you terminate a running container instance, Amazon ECS automatically deregisters the instance from your cluster (stopped container instances or instances with disconnected agents are not automatically deregistered when terminated).
48 */
49 deregisterContainerInstance(params: ECS.Types.DeregisterContainerInstanceRequest, callback?: (err: AWSError, data: ECS.Types.DeregisterContainerInstanceResponse) => void): Request<ECS.Types.DeregisterContainerInstanceResponse, AWSError>;
50 /**
51 * Deregisters an Amazon ECS container instance from the specified cluster. This instance is no longer available to run tasks. If you intend to use the container instance for some other purpose after deregistration, you should stop all of the tasks running on the container instance before deregistration to avoid any orphaned tasks from consuming resources. Deregistering a container instance removes the instance from a cluster, but it does not terminate the EC2 instance; if you are finished using the instance, be sure to terminate it in the Amazon EC2 console to stop billing. If you terminate a running container instance, Amazon ECS automatically deregisters the instance from your cluster (stopped container instances or instances with disconnected agents are not automatically deregistered when terminated).
52 */
53 deregisterContainerInstance(callback?: (err: AWSError, data: ECS.Types.DeregisterContainerInstanceResponse) => void): Request<ECS.Types.DeregisterContainerInstanceResponse, AWSError>;
54 /**
55 * Deregisters the specified task definition by family and revision. Upon deregistration, the task definition is marked as INACTIVE. Existing tasks and services that reference an INACTIVE task definition continue to run without disruption. Existing services that reference an INACTIVE task definition can still scale up or down by modifying the service's desired count. You cannot use an INACTIVE task definition to run new tasks or create new services, and you cannot update an existing service to reference an INACTIVE task definition (although there may be up to a 10 minute window following deregistration where these restrictions have not yet taken effect).
56 */
57 deregisterTaskDefinition(params: ECS.Types.DeregisterTaskDefinitionRequest, callback?: (err: AWSError, data: ECS.Types.DeregisterTaskDefinitionResponse) => void): Request<ECS.Types.DeregisterTaskDefinitionResponse, AWSError>;
58 /**
59 * Deregisters the specified task definition by family and revision. Upon deregistration, the task definition is marked as INACTIVE. Existing tasks and services that reference an INACTIVE task definition continue to run without disruption. Existing services that reference an INACTIVE task definition can still scale up or down by modifying the service's desired count. You cannot use an INACTIVE task definition to run new tasks or create new services, and you cannot update an existing service to reference an INACTIVE task definition (although there may be up to a 10 minute window following deregistration where these restrictions have not yet taken effect).
60 */
61 deregisterTaskDefinition(callback?: (err: AWSError, data: ECS.Types.DeregisterTaskDefinitionResponse) => void): Request<ECS.Types.DeregisterTaskDefinitionResponse, AWSError>;
62 /**
63 * Describes one or more of your clusters.
64 */
65 describeClusters(params: ECS.Types.DescribeClustersRequest, callback?: (err: AWSError, data: ECS.Types.DescribeClustersResponse) => void): Request<ECS.Types.DescribeClustersResponse, AWSError>;
66 /**
67 * Describes one or more of your clusters.
68 */
69 describeClusters(callback?: (err: AWSError, data: ECS.Types.DescribeClustersResponse) => void): Request<ECS.Types.DescribeClustersResponse, AWSError>;
70 /**
71 * Describes Amazon EC2 Container Service container instances. Returns metadata about registered and remaining resources on each container instance requested.
72 */
73 describeContainerInstances(params: ECS.Types.DescribeContainerInstancesRequest, callback?: (err: AWSError, data: ECS.Types.DescribeContainerInstancesResponse) => void): Request<ECS.Types.DescribeContainerInstancesResponse, AWSError>;
74 /**
75 * Describes Amazon EC2 Container Service container instances. Returns metadata about registered and remaining resources on each container instance requested.
76 */
77 describeContainerInstances(callback?: (err: AWSError, data: ECS.Types.DescribeContainerInstancesResponse) => void): Request<ECS.Types.DescribeContainerInstancesResponse, AWSError>;
78 /**
79 * Describes the specified services running in your cluster.
80 */
81 describeServices(params: ECS.Types.DescribeServicesRequest, callback?: (err: AWSError, data: ECS.Types.DescribeServicesResponse) => void): Request<ECS.Types.DescribeServicesResponse, AWSError>;
82 /**
83 * Describes the specified services running in your cluster.
84 */
85 describeServices(callback?: (err: AWSError, data: ECS.Types.DescribeServicesResponse) => void): Request<ECS.Types.DescribeServicesResponse, AWSError>;
86 /**
87 * Describes a task definition. You can specify a family and revision to find information about a specific task definition, or you can simply specify the family to find the latest ACTIVE revision in that family. You can only describe INACTIVE task definitions while an active task or service references them.
88 */
89 describeTaskDefinition(params: ECS.Types.DescribeTaskDefinitionRequest, callback?: (err: AWSError, data: ECS.Types.DescribeTaskDefinitionResponse) => void): Request<ECS.Types.DescribeTaskDefinitionResponse, AWSError>;
90 /**
91 * Describes a task definition. You can specify a family and revision to find information about a specific task definition, or you can simply specify the family to find the latest ACTIVE revision in that family. You can only describe INACTIVE task definitions while an active task or service references them.
92 */
93 describeTaskDefinition(callback?: (err: AWSError, data: ECS.Types.DescribeTaskDefinitionResponse) => void): Request<ECS.Types.DescribeTaskDefinitionResponse, AWSError>;
94 /**
95 * Describes a specified task or tasks.
96 */
97 describeTasks(params: ECS.Types.DescribeTasksRequest, callback?: (err: AWSError, data: ECS.Types.DescribeTasksResponse) => void): Request<ECS.Types.DescribeTasksResponse, AWSError>;
98 /**
99 * Describes a specified task or tasks.
100 */
101 describeTasks(callback?: (err: AWSError, data: ECS.Types.DescribeTasksResponse) => void): Request<ECS.Types.DescribeTasksResponse, AWSError>;
102 /**
103 * This action is only used by the Amazon EC2 Container Service agent, and it is not intended for use outside of the agent. Returns an endpoint for the Amazon EC2 Container Service agent to poll for updates.
104 */
105 discoverPollEndpoint(params: ECS.Types.DiscoverPollEndpointRequest, callback?: (err: AWSError, data: ECS.Types.DiscoverPollEndpointResponse) => void): Request<ECS.Types.DiscoverPollEndpointResponse, AWSError>;
106 /**
107 * This action is only used by the Amazon EC2 Container Service agent, and it is not intended for use outside of the agent. Returns an endpoint for the Amazon EC2 Container Service agent to poll for updates.
108 */
109 discoverPollEndpoint(callback?: (err: AWSError, data: ECS.Types.DiscoverPollEndpointResponse) => void): Request<ECS.Types.DiscoverPollEndpointResponse, AWSError>;
110 /**
111 * Returns a list of existing clusters.
112 */
113 listClusters(params: ECS.Types.ListClustersRequest, callback?: (err: AWSError, data: ECS.Types.ListClustersResponse) => void): Request<ECS.Types.ListClustersResponse, AWSError>;
114 /**
115 * Returns a list of existing clusters.
116 */
117 listClusters(callback?: (err: AWSError, data: ECS.Types.ListClustersResponse) => void): Request<ECS.Types.ListClustersResponse, AWSError>;
118 /**
119 * Returns a list of container instances in a specified cluster.
120 */
121 listContainerInstances(params: ECS.Types.ListContainerInstancesRequest, callback?: (err: AWSError, data: ECS.Types.ListContainerInstancesResponse) => void): Request<ECS.Types.ListContainerInstancesResponse, AWSError>;
122 /**
123 * Returns a list of container instances in a specified cluster.
124 */
125 listContainerInstances(callback?: (err: AWSError, data: ECS.Types.ListContainerInstancesResponse) => void): Request<ECS.Types.ListContainerInstancesResponse, AWSError>;
126 /**
127 * Lists the services that are running in a specified cluster.
128 */
129 listServices(params: ECS.Types.ListServicesRequest, callback?: (err: AWSError, data: ECS.Types.ListServicesResponse) => void): Request<ECS.Types.ListServicesResponse, AWSError>;
130 /**
131 * Lists the services that are running in a specified cluster.
132 */
133 listServices(callback?: (err: AWSError, data: ECS.Types.ListServicesResponse) => void): Request<ECS.Types.ListServicesResponse, AWSError>;
134 /**
135 * Returns a list of task definition families that are registered to your account (which may include task definition families that no longer have any ACTIVE task definition revisions). You can filter out task definition families that do not contain any ACTIVE task definition revisions by setting the status parameter to ACTIVE. You can also filter the results with the familyPrefix parameter.
136 */
137 listTaskDefinitionFamilies(params: ECS.Types.ListTaskDefinitionFamiliesRequest, callback?: (err: AWSError, data: ECS.Types.ListTaskDefinitionFamiliesResponse) => void): Request<ECS.Types.ListTaskDefinitionFamiliesResponse, AWSError>;
138 /**
139 * Returns a list of task definition families that are registered to your account (which may include task definition families that no longer have any ACTIVE task definition revisions). You can filter out task definition families that do not contain any ACTIVE task definition revisions by setting the status parameter to ACTIVE. You can also filter the results with the familyPrefix parameter.
140 */
141 listTaskDefinitionFamilies(callback?: (err: AWSError, data: ECS.Types.ListTaskDefinitionFamiliesResponse) => void): Request<ECS.Types.ListTaskDefinitionFamiliesResponse, AWSError>;
142 /**
143 * Returns a list of task definitions that are registered to your account. You can filter the results by family name with the familyPrefix parameter or by status with the status parameter.
144 */
145 listTaskDefinitions(params: ECS.Types.ListTaskDefinitionsRequest, callback?: (err: AWSError, data: ECS.Types.ListTaskDefinitionsResponse) => void): Request<ECS.Types.ListTaskDefinitionsResponse, AWSError>;
146 /**
147 * Returns a list of task definitions that are registered to your account. You can filter the results by family name with the familyPrefix parameter or by status with the status parameter.
148 */
149 listTaskDefinitions(callback?: (err: AWSError, data: ECS.Types.ListTaskDefinitionsResponse) => void): Request<ECS.Types.ListTaskDefinitionsResponse, AWSError>;
150 /**
151 * Returns a list of tasks for a specified cluster. You can filter the results by family name, by a particular container instance, or by the desired status of the task with the family, containerInstance, and desiredStatus parameters. Recently-stopped tasks might appear in the returned results. Currently, stopped tasks appear in the returned results for at least one hour.
152 */
153 listTasks(params: ECS.Types.ListTasksRequest, callback?: (err: AWSError, data: ECS.Types.ListTasksResponse) => void): Request<ECS.Types.ListTasksResponse, AWSError>;
154 /**
155 * Returns a list of tasks for a specified cluster. You can filter the results by family name, by a particular container instance, or by the desired status of the task with the family, containerInstance, and desiredStatus parameters. Recently-stopped tasks might appear in the returned results. Currently, stopped tasks appear in the returned results for at least one hour.
156 */
157 listTasks(callback?: (err: AWSError, data: ECS.Types.ListTasksResponse) => void): Request<ECS.Types.ListTasksResponse, AWSError>;
158 /**
159 * This action is only used by the Amazon EC2 Container Service agent, and it is not intended for use outside of the agent. Registers an EC2 instance into the specified cluster. This instance becomes available to place containers on.
160 */
161 registerContainerInstance(params: ECS.Types.RegisterContainerInstanceRequest, callback?: (err: AWSError, data: ECS.Types.RegisterContainerInstanceResponse) => void): Request<ECS.Types.RegisterContainerInstanceResponse, AWSError>;
162 /**
163 * This action is only used by the Amazon EC2 Container Service agent, and it is not intended for use outside of the agent. Registers an EC2 instance into the specified cluster. This instance becomes available to place containers on.
164 */
165 registerContainerInstance(callback?: (err: AWSError, data: ECS.Types.RegisterContainerInstanceResponse) => void): Request<ECS.Types.RegisterContainerInstanceResponse, AWSError>;
166 /**
167 * Registers a new task definition from the supplied family and containerDefinitions. Optionally, you can add data volumes to your containers with the volumes parameter. For more information about task definition parameters and defaults, see Amazon ECS Task Definitions in the Amazon EC2 Container Service Developer Guide. You can specify an IAM role for your task with the taskRoleArn parameter. When you specify an IAM role for a task, its containers can then use the latest versions of the AWS CLI or SDKs to make API requests to the AWS services that are specified in the IAM policy associated with the role. For more information, see IAM Roles for Tasks in the Amazon EC2 Container Service Developer Guide. You can specify a Docker networking mode for the containers in your task definition with the networkMode parameter. The available network modes correspond to those described in Network settings in the Docker run reference.
168 */
169 registerTaskDefinition(params: ECS.Types.RegisterTaskDefinitionRequest, callback?: (err: AWSError, data: ECS.Types.RegisterTaskDefinitionResponse) => void): Request<ECS.Types.RegisterTaskDefinitionResponse, AWSError>;
170 /**
171 * Registers a new task definition from the supplied family and containerDefinitions. Optionally, you can add data volumes to your containers with the volumes parameter. For more information about task definition parameters and defaults, see Amazon ECS Task Definitions in the Amazon EC2 Container Service Developer Guide. You can specify an IAM role for your task with the taskRoleArn parameter. When you specify an IAM role for a task, its containers can then use the latest versions of the AWS CLI or SDKs to make API requests to the AWS services that are specified in the IAM policy associated with the role. For more information, see IAM Roles for Tasks in the Amazon EC2 Container Service Developer Guide. You can specify a Docker networking mode for the containers in your task definition with the networkMode parameter. The available network modes correspond to those described in Network settings in the Docker run reference.
172 */
173 registerTaskDefinition(callback?: (err: AWSError, data: ECS.Types.RegisterTaskDefinitionResponse) => void): Request<ECS.Types.RegisterTaskDefinitionResponse, AWSError>;
174 /**
175 * Start a task using random placement and the default Amazon ECS scheduler. To use your own scheduler or place a task on a specific container instance, use StartTask instead. The count parameter is limited to 10 tasks per call.
176 */
177 runTask(params: ECS.Types.RunTaskRequest, callback?: (err: AWSError, data: ECS.Types.RunTaskResponse) => void): Request<ECS.Types.RunTaskResponse, AWSError>;
178 /**
179 * Start a task using random placement and the default Amazon ECS scheduler. To use your own scheduler or place a task on a specific container instance, use StartTask instead. The count parameter is limited to 10 tasks per call.
180 */
181 runTask(callback?: (err: AWSError, data: ECS.Types.RunTaskResponse) => void): Request<ECS.Types.RunTaskResponse, AWSError>;
182 /**
183 * Starts a new task from the specified task definition on the specified container instance or instances. To use the default Amazon ECS scheduler to place your task, use RunTask instead. The list of container instances to start tasks on is limited to 10.
184 */
185 startTask(params: ECS.Types.StartTaskRequest, callback?: (err: AWSError, data: ECS.Types.StartTaskResponse) => void): Request<ECS.Types.StartTaskResponse, AWSError>;
186 /**
187 * Starts a new task from the specified task definition on the specified container instance or instances. To use the default Amazon ECS scheduler to place your task, use RunTask instead. The list of container instances to start tasks on is limited to 10.
188 */
189 startTask(callback?: (err: AWSError, data: ECS.Types.StartTaskResponse) => void): Request<ECS.Types.StartTaskResponse, AWSError>;
190 /**
191 * Stops a running task. When StopTask is called on a task, the equivalent of docker stop is issued to the containers running in the task. This results in a SIGTERM and a 30-second timeout, after which SIGKILL is sent and the containers are forcibly stopped. If the container handles the SIGTERM gracefully and exits within 30 seconds from receiving it, no SIGKILL is sent.
192 */
193 stopTask(params: ECS.Types.StopTaskRequest, callback?: (err: AWSError, data: ECS.Types.StopTaskResponse) => void): Request<ECS.Types.StopTaskResponse, AWSError>;
194 /**
195 * Stops a running task. When StopTask is called on a task, the equivalent of docker stop is issued to the containers running in the task. This results in a SIGTERM and a 30-second timeout, after which SIGKILL is sent and the containers are forcibly stopped. If the container handles the SIGTERM gracefully and exits within 30 seconds from receiving it, no SIGKILL is sent.
196 */
197 stopTask(callback?: (err: AWSError, data: ECS.Types.StopTaskResponse) => void): Request<ECS.Types.StopTaskResponse, AWSError>;
198 /**
199 * This action is only used by the Amazon EC2 Container Service agent, and it is not intended for use outside of the agent. Sent to acknowledge that a container changed states.
200 */
201 submitContainerStateChange(params: ECS.Types.SubmitContainerStateChangeRequest, callback?: (err: AWSError, data: ECS.Types.SubmitContainerStateChangeResponse) => void): Request<ECS.Types.SubmitContainerStateChangeResponse, AWSError>;
202 /**
203 * This action is only used by the Amazon EC2 Container Service agent, and it is not intended for use outside of the agent. Sent to acknowledge that a container changed states.
204 */
205 submitContainerStateChange(callback?: (err: AWSError, data: ECS.Types.SubmitContainerStateChangeResponse) => void): Request<ECS.Types.SubmitContainerStateChangeResponse, AWSError>;
206 /**
207 * This action is only used by the Amazon EC2 Container Service agent, and it is not intended for use outside of the agent. Sent to acknowledge that a task changed states.
208 */
209 submitTaskStateChange(params: ECS.Types.SubmitTaskStateChangeRequest, callback?: (err: AWSError, data: ECS.Types.SubmitTaskStateChangeResponse) => void): Request<ECS.Types.SubmitTaskStateChangeResponse, AWSError>;
210 /**
211 * This action is only used by the Amazon EC2 Container Service agent, and it is not intended for use outside of the agent. Sent to acknowledge that a task changed states.
212 */
213 submitTaskStateChange(callback?: (err: AWSError, data: ECS.Types.SubmitTaskStateChangeResponse) => void): Request<ECS.Types.SubmitTaskStateChangeResponse, AWSError>;
214 /**
215 * Updates the Amazon ECS container agent on a specified container instance. Updating the Amazon ECS container agent does not interrupt running tasks or services on the container instance. The process for updating the agent differs depending on whether your container instance was launched with the Amazon ECS-optimized AMI or another operating system. UpdateContainerAgent requires the Amazon ECS-optimized AMI or Amazon Linux with the ecs-init service installed and running. For help updating the Amazon ECS container agent on other operating systems, see Manually Updating the Amazon ECS Container Agent in the Amazon EC2 Container Service Developer Guide.
216 */
217 updateContainerAgent(params: ECS.Types.UpdateContainerAgentRequest, callback?: (err: AWSError, data: ECS.Types.UpdateContainerAgentResponse) => void): Request<ECS.Types.UpdateContainerAgentResponse, AWSError>;
218 /**
219 * Updates the Amazon ECS container agent on a specified container instance. Updating the Amazon ECS container agent does not interrupt running tasks or services on the container instance. The process for updating the agent differs depending on whether your container instance was launched with the Amazon ECS-optimized AMI or another operating system. UpdateContainerAgent requires the Amazon ECS-optimized AMI or Amazon Linux with the ecs-init service installed and running. For help updating the Amazon ECS container agent on other operating systems, see Manually Updating the Amazon ECS Container Agent in the Amazon EC2 Container Service Developer Guide.
220 */
221 updateContainerAgent(callback?: (err: AWSError, data: ECS.Types.UpdateContainerAgentResponse) => void): Request<ECS.Types.UpdateContainerAgentResponse, AWSError>;
222 /**
223 * Modifies the desired count, deployment configuration, or task definition used in a service. You can add to or subtract from the number of instantiations of a task definition in a service by specifying the cluster that the service is running in and a new desiredCount parameter. You can use UpdateService to modify your task definition and deploy a new version of your service. You can also update the deployment configuration of a service. When a deployment is triggered by updating the task definition of a service, the service scheduler uses the deployment configuration parameters, minimumHealthyPercent and maximumPercent, to determine the deployment strategy. If the minimumHealthyPercent is below 100%, the scheduler can ignore the desiredCount temporarily during a deployment. For example, if your service has a desiredCount of four tasks, a minimumHealthyPercent of 50% allows the scheduler to stop two existing tasks before starting two new tasks. Tasks for services that do not use a load balancer are considered healthy if they are in the RUNNING state; tasks for services that do use a load balancer are considered healthy if they are in the RUNNING state and the container instance it is hosted on is reported as healthy by the load balancer. The maximumPercent parameter represents an upper limit on the number of running tasks during a deployment, which enables you to define the deployment batch size. For example, if your service has a desiredCount of four tasks, a maximumPercent value of 200% starts four new tasks before stopping the four older tasks (provided that the cluster resources required to do this are available). When UpdateService stops a task during a deployment, the equivalent of docker stop is issued to the containers running in the task. This results in a SIGTERM and a 30-second timeout, after which SIGKILL is sent and the containers are forcibly stopped. If the container handles the SIGTERM gracefully and exits within 30 seconds from receiving it, no SIGKILL is sent. When the service scheduler launches new tasks, it attempts to balance them across the Availability Zones in your cluster with the following logic: Determine which of the container instances in your cluster can support your service's task definition (for example, they have the required CPU, memory, ports, and container instance attributes). Sort the valid container instances by the fewest number of running tasks for this service in the same Availability Zone as the instance. For example, if zone A has one running service task and zones B and C each have zero, valid container instances in either zone B or C are considered optimal for placement. Place the new service task on a valid container instance in an optimal Availability Zone (based on the previous steps), favoring container instances with the fewest number of running tasks for this service.
224 */
225 updateService(params: ECS.Types.UpdateServiceRequest, callback?: (err: AWSError, data: ECS.Types.UpdateServiceResponse) => void): Request<ECS.Types.UpdateServiceResponse, AWSError>;
226 /**
227 * Modifies the desired count, deployment configuration, or task definition used in a service. You can add to or subtract from the number of instantiations of a task definition in a service by specifying the cluster that the service is running in and a new desiredCount parameter. You can use UpdateService to modify your task definition and deploy a new version of your service. You can also update the deployment configuration of a service. When a deployment is triggered by updating the task definition of a service, the service scheduler uses the deployment configuration parameters, minimumHealthyPercent and maximumPercent, to determine the deployment strategy. If the minimumHealthyPercent is below 100%, the scheduler can ignore the desiredCount temporarily during a deployment. For example, if your service has a desiredCount of four tasks, a minimumHealthyPercent of 50% allows the scheduler to stop two existing tasks before starting two new tasks. Tasks for services that do not use a load balancer are considered healthy if they are in the RUNNING state; tasks for services that do use a load balancer are considered healthy if they are in the RUNNING state and the container instance it is hosted on is reported as healthy by the load balancer. The maximumPercent parameter represents an upper limit on the number of running tasks during a deployment, which enables you to define the deployment batch size. For example, if your service has a desiredCount of four tasks, a maximumPercent value of 200% starts four new tasks before stopping the four older tasks (provided that the cluster resources required to do this are available). When UpdateService stops a task during a deployment, the equivalent of docker stop is issued to the containers running in the task. This results in a SIGTERM and a 30-second timeout, after which SIGKILL is sent and the containers are forcibly stopped. If the container handles the SIGTERM gracefully and exits within 30 seconds from receiving it, no SIGKILL is sent. When the service scheduler launches new tasks, it attempts to balance them across the Availability Zones in your cluster with the following logic: Determine which of the container instances in your cluster can support your service's task definition (for example, they have the required CPU, memory, ports, and container instance attributes). Sort the valid container instances by the fewest number of running tasks for this service in the same Availability Zone as the instance. For example, if zone A has one running service task and zones B and C each have zero, valid container instances in either zone B or C are considered optimal for placement. Place the new service task on a valid container instance in an optimal Availability Zone (based on the previous steps), favoring container instances with the fewest number of running tasks for this service.
228 */
229 updateService(callback?: (err: AWSError, data: ECS.Types.UpdateServiceResponse) => void): Request<ECS.Types.UpdateServiceResponse, AWSError>;
230 /**
231 * Waits for the tasksRunning state by periodically calling the underlying ECS.describeTasksoperation every 6 seconds (at most 100 times).
232 */
233 waitFor(state: "tasksRunning", params: ECS.Types.DescribeTasksRequest, callback?: (err: AWSError, data: ECS.Types.DescribeTasksResponse) => void): Request<ECS.Types.DescribeTasksResponse, AWSError>;
234 /**
235 * Waits for the tasksRunning state by periodically calling the underlying ECS.describeTasksoperation every 6 seconds (at most 100 times).
236 */
237 waitFor(state: "tasksRunning", callback?: (err: AWSError, data: ECS.Types.DescribeTasksResponse) => void): Request<ECS.Types.DescribeTasksResponse, AWSError>;
238 /**
239 * Waits for the tasksStopped state by periodically calling the underlying ECS.describeTasksoperation every 6 seconds (at most 100 times).
240 */
241 waitFor(state: "tasksStopped", params: ECS.Types.DescribeTasksRequest, callback?: (err: AWSError, data: ECS.Types.DescribeTasksResponse) => void): Request<ECS.Types.DescribeTasksResponse, AWSError>;
242 /**
243 * Waits for the tasksStopped state by periodically calling the underlying ECS.describeTasksoperation every 6 seconds (at most 100 times).
244 */
245 waitFor(state: "tasksStopped", callback?: (err: AWSError, data: ECS.Types.DescribeTasksResponse) => void): Request<ECS.Types.DescribeTasksResponse, AWSError>;
246 /**
247 * Waits for the servicesStable state by periodically calling the underlying ECS.describeServicesoperation every 15 seconds (at most 40 times).
248 */
249 waitFor(state: "servicesStable", params: ECS.Types.DescribeServicesRequest, callback?: (err: AWSError, data: ECS.Types.DescribeServicesResponse) => void): Request<ECS.Types.DescribeServicesResponse, AWSError>;
250 /**
251 * Waits for the servicesStable state by periodically calling the underlying ECS.describeServicesoperation every 15 seconds (at most 40 times).
252 */
253 waitFor(state: "servicesStable", callback?: (err: AWSError, data: ECS.Types.DescribeServicesResponse) => void): Request<ECS.Types.DescribeServicesResponse, AWSError>;
254 /**
255 * Waits for the servicesInactive state by periodically calling the underlying ECS.describeServicesoperation every 15 seconds (at most 40 times).
256 */
257 waitFor(state: "servicesInactive", params: ECS.Types.DescribeServicesRequest, callback?: (err: AWSError, data: ECS.Types.DescribeServicesResponse) => void): Request<ECS.Types.DescribeServicesResponse, AWSError>;
258 /**
259 * Waits for the servicesInactive state by periodically calling the underlying ECS.describeServicesoperation every 15 seconds (at most 40 times).
260 */
261 waitFor(state: "servicesInactive", callback?: (err: AWSError, data: ECS.Types.DescribeServicesResponse) => void): Request<ECS.Types.DescribeServicesResponse, AWSError>;
262 }
263 declare namespace ECS.Types {
264 export type AgentUpdateStatus = "PENDING"|"STAGING"|"STAGED"|"UPDATING"|"UPDATED"|"FAILED"|string;
265 export interface Attribute {
266 /**
267 * The name of the container instance attribute.
268 */
269 name: String;
270 /**
271 * The value of the container instance attribute (at this time, the value here is Null, but this could change in future revisions for expandability).
272 */
273 value?: String;
274 }
275 export type Attributes = Attribute[];
276 export type Boolean = boolean;
277 export type BoxedBoolean = boolean;
278 export type BoxedInteger = number;
279 export interface Cluster {
280 /**
281 * The Amazon Resource Name (ARN) that identifies the cluster. The ARN contains the arn:aws:ecs namespace, followed by the region of the cluster, the AWS account ID of the cluster owner, the cluster namespace, and then the cluster name. For example, arn:aws:ecs:region:012345678910:cluster/test ..
282 */
283 clusterArn?: String;
284 /**
285 * A user-generated string that you use to identify your cluster.
286 */
287 clusterName?: String;
288 /**
289 * The status of the cluster. The valid values are ACTIVE or INACTIVE. ACTIVE indicates that you can register container instances with the cluster and the associated instances can accept tasks.
290 */
291 status?: String;
292 /**
293 * The number of container instances registered into the cluster.
294 */
295 registeredContainerInstancesCount?: Integer;
296 /**
297 * The number of tasks in the cluster that are in the RUNNING state.
298 */
299 runningTasksCount?: Integer;
300 /**
301 * The number of tasks in the cluster that are in the PENDING state.
302 */
303 pendingTasksCount?: Integer;
304 /**
305 * The number of services that are running on the cluster in an ACTIVE state. You can view these services with ListServices.
306 */
307 activeServicesCount?: Integer;
308 }
309 export type Clusters = Cluster[];
310 export interface Container {
311 /**
312 * The Amazon Resource Name (ARN) of the container.
313 */
314 containerArn?: String;
315 /**
316 * The Amazon Resource Name (ARN) of the task.
317 */
318 taskArn?: String;
319 /**
320 * The name of the container.
321 */
322 name?: String;
323 /**
324 * The last known status of the container.
325 */
326 lastStatus?: String;
327 /**
328 * The exit code returned from the container.
329 */
330 exitCode?: BoxedInteger;
331 /**
332 * A short (255 max characters) human-readable string to provide additional detail about a running or stopped container.
333 */
334 reason?: String;
335 /**
336 * The network bindings associated with the container.
337 */
338 networkBindings?: NetworkBindings;
339 }
340 export interface ContainerDefinition {
341 /**
342 * The name of a container. If you are linking multiple containers together in a task definition, the name of one container can be entered in the links of another container to connect the containers. Up to 255 letters (uppercase and lowercase), numbers, hyphens, and underscores are allowed. This parameter maps to name in the Create a container section of the Docker Remote API and the --name option to docker run.
343 */
344 name?: String;
345 /**
346 * The image used to start a container. This string is passed directly to the Docker daemon. Images in the Docker Hub registry are available by default. Other repositories are specified with repository-url/image:tag . Up to 255 letters (uppercase and lowercase), numbers, hyphens, underscores, colons, periods, forward slashes, and number signs are allowed. This parameter maps to Image in the Create a container section of the Docker Remote API and the IMAGE parameter of docker run. Images in official repositories on Docker Hub use a single name (for example, ubuntu or mongo). Images in other repositories on Docker Hub are qualified with an organization name (for example, amazon/amazon-ecs-agent). Images in other online repositories are qualified further by a domain name (for example, quay.io/assemblyline/ubuntu).
347 */
348 image?: String;
349 /**
350 * The number of cpu units reserved for the container. A container instance has 1,024 cpu units for every CPU core. This parameter specifies the minimum amount of CPU to reserve for a container, and containers share unallocated CPU units with other containers on the instance with the same ratio as their allocated amount. This parameter maps to CpuShares in the Create a container section of the Docker Remote API and the --cpu-shares option to docker run. You can determine the number of CPU units that are available per EC2 instance type by multiplying the vCPUs listed for that instance type on the Amazon EC2 Instances detail page by 1,024. For example, if you run a single-container task on a single-core instance type with 512 CPU units specified for that container, and that is the only task running on the container instance, that container could use the full 1,024 CPU unit share at any given time. However, if you launched another copy of the same task on that container instance, each task would be guaranteed a minimum of 512 CPU units when needed, and each container could float to higher CPU usage if the other container was not using it, but if both tasks were 100% active all of the time, they would be limited to 512 CPU units. The Docker daemon on the container instance uses the CPU value to calculate the relative CPU share ratios for running containers. For more information, see CPU share constraint in the Docker documentation. The minimum valid CPU share value that the Linux kernel allows is 2; however, the CPU parameter is not required, and you can use CPU values below 2 in your container definitions. For CPU values below 2 (including null), the behavior varies based on your Amazon ECS container agent version: Agent versions less than or equal to 1.1.0: Null and zero CPU values are passed to Docker as 0, which Docker then converts to 1,024 CPU shares. CPU values of 1 are passed to Docker as 1, which the Linux kernel converts to 2 CPU shares. Agent versions greater than or equal to 1.2.0: Null, zero, and CPU values of 1 are passed to Docker as 2.
351 */
352 cpu?: Integer;
353 /**
354 * The hard limit (in MiB) of memory to present to the container. If your container attempts to exceed the memory specified here, the container is killed. This parameter maps to Memory in the Create a container section of the Docker Remote API and the --memory option to docker run. You must specify a non-zero integer for one or both of memory or memoryReservation in container definitions. If you specify both, memory must be greater than memoryReservation. If you specify memoryReservation, then that value is subtracted from the available memory resources for the container instance on which the container is placed; otherwise, the value of memory is used. The Docker daemon reserves a minimum of 4 MiB of memory for a container, so you should not specify fewer than 4 MiB of memory for your containers.
355 */
356 memory?: BoxedInteger;
357 /**
358 * The soft limit (in MiB) of memory to reserve for the container. When system memory is under heavy contention, Docker attempts to keep the container memory to this soft limit; however, your container can consume more memory when it needs to, up to either the hard limit specified with the memory parameter (if applicable), or all of the available memory on the container instance, whichever comes first. This parameter maps to MemoryReservation in the Create a container section of the Docker Remote API and the --memory-reservation option to docker run. You must specify a non-zero integer for one or both of memory or memoryReservation in container definitions. If you specify both, memory must be greater than memoryReservation. If you specify memoryReservation, then that value is subtracted from the available memory resources for the container instance on which the container is placed; otherwise, the value of memory is used. For example, if your container normally uses 128 MiB of memory, but occasionally bursts to 256 MiB of memory for short periods of time, you can set a memoryReservation of 128 MiB, and a memory hard limit of 300 MiB. This configuration would allow the container to only reserve 128 MiB of memory from the remaining resources on the container instance, but also allow the container to consume more memory resources when needed.
359 */
360 memoryReservation?: BoxedInteger;
361 /**
362 * The link parameter allows containers to communicate with each other without the need for port mappings, using the name parameter and optionally, an alias for the link. This construct is analogous to name:alias in Docker links. Up to 255 letters (uppercase and lowercase), numbers, hyphens, and underscores are allowed for each name and alias. For more information on linking Docker containers, see https://docs.docker.com/engine/userguide/networking/default_network/dockerlinks/. This parameter maps to Links in the Create a container section of the Docker Remote API and the --link option to docker run. Containers that are collocated on a single container instance may be able to communicate with each other without requiring links or host port mappings. Network isolation is achieved on the container instance using security groups and VPC settings.
363 */
364 links?: StringList;
365 /**
366 * The list of port mappings for the container. Port mappings allow containers to access ports on the host container instance to send or receive traffic. This parameter maps to PortBindings in the Create a container section of the Docker Remote API and the --publish option to docker run. If the network mode of a task definition is set to none, then you cannot specify port mappings. If the network mode of a task definition is set to host, then host ports must either be undefined or they must match the container port in the port mapping. After a task reaches the RUNNING status, manual and automatic host and container port assignments are visible in the Network Bindings section of a container description of a selected task in the Amazon ECS console, or the networkBindings section DescribeTasks responses.
367 */
368 portMappings?: PortMappingList;
369 /**
370 * If the essential parameter of a container is marked as true, and that container fails or stops for any reason, all other containers that are part of the task are stopped. If the essential parameter of a container is marked as false, then its failure does not affect the rest of the containers in a task. If this parameter is omitted, a container is assumed to be essential. All tasks must have at least one essential container. If you have an application that is composed of multiple containers, you should group containers that are used for a common purpose into components, and separate the different components into multiple task definitions. For more information, see Application Architecture in the Amazon EC2 Container Service Developer Guide.
371 */
372 essential?: BoxedBoolean;
373 /**
374 * Early versions of the Amazon ECS container agent do not properly handle entryPoint parameters. If you have problems using entryPoint, update your container agent or enter your commands and arguments as command array items instead. The entry point that is passed to the container. This parameter maps to Entrypoint in the Create a container section of the Docker Remote API and the --entrypoint option to docker run. For more information, see https://docs.docker.com/engine/reference/builder/#entrypoint.
375 */
376 entryPoint?: StringList;
377 /**
378 * The command that is passed to the container. This parameter maps to Cmd in the Create a container section of the Docker Remote API and the COMMAND parameter to docker run. For more information, see https://docs.docker.com/engine/reference/builder/#cmd.
379 */
380 command?: StringList;
381 /**
382 * The environment variables to pass to a container. This parameter maps to Env in the Create a container section of the Docker Remote API and the --env option to docker run. We do not recommend using plain text environment variables for sensitive information, such as credential data.
383 */
384 environment?: EnvironmentVariables;
385 /**
386 * The mount points for data volumes in your container. This parameter maps to Volumes in the Create a container section of the Docker Remote API and the --volume option to docker run.
387 */
388 mountPoints?: MountPointList;
389 /**
390 * Data volumes to mount from another container. This parameter maps to VolumesFrom in the Create a container section of the Docker Remote API and the --volumes-from option to docker run.
391 */
392 volumesFrom?: VolumeFromList;
393 /**
394 * The hostname to use for your container. This parameter maps to Hostname in the Create a container section of the Docker Remote API and the --hostname option to docker run.
395 */
396 hostname?: String;
397 /**
398 * The user name to use inside the container. This parameter maps to User in the Create a container section of the Docker Remote API and the --user option to docker run.
399 */
400 user?: String;
401 /**
402 * The working directory in which to run commands inside the container. This parameter maps to WorkingDir in the Create a container section of the Docker Remote API and the --workdir option to docker run.
403 */
404 workingDirectory?: String;
405 /**
406 * When this parameter is true, networking is disabled within the container. This parameter maps to NetworkDisabled in the Create a container section of the Docker Remote API.
407 */
408 disableNetworking?: BoxedBoolean;
409 /**
410 * When this parameter is true, the container is given elevated privileges on the host container instance (similar to the root user). This parameter maps to Privileged in the Create a container section of the Docker Remote API and the --privileged option to docker run.
411 */
412 privileged?: BoxedBoolean;
413 /**
414 * When this parameter is true, the container is given read-only access to its root file system. This parameter maps to ReadonlyRootfs in the Create a container section of the Docker Remote API and the --read-only option to docker run.
415 */
416 readonlyRootFilesystem?: BoxedBoolean;
417 /**
418 * A list of DNS servers that are presented to the container. This parameter maps to Dns in the Create a container section of the Docker Remote API and the --dns option to docker run.
419 */
420 dnsServers?: StringList;
421 /**
422 * A list of DNS search domains that are presented to the container. This parameter maps to DnsSearch in the Create a container section of the Docker Remote API and the --dns-search option to docker run.
423 */
424 dnsSearchDomains?: StringList;
425 /**
426 * A list of hostnames and IP address mappings to append to the /etc/hosts file on the container. This parameter maps to ExtraHosts in the Create a container section of the Docker Remote API and the --add-host option to docker run.
427 */
428 extraHosts?: HostEntryList;
429 /**
430 * A list of strings to provide custom labels for SELinux and AppArmor multi-level security systems. This parameter maps to SecurityOpt in the Create a container section of the Docker Remote API and the --security-opt option to docker run. The Amazon ECS container agent running on a container instance must register with the ECS_SELINUX_CAPABLE=true or ECS_APPARMOR_CAPABLE=true environment variables before containers placed on that instance can use these security options. For more information, see Amazon ECS Container Agent Configuration in the Amazon EC2 Container Service Developer Guide.
431 */
432 dockerSecurityOptions?: StringList;
433 /**
434 * A key/value map of labels to add to the container. This parameter maps to Labels in the Create a container section of the Docker Remote API and the --label option to docker run. This parameter requires version 1.18 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log into your container instance and run the following command: sudo docker version | grep "Server API version"
435 */
436 dockerLabels?: DockerLabelsMap;
437 /**
438 * A list of ulimits to set in the container. This parameter maps to Ulimits in the Create a container section of the Docker Remote API and the --ulimit option to docker run. Valid naming values are displayed in the Ulimit data type. This parameter requires version 1.18 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log into your container instance and run the following command: sudo docker version | grep "Server API version"
439 */
440 ulimits?: UlimitList;
441 /**
442 * The log configuration specification for the container. This parameter maps to LogConfig in the Create a container section of the Docker Remote API and the --log-driver option to docker run. By default, containers use the same logging driver that the Docker daemon uses; however the container may use a different logging driver than the Docker daemon by specifying a log driver with this parameter in the container definition. To use a different logging driver for a container, the log system must be configured properly on the container instance (or on a different log server for remote logging options). For more information on the options for different supported log drivers, see Configure logging drivers in the Docker documentation. Amazon ECS currently supports a subset of the logging drivers available to the Docker daemon (shown in the LogConfiguration data type). Currently unsupported log drivers may be available in future releases of the Amazon ECS container agent. This parameter requires version 1.18 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log into your container instance and run the following command: sudo docker version | grep "Server API version" The Amazon ECS container agent running on a container instance must register the logging drivers available on that instance with the ECS_AVAILABLE_LOGGING_DRIVERS environment variable before containers placed on that instance can use these log configuration options. For more information, see Amazon ECS Container Agent Configuration in the Amazon EC2 Container Service Developer Guide.
443 */
444 logConfiguration?: LogConfiguration;
445 }
446 export type ContainerDefinitions = ContainerDefinition[];
447 export interface ContainerInstance {
448 /**
449 * The Amazon Resource Name (ARN) of the container instance. The ARN contains the arn:aws:ecs namespace, followed by the region of the container instance, the AWS account ID of the container instance owner, the container-instance namespace, and then the container instance ID. For example, arn:aws:ecs:region:aws_account_id:container-instance/container_instance_ID .
450 */
451 containerInstanceArn?: String;
452 /**
453 * The EC2 instance ID of the container instance.
454 */
455 ec2InstanceId?: String;
456 /**
457 * The version counter for the container instance. Every time a container instance experiences a change that triggers a CloudWatch event, the version counter is incremented. If you are replicating your Amazon ECS container instance state with CloudWatch events, you can compare the version of a container instance reported by the Amazon ECS APIs with the version reported in CloudWatch events for the container instance (inside the detail object) to verify that the version in your event stream is current.
458 */
459 version?: Long;
460 /**
461 * The version information for the Amazon ECS container agent and Docker daemon running on the container instance.
462 */
463 versionInfo?: VersionInfo;
464 /**
465 * For most resource types, this parameter describes the remaining resources of the container instance that are available for new tasks. For port resource types, this parameter describes the ports that are reserved by the Amazon ECS container agent and any containers that have reserved port mappings; any port that is not specified here is available for new tasks.
466 */
467 remainingResources?: Resources;
468 /**
469 * For most resource types, this parameter describes the registered resources on the container instance that are in use by current tasks. For port resource types, this parameter describes the ports that were reserved by the Amazon ECS container agent when it registered the container instance with Amazon ECS.
470 */
471 registeredResources?: Resources;
472 /**
473 * The status of the container instance. The valid values are ACTIVE or INACTIVE. ACTIVE indicates that the container instance can accept tasks.
474 */
475 status?: String;
476 /**
477 * This parameter returns true if the agent is actually connected to Amazon ECS. Registered instances with an agent that may be unhealthy or stopped return false, and instances without a connected agent cannot accept placement requests.
478 */
479 agentConnected?: Boolean;
480 /**
481 * The number of tasks on the container instance that are in the RUNNING status.
482 */
483 runningTasksCount?: Integer;
484 /**
485 * The number of tasks on the container instance that are in the PENDING status.
486 */
487 pendingTasksCount?: Integer;
488 /**
489 * The status of the most recent agent update. If an update has never been requested, this value is NULL.
490 */
491 agentUpdateStatus?: AgentUpdateStatus;
492 /**
493 * The attributes set for the container instance by the Amazon ECS container agent at instance registration.
494 */
495 attributes?: Attributes;
496 }
497 export type ContainerInstances = ContainerInstance[];
498 export interface ContainerOverride {
499 /**
500 * The name of the container that receives the override.
501 */
502 name?: String;
503 /**
504 * The command to send to the container that overrides the default command from the Docker image or the task definition.
505 */
506 command?: StringList;
507 /**
508 * 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.
509 */
510 environment?: EnvironmentVariables;
511 }
512 export type ContainerOverrides = ContainerOverride[];
513 export type Containers = Container[];
514 export interface CreateClusterRequest {
515 /**
516 * The name of your cluster. If you do not specify a name for your cluster, you create a cluster named default. Up to 255 letters (uppercase and lowercase), numbers, hyphens, and underscores are allowed.
517 */
518 clusterName?: String;
519 }
520 export interface CreateClusterResponse {
521 /**
522 * The full description of your new cluster.
523 */
524 cluster?: Cluster;
525 }
526 export interface CreateServiceRequest {
527 /**
528 * The short name or full Amazon Resource Name (ARN) of the cluster on which to run your service. If you do not specify a cluster, the default cluster is assumed.
529 */
530 cluster?: String;
531 /**
532 * The name of your service. Up to 255 letters (uppercase and lowercase), numbers, hyphens, and underscores are allowed. Service names must be unique within a cluster, but you can have similarly named services in multiple clusters within a region or across multiple regions.
533 */
534 serviceName: String;
535 /**
536 * The family and revision (family:revision) or full Amazon Resource Name (ARN) of the task definition to run in your service. If a revision is not specified, the latest ACTIVE revision is used.
537 */
538 taskDefinition: String;
539 /**
540 * A load balancer object representing the load balancer to use with your service. Currently, you are limited to one load balancer per service. After you create a service, the load balancer name, container name, and container port specified in the service definition are immutable. For Elastic Load Balancing Classic load balancers, this object must contain the load balancer name, the container name (as it appears in a container definition), and the container port to access from the load balancer. When a task from this service is placed on a container instance, the container instance is registered with the load balancer specified here. For Elastic Load Balancing Application load balancers, this object must contain the load balancer target group ARN, the container name (as it appears in a container definition), and the container port to access from the load balancer. When a task from this service is placed on a container instance, the container instance and port combination is registered as a target in the target group specified here.
541 */
542 loadBalancers?: LoadBalancers;
543 /**
544 * The number of instantiations of the specified task definition to place and keep running on your cluster.
545 */
546 desiredCount: BoxedInteger;
547 /**
548 * Unique, case-sensitive identifier you provide to ensure the idempotency of the request. Up to 32 ASCII characters are allowed.
549 */
550 clientToken?: String;
551 /**
552 * The name or full Amazon Resource Name (ARN) of the IAM role that allows Amazon ECS to make calls to your load balancer on your behalf. This parameter is required if you are using a load balancer with your service. If you specify the role parameter, you must also specify a load balancer object with the loadBalancers parameter. If your specified role has a path other than /, then you must either specify the full role ARN (this is recommended) or prefix the role name with the path. For example, if a role with the name bar has a path of /foo/ then you would specify /foo/bar as the role name. For more information, see Friendly Names and Paths in the IAM User Guide.
553 */
554 role?: String;
555 /**
556 * Optional deployment parameters that control how many tasks run during the deployment and the ordering of stopping and starting tasks.
557 */
558 deploymentConfiguration?: DeploymentConfiguration;
559 }
560 export interface CreateServiceResponse {
561 /**
562 * The full description of your service following the create call.
563 */
564 service?: Service;
565 }
566 export interface DeleteClusterRequest {
567 /**
568 * The short name or full Amazon Resource Name (ARN) of the cluster to delete.
569 */
570 cluster: String;
571 }
572 export interface DeleteClusterResponse {
573 /**
574 * The full description of the deleted cluster.
575 */
576 cluster?: Cluster;
577 }
578 export interface DeleteServiceRequest {
579 /**
580 * The name of the cluster that hosts the service to delete. If you do not specify a cluster, the default cluster is assumed.
581 */
582 cluster?: String;
583 /**
584 * The name of the service to delete.
585 */
586 service: String;
587 }
588 export interface DeleteServiceResponse {
589 /**
590 * The full description of the deleted service.
591 */
592 service?: Service;
593 }
594 export interface Deployment {
595 /**
596 * The ID of the deployment.
597 */
598 id?: String;
599 /**
600 * The status of the deployment. Valid values are PRIMARY (for the most recent deployment), ACTIVE (for previous deployments that still have tasks running, but are being replaced with the PRIMARY deployment), and INACTIVE (for deployments that have been completely replaced).
601 */
602 status?: String;
603 /**
604 * The most recent task definition that was specified for the service to use.
605 */
606 taskDefinition?: String;
607 /**
608 * The most recent desired count of tasks that was specified for the service to deploy or maintain.
609 */
610 desiredCount?: Integer;
611 /**
612 * The number of tasks in the deployment that are in the PENDING status.
613 */
614 pendingCount?: Integer;
615 /**
616 * The number of tasks in the deployment that are in the RUNNING status.
617 */
618 runningCount?: Integer;
619 /**
620 * The Unix timestamp for when the service was created.
621 */
622 createdAt?: Timestamp;
623 /**
624 * The Unix timestamp for when the service was last updated.
625 */
626 updatedAt?: Timestamp;
627 }
628 export interface DeploymentConfiguration {
629 /**
630 * The upper limit (as a percentage of the service's desiredCount) of the number of tasks that are allowed in the RUNNING or PENDING state in a service during a deployment. The maximum number of tasks during a deployment is the desiredCount multiplied by the maximumPercent/100, rounded down to the nearest integer value.
631 */
632 maximumPercent?: BoxedInteger;
633 /**
634 * The lower limit (as a percentage of the service's desiredCount) of the number of running tasks that must remain in the RUNNING state in a service during a deployment. The minimum healthy tasks during a deployment is the desiredCount multiplied by the minimumHealthyPercent/100, rounded up to the nearest integer value.
635 */
636 minimumHealthyPercent?: BoxedInteger;
637 }
638 export type Deployments = Deployment[];
639 export interface DeregisterContainerInstanceRequest {
640 /**
641 * The short name or full Amazon Resource Name (ARN) of the cluster that hosts the container instance to deregister. If you do not specify a cluster, the default cluster is assumed.
642 */
643 cluster?: String;
644 /**
645 * The container instance ID or full Amazon Resource Name (ARN) of the container instance to deregister. The ARN contains the arn:aws:ecs namespace, followed by the region of the container instance, the AWS account ID of the container instance owner, the container-instance namespace, and then the container instance ID. For example, arn:aws:ecs:region:aws_account_id:container-instance/container_instance_ID .
646 */
647 containerInstance: String;
648 /**
649 * Forces the deregistration of the container instance. If you have tasks running on the container instance when you deregister it with the force option, these tasks remain running until you terminate the instance or the tasks stop through some other means, but they are orphaned (no longer monitored or accounted for by Amazon ECS). If an orphaned task on your container instance is part of an Amazon ECS service, then the service scheduler starts another copy of that task, on a different container instance if possible. Any containers in orphaned service tasks that are registered with a Classic load balancer or an Application load balancer target group are deregistered, and they will begin connection draining according to the settings on the load balancer or target group.
650 */
651 force?: BoxedBoolean;
652 }
653 export interface DeregisterContainerInstanceResponse {
654 /**
655 * The container instance that was deregistered.
656 */
657 containerInstance?: ContainerInstance;
658 }
659 export interface DeregisterTaskDefinitionRequest {
660 /**
661 * The family and revision (family:revision) or full Amazon Resource Name (ARN) of the task definition to deregister. You must specify a revision.
662 */
663 taskDefinition: String;
664 }
665 export interface DeregisterTaskDefinitionResponse {
666 /**
667 * The full description of the deregistered task.
668 */
669 taskDefinition?: TaskDefinition;
670 }
671 export interface DescribeClustersRequest {
672 /**
673 * A space-separated list of up to 100 cluster names or full cluster Amazon Resource Name (ARN) entries. If you do not specify a cluster, the default cluster is assumed.
674 */
675 clusters?: StringList;
676 }
677 export interface DescribeClustersResponse {
678 /**
679 * The list of clusters.
680 */
681 clusters?: Clusters;
682 /**
683 * Any failures associated with the call.
684 */
685 failures?: Failures;
686 }
687 export interface DescribeContainerInstancesRequest {
688 /**
689 * The short name or full Amazon Resource Name (ARN) of the cluster that hosts the container instances to describe. If you do not specify a cluster, the default cluster is assumed.
690 */
691 cluster?: String;
692 /**
693 * A space-separated list of container instance IDs or full Amazon Resource Name (ARN) entries.
694 */
695 containerInstances: StringList;
696 }
697 export interface DescribeContainerInstancesResponse {
698 /**
699 * The list of container instances.
700 */
701 containerInstances?: ContainerInstances;
702 /**
703 * Any failures associated with the call.
704 */
705 failures?: Failures;
706 }
707 export interface DescribeServicesRequest {
708 /**
709 * The name of the cluster that hosts the service to describe. If you do not specify a cluster, the default cluster is assumed.
710 */
711 cluster?: String;
712 /**
713 * A list of services to describe. You may specify up to 10 services to describe in a single operation.
714 */
715 services: StringList;
716 }
717 export interface DescribeServicesResponse {
718 /**
719 * The list of services described.
720 */
721 services?: Services;
722 /**
723 * Any failures associated with the call.
724 */
725 failures?: Failures;
726 }
727 export interface DescribeTaskDefinitionRequest {
728 /**
729 * The family for the latest ACTIVE revision, family and revision (family:revision) for a specific revision in the family, or full Amazon Resource Name (ARN) of the task definition to describe.
730 */
731 taskDefinition: String;
732 }
733 export interface DescribeTaskDefinitionResponse {
734 /**
735 * The full task definition description.
736 */
737 taskDefinition?: TaskDefinition;
738 }
739 export interface DescribeTasksRequest {
740 /**
741 * The short name or full Amazon Resource Name (ARN) of the cluster that hosts the task to describe. If you do not specify a cluster, the default cluster is assumed.
742 */
743 cluster?: String;
744 /**
745 * A space-separated list of task IDs or full Amazon Resource Name (ARN) entries.
746 */
747 tasks: StringList;
748 }
749 export interface DescribeTasksResponse {
750 /**
751 * The list of tasks.
752 */
753 tasks?: Tasks;
754 /**
755 * Any failures associated with the call.
756 */
757 failures?: Failures;
758 }
759 export type DesiredStatus = "RUNNING"|"PENDING"|"STOPPED"|string;
760 export interface DiscoverPollEndpointRequest {
761 /**
762 * The container instance ID or full Amazon Resource Name (ARN) of the container instance. The ARN contains the arn:aws:ecs namespace, followed by the region of the container instance, the AWS account ID of the container instance owner, the container-instance namespace, and then the container instance ID. For example, arn:aws:ecs:region:aws_account_id:container-instance/container_instance_ID .
763 */
764 containerInstance?: String;
765 /**
766 * The cluster that the container instance belongs to.
767 */
768 cluster?: String;
769 }
770 export interface DiscoverPollEndpointResponse {
771 /**
772 * The endpoint for the Amazon ECS agent to poll.
773 */
774 endpoint?: String;
775 /**
776 * The telemetry endpoint for the Amazon ECS agent.
777 */
778 telemetryEndpoint?: String;
779 }
780 export type DockerLabelsMap = {[key: string]: String};
781 export type Double = number;
782 export type EnvironmentVariables = KeyValuePair[];
783 export interface Failure {
784 /**
785 * The Amazon Resource Name (ARN) of the failed resource.
786 */
787 arn?: String;
788 /**
789 * The reason for the failure.
790 */
791 reason?: String;
792 }
793 export type Failures = Failure[];
794 export interface HostEntry {
795 /**
796 * The hostname to use in the /etc/hosts entry.
797 */
798 hostname: String;
799 /**
800 * The IP address to use in the /etc/hosts entry.
801 */
802 ipAddress: String;
803 }
804 export type HostEntryList = HostEntry[];
805 export interface HostVolumeProperties {
806 /**
807 * The path on the host container instance that is presented to the container. If this parameter is empty, then the Docker daemon has assigned a host path for you. If the host parameter contains a sourcePath file location, then the data volume persists at the specified location on the host container instance until you delete it manually. If the sourcePath value does not exist on the host container instance, the Docker daemon creates it. If the location does exist, the contents of the source path folder are exported.
808 */
809 sourcePath?: String;
810 }
811 export type Integer = number;
812 export interface KeyValuePair {
813 /**
814 * The name of the key value pair. For environment variables, this is the name of the environment variable.
815 */
816 name?: String;
817 /**
818 * The value of the key value pair. For environment variables, this is the value of the environment variable.
819 */
820 value?: String;
821 }
822 export interface ListClustersRequest {
823 /**
824 * The nextToken value returned from a previous paginated ListClusters request where maxResults was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the nextToken value. This value is null when there are no more results to return. This token should be treated as an opaque identifier that is only used to retrieve the next items in a list and not for other programmatic purposes.
825 */
826 nextToken?: String;
827 /**
828 * The maximum number of cluster results returned by ListClusters in paginated output. When this parameter is used, ListClusters only returns maxResults results in a single page along with a nextToken response element. The remaining results of the initial request can be seen by sending another ListClusters request with the returned nextToken value. This value can be between 1 and 100. If this parameter is not used, then ListClusters returns up to 100 results and a nextToken value if applicable.
829 */
830 maxResults?: BoxedInteger;
831 }
832 export interface ListClustersResponse {
833 /**
834 * The list of full Amazon Resource Name (ARN) entries for each cluster associated with your account.
835 */
836 clusterArns?: StringList;
837 /**
838 * The nextToken value to include in a future ListClusters request. When the results of a ListClusters request exceed maxResults, this value can be used to retrieve the next page of results. This value is null when there are no more results to return.
839 */
840 nextToken?: String;
841 }
842 export interface ListContainerInstancesRequest {
843 /**
844 * The short name or full Amazon Resource Name (ARN) of the cluster that hosts the container instances to list. If you do not specify a cluster, the default cluster is assumed.
845 */
846 cluster?: String;
847 /**
848 * The nextToken value returned from a previous paginated ListContainerInstances request where maxResults was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the nextToken value. This value is null when there are no more results to return. This token should be treated as an opaque identifier that is only used to retrieve the next items in a list and not for other programmatic purposes.
849 */
850 nextToken?: String;
851 /**
852 * The maximum number of container instance results returned by ListContainerInstances in paginated output. When this parameter is used, ListContainerInstances only returns maxResults results in a single page along with a nextToken response element. The remaining results of the initial request can be seen by sending another ListContainerInstances request with the returned nextToken value. This value can be between 1 and 100. If this parameter is not used, then ListContainerInstances returns up to 100 results and a nextToken value if applicable.
853 */
854 maxResults?: BoxedInteger;
855 }
856 export interface ListContainerInstancesResponse {
857 /**
858 * The list of container instances with full Amazon Resource Name (ARN) entries for each container instance associated with the specified cluster.
859 */
860 containerInstanceArns?: StringList;
861 /**
862 * The nextToken value to include in a future ListContainerInstances request. When the results of a ListContainerInstances request exceed maxResults, this value can be used to retrieve the next page of results. This value is null when there are no more results to return.
863 */
864 nextToken?: String;
865 }
866 export interface ListServicesRequest {
867 /**
868 * The short name or full Amazon Resource Name (ARN) of the cluster that hosts the services to list. If you do not specify a cluster, the default cluster is assumed.
869 */
870 cluster?: String;
871 /**
872 * The nextToken value returned from a previous paginated ListServices request where maxResults was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the nextToken value. This value is null when there are no more results to return. This token should be treated as an opaque identifier that is only used to retrieve the next items in a list and not for other programmatic purposes.
873 */
874 nextToken?: String;
875 /**
876 * The maximum number of container instance results returned by ListServices in paginated output. When this parameter is used, ListServices only returns maxResults results in a single page along with a nextToken response element. The remaining results of the initial request can be seen by sending another ListServices request with the returned nextToken value. This value can be between 1 and 10. If this parameter is not used, then ListServices returns up to 10 results and a nextToken value if applicable.
877 */
878 maxResults?: BoxedInteger;
879 }
880 export interface ListServicesResponse {
881 /**
882 * The list of full Amazon Resource Name (ARN) entries for each service associated with the specified cluster.
883 */
884 serviceArns?: StringList;
885 /**
886 * The nextToken value to include in a future ListServices request. When the results of a ListServices request exceed maxResults, this value can be used to retrieve the next page of results. This value is null when there are no more results to return.
887 */
888 nextToken?: String;
889 }
890 export interface ListTaskDefinitionFamiliesRequest {
891 /**
892 * The familyPrefix is a string that is used to filter the results of ListTaskDefinitionFamilies. If you specify a familyPrefix, only task definition family names that begin with the familyPrefix string are returned.
893 */
894 familyPrefix?: String;
895 /**
896 * The task definition family status with which to filter the ListTaskDefinitionFamilies results. By default, both ACTIVE and INACTIVE task definition families are listed. If this parameter is set to ACTIVE, only task definition families that have an ACTIVE task definition revision are returned. If this parameter is set to INACTIVE, only task definition families that do not have any ACTIVE task definition revisions are returned. If you paginate the resulting output, be sure to keep the status value constant in each subsequent request.
897 */
898 status?: TaskDefinitionFamilyStatus;
899 /**
900 * The nextToken value returned from a previous paginated ListTaskDefinitionFamilies request where maxResults was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the nextToken value. This value is null when there are no more results to return. This token should be treated as an opaque identifier that is only used to retrieve the next items in a list and not for other programmatic purposes.
901 */
902 nextToken?: String;
903 /**
904 * The maximum number of task definition family results returned by ListTaskDefinitionFamilies in paginated output. When this parameter is used, ListTaskDefinitions only returns maxResults results in a single page along with a nextToken response element. The remaining results of the initial request can be seen by sending another ListTaskDefinitionFamilies request with the returned nextToken value. This value can be between 1 and 100. If this parameter is not used, then ListTaskDefinitionFamilies returns up to 100 results and a nextToken value if applicable.
905 */
906 maxResults?: BoxedInteger;
907 }
908 export interface ListTaskDefinitionFamiliesResponse {
909 /**
910 * The list of task definition family names that match the ListTaskDefinitionFamilies request.
911 */
912 families?: StringList;
913 /**
914 * The nextToken value to include in a future ListTaskDefinitionFamilies request. When the results of a ListTaskDefinitionFamilies request exceed maxResults, this value can be used to retrieve the next page of results. This value is null when there are no more results to return.
915 */
916 nextToken?: String;
917 }
918 export interface ListTaskDefinitionsRequest {
919 /**
920 * The full family name with which to filter the ListTaskDefinitions results. Specifying a familyPrefix limits the listed task definitions to task definition revisions that belong to that family.
921 */
922 familyPrefix?: String;
923 /**
924 * The task definition status with which to filter the ListTaskDefinitions results. By default, only ACTIVE task definitions are listed. By setting this parameter to INACTIVE, you can view task definitions that are INACTIVE as long as an active task or service still references them. If you paginate the resulting output, be sure to keep the status value constant in each subsequent request.
925 */
926 status?: TaskDefinitionStatus;
927 /**
928 * The order in which to sort the results. Valid values are ASC and DESC. By default (ASC), task definitions are listed lexicographically by family name and in ascending numerical order by revision so that the newest task definitions in a family are listed last. Setting this parameter to DESC reverses the sort order on family name and revision so that the newest task definitions in a family are listed first.
929 */
930 sort?: SortOrder;
931 /**
932 * The nextToken value returned from a previous paginated ListTaskDefinitions request where maxResults was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the nextToken value. This value is null when there are no more results to return. This token should be treated as an opaque identifier that is only used to retrieve the next items in a list and not for other programmatic purposes.
933 */
934 nextToken?: String;
935 /**
936 * The maximum number of task definition results returned by ListTaskDefinitions in paginated output. When this parameter is used, ListTaskDefinitions only returns maxResults results in a single page along with a nextToken response element. The remaining results of the initial request can be seen by sending another ListTaskDefinitions request with the returned nextToken value. This value can be between 1 and 100. If this parameter is not used, then ListTaskDefinitions returns up to 100 results and a nextToken value if applicable.
937 */
938 maxResults?: BoxedInteger;
939 }
940 export interface ListTaskDefinitionsResponse {
941 /**
942 * The list of task definition Amazon Resource Name (ARN) entries for the ListTaskDefinitions request.
943 */
944 taskDefinitionArns?: StringList;
945 /**
946 * The nextToken value to include in a future ListTaskDefinitions request. When the results of a ListTaskDefinitions request exceed maxResults, this value can be used to retrieve the next page of results. This value is null when there are no more results to return.
947 */
948 nextToken?: String;
949 }
950 export interface ListTasksRequest {
951 /**
952 * The short name or full Amazon Resource Name (ARN) of the cluster that hosts the tasks to list. If you do not specify a cluster, the default cluster is assumed.
953 */
954 cluster?: String;
955 /**
956 * The container instance ID or full Amazon Resource Name (ARN) of the container instance with which to filter the ListTasks results. Specifying a containerInstance limits the results to tasks that belong to that container instance.
957 */
958 containerInstance?: String;
959 /**
960 * The name of the family with which to filter the ListTasks results. Specifying a family limits the results to tasks that belong to that family.
961 */
962 family?: String;
963 /**
964 * The nextToken value returned from a previous paginated ListTasks request where maxResults was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the nextToken value. This value is null when there are no more results to return. This token should be treated as an opaque identifier that is only used to retrieve the next items in a list and not for other programmatic purposes.
965 */
966 nextToken?: String;
967 /**
968 * The maximum number of task results returned by ListTasks in paginated output. When this parameter is used, ListTasks only returns maxResults results in a single page along with a nextToken response element. The remaining results of the initial request can be seen by sending another ListTasks request with the returned nextToken value. This value can be between 1 and 100. If this parameter is not used, then ListTasks returns up to 100 results and a nextToken value if applicable.
969 */
970 maxResults?: BoxedInteger;
971 /**
972 * The startedBy value with which to filter the task results. Specifying a startedBy value limits the results to tasks that were started with that value.
973 */
974 startedBy?: String;
975 /**
976 * The name of the service with which to filter the ListTasks results. Specifying a serviceName limits the results to tasks that belong to that service.
977 */
978 serviceName?: String;
979 /**
980 * The task desired status with which to filter the ListTasks results. Specifying a desiredStatus of STOPPED limits the results to tasks that ECS has set the desired status to STOPPED, which can be useful for debugging tasks that are not starting properly or have died or finished. The default status filter is RUNNING, which shows tasks that ECS has set the desired status to RUNNING. Although you can filter results based on a desired status of PENDING, this will not return any results because ECS never sets the desired status of a task to that value (only a task's lastStatus may have a value of PENDING).
981 */
982 desiredStatus?: DesiredStatus;
983 }
984 export interface ListTasksResponse {
985 /**
986 * The list of task Amazon Resource Name (ARN) entries for the ListTasks request.
987 */
988 taskArns?: StringList;
989 /**
990 * The nextToken value to include in a future ListTasks request. When the results of a ListTasks request exceed maxResults, this value can be used to retrieve the next page of results. This value is null when there are no more results to return.
991 */
992 nextToken?: String;
993 }
994 export interface LoadBalancer {
995 /**
996 * The full Amazon Resource Name (ARN) of the Elastic Load Balancing target group associated with a service.
997 */
998 targetGroupArn?: String;
999 /**
1000 * The name of the load balancer.
1001 */
1002 loadBalancerName?: String;
1003 /**
1004 * The name of the container (as it appears in a container definition) to associate with the load balancer.
1005 */
1006 containerName?: String;
1007 /**
1008 * The port on the container to associate with the load balancer. This port must correspond to a containerPort in the service's task definition. Your container instances must allow ingress traffic on the hostPort of the port mapping.
1009 */
1010 containerPort?: BoxedInteger;
1011 }
1012 export type LoadBalancers = LoadBalancer[];
1013 export interface LogConfiguration {
1014 /**
1015 * The log driver to use for the container. The valid values listed for this parameter are log drivers that the Amazon ECS container agent can communicate with by default. If you have a custom driver that is not listed above that you would like to work with the Amazon ECS container agent, you can fork the Amazon ECS container agent project that is available on GitHub and customize it to work with that driver. We encourage you to submit pull requests for changes that you would like to have included. However, Amazon Web Services does not currently provide support for running modified copies of this software. This parameter requires version 1.18 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log into your container instance and run the following command: sudo docker version | grep "Server API version"
1016 */
1017 logDriver: LogDriver;
1018 /**
1019 * The configuration options to send to the log driver. This parameter requires version 1.19 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log into your container instance and run the following command: sudo docker version | grep "Server API version"
1020 */
1021 options?: LogConfigurationOptionsMap;
1022 }
1023 export type LogConfigurationOptionsMap = {[key: string]: String};
1024 export type LogDriver = "json-file"|"syslog"|"journald"|"gelf"|"fluentd"|"awslogs"|"splunk"|string;
1025 export type Long = number;
1026 export interface MountPoint {
1027 /**
1028 * The name of the volume to mount.
1029 */
1030 sourceVolume?: String;
1031 /**
1032 * The path on the container to mount the host volume at.
1033 */
1034 containerPath?: String;
1035 /**
1036 * If this value is true, the container has read-only access to the volume. If this value is false, then the container can write to the volume. The default value is false.
1037 */
1038 readOnly?: BoxedBoolean;
1039 }
1040 export type MountPointList = MountPoint[];
1041 export interface NetworkBinding {
1042 /**
1043 * The IP address that the container is bound to on the container instance.
1044 */
1045 bindIP?: String;
1046 /**
1047 * The port number on the container that is be used with the network binding.
1048 */
1049 containerPort?: BoxedInteger;
1050 /**
1051 * The port number on the host that is used with the network binding.
1052 */
1053 hostPort?: BoxedInteger;
1054 /**
1055 * The protocol used for the network binding.
1056 */
1057 protocol?: TransportProtocol;
1058 }
1059 export type NetworkBindings = NetworkBinding[];
1060 export type NetworkMode = "bridge"|"host"|"none"|string;
1061 export interface PortMapping {
1062 /**
1063 * The port number on the container that is bound to the user-specified or automatically assigned host port. If you specify a container port and not a host port, your container automatically receives a host port in the ephemeral port range (for more information, see hostPort). Port mappings that are automatically assigned in this way do not count toward the 100 reserved ports limit of a container instance.
1064 */
1065 containerPort?: BoxedInteger;
1066 /**
1067 * The port number on the container instance to reserve for your container. You can specify a non-reserved host port for your container port mapping, or you can omit the hostPort (or set it to 0) while specifying a containerPort and your container automatically receives a port in the ephemeral port range for your container instance operating system and Docker version. The default ephemeral port range is 49153 to 65535, and this range is used for Docker versions prior to 1.6.0. For Docker version 1.6.0 and later, the Docker daemon tries to read the ephemeral port range from /proc/sys/net/ipv4/ip_local_port_range; if this kernel parameter is unavailable, the default ephemeral port range is used. You should not attempt to specify a host port in the ephemeral port range, because these are reserved for automatic assignment. In general, ports below 32768 are outside of the ephemeral port range. The default reserved ports are 22 for SSH, the Docker ports 2375 and 2376, and the Amazon ECS container agent ports 51678 and 51679. Any host port that was previously specified in a running task is also reserved while the task is running (after a task stops, the host port is released).The current reserved ports are displayed in the remainingResources of DescribeContainerInstances output, and a container instance may have up to 100 reserved ports at a time, including the default reserved ports (automatically assigned ports do not count toward the 100 reserved ports limit).
1068 */
1069 hostPort?: BoxedInteger;
1070 /**
1071 * The protocol used for the port mapping. Valid values are tcp and udp. The default is tcp.
1072 */
1073 protocol?: TransportProtocol;
1074 }
1075 export type PortMappingList = PortMapping[];
1076 export interface RegisterContainerInstanceRequest {
1077 /**
1078 * The short name or full Amazon Resource Name (ARN) of the cluster with which to register your container instance. If you do not specify a cluster, the default cluster is assumed.
1079 */
1080 cluster?: String;
1081 /**
1082 * The instance identity document for the EC2 instance to register. This document can be found by running the following command from the instance: curl http://169.254.169.254/latest/dynamic/instance-identity/document/
1083 */
1084 instanceIdentityDocument?: String;
1085 /**
1086 * The instance identity document signature for the EC2 instance to register. This signature can be found by running the following command from the instance: curl http://169.254.169.254/latest/dynamic/instance-identity/signature/
1087 */
1088 instanceIdentityDocumentSignature?: String;
1089 /**
1090 * The resources available on the instance.
1091 */
1092 totalResources?: Resources;
1093 /**
1094 * The version information for the Amazon ECS container agent and Docker daemon running on the container instance.
1095 */
1096 versionInfo?: VersionInfo;
1097 /**
1098 * The Amazon Resource Name (ARN) of the container instance (if it was previously registered).
1099 */
1100 containerInstanceArn?: String;
1101 /**
1102 * The container instance attributes that this container instance supports.
1103 */
1104 attributes?: Attributes;
1105 }
1106 export interface RegisterContainerInstanceResponse {
1107 /**
1108 * The container instance that was registered.
1109 */
1110 containerInstance?: ContainerInstance;
1111 }
1112 export interface RegisterTaskDefinitionRequest {
1113 /**
1114 * You must specify a family for a task definition, which allows you to track multiple versions of the same task definition. The family is used as a name for your task definition. Up to 255 letters (uppercase and lowercase), numbers, hyphens, and underscores are allowed.
1115 */
1116 family: String;
1117 /**
1118 * 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 IAM Roles for Tasks in the Amazon EC2 Container Service Developer Guide.
1119 */
1120 taskRoleArn?: String;
1121 /**
1122 * The Docker networking mode to use for the containers in the task. The valid values are none, bridge, and host. The default Docker network mode is bridge. If the network mode is set to none, you cannot specify port mappings in your container definitions, and the task's containers do not have external connectivity. The host network mode offers the highest networking performance for containers because they use the host network stack instead of the virtualized network stack provided by the bridge mode; however, exposed container ports are mapped directly to the corresponding host port, so you cannot take advantage of dynamic host port mappings or run multiple instantiations of the same task on a single container instance if port mappings are used. For more information, see Network settings in the Docker run reference.
1123 */
1124 networkMode?: NetworkMode;
1125 /**
1126 * A list of container definitions in JSON format that describe the different containers that make up your task.
1127 */
1128 containerDefinitions: ContainerDefinitions;
1129 /**
1130 * A list of volume definitions in JSON format that containers in your task may use.
1131 */
1132 volumes?: VolumeList;
1133 }
1134 export interface RegisterTaskDefinitionResponse {
1135 /**
1136 * The full description of the registered task definition.
1137 */
1138 taskDefinition?: TaskDefinition;
1139 }
1140 export type RequiresAttributes = Attribute[];
1141 export interface Resource {
1142 /**
1143 * The name of the resource, such as CPU, MEMORY, PORTS, or a user-defined resource.
1144 */
1145 name?: String;
1146 /**
1147 * The type of the resource, such as INTEGER, DOUBLE, LONG, or STRINGSET.
1148 */
1149 type?: String;
1150 /**
1151 * When the doubleValue type is set, the value of the resource must be a double precision floating-point type.
1152 */
1153 doubleValue?: Double;
1154 /**
1155 * When the longValue type is set, the value of the resource must be an extended precision floating-point type.
1156 */
1157 longValue?: Long;
1158 /**
1159 * When the integerValue type is set, the value of the resource must be an integer.
1160 */
1161 integerValue?: Integer;
1162 /**
1163 * When the stringSetValue type is set, the value of the resource must be a string type.
1164 */
1165 stringSetValue?: StringList;
1166 }
1167 export type Resources = Resource[];
1168 export interface RunTaskRequest {
1169 /**
1170 * The short name or full Amazon Resource Name (ARN) of the cluster on which to run your task. If you do not specify a cluster, the default cluster is assumed.
1171 */
1172 cluster?: String;
1173 /**
1174 * The family and revision (family:revision) or full Amazon Resource Name (ARN) of the task definition to run. If a revision is not specified, the latest ACTIVE revision is used.
1175 */
1176 taskDefinition: String;
1177 /**
1178 * A list of container overrides in JSON format that specify the name of a container in the specified task definition and the overrides it should receive. You can override the default command for a container (that is specified in the task definition or Docker image) with a command override. You can also override existing environment variables (that are specified in the task definition or Docker image) on a container or add new environment variables to it with an environment override. A total of 8192 characters are allowed for overrides. This limit includes the JSON formatting characters of the override structure.
1179 */
1180 overrides?: TaskOverride;
1181 /**
1182 * The number of instantiations of the specified task to place on your cluster. The count parameter is limited to 10 tasks per call.
1183 */
1184 count?: BoxedInteger;
1185 /**
1186 * An optional tag specified when a task is started. For example if you automatically trigger a task to run a batch process job, you could apply a unique identifier for that job to your task with the startedBy parameter. You can then identify which tasks belong to that job by filtering the results of a ListTasks call with the startedBy value. Up to 36 letters (uppercase and lowercase), numbers, hyphens, and underscores are allowed. If a task is started by an Amazon ECS service, then the startedBy parameter contains the deployment ID of the service that starts it.
1187 */
1188 startedBy?: String;
1189 }
1190 export interface RunTaskResponse {
1191 /**
1192 * A full description of the tasks that were run. Each task that was successfully placed on your cluster are described here.
1193 */
1194 tasks?: Tasks;
1195 /**
1196 * Any failures associated with the call.
1197 */
1198 failures?: Failures;
1199 }
1200 export interface Service {
1201 /**
1202 * The Amazon Resource Name (ARN) that identifies the service. The ARN contains the arn:aws:ecs namespace, followed by the region of the service, the AWS account ID of the service owner, the service namespace, and then the service name. For example, arn:aws:ecs:region:012345678910:service/my-service .
1203 */
1204 serviceArn?: String;
1205 /**
1206 * The name of your service. Up to 255 letters (uppercase and lowercase), numbers, hyphens, and underscores are allowed. Service names must be unique within a cluster, but you can have similarly named services in multiple clusters within a region or across multiple regions.
1207 */
1208 serviceName?: String;
1209 /**
1210 * The Amazon Resource Name (ARN) of the cluster that hosts the service.
1211 */
1212 clusterArn?: String;
1213 /**
1214 * A list of Elastic Load Balancing load balancer objects, containing the load balancer name, the container name (as it appears in a container definition), and the container port to access from the load balancer.
1215 */
1216 loadBalancers?: LoadBalancers;
1217 /**
1218 * The status of the service. The valid values are ACTIVE, DRAINING, or INACTIVE.
1219 */
1220 status?: String;
1221 /**
1222 * The desired number of instantiations of the task definition to keep running on the service. This value is specified when the service is created with CreateService, and it can be modified with UpdateService.
1223 */
1224 desiredCount?: Integer;
1225 /**
1226 * The number of tasks in the cluster that are in the RUNNING state.
1227 */
1228 runningCount?: Integer;
1229 /**
1230 * The number of tasks in the cluster that are in the PENDING state.
1231 */
1232 pendingCount?: Integer;
1233 /**
1234 * The task definition to use for tasks in the service. This value is specified when the service is created with CreateService, and it can be modified with UpdateService.
1235 */
1236 taskDefinition?: String;
1237 /**
1238 * Optional deployment parameters that control how many tasks run during the deployment and the ordering of stopping and starting tasks.
1239 */
1240 deploymentConfiguration?: DeploymentConfiguration;
1241 /**
1242 * The current state of deployments for the service.
1243 */
1244 deployments?: Deployments;
1245 /**
1246 * The Amazon Resource Name (ARN) of the IAM role associated with the service that allows the Amazon ECS container agent to register container instances with an Elastic Load Balancing load balancer.
1247 */
1248 roleArn?: String;
1249 /**
1250 * The event stream for your service. A maximum of 100 of the latest events are displayed.
1251 */
1252 events?: ServiceEvents;
1253 /**
1254 * The Unix timestamp for when the service was created.
1255 */
1256 createdAt?: Timestamp;
1257 }
1258 export interface ServiceEvent {
1259 /**
1260 * The ID string of the event.
1261 */
1262 id?: String;
1263 /**
1264 * The Unix timestamp for when the event was triggered.
1265 */
1266 createdAt?: Timestamp;
1267 /**
1268 * The event message.
1269 */
1270 message?: String;
1271 }
1272 export type ServiceEvents = ServiceEvent[];
1273 export type Services = Service[];
1274 export type SortOrder = "ASC"|"DESC"|string;
1275 export interface StartTaskRequest {
1276 /**
1277 * The short name or full Amazon Resource Name (ARN) of the cluster on which to start your task. If you do not specify a cluster, the default cluster is assumed.
1278 */
1279 cluster?: String;
1280 /**
1281 * The family and revision (family:revision) or full Amazon Resource Name (ARN) of the task definition to start. If a revision is not specified, the latest ACTIVE revision is used.
1282 */
1283 taskDefinition: String;
1284 /**
1285 * A list of container overrides in JSON format that specify the name of a container in the specified task definition and the overrides it should receive. You can override the default command for a container (that is specified in the task definition or Docker image) with a command override. You can also override existing environment variables (that are specified in the task definition or Docker image) on a container or add new environment variables to it with an environment override. A total of 8192 characters are allowed for overrides. This limit includes the JSON formatting characters of the override structure.
1286 */
1287 overrides?: TaskOverride;
1288 /**
1289 * The container instance IDs or full Amazon Resource Name (ARN) entries for the container instances on which you would like to place your task. The list of container instances to start tasks on is limited to 10.
1290 */
1291 containerInstances: StringList;
1292 /**
1293 * An optional tag specified when a task is started. For example if you automatically trigger a task to run a batch process job, you could apply a unique identifier for that job to your task with the startedBy parameter. You can then identify which tasks belong to that job by filtering the results of a ListTasks call with the startedBy value. Up to 36 letters (uppercase and lowercase), numbers, hyphens, and underscores are allowed. If a task is started by an Amazon ECS service, then the startedBy parameter contains the deployment ID of the service that starts it.
1294 */
1295 startedBy?: String;
1296 }
1297 export interface StartTaskResponse {
1298 /**
1299 * A full description of the tasks that were started. Each task that was successfully placed on your container instances are described here.
1300 */
1301 tasks?: Tasks;
1302 /**
1303 * Any failures associated with the call.
1304 */
1305 failures?: Failures;
1306 }
1307 export interface StopTaskRequest {
1308 /**
1309 * 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.
1310 */
1311 cluster?: String;
1312 /**
1313 * The task ID or full Amazon Resource Name (ARN) entry of the task to stop.
1314 */
1315 task: String;
1316 /**
1317 * An optional message specified when a task is stopped. For example, if you are using a custom scheduler, you can use this parameter to specify the reason for stopping the task here, and the message will appear in subsequent DescribeTasks API operations on this task. Up to 255 characters are allowed in this message.
1318 */
1319 reason?: String;
1320 }
1321 export interface StopTaskResponse {
1322 /**
1323 * The task that was stopped.
1324 */
1325 task?: Task;
1326 }
1327 export type String = string;
1328 export type StringList = String[];
1329 export interface SubmitContainerStateChangeRequest {
1330 /**
1331 * The short name or full Amazon Resource Name (ARN) of the cluster that hosts the container.
1332 */
1333 cluster?: String;
1334 /**
1335 * The task ID or full Amazon Resource Name (ARN) of the task that hosts the container.
1336 */
1337 task?: String;
1338 /**
1339 * The name of the container.
1340 */
1341 containerName?: String;
1342 /**
1343 * The status of the state change request.
1344 */
1345 status?: String;
1346 /**
1347 * The exit code returned for the state change request.
1348 */
1349 exitCode?: BoxedInteger;
1350 /**
1351 * The reason for the state change request.
1352 */
1353 reason?: String;
1354 /**
1355 * The network bindings of the container.
1356 */
1357 networkBindings?: NetworkBindings;
1358 }
1359 export interface SubmitContainerStateChangeResponse {
1360 /**
1361 * Acknowledgement of the state change.
1362 */
1363 acknowledgment?: String;
1364 }
1365 export interface SubmitTaskStateChangeRequest {
1366 /**
1367 * The short name or full Amazon Resource Name (ARN) of the cluster that hosts the task.
1368 */
1369 cluster?: String;
1370 /**
1371 * The task ID or full Amazon Resource Name (ARN) of the task in the state change request.
1372 */
1373 task?: String;
1374 /**
1375 * The status of the state change request.
1376 */
1377 status?: String;
1378 /**
1379 * The reason for the state change request.
1380 */
1381 reason?: String;
1382 }
1383 export interface SubmitTaskStateChangeResponse {
1384 /**
1385 * Acknowledgement of the state change.
1386 */
1387 acknowledgment?: String;
1388 }
1389 export interface Task {
1390 /**
1391 * The Amazon Resource Name (ARN) of the task.
1392 */
1393 taskArn?: String;
1394 /**
1395 * The Amazon Resource Name (ARN) of the cluster that hosts the task.
1396 */
1397 clusterArn?: String;
1398 /**
1399 * The Amazon Resource Name (ARN) of the task definition that creates the task.
1400 */
1401 taskDefinitionArn?: String;
1402 /**
1403 * The Amazon Resource Name (ARN) of the container instances that host the task.
1404 */
1405 containerInstanceArn?: String;
1406 /**
1407 * One or more container overrides.
1408 */
1409 overrides?: TaskOverride;
1410 /**
1411 * The last known status of the task.
1412 */
1413 lastStatus?: String;
1414 /**
1415 * The desired status of the task.
1416 */
1417 desiredStatus?: String;
1418 /**
1419 * The containers associated with the task.
1420 */
1421 containers?: Containers;
1422 /**
1423 * The tag specified when a task is started. If the task is started by an Amazon ECS service, then the startedBy parameter contains the deployment ID of the service that starts it.
1424 */
1425 startedBy?: String;
1426 /**
1427 * The version counter for the task. Every time a task experiences a change that triggers a CloudWatch event, the version counter is incremented. If you are replicating your Amazon ECS task state with CloudWatch events, you can compare the version of a task reported by the Amazon ECS APIs with the version reported in CloudWatch events for the task (inside the detail object) to verify that the version in your event stream is current.
1428 */
1429 version?: Long;
1430 /**
1431 * The reason the task was stopped.
1432 */
1433 stoppedReason?: String;
1434 /**
1435 * The Unix timestamp for when the task was created (the task entered the PENDING state).
1436 */
1437 createdAt?: Timestamp;
1438 /**
1439 * The Unix timestamp for when the task was started (the task transitioned from the PENDING state to the RUNNING state).
1440 */
1441 startedAt?: Timestamp;
1442 /**
1443 * The Unix timestamp for when the task was stopped (the task transitioned from the RUNNING state to the STOPPED state).
1444 */
1445 stoppedAt?: Timestamp;
1446 }
1447 export interface TaskDefinition {
1448 /**
1449 * The full Amazon Resource Name (ARN) of the task definition.
1450 */
1451 taskDefinitionArn?: String;
1452 /**
1453 * A list of container definitions in JSON format that describe the different containers that make up your task. For more information about container definition parameters and defaults, see Amazon ECS Task Definitions in the Amazon EC2 Container Service Developer Guide.
1454 */
1455 containerDefinitions?: ContainerDefinitions;
1456 /**
1457 * The family of your task definition, used as the definition name.
1458 */
1459 family?: String;
1460 /**
1461 * The Amazon Resource Name (ARN) of the IAM role that containers in this task can assume. All containers in this task are granted the permissions that are specified in this role.
1462 */
1463 taskRoleArn?: String;
1464 /**
1465 * The Docker networking mode to use for the containers in the task. The valid values are none, bridge, and host. If the network mode is none, the containers do not have external connectivity. The default Docker network mode is bridge. The host network mode offers the highest networking performance for containers because it uses the host network stack instead of the virtualized network stack provided by the bridge mode. For more information, see Network settings in the Docker run reference.
1466 */
1467 networkMode?: NetworkMode;
1468 /**
1469 * The revision of the task in a particular family. The revision is a version number of a task definition in a family. When you register a task definition for the first time, the revision is 1; each time you register a new revision of a task definition in the same family, the revision value always increases by one (even if you have deregistered previous revisions in this family).
1470 */
1471 revision?: Integer;
1472 /**
1473 * The list of volumes in a task. For more information about volume definition parameters and defaults, see Amazon ECS Task Definitions in the Amazon EC2 Container Service Developer Guide.
1474 */
1475 volumes?: VolumeList;
1476 /**
1477 * The status of the task definition.
1478 */
1479 status?: TaskDefinitionStatus;
1480 /**
1481 * The container instance attributes required by your task.
1482 */
1483 requiresAttributes?: RequiresAttributes;
1484 }
1485 export type TaskDefinitionFamilyStatus = "ACTIVE"|"INACTIVE"|"ALL"|string;
1486 export type TaskDefinitionStatus = "ACTIVE"|"INACTIVE"|string;
1487 export interface TaskOverride {
1488 /**
1489 * One or more container overrides sent to a task.
1490 */
1491 containerOverrides?: ContainerOverrides;
1492 /**
1493 * The Amazon Resource Name (ARN) of the IAM role that containers in this task can assume. All containers in this task are granted the permissions that are specified in this role.
1494 */
1495 taskRoleArn?: String;
1496 }
1497 export type Tasks = Task[];
1498 export type Timestamp = Date;
1499 export type TransportProtocol = "tcp"|"udp"|string;
1500 export interface Ulimit {
1501 /**
1502 * The type of the ulimit.
1503 */
1504 name: UlimitName;
1505 /**
1506 * The soft limit for the ulimit type.
1507 */
1508 softLimit: Integer;
1509 /**
1510 * The hard limit for the ulimit type.
1511 */
1512 hardLimit: Integer;
1513 }
1514 export type UlimitList = Ulimit[];
1515 export type UlimitName = "core"|"cpu"|"data"|"fsize"|"locks"|"memlock"|"msgqueue"|"nice"|"nofile"|"nproc"|"rss"|"rtprio"|"rttime"|"sigpending"|"stack"|string;
1516 export interface UpdateContainerAgentRequest {
1517 /**
1518 * The short name or full Amazon Resource Name (ARN) of the cluster that your container instance is running on. If you do not specify a cluster, the default cluster is assumed.
1519 */
1520 cluster?: String;
1521 /**
1522 * The container instance ID or full Amazon Resource Name (ARN) entries for the container instance on which you would like to update the Amazon ECS container agent.
1523 */
1524 containerInstance: String;
1525 }
1526 export interface UpdateContainerAgentResponse {
1527 /**
1528 * The container instance for which the container agent was updated.
1529 */
1530 containerInstance?: ContainerInstance;
1531 }
1532 export interface UpdateServiceRequest {
1533 /**
1534 * The short name or full Amazon Resource Name (ARN) of the cluster that your service is running on. If you do not specify a cluster, the default cluster is assumed.
1535 */
1536 cluster?: String;
1537 /**
1538 * The name of the service to update.
1539 */
1540 service: String;
1541 /**
1542 * The number of instantiations of the task to place and keep running in your service.
1543 */
1544 desiredCount?: BoxedInteger;
1545 /**
1546 * The family and revision (family:revision) or full Amazon Resource Name (ARN) of the task definition to run in your service. If a revision is not specified, the latest ACTIVE revision is used. If you modify the task definition with UpdateService, Amazon ECS spawns a task with the new version of the task definition and then stops an old task after the new version is running.
1547 */
1548 taskDefinition?: String;
1549 /**
1550 * Optional deployment parameters that control how many tasks run during the deployment and the ordering of stopping and starting tasks.
1551 */
1552 deploymentConfiguration?: DeploymentConfiguration;
1553 }
1554 export interface UpdateServiceResponse {
1555 /**
1556 * The full description of your service following the update call.
1557 */
1558 service?: Service;
1559 }
1560 export interface VersionInfo {
1561 /**
1562 * The version number of the Amazon ECS container agent.
1563 */
1564 agentVersion?: String;
1565 /**
1566 * The Git commit hash for the Amazon ECS container agent build on the amazon-ecs-agent GitHub repository.
1567 */
1568 agentHash?: String;
1569 /**
1570 * The Docker version running on the container instance.
1571 */
1572 dockerVersion?: String;
1573 }
1574 export interface Volume {
1575 /**
1576 * The name of the volume. Up to 255 letters (uppercase and lowercase), numbers, hyphens, and underscores are allowed. This name is referenced in the sourceVolume parameter of container definition mountPoints.
1577 */
1578 name?: String;
1579 /**
1580 * The contents of the host parameter determine whether your data volume persists on the host container instance and where it is stored. If the host parameter is empty, then the Docker daemon assigns a host path for your data volume, but the data is not guaranteed to persist after the containers associated with it stop running.
1581 */
1582 host?: HostVolumeProperties;
1583 }
1584 export interface VolumeFrom {
1585 /**
1586 * The name of the container to mount volumes from.
1587 */
1588 sourceContainer?: String;
1589 /**
1590 * If this value is true, the container has read-only access to the volume. If this value is false, then the container can write to the volume. The default value is false.
1591 */
1592 readOnly?: BoxedBoolean;
1593 }
1594 export type VolumeFromList = VolumeFrom[];
1595 export type VolumeList = Volume[];
1596 /**
1597 * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version.
1598 */
1599 export type apiVersion = "2014-11-13"|"latest"|string;
1600 export interface ClientApiVersions {
1601 /**
1602 * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version.
1603 */
1604 apiVersion?: apiVersion;
1605 }
1606 export type ClientConfiguration = ServiceConfigurationOptions & ClientApiVersions;
1607 }
1608 export = ECS;