1{ 2 "version": "2.0", 3 "service": "<p>Amazon Elastic 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. You can host your cluster on a serverless infrastructure that is managed by Amazon ECS by launching your services or tasks using the Fargate launch type. For more control, you can host your tasks on a cluster of Amazon Elastic Compute Cloud (Amazon EC2) instances that you manage by using the EC2 launch type. For more information about launch types, see <a href=\"http://docs.aws.amazon.com/AmazonECS/latest/developerguide/launch_types.html\">Amazon ECS Launch Types</a>.</p> <p>Amazon ECS lets you launch and stop container-based 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.</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 ECS eliminates the need for you to operate your own cluster management and configuration management systems or worry about scaling your management infrastructure.</p>", 4 "operations": { 5 "CreateCluster": "<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> <note> <p>When you call the <a>CreateCluster</a> API operation, Amazon ECS attempts to create the service-linked role for your account so that required resources in other AWS services can be managed on your behalf. However, if the IAM user that makes the call does not have permissions to create the service-linked role, it is not created. For more information, see <a href=\"http://docs.aws.amazon.com/AmazonECS/latest/developerguide/using-service-linked-roles.html\">Using Service-Linked Roles for Amazon ECS</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p> </note>", 6 "CreateService": "<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 Elastic Container Service Developer Guide</i>.</p> <p>You can optionally specify a deployment configuration for your service. During a deployment, the service scheduler uses the <code>minimumHealthyPercent</code> and <code>maximumPercent</code> parameters to determine the deployment strategy. The deployment is triggered by changing the task definition or the desired count of a service with an <a>UpdateService</a> operation.</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 can 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 they are 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 can 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 determines task placement in your cluster using 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>By default, the service scheduler attempts to balance tasks across Availability Zones in this manner (although you can choose a different placement strategy) with the <code>placementStrategy</code> parameter):</p> <ul> <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> </li> </ul>", 7 "DeleteAttributes": "<p>Deletes one or more custom attributes from an Amazon ECS resource.</p>", 8 "DeleteCluster": "<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>", 9 "DeleteService": "<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 return a <code>ServiceNotFoundException</code> error.</p> </note>", 10 "DeregisterContainerInstance": "<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. That prevents 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>", 11 "DeregisterTaskDefinition": "<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> <note> <p>At this time, <code>INACTIVE</code> task definitions remain discoverable in your account indefinitely; however, this behavior is subject to change in the future, so you should not rely on <code>INACTIVE</code> task definitions persisting beyond the lifecycle of any associated tasks and services.</p> </note>", 12 "DescribeClusters": "<p>Describes one or more of your clusters.</p>", 13 "DescribeContainerInstances": "<p>Describes Amazon Elastic Container Service container instances. Returns metadata about registered and remaining resources on each container instance requested.</p>", 14 "DescribeServices": "<p>Describes the specified services running in your cluster.</p>", 15 "DescribeTaskDefinition": "<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>", 16 "DescribeTasks": "<p>Describes a specified task or tasks.</p>", 17 "DiscoverPollEndpoint": "<note> <p>This action is only used by the Amazon ECS agent, and it is not intended for use outside of the agent.</p> </note> <p>Returns an endpoint for the Amazon ECS agent to poll for updates.</p>", 18 "ListAttributes": "<p>Lists the attributes for Amazon ECS resources within a specified target type and cluster. When you specify a target type and cluster, <code>ListAttributes</code> returns a list of attribute objects, one for each attribute on each resource. You can filter the list of results to a single attribute name to only return results that have that name. You can also filter the results by attribute name and value, for example, to see which container instances in a cluster are running a Linux AMI (<code>ecs.os-type=linux</code>). </p>", 19 "ListClusters": "<p>Returns a list of existing clusters.</p>", 20 "ListContainerInstances": "<p>Returns a list of container instances in a specified cluster. You can filter the results of a <code>ListContainerInstances</code> operation with cluster query language statements inside the <code>filter</code> parameter. For more information, see <a href=\"http://docs.aws.amazon.com/AmazonECS/latest/developerguide/cluster-query-language.html\">Cluster Query Language</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p>", 21 "ListServices": "<p>Lists the services that are running in a specified cluster.</p>", 22 "ListTaskDefinitionFamilies": "<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>", 23 "ListTaskDefinitions": "<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>", 24 "ListTasks": "<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>", 25 "PutAttributes": "<p>Create or update an attribute on an Amazon ECS resource. If the attribute does not exist, it is created. If the attribute exists, its value is replaced with the specified value. To delete an attribute, use <a>DeleteAttributes</a>. For more information, see <a href=\"http://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-placement-constraints.html#attributes\">Attributes</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p>", 26 "RegisterContainerInstance": "<note> <p>This action is only used by the Amazon ECS 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>", 27 "RegisterTaskDefinition": "<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 Elastic 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 Elastic 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. If you specify the <code>awsvpc</code> network mode, the task is allocated an Elastic Network Interface, and you must specify a <a>NetworkConfiguration</a> when you create a service or run a task with the task definition. For more information, see <a href=\"http://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-networking.html\">Task Networking</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p>", 28 "RunTask": "<p>Starts a new task using the specified task definition.</p> <p>You can allow Amazon ECS to place tasks for you, or you can customize how Amazon ECS places tasks using placement constraints and placement strategies. For more information, see <a href=\"http://docs.aws.amazon.com/AmazonECS/latest/developerguide/scheduling_tasks.html\">Scheduling Tasks</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p> <p>Alternatively, you can use <a>StartTask</a> to use your own scheduler or place tasks manually on specific container instances.</p> <p>The Amazon ECS API follows an eventual consistency model, due to the distributed nature of the system supporting the API. This means that the result of an API command you run that affects your Amazon ECS resources might not be immediately visible to all subsequent commands you run. You should keep this in mind when you carry out an API command that immediately follows a previous API command.</p> <p>To manage eventual consistency, you can do the following:</p> <ul> <li> <p>Confirm the state of the resource before you run a command to modify it. Run the DescribeTasks command using an exponential backoff algorithm to ensure that you allow enough time for the previous command to propagate through the system. To do this, run the DescribeTasks command repeatedly, starting with a couple of seconds of wait time, and increasing gradually up to five minutes of wait time.</p> </li> <li> <p>Add wait time between subsequent commands, even if the DescribeTasks command returns an accurate response. Apply an exponential backoff algorithm starting with a couple of seconds of wait time, and increase gradually up to about five minutes of wait time.</p> </li> </ul>", 29 "StartTask": "<p>Starts a new task from the specified task definition on the specified container instance or instances.</p> <p>Alternatively, you can use <a>RunTask</a> to place tasks for you. For more information, see <a href=\"http://docs.aws.amazon.com/AmazonECS/latest/developerguide/scheduling_tasks.html\">Scheduling Tasks</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p>", 30 "StopTask": "<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 default 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> <note> <p>The default 30-second timeout can be configured on the Amazon ECS container agent with the <code>ECS_CONTAINER_STOP_TIMEOUT</code> variable. 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 Elastic Container Service Developer Guide</i>.</p> </note>", 31 "SubmitContainerStateChange": "<note> <p>This action is only used by the Amazon ECS agent, and it is not intended for use outside of the agent.</p> </note> <p>Sent to acknowledge that a container changed states.</p>", 32 "SubmitTaskStateChange": "<note> <p>This action is only used by the Amazon ECS agent, and it is not intended for use outside of the agent.</p> </note> <p>Sent to acknowledge that a task changed states.</p>", 33 "UpdateContainerAgent": "<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 Elastic Container Service Developer Guide</i>.</p>", 34 "UpdateContainerInstancesState": "<p>Modifies the status of an Amazon ECS container instance.</p> <p>You can change the status of a container instance to <code>DRAINING</code> to manually remove an instance from a cluster, for example to perform system updates, update the Docker daemon, or scale down the cluster size. </p> <p>When you set a container instance to <code>DRAINING</code>, Amazon ECS prevents new tasks from being scheduled for placement on the container instance and replacement service tasks are started on other container instances in the cluster if the resources are available. Service tasks on the container instance that are in the <code>PENDING</code> state are stopped immediately.</p> <p>Service tasks on the container instance that are in the <code>RUNNING</code> state are stopped and replaced according to the service's deployment configuration parameters, <code>minimumHealthyPercent</code> and <code>maximumPercent</code>. You can change the deployment configuration of your service using <a>UpdateService</a>.</p> <ul> <li> <p>If <code>minimumHealthyPercent</code> is below 100%, the scheduler can ignore <code>desiredCount</code> temporarily during task replacement. For example, <code>desiredCount</code> is four tasks, a minimum of 50% allows the scheduler to stop two existing tasks before starting two new tasks. If the minimum is 100%, the service scheduler can't remove existing tasks until the replacement tasks are considered healthy. Tasks for services that do not use a load balancer are considered healthy if they are in the <code>RUNNING</code> state. Tasks for services that use a load balancer are considered healthy if they are in the <code>RUNNING</code> state and the container instance they are hosted on is reported as healthy by the load balancer.</p> </li> <li> <p>The <code>maximumPercent</code> parameter represents an upper limit on the number of running tasks during task replacement, which enables you to define the replacement batch size. For example, if <code>desiredCount</code> of four tasks, a maximum of 200% starts four new tasks before stopping the four tasks to be drained (provided that the cluster resources required to do this are available). If the maximum is 100%, then replacement tasks can't start until the draining tasks have stopped.</p> </li> </ul> <p>Any <code>PENDING</code> or <code>RUNNING</code> tasks that do not belong to a service are not affected; you must wait for them to finish or stop them manually.</p> <p>A container instance has completed draining when it has no more <code>RUNNING</code> tasks. You can verify this using <a>ListTasks</a>.</p> <p>When you set a container instance to <code>ACTIVE</code>, the Amazon ECS scheduler can begin scheduling tasks on the instance again.</p>", 35 "UpdateService": "<p>Modifies the desired count, deployment configuration, network 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> <ul> <li> <p>If <code>minimumHealthyPercent</code> is below 100%, the scheduler can ignore <code>desiredCount</code> temporarily during a deployment. For example, if <code>desiredCount</code> is four tasks, a minimum of 50% allows the scheduler to stop two existing tasks before starting two new tasks. Tasks for services that do not use a load balancer are considered healthy if they are in the <code>RUNNING</code> state. Tasks for services that use a load balancer are considered healthy if they are in the <code>RUNNING</code> state and the container instance they are hosted on is reported as healthy by the load balancer.</p> </li> <li> <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 <code>desiredCount</code> is four tasks, a maximum of 200% starts four new tasks before stopping the four older tasks (provided that the cluster resources required to do this are available).</p> </li> </ul> <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 determines task placement 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>By default, the service scheduler attempts to balance tasks across Availability Zones in this manner (although you can choose a different placement strategy):</p> <ul> <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> </li> </ul> <p>When the service scheduler stops running tasks, it attempts to maintain balance across the Availability Zones in your cluster using the following logic: </p> <ul> <li> <p>Sort the container instances by the largest 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 two, container instances in either zone B or C are considered optimal for termination.</p> </li> <li> <p>Stop the task on a container instance in an optimal Availability Zone (based on the previous steps), favoring container instances with the largest number of running tasks for this service.</p> </li> </ul>" 36 }, 37 "shapes": { 38 "AccessDeniedException": { 39 "base": "<p>You do not have authorization to perform the requested action.</p>", 40 "refs": { 41 } 42 }, 43 "AgentUpdateStatus": { 44 "base": null, 45 "refs": { 46 "ContainerInstance$agentUpdateStatus": "<p>The status of the most recent agent update. If an update has never been requested, this value is <code>NULL</code>.</p>" 47 } 48 }, 49 "AssignPublicIp": { 50 "base": null, 51 "refs": { 52 "AwsVpcConfiguration$assignPublicIp": "<p>Specifies whether or not the task's elastic network interface receives a public IP address.</p>" 53 } 54 }, 55 "Attachment": { 56 "base": "<p>An object representing a container instance or task attachment.</p>", 57 "refs": { 58 "Attachments$member": null 59 } 60 }, 61 "AttachmentDetails": { 62 "base": null, 63 "refs": { 64 "Attachment$details": "<p>Details of the attachment. For Elastic Network Interfaces, this includes the network interface ID, the MAC address, the subnet ID, and the private IPv4 address.</p>" 65 } 66 }, 67 "AttachmentStateChange": { 68 "base": "<p>An object representing a change in state for a task attachment.</p>", 69 "refs": { 70 "AttachmentStateChanges$member": null 71 } 72 }, 73 "AttachmentStateChanges": { 74 "base": null, 75 "refs": { 76 "SubmitTaskStateChangeRequest$attachments": "<p>Any attachments associated with the state change request.</p>" 77 } 78 }, 79 "Attachments": { 80 "base": null, 81 "refs": { 82 "ContainerInstance$attachments": "<p>The Elastic Network Interfaces associated with the container instance.</p>", 83 "Task$attachments": "<p>The Elastic Network Adapter associated with the task if the task uses the <code>awsvpc</code> network mode.</p>" 84 } 85 }, 86 "Attribute": { 87 "base": "<p>An attribute is a name-value pair associated with an Amazon ECS object. Attributes enable you to extend the Amazon ECS data model by adding custom metadata to your resources. For more information, see <a href=\"http://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-placement-constraints.html#attributes\">Attributes</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p>", 88 "refs": { 89 "Attributes$member": null, 90 "RequiresAttributes$member": null 91 } 92 }, 93 "AttributeLimitExceededException": { 94 "base": "<p>You can apply up to 10 custom attributes per resource. You can view the attributes of a resource with <a>ListAttributes</a>. You can remove existing attributes on a resource with <a>DeleteAttributes</a>.</p>", 95 "refs": { 96 } 97 }, 98 "Attributes": { 99 "base": null, 100 "refs": { 101 "ContainerInstance$attributes": "<p>The attributes set for the container instance, either by the Amazon ECS container agent at instance registration or manually with the <a>PutAttributes</a> operation.</p>", 102 "DeleteAttributesRequest$attributes": "<p>The attributes to delete from your resource. You can specify up to 10 attributes per request. For custom attributes, specify the attribute name and target ID, but do not specify the value. If you specify the target ID using the short form, you must also specify the target type.</p>", 103 "DeleteAttributesResponse$attributes": "<p>A list of attribute objects that were successfully deleted from your resource.</p>", 104 "ListAttributesResponse$attributes": "<p>A list of attribute objects that meet the criteria of the request.</p>", 105 "PutAttributesRequest$attributes": "<p>The attributes to apply to your resource. You can specify up to 10 custom attributes per resource. You can specify up to 10 attributes in a single call.</p>", 106 "PutAttributesResponse$attributes": "<p>The attributes applied to your resource.</p>", 107 "RegisterContainerInstanceRequest$attributes": "<p>The container instance attributes that this container instance supports.</p>" 108 } 109 }, 110 "AwsVpcConfiguration": { 111 "base": "<p>An object representing the networking details for a task or service.</p>", 112 "refs": { 113 "NetworkConfiguration$awsvpcConfiguration": "<p>The VPC subnets and security groups associated with a task.</p>" 114 } 115 }, 116 "BlockedException": { 117 "base": "<p>Your AWS account has been blocked. <a href=\"http://aws.amazon.com/contact-us/\">Contact AWS Customer Support</a> for more information.</p>", 118 "refs": { 119 } 120 }, 121 "Boolean": { 122 "base": null, 123 "refs": { 124 "ContainerInstance$agentConnected": "<p>This parameter returns <code>true</code> if the agent is connected to Amazon ECS. Registered instances with an agent that may be unhealthy or stopped return <code>false</code>. Instances without a connected agent can't accept placement requests.</p>", 125 "UpdateServiceRequest$forceNewDeployment": "<p>Whether or not to force a new deployment of the service.</p>" 126 } 127 }, 128 "BoxedBoolean": { 129 "base": null, 130 "refs": { 131 "ContainerDefinition$essential": "<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 Elastic Container Service Developer Guide</i>.</p>", 132 "ContainerDefinition$disableNetworking": "<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.27/#create-a-container\">Create a container</a> section of the <a href=\"https://docs.docker.com/engine/reference/api/docker_remote_api_v1.27/\">Docker Remote API</a>.</p> <note> <p>This parameter is not supported for Windows containers.</p> </note>", 133 "ContainerDefinition$privileged": "<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.27/#create-a-container\">Create a container</a> section of the <a href=\"https://docs.docker.com/engine/reference/api/docker_remote_api_v1.27/\">Docker Remote API</a> and the <code>--privileged</code> option to <a href=\"https://docs.docker.com/engine/reference/run/\">docker run</a>.</p> <note> <p>This parameter is not supported for Windows containers or tasks using the Fargate launch type.</p> </note>", 134 "ContainerDefinition$readonlyRootFilesystem": "<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.27/#create-a-container\">Create a container</a> section of the <a href=\"https://docs.docker.com/engine/reference/api/docker_remote_api_v1.27/\">Docker Remote API</a> and the <code>--read-only</code> option to <code>docker run</code>.</p> <note> <p>This parameter is not supported for Windows containers.</p> </note>", 135 "DeregisterContainerInstanceRequest$force": "<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. They begin connection draining according to the settings on the load balancer or target group.</p>", 136 "LinuxParameters$initProcessEnabled": "<p>Run an <code>init</code> process inside the container that forwards signals and reaps processes. This parameter maps to the <code>--init</code> option to <a href=\"https://docs.docker.com/engine/reference/run/\">docker run</a>. This parameter requires version 1.25 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log in to your container instance and run the following command: <code>sudo docker version | grep \"Server API version\"</code> </p>", 137 "MountPoint$readOnly": "<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>", 138 "VolumeFrom$readOnly": "<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>" 139 } 140 }, 141 "BoxedInteger": { 142 "base": null, 143 "refs": { 144 "Container$exitCode": "<p>The exit code returned from the container.</p>", 145 "ContainerDefinition$memory": "<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.27/#create-a-container\">Create a container</a> section of the <a href=\"https://docs.docker.com/engine/reference/api/docker_remote_api_v1.27/\">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>If your containers will be part of a task using the Fargate launch type, this field is optional and the only requirement is that the total amount of memory reserved for all containers within a task be lower than the task <code>memory</code> value.</p> <p>For containers that will be part of a task using the EC2 launch type, 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>", 146 "ContainerDefinition$memoryReservation": "<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.27/#create-a-container\">Create a container</a> section of the <a href=\"https://docs.docker.com/engine/reference/api/docker_remote_api_v1.27/\">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> <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>", 147 "ContainerOverride$cpu": "<p>The number of <code>cpu</code> units reserved for the container, instead of the default value from the task definition. You must also specify a container name.</p>", 148 "ContainerOverride$memory": "<p>The hard limit (in MiB) of memory to present to the container, instead of the default value from the task definition. If your container attempts to exceed the memory specified here, the container is killed. You must also specify a container name.</p>", 149 "ContainerOverride$memoryReservation": "<p>The soft limit (in MiB) of memory to reserve for the container, instead of the default value from the task definition. You must also specify a container name.</p>", 150 "ContainerStateChange$exitCode": "<p>The exit code for the container, if the state change is a result of the container exiting.</p>", 151 "CreateServiceRequest$desiredCount": "<p>The number of instantiations of the specified task definition to place and keep running on your cluster.</p>", 152 "CreateServiceRequest$healthCheckGracePeriodSeconds": "<p>The period of time, in seconds, that the Amazon ECS service scheduler should ignore unhealthy Elastic Load Balancing target health checks after a task has first started. This is only valid if your service is configured to use a load balancer. If your service's tasks take a while to start and respond to ELB health checks, you can specify a health check grace period of up to 1,800 seconds during which the ECS service scheduler will ignore ELB health check status. This grace period can prevent the ECS service scheduler from marking tasks as unhealthy and stopping them before they have time to come up.</p>", 153 "DeploymentConfiguration$maximumPercent": "<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 <code>maximumPercent</code>/100, rounded down to the nearest integer value.</p>", 154 "DeploymentConfiguration$minimumHealthyPercent": "<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 number of healthy tasks during a deployment is the <code>desiredCount</code> multiplied by <code>minimumHealthyPercent</code>/100, rounded up to the nearest integer value.</p>", 155 "ListAttributesRequest$maxResults": "<p>The maximum number of cluster results returned by <code>ListAttributes</code> in paginated output. When this parameter is used, <code>ListAttributes</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>ListAttributes</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>ListAttributes</code> returns up to 100 results and a <code>nextToken</code> value if applicable.</p>", 156 "ListClustersRequest$maxResults": "<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>", 157 "ListContainerInstancesRequest$maxResults": "<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>", 158 "ListServicesRequest$maxResults": "<p>The maximum number of service 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>", 159 "ListTaskDefinitionFamiliesRequest$maxResults": "<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>", 160 "ListTaskDefinitionsRequest$maxResults": "<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>", 161 "ListTasksRequest$maxResults": "<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>", 162 "LoadBalancer$containerPort": "<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>", 163 "NetworkBinding$containerPort": "<p>The port number on the container that is used with the network binding.</p>", 164 "NetworkBinding$hostPort": "<p>The port number on the host that is used with the network binding.</p>", 165 "PortMapping$containerPort": "<p>The port number on the container that is bound to the user-specified or automatically assigned host port.</p> <p>If using containers in a task with the <code>awsvpc</code> or <code>host</code> network mode, exposed ports should be specified using <code>containerPort</code>.</p> <p>If using containers in a task with the <code>bridge</code> network mode and 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>", 166 "PortMapping$hostPort": "<p>The port number on the container instance to reserve for your container.</p> <p>If using containers in a task with the <code>awsvpc</code> or <code>host</code> network mode, the <code>hostPort</code> can either be left blank or needs to be the same value as the <code>containerPort</code>.</p> <p>If using containers in a task with the <code>bridge</code> network mode, 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 for Docker version 1.6.0 and later is listed on the instance under <code>/proc/sys/net/ipv4/ip_local_port_range</code>; if this kernel parameter is unavailable, the default ephemeral port range from 49153 through 65535 is used. You should not attempt to specify a host port in the ephemeral port range as these are reserved for automatic assignment. In general, ports below 32768 are outside of the ephemeral port range.</p> <note> <p>The default ephemeral port range from 49153 through 65535 is always used for Docker versions before 1.6.0.</p> </note> <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>", 167 "RunTaskRequest$count": "<p>The number of instantiations of the specified task to place on your cluster. You can specify up to 10 tasks per call.</p>", 168 "Service$healthCheckGracePeriodSeconds": "<p>The period of time, in seconds, that the Amazon ECS service scheduler ignores unhealthy Elastic Load Balancing target health checks after a task has first started.</p>", 169 "SubmitContainerStateChangeRequest$exitCode": "<p>The exit code returned for the state change request.</p>", 170 "UpdateServiceRequest$desiredCount": "<p>The number of instantiations of the task to place and keep running in your service.</p>", 171 "UpdateServiceRequest$healthCheckGracePeriodSeconds": "<p>The period of time, in seconds, that the Amazon ECS service scheduler should ignore unhealthy Elastic Load Balancing target health checks after a task has first started. This is only valid if your service is configured to use a load balancer. If your service's tasks take a while to start and respond to ELB health checks, you can specify a health check grace period of up to 1,800 seconds during which the ECS service scheduler will ignore ELB health check status. This grace period can prevent the ECS service scheduler from marking tasks as unhealthy and stopping them before they have time to come up.</p>" 172 } 173 }, 174 "ClientException": { 175 "base": "<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 permissions to use the action or resource, or specifying an identifier that is not valid.</p>", 176 "refs": { 177 } 178 }, 179 "Cluster": { 180 "base": "<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>", 181 "refs": { 182 "Clusters$member": null, 183 "CreateClusterResponse$cluster": "<p>The full description of your new cluster.</p>", 184 "DeleteClusterResponse$cluster": "<p>The full description of the deleted cluster.</p>" 185 } 186 }, 187 "ClusterContainsContainerInstancesException": { 188 "base": "<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>", 189 "refs": { 190 } 191 }, 192 "ClusterContainsServicesException": { 193 "base": "<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>", 194 "refs": { 195 } 196 }, 197 "ClusterContainsTasksException": { 198 "base": "<p>You cannot delete a cluster that has active tasks.</p>", 199 "refs": { 200 } 201 }, 202 "ClusterField": { 203 "base": null, 204 "refs": { 205 "ClusterFieldList$member": null 206 } 207 }, 208 "ClusterFieldList": { 209 "base": null, 210 "refs": { 211 "DescribeClustersRequest$include": "<p>Additional information about your clusters to be separated by launch type, including:</p> <ul> <li> <p>runningEC2TasksCount</p> </li> <li> <p>runningFargateTasksCount</p> </li> <li> <p>pendingEC2TasksCount</p> </li> <li> <p>pendingFargateTasksCount</p> </li> <li> <p>activeEC2ServiceCount</p> </li> <li> <p>activeFargateServiceCount</p> </li> <li> <p>drainingEC2ServiceCount</p> </li> <li> <p>drainingFargateServiceCount</p> </li> </ul>" 212 } 213 }, 214 "ClusterNotFoundException": { 215 "base": "<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>", 216 "refs": { 217 } 218 }, 219 "Clusters": { 220 "base": null, 221 "refs": { 222 "DescribeClustersResponse$clusters": "<p>The list of clusters.</p>" 223 } 224 }, 225 "Compatibility": { 226 "base": null, 227 "refs": { 228 "CompatibilityList$member": null 229 } 230 }, 231 "CompatibilityList": { 232 "base": null, 233 "refs": { 234 "RegisterTaskDefinitionRequest$requiresCompatibilities": "<p>The launch type required by the task. If no value is specified, it defaults to <code>EC2</code>.</p>", 235 "TaskDefinition$compatibilities": "<p>The launch type to use with your task. For more information, see <a href=\"http://docs.aws.amazon.com/AmazonECS/latest/developerguide/launch_types.html\">Amazon ECS Launch Types</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p>", 236 "TaskDefinition$requiresCompatibilities": "<p>The launch type the task is using.</p>" 237 } 238 }, 239 "Connectivity": { 240 "base": null, 241 "refs": { 242 "Task$connectivity": "<p>The connectivity status of a task.</p>" 243 } 244 }, 245 "Container": { 246 "base": "<p>A Docker container that is part of a task.</p>", 247 "refs": { 248 "Containers$member": null 249 } 250 }, 251 "ContainerDefinition": { 252 "base": "<p>Container definitions are used in task definitions to describe the different containers that are launched as part of a task.</p>", 253 "refs": { 254 "ContainerDefinitions$member": null 255 } 256 }, 257 "ContainerDefinitions": { 258 "base": null, 259 "refs": { 260 "RegisterTaskDefinitionRequest$containerDefinitions": "<p>A list of container definitions in JSON format that describe the different containers that make up your task.</p>", 261 "TaskDefinition$containerDefinitions": "<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 Elastic Container Service Developer Guide</i>.</p>" 262 } 263 }, 264 "ContainerInstance": { 265 "base": "<p>An EC2 instance that is running the Amazon ECS agent and has been registered with a cluster.</p>", 266 "refs": { 267 "ContainerInstances$member": null, 268 "DeregisterContainerInstanceResponse$containerInstance": "<p>The container instance that was deregistered.</p>", 269 "RegisterContainerInstanceResponse$containerInstance": "<p>The container instance that was registered.</p>", 270 "UpdateContainerAgentResponse$containerInstance": "<p>The container instance for which the container agent was updated.</p>" 271 } 272 }, 273 "ContainerInstanceStatus": { 274 "base": null, 275 "refs": { 276 "ListContainerInstancesRequest$status": "<p>Filters the container instances by status. For example, if you specify the <code>DRAINING</code> status, the results include only container instances that have been set to <code>DRAINING</code> using <a>UpdateContainerInstancesState</a>. If you do not specify this parameter, the default is to include container instances set to <code>ACTIVE</code> and <code>DRAINING</code>.</p>", 277 "UpdateContainerInstancesStateRequest$status": "<p>The container instance state with which to update the container instance.</p>" 278 } 279 }, 280 "ContainerInstances": { 281 "base": null, 282 "refs": { 283 "DescribeContainerInstancesResponse$containerInstances": "<p>The list of container instances.</p>", 284 "UpdateContainerInstancesStateResponse$containerInstances": "<p>The list of container instances.</p>" 285 } 286 }, 287 "ContainerOverride": { 288 "base": "<p>The overrides that should be sent to a container.</p>", 289 "refs": { 290 "ContainerOverrides$member": null 291 } 292 }, 293 "ContainerOverrides": { 294 "base": null, 295 "refs": { 296 "TaskOverride$containerOverrides": "<p>One or more container overrides sent to a task.</p>" 297 } 298 }, 299 "ContainerStateChange": { 300 "base": "<p>An object representing a change in state for a container.</p>", 301 "refs": { 302 "ContainerStateChanges$member": null 303 } 304 }, 305 "ContainerStateChanges": { 306 "base": null, 307 "refs": { 308 "SubmitTaskStateChangeRequest$containers": "<p>Any containers associated with the state change request.</p>" 309 } 310 }, 311 "Containers": { 312 "base": null, 313 "refs": { 314 "Task$containers": "<p>The containers associated with the task.</p>" 315 } 316 }, 317 "CreateClusterRequest": { 318 "base": null, 319 "refs": { 320 } 321 }, 322 "CreateClusterResponse": { 323 "base": null, 324 "refs": { 325 } 326 }, 327 "CreateServiceRequest": { 328 "base": null, 329 "refs": { 330 } 331 }, 332 "CreateServiceResponse": { 333 "base": null, 334 "refs": { 335 } 336 }, 337 "DeleteAttributesRequest": { 338 "base": null, 339 "refs": { 340 } 341 }, 342 "DeleteAttributesResponse": { 343 "base": null, 344 "refs": { 345 } 346 }, 347 "DeleteClusterRequest": { 348 "base": null, 349 "refs": { 350 } 351 }, 352 "DeleteClusterResponse": { 353 "base": null, 354 "refs": { 355 } 356 }, 357 "DeleteServiceRequest": { 358 "base": null, 359 "refs": { 360 } 361 }, 362 "DeleteServiceResponse": { 363 "base": null, 364 "refs": { 365 } 366 }, 367 "Deployment": { 368 "base": "<p>The details of an Amazon ECS service deployment.</p>", 369 "refs": { 370 "Deployments$member": null 371 } 372 }, 373 "DeploymentConfiguration": { 374 "base": "<p>Optional deployment parameters that control how many tasks run during the deployment and the ordering of stopping and starting tasks.</p>", 375 "refs": { 376 "CreateServiceRequest$deploymentConfiguration": "<p>Optional deployment parameters that control how many tasks run during the deployment and the ordering of stopping and starting tasks.</p>", 377 "Service$deploymentConfiguration": "<p>Optional deployment parameters that control how many tasks run during the deployment and the ordering of stopping and starting tasks.</p>", 378 "UpdateServiceRequest$deploymentConfiguration": "<p>Optional deployment parameters that control how many tasks run during the deployment and the ordering of stopping and starting tasks.</p>" 379 } 380 }, 381 "Deployments": { 382 "base": null, 383 "refs": { 384 "Service$deployments": "<p>The current state of deployments for the service.</p>" 385 } 386 }, 387 "DeregisterContainerInstanceRequest": { 388 "base": null, 389 "refs": { 390 } 391 }, 392 "DeregisterContainerInstanceResponse": { 393 "base": null, 394 "refs": { 395 } 396 }, 397 "DeregisterTaskDefinitionRequest": { 398 "base": null, 399 "refs": { 400 } 401 }, 402 "DeregisterTaskDefinitionResponse": { 403 "base": null, 404 "refs": { 405 } 406 }, 407 "DescribeClustersRequest": { 408 "base": null, 409 "refs": { 410 } 411 }, 412 "DescribeClustersResponse": { 413 "base": null, 414 "refs": { 415 } 416 }, 417 "DescribeContainerInstancesRequest": { 418 "base": null, 419 "refs": { 420 } 421 }, 422 "DescribeContainerInstancesResponse": { 423 "base": null, 424 "refs": { 425 } 426 }, 427 "DescribeServicesRequest": { 428 "base": null, 429 "refs": { 430 } 431 }, 432 "DescribeServicesResponse": { 433 "base": null, 434 "refs": { 435 } 436 }, 437 "DescribeTaskDefinitionRequest": { 438 "base": null, 439 "refs": { 440 } 441 }, 442 "DescribeTaskDefinitionResponse": { 443 "base": null, 444 "refs": { 445 } 446 }, 447 "DescribeTasksRequest": { 448 "base": null, 449 "refs": { 450 } 451 }, 452 "DescribeTasksResponse": { 453 "base": null, 454 "refs": { 455 } 456 }, 457 "DesiredStatus": { 458 "base": null, 459 "refs": { 460 "ListTasksRequest$desiredStatus": "<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 Amazon 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 Amazon 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 does not return any results because Amazon 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>" 461 } 462 }, 463 "Device": { 464 "base": "<p>An object representing a container instance host device.</p>", 465 "refs": { 466 "DevicesList$member": null 467 } 468 }, 469 "DeviceCgroupPermission": { 470 "base": null, 471 "refs": { 472 "DeviceCgroupPermissions$member": null 473 } 474 }, 475 "DeviceCgroupPermissions": { 476 "base": null, 477 "refs": { 478 "Device$permissions": "<p>The explicit permissions to provide to the container for the device. By default, the container has permissions for <code>read</code>, <code>write</code>, and <code>mknod</code> for the device.</p>" 479 } 480 }, 481 "DevicesList": { 482 "base": null, 483 "refs": { 484 "LinuxParameters$devices": "<p>Any host devices to expose to the container. This parameter maps to <code>Devices</code> in the <a href=\"https://docs.docker.com/engine/reference/api/docker_remote_api_v1.27/#create-a-container\">Create a container</a> section of the <a href=\"https://docs.docker.com/engine/reference/api/docker_remote_api_v1.27/\">Docker Remote API</a> and the <code>--device</code> option to <a href=\"https://docs.docker.com/engine/reference/run/\">docker run</a>.</p>" 485 } 486 }, 487 "DiscoverPollEndpointRequest": { 488 "base": null, 489 "refs": { 490 } 491 }, 492 "DiscoverPollEndpointResponse": { 493 "base": null, 494 "refs": { 495 } 496 }, 497 "DockerLabelsMap": { 498 "base": null, 499 "refs": { 500 "ContainerDefinition$dockerLabels": "<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.27/#create-a-container\">Create a container</a> section of the <a href=\"https://docs.docker.com/engine/reference/api/docker_remote_api_v1.27/\">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 in to your container instance and run the following command: <code>sudo docker version | grep \"Server API version\"</code> </p>" 501 } 502 }, 503 "Double": { 504 "base": null, 505 "refs": { 506 "Resource$doubleValue": "<p>When the <code>doubleValue</code> type is set, the value of the resource must be a double precision floating-point type.</p>" 507 } 508 }, 509 "EnvironmentVariables": { 510 "base": null, 511 "refs": { 512 "ContainerDefinition$environment": "<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.27/#create-a-container\">Create a container</a> section of the <a href=\"https://docs.docker.com/engine/reference/api/docker_remote_api_v1.27/\">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 plaintext environment variables for sensitive information, such as credential data.</p> </important>", 513 "ContainerOverride$environment": "<p>The environment variables to send to the container. You can add new environment variables, which are added to the container at launch, or you can override the existing environment variables from the Docker image or the task definition. You must also specify a container name.</p>" 514 } 515 }, 516 "Failure": { 517 "base": "<p>A failed resource.</p>", 518 "refs": { 519 "Failures$member": null 520 } 521 }, 522 "Failures": { 523 "base": null, 524 "refs": { 525 "DescribeClustersResponse$failures": "<p>Any failures associated with the call.</p>", 526 "DescribeContainerInstancesResponse$failures": "<p>Any failures associated with the call.</p>", 527 "DescribeServicesResponse$failures": "<p>Any failures associated with the call.</p>", 528 "DescribeTasksResponse$failures": "<p>Any failures associated with the call.</p>", 529 "RunTaskResponse$failures": "<p>Any failures associated with the call.</p>", 530 "StartTaskResponse$failures": "<p>Any failures associated with the call.</p>", 531 "UpdateContainerInstancesStateResponse$failures": "<p>Any failures associated with the call.</p>" 532 } 533 }, 534 "HostEntry": { 535 "base": "<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>", 536 "refs": { 537 "HostEntryList$member": null 538 } 539 }, 540 "HostEntryList": { 541 "base": null, 542 "refs": { 543 "ContainerDefinition$extraHosts": "<p>A list of hostnames and IP address mappings to append to the <code>/etc/hosts</code> file on the container. If using the Fargate launch type, this may be used to list non-Fargate hosts you want the container to talk to. This parameter maps to <code>ExtraHosts</code> in the <a href=\"https://docs.docker.com/engine/reference/api/docker_remote_api_v1.27/#create-a-container\">Create a container</a> section of the <a href=\"https://docs.docker.com/engine/reference/api/docker_remote_api_v1.27/\">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> <note> <p>This parameter is not supported for Windows containers.</p> </note>" 544 } 545 }, 546 "HostVolumeProperties": { 547 "base": "<p>Details on a container instance host volume.</p>", 548 "refs": { 549 "Volume$host": "<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> <p>Windows containers can mount whole directories on the same drive as <code>$env:ProgramData</code>. Windows containers cannot mount directories on a different drive, and mount point cannot be across drives. For example, you can mount <code>C:\\my\\path:C:\\my\\path</code> and <code>D:\\:D:\\</code>, but not <code>D:\\my\\path:C:\\my\\path</code> or <code>D:\\:C:\\my\\path</code>.</p>" 550 } 551 }, 552 "Integer": { 553 "base": null, 554 "refs": { 555 "Cluster$registeredContainerInstancesCount": "<p>The number of container instances registered into the cluster.</p>", 556 "Cluster$runningTasksCount": "<p>The number of tasks in the cluster that are in the <code>RUNNING</code> state.</p>", 557 "Cluster$pendingTasksCount": "<p>The number of tasks in the cluster that are in the <code>PENDING</code> state.</p>", 558 "Cluster$activeServicesCount": "<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>", 559 "ContainerDefinition$cpu": "<p>The number of <code>cpu</code> units reserved for the container. This parameter maps to <code>CpuShares</code> in the <a href=\"https://docs.docker.com/engine/reference/api/docker_remote_api_v1.27/#create-a-container\">Create a container</a> section of the <a href=\"https://docs.docker.com/engine/reference/api/docker_remote_api_v1.27/\">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> <p>This field is optional for tasks using the Fargate launch type, and the only requirement is that the total amount of CPU reserved for all containers within a task be lower than the task-level <code>cpu</code> value.</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>Linux containers share unallocated CPU units with other containers on the container instance with the same ratio as their allocated amount. 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>On Linux container instances, 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 will allow 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> <p>On Windows container instances, the CPU limit is enforced as an absolute limit, or a quota. Windows containers only have access to the specified amount of CPU that is described in the task definition.</p>", 560 "ContainerInstance$runningTasksCount": "<p>The number of tasks on the container instance that are in the <code>RUNNING</code> status.</p>", 561 "ContainerInstance$pendingTasksCount": "<p>The number of tasks on the container instance that are in the <code>PENDING</code> status.</p>", 562 "Deployment$desiredCount": "<p>The most recent desired count of tasks that was specified for the service to deploy or maintain.</p>", 563 "Deployment$pendingCount": "<p>The number of tasks in the deployment that are in the <code>PENDING</code> status.</p>", 564 "Deployment$runningCount": "<p>The number of tasks in the deployment that are in the <code>RUNNING</code> status.</p>", 565 "Resource$integerValue": "<p>When the <code>integerValue</code> type is set, the value of the resource must be an integer.</p>", 566 "Service$desiredCount": "<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>", 567 "Service$runningCount": "<p>The number of tasks in the cluster that are in the <code>RUNNING</code> state.</p>", 568 "Service$pendingCount": "<p>The number of tasks in the cluster that are in the <code>PENDING</code> state.</p>", 569 "TaskDefinition$revision": "<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>", 570 "Ulimit$softLimit": "<p>The soft limit for the ulimit type.</p>", 571 "Ulimit$hardLimit": "<p>The hard limit for the ulimit type.</p>" 572 } 573 }, 574 "InvalidParameterException": { 575 "base": "<p>The specified parameter is invalid. Review the available parameters for the API request.</p>", 576 "refs": { 577 } 578 }, 579 "KernelCapabilities": { 580 "base": "<p>The Linux capabilities for the container that are added to or dropped from the default configuration provided by Docker. For more information on the default capabilities and the non-default available capabilities, see <a href=\"https://docs.docker.com/engine/reference/run/#runtime-privilege-and-linux-capabilities\">Runtime privilege and Linux capabilities</a> in the <i>Docker run reference</i>. For more detailed information on these Linux capabilities, see the <a href=\"http://man7.org/linux/man-pages/man7/capabilities.7.html\">capabilities(7)</a> Linux manual page.</p>", 581 "refs": { 582 "LinuxParameters$capabilities": "<p>The Linux capabilities for the container that are added to or dropped from the default configuration provided by Docker.</p>" 583 } 584 }, 585 "KeyValuePair": { 586 "base": "<p>A key and value pair object.</p>", 587 "refs": { 588 "AttachmentDetails$member": null, 589 "EnvironmentVariables$member": null, 590 "Statistics$member": null 591 } 592 }, 593 "LaunchType": { 594 "base": null, 595 "refs": { 596 "CreateServiceRequest$launchType": "<p>The launch type on which to run your service.</p>", 597 "Deployment$launchType": "<p>The launch type on which your service is running.</p>", 598 "ListServicesRequest$launchType": "<p>The launch type for services you want to list.</p>", 599 "ListTasksRequest$launchType": "<p>The launch type for services you want to list.</p>", 600 "RunTaskRequest$launchType": "<p>The launch type on which to run your task.</p>", 601 "Service$launchType": "<p>The launch type on which your service is running.</p>", 602 "Task$launchType": "<p>The launch type on which your task is running.</p>" 603 } 604 }, 605 "LinuxParameters": { 606 "base": "<p>Linux-specific options that are applied to the container, such as Linux <a>KernelCapabilities</a>.</p>", 607 "refs": { 608 "ContainerDefinition$linuxParameters": "<p>Linux-specific modifications that are applied to the container, such as Linux <a>KernelCapabilities</a>.</p> <note> <p>This parameter is not supported for Windows containers or tasks using the Fargate launch type.</p> </note>" 609 } 610 }, 611 "ListAttributesRequest": { 612 "base": null, 613 "refs": { 614 } 615 }, 616 "ListAttributesResponse": { 617 "base": null, 618 "refs": { 619 } 620 }, 621 "ListClustersRequest": { 622 "base": null, 623 "refs": { 624 } 625 }, 626 "ListClustersResponse": { 627 "base": null, 628 "refs": { 629 } 630 }, 631 "ListContainerInstancesRequest": { 632 "base": null, 633 "refs": { 634 } 635 }, 636 "ListContainerInstancesResponse": { 637 "base": null, 638 "refs": { 639 } 640 }, 641 "ListServicesRequest": { 642 "base": null, 643 "refs": { 644 } 645 }, 646 "ListServicesResponse": { 647 "base": null, 648 "refs": { 649 } 650 }, 651 "ListTaskDefinitionFamiliesRequest": { 652 "base": null, 653 "refs": { 654 } 655 }, 656 "ListTaskDefinitionFamiliesResponse": { 657 "base": null, 658 "refs": { 659 } 660 }, 661 "ListTaskDefinitionsRequest": { 662 "base": null, 663 "refs": { 664 } 665 }, 666 "ListTaskDefinitionsResponse": { 667 "base": null, 668 "refs": { 669 } 670 }, 671 "ListTasksRequest": { 672 "base": null, 673 "refs": { 674 } 675 }, 676 "ListTasksResponse": { 677 "base": null, 678 "refs": { 679 } 680 }, 681 "LoadBalancer": { 682 "base": "<p>Details on a load balancer that is used with a service.</p>", 683 "refs": { 684 "LoadBalancers$member": null 685 } 686 }, 687 "LoadBalancers": { 688 "base": null, 689 "refs": { 690 "CreateServiceRequest$loadBalancers": "<p>A load balancer object representing the load balancer to use with your service. Currently, you are limited to one load balancer or target group per service. After you create a service, the load balancer name or target group ARN, container name, and container port specified in the service definition are immutable.</p> <p>For 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 Application Load Balancers and Network 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>", 691 "Service$loadBalancers": "<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>" 692 } 693 }, 694 "LogConfiguration": { 695 "base": "<p>Log configuration options to send to a custom log driver for the container.</p>", 696 "refs": { 697 "ContainerDefinition$logConfiguration": "<p>The log configuration specification for the container.</p> <p>If using the Fargate launch type, the only supported value is <code>awslogs</code>.</p> <p>This parameter maps to <code>LogConfig</code> in the <a href=\"https://docs.docker.com/engine/reference/api/docker_remote_api_v1.27/#create-a-container\">Create a container</a> section of the <a href=\"https://docs.docker.com/engine/reference/api/docker_remote_api_v1.27/\">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). Additional 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 in to 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 Elastic Container Service Developer Guide</i>.</p> </note>" 698 } 699 }, 700 "LogConfigurationOptionsMap": { 701 "base": null, 702 "refs": { 703 "LogConfiguration$options": "<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 in to your container instance and run the following command: <code>sudo docker version | grep \"Server API version\"</code> </p>" 704 } 705 }, 706 "LogDriver": { 707 "base": null, 708 "refs": { 709 "LogConfiguration$logDriver": "<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. If using the Fargate launch type, the only supported value is <code>awslogs</code>. For more information about using the <code>awslogs</code> driver, see <a href=\"http://docs.aws.amazon.com/AmazonECS/latest/developerguide/using_awslogs.html\">Using the awslogs Log Driver</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</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 support 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 in to your container instance and run the following command: <code>sudo docker version | grep \"Server API version\"</code> </p>" 710 } 711 }, 712 "Long": { 713 "base": null, 714 "refs": { 715 "ContainerInstance$version": "<p>The version counter for the container instance. Every time a container instance experiences a change that triggers a CloudWatch event, the version counter is incremented. If you are replicating your Amazon ECS container instance state with CloudWatch Events, you can compare the version of a container instance reported by the Amazon ECS APIs with the version reported in CloudWatch Events for the container instance (inside the <code>detail</code> object) to verify that the version in your event stream is current.</p>", 716 "Resource$longValue": "<p>When the <code>longValue</code> type is set, the value of the resource must be an extended precision floating-point type.</p>", 717 "Task$version": "<p>The version counter for the task. Every time a task experiences a change that triggers a CloudWatch event, the version counter is incremented. If you are replicating your Amazon ECS task state with CloudWatch Events, you can compare the version of a task reported by the Amazon ECS APIs with the version reported in CloudWatch Events for the task (inside the <code>detail</code> object) to verify that the version in your event stream is current.</p>" 718 } 719 }, 720 "MissingVersionException": { 721 "base": "<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>", 722 "refs": { 723 } 724 }, 725 "MountPoint": { 726 "base": "<p>Details on a volume mount point that is used in a container definition.</p>", 727 "refs": { 728 "MountPointList$member": null 729 } 730 }, 731 "MountPointList": { 732 "base": null, 733 "refs": { 734 "ContainerDefinition$mountPoints": "<p>The mount points for data volumes in your container.</p> <p>This parameter maps to <code>Volumes</code> in the <a href=\"https://docs.docker.com/engine/reference/api/docker_remote_api_v1.27/#create-a-container\">Create a container</a> section of the <a href=\"https://docs.docker.com/engine/reference/api/docker_remote_api_v1.27/\">Docker Remote API</a> and the <code>--volume</code> option to <a href=\"https://docs.docker.com/engine/reference/run/\">docker run</a>.</p> <p>Windows containers can mount whole directories on the same drive as <code>$env:ProgramData</code>. Windows containers cannot mount directories on a different drive, and mount point cannot be across drives.</p>" 735 } 736 }, 737 "NetworkBinding": { 738 "base": "<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>", 739 "refs": { 740 "NetworkBindings$member": null 741 } 742 }, 743 "NetworkBindings": { 744 "base": null, 745 "refs": { 746 "Container$networkBindings": "<p>The network bindings associated with the container.</p>", 747 "ContainerStateChange$networkBindings": "<p>Any network bindings associated with the container.</p>", 748 "SubmitContainerStateChangeRequest$networkBindings": "<p>The network bindings of the container.</p>" 749 } 750 }, 751 "NetworkConfiguration": { 752 "base": "<p>An object representing the network configuration for a task or service.</p>", 753 "refs": { 754 "CreateServiceRequest$networkConfiguration": "<p>The network configuration for the service. This parameter is required for task definitions that use the <code>awsvpc</code> network mode to receive their own Elastic Network Interface, and it is not supported for other network modes. For more information, see <a href=\"http://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-networking.html\">Task Networking</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p>", 755 "Deployment$networkConfiguration": "<p>The VPC subnet and security group configuration for tasks that receive their own Elastic Network Interface by using the <code>awsvpc</code> networking mode.</p>", 756 "RunTaskRequest$networkConfiguration": "<p>The network configuration for the task. This parameter is required for task definitions that use the <code>awsvpc</code> network mode to receive their own Elastic Network Interface, and it is not supported for other network modes. For more information, see <a href=\"http://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-networking.html\">Task Networking</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p>", 757 "Service$networkConfiguration": "<p>The VPC subnet and security group configuration for tasks that receive their own Elastic Network Interface by using the <code>awsvpc</code> networking mode.</p>", 758 "StartTaskRequest$networkConfiguration": "<p>The VPC subnet and security group configuration for tasks that receive their own Elastic Network Interface by using the <code>awsvpc</code> networking mode.</p>", 759 "UpdateServiceRequest$networkConfiguration": "<p>The network configuration for the service. This parameter is required for task definitions that use the <code>awsvpc</code> network mode to receive their own Elastic Network Interface, and it is not supported for other network modes. For more information, see <a href=\"http://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-networking.html\">Task Networking</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p> <note> <p>Updating a service to add a subnet to a list of existing subnets does not trigger a service deployment. For example, if your network configuration change is to keep the existing subnets and simply add another subnet to the network configuration, this does not trigger a new service deployment.</p> </note>" 760 } 761 }, 762 "NetworkInterface": { 763 "base": "<p>An object representing the Elastic Network Interface for tasks that use the <code>awsvpc</code> network mode.</p>", 764 "refs": { 765 "NetworkInterfaces$member": null 766 } 767 }, 768 "NetworkInterfaces": { 769 "base": null, 770 "refs": { 771 "Container$networkInterfaces": "<p>The network interfaces associated with the container.</p>" 772 } 773 }, 774 "NetworkMode": { 775 "base": null, 776 "refs": { 777 "RegisterTaskDefinitionRequest$networkMode": "<p>The Docker networking mode to use for the containers in the task. The valid values are <code>none</code>, <code>bridge</code>, <code>awsvpc</code>, and <code>host</code>. The default Docker network mode is <code>bridge</code>. If using the Fargate launch type, the <code>awsvpc</code> network mode is required. If using the EC2 launch type, any network mode can be used. If the network mode is set to <code>none</code>, you can't specify port mappings in your container definitions, and the task's containers do not have external connectivity. The <code>host</code> and <code>awsvpc</code> network modes offer the highest networking performance for containers because they use the EC2 network stack instead of the virtualized network stack provided by the <code>bridge</code> mode.</p> <p>With the <code>host</code> and <code>awsvpc</code> network modes, exposed container ports are mapped directly to the corresponding host port (for the <code>host</code> network mode) or the attached elastic network interface port (for the <code>awsvpc</code> network mode), so you cannot take advantage of dynamic host port mappings. </p> <p>If the network mode is <code>awsvpc</code>, the task is allocated an Elastic Network Interface, and you must specify a <a>NetworkConfiguration</a> when you create a service or run a task with the task definition. For more information, see <a href=\"http://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-networking.html\">Task Networking</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p> <p>If the network mode is <code>host</code>, you can't run multiple instantiations of the same task on a single container instance when port mappings are used.</p> <p>Docker for Windows uses different network modes than Docker for Linux. When you register a task definition with Windows containers, you must not specify a network 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>", 778 "TaskDefinition$networkMode": "<p>The Docker networking mode to use for the containers in the task. The valid values are <code>none</code>, <code>bridge</code>, <code>awsvpc</code>, and <code>host</code>. The default Docker network mode is <code>bridge</code>. If using the Fargate launch type, the <code>awsvpc</code> network mode is required. If using the EC2 launch type, any network mode can be used. If the network mode is set to <code>none</code>, you can't specify port mappings in your container definitions, and the task's containers do not have external connectivity. The <code>host</code> and <code>awsvpc</code> network modes offer the highest networking performance for containers because they use the EC2 network stack instead of the virtualized network stack provided by the <code>bridge</code> mode.</p> <p>With the <code>host</code> and <code>awsvpc</code> network modes, exposed container ports are mapped directly to the corresponding host port (for the <code>host</code> network mode) or the attached elastic network interface port (for the <code>awsvpc</code> network mode), so you cannot take advantage of dynamic host port mappings. </p> <p>If the network mode is <code>awsvpc</code>, the task is allocated an Elastic Network Interface, and you must specify a <a>NetworkConfiguration</a> when you create a service or run a task with the task definition. For more information, see <a href=\"http://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-networking.html\">Task Networking</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p> <note> <p>Currently, only the Amazon ECS-optimized AMI, other Amazon Linux variants with the <code>ecs-init</code> package, or AWS Fargate infrastructure support the <code>awsvpc</code> network mode. </p> </note> <p>If the network mode is <code>host</code>, you can't run multiple instantiations of the same task on a single container instance when port mappings are used.</p> <p>Docker for Windows uses different network modes than Docker for Linux. When you register a task definition with Windows containers, you must not specify a network mode. If you use the console to register a task definition with Windows containers, you must choose the <code><default></code> network mode object. </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>" 779 } 780 }, 781 "NoUpdateAvailableException": { 782 "base": "<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>", 783 "refs": { 784 } 785 }, 786 "PlacementConstraint": { 787 "base": "<p>An object representing a constraint on task placement. For more information, see <a href=\"http://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-placement-constraints.html\">Task Placement Constraints</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p>", 788 "refs": { 789 "PlacementConstraints$member": null 790 } 791 }, 792 "PlacementConstraintType": { 793 "base": null, 794 "refs": { 795 "PlacementConstraint$type": "<p>The type of constraint. Use <code>distinctInstance</code> to ensure that each task in a particular group is running on a different container instance. Use <code>memberOf</code> to restrict the selection to a group of valid candidates. The value <code>distinctInstance</code> is not supported in task definitions.</p>" 796 } 797 }, 798 "PlacementConstraints": { 799 "base": null, 800 "refs": { 801 "CreateServiceRequest$placementConstraints": "<p>An array of placement constraint objects to use for tasks in your service. You can specify a maximum of 10 constraints per task (this limit includes constraints in the task definition and those specified at run time). </p>", 802 "RunTaskRequest$placementConstraints": "<p>An array of placement constraint objects to use for the task. You can specify up to 10 constraints per task (including constraints in the task definition and those specified at run time).</p>", 803 "Service$placementConstraints": "<p>The placement constraints for the tasks in the service.</p>" 804 } 805 }, 806 "PlacementStrategies": { 807 "base": null, 808 "refs": { 809 "CreateServiceRequest$placementStrategy": "<p>The placement strategy objects to use for tasks in your service. You can specify a maximum of five strategy rules per service.</p>", 810 "RunTaskRequest$placementStrategy": "<p>The placement strategy objects to use for the task. You can specify a maximum of five strategy rules per task.</p>", 811 "Service$placementStrategy": "<p>The placement strategy that determines how tasks for the service are placed.</p>" 812 } 813 }, 814 "PlacementStrategy": { 815 "base": "<p>The task placement strategy for a task or service. For more information, see <a href=\"http://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-placement-strategies.html\">Task Placement Strategies</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p>", 816 "refs": { 817 "PlacementStrategies$member": null 818 } 819 }, 820 "PlacementStrategyType": { 821 "base": null, 822 "refs": { 823 "PlacementStrategy$type": "<p>The type of placement strategy. The <code>random</code> placement strategy randomly places tasks on available candidates. The <code>spread</code> placement strategy spreads placement across available candidates evenly based on the <code>field</code> parameter. The <code>binpack</code> strategy places tasks on available candidates that have the least available amount of the resource that is specified with the <code>field</code> parameter. For example, if you binpack on memory, a task is placed on the instance with the least amount of remaining memory (but still enough to run the task).</p>" 824 } 825 }, 826 "PlatformTaskDefinitionIncompatibilityException": { 827 "base": "<p>The specified platform version does not satisfy the task definition’s required capabilities.</p>", 828 "refs": { 829 } 830 }, 831 "PlatformUnknownException": { 832 "base": "<p>The specified platform version does not exist.</p>", 833 "refs": { 834 } 835 }, 836 "PortMapping": { 837 "base": "<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.</p> <p>If using containers in a task with the <code>awsvpc</code> or <code>host</code> network mode, exposed ports should be specified using <code>containerPort</code>. The <code>hostPort</code> can be left blank or it must be the same value as the <code>containerPort</code>.</p> <p>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>", 838 "refs": { 839 "PortMappingList$member": null 840 } 841 }, 842 "PortMappingList": { 843 "base": null, 844 "refs": { 845 "ContainerDefinition$portMappings": "<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.</p> <p>For task definitions that use the <code>awsvpc</code> network mode, you should only specify the <code>containerPort</code>. The <code>hostPort</code> can be left blank or it must be the same value as the <code>containerPort</code>.</p> <p>Port mappings on Windows use the <code>NetNAT</code> gateway address rather than <code>localhost</code>. There is no loopback for port mappings on Windows, so you cannot access a container's mapped port from the host itself. </p> <p>This parameter maps to <code>PortBindings</code> in the <a href=\"https://docs.docker.com/engine/reference/api/docker_remote_api_v1.27/#create-a-container\">Create a container</a> section of the <a href=\"https://docs.docker.com/engine/reference/api/docker_remote_api_v1.27/\">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 can't 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 for a selected task in the Amazon ECS console, or the <code>networkBindings</code> section <a>DescribeTasks</a> responses.</p> </note>" 846 } 847 }, 848 "PutAttributesRequest": { 849 "base": null, 850 "refs": { 851 } 852 }, 853 "PutAttributesResponse": { 854 "base": null, 855 "refs": { 856 } 857 }, 858 "RegisterContainerInstanceRequest": { 859 "base": null, 860 "refs": { 861 } 862 }, 863 "RegisterContainerInstanceResponse": { 864 "base": null, 865 "refs": { 866 } 867 }, 868 "RegisterTaskDefinitionRequest": { 869 "base": null, 870 "refs": { 871 } 872 }, 873 "RegisterTaskDefinitionResponse": { 874 "base": null, 875 "refs": { 876 } 877 }, 878 "RequiresAttributes": { 879 "base": null, 880 "refs": { 881 "TaskDefinition$requiresAttributes": "<p>The container instance attributes required by your task. This field is not valid if using the Fargate launch type for your task.</p>" 882 } 883 }, 884 "Resource": { 885 "base": "<p>Describes the resources available for a container instance.</p>", 886 "refs": { 887 "Resources$member": null 888 } 889 }, 890 "Resources": { 891 "base": null, 892 "refs": { 893 "ContainerInstance$remainingResources": "<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>", 894 "ContainerInstance$registeredResources": "<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>", 895 "RegisterContainerInstanceRequest$totalResources": "<p>The resources available on the instance.</p>" 896 } 897 }, 898 "RunTaskRequest": { 899 "base": null, 900 "refs": { 901 } 902 }, 903 "RunTaskResponse": { 904 "base": null, 905 "refs": { 906 } 907 }, 908 "ServerException": { 909 "base": "<p>These errors are usually caused by a server issue.</p>", 910 "refs": { 911 } 912 }, 913 "Service": { 914 "base": "<p>Details on a service within a cluster</p>", 915 "refs": { 916 "CreateServiceResponse$service": "<p>The full description of your service following the create call.</p>", 917 "DeleteServiceResponse$service": "<p>The full description of the deleted service.</p>", 918 "Services$member": null, 919 "UpdateServiceResponse$service": "<p>The full description of your service following the update call.</p>" 920 } 921 }, 922 "ServiceEvent": { 923 "base": "<p>Details on an event associated with a service.</p>", 924 "refs": { 925 "ServiceEvents$member": null 926 } 927 }, 928 "ServiceEvents": { 929 "base": null, 930 "refs": { 931 "Service$events": "<p>The event stream for your service. A maximum of 100 of the latest events are displayed.</p>" 932 } 933 }, 934 "ServiceNotActiveException": { 935 "base": "<p>The specified service is not active. You can't update a service that is inactive. If you have previously deleted a service, you can re-create it with <a>CreateService</a>.</p>", 936 "refs": { 937 } 938 }, 939 "ServiceNotFoundException": { 940 "base": "<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>", 941 "refs": { 942 } 943 }, 944 "Services": { 945 "base": null, 946 "refs": { 947 "DescribeServicesResponse$services": "<p>The list of services described.</p>" 948 } 949 }, 950 "SortOrder": { 951 "base": null, 952 "refs": { 953 "ListTaskDefinitionsRequest$sort": "<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>" 954 } 955 }, 956 "StartTaskRequest": { 957 "base": null, 958 "refs": { 959 } 960 }, 961 "StartTaskResponse": { 962 "base": null, 963 "refs": { 964 } 965 }, 966 "Statistics": { 967 "base": null, 968 "refs": { 969 "Cluster$statistics": "<p>Additional information about your clusters that are separated by launch type, including:</p> <ul> <li> <p>runningEC2TasksCount</p> </li> <li> <p>RunningFargateTasksCount</p> </li> <li> <p>pendingEC2TasksCount</p> </li> <li> <p>pendingFargateTasksCount</p> </li> <li> <p>activeEC2ServiceCount</p> </li> <li> <p>activeFargateServiceCount</p> </li> <li> <p>drainingEC2ServiceCount</p> </li> <li> <p>drainingFargateServiceCount</p> </li> </ul>" 970 } 971 }, 972 "StopTaskRequest": { 973 "base": null, 974 "refs": { 975 } 976 }, 977 "StopTaskResponse": { 978 "base": null, 979 "refs": { 980 } 981 }, 982 "String": { 983 "base": null, 984 "refs": { 985 "Attachment$id": "<p>The unique identifier for the attachment.</p>", 986 "Attachment$type": "<p>The type of the attachment, such as an <code>ElasticNetworkInterface</code>.</p>", 987 "Attachment$status": "<p> The status of the attachment. Valid values are <code>PRECREATED</code>, <code>CREATED</code>, <code>ATTACHING</code>, <code>ATTACHED</code>, <code>DETACHING</code>, <code>DETACHED</code>, and <code>DELETED</code>.</p>", 988 "AttachmentStateChange$attachmentArn": "<p>The Amazon Resource Name (ARN) of the attachment.</p>", 989 "AttachmentStateChange$status": "<p>The status of the attachment.</p>", 990 "Attribute$name": "<p>The name of the attribute. Up to 128 letters (uppercase and lowercase), numbers, hyphens, underscores, and periods are allowed.</p>", 991 "Attribute$value": "<p>The value of the attribute. Up to 128 letters (uppercase and lowercase), numbers, hyphens, underscores, periods, at signs (@), forward slashes, colons, and spaces are allowed.</p>", 992 "Attribute$targetId": "<p>The ID of the target. You can specify the short form ID for a resource or the full Amazon Resource Name (ARN).</p>", 993 "ClientException$message": null, 994 "Cluster$clusterArn": "<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>", 995 "Cluster$clusterName": "<p>A user-generated string that you use to identify your cluster.</p>", 996 "Cluster$status": "<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>", 997 "Container$containerArn": "<p>The Amazon Resource Name (ARN) of the container.</p>", 998 "Container$taskArn": "<p>The ARN of the task.</p>", 999 "Container$name": "<p>The name of the container.</p>", 1000 "Container$lastStatus": "<p>The last known status of the container.</p>", 1001 "Container$reason": "<p>A short (255 max characters) human-readable string to provide additional details about a running or stopped container.</p>", 1002 "ContainerDefinition$name": "<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.27/#create-a-container\">Create a container</a> section of the <a href=\"https://docs.docker.com/engine/reference/api/docker_remote_api_v1.27/\">Docker Remote API</a> and the <code>--name</code> option to <a href=\"https://docs.docker.com/engine/reference/run/\">docker run</a>. </p>", 1003 "ContainerDefinition$image": "<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 either <code> <i>repository-url</i>/<i>image</i>:<i>tag</i> </code> or <code> <i>repository-url</i>/<i>image</i>@<i>digest</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.27/#create-a-container\">Create a container</a> section of the <a href=\"https://docs.docker.com/engine/reference/api/docker_remote_api_v1.27/\">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 Amazon ECR repositories can be specified by either using the full <code>registry/repository:tag</code> or <code>registry/repository@digest</code>. For example, <code>012345678910.dkr.ecr.<region-name>.amazonaws.com/<repository-name>:latest</code> or <code>012345678910.dkr.ecr.<region-name>.amazonaws.com/<repository-name>@sha256:94afd1f2e64d908bc90dbca0035a5b567EXAMPLE</code>. </p> </li> <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>", 1004 "ContainerDefinition$hostname": "<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.27/#create-a-container\">Create a container</a> section of the <a href=\"https://docs.docker.com/engine/reference/api/docker_remote_api_v1.27/\">Docker Remote API</a> and the <code>--hostname</code> option to <a href=\"https://docs.docker.com/engine/reference/run/\">docker run</a>.</p>", 1005 "ContainerDefinition$user": "<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.27/#create-a-container\">Create a container</a> section of the <a href=\"https://docs.docker.com/engine/reference/api/docker_remote_api_v1.27/\">Docker Remote API</a> and the <code>--user</code> option to <a href=\"https://docs.docker.com/engine/reference/run/\">docker run</a>.</p> <note> <p>This parameter is not supported for Windows containers.</p> </note>", 1006 "ContainerDefinition$workingDirectory": "<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.27/#create-a-container\">Create a container</a> section of the <a href=\"https://docs.docker.com/engine/reference/api/docker_remote_api_v1.27/\">Docker Remote API</a> and the <code>--workdir</code> option to <a href=\"https://docs.docker.com/engine/reference/run/\">docker run</a>.</p>", 1007 "ContainerInstance$containerInstanceArn": "<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>", 1008 "ContainerInstance$ec2InstanceId": "<p>The EC2 instance ID of the container instance.</p>", 1009 "ContainerInstance$status": "<p>The status of the container instance. The valid values are <code>ACTIVE</code>, <code>INACTIVE</code>, or <code>DRAINING</code>. <code>ACTIVE</code> indicates that the container instance can accept tasks. <code>DRAINING</code> indicates that new tasks are not placed on the container instance and any service tasks running on the container instance are removed if possible. For more information, see <a href=\"http://docs.aws.amazon.com/AmazonECS/latest/developerguide/container-instance-draining.html\">Container Instance Draining</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p>", 1010 "ContainerOverride$name": "<p>The name of the container that receives the override. This parameter is required if any override is specified.</p>", 1011 "ContainerStateChange$containerName": "<p>The name of the container.</p>", 1012 "ContainerStateChange$reason": "<p>The reason for the state change.</p>", 1013 "ContainerStateChange$status": "<p>The status of the container.</p>", 1014 "CreateClusterRequest$clusterName": "<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>", 1015 "CreateServiceRequest$cluster": "<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>", 1016 "CreateServiceRequest$serviceName": "<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>", 1017 "CreateServiceRequest$taskDefinition": "<p>The <code>family</code> and <code>revision</code> (<code>family:revision</code>) or full 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>", 1018 "CreateServiceRequest$clientToken": "<p>Unique, case-sensitive identifier you provide to ensure the idempotency of the request. Up to 32 ASCII characters are allowed.</p>", 1019 "CreateServiceRequest$platformVersion": "<p>The platform version on which to run your service. If one is not specified, the latest version is used by default.</p>", 1020 "CreateServiceRequest$role": "<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 only permitted if you are using a load balancer with your service and your task definition does not use the <code>awsvpc</code> network mode. If you specify the <code>role</code> parameter, you must also specify a load balancer object with the <code>loadBalancers</code> parameter.</p> <important> <p>If your account has already created the Amazon ECS service-linked role, that role is used by default for your service unless you specify a role here. The service-linked role is required if your task definition uses the <code>awsvpc</code> network mode, in which case you should not specify a role here. For more information, see <a href=\"http://docs.aws.amazon.com/AmazonECS/latest/developerguide/using-service-linked-roles.html\">Using Service-Linked Roles for Amazon ECS</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p> </important> <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>", 1021 "DeleteAttributesRequest$cluster": "<p>The short name or full Amazon Resource Name (ARN) of the cluster that contains the resource to delete attributes. If you do not specify a cluster, the default cluster is assumed.</p>", 1022 "DeleteClusterRequest$cluster": "<p>The short name or full Amazon Resource Name (ARN) of the cluster to delete.</p>", 1023 "DeleteServiceRequest$cluster": "<p>The short name or full Amazon Resource Name (ARN) of the cluster that hosts the service to delete. If you do not specify a cluster, the default cluster is assumed.</p>", 1024 "DeleteServiceRequest$service": "<p>The name of the service to delete.</p>", 1025 "Deployment$id": "<p>The ID of the deployment.</p>", 1026 "Deployment$status": "<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>", 1027 "Deployment$taskDefinition": "<p>The most recent task definition that was specified for the service to use.</p>", 1028 "Deployment$platformVersion": "<p>The platform version on which your service is running.</p>", 1029 "DeregisterContainerInstanceRequest$cluster": "<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>", 1030 "DeregisterContainerInstanceRequest$containerInstance": "<p>The container instance ID or full 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>", 1031 "DeregisterTaskDefinitionRequest$taskDefinition": "<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>", 1032 "DescribeContainerInstancesRequest$cluster": "<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>", 1033 "DescribeServicesRequest$cluster": "<p>The short name or full Amazon Resource Name (ARN)the cluster that hosts the service to describe. If you do not specify a cluster, the default cluster is assumed.</p>", 1034 "DescribeTaskDefinitionRequest$taskDefinition": "<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>", 1035 "DescribeTasksRequest$cluster": "<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>", 1036 "Device$hostPath": "<p>The path for the device on the host container instance.</p>", 1037 "Device$containerPath": "<p>The path inside the container at which to expose the host device.</p>", 1038 "DiscoverPollEndpointRequest$containerInstance": "<p>The container instance ID or full 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>", 1039 "DiscoverPollEndpointRequest$cluster": "<p>The short name or full Amazon Resource Name (ARN) of the cluster that the container instance belongs to.</p>", 1040 "DiscoverPollEndpointResponse$endpoint": "<p>The endpoint for the Amazon ECS agent to poll.</p>", 1041 "DiscoverPollEndpointResponse$telemetryEndpoint": "<p>The telemetry endpoint for the Amazon ECS agent.</p>", 1042 "DockerLabelsMap$key": null, 1043 "DockerLabelsMap$value": null, 1044 "Failure$arn": "<p>The Amazon Resource Name (ARN) of the failed resource.</p>", 1045 "Failure$reason": "<p>The reason for the failure.</p>", 1046 "HostEntry$hostname": "<p>The hostname to use in the <code>/etc/hosts</code> entry.</p>", 1047 "HostEntry$ipAddress": "<p>The IP address to use in the <code>/etc/hosts</code> entry.</p>", 1048 "HostVolumeProperties$sourcePath": "<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> <p>If you are using the Fargate launch type, the <code>sourcePath</code> parameter is not supported.</p>", 1049 "KeyValuePair$name": "<p>The name of the key value pair. For environment variables, this is the name of the environment variable.</p>", 1050 "KeyValuePair$value": "<p>The value of the key value pair. For environment variables, this is the value of the environment variable.</p>", 1051 "ListAttributesRequest$cluster": "<p>The short name or full Amazon Resource Name (ARN) of the cluster to list attributes. If you do not specify a cluster, the default cluster is assumed.</p>", 1052 "ListAttributesRequest$attributeName": "<p>The name of the attribute with which to filter the results. </p>", 1053 "ListAttributesRequest$attributeValue": "<p>The value of the attribute with which to filter results. You must also specify an attribute name to use this parameter.</p>", 1054 "ListAttributesRequest$nextToken": "<p>The <code>nextToken</code> value returned from a previous paginated <code>ListAttributes</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.</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>", 1055 "ListAttributesResponse$nextToken": "<p>The <code>nextToken</code> value to include in a future <code>ListAttributes</code> request. When the results of a <code>ListAttributes</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>", 1056 "ListClustersRequest$nextToken": "<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.</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>", 1057 "ListClustersResponse$nextToken": "<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>", 1058 "ListContainerInstancesRequest$cluster": "<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>", 1059 "ListContainerInstancesRequest$filter": "<p>You can filter the results of a <code>ListContainerInstances</code> operation with cluster query language statements. For more information, see <a href=\"http://docs.aws.amazon.com/AmazonECS/latest/developerguide/cluster-query-language.html\">Cluster Query Language</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p>", 1060 "ListContainerInstancesRequest$nextToken": "<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.</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>", 1061 "ListContainerInstancesResponse$nextToken": "<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>", 1062 "ListServicesRequest$cluster": "<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>", 1063 "ListServicesRequest$nextToken": "<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.</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>", 1064 "ListServicesResponse$nextToken": "<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>", 1065 "ListTaskDefinitionFamiliesRequest$familyPrefix": "<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>", 1066 "ListTaskDefinitionFamiliesRequest$nextToken": "<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.</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>", 1067 "ListTaskDefinitionFamiliesResponse$nextToken": "<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>", 1068 "ListTaskDefinitionsRequest$familyPrefix": "<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>", 1069 "ListTaskDefinitionsRequest$nextToken": "<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.</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>", 1070 "ListTaskDefinitionsResponse$nextToken": "<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>", 1071 "ListTasksRequest$cluster": "<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>", 1072 "ListTasksRequest$containerInstance": "<p>The container instance ID or full 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>", 1073 "ListTasksRequest$family": "<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>", 1074 "ListTasksRequest$nextToken": "<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.</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>", 1075 "ListTasksRequest$startedBy": "<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>", 1076 "ListTasksRequest$serviceName": "<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>", 1077 "ListTasksResponse$nextToken": "<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>", 1078 "LoadBalancer$targetGroupArn": "<p>The full Amazon Resource Name (ARN) of the Elastic Load Balancing target group associated with a service.</p>", 1079 "LoadBalancer$loadBalancerName": "<p>The name of a load balancer.</p>", 1080 "LoadBalancer$containerName": "<p>The name of the container (as it appears in a container definition) to associate with the load balancer.</p>", 1081 "LogConfigurationOptionsMap$key": null, 1082 "LogConfigurationOptionsMap$value": null, 1083 "MountPoint$sourceVolume": "<p>The name of the volume to mount.</p>", 1084 "MountPoint$containerPath": "<p>The path on the container to mount the host volume at.</p>", 1085 "NetworkBinding$bindIP": "<p>The IP address that the container is bound to on the container instance.</p>", 1086 "NetworkInterface$attachmentId": "<p>The attachment ID for the network interface.</p>", 1087 "NetworkInterface$privateIpv4Address": "<p>The private IPv4 address for the network interface.</p>", 1088 "NetworkInterface$ipv6Address": "<p>The private IPv6 address for the network interface.</p>", 1089 "PlacementConstraint$expression": "<p>A cluster query language expression to apply to the constraint. Note you cannot specify an expression if the constraint type is <code>distinctInstance</code>. For more information, see <a href=\"http://docs.aws.amazon.com/AmazonECS/latest/developerguide/cluster-query-language.html\">Cluster Query Language</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p>", 1090 "PlacementStrategy$field": "<p>The field to apply the placement strategy against. For the <code>spread</code> placement strategy, valid values are <code>instanceId</code> (or <code>host</code>, which has the same effect), or any platform or custom attribute that is applied to a container instance, such as <code>attribute:ecs.availability-zone</code>. For the <code>binpack</code> placement strategy, valid values are <code>cpu</code> and <code>memory</code>. For the <code>random</code> placement strategy, this field is not used.</p>", 1091 "PutAttributesRequest$cluster": "<p>The short name or full Amazon Resource Name (ARN) of the cluster that contains the resource to apply attributes. If you do not specify a cluster, the default cluster is assumed.</p>", 1092 "RegisterContainerInstanceRequest$cluster": "<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>", 1093 "RegisterContainerInstanceRequest$instanceIdentityDocument": "<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>", 1094 "RegisterContainerInstanceRequest$instanceIdentityDocumentSignature": "<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>", 1095 "RegisterContainerInstanceRequest$containerInstanceArn": "<p>The ARN of the container instance (if it was previously registered).</p>", 1096 "RegisterTaskDefinitionRequest$family": "<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>", 1097 "RegisterTaskDefinitionRequest$taskRoleArn": "<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 Elastic Container Service Developer Guide</i>.</p>", 1098 "RegisterTaskDefinitionRequest$executionRoleArn": "<p>The Amazon Resource Name (ARN) of the task execution role that the Amazon ECS container agent and the Docker daemon can assume.</p>", 1099 "RegisterTaskDefinitionRequest$cpu": "<p>The number of <code>cpu</code> units used by the task. If using the EC2 launch type, this field is optional and any value can be used.</p> <note> <p>Task-level CPU and memory parameters are ignored for Windows containers. We recommend specifying container-level resources for Windows containers.</p> </note> <p>If you are using the Fargate launch type, this field is required and you must use one of the following values, which determines your range of valid values for the <code>memory</code> parameter:</p> <ul> <li> <p>256 (.25 vCPU) - Available <code>memory</code> values: 0.5GB, 1GB, 2GB</p> </li> <li> <p>512 (.5 vCPU) - Available <code>memory</code> values: 1GB, 2GB, 3GB, 4GB</p> </li> <li> <p>1024 (1 vCPU) - Available <code>memory</code> values: 2GB, 3GB, 4GB, 5GB, 6GB, 7GB, 8GB</p> </li> <li> <p>2048 (2 vCPU) - Available <code>memory</code> values: Between 4GB and 16GB in 1GB increments</p> </li> <li> <p>4096 (4 vCPU) - Available <code>memory</code> values: Between 8GB and 30GB in 1GB increments</p> </li> </ul>", 1100 "RegisterTaskDefinitionRequest$memory": "<p>The amount (in MiB) of memory used by the task. If using the EC2 launch type, this field is optional and any value can be used.</p> <note> <p>Task-level CPU and memory parameters are ignored for Windows containers. We recommend specifying container-level resources for Windows containers.</p> </note> <p>If you are using the Fargate launch type, this field is required and you must use one of the following values, which determines your range of valid values for the <code>cpu</code> parameter:</p> <ul> <li> <p>0.5GB, 1GB, 2GB - Available <code>cpu</code> values: 256 (.25 vCPU)</p> </li> <li> <p>1GB, 2GB, 3GB, 4GB - Available <code>cpu</code> values: 512 (.5 vCPU)</p> </li> <li> <p>2GB, 3GB, 4GB, 5GB, 6GB, 7GB, 8GB - Available <code>cpu</code> values: 1024 (1 vCPU)</p> </li> <li> <p>Between 4GB and 16GB in 1GB increments - Available <code>cpu</code> values: 2048 (2 vCPU)</p> </li> <li> <p>Between 8GB and 30GB in 1GB increments - Available <code>cpu</code> values: 4096 (4 vCPU)</p> </li> </ul>", 1101 "Resource$name": "<p>The name of the resource, such as <code>cpu</code>, <code>memory</code>, <code>ports</code>, or a user-defined resource.</p>", 1102 "Resource$type": "<p>The type of the resource, such as <code>INTEGER</code>, <code>DOUBLE</code>, <code>LONG</code>, or <code>STRINGSET</code>.</p>", 1103 "RunTaskRequest$cluster": "<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>", 1104 "RunTaskRequest$taskDefinition": "<p>The <code>family</code> and <code>revision</code> (<code>family:revision</code>) or full ARN of the task definition to run. If a <code>revision</code> is not specified, the latest <code>ACTIVE</code> revision is used.</p>", 1105 "RunTaskRequest$startedBy": "<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>", 1106 "RunTaskRequest$group": "<p>The name of the task group to associate with the task. The default value is the family name of the task definition (for example, family:my-family-name).</p>", 1107 "RunTaskRequest$platformVersion": "<p>The platform version on which to run your task. If one is not specified, the latest version is used by default.</p>", 1108 "ServerException$message": null, 1109 "Service$serviceArn": "<p>The 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>", 1110 "Service$serviceName": "<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>", 1111 "Service$clusterArn": "<p>The Amazon Resource Name (ARN) of the cluster that hosts the service.</p>", 1112 "Service$status": "<p>The status of the service. The valid values are <code>ACTIVE</code>, <code>DRAINING</code>, or <code>INACTIVE</code>.</p>", 1113 "Service$platformVersion": "<p>The platform version on which your task is running. For more information, see <a href=\"http://docs.aws.amazon.com/AmazonECS/latest/developerguide/platform_versions.html\">AWS Fargate Platform Versions</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p>", 1114 "Service$taskDefinition": "<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>", 1115 "Service$roleArn": "<p>The 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>", 1116 "ServiceEvent$id": "<p>The ID string of the event.</p>", 1117 "ServiceEvent$message": "<p>The event message.</p>", 1118 "StartTaskRequest$cluster": "<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>", 1119 "StartTaskRequest$taskDefinition": "<p>The <code>family</code> and <code>revision</code> (<code>family:revision</code>) or full ARN of the task definition to start. If a <code>revision</code> is not specified, the latest <code>ACTIVE</code> revision is used.</p>", 1120 "StartTaskRequest$startedBy": "<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>", 1121 "StartTaskRequest$group": "<p>The name of the task group to associate with the task. The default value is the family name of the task definition (for example, family:my-family-name).</p>", 1122 "StopTaskRequest$cluster": "<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>", 1123 "StopTaskRequest$task": "<p>The task ID or full ARN entry of the task to stop.</p>", 1124 "StopTaskRequest$reason": "<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 appears in subsequent <a>DescribeTasks</a> API operations on this task. Up to 255 characters are allowed in this message.</p>", 1125 "StringList$member": null, 1126 "SubmitContainerStateChangeRequest$cluster": "<p>The short name or full ARN of the cluster that hosts the container.</p>", 1127 "SubmitContainerStateChangeRequest$task": "<p>The task ID or full Amazon Resource Name (ARN) of the task that hosts the container.</p>", 1128 "SubmitContainerStateChangeRequest$containerName": "<p>The name of the container.</p>", 1129 "SubmitContainerStateChangeRequest$status": "<p>The status of the state change request.</p>", 1130 "SubmitContainerStateChangeRequest$reason": "<p>The reason for the state change request.</p>", 1131 "SubmitContainerStateChangeResponse$acknowledgment": "<p>Acknowledgement of the state change.</p>", 1132 "SubmitTaskStateChangeRequest$cluster": "<p>The short name or full Amazon Resource Name (ARN) of the cluster that hosts the task.</p>", 1133 "SubmitTaskStateChangeRequest$task": "<p>The task ID or full ARN of the task in the state change request.</p>", 1134 "SubmitTaskStateChangeRequest$status": "<p>The status of the state change request.</p>", 1135 "SubmitTaskStateChangeRequest$reason": "<p>The reason for the state change request.</p>", 1136 "SubmitTaskStateChangeResponse$acknowledgment": "<p>Acknowledgement of the state change.</p>", 1137 "Task$taskArn": "<p>The Amazon Resource Name (ARN) of the task.</p>", 1138 "Task$clusterArn": "<p>The ARN of the cluster that hosts the task.</p>", 1139 "Task$taskDefinitionArn": "<p>The ARN of the task definition that creates the task.</p>", 1140 "Task$containerInstanceArn": "<p>The ARN of the container instances that host the task.</p>", 1141 "Task$lastStatus": "<p>The last known status of the task.</p>", 1142 "Task$desiredStatus": "<p>The desired status of the task.</p>", 1143 "Task$cpu": "<p>The number of <code>cpu</code> units used by the task. If using the EC2 launch type, this field is optional and any value can be used. If using the Fargate launch type, this field is required and you must use one of the following values, which determines your range of valid values for the <code>memory</code> parameter:</p> <ul> <li> <p>256 (.25 vCPU) - Available <code>memory</code> values: 0.5GB, 1GB, 2GB</p> </li> <li> <p>512 (.5 vCPU) - Available <code>memory</code> values: 1GB, 2GB, 3GB, 4GB</p> </li> <li> <p>1024 (1 vCPU) - Available <code>memory</code> values: 2GB, 3GB, 4GB, 5GB, 6GB, 7GB, 8GB</p> </li> <li> <p>2048 (2 vCPU) - Available <code>memory</code> values: Between 4GB and 16GB in 1GB increments</p> </li> <li> <p>4096 (4 vCPU) - Available <code>memory</code> values: Between 8GB and 30GB in 1GB increments</p> </li> </ul>", 1144 "Task$memory": "<p>The amount (in MiB) of memory used by the task. If using the EC2 launch type, this field is optional and any value can be used. If using the Fargate launch type, this field is required and you must use one of the following values, which determines your range of valid values for the <code>cpu</code> parameter:</p> <ul> <li> <p>0.5GB, 1GB, 2GB - Available <code>cpu</code> values: 256 (.25 vCPU)</p> </li> <li> <p>1GB, 2GB, 3GB, 4GB - Available <code>cpu</code> values: 512 (.5 vCPU)</p> </li> <li> <p>2GB, 3GB, 4GB, 5GB, 6GB, 7GB, 8GB - Available <code>cpu</code> values: 1024 (1 vCPU)</p> </li> <li> <p>Between 4GB and 16GB in 1GB increments - Available <code>cpu</code> values: 2048 (2 vCPU)</p> </li> <li> <p>Between 8GB and 30GB in 1GB increments - Available <code>cpu</code> values: 4096 (4 vCPU)</p> </li> </ul>", 1145 "Task$startedBy": "<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>", 1146 "Task$stoppedReason": "<p>The reason the task was stopped.</p>", 1147 "Task$group": "<p>The name of the task group associated with the task.</p>", 1148 "Task$platformVersion": "<p>The platform version on which your task is running. For more information, see <a href=\"http://docs.aws.amazon.com/AmazonECS/latest/developerguide/platform_versions.html\">AWS Fargate Platform Versions</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p>", 1149 "TaskDefinition$taskDefinitionArn": "<p>The full Amazon Resource Name (ARN) of the task definition.</p>", 1150 "TaskDefinition$family": "<p>The family of your task definition, used as the definition name.</p>", 1151 "TaskDefinition$taskRoleArn": "<p>The 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> <p>IAM roles for tasks on Windows require that the <code>-EnableTaskIAMRole</code> option is set when you launch the Amazon ECS-optimized Windows AMI. Your containers must also run some configuration code in order to take advantage of the feature. For more information, see <a href=\"http://docs.aws.amazon.com/AmazonECS/latest/developerguide/windows_task_IAM_roles.html\">Windows IAM Roles for Tasks</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p>", 1152 "TaskDefinition$executionRoleArn": "<p>The Amazon Resource Name (ARN) of the task execution role that the Amazon ECS container agent and the Docker daemon can assume.</p>", 1153 "TaskDefinition$cpu": "<p>The number of <code>cpu</code> units used by the task. If using the EC2 launch type, this field is optional and any value can be used. If using the Fargate launch type, this field is required and you must use one of the following values, which determines your range of valid values for the <code>memory</code> parameter:</p> <ul> <li> <p>256 (.25 vCPU) - Available <code>memory</code> values: 0.5GB, 1GB, 2GB</p> </li> <li> <p>512 (.5 vCPU) - Available <code>memory</code> values: 1GB, 2GB, 3GB, 4GB</p> </li> <li> <p>1024 (1 vCPU) - Available <code>memory</code> values: 2GB, 3GB, 4GB, 5GB, 6GB, 7GB, 8GB</p> </li> <li> <p>2048 (2 vCPU) - Available <code>memory</code> values: Between 4GB and 16GB in 1GB increments</p> </li> <li> <p>4096 (4 vCPU) - Available <code>memory</code> values: Between 8GB and 30GB in 1GB increments</p> </li> </ul>", 1154 "TaskDefinition$memory": "<p>The amount (in MiB) of memory used by the task. If using the EC2 launch type, this field is optional and any value can be used. If using the Fargate launch type, this field is required and you must use one of the following values, which determines your range of valid values for the <code>cpu</code> parameter:</p> <ul> <li> <p>0.5GB, 1GB, 2GB - Available <code>cpu</code> values: 256 (.25 vCPU)</p> </li> <li> <p>1GB, 2GB, 3GB, 4GB - Available <code>cpu</code> values: 512 (.5 vCPU)</p> </li> <li> <p>2GB, 3GB, 4GB, 5GB, 6GB, 7GB, 8GB - Available <code>cpu</code> values: 1024 (1 vCPU)</p> </li> <li> <p>Between 4GB and 16GB in 1GB increments - Available <code>cpu</code> values: 2048 (2 vCPU)</p> </li> <li> <p>Between 8GB and 30GB in 1GB increments - Available <code>cpu</code> values: 4096 (4 vCPU)</p> </li> </ul>", 1155 "TaskDefinitionPlacementConstraint$expression": "<p>A cluster query language expression to apply to the constraint. For more information, see <a href=\"http://docs.aws.amazon.com/AmazonECS/latest/developerguide/cluster-query-language.html\">Cluster Query Language</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p>", 1156 "TaskOverride$taskRoleArn": "<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>", 1157 "TaskOverride$executionRoleArn": "<p>The Amazon Resource Name (ARN) of the task execution role that the Amazon ECS container agent and the Docker daemon can assume.</p>", 1158 "UpdateContainerAgentRequest$cluster": "<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>", 1159 "UpdateContainerAgentRequest$containerInstance": "<p>The container instance ID or full ARN entries for the container instance on which you would like to update the Amazon ECS container agent.</p>", 1160 "UpdateContainerInstancesStateRequest$cluster": "<p>The short name or full Amazon Resource Name (ARN) of the cluster that hosts the container instance to update. If you do not specify a cluster, the default cluster is assumed.</p>", 1161 "UpdateServiceRequest$cluster": "<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>", 1162 "UpdateServiceRequest$service": "<p>The name of the service to update.</p>", 1163 "UpdateServiceRequest$taskDefinition": "<p>The <code>family</code> and <code>revision</code> (<code>family:revision</code>) or full 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>", 1164 "UpdateServiceRequest$platformVersion": "<p>The platform version you want to update your service to run.</p>", 1165 "VersionInfo$agentVersion": "<p>The version number of the Amazon ECS container agent.</p>", 1166 "VersionInfo$agentHash": "<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>", 1167 "VersionInfo$dockerVersion": "<p>The Docker version running on the container instance.</p>", 1168 "Volume$name": "<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>", 1169 "VolumeFrom$sourceContainer": "<p>The name of another container within the same task definition to mount volumes from.</p>" 1170 } 1171 }, 1172 "StringList": { 1173 "base": null, 1174 "refs": { 1175 "AwsVpcConfiguration$subnets": "<p>The subnets associated with the task or service.</p>", 1176 "AwsVpcConfiguration$securityGroups": "<p>The security groups associated with the task or service. If you do not specify a security group, the default security group for the VPC is used.</p>", 1177 "ContainerDefinition$links": "<p>The <code>link</code> parameter allows containers to communicate with each other without the need for port mappings. Only supported if the network mode of a task definition is set to <code>bridge</code>. The <code>name:internalName</code> 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 more information about linking Docker containers, go to <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.27/#create-a-container\">Create a container</a> section of the <a href=\"https://docs.docker.com/engine/reference/api/docker_remote_api_v1.27/\">Docker Remote API</a> and the <code>--link</code> option to <a href=\"https://docs.docker.com/engine/reference/commandline/run/\"> <code>docker run</code> </a>.</p> <note> <p>This parameter is not supported for Windows containers.</p> </note> <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>", 1178 "ContainerDefinition$entryPoint": "<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.27/#create-a-container\">Create a container</a> section of the <a href=\"https://docs.docker.com/engine/reference/api/docker_remote_api_v1.27/\">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>", 1179 "ContainerDefinition$command": "<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.27/#create-a-container\">Create a container</a> section of the <a href=\"https://docs.docker.com/engine/reference/api/docker_remote_api_v1.27/\">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>", 1180 "ContainerDefinition$dnsServers": "<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.27/#create-a-container\">Create a container</a> section of the <a href=\"https://docs.docker.com/engine/reference/api/docker_remote_api_v1.27/\">Docker Remote API</a> and the <code>--dns</code> option to <a href=\"https://docs.docker.com/engine/reference/run/\">docker run</a>.</p> <note> <p>This parameter is not supported for Windows containers.</p> </note>", 1181 "ContainerDefinition$dnsSearchDomains": "<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.27/#create-a-container\">Create a container</a> section of the <a href=\"https://docs.docker.com/engine/reference/api/docker_remote_api_v1.27/\">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> <note> <p>This parameter is not supported for Windows containers.</p> </note>", 1182 "ContainerDefinition$dockerSecurityOptions": "<p>A list of strings to provide custom labels for SELinux and AppArmor multi-level security systems. This field is not valid for containers in tasks using the Fargate launch type.</p> <p>This parameter maps to <code>SecurityOpt</code> in the <a href=\"https://docs.docker.com/engine/reference/api/docker_remote_api_v1.27/#create-a-container\">Create a container</a> section of the <a href=\"https://docs.docker.com/engine/reference/api/docker_remote_api_v1.27/\">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 Elastic Container Service Developer Guide</i>.</p> <p>This parameter is not supported for Windows containers.</p> </note>", 1183 "ContainerOverride$command": "<p>The command to send to the container that overrides the default command from the Docker image or the task definition. You must also specify a container name.</p>", 1184 "DescribeClustersRequest$clusters": "<p>A 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>", 1185 "DescribeContainerInstancesRequest$containerInstances": "<p>A list of container instance IDs or full ARN entries.</p>", 1186 "DescribeServicesRequest$services": "<p>A list of services to describe. You may specify up to 10 services to describe in a single operation.</p>", 1187 "DescribeTasksRequest$tasks": "<p>A list of up to 100 task IDs or full ARN entries.</p>", 1188 "KernelCapabilities$add": "<p>The Linux capabilities for the container that have been added to the default configuration provided by Docker. This parameter maps to <code>CapAdd</code> in the <a href=\"https://docs.docker.com/engine/reference/api/docker_remote_api_v1.27/#create-a-container\">Create a container</a> section of the <a href=\"https://docs.docker.com/engine/reference/api/docker_remote_api_v1.27/\">Docker Remote API</a> and the <code>--cap-add</code> option to <a href=\"https://docs.docker.com/engine/reference/run/\">docker run</a>.</p> <p>Valid values: <code>\"ALL\" | \"AUDIT_CONTROL\" | \"AUDIT_WRITE\" | \"BLOCK_SUSPEND\" | \"CHOWN\" | \"DAC_OVERRIDE\" | \"DAC_READ_SEARCH\" | \"FOWNER\" | \"FSETID\" | \"IPC_LOCK\" | \"IPC_OWNER\" | \"KILL\" | \"LEASE\" | \"LINUX_IMMUTABLE\" | \"MAC_ADMIN\" | \"MAC_OVERRIDE\" | \"MKNOD\" | \"NET_ADMIN\" | \"NET_BIND_SERVICE\" | \"NET_BROADCAST\" | \"NET_RAW\" | \"SETFCAP\" | \"SETGID\" | \"SETPCAP\" | \"SETUID\" | \"SYS_ADMIN\" | \"SYS_BOOT\" | \"SYS_CHROOT\" | \"SYS_MODULE\" | \"SYS_NICE\" | \"SYS_PACCT\" | \"SYS_PTRACE\" | \"SYS_RAWIO\" | \"SYS_RESOURCE\" | \"SYS_TIME\" | \"SYS_TTY_CONFIG\" | \"SYSLOG\" | \"WAKE_ALARM\"</code> </p>", 1189 "KernelCapabilities$drop": "<p>The Linux capabilities for the container that have been removed from the default configuration provided by Docker. This parameter maps to <code>CapDrop</code> in the <a href=\"https://docs.docker.com/engine/reference/api/docker_remote_api_v1.27/#create-a-container\">Create a container</a> section of the <a href=\"https://docs.docker.com/engine/reference/api/docker_remote_api_v1.27/\">Docker Remote API</a> and the <code>--cap-drop</code> option to <a href=\"https://docs.docker.com/engine/reference/run/\">docker run</a>.</p> <p>Valid values: <code>\"ALL\" | \"AUDIT_CONTROL\" | \"AUDIT_WRITE\" | \"BLOCK_SUSPEND\" | \"CHOWN\" | \"DAC_OVERRIDE\" | \"DAC_READ_SEARCH\" | \"FOWNER\" | \"FSETID\" | \"IPC_LOCK\" | \"IPC_OWNER\" | \"KILL\" | \"LEASE\" | \"LINUX_IMMUTABLE\" | \"MAC_ADMIN\" | \"MAC_OVERRIDE\" | \"MKNOD\" | \"NET_ADMIN\" | \"NET_BIND_SERVICE\" | \"NET_BROADCAST\" | \"NET_RAW\" | \"SETFCAP\" | \"SETGID\" | \"SETPCAP\" | \"SETUID\" | \"SYS_ADMIN\" | \"SYS_BOOT\" | \"SYS_CHROOT\" | \"SYS_MODULE\" | \"SYS_NICE\" | \"SYS_PACCT\" | \"SYS_PTRACE\" | \"SYS_RAWIO\" | \"SYS_RESOURCE\" | \"SYS_TIME\" | \"SYS_TTY_CONFIG\" | \"SYSLOG\" | \"WAKE_ALARM\"</code> </p>", 1190 "ListClustersResponse$clusterArns": "<p>The list of full Amazon Resource Name (ARN) entries for each cluster associated with your account.</p>", 1191 "ListContainerInstancesResponse$containerInstanceArns": "<p>The list of container instances with full ARN entries for each container instance associated with the specified cluster.</p>", 1192 "ListServicesResponse$serviceArns": "<p>The list of full ARN entries for each service associated with the specified cluster.</p>", 1193 "ListTaskDefinitionFamiliesResponse$families": "<p>The list of task definition family names that match the <code>ListTaskDefinitionFamilies</code> request.</p>", 1194 "ListTaskDefinitionsResponse$taskDefinitionArns": "<p>The list of task definition Amazon Resource Name (ARN) entries for the <code>ListTaskDefinitions</code> request.</p>", 1195 "ListTasksResponse$taskArns": "<p>The list of task ARN entries for the <code>ListTasks</code> request.</p>", 1196 "Resource$stringSetValue": "<p>When the <code>stringSetValue</code> type is set, the value of the resource must be a string type.</p>", 1197 "StartTaskRequest$containerInstances": "<p>The container instance IDs or full ARN entries for the container instances on which you would like to place your task. You can specify up to 10 container instances.</p>", 1198 "UpdateContainerInstancesStateRequest$containerInstances": "<p>A list of container instance IDs or full ARN entries.</p>" 1199 } 1200 }, 1201 "SubmitContainerStateChangeRequest": { 1202 "base": null, 1203 "refs": { 1204 } 1205 }, 1206 "SubmitContainerStateChangeResponse": { 1207 "base": null, 1208 "refs": { 1209 } 1210 }, 1211 "SubmitTaskStateChangeRequest": { 1212 "base": null, 1213 "refs": { 1214 } 1215 }, 1216 "SubmitTaskStateChangeResponse": { 1217 "base": null, 1218 "refs": { 1219 } 1220 }, 1221 "TargetNotFoundException": { 1222 "base": "<p>The specified target could not be found. You can view your available container instances with <a>ListContainerInstances</a>. Amazon ECS container instances are cluster-specific and region-specific.</p>", 1223 "refs": { 1224 } 1225 }, 1226 "TargetType": { 1227 "base": null, 1228 "refs": { 1229 "Attribute$targetType": "<p>The type of the target with which to attach the attribute. This parameter is required if you use the short form ID for a resource instead of the full ARN.</p>", 1230 "ListAttributesRequest$targetType": "<p>The type of the target with which to list attributes.</p>" 1231 } 1232 }, 1233 "Task": { 1234 "base": "<p>Details on a task in a cluster.</p>", 1235 "refs": { 1236 "StopTaskResponse$task": "<p>The task that was stopped.</p>", 1237 "Tasks$member": null 1238 } 1239 }, 1240 "TaskDefinition": { 1241 "base": "<p>Details of a task definition.</p>", 1242 "refs": { 1243 "DeregisterTaskDefinitionResponse$taskDefinition": "<p>The full description of the deregistered task.</p>", 1244 "DescribeTaskDefinitionResponse$taskDefinition": "<p>The full task definition description.</p>", 1245 "RegisterTaskDefinitionResponse$taskDefinition": "<p>The full description of the registered task definition.</p>" 1246 } 1247 }, 1248 "TaskDefinitionFamilyStatus": { 1249 "base": null, 1250 "refs": { 1251 "ListTaskDefinitionFamiliesRequest$status": "<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>" 1252 } 1253 }, 1254 "TaskDefinitionPlacementConstraint": { 1255 "base": "<p>An object representing a constraint on task placement in the task definition.</p> <p>If you are using the Fargate launch type, task placement contraints are not supported.</p> <p>For more information, see <a href=\"http://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-placement-constraints.html\">Task Placement Constraints</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p>", 1256 "refs": { 1257 "TaskDefinitionPlacementConstraints$member": null 1258 } 1259 }, 1260 "TaskDefinitionPlacementConstraintType": { 1261 "base": null, 1262 "refs": { 1263 "TaskDefinitionPlacementConstraint$type": "<p>The type of constraint. The <code>DistinctInstance</code> constraint ensures that each task in a particular group is running on a different container instance. The <code>MemberOf</code> constraint restricts selection to be from a group of valid candidates.</p>" 1264 } 1265 }, 1266 "TaskDefinitionPlacementConstraints": { 1267 "base": null, 1268 "refs": { 1269 "RegisterTaskDefinitionRequest$placementConstraints": "<p>An array of placement constraint objects to use for the task. You can specify a maximum of 10 constraints per task (this limit includes constraints in the task definition and those specified at run time).</p>", 1270 "TaskDefinition$placementConstraints": "<p>An array of placement constraint objects to use for tasks. This field is not valid if using the Fargate launch type for your task.</p>" 1271 } 1272 }, 1273 "TaskDefinitionStatus": { 1274 "base": null, 1275 "refs": { 1276 "ListTaskDefinitionsRequest$status": "<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>", 1277 "TaskDefinition$status": "<p>The status of the task definition.</p>" 1278 } 1279 }, 1280 "TaskOverride": { 1281 "base": "<p>The overrides associated with a task.</p>", 1282 "refs": { 1283 "RunTaskRequest$overrides": "<p>A list of container overrides in JSON format that specify the name of a container in the specified task definition and the overrides it 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>", 1284 "StartTaskRequest$overrides": "<p>A list of container overrides in JSON format that specify the name of a container in the specified task definition and the overrides it 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>", 1285 "Task$overrides": "<p>One or more container overrides.</p>" 1286 } 1287 }, 1288 "Tasks": { 1289 "base": null, 1290 "refs": { 1291 "DescribeTasksResponse$tasks": "<p>The list of tasks.</p>", 1292 "RunTaskResponse$tasks": "<p>A full description of the tasks that were run. The tasks that were successfully placed on your cluster are described here.</p>", 1293 "StartTaskResponse$tasks": "<p>A full description of the tasks that were started. Each task that was successfully placed on your container instances is described.</p>" 1294 } 1295 }, 1296 "Timestamp": { 1297 "base": null, 1298 "refs": { 1299 "ContainerInstance$registeredAt": "<p>The Unix time stamp for when the container instance was registered.</p>", 1300 "Deployment$createdAt": "<p>The Unix time stamp for when the service was created.</p>", 1301 "Deployment$updatedAt": "<p>The Unix time stamp for when the service was last updated.</p>", 1302 "Service$createdAt": "<p>The Unix time stamp for when the service was created.</p>", 1303 "ServiceEvent$createdAt": "<p>The Unix time stamp for when the event was triggered.</p>", 1304 "SubmitTaskStateChangeRequest$pullStartedAt": "<p>The Unix time stamp for when the container image pull began.</p>", 1305 "SubmitTaskStateChangeRequest$pullStoppedAt": "<p>The Unix time stamp for when the container image pull completed.</p>", 1306 "SubmitTaskStateChangeRequest$executionStoppedAt": "<p>The Unix timestamp for when the task execution stopped.</p>", 1307 "Task$connectivityAt": "<p>The Unix time stamp for when the task last went into <code>CONNECTED</code> status.</p>", 1308 "Task$pullStartedAt": "<p>The Unix time stamp for when the container image pull began.</p>", 1309 "Task$pullStoppedAt": "<p>The Unix time stamp for when the container image pull completed.</p>", 1310 "Task$executionStoppedAt": "<p>The Unix timestamp for when the task execution stopped.</p>", 1311 "Task$createdAt": "<p>The Unix time stamp for when the task was created (the task entered the <code>PENDING</code> state).</p>", 1312 "Task$startedAt": "<p>The Unix time stamp for when the task started (the task transitioned from the <code>PENDING</code> state to the <code>RUNNING</code> state).</p>", 1313 "Task$stoppingAt": "<p>The Unix time stamp for when the task will stop (the task transitioned from the <code>RUNNING</code> state to the <code>STOPPED</code> state).</p>", 1314 "Task$stoppedAt": "<p>The Unix time stamp for when the task was stopped (the task transitioned from the <code>RUNNING</code> state to the <code>STOPPED</code> state).</p>" 1315 } 1316 }, 1317 "TransportProtocol": { 1318 "base": null, 1319 "refs": { 1320 "NetworkBinding$protocol": "<p>The protocol used for the network binding.</p>", 1321 "PortMapping$protocol": "<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>" 1322 } 1323 }, 1324 "Ulimit": { 1325 "base": "<p>The <code>ulimit</code> settings to pass to the container.</p>", 1326 "refs": { 1327 "UlimitList$member": null 1328 } 1329 }, 1330 "UlimitList": { 1331 "base": null, 1332 "refs": { 1333 "ContainerDefinition$ulimits": "<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.27/#create-a-container\">Create a container</a> section of the <a href=\"https://docs.docker.com/engine/reference/api/docker_remote_api_v1.27/\">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 in to your container instance and run the following command: <code>sudo docker version | grep \"Server API version\"</code> </p> <note> <p>This parameter is not supported for Windows containers.</p> </note>" 1334 } 1335 }, 1336 "UlimitName": { 1337 "base": null, 1338 "refs": { 1339 "Ulimit$name": "<p>The <code>type</code> of the <code>ulimit</code>.</p>" 1340 } 1341 }, 1342 "UnsupportedFeatureException": { 1343 "base": "<p>The specified task is not supported in this region.</p>", 1344 "refs": { 1345 } 1346 }, 1347 "UpdateContainerAgentRequest": { 1348 "base": null, 1349 "refs": { 1350 } 1351 }, 1352 "UpdateContainerAgentResponse": { 1353 "base": null, 1354 "refs": { 1355 } 1356 }, 1357 "UpdateContainerInstancesStateRequest": { 1358 "base": null, 1359 "refs": { 1360 } 1361 }, 1362 "UpdateContainerInstancesStateResponse": { 1363 "base": null, 1364 "refs": { 1365 } 1366 }, 1367 "UpdateInProgressException": { 1368 "base": "<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>", 1369 "refs": { 1370 } 1371 }, 1372 "UpdateServiceRequest": { 1373 "base": null, 1374 "refs": { 1375 } 1376 }, 1377 "UpdateServiceResponse": { 1378 "base": null, 1379 "refs": { 1380 } 1381 }, 1382 "VersionInfo": { 1383 "base": "<p>The Docker and Amazon ECS container agent version information about a container instance.</p>", 1384 "refs": { 1385 "ContainerInstance$versionInfo": "<p>The version information for the Amazon ECS container agent and Docker daemon running on the container instance.</p>", 1386 "RegisterContainerInstanceRequest$versionInfo": "<p>The version information for the Amazon ECS container agent and Docker daemon running on the container instance.</p>" 1387 } 1388 }, 1389 "Volume": { 1390 "base": "<p>A data volume used in a task definition.</p>", 1391 "refs": { 1392 "VolumeList$member": null 1393 } 1394 }, 1395 "VolumeFrom": { 1396 "base": "<p>Details on a data volume from another container in the same task definition.</p>", 1397 "refs": { 1398 "VolumeFromList$member": null 1399 } 1400 }, 1401 "VolumeFromList": { 1402 "base": null, 1403 "refs": { 1404 "ContainerDefinition$volumesFrom": "<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.27/#create-a-container\">Create a container</a> section of the <a href=\"https://docs.docker.com/engine/reference/api/docker_remote_api_v1.27/\">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>" 1405 } 1406 }, 1407 "VolumeList": { 1408 "base": null, 1409 "refs": { 1410 "RegisterTaskDefinitionRequest$volumes": "<p>A list of volume definitions in JSON format that containers in your task may use.</p>", 1411 "TaskDefinition$volumes": "<p>The list of volumes in a task.</p> <p>If you are using the Fargate launch type, the <code>host</code> and <code>sourcePath</code> parameters are not supported.</p> <p>For more information about volume definition parameters and defaults, see <a href=\"http://docs.aws.amazon.com/AmazonECS/latest/developerguide/task_definitions.html\">Amazon ECS Task Definitions</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p>" 1412 } 1413 } 1414 } 1415} 1416