dprevot/python-botocore
1
0
Fork 0
Code Issues Pull requests Packages Projects Releases Wiki Activity
python-botocore/botocore/data/ecs/2014-11-13/service-2.json
TANIGUCHI Takaki 2519667221 New upstream version 1.4.70
2016-11-10 11:24:10 +09:00

2304 lines
146 KiB
JSON
Raw Blame History

{
"version":"2.0",
"metadata":{
"apiVersion":"2014-11-13",
"endpointPrefix":"ecs",
"jsonVersion":"1.1",
"protocol":"json",
"serviceAbbreviation":"Amazon ECS",
"serviceFullName":"Amazon EC2 Container Service",
"signatureVersion":"v4",
"targetPrefix":"AmazonEC2ContainerServiceV20141113"
},
"operations":{
"CreateCluster":{
"name":"CreateCluster",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"CreateClusterRequest"},
"output":{"shape":"CreateClusterResponse"},
"errors":[
{"shape":"ServerException"},
{"shape":"ClientException"},
{"shape":"InvalidParameterException"}
],
"documentation":"<p>Creates a new Amazon ECS cluster. By default, your account receives a <code>default</code> cluster when you launch your first container instance. However, you can create your own cluster with a unique name with the <code>CreateCluster</code> action.</p>"
},
"CreateService":{
"name":"CreateService",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"CreateServiceRequest"},
"output":{"shape":"CreateServiceResponse"},
"errors":[
{"shape":"ServerException"},
{"shape":"ClientException"},
{"shape":"InvalidParameterException"},
{"shape":"ClusterNotFoundException"}
],
"documentation":"<p>Runs and maintains a desired number of tasks from a specified task definition. If the number of tasks running in a service drops below <code>desiredCount</code>, Amazon ECS spawns another copy of the task in the specified cluster. To update an existing service, see <a>UpdateService</a>.</p> <p>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 <a href=\"http://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-load-balancing.html\">Service Load Balancing</a> in the <i>Amazon EC2 Container Service Developer Guide</i>.</p> <p>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 <a>UpdateService</a> operation), the service scheduler uses the <code>minimumHealthyPercent</code> and <code>maximumPercent</code> parameters to determine the deployment strategy.</p> <p>The <code>minimumHealthyPercent</code> represents a lower limit on the number of your service's tasks that must remain in the <code>RUNNING</code> state during a deployment, as a percentage of the <code>desiredCount</code> (rounded up to the nearest integer). This parameter enables you to deploy without using additional cluster capacity. For example, if your service has a <code>desiredCount</code> of four tasks and a <code>minimumHealthyPercent</code> of 50%, the scheduler may stop two existing tasks to free up cluster capacity before starting two new tasks. Tasks for services that <i>do not</i> use a load balancer are considered healthy if they are in the <code>RUNNING</code> state; tasks for services that <i>do</i> use a load balancer are considered healthy if they are in the <code>RUNNING</code> state and the container instance it is hosted on is reported as healthy by the load balancer. The default value for <code>minimumHealthyPercent</code> is 50% in the console and 100% for the AWS CLI, the AWS SDKs, and the APIs.</p> <p>The <code>maximumPercent</code> parameter represents an upper limit on the number of your service's tasks that are allowed in the <code>RUNNING</code> or <code>PENDING</code> state during a deployment, as a percentage of the <code>desiredCount</code> (rounded down to the nearest integer). This parameter enables you to define the deployment batch size. For example, if your service has a <code>desiredCount</code> of four tasks and a <code>maximumPercent</code> 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 <code>maximumPercent</code> is 200%.</p> <p>When the service scheduler launches new tasks, it attempts to balance them across the Availability Zones in your cluster with the following logic:</p> <ul> <li> <p>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).</p> </li> <li> <p>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.</p> </li> <li> <p>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.</p> </li> </ul>"
},
"DeleteCluster":{
"name":"DeleteCluster",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"DeleteClusterRequest"},
"output":{"shape":"DeleteClusterResponse"},
"errors":[
{"shape":"ServerException"},
{"shape":"ClientException"},
{"shape":"InvalidParameterException"},
{"shape":"ClusterNotFoundException"},
{"shape":"ClusterContainsContainerInstancesException"},
{"shape":"ClusterContainsServicesException"}
],
"documentation":"<p>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 <a>ListContainerInstances</a> and deregister them with <a>DeregisterContainerInstance</a>.</p>"
},
"DeleteService":{
"name":"DeleteService",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"DeleteServiceRequest"},
"output":{"shape":"DeleteServiceResponse"},
"errors":[
{"shape":"ServerException"},
{"shape":"ClientException"},
{"shape":"InvalidParameterException"},
{"shape":"ClusterNotFoundException"},
{"shape":"ServiceNotFoundException"}
],
"documentation":"<p>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 <a>UpdateService</a>.</p> <note> <p>When you delete a service, if there are still running tasks that require cleanup, the service status moves from <code>ACTIVE</code> to <code>DRAINING</code>, and the service is no longer visible in the console or in <a>ListServices</a> API operations. After the tasks have stopped, then the service status moves from <code>DRAINING</code> to <code>INACTIVE</code>. Services in the <code>DRAINING</code> or <code>INACTIVE</code> status can still be viewed with <a>DescribeServices</a> API operations; however, in the future, <code>INACTIVE</code> services may be cleaned up and purged from Amazon ECS record keeping, and <a>DescribeServices</a> API operations on those services will return a <code>ServiceNotFoundException</code> error.</p> </note>"
},
"DeregisterContainerInstance":{
"name":"DeregisterContainerInstance",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"DeregisterContainerInstanceRequest"},
"output":{"shape":"DeregisterContainerInstanceResponse"},
"errors":[
{"shape":"ServerException"},
{"shape":"ClientException"},
{"shape":"InvalidParameterException"},
{"shape":"ClusterNotFoundException"}
],
"documentation":"<p>Deregisters an Amazon ECS container instance from the specified cluster. This instance is no longer available to run tasks.</p> <p>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.</p> <p>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.</p> <note> <p>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).</p> </note>"
},
"DeregisterTaskDefinition":{
"name":"DeregisterTaskDefinition",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"DeregisterTaskDefinitionRequest"},
"output":{"shape":"DeregisterTaskDefinitionResponse"},
"errors":[
{"shape":"ServerException"},
{"shape":"ClientException"},
{"shape":"InvalidParameterException"}
],
"documentation":"<p>Deregisters the specified task definition by family and revision. Upon deregistration, the task definition is marked as <code>INACTIVE</code>. Existing tasks and services that reference an <code>INACTIVE</code> task definition continue to run without disruption. Existing services that reference an <code>INACTIVE</code> task definition can still scale up or down by modifying the service's desired count.</p> <p>You cannot use an <code>INACTIVE</code> task definition to run new tasks or create new services, and you cannot update an existing service to reference an <code>INACTIVE</code> task definition (although there may be up to a 10 minute window following deregistration where these restrictions have not yet taken effect).</p>"
},
"DescribeClusters":{
"name":"DescribeClusters",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"DescribeClustersRequest"},
"output":{"shape":"DescribeClustersResponse"},
"errors":[
{"shape":"ServerException"},
{"shape":"ClientException"},
{"shape":"InvalidParameterException"}
],
"documentation":"<p>Describes one or more of your clusters.</p>"
},
"DescribeContainerInstances":{
"name":"DescribeContainerInstances",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"DescribeContainerInstancesRequest"},
"output":{"shape":"DescribeContainerInstancesResponse"},
"errors":[
{"shape":"ServerException"},
{"shape":"ClientException"},
{"shape":"InvalidParameterException"},
{"shape":"ClusterNotFoundException"}
],
"documentation":"<p>Describes Amazon EC2 Container Service container instances. Returns metadata about registered and remaining resources on each container instance requested.</p>"
},
"DescribeServices":{
"name":"DescribeServices",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"DescribeServicesRequest"},
"output":{"shape":"DescribeServicesResponse"},
"errors":[
{"shape":"ServerException"},
{"shape":"ClientException"},
{"shape":"InvalidParameterException"},
{"shape":"ClusterNotFoundException"}
],
"documentation":"<p>Describes the specified services running in your cluster.</p>"
},
"DescribeTaskDefinition":{
"name":"DescribeTaskDefinition",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"DescribeTaskDefinitionRequest"},
"output":{"shape":"DescribeTaskDefinitionResponse"},
"errors":[
{"shape":"ServerException"},
{"shape":"ClientException"},
{"shape":"InvalidParameterException"}
],
"documentation":"<p>Describes a task definition. You can specify a <code>family</code> and <code>revision</code> to find information about a specific task definition, or you can simply specify the family to find the latest <code>ACTIVE</code> revision in that family.</p> <note> <p>You can only describe <code>INACTIVE</code> task definitions while an active task or service references them.</p> </note>"
},
"DescribeTasks":{
"name":"DescribeTasks",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"DescribeTasksRequest"},
"output":{"shape":"DescribeTasksResponse"},
"errors":[
{"shape":"ServerException"},
{"shape":"ClientException"},
{"shape":"InvalidParameterException"},
{"shape":"ClusterNotFoundException"}
],
"documentation":"<p>Describes a specified task or tasks.</p>"
},
"DiscoverPollEndpoint":{
"name":"DiscoverPollEndpoint",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"DiscoverPollEndpointRequest"},
"output":{"shape":"DiscoverPollEndpointResponse"},
"errors":[
{"shape":"ServerException"},
{"shape":"ClientException"}
],
"documentation":"<note> <p>This action is only used by the Amazon EC2 Container Service agent, and it is not intended for use outside of the agent.</p> </note> <p>Returns an endpoint for the Amazon EC2 Container Service agent to poll for updates.</p>"
},
"ListClusters":{
"name":"ListClusters",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"ListClustersRequest"},
"output":{"shape":"ListClustersResponse"},
"errors":[
{"shape":"ServerException"},
{"shape":"ClientException"},
{"shape":"InvalidParameterException"}
],
"documentation":"<p>Returns a list of existing clusters.</p>"
},
"ListContainerInstances":{
"name":"ListContainerInstances",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"ListContainerInstancesRequest"},
"output":{"shape":"ListContainerInstancesResponse"},
"errors":[
{"shape":"ServerException"},
{"shape":"ClientException"},
{"shape":"InvalidParameterException"},
{"shape":"ClusterNotFoundException"}
],
"documentation":"<p>Returns a list of container instances in a specified cluster.</p>"
},
"ListServices":{
"name":"ListServices",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"ListServicesRequest"},
"output":{"shape":"ListServicesResponse"},
"errors":[
{"shape":"ServerException"},
{"shape":"ClientException"},
{"shape":"InvalidParameterException"},
{"shape":"ClusterNotFoundException"}
],
"documentation":"<p>Lists the services that are running in a specified cluster.</p>"
},
"ListTaskDefinitionFamilies":{
"name":"ListTaskDefinitionFamilies",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"ListTaskDefinitionFamiliesRequest"},
"output":{"shape":"ListTaskDefinitionFamiliesResponse"},
"errors":[
{"shape":"ServerException"},
{"shape":"ClientException"},
{"shape":"InvalidParameterException"}
],
"documentation":"<p>Returns a list of task definition families that are registered to your account (which may include task definition families that no longer have any <code>ACTIVE</code> task definition revisions).</p> <p>You can filter out task definition families that do not contain any <code>ACTIVE</code> task definition revisions by setting the <code>status</code> parameter to <code>ACTIVE</code>. You can also filter the results with the <code>familyPrefix</code> parameter.</p>"
},
"ListTaskDefinitions":{
"name":"ListTaskDefinitions",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"ListTaskDefinitionsRequest"},
"output":{"shape":"ListTaskDefinitionsResponse"},
"errors":[
{"shape":"ServerException"},
{"shape":"ClientException"},
{"shape":"InvalidParameterException"}
],
"documentation":"<p>Returns a list of task definitions that are registered to your account. You can filter the results by family name with the <code>familyPrefix</code> parameter or by status with the <code>status</code> parameter.</p>"
},
"ListTasks":{
"name":"ListTasks",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"ListTasksRequest"},
"output":{"shape":"ListTasksResponse"},
"errors":[
{"shape":"ServerException"},
{"shape":"ClientException"},
{"shape":"InvalidParameterException"},
{"shape":"ClusterNotFoundException"},
{"shape":"ServiceNotFoundException"}
],
"documentation":"<p>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 <code>family</code>, <code>containerInstance</code>, and <code>desiredStatus</code> parameters.</p> <p>Recently-stopped tasks might appear in the returned results. Currently, stopped tasks appear in the returned results for at least one hour. </p>"
},
"RegisterContainerInstance":{
"name":"RegisterContainerInstance",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"RegisterContainerInstanceRequest"},
"output":{"shape":"RegisterContainerInstanceResponse"},
"errors":[
{"shape":"ServerException"},
{"shape":"ClientException"}
],
"documentation":"<note> <p>This action is only used by the Amazon EC2 Container Service agent, and it is not intended for use outside of the agent.</p> </note> <p>Registers an EC2 instance into the specified cluster. This instance becomes available to place containers on.</p>"
},
"RegisterTaskDefinition":{
"name":"RegisterTaskDefinition",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"RegisterTaskDefinitionRequest"},
"output":{"shape":"RegisterTaskDefinitionResponse"},
"errors":[
{"shape":"ServerException"},
{"shape":"ClientException"},
{"shape":"InvalidParameterException"}
],
"documentation":"<p>Registers a new task definition from the supplied <code>family</code> and <code>containerDefinitions</code>. Optionally, you can add data volumes to your containers with the <code>volumes</code> parameter. For more information about task definition parameters and defaults, see <a href=\"http://docs.aws.amazon.com/AmazonECS/latest/developerguide/task_defintions.html\">Amazon ECS Task Definitions</a> in the <i>Amazon EC2 Container Service Developer Guide</i>.</p> <p>You can specify an IAM role for your task with the <code>taskRoleArn</code> 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 <a href=\"http://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-iam-roles.html\">IAM Roles for Tasks</a> in the <i>Amazon EC2 Container Service Developer Guide</i>.</p> <p>You can specify a Docker networking mode for the containers in your task definition with the <code>networkMode</code> parameter. The available network modes correspond to those described in <a href=\"https://docs.docker.com/engine/reference/run/#/network-settings\">Network settings</a> in the Docker run reference.</p>"
},
"RunTask":{
"name":"RunTask",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"RunTaskRequest"},
"output":{"shape":"RunTaskResponse"},
"errors":[
{"shape":"ServerException"},
{"shape":"ClientException"},
{"shape":"InvalidParameterException"},
{"shape":"ClusterNotFoundException"}
],
"documentation":"<p>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 <code>StartTask</code> instead.</p> <important> <p>The <code>count</code> parameter is limited to 10 tasks per call.</p> </important>"
},
"StartTask":{
"name":"StartTask",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"StartTaskRequest"},
"output":{"shape":"StartTaskResponse"},
"errors":[
{"shape":"ServerException"},
{"shape":"ClientException"},
{"shape":"InvalidParameterException"},
{"shape":"ClusterNotFoundException"}
],
"documentation":"<p>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 <code>RunTask</code> instead.</p> <important> <p>The list of container instances to start tasks on is limited to 10.</p> </important>"
},
"StopTask":{
"name":"StopTask",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"StopTaskRequest"},
"output":{"shape":"StopTaskResponse"},
"errors":[
{"shape":"ServerException"},
{"shape":"ClientException"},
{"shape":"InvalidParameterException"},
{"shape":"ClusterNotFoundException"}
],
"documentation":"<p>Stops a running task.</p> <p>When <a>StopTask</a> is called on a task, the equivalent of <code>docker stop</code> is issued to the containers running in the task. This results in a <code>SIGTERM</code> and a 30-second timeout, after which <code>SIGKILL</code> is sent and the containers are forcibly stopped. If the container handles the <code>SIGTERM</code> gracefully and exits within 30 seconds from receiving it, no <code>SIGKILL</code> is sent.</p>"
},
"SubmitContainerStateChange":{
"name":"SubmitContainerStateChange",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"SubmitContainerStateChangeRequest"},
"output":{"shape":"SubmitContainerStateChangeResponse"},
"errors":[
{"shape":"ServerException"},
{"shape":"ClientException"}
],
"documentation":"<note> <p>This action is only used by the Amazon EC2 Container Service agent, and it is not intended for use outside of the agent.</p> </note> <p>Sent to acknowledge that a container changed states.</p>"
},
"SubmitTaskStateChange":{
"name":"SubmitTaskStateChange",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"SubmitTaskStateChangeRequest"},
"output":{"shape":"SubmitTaskStateChangeResponse"},
"errors":[
{"shape":"ServerException"},
{"shape":"ClientException"}
],
"documentation":"<note> <p>This action is only used by the Amazon EC2 Container Service agent, and it is not intended for use outside of the agent.</p> </note> <p>Sent to acknowledge that a task changed states.</p>"
},
"UpdateContainerAgent":{
"name":"UpdateContainerAgent",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"UpdateContainerAgentRequest"},
"output":{"shape":"UpdateContainerAgentResponse"},
"errors":[
{"shape":"ServerException"},
{"shape":"ClientException"},
{"shape":"InvalidParameterException"},
{"shape":"ClusterNotFoundException"},
{"shape":"UpdateInProgressException"},
{"shape":"NoUpdateAvailableException"},
{"shape":"MissingVersionException"}
],
"documentation":"<p>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.</p> <p> <code>UpdateContainerAgent</code> requires the Amazon ECS-optimized AMI or Amazon Linux with the <code>ecs-init</code> service installed and running. For help updating the Amazon ECS container agent on other operating systems, see <a href=\"http://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-agent-update.html#manually_update_agent\">Manually Updating the Amazon ECS Container Agent</a> in the <i>Amazon EC2 Container Service Developer Guide</i>.</p>"
},
"UpdateService":{
"name":"UpdateService",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"UpdateServiceRequest"},
"output":{"shape":"UpdateServiceResponse"},
"errors":[
{"shape":"ServerException"},
{"shape":"ClientException"},
{"shape":"InvalidParameterException"},
{"shape":"ClusterNotFoundException"},
{"shape":"ServiceNotFoundException"},
{"shape":"ServiceNotActiveException"}
],
"documentation":"<p>Modifies the desired count, deployment configuration, or task definition used in a service.</p> <p>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 <code>desiredCount</code> parameter.</p> <p>You can use <a>UpdateService</a> to modify your task definition and deploy a new version of your service.</p> <p>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, <code>minimumHealthyPercent</code> and <code>maximumPercent</code>, to determine the deployment strategy.</p> <p>If the <code>minimumHealthyPercent</code> is below 100%, the scheduler can ignore the <code>desiredCount</code> temporarily during a deployment. For example, if your service has a <code>desiredCount</code> of four tasks, a <code>minimumHealthyPercent</code> of 50% allows the scheduler to stop two existing tasks before starting two new tasks. Tasks for services that <i>do not</i> use a load balancer are considered healthy if they are in the <code>RUNNING</code> state; tasks for services that <i>do</i> use a load balancer are considered healthy if they are in the <code>RUNNING</code> state and the container instance it is hosted on is reported as healthy by the load balancer.</p> <p>The <code>maximumPercent</code> 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 <code>desiredCount</code> of four tasks, a <code>maximumPercent</code> value of 200% starts four new tasks before stopping the four older tasks (provided that the cluster resources required to do this are available).</p> <p>When <a>UpdateService</a> stops a task during a deployment, the equivalent of <code>docker stop</code> is issued to the containers running in the task. This results in a <code>SIGTERM</code> and a 30-second timeout, after which <code>SIGKILL</code> is sent and the containers are forcibly stopped. If the container handles the <code>SIGTERM</code> gracefully and exits within 30 seconds from receiving it, no <code>SIGKILL</code> is sent.</p> <p>When the service scheduler launches new tasks, it attempts to balance them across the Availability Zones in your cluster with the following logic:</p> <ul> <li> <p>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).</p> </li> <li> <p>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.</p> </li> <li> <p>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.</p> </li> </ul>"
}
},
"shapes":{
"AgentUpdateStatus":{
"type":"string",
"enum":[
"PENDING",
"STAGING",
"STAGED",
"UPDATING",
"UPDATED",
"FAILED"
]
},
"Attribute":{
"type":"structure",
"required":["name"],
"members":{
"name":{
"shape":"String",
"documentation":"<p>The name of the container instance attribute.</p>"
},
"value":{
"shape":"String",
"documentation":"<p>The value of the container instance attribute (at this time, the value here is <code>Null</code>, but this could change in future revisions for expandability).</p>"
}
},
"documentation":"<p>The attributes applicable to a container instance when it is registered.</p>"
},
"Attributes":{
"type":"list",
"member":{"shape":"Attribute"}
},
"Boolean":{"type":"boolean"},
"BoxedBoolean":{
"type":"boolean",
"box":true
},
"BoxedInteger":{
"type":"integer",
"box":true
},
"ClientException":{
"type":"structure",
"members":{
"message":{"shape":"String"}
},
"documentation":"<p>These errors are usually caused by a client action, such as using an action or resource on behalf of a user that doesn't have permission to use the action or resource, or specifying an identifier that is not valid.</p>",
"exception":true
},
"Cluster":{
"type":"structure",
"members":{
"clusterArn":{
"shape":"String",
"documentation":"<p>The Amazon Resource Name (ARN) that identifies the cluster. The ARN contains the <code>arn:aws:ecs</code> namespace, followed by the region of the cluster, the AWS account ID of the cluster owner, the <code>cluster</code> namespace, and then the cluster name. For example, <code>arn:aws:ecs:<i>region</i>:<i>012345678910</i>:cluster/<i>test</i> </code>..</p>"
},
"clusterName":{
"shape":"String",
"documentation":"<p>A user-generated string that you use to identify your cluster.</p>"
},
"status":{
"shape":"String",
"documentation":"<p>The status of the cluster. The valid values are <code>ACTIVE</code> or <code>INACTIVE</code>. <code>ACTIVE</code> indicates that you can register container instances with the cluster and the associated instances can accept tasks.</p>"
},
"registeredContainerInstancesCount":{
"shape":"Integer",
"documentation":"<p>The number of container instances registered into the cluster.</p>"
},
"runningTasksCount":{
"shape":"Integer",
"documentation":"<p>The number of tasks in the cluster that are in the <code>RUNNING</code> state.</p>"
},
"pendingTasksCount":{
"shape":"Integer",
"documentation":"<p>The number of tasks in the cluster that are in the <code>PENDING</code> state.</p>"
},
"activeServicesCount":{
"shape":"Integer",
"documentation":"<p>The number of services that are running on the cluster in an <code>ACTIVE</code> state. You can view these services with <a>ListServices</a>.</p>"
}
},
"documentation":"<p>A regional grouping of one or more container instances on which you can run task requests. Each account receives a default cluster the first time you use the Amazon ECS service, but you may also create other clusters. Clusters may contain more than one instance type simultaneously.</p>"
},
"ClusterContainsContainerInstancesException":{
"type":"structure",
"members":{
},
"documentation":"<p>You cannot delete a cluster that has registered container instances. You must first deregister the container instances before you can delete the cluster. For more information, see <a>DeregisterContainerInstance</a>.</p>",
"exception":true
},
"ClusterContainsServicesException":{
"type":"structure",
"members":{
},
"documentation":"<p>You cannot delete a cluster that contains services. You must first update the service to reduce its desired task count to 0 and then delete the service. For more information, see <a>UpdateService</a> and <a>DeleteService</a>.</p>",
"exception":true
},
"ClusterNotFoundException":{
"type":"structure",
"members":{
},
"documentation":"<p>The specified cluster could not be found. You can view your available clusters with <a>ListClusters</a>. Amazon ECS clusters are region-specific.</p>",
"exception":true
},
"Clusters":{
"type":"list",
"member":{"shape":"Cluster"}
},
"Container":{
"type":"structure",
"members":{
"containerArn":{
"shape":"String",
"documentation":"<p>The Amazon Resource Name (ARN) of the container.</p>"
},
"taskArn":{
"shape":"String",
"documentation":"<p>The Amazon Resource Name (ARN) of the task.</p>"
},
"name":{
"shape":"String",
"documentation":"<p>The name of the container.</p>"
},
"lastStatus":{
"shape":"String",
"documentation":"<p>The last known status of the container.</p>"
},
"exitCode":{
"shape":"BoxedInteger",
"documentation":"<p>The exit code returned from the container.</p>"
},
"reason":{
"shape":"String",
"documentation":"<p>A short (255 max characters) human-readable string to provide additional detail about a running or stopped container.</p>"
},
"networkBindings":{
"shape":"NetworkBindings",
"documentation":"<p>The network bindings associated with the container.</p>"
}
},
"documentation":"<p>A Docker container that is part of a task.</p>"
},
"ContainerDefinition":{
"type":"structure",
"members":{
"name":{
"shape":"String",
"documentation":"<p>The name of a container. If you are linking multiple containers together in a task definition, the <code>name</code> of one container can be entered in the <code>links</code> of another container to connect the containers. Up to 255 letters (uppercase and lowercase), numbers, hyphens, and underscores are allowed. This parameter maps to <code>name</code> in the <a href=\"https://docs.docker.com/engine/reference/api/docker_remote_api_v1.23/#create-a-container\">Create a container</a> section of the <a href=\"https://docs.docker.com/engine/reference/api/docker_remote_api_v1.23/\">Docker Remote API</a> and the <code>--name</code> option to <a href=\"https://docs.docker.com/engine/reference/run/\">docker run</a>. </p>"
},
"image":{
"shape":"String",
"documentation":"<p>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 <code> <i>repository-url</i>/<i>image</i>:<i>tag</i> </code>. Up to 255 letters (uppercase and lowercase), numbers, hyphens, underscores, colons, periods, forward slashes, and number signs are allowed. This parameter maps to <code>Image</code> in the <a href=\"https://docs.docker.com/engine/reference/api/docker_remote_api_v1.23/#create-a-container\">Create a container</a> section of the <a href=\"https://docs.docker.com/engine/reference/api/docker_remote_api_v1.23/\">Docker Remote API</a> and the <code>IMAGE</code> parameter of <a href=\"https://docs.docker.com/engine/reference/run/\">docker run</a>.</p> <ul> <li> <p>Images in official repositories on Docker Hub use a single name (for example, <code>ubuntu</code> or <code>mongo</code>).</p> </li> <li> <p>Images in other repositories on Docker Hub are qualified with an organization name (for example, <code>amazon/amazon-ecs-agent</code>).</p> </li> <li> <p>Images in other online repositories are qualified further by a domain name (for example, <code>quay.io/assemblyline/ubuntu</code>).</p> </li> </ul>"
},
"cpu":{
"shape":"Integer",
"documentation":"<p>The number of <code>cpu</code> units reserved for the container. A container instance has 1,024 <code>cpu</code> 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 <code>CpuShares</code> in the <a href=\"https://docs.docker.com/engine/reference/api/docker_remote_api_v1.23/#create-a-container\">Create a container</a> section of the <a href=\"https://docs.docker.com/engine/reference/api/docker_remote_api_v1.23/\">Docker Remote API</a> and the <code>--cpu-shares</code> option to <a href=\"https://docs.docker.com/engine/reference/run/\">docker run</a>.</p> <note> <p>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 <a href=\"http://aws.amazon.com/ec2/instance-types/\">Amazon EC2 Instances</a> detail page by 1,024.</p> </note> <p>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.</p> <p>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 <a href=\"https://docs.docker.com/engine/reference/run/#cpu-share-constraint\">CPU share constraint</a> 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:</p> <ul> <li> <p> <b>Agent versions less than or equal to 1.1.0:</b> 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.</p> </li> <li> <p> <b>Agent versions greater than or equal to 1.2.0:</b> Null, zero, and CPU values of 1 are passed to Docker as 2.</p> </li> </ul>"
},
"memory":{
"shape":"BoxedInteger",
"documentation":"<p>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 <code>Memory</code> in the <a href=\"https://docs.docker.com/engine/reference/api/docker_remote_api_v1.23/#create-a-container\">Create a container</a> section of the <a href=\"https://docs.docker.com/engine/reference/api/docker_remote_api_v1.23/\">Docker Remote API</a> and the <code>--memory</code> option to <a href=\"https://docs.docker.com/engine/reference/run/\">docker run</a>.</p> <p>You must specify a non-zero integer for one or both of <code>memory</code> or <code>memoryReservation</code> in container definitions. If you specify both, <code>memory</code> must be greater than <code>memoryReservation</code>. If you specify <code>memoryReservation</code>, then that value is subtracted from the available memory resources for the container instance on which the container is placed; otherwise, the value of <code>memory</code> is used.</p> <p>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. </p>"
},
"memoryReservation":{
"shape":"BoxedInteger",
"documentation":"<p>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 <code>memory</code> parameter (if applicable), or all of the available memory on the container instance, whichever comes first. This parameter maps to <code>MemoryReservation</code> in the <a href=\"https://docs.docker.com/engine/reference/api/docker_remote_api_v1.23/#create-a-container\">Create a container</a> section of the <a href=\"https://docs.docker.com/engine/reference/api/docker_remote_api_v1.23/\">Docker Remote API</a> and the <code>--memory-reservation</code> option to <a href=\"https://docs.docker.com/engine/reference/run/\">docker run</a>.</p> <p>You must specify a non-zero integer for one or both of <code>memory</code> or <code>memoryReservation</code> in container definitions. If you specify both, <code>memory</code> must be greater than <code>memoryReservation</code>. If you specify <code>memoryReservation</code>, then that value is subtracted from the available memory resources for the container instance on which the container is placed; otherwise, the value of <code>memory</code> is used.</p> <p>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 <code>memoryReservation</code> of 128 MiB, and a <code>memory</code> 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.</p>"
},
"links":{
"shape":"StringList",
"documentation":"<p>The <code>link</code> parameter allows containers to communicate with each other without the need for port mappings, using the <code>name</code> parameter and optionally, an <code>alias</code> for the link. This construct is analogous to <code>name:alias</code> in Docker links. Up to 255 letters (uppercase and lowercase), numbers, hyphens, and underscores are allowed for each <code>name</code> and <code>alias</code>. For more information on linking Docker containers, see <a href=\"https://docs.docker.com/engine/userguide/networking/default_network/dockerlinks/\">https://docs.docker.com/engine/userguide/networking/default_network/dockerlinks/</a>. This parameter maps to <code>Links</code> in the <a href=\"https://docs.docker.com/engine/reference/api/docker_remote_api_v1.23/#create-a-container\">Create a container</a> section of the <a href=\"https://docs.docker.com/engine/reference/api/docker_remote_api_v1.23/\">Docker Remote API</a> and the <code>--link</code> option to <a href=\"https://docs.docker.com/engine/reference/run/\">docker run</a>.</p> <important> <p>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.</p> </important>"
},
"portMappings":{
"shape":"PortMappingList",
"documentation":"<p>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 <code>PortBindings</code> in the <a href=\"https://docs.docker.com/engine/reference/api/docker_remote_api_v1.23/#create-a-container\">Create a container</a> section of the <a href=\"https://docs.docker.com/engine/reference/api/docker_remote_api_v1.23/\">Docker Remote API</a> and the <code>--publish</code> option to <a href=\"https://docs.docker.com/engine/reference/run/\">docker run</a>. If the network mode of a task definition is set to <code>none</code>, then you cannot specify port mappings. If the network mode of a task definition is set to <code>host</code>, then host ports must either be undefined or they must match the container port in the port mapping.</p> <note> <p>After a task reaches the <code>RUNNING</code> status, manual and automatic host and container port assignments are visible in the <b>Network Bindings</b> section of a container description of a selected task in the Amazon ECS console, or the <code>networkBindings</code> section <a>DescribeTasks</a> responses.</p> </note>"
},
"essential":{
"shape":"BoxedBoolean",
"documentation":"<p>If the <code>essential</code> parameter of a container is marked as <code>true</code>, and that container fails or stops for any reason, all other containers that are part of the task are stopped. If the <code>essential</code> parameter of a container is marked as <code>false</code>, 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.</p> <p>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 <a href=\"http://docs.aws.amazon.com/AmazonECS/latest/developerguide/application_architecture.html\">Application Architecture</a> in the <i>Amazon EC2 Container Service Developer Guide</i>.</p>"
},
"entryPoint":{
"shape":"StringList",
"documentation":"<important> <p>Early versions of the Amazon ECS container agent do not properly handle <code>entryPoint</code> parameters. If you have problems using <code>entryPoint</code>, update your container agent or enter your commands and arguments as <code>command</code> array items instead.</p> </important> <p>The entry point that is passed to the container. This parameter maps to <code>Entrypoint</code> in the <a href=\"https://docs.docker.com/engine/reference/api/docker_remote_api_v1.23/#create-a-container\">Create a container</a> section of the <a href=\"https://docs.docker.com/engine/reference/api/docker_remote_api_v1.23/\">Docker Remote API</a> and the <code>--entrypoint</code> option to <a href=\"https://docs.docker.com/engine/reference/run/\">docker run</a>. For more information, see <a href=\"https://docs.docker.com/engine/reference/builder/#entrypoint\">https://docs.docker.com/engine/reference/builder/#entrypoint</a>.</p>"
},
"command":{
"shape":"StringList",
"documentation":"<p>The command that is passed to the container. This parameter maps to <code>Cmd</code> in the <a href=\"https://docs.docker.com/engine/reference/api/docker_remote_api_v1.23/#create-a-container\">Create a container</a> section of the <a href=\"https://docs.docker.com/engine/reference/api/docker_remote_api_v1.23/\">Docker Remote API</a> and the <code>COMMAND</code> parameter to <a href=\"https://docs.docker.com/engine/reference/run/\">docker run</a>. For more information, see <a href=\"https://docs.docker.com/engine/reference/builder/#cmd\">https://docs.docker.com/engine/reference/builder/#cmd</a>.</p>"
},
"environment":{
"shape":"EnvironmentVariables",
"documentation":"<p>The environment variables to pass to a container. This parameter maps to <code>Env</code> in the <a href=\"https://docs.docker.com/engine/reference/api/docker_remote_api_v1.23/#create-a-container\">Create a container</a> section of the <a href=\"https://docs.docker.com/engine/reference/api/docker_remote_api_v1.23/\">Docker Remote API</a> and the <code>--env</code> option to <a href=\"https://docs.docker.com/engine/reference/run/\">docker run</a>.</p> <important> <p>We do not recommend using plain text environment variables for sensitive information, such as credential data.</p> </important>"
},
"mountPoints":{
"shape":"MountPointList",
"documentation":"<p>The mount points for data volumes in your container. This parameter maps to <code>Volumes</code> in the <a href=\"https://docs.docker.com/engine/reference/api/docker_remote_api_v1.23/#create-a-container\">Create a container</a> section of the <a href=\"https://docs.docker.com/engine/reference/api/docker_remote_api_v1.23/\">Docker Remote API</a> and the <code>--volume</code> option to <a href=\"https://docs.docker.com/engine/reference/run/\">docker run</a>.</p>"
},
"volumesFrom":{
"shape":"VolumeFromList",
"documentation":"<p>Data volumes to mount from another container. This parameter maps to <code>VolumesFrom</code> in the <a href=\"https://docs.docker.com/engine/reference/api/docker_remote_api_v1.23/#create-a-container\">Create a container</a> section of the <a href=\"https://docs.docker.com/engine/reference/api/docker_remote_api_v1.23/\">Docker Remote API</a> and the <code>--volumes-from</code> option to <a href=\"https://docs.docker.com/engine/reference/run/\">docker run</a>.</p>"
},
"hostname":{
"shape":"String",
"documentation":"<p>The hostname to use for your container. This parameter maps to <code>Hostname</code> in the <a href=\"https://docs.docker.com/engine/reference/api/docker_remote_api_v1.23/#create-a-container\">Create a container</a> section of the <a href=\"https://docs.docker.com/engine/reference/api/docker_remote_api_v1.23/\">Docker Remote API</a> and the <code>--hostname</code> option to <a href=\"https://docs.docker.com/engine/reference/run/\">docker run</a>.</p>"
},
"user":{
"shape":"String",
"documentation":"<p>The user name to use inside the container. This parameter maps to <code>User</code> in the <a href=\"https://docs.docker.com/engine/reference/api/docker_remote_api_v1.23/#create-a-container\">Create a container</a> section of the <a href=\"https://docs.docker.com/engine/reference/api/docker_remote_api_v1.23/\">Docker Remote API</a> and the <code>--user</code> option to <a href=\"https://docs.docker.com/engine/reference/run/\">docker run</a>.</p>"
},
"workingDirectory":{
"shape":"String",
"documentation":"<p>The working directory in which to run commands inside the container. This parameter maps to <code>WorkingDir</code> in the <a href=\"https://docs.docker.com/engine/reference/api/docker_remote_api_v1.23/#create-a-container\">Create a container</a> section of the <a href=\"https://docs.docker.com/engine/reference/api/docker_remote_api_v1.23/\">Docker Remote API</a> and the <code>--workdir</code> option to <a href=\"https://docs.docker.com/engine/reference/run/\">docker run</a>.</p>"
},
"disableNetworking":{
"shape":"BoxedBoolean",
"documentation":"<p>When this parameter is true, networking is disabled within the container. This parameter maps to <code>NetworkDisabled</code> in the <a href=\"https://docs.docker.com/engine/reference/api/docker_remote_api_v1.23/#create-a-container\">Create a container</a> section of the <a href=\"https://docs.docker.com/engine/reference/api/docker_remote_api_v1.23/\">Docker Remote API</a>.</p>"
},
"privileged":{
"shape":"BoxedBoolean",
"documentation":"<p>When this parameter is true, the container is given elevated privileges on the host container instance (similar to the <code>root</code> user). This parameter maps to <code>Privileged</code> in the <a href=\"https://docs.docker.com/engine/reference/api/docker_remote_api_v1.23/#create-a-container\">Create a container</a> section of the <a href=\"https://docs.docker.com/engine/reference/api/docker_remote_api_v1.23/\">Docker Remote API</a> and the <code>--privileged</code> option to <a href=\"https://docs.docker.com/engine/reference/run/\">docker run</a>.</p>"
},
"readonlyRootFilesystem":{
"shape":"BoxedBoolean",
"documentation":"<p>When this parameter is true, the container is given read-only access to its root file system. This parameter maps to <code>ReadonlyRootfs</code> in the <a href=\"https://docs.docker.com/engine/reference/api/docker_remote_api_v1.23/#create-a-container\">Create a container</a> section of the <a href=\"https://docs.docker.com/engine/reference/api/docker_remote_api_v1.23/\">Docker Remote API</a> and the <code>--read-only</code> option to <code>docker run</code>.</p>"
},
"dnsServers":{
"shape":"StringList",
"documentation":"<p>A list of DNS servers that are presented to the container. This parameter maps to <code>Dns</code> in the <a href=\"https://docs.docker.com/engine/reference/api/docker_remote_api_v1.23/#create-a-container\">Create a container</a> section of the <a href=\"https://docs.docker.com/engine/reference/api/docker_remote_api_v1.23/\">Docker Remote API</a> and the <code>--dns</code> option to <a href=\"https://docs.docker.com/engine/reference/run/\">docker run</a>.</p>"
},
"dnsSearchDomains":{
"shape":"StringList",
"documentation":"<p>A list of DNS search domains that are presented to the container. This parameter maps to <code>DnsSearch</code> in the <a href=\"https://docs.docker.com/engine/reference/api/docker_remote_api_v1.23/#create-a-container\">Create a container</a> section of the <a href=\"https://docs.docker.com/engine/reference/api/docker_remote_api_v1.23/\">Docker Remote API</a> and the <code>--dns-search</code> option to <a href=\"https://docs.docker.com/engine/reference/run/\">docker run</a>.</p>"
},
"extraHosts":{
"shape":"HostEntryList",
"documentation":"<p>A list of hostnames and IP address mappings to append to the <code>/etc/hosts</code> file on the container. This parameter maps to <code>ExtraHosts</code> in the <a href=\"https://docs.docker.com/engine/reference/api/docker_remote_api_v1.23/#create-a-container\">Create a container</a> section of the <a href=\"https://docs.docker.com/engine/reference/api/docker_remote_api_v1.23/\">Docker Remote API</a> and the <code>--add-host</code> option to <a href=\"https://docs.docker.com/engine/reference/run/\">docker run</a>.</p>"
},
"dockerSecurityOptions":{
"shape":"StringList",
"documentation":"<p>A list of strings to provide custom labels for SELinux and AppArmor multi-level security systems. This parameter maps to <code>SecurityOpt</code> in the <a href=\"https://docs.docker.com/engine/reference/api/docker_remote_api_v1.23/#create-a-container\">Create a container</a> section of the <a href=\"https://docs.docker.com/engine/reference/api/docker_remote_api_v1.23/\">Docker Remote API</a> and the <code>--security-opt</code> option to <a href=\"https://docs.docker.com/engine/reference/run/\">docker run</a>.</p> <note> <p>The Amazon ECS container agent running on a container instance must register with the <code>ECS_SELINUX_CAPABLE=true</code> or <code>ECS_APPARMOR_CAPABLE=true</code> environment variables before containers placed on that instance can use these security options. For more information, see <a href=\"http://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-agent-config.html\">Amazon ECS Container Agent Configuration</a> in the <i>Amazon EC2 Container Service Developer Guide</i>.</p> </note>"
},
"dockerLabels":{
"shape":"DockerLabelsMap",
"documentation":"<p>A key/value map of labels to add to the container. This parameter maps to <code>Labels</code> in the <a href=\"https://docs.docker.com/engine/reference/api/docker_remote_api_v1.23/#create-a-container\">Create a container</a> section of the <a href=\"https://docs.docker.com/engine/reference/api/docker_remote_api_v1.23/\">Docker Remote API</a> and the <code>--label</code> option to <a href=\"https://docs.docker.com/engine/reference/run/\">docker run</a>. 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: <code>sudo docker version | grep \"Server API version\"</code> </p>"
},
"ulimits":{
"shape":"UlimitList",
"documentation":"<p>A list of <code>ulimits</code> to set in the container. This parameter maps to <code>Ulimits</code> in the <a href=\"https://docs.docker.com/engine/reference/api/docker_remote_api_v1.23/#create-a-container\">Create a container</a> section of the <a href=\"https://docs.docker.com/engine/reference/api/docker_remote_api_v1.23/\">Docker Remote API</a> and the <code>--ulimit</code> option to <a href=\"https://docs.docker.com/engine/reference/run/\">docker run</a>. Valid naming values are displayed in the <a>Ulimit</a> 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: <code>sudo docker version | grep \"Server API version\"</code> </p>"
},
"logConfiguration":{
"shape":"LogConfiguration",
"documentation":"<p>The log configuration specification for the container. This parameter maps to <code>LogConfig</code> in the <a href=\"https://docs.docker.com/engine/reference/api/docker_remote_api_v1.23/#create-a-container\">Create a container</a> section of the <a href=\"https://docs.docker.com/engine/reference/api/docker_remote_api_v1.23/\">Docker Remote API</a> and the <code>--log-driver</code> option to <a href=\"https://docs.docker.com/engine/reference/run/\">docker run</a>. 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 <a href=\"https://docs.docker.com/engine/admin/logging/overview/\">Configure logging drivers</a> in the Docker documentation.</p> <note> <p>Amazon ECS currently supports a subset of the logging drivers available to the Docker daemon (shown in the <a>LogConfiguration</a> data type). Currently unsupported log drivers may be available in future releases of the Amazon ECS container agent.</p> </note> <p>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: <code>sudo docker version | grep \"Server API version\"</code> </p> <note> <p>The Amazon ECS container agent running on a container instance must register the logging drivers available on that instance with the <code>ECS_AVAILABLE_LOGGING_DRIVERS</code> environment variable before containers placed on that instance can use these log configuration options. For more information, see <a href=\"http://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-agent-config.html\">Amazon ECS Container Agent Configuration</a> in the <i>Amazon EC2 Container Service Developer Guide</i>.</p> </note>"
}
},
"documentation":"<p>Container definitions are used in task definitions to describe the different containers that are launched as part of a task.</p>"
},
"ContainerDefinitions":{
"type":"list",
"member":{"shape":"ContainerDefinition"}
},
"ContainerInstance":{
"type":"structure",
"members":{
"containerInstanceArn":{
"shape":"String",
"documentation":"<p>The Amazon Resource Name (ARN) of the container instance. The ARN contains the <code>arn:aws:ecs</code> namespace, followed by the region of the container instance, the AWS account ID of the container instance owner, the <code>container-instance</code> namespace, and then the container instance ID. For example, <code>arn:aws:ecs:<i>region</i>:<i>aws_account_id</i>:container-instance/<i>container_instance_ID</i> </code>.</p>"
},
"ec2InstanceId":{
"shape":"String",
"documentation":"<p>The EC2 instance ID of the container instance.</p>"
},
"versionInfo":{
"shape":"VersionInfo",
"documentation":"<p>The version information for the Amazon ECS container agent and Docker daemon running on the container instance.</p>"
},
"remainingResources":{
"shape":"Resources",
"documentation":"<p>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.</p>"
},
"registeredResources":{
"shape":"Resources",
"documentation":"<p>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.</p>"
},
"status":{
"shape":"String",
"documentation":"<p>The status of the container instance. The valid values are <code>ACTIVE</code> or <code>INACTIVE</code>. <code>ACTIVE</code> indicates that the container instance can accept tasks.</p>"
},
"agentConnected":{
"shape":"Boolean",
"documentation":"<p>This parameter returns <code>true</code> if the agent is actually connected to Amazon ECS. Registered instances with an agent that may be unhealthy or stopped return <code>false</code>, and instances without a connected agent cannot accept placement requests.</p>"
},
"runningTasksCount":{
"shape":"Integer",
"documentation":"<p>The number of tasks on the container instance that are in the <code>RUNNING</code> status.</p>"
},
"pendingTasksCount":{
"shape":"Integer",
"documentation":"<p>The number of tasks on the container instance that are in the <code>PENDING</code> status.</p>"
},
"agentUpdateStatus":{
"shape":"AgentUpdateStatus",
"documentation":"<p>The status of the most recent agent update. If an update has never been requested, this value is <code>NULL</code>.</p>"
},
"attributes":{
"shape":"Attributes",
"documentation":"<p>The attributes set for the container instance by the Amazon ECS container agent at instance registration.</p>"
}
},
"documentation":"<p>An EC2 instance that is running the Amazon ECS agent and has been registered with a cluster.</p>"
},
"ContainerInstances":{
"type":"list",
"member":{"shape":"ContainerInstance"}
},
"ContainerOverride":{
"type":"structure",
"members":{
"name":{
"shape":"String",
"documentation":"<p>The name of the container that receives the override.</p>"
},
"command":{
"shape":"StringList",
"documentation":"<p>The command to send to the container that overrides the default command from the Docker image or the task definition.</p>"
},
"environment":{
"shape":"EnvironmentVariables",
"documentation":"<p>The environment variables to send to the container. You can add new environment variables, which are added to the container at launch, or you can override the existing environment variables from the Docker image or the task definition.</p>"
}
},
"documentation":"<p>The overrides that should be sent to a container.</p>"
},
"ContainerOverrides":{
"type":"list",
"member":{"shape":"ContainerOverride"}
},
"Containers":{
"type":"list",
"member":{"shape":"Container"}
},
"CreateClusterRequest":{
"type":"structure",
"members":{
"clusterName":{
"shape":"String",
"documentation":"<p>The name of your cluster. If you do not specify a name for your cluster, you create a cluster named <code>default</code>. Up to 255 letters (uppercase and lowercase), numbers, hyphens, and underscores are allowed.</p>"
}
}
},
"CreateClusterResponse":{
"type":"structure",
"members":{
"cluster":{
"shape":"Cluster",
"documentation":"<p>The full description of your new cluster.</p>"
}
}
},
"CreateServiceRequest":{
"type":"structure",
"required":[
"serviceName",
"taskDefinition",
"desiredCount"
],
"members":{
"cluster":{
"shape":"String",
"documentation":"<p>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.</p>"
},
"serviceName":{
"shape":"String",
"documentation":"<p>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.</p>"
},
"taskDefinition":{
"shape":"String",
"documentation":"<p>The <code>family</code> and <code>revision</code> (<code>family:revision</code>) or full Amazon Resource Name (ARN) of the task definition to run in your service. If a <code>revision</code> is not specified, the latest <code>ACTIVE</code> revision is used.</p>"
},
"loadBalancers":{
"shape":"LoadBalancers",
"documentation":"<p>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.</p> <p>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.</p> <p>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.</p>"
},
"desiredCount":{
"shape":"BoxedInteger",
"documentation":"<p>The number of instantiations of the specified task definition to place and keep running on your cluster.</p>"
},
"clientToken":{
"shape":"String",
"documentation":"<p>Unique, case-sensitive identifier you provide to ensure the idempotency of the request. Up to 32 ASCII characters are allowed.</p>"
},
"role":{
"shape":"String",
"documentation":"<p>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 <code>role</code> parameter, you must also specify a load balancer object with the <code>loadBalancers</code> parameter.</p> <p>If your specified role has a path other than <code>/</code>, 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 <code>bar</code> has a path of <code>/foo/</code> then you would specify <code>/foo/bar</code> as the role name. For more information, see <a href=\"http://docs.aws.amazon.com/IAM/latest/UserGuide/reference_identifiers.html#identifiers-friendly-names\">Friendly Names and Paths</a> in the <i>IAM User Guide</i>.</p>"
},
"deploymentConfiguration":{
"shape":"DeploymentConfiguration",
"documentation":"<p>Optional deployment parameters that control how many tasks run during the deployment and the ordering of stopping and starting tasks.</p>"
}
}
},
"CreateServiceResponse":{
"type":"structure",
"members":{
"service":{
"shape":"Service",
"documentation":"<p>The full description of your service following the create call.</p>"
}
}
},
"DeleteClusterRequest":{
"type":"structure",
"required":["cluster"],
"members":{
"cluster":{
"shape":"String",
"documentation":"<p>The short name or full Amazon Resource Name (ARN) of the cluster to delete.</p>"
}
}
},
"DeleteClusterResponse":{
"type":"structure",
"members":{
"cluster":{
"shape":"Cluster",
"documentation":"<p>The full description of the deleted cluster.</p>"
}
}
},
"DeleteServiceRequest":{
"type":"structure",
"required":["service"],
"members":{
"cluster":{
"shape":"String",
"documentation":"<p>The name of the cluster that hosts the service to delete. If you do not specify a cluster, the default cluster is assumed.</p>"
},
"service":{
"shape":"String",
"documentation":"<p>The name of the service to delete.</p>"
}
}
},
"DeleteServiceResponse":{
"type":"structure",
"members":{
"service":{
"shape":"Service",
"documentation":"<p>The full description of the deleted service.</p>"
}
}
},
"Deployment":{
"type":"structure",
"members":{
"id":{
"shape":"String",
"documentation":"<p>The ID of the deployment.</p>"
},
"status":{
"shape":"String",
"documentation":"<p>The status of the deployment. Valid values are <code>PRIMARY</code> (for the most recent deployment), <code>ACTIVE</code> (for previous deployments that still have tasks running, but are being replaced with the <code>PRIMARY</code> deployment), and <code>INACTIVE</code> (for deployments that have been completely replaced).</p>"
},
"taskDefinition":{
"shape":"String",
"documentation":"<p>The most recent task definition that was specified for the service to use.</p>"
},
"desiredCount":{
"shape":"Integer",
"documentation":"<p>The most recent desired count of tasks that was specified for the service to deploy or maintain.</p>"
},
"pendingCount":{
"shape":"Integer",
"documentation":"<p>The number of tasks in the deployment that are in the <code>PENDING</code> status.</p>"
},
"runningCount":{
"shape":"Integer",
"documentation":"<p>The number of tasks in the deployment that are in the <code>RUNNING</code> status.</p>"
},
"createdAt":{
"shape":"Timestamp",
"documentation":"<p>The Unix timestamp for when the service was created.</p>"
},
"updatedAt":{
"shape":"Timestamp",
"documentation":"<p>The Unix timestamp for when the service was last updated.</p>"
}
},
"documentation":"<p>The details of an Amazon ECS service deployment.</p>"
},
"DeploymentConfiguration":{
"type":"structure",
"members":{
"maximumPercent":{
"shape":"BoxedInteger",
"documentation":"<p>The upper limit (as a percentage of the service's <code>desiredCount</code>) of the number of tasks that are allowed in the <code>RUNNING</code> or <code>PENDING</code> state in a service during a deployment. The maximum number of tasks during a deployment is the <code>desiredCount</code> multiplied by the <code>maximumPercent</code>/100, rounded down to the nearest integer value.</p>"
},
"minimumHealthyPercent":{
"shape":"BoxedInteger",
"documentation":"<p>The lower limit (as a percentage of the service's <code>desiredCount</code>) of the number of running tasks that must remain in the <code>RUNNING</code> state in a service during a deployment. The minimum healthy tasks during a deployment is the <code>desiredCount</code> multiplied by the <code>minimumHealthyPercent</code>/100, rounded up to the nearest integer value.</p>"
}
},
"documentation":"<p>Optional deployment parameters that control how many tasks run during the deployment and the ordering of stopping and starting tasks.</p>"
},
"Deployments":{
"type":"list",
"member":{"shape":"Deployment"}
},
"DeregisterContainerInstanceRequest":{
"type":"structure",
"required":["containerInstance"],
"members":{
"cluster":{
"shape":"String",
"documentation":"<p>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.</p>"
},
"containerInstance":{
"shape":"String",
"documentation":"<p>The container instance ID or full Amazon Resource Name (ARN) of the container instance to deregister. The ARN contains the <code>arn:aws:ecs</code> namespace, followed by the region of the container instance, the AWS account ID of the container instance owner, the <code>container-instance</code> namespace, and then the container instance ID. For example, <code>arn:aws:ecs:<i>region</i>:<i>aws_account_id</i>:container-instance/<i>container_instance_ID</i> </code>.</p>"
},
"force":{
"shape":"BoxedBoolean",
"documentation":"<p>Forces the deregistration of the container instance. If you have tasks running on the container instance when you deregister it with the <code>force</code> 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. </p> <p>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.</p>"
}
}
},
"DeregisterContainerInstanceResponse":{
"type":"structure",
"members":{
"containerInstance":{"shape":"ContainerInstance"}
}
},
"DeregisterTaskDefinitionRequest":{
"type":"structure",
"required":["taskDefinition"],
"members":{
"taskDefinition":{
"shape":"String",
"documentation":"<p>The <code>family</code> and <code>revision</code> (<code>family:revision</code>) or full Amazon Resource Name (ARN) of the task definition to deregister. You must specify a <code>revision</code>.</p>"
}
}
},
"DeregisterTaskDefinitionResponse":{
"type":"structure",
"members":{
"taskDefinition":{
"shape":"TaskDefinition",
"documentation":"<p>The full description of the deregistered task.</p>"
}
}
},
"DescribeClustersRequest":{
"type":"structure",
"members":{
"clusters":{
"shape":"StringList",
"documentation":"<p>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.</p>"
}
}
},
"DescribeClustersResponse":{
"type":"structure",
"members":{
"clusters":{
"shape":"Clusters",
"documentation":"<p>The list of clusters.</p>"
},
"failures":{
"shape":"Failures",
"documentation":"<p>Any failures associated with the call.</p>"
}
}
},
"DescribeContainerInstancesRequest":{
"type":"structure",
"required":["containerInstances"],
"members":{
"cluster":{
"shape":"String",
"documentation":"<p>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.</p>"
},
"containerInstances":{
"shape":"StringList",
"documentation":"<p>A space-separated list of container instance IDs or full Amazon Resource Name (ARN) entries.</p>"
}
}
},
"DescribeContainerInstancesResponse":{
"type":"structure",
"members":{
"containerInstances":{
"shape":"ContainerInstances",
"documentation":"<p>The list of container instances.</p>"
},
"failures":{
"shape":"Failures",
"documentation":"<p>Any failures associated with the call.</p>"
}
}
},
"DescribeServicesRequest":{
"type":"structure",
"required":["services"],
"members":{
"cluster":{
"shape":"String",
"documentation":"<p>The name of the cluster that hosts the service to describe. If you do not specify a cluster, the default cluster is assumed.</p>"
},
"services":{
"shape":"StringList",
"documentation":"<p>A list of services to describe. You may specify up to 10 services to describe in a single operation.</p>"
}
}
},
"DescribeServicesResponse":{
"type":"structure",
"members":{
"services":{
"shape":"Services",
"documentation":"<p>The list of services described.</p>"
},
"failures":{
"shape":"Failures",
"documentation":"<p>Any failures associated with the call.</p>"
}
}
},
"DescribeTaskDefinitionRequest":{
"type":"structure",
"required":["taskDefinition"],
"members":{
"taskDefinition":{
"shape":"String",
"documentation":"<p>The <code>family</code> for the latest <code>ACTIVE</code> revision, <code>family</code> and <code>revision</code> (<code>family:revision</code>) for a specific revision in the family, or full Amazon Resource Name (ARN) of the task definition to describe.</p>"
}
}
},
"DescribeTaskDefinitionResponse":{
"type":"structure",
"members":{
"taskDefinition":{
"shape":"TaskDefinition",
"documentation":"<p>The full task definition description.</p>"
}
}
},
"DescribeTasksRequest":{
"type":"structure",
"required":["tasks"],
"members":{
"cluster":{
"shape":"String",
"documentation":"<p>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.</p>"
},
"tasks":{
"shape":"StringList",
"documentation":"<p>A space-separated list of task IDs or full Amazon Resource Name (ARN) entries.</p>"
}
}
},
"DescribeTasksResponse":{
"type":"structure",
"members":{
"tasks":{
"shape":"Tasks",
"documentation":"<p>The list of tasks.</p>"
},
"failures":{
"shape":"Failures",
"documentation":"<p>Any failures associated with the call.</p>"
}
}
},
"DesiredStatus":{
"type":"string",
"enum":[
"RUNNING",
"PENDING",
"STOPPED"
]
},
"DiscoverPollEndpointRequest":{
"type":"structure",
"members":{
"containerInstance":{
"shape":"String",
"documentation":"<p>The container instance ID or full Amazon Resource Name (ARN) of the container instance. The ARN contains the <code>arn:aws:ecs</code> namespace, followed by the region of the container instance, the AWS account ID of the container instance owner, the <code>container-instance</code> namespace, and then the container instance ID. For example, <code>arn:aws:ecs:<i>region</i>:<i>aws_account_id</i>:container-instance/<i>container_instance_ID</i> </code>.</p>"
},
"cluster":{
"shape":"String",
"documentation":"<p>The cluster that the container instance belongs to.</p>"
}
}
},
"DiscoverPollEndpointResponse":{
"type":"structure",
"members":{
"endpoint":{
"shape":"String",
"documentation":"<p>The endpoint for the Amazon ECS agent to poll.</p>"
},
"telemetryEndpoint":{
"shape":"String",
"documentation":"<p>The telemetry endpoint for the Amazon ECS agent.</p>"
}
}
},
"DockerLabelsMap":{
"type":"map",
"key":{"shape":"String"},
"value":{"shape":"String"}
},
"Double":{"type":"double"},
"EnvironmentVariables":{
"type":"list",
"member":{"shape":"KeyValuePair"}
},
"Failure":{
"type":"structure",
"members":{
"arn":{
"shape":"String",
"documentation":"<p>The Amazon Resource Name (ARN) of the failed resource.</p>"
},
"reason":{
"shape":"String",
"documentation":"<p>The reason for the failure.</p>"
}
},
"documentation":"<p>A failed resource.</p>"
},
"Failures":{
"type":"list",
"member":{"shape":"Failure"}
},
"HostEntry":{
"type":"structure",
"required":[
"hostname",
"ipAddress"
],
"members":{
"hostname":{
"shape":"String",
"documentation":"<p>The hostname to use in the <code>/etc/hosts</code> entry.</p>"
},
"ipAddress":{
"shape":"String",
"documentation":"<p>The IP address to use in the <code>/etc/hosts</code> entry.</p>"
}
},
"documentation":"<p>Hostnames and IP address entries that are added to the <code>/etc/hosts</code> file of a container via the <code>extraHosts</code> parameter of its <a>ContainerDefinition</a>. </p>"
},
"HostEntryList":{
"type":"list",
"member":{"shape":"HostEntry"}
},
"HostVolumeProperties":{
"type":"structure",
"members":{
"sourcePath":{
"shape":"String",
"documentation":"<p>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 <code>host</code> parameter contains a <code>sourcePath</code> file location, then the data volume persists at the specified location on the host container instance until you delete it manually. If the <code>sourcePath</code> 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.</p>"
}
},
"documentation":"<p>Details on a container instance host volume.</p>"
},
"Integer":{"type":"integer"},
"InvalidParameterException":{
"type":"structure",
"members":{
},
"documentation":"<p>The specified parameter is invalid. Review the available parameters for the API request.</p>",
"exception":true
},
"KeyValuePair":{
"type":"structure",
"members":{
"name":{
"shape":"String",
"documentation":"<p>The name of the key value pair. For environment variables, this is the name of the environment variable.</p>"
},
"value":{
"shape":"String",
"documentation":"<p>The value of the key value pair. For environment variables, this is the value of the environment variable.</p>"
}
},
"documentation":"<p>A key and value pair object.</p>"
},
"ListClustersRequest":{
"type":"structure",
"members":{
"nextToken":{
"shape":"String",
"documentation":"<p>The <code>nextToken</code> value returned from a previous paginated <code>ListClusters</code> request where <code>maxResults</code> was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the <code>nextToken</code> value. This value is <code>null</code> when there are no more results to return.</p> <note> <p>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.</p> </note>"
},
"maxResults":{
"shape":"BoxedInteger",
"documentation":"<p>The maximum number of cluster results returned by <code>ListClusters</code> in paginated output. When this parameter is used, <code>ListClusters</code> only returns <code>maxResults</code> results in a single page along with a <code>nextToken</code> response element. The remaining results of the initial request can be seen by sending another <code>ListClusters</code> request with the returned <code>nextToken</code> value. This value can be between 1 and 100. If this parameter is not used, then <code>ListClusters</code> returns up to 100 results and a <code>nextToken</code> value if applicable.</p>"
}
}
},
"ListClustersResponse":{
"type":"structure",
"members":{
"clusterArns":{
"shape":"StringList",
"documentation":"<p>The list of full Amazon Resource Name (ARN) entries for each cluster associated with your account.</p>"
},
"nextToken":{
"shape":"String",
"documentation":"<p>The <code>nextToken</code> value to include in a future <code>ListClusters</code> request. When the results of a <code>ListClusters</code> request exceed <code>maxResults</code>, this value can be used to retrieve the next page of results. This value is <code>null</code> when there are no more results to return.</p>"
}
}
},
"ListContainerInstancesRequest":{
"type":"structure",
"members":{
"cluster":{
"shape":"String",
"documentation":"<p>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.</p>"
},
"nextToken":{
"shape":"String",
"documentation":"<p>The <code>nextToken</code> value returned from a previous paginated <code>ListContainerInstances</code> request where <code>maxResults</code> was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the <code>nextToken</code> value. This value is <code>null</code> when there are no more results to return.</p> <note> <p>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.</p> </note>"
},
"maxResults":{
"shape":"BoxedInteger",
"documentation":"<p>The maximum number of container instance results returned by <code>ListContainerInstances</code> in paginated output. When this parameter is used, <code>ListContainerInstances</code> only returns <code>maxResults</code> results in a single page along with a <code>nextToken</code> response element. The remaining results of the initial request can be seen by sending another <code>ListContainerInstances</code> request with the returned <code>nextToken</code> value. This value can be between 1 and 100. If this parameter is not used, then <code>ListContainerInstances</code> returns up to 100 results and a <code>nextToken</code> value if applicable.</p>"
}
}
},
"ListContainerInstancesResponse":{
"type":"structure",
"members":{
"containerInstanceArns":{
"shape":"StringList",
"documentation":"<p>The list of container instances with full Amazon Resource Name (ARN) entries for each container instance associated with the specified cluster.</p>"
},
"nextToken":{
"shape":"String",
"documentation":"<p>The <code>nextToken</code> value to include in a future <code>ListContainerInstances</code> request. When the results of a <code>ListContainerInstances</code> request exceed <code>maxResults</code>, this value can be used to retrieve the next page of results. This value is <code>null</code> when there are no more results to return.</p>"
}
}
},
"ListServicesRequest":{
"type":"structure",
"members":{
"cluster":{
"shape":"String",
"documentation":"<p>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.</p>"
},
"nextToken":{
"shape":"String",
"documentation":"<p>The <code>nextToken</code> value returned from a previous paginated <code>ListServices</code> request where <code>maxResults</code> was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the <code>nextToken</code> value. This value is <code>null</code> when there are no more results to return.</p> <note> <p>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.</p> </note>"
},
"maxResults":{
"shape":"BoxedInteger",
"documentation":"<p>The maximum number of container instance results returned by <code>ListServices</code> in paginated output. When this parameter is used, <code>ListServices</code> only returns <code>maxResults</code> results in a single page along with a <code>nextToken</code> response element. The remaining results of the initial request can be seen by sending another <code>ListServices</code> request with the returned <code>nextToken</code> value. This value can be between 1 and 10. If this parameter is not used, then <code>ListServices</code> returns up to 10 results and a <code>nextToken</code> value if applicable.</p>"
}
}
},
"ListServicesResponse":{
"type":"structure",
"members":{
"serviceArns":{
"shape":"StringList",
"documentation":"<p>The list of full Amazon Resource Name (ARN) entries for each service associated with the specified cluster.</p>"
},
"nextToken":{
"shape":"String",
"documentation":"<p>The <code>nextToken</code> value to include in a future <code>ListServices</code> request. When the results of a <code>ListServices</code> request exceed <code>maxResults</code>, this value can be used to retrieve the next page of results. This value is <code>null</code> when there are no more results to return.</p>"
}
}
},
"ListTaskDefinitionFamiliesRequest":{
"type":"structure",
"members":{
"familyPrefix":{
"shape":"String",
"documentation":"<p>The <code>familyPrefix</code> is a string that is used to filter the results of <code>ListTaskDefinitionFamilies</code>. If you specify a <code>familyPrefix</code>, only task definition family names that begin with the <code>familyPrefix</code> string are returned.</p>"
},
"status":{
"shape":"TaskDefinitionFamilyStatus",
"documentation":"<p>The task definition family status with which to filter the <code>ListTaskDefinitionFamilies</code> results. By default, both <code>ACTIVE</code> and <code>INACTIVE</code> task definition families are listed. If this parameter is set to <code>ACTIVE</code>, only task definition families that have an <code>ACTIVE</code> task definition revision are returned. If this parameter is set to <code>INACTIVE</code>, only task definition families that do not have any <code>ACTIVE</code> task definition revisions are returned. If you paginate the resulting output, be sure to keep the <code>status</code> value constant in each subsequent request.</p>"
},
"nextToken":{
"shape":"String",
"documentation":"<p>The <code>nextToken</code> value returned from a previous paginated <code>ListTaskDefinitionFamilies</code> request where <code>maxResults</code> was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the <code>nextToken</code> value. This value is <code>null</code> when there are no more results to return.</p> <note> <p>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.</p> </note>"
},
"maxResults":{
"shape":"BoxedInteger",
"documentation":"<p>The maximum number of task definition family results returned by <code>ListTaskDefinitionFamilies</code> in paginated output. When this parameter is used, <code>ListTaskDefinitions</code> only returns <code>maxResults</code> results in a single page along with a <code>nextToken</code> response element. The remaining results of the initial request can be seen by sending another <code>ListTaskDefinitionFamilies</code> request with the returned <code>nextToken</code> value. This value can be between 1 and 100. If this parameter is not used, then <code>ListTaskDefinitionFamilies</code> returns up to 100 results and a <code>nextToken</code> value if applicable.</p>"
}
}
},
"ListTaskDefinitionFamiliesResponse":{
"type":"structure",
"members":{
"families":{
"shape":"StringList",
"documentation":"<p>The list of task definition family names that match the <code>ListTaskDefinitionFamilies</code> request.</p>"
},
"nextToken":{
"shape":"String",
"documentation":"<p>The <code>nextToken</code> value to include in a future <code>ListTaskDefinitionFamilies</code> request. When the results of a <code>ListTaskDefinitionFamilies</code> request exceed <code>maxResults</code>, this value can be used to retrieve the next page of results. This value is <code>null</code> when there are no more results to return.</p>"
}
}
},
"ListTaskDefinitionsRequest":{
"type":"structure",
"members":{
"familyPrefix":{
"shape":"String",
"documentation":"<p>The full family name with which to filter the <code>ListTaskDefinitions</code> results. Specifying a <code>familyPrefix</code> limits the listed task definitions to task definition revisions that belong to that family.</p>"
},
"status":{
"shape":"TaskDefinitionStatus",
"documentation":"<p>The task definition status with which to filter the <code>ListTaskDefinitions</code> results. By default, only <code>ACTIVE</code> task definitions are listed. By setting this parameter to <code>INACTIVE</code>, you can view task definitions that are <code>INACTIVE</code> as long as an active task or service still references them. If you paginate the resulting output, be sure to keep the <code>status</code> value constant in each subsequent request.</p>"
},
"sort":{
"shape":"SortOrder",
"documentation":"<p>The order in which to sort the results. Valid values are <code>ASC</code> and <code>DESC</code>. By default (<code>ASC</code>), 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 <code>DESC</code> reverses the sort order on family name and revision so that the newest task definitions in a family are listed first.</p>"
},
"nextToken":{
"shape":"String",
"documentation":"<p>The <code>nextToken</code> value returned from a previous paginated <code>ListTaskDefinitions</code> request where <code>maxResults</code> was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the <code>nextToken</code> value. This value is <code>null</code> when there are no more results to return.</p> <note> <p>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.</p> </note>"
},
"maxResults":{
"shape":"BoxedInteger",
"documentation":"<p>The maximum number of task definition results returned by <code>ListTaskDefinitions</code> in paginated output. When this parameter is used, <code>ListTaskDefinitions</code> only returns <code>maxResults</code> results in a single page along with a <code>nextToken</code> response element. The remaining results of the initial request can be seen by sending another <code>ListTaskDefinitions</code> request with the returned <code>nextToken</code> value. This value can be between 1 and 100. If this parameter is not used, then <code>ListTaskDefinitions</code> returns up to 100 results and a <code>nextToken</code> value if applicable.</p>"
}
}
},
"ListTaskDefinitionsResponse":{
"type":"structure",
"members":{
"taskDefinitionArns":{
"shape":"StringList",
"documentation":"<p>The list of task definition Amazon Resource Name (ARN) entries for the <code>ListTaskDefinitions</code> request.</p>"
},
"nextToken":{
"shape":"String",
"documentation":"<p>The <code>nextToken</code> value to include in a future <code>ListTaskDefinitions</code> request. When the results of a <code>ListTaskDefinitions</code> request exceed <code>maxResults</code>, this value can be used to retrieve the next page of results. This value is <code>null</code> when there are no more results to return.</p>"
}
}
},
"ListTasksRequest":{
"type":"structure",
"members":{
"cluster":{
"shape":"String",
"documentation":"<p>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.</p>"
},
"containerInstance":{
"shape":"String",
"documentation":"<p>The container instance ID or full Amazon Resource Name (ARN) of the container instance with which to filter the <code>ListTasks</code> results. Specifying a <code>containerInstance</code> limits the results to tasks that belong to that container instance.</p>"
},
"family":{
"shape":"String",
"documentation":"<p>The name of the family with which to filter the <code>ListTasks</code> results. Specifying a <code>family</code> limits the results to tasks that belong to that family.</p>"
},
"nextToken":{
"shape":"String",
"documentation":"<p>The <code>nextToken</code> value returned from a previous paginated <code>ListTasks</code> request where <code>maxResults</code> was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the <code>nextToken</code> value. This value is <code>null</code> when there are no more results to return.</p> <note> <p>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.</p> </note>"
},
"maxResults":{
"shape":"BoxedInteger",
"documentation":"<p>The maximum number of task results returned by <code>ListTasks</code> in paginated output. When this parameter is used, <code>ListTasks</code> only returns <code>maxResults</code> results in a single page along with a <code>nextToken</code> response element. The remaining results of the initial request can be seen by sending another <code>ListTasks</code> request with the returned <code>nextToken</code> value. This value can be between 1 and 100. If this parameter is not used, then <code>ListTasks</code> returns up to 100 results and a <code>nextToken</code> value if applicable.</p>"
},
"startedBy":{
"shape":"String",
"documentation":"<p>The <code>startedBy</code> value with which to filter the task results. Specifying a <code>startedBy</code> value limits the results to tasks that were started with that value.</p>"
},
"serviceName":{
"shape":"String",
"documentation":"<p>The name of the service with which to filter the <code>ListTasks</code> results. Specifying a <code>serviceName</code> limits the results to tasks that belong to that service.</p>"
},
"desiredStatus":{
"shape":"DesiredStatus",
"documentation":"<p>The task desired status with which to filter the <code>ListTasks</code> results. Specifying a <code>desiredStatus</code> of <code>STOPPED</code> limits the results to tasks that ECS has set the desired status to <code>STOPPED</code>, which can be useful for debugging tasks that are not starting properly or have died or finished. The default status filter is <code>RUNNING</code>, which shows tasks that ECS has set the desired status to <code>RUNNING</code>.</p> <note> <p>Although you can filter results based on a desired status of <code>PENDING</code>, this will not return any results because ECS never sets the desired status of a task to that value (only a task's <code>lastStatus</code> may have a value of <code>PENDING</code>).</p> </note>"
}
}
},
"ListTasksResponse":{
"type":"structure",
"members":{
"taskArns":{
"shape":"StringList",
"documentation":"<p>The list of task Amazon Resource Name (ARN) entries for the <code>ListTasks</code> request.</p>"
},
"nextToken":{
"shape":"String",
"documentation":"<p>The <code>nextToken</code> value to include in a future <code>ListTasks</code> request. When the results of a <code>ListTasks</code> request exceed <code>maxResults</code>, this value can be used to retrieve the next page of results. This value is <code>null</code> when there are no more results to return.</p>"
}
}
},
"LoadBalancer":{
"type":"structure",
"members":{
"targetGroupArn":{
"shape":"String",
"documentation":"<p>The full Amazon Resource Name (ARN) of the Elastic Load Balancing target group associated with a service.</p>"
},
"loadBalancerName":{
"shape":"String",
"documentation":"<p>The name of the load balancer.</p>"
},
"containerName":{
"shape":"String",
"documentation":"<p>The name of the container (as it appears in a container definition) to associate with the load balancer.</p>"
},
"containerPort":{
"shape":"BoxedInteger",
"documentation":"<p>The port on the container to associate with the load balancer. This port must correspond to a <code>containerPort</code> in the service's task definition. Your container instances must allow ingress traffic on the <code>hostPort</code> of the port mapping.</p>"
}
},
"documentation":"<p>Details on a load balancer that is used with a service.</p>"
},
"LoadBalancers":{
"type":"list",
"member":{"shape":"LoadBalancer"}
},
"LogConfiguration":{
"type":"structure",
"required":["logDriver"],
"members":{
"logDriver":{
"shape":"LogDriver",
"documentation":"<p>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. </p> <note> <p>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 <a href=\"https://github.com/aws/amazon-ecs-agent\">available on GitHub</a> 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.</p> </note> <p>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: <code>sudo docker version | grep \"Server API version\"</code> </p>"
},
"options":{
"shape":"LogConfigurationOptionsMap",
"documentation":"<p>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: <code>sudo docker version | grep \"Server API version\"</code> </p>"
}
},
"documentation":"<p>Log configuration options to send to a custom log driver for the container.</p>"
},
"LogConfigurationOptionsMap":{
"type":"map",
"key":{"shape":"String"},
"value":{"shape":"String"}
},
"LogDriver":{
"type":"string",
"enum":[
"json-file",
"syslog",
"journald",
"gelf",
"fluentd",
"awslogs",
"splunk"
]
},
"Long":{"type":"long"},
"MissingVersionException":{
"type":"structure",
"members":{
},
"documentation":"<p>Amazon ECS is unable to determine the current version of the Amazon ECS container agent on the container instance and does not have enough information to proceed with an update. This could be because the agent running on the container instance is an older or custom version that does not use our version information.</p>",
"exception":true
},
"MountPoint":{
"type":"structure",
"members":{
"sourceVolume":{
"shape":"String",
"documentation":"<p>The name of the volume to mount.</p>"
},
"containerPath":{
"shape":"String",
"documentation":"<p>The path on the container to mount the host volume at.</p>"
},
"readOnly":{
"shape":"BoxedBoolean",
"documentation":"<p>If this value is <code>true</code>, the container has read-only access to the volume. If this value is <code>false</code>, then the container can write to the volume. The default value is <code>false</code>.</p>"
}
},
"documentation":"<p>Details on a volume mount point that is used in a container definition.</p>"
},
"MountPointList":{
"type":"list",
"member":{"shape":"MountPoint"}
},
"NetworkBinding":{
"type":"structure",
"members":{
"bindIP":{
"shape":"String",
"documentation":"<p>The IP address that the container is bound to on the container instance.</p>"
},
"containerPort":{
"shape":"BoxedInteger",
"documentation":"<p>The port number on the container that is be used with the network binding.</p>"
},
"hostPort":{
"shape":"BoxedInteger",
"documentation":"<p>The port number on the host that is used with the network binding.</p>"
},
"protocol":{
"shape":"TransportProtocol",
"documentation":"<p>The protocol used for the network binding.</p>"
}
},
"documentation":"<p>Details on the network bindings between a container and its host container instance. After a task reaches the <code>RUNNING</code> status, manual and automatic host and container port assignments are visible in the <code>networkBindings</code> section of <a>DescribeTasks</a> API responses.</p>"
},
"NetworkBindings":{
"type":"list",
"member":{"shape":"NetworkBinding"}
},
"NetworkMode":{
"type":"string",
"enum":[
"bridge",
"host",
"none"
]
},
"NoUpdateAvailableException":{
"type":"structure",
"members":{
},
"documentation":"<p>There is no update available for this Amazon ECS container agent. This could be because the agent is already running the latest version, or it is so old that there is no update path to the current version.</p>",
"exception":true
},
"PortMapping":{
"type":"structure",
"members":{
"containerPort":{
"shape":"BoxedInteger",
"documentation":"<p>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 <code>hostPort</code>). Port mappings that are automatically assigned in this way do not count toward the 100 reserved ports limit of a container instance.</p>"
},
"hostPort":{
"shape":"BoxedInteger",
"documentation":"<p>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 <code>hostPort</code> (or set it to <code>0</code>) while specifying a <code>containerPort</code> and your container automatically receives a port in the ephemeral port range for your container instance operating system and Docker version.</p> <p>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 <code>/proc/sys/net/ipv4/ip_local_port_range</code>; 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.</p> <p>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 <code>remainingResources</code> of <a>DescribeContainerInstances</a> 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).</p>"
},
"protocol":{
"shape":"TransportProtocol",
"documentation":"<p>The protocol used for the port mapping. Valid values are <code>tcp</code> and <code>udp</code>. The default is <code>tcp</code>.</p>"
}
},
"documentation":"<p>Port mappings allow containers to access ports on the host container instance to send or receive traffic. Port mappings are specified as part of the container definition. After a task reaches the <code>RUNNING</code> status, manual and automatic host and container port assignments are visible in the <code>networkBindings</code> section of <a>DescribeTasks</a> API responses.</p>"
},
"PortMappingList":{
"type":"list",
"member":{"shape":"PortMapping"}
},
"RegisterContainerInstanceRequest":{
"type":"structure",
"members":{
"cluster":{
"shape":"String",
"documentation":"<p>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.</p>"
},
"instanceIdentityDocument":{
"shape":"String",
"documentation":"<p>The instance identity document for the EC2 instance to register. This document can be found by running the following command from the instance: <code>curl http://169.254.169.254/latest/dynamic/instance-identity/document/</code> </p>"
},
"instanceIdentityDocumentSignature":{
"shape":"String",
"documentation":"<p>The instance identity document signature for the EC2 instance to register. This signature can be found by running the following command from the instance: <code>curl http://169.254.169.254/latest/dynamic/instance-identity/signature/</code> </p>"
},
"totalResources":{
"shape":"Resources",
"documentation":"<p>The resources available on the instance.</p>"
},
"versionInfo":{
"shape":"VersionInfo",
"documentation":"<p>The version information for the Amazon ECS container agent and Docker daemon running on the container instance.</p>"
},
"containerInstanceArn":{
"shape":"String",
"documentation":"<p>The Amazon Resource Name (ARN) of the container instance (if it was previously registered).</p>"
},
"attributes":{
"shape":"Attributes",
"documentation":"<p>The container instance attributes that this container instance supports.</p>"
}
}
},
"RegisterContainerInstanceResponse":{
"type":"structure",
"members":{
"containerInstance":{"shape":"ContainerInstance"}
}
},
"RegisterTaskDefinitionRequest":{
"type":"structure",
"required":[
"family",
"containerDefinitions"
],
"members":{
"family":{
"shape":"String",
"documentation":"<p>You must specify a <code>family</code> for a task definition, which allows you to track multiple versions of the same task definition. The <code>family</code> is used as a name for your task definition. Up to 255 letters (uppercase and lowercase), numbers, hyphens, and underscores are allowed.</p>"
},
"taskRoleArn":{
"shape":"String",
"documentation":"<p>The short name or full Amazon Resource Name (ARN) of the IAM role that containers in this task can assume. All containers in this task are granted the permissions that are specified in this role. For more information, see <a href=\"http://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-iam-roles.html\">IAM Roles for Tasks</a> in the <i>Amazon EC2 Container Service Developer Guide</i>.</p>"
},
"networkMode":{
"shape":"NetworkMode",
"documentation":"<p>The Docker networking mode to use for the containers in the task. The valid values are <code>none</code>, <code>bridge</code>, and <code>host</code>. </p> <p>The default Docker network mode is <code>bridge</code>. If the network mode is set to <code>none</code>, you cannot specify port mappings in your container definitions, and the task's containers do not have external connectivity. The <code>host</code> 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 <code>bridge</code> 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.</p> <p>For more information, see <a href=\"https://docs.docker.com/engine/reference/run/#network-settings\">Network settings</a> in the <i>Docker run reference</i>.</p>"
},
"containerDefinitions":{
"shape":"ContainerDefinitions",
"documentation":"<p>A list of container definitions in JSON format that describe the different containers that make up your task.</p>"
},
"volumes":{
"shape":"VolumeList",
"documentation":"<p>A list of volume definitions in JSON format that containers in your task may use.</p>"
}
}
},
"RegisterTaskDefinitionResponse":{
"type":"structure",
"members":{
"taskDefinition":{
"shape":"TaskDefinition",
"documentation":"<p>The full description of the registered task definition.</p>"
}
}
},
"RequiresAttributes":{
"type":"list",
"member":{"shape":"Attribute"}
},
"Resource":{
"type":"structure",
"members":{
"name":{
"shape":"String",
"documentation":"<p>The name of the resource, such as <code>CPU</code>, <code>MEMORY</code>, <code>PORTS</code>, or a user-defined resource.</p>"
},
"type":{
"shape":"String",
"documentation":"<p>The type of the resource, such as <code>INTEGER</code>, <code>DOUBLE</code>, <code>LONG</code>, or <code>STRINGSET</code>.</p>"
},
"doubleValue":{
"shape":"Double",
"documentation":"<p>When the <code>doubleValue</code> type is set, the value of the resource must be a double precision floating-point type.</p>"
},
"longValue":{
"shape":"Long",
"documentation":"<p>When the <code>longValue</code> type is set, the value of the resource must be an extended precision floating-point type.</p>"
},
"integerValue":{
"shape":"Integer",
"documentation":"<p>When the <code>integerValue</code> type is set, the value of the resource must be an integer.</p>"
},
"stringSetValue":{
"shape":"StringList",
"documentation":"<p>When the <code>stringSetValue</code> type is set, the value of the resource must be a string type.</p>"
}
},
"documentation":"<p>Describes the resources available for a container instance.</p>"
},
"Resources":{
"type":"list",
"member":{"shape":"Resource"}
},
"RunTaskRequest":{
"type":"structure",
"required":["taskDefinition"],
"members":{
"cluster":{
"shape":"String",
"documentation":"<p>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.</p>"
},
"taskDefinition":{
"shape":"String",
"documentation":"<p>The <code>family</code> and <code>revision</code> (<code>family:revision</code>) or full Amazon Resource Name (ARN) of the task definition to run. If a <code>revision</code> is not specified, the latest <code>ACTIVE</code> revision is used.</p>"
},
"overrides":{
"shape":"TaskOverride",
"documentation":"<p>A list of container overrides in JSON format that specify the name of a container in the specified task definition and the overrides it should receive. You can override the default command for a container (that is specified in the task definition or Docker image) with a <code>command</code> override. You can also override existing environment variables (that are specified in the task definition or Docker image) on a container or add new environment variables to it with an <code>environment</code> override.</p> <note> <p>A total of 8192 characters are allowed for overrides. This limit includes the JSON formatting characters of the override structure.</p> </note>"
},
"count":{
"shape":"BoxedInteger",
"documentation":"<p>The number of instantiations of the specified task to place on your cluster.</p> <important> <p>The <code>count</code> parameter is limited to 10 tasks per call.</p> </important>"
},
"startedBy":{
"shape":"String",
"documentation":"<p>An optional tag specified when a task is started. For example if you automatically trigger a task to run a batch process job, you could apply a unique identifier for that job to your task with the <code>startedBy</code> parameter. You can then identify which tasks belong to that job by filtering the results of a <a>ListTasks</a> call with the <code>startedBy</code> value. Up to 36 letters (uppercase and lowercase), numbers, hyphens, and underscores are allowed.</p> <p>If a task is started by an Amazon ECS service, then the <code>startedBy</code> parameter contains the deployment ID of the service that starts it.</p>"
}
}
},
"RunTaskResponse":{
"type":"structure",
"members":{
"tasks":{
"shape":"Tasks",
"documentation":"<p>A full description of the tasks that were run. Each task that was successfully placed on your cluster are described here.</p>"
},
"failures":{
"shape":"Failures",
"documentation":"<p>Any failures associated with the call.</p>"
}
}
},
"ServerException":{
"type":"structure",
"members":{
"message":{"shape":"String"}
},
"documentation":"<p>These errors are usually caused by a server issue.</p>",
"exception":true,
"fault":true
},
"Service":{
"type":"structure",
"members":{
"serviceArn":{
"shape":"String",
"documentation":"<p>The Amazon Resource Name (ARN) that identifies the service. The ARN contains the <code>arn:aws:ecs</code> namespace, followed by the region of the service, the AWS account ID of the service owner, the <code>service</code> namespace, and then the service name. For example, <code>arn:aws:ecs:<i>region</i>:<i>012345678910</i>:service/<i>my-service</i> </code>.</p>"
},
"serviceName":{
"shape":"String",
"documentation":"<p>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.</p>"
},
"clusterArn":{
"shape":"String",
"documentation":"<p>The Amazon Resource Name (ARN) of the cluster that hosts the service.</p>"
},
"loadBalancers":{
"shape":"LoadBalancers",
"documentation":"<p>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.</p>"
},
"status":{
"shape":"String",
"documentation":"<p>The status of the service. The valid values are <code>ACTIVE</code>, <code>DRAINING</code>, or <code>INACTIVE</code>.</p>"
},
"desiredCount":{
"shape":"Integer",
"documentation":"<p>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 <a>CreateService</a>, and it can be modified with <a>UpdateService</a>.</p>"
},
"runningCount":{
"shape":"Integer",
"documentation":"<p>The number of tasks in the cluster that are in the <code>RUNNING</code> state.</p>"
},
"pendingCount":{
"shape":"Integer",
"documentation":"<p>The number of tasks in the cluster that are in the <code>PENDING</code> state.</p>"
},
"taskDefinition":{
"shape":"String",
"documentation":"<p>The task definition to use for tasks in the service. This value is specified when the service is created with <a>CreateService</a>, and it can be modified with <a>UpdateService</a>.</p>"
},
"deploymentConfiguration":{
"shape":"DeploymentConfiguration",
"documentation":"<p>Optional deployment parameters that control how many tasks run during the deployment and the ordering of stopping and starting tasks.</p>"
},
"deployments":{
"shape":"Deployments",
"documentation":"<p>The current state of deployments for the service.</p>"
},
"roleArn":{
"shape":"String",
"documentation":"<p>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.</p>"
},
"events":{
"shape":"ServiceEvents",
"documentation":"<p>The event stream for your service. A maximum of 100 of the latest events are displayed.</p>"
},
"createdAt":{
"shape":"Timestamp",
"documentation":"<p>The Unix timestamp for when the service was created.</p>"
}
},
"documentation":"<p>Details on a service within a cluster</p>"
},
"ServiceEvent":{
"type":"structure",
"members":{
"id":{
"shape":"String",
"documentation":"<p>The ID string of the event.</p>"
},
"createdAt":{
"shape":"Timestamp",
"documentation":"<p>The Unix timestamp for when the event was triggered.</p>"
},
"message":{
"shape":"String",
"documentation":"<p>The event message.</p>"
}
},
"documentation":"<p>Details on an event associated with a service.</p>"
},
"ServiceEvents":{
"type":"list",
"member":{"shape":"ServiceEvent"}
},
"ServiceNotActiveException":{
"type":"structure",
"members":{
},
"documentation":"<p>The specified service is not active. You cannot update a service that is not active. If you have previously deleted a service, you can re-create it with <a>CreateService</a>.</p>",
"exception":true
},
"ServiceNotFoundException":{
"type":"structure",
"members":{
},
"documentation":"<p>The specified service could not be found. You can view your available services with <a>ListServices</a>. Amazon ECS services are cluster-specific and region-specific.</p>",
"exception":true
},
"Services":{
"type":"list",
"member":{"shape":"Service"}
},
"SortOrder":{
"type":"string",
"enum":[
"ASC",
"DESC"
]
},
"StartTaskRequest":{
"type":"structure",
"required":[
"taskDefinition",
"containerInstances"
],
"members":{
"cluster":{
"shape":"String",
"documentation":"<p>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.</p>"
},
"taskDefinition":{
"shape":"String",
"documentation":"<p>The <code>family</code> and <code>revision</code> (<code>family:revision</code>) or full Amazon Resource Name (ARN) of the task definition to start. If a <code>revision</code> is not specified, the latest <code>ACTIVE</code> revision is used.</p>"
},
"overrides":{
"shape":"TaskOverride",
"documentation":"<p>A list of container overrides in JSON format that specify the name of a container in the specified task definition and the overrides it should receive. You can override the default command for a container (that is specified in the task definition or Docker image) with a <code>command</code> override. You can also override existing environment variables (that are specified in the task definition or Docker image) on a container or add new environment variables to it with an <code>environment</code> override.</p> <note> <p>A total of 8192 characters are allowed for overrides. This limit includes the JSON formatting characters of the override structure.</p> </note>"
},
"containerInstances":{
"shape":"StringList",
"documentation":"<p>The container instance IDs or full Amazon Resource Name (ARN) entries for the container instances on which you would like to place your task.</p> <important> <p>The list of container instances to start tasks on is limited to 10.</p> </important>"
},
"startedBy":{
"shape":"String",
"documentation":"<p>An optional tag specified when a task is started. For example if you automatically trigger a task to run a batch process job, you could apply a unique identifier for that job to your task with the <code>startedBy</code> parameter. You can then identify which tasks belong to that job by filtering the results of a <a>ListTasks</a> call with the <code>startedBy</code> value. Up to 36 letters (uppercase and lowercase), numbers, hyphens, and underscores are allowed.</p> <p>If a task is started by an Amazon ECS service, then the <code>startedBy</code> parameter contains the deployment ID of the service that starts it.</p>"
}
}
},
"StartTaskResponse":{
"type":"structure",
"members":{
"tasks":{
"shape":"Tasks",
"documentation":"<p>A full description of the tasks that were started. Each task that was successfully placed on your container instances are described here.</p>"
},
"failures":{
"shape":"Failures",
"documentation":"<p>Any failures associated with the call.</p>"
}
}
},
"StopTaskRequest":{
"type":"structure",
"required":["task"],
"members":{
"cluster":{
"shape":"String",
"documentation":"<p>The short name or full Amazon Resource Name (ARN) of the cluster that hosts the task to stop. If you do not specify a cluster, the default cluster is assumed.</p>"
},
"task":{
"shape":"String",
"documentation":"<p>The task ID or full Amazon Resource Name (ARN) entry of the task to stop.</p>"
},
"reason":{
"shape":"String",
"documentation":"<p>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 <a>DescribeTasks</a> API operations on this task. Up to 255 characters are allowed in this message.</p>"
}
}
},
"StopTaskResponse":{
"type":"structure",
"members":{
"task":{"shape":"Task"}
}
},
"String":{"type":"string"},
"StringList":{
"type":"list",
"member":{"shape":"String"}
},
"SubmitContainerStateChangeRequest":{
"type":"structure",
"members":{
"cluster":{
"shape":"String",
"documentation":"<p>The short name or full Amazon Resource Name (ARN) of the cluster that hosts the container.</p>"
},
"task":{
"shape":"String",
"documentation":"<p>The task ID or full Amazon Resource Name (ARN) of the task that hosts the container.</p>"
},
"containerName":{
"shape":"String",
"documentation":"<p>The name of the container.</p>"
},
"status":{
"shape":"String",
"documentation":"<p>The status of the state change request.</p>"
},
"exitCode":{
"shape":"BoxedInteger",
"documentation":"<p>The exit code returned for the state change request.</p>"
},
"reason":{
"shape":"String",
"documentation":"<p>The reason for the state change request.</p>"
},
"networkBindings":{
"shape":"NetworkBindings",
"documentation":"<p>The network bindings of the container.</p>"
}
}
},
"SubmitContainerStateChangeResponse":{
"type":"structure",
"members":{
"acknowledgment":{
"shape":"String",
"documentation":"<p>Acknowledgement of the state change.</p>"
}
}
},
"SubmitTaskStateChangeRequest":{
"type":"structure",
"members":{
"cluster":{
"shape":"String",
"documentation":"<p>The short name or full Amazon Resource Name (ARN) of the cluster that hosts the task.</p>"
},
"task":{
"shape":"String",
"documentation":"<p>The task ID or full Amazon Resource Name (ARN) of the task in the state change request.</p>"
},
"status":{
"shape":"String",
"documentation":"<p>The status of the state change request.</p>"
},
"reason":{
"shape":"String",
"documentation":"<p>The reason for the state change request.</p>"
}
}
},
"SubmitTaskStateChangeResponse":{
"type":"structure",
"members":{
"acknowledgment":{
"shape":"String",
"documentation":"<p>Acknowledgement of the state change.</p>"
}
}
},
"Task":{
"type":"structure",
"members":{
"taskArn":{
"shape":"String",
"documentation":"<p>The Amazon Resource Name (ARN) of the task.</p>"
},
"clusterArn":{
"shape":"String",
"documentation":"<p>The Amazon Resource Name (ARN) of the cluster that hosts the task.</p>"
},
"taskDefinitionArn":{
"shape":"String",
"documentation":"<p>The Amazon Resource Name (ARN) of the task definition that creates the task.</p>"
},
"containerInstanceArn":{
"shape":"String",
"documentation":"<p>The Amazon Resource Name (ARN) of the container instances that host the task.</p>"
},
"overrides":{
"shape":"TaskOverride",
"documentation":"<p>One or more container overrides.</p>"
},
"lastStatus":{
"shape":"String",
"documentation":"<p>The last known status of the task.</p>"
},
"desiredStatus":{
"shape":"String",
"documentation":"<p>The desired status of the task.</p>"
},
"containers":{
"shape":"Containers",
"documentation":"<p>The containers associated with the task.</p>"
},
"startedBy":{
"shape":"String",
"documentation":"<p>The tag specified when a task is started. If the task is started by an Amazon ECS service, then the <code>startedBy</code> parameter contains the deployment ID of the service that starts it.</p>"
},
"stoppedReason":{
"shape":"String",
"documentation":"<p>The reason the task was stopped.</p>"
},
"createdAt":{
"shape":"Timestamp",
"documentation":"<p>The Unix timestamp for when the task was created (the task entered the <code>PENDING</code> state).</p>"
},
"startedAt":{
"shape":"Timestamp",
"documentation":"<p>The Unix timestamp for when the task was started (the task transitioned from the <code>PENDING</code> state to the <code>RUNNING</code> state).</p>"
},
"stoppedAt":{
"shape":"Timestamp",
"documentation":"<p>The Unix timestamp for when the task was stopped (the task transitioned from the <code>RUNNING</code> state to the <code>STOPPED</code> state).</p>"
}
},
"documentation":"<p>Details on a task in a cluster.</p>"
},
"TaskDefinition":{
"type":"structure",
"members":{
"taskDefinitionArn":{
"shape":"String",
"documentation":"<p>The full Amazon Resource Name (ARN) of the task definition.</p>"
},
"containerDefinitions":{
"shape":"ContainerDefinitions",
"documentation":"<p>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 <a href=\"http://docs.aws.amazon.com/AmazonECS/latest/developerguide/task_defintions.html\">Amazon ECS Task Definitions</a> in the <i>Amazon EC2 Container Service Developer Guide</i>.</p>"
},
"family":{
"shape":"String",
"documentation":"<p>The family of your task definition, used as the definition name.</p>"
},
"taskRoleArn":{
"shape":"String",
"documentation":"<p>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.</p>"
},
"networkMode":{
"shape":"NetworkMode",
"documentation":"<p>The Docker networking mode to use for the containers in the task. The valid values are <code>none</code>, <code>bridge</code>, and <code>host</code>. </p> <p>If the network mode is <code>none</code>, the containers do not have external connectivity. The default Docker network mode is <code>bridge</code>. The <code>host</code> 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 <code>bridge</code> mode.</p> <p>For more information, see <a href=\"https://docs.docker.com/engine/reference/run/#network-settings\">Network settings</a> in the <i>Docker run reference</i>.</p>"
},
"revision":{
"shape":"Integer",
"documentation":"<p>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 <code>1</code>; 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).</p>"
},
"volumes":{
"shape":"VolumeList",
"documentation":"<p>The list of volumes in a task. For more information about volume definition parameters and defaults, see <a href=\"http://docs.aws.amazon.com/AmazonECS/latest/developerguide/task_defintions.html\">Amazon ECS Task Definitions</a> in the <i>Amazon EC2 Container Service Developer Guide</i>.</p>"
},
"status":{
"shape":"TaskDefinitionStatus",
"documentation":"<p>The status of the task definition.</p>"
},
"requiresAttributes":{
"shape":"RequiresAttributes",
"documentation":"<p>The container instance attributes required by your task.</p>"
}
},
"documentation":"<p>Details of a task definition.</p>"
},
"TaskDefinitionFamilyStatus":{
"type":"string",
"enum":[
"ACTIVE",
"INACTIVE",
"ALL"
]
},
"TaskDefinitionStatus":{
"type":"string",
"enum":[
"ACTIVE",
"INACTIVE"
]
},
"TaskOverride":{
"type":"structure",
"members":{
"containerOverrides":{
"shape":"ContainerOverrides",
"documentation":"<p>One or more container overrides sent to a task.</p>"
},
"taskRoleArn":{
"shape":"String",
"documentation":"<p>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.</p>"
}
},
"documentation":"<p>The overrides associated with a task.</p>"
},
"Tasks":{
"type":"list",
"member":{"shape":"Task"}
},
"Timestamp":{"type":"timestamp"},
"TransportProtocol":{
"type":"string",
"enum":[
"tcp",
"udp"
]
},
"Ulimit":{
"type":"structure",
"required":[
"name",
"softLimit",
"hardLimit"
],
"members":{
"name":{
"shape":"UlimitName",
"documentation":"<p>The <code>type</code> of the <code>ulimit</code>.</p>"
},
"softLimit":{
"shape":"Integer",
"documentation":"<p>The soft limit for the ulimit type.</p>"
},
"hardLimit":{
"shape":"Integer",
"documentation":"<p>The hard limit for the ulimit type.</p>"
}
},
"documentation":"<p>The <code>ulimit</code> settings to pass to the container.</p>"
},
"UlimitList":{
"type":"list",
"member":{"shape":"Ulimit"}
},
"UlimitName":{
"type":"string",
"enum":[
"core",
"cpu",
"data",
"fsize",
"locks",
"memlock",
"msgqueue",
"nice",
"nofile",
"nproc",
"rss",
"rtprio",
"rttime",
"sigpending",
"stack"
]
},
"UpdateContainerAgentRequest":{
"type":"structure",
"required":["containerInstance"],
"members":{
"cluster":{
"shape":"String",
"documentation":"<p>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.</p>"
},
"containerInstance":{
"shape":"String",
"documentation":"<p>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.</p>"
}
}
},
"UpdateContainerAgentResponse":{
"type":"structure",
"members":{
"containerInstance":{"shape":"ContainerInstance"}
}
},
"UpdateInProgressException":{
"type":"structure",
"members":{
},
"documentation":"<p>There is already a current Amazon ECS container agent update in progress on the specified container instance. If the container agent becomes disconnected while it is in a transitional stage, such as <code>PENDING</code> or <code>STAGING</code>, the update process can get stuck in that state. However, when the agent reconnects, it resumes where it stopped previously.</p>",
"exception":true
},
"UpdateServiceRequest":{
"type":"structure",
"required":["service"],
"members":{
"cluster":{
"shape":"String",
"documentation":"<p>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.</p>"
},
"service":{
"shape":"String",
"documentation":"<p>The name of the service to update.</p>"
},
"desiredCount":{
"shape":"BoxedInteger",
"documentation":"<p>The number of instantiations of the task to place and keep running in your service.</p>"
},
"taskDefinition":{
"shape":"String",
"documentation":"<p>The <code>family</code> and <code>revision</code> (<code>family:revision</code>) or full Amazon Resource Name (ARN) of the task definition to run in your service. If a <code>revision</code> is not specified, the latest <code>ACTIVE</code> revision is used. If you modify the task definition with <code>UpdateService</code>, 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.</p>"
},
"deploymentConfiguration":{
"shape":"DeploymentConfiguration",
"documentation":"<p>Optional deployment parameters that control how many tasks run during the deployment and the ordering of stopping and starting tasks.</p>"
}
}
},
"UpdateServiceResponse":{
"type":"structure",
"members":{
"service":{
"shape":"Service",
"documentation":"<p>The full description of your service following the update call.</p>"
}
}
},
"VersionInfo":{
"type":"structure",
"members":{
"agentVersion":{
"shape":"String",
"documentation":"<p>The version number of the Amazon ECS container agent.</p>"
},
"agentHash":{
"shape":"String",
"documentation":"<p>The Git commit hash for the Amazon ECS container agent build on the <a href=\"https://github.com/aws/amazon-ecs-agent/commits/master\">amazon-ecs-agent </a> GitHub repository.</p>"
},
"dockerVersion":{
"shape":"String",
"documentation":"<p>The Docker version running on the container instance.</p>"
}
},
"documentation":"<p>The Docker and Amazon ECS container agent version information about a container instance.</p>"
},
"Volume":{
"type":"structure",
"members":{
"name":{
"shape":"String",
"documentation":"<p>The name of the volume. Up to 255 letters (uppercase and lowercase), numbers, hyphens, and underscores are allowed. This name is referenced in the <code>sourceVolume</code> parameter of container definition <code>mountPoints</code>.</p>"
},
"host":{
"shape":"HostVolumeProperties",
"documentation":"<p>The contents of the <code>host</code> 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.</p>"
}
},
"documentation":"<p>A data volume used in a task definition.</p>"
},
"VolumeFrom":{
"type":"structure",
"members":{
"sourceContainer":{
"shape":"String",
"documentation":"<p>The name of the container to mount volumes from.</p>"
},
"readOnly":{
"shape":"BoxedBoolean",
"documentation":"<p>If this value is <code>true</code>, the container has read-only access to the volume. If this value is <code>false</code>, then the container can write to the volume. The default value is <code>false</code>.</p>"
}
},
"documentation":"<p>Details on a data volume from another container.</p>"
},
"VolumeFromList":{
"type":"list",
"member":{"shape":"VolumeFrom"}
},
"VolumeList":{
"type":"list",
"member":{"shape":"Volume"}
}
},
"documentation":"<p>Amazon EC2 Container Service (Amazon ECS) is a highly scalable, fast, container management service that makes it easy to run, stop, and manage Docker containers on a cluster of EC2 instances. Amazon ECS lets you launch and stop container-enabled applications with simple API calls, allows you to get the state of your cluster from a centralized service, and gives you access to many familiar Amazon EC2 features like security groups, Amazon EBS volumes, and IAM roles.</p> <p>You can use Amazon ECS to schedule the placement of containers across your cluster based on your resource needs, isolation policies, and availability requirements. Amazon EC2 Container Service eliminates the need for you to operate your own cluster management and configuration management systems or worry about scaling your management infrastructure.</p>"
}
Reference in a new issue View git blame Copy permalink