Amazon EC2 Container Service (Amazon ECS) is a highly scalable, fast, container management service that makes it easy to run, stop, and manage Docker containers on a cluster of EC2 instances. Amazon ECS lets you launch and stop container-enabled applications with simple API calls, allows you to get the state of your cluster from a centralized service, and gives you access to many familiar Amazon EC2 features like security groups, Amazon EBS volumes, and IAM roles.
You can use Amazon ECS to schedule the placement of containers across your cluster based on your resource needs, isolation policies, and availability requirements. Amazon EC2 Container Service eliminates the need for you to operate your own cluster management and configuration management systems or worry about scaling your management infrastructure.
", "operations": { "CreateCluster": "Creates a new Amazon ECS cluster. By default, your account receives a default cluster when you launch your first container instance. However, you can create your own cluster with a unique name with the CreateCluster action.
Runs and maintains a desired number of tasks from a specified task definition. If the number of tasks running in a service drops below desiredCount, Amazon ECS spawns another instantiation of the task in the specified cluster.
Runs and maintains a desired number of tasks from a specified task definition. If the number of tasks running in a service drops below desiredCount, Amazon ECS spawns another instantiation of the task in the specified cluster. To update an existing service, see UpdateService.
When the service scheduler launches new tasks, it attempts to balance them across the Availability Zones in your cluster with the following logic:
Determine which of the container instances in your cluster can support your service's task definition (for example, they have the required CPU, memory, ports, and container instance attributes).
Sort the valid container instances by the fewest number of running tasks for this service in the same Availability Zone as the instance. For example, if zone A has one running service task and zones B and C each have zero, valid container instances in either zone B or C are considered optimal for placement.
Place the new service task on a valid container instance in an optimal Availability Zone (based on the previous steps), favoring container instances with the fewest number of running tasks for this service.
Deletes the specified cluster. You must deregister all container instances from this cluster before you may delete it. You can list the container instances in a cluster with ListContainerInstances and deregister them with DeregisterContainerInstance.
", - "DeleteService": "Deletes a specified service within a cluster.
", + "DeleteService": "Deletes a specified service within a cluster. You can delete a service if you have no running tasks in it and the desired task count is zero. If the service is actively maintaining tasks, you cannot delete it, and you must update the service to a desired task count of zero. For more information, see UpdateService.
When you delete a service, if there are still running tasks that require cleanup, the service status moves from ACTIVE to DRAINING, and the service is no longer visible in the console or in ListServices API operations. After the tasks have stopped, then the service status moves from DRAINING to INACTIVE. Services in the DRAINING or INACTIVE status can still be viewed with DescribeServices API operations; however, in the future, INACTIVE services may be cleaned up and purged from Amazon ECS record keeping, and DescribeServices API operations on those services will return a ServiceNotFoundException error.
Deregisters an Amazon ECS container instance from the specified cluster. This instance is no longer available to run tasks.
If you intend to use the container instance for some other purpose after deregistration, you should stop all of the tasks running on the container instance before deregistration to avoid any orphaned tasks from consuming resources.
Deregistering a container instance removes the instance from a cluster, but it does not terminate the EC2 instance; if you are finished using the instance, be sure to terminate it in the Amazon EC2 console to stop billing.
When you terminate a container instance, it is automatically deregistered from your cluster.
Deregisters the specified task definition by family and revision. Upon deregistration, the task definition is marked as INACTIVE. Existing tasks and services that reference an INACTIVE task definition continue to run without disruption. Existing services that reference an INACTIVE task definition can still scale up or down by modifying the service's desired count.
You cannot use an INACTIVE task definition to run new tasks or create new services, and you cannot update an existing service to reference an INACTIVE task definition (although there may be up to a 10 minute window following deregistration where these restrictions have not yet taken effect).
Describes one or more of your clusters.
", @@ -27,9 +28,8 @@ "SubmitContainerStateChange": "This action is only used by the Amazon EC2 Container Service agent, and it is not intended for use outside of the agent.
Sent to acknowledge that a container changed states.
", "SubmitTaskStateChange": "This action is only used by the Amazon EC2 Container Service agent, and it is not intended for use outside of the agent.
Sent to acknowledge that a task changed states.
", "UpdateContainerAgent": "Updates the Amazon ECS container agent on a specified container instance. Updating the Amazon ECS container agent does not interrupt running tasks or services on the container instance. The process for updating the agent differs depending on whether your container instance was launched with the Amazon ECS-optimized AMI or another operating system.
UpdateContainerAgent requires the Amazon ECS-optimized AMI or Amazon Linux with the ecs-init service installed and running. For help updating the Amazon ECS container agent on other operating systems, see Manually Updating the Amazon ECS Container Agent in the Amazon EC2 Container Service Developer Guide.
Modify the desired count or task definition used in a service.
You can add to or subtract from the number of instantiations of a task definition in a service by specifying the cluster that the service is running in and a new desiredCount parameter.
You can use UpdateService to modify your task definition and deploy a new version of your service, one task at a time. If you modify the task definition with UpdateService, Amazon ECS spawns a task with the new version of the task definition and then stops an old task after the new version is running. Because UpdateService starts a new version of the task before stopping an old version, your cluster must have capacity to support one more instantiation of the task when UpdateService is run. If your cluster cannot support another instantiation of the task used in your service, you can reduce the desired count of your service by one before modifying the task definition.
When UpdateService replaces a task during an update, the equivalent of docker stop is issued to the containers running in the task. This results in a SIGTERM and a 30-second timeout, after which SIGKILL is sent and the containers are forcibly stopped. If the container handles the SIGTERM gracefully and exits within 30 seconds from receiving it, no SIGKILL is sent.
Modify the desired count or task definition used in a service.
You can add to or subtract from the number of instantiations of a task definition in a service by specifying the cluster that the service is running in and a new desiredCount parameter.
You can use UpdateService to modify your task definition and deploy a new version of your service, one task at a time. If you modify the task definition with UpdateService, Amazon ECS spawns a task with the new version of the task definition and then stops an old task after the new version is running. Because UpdateService starts a new version of the task before stopping an old version, your cluster must have capacity to support one more instantiation of the task when UpdateService is run. If your cluster cannot support another instantiation of the task used in your service, you can reduce the desired count of your service by one before modifying the task definition.
When UpdateService replaces a task during an update, the equivalent of docker stop is issued to the containers running in the task. This results in a SIGTERM and a 30-second timeout, after which SIGKILL is sent and the containers are forcibly stopped. If the container handles the SIGTERM gracefully and exits within 30 seconds from receiving it, no SIGKILL is sent.
When the service scheduler launches new tasks, it attempts to balance them across the Availability Zones in your cluster with the following logic:
Determine which of the container instances in your cluster can support your service's task definition (for example, they have the required CPU, memory, ports, and container instance attributes).
Sort the valid container instances by the fewest number of running tasks for this service in the same Availability Zone as the instance. For example, if zone A has one running service task and zones B and C each have zero, valid container instances in either zone B or C are considered optimal for placement.
Place the new service task on a valid container instance in an optimal Availability Zone (based on the previous steps), favoring container instances with the fewest number of running tasks for this service.
Amazon EC2 Container Service (Amazon ECS) is a highly scalable, fast, container management service that makes it easy to run, stop, and manage Docker containers on a cluster of EC2 instances. Amazon ECS lets you launch and stop container-enabled applications with simple API calls, allows you to get the state of your cluster from a centralized service, and gives you access to many familiar Amazon EC2 features like security groups, Amazon EBS volumes, and IAM roles.
You can use Amazon ECS to schedule the placement of containers across your cluster based on your resource needs, isolation policies, and availability requirements. Amazon EC2 Container Service eliminates the need for you to operate your own cluster management and configuration management systems or worry about scaling your management infrastructure.
", "shapes": { "AgentUpdateStatus": { "base": null, @@ -76,7 +76,7 @@ "CreateServiceRequest$desiredCount": "The number of instantiations of the specified task definition to place and keep running on your cluster.
", "ListClustersRequest$maxResults": "The maximum number of cluster results returned by ListClusters in paginated output. When this parameter is used, ListClusters only returns maxResults results in a single page along with a nextToken response element. The remaining results of the initial request can be seen by sending another ListClusters request with the returned nextToken value. This value can be between 1 and 100. If this parameter is not used, then ListClusters returns up to 100 results and a nextToken value if applicable.
The maximum number of container instance results returned by ListContainerInstances in paginated output. When this parameter is used, ListContainerInstances only returns maxResults results in a single page along with a nextToken response element. The remaining results of the initial request can be seen by sending another ListContainerInstances request with the returned nextToken value. This value can be between 1 and 100. If this parameter is not used, then ListContainerInstances returns up to 100 results and a nextToken value if applicable.
The maximum number of container instance results returned by ListServices in paginated output. When this parameter is used, ListServices only returns maxResults results in a single page along with a nextToken response element. The remaining results of the initial request can be seen by sending another ListServices request with the returned nextToken value. This value can be between 1 and 100. If this parameter is not used, then ListServices returns up to 100 results and a nextToken value if applicable.
The maximum number of container instance results returned by ListServices in paginated output. When this parameter is used, ListServices only returns maxResults results in a single page along with a nextToken response element. The remaining results of the initial request can be seen by sending another ListServices request with the returned nextToken value. This value can be between 1 and 10. If this parameter is not used, then ListServices returns up to 10 results and a nextToken value if applicable.
The maximum number of task definition family results returned by ListTaskDefinitionFamilies in paginated output. When this parameter is used, ListTaskDefinitions only returns maxResults results in a single page along with a nextToken response element. The remaining results of the initial request can be seen by sending another ListTaskDefinitionFamilies request with the returned nextToken value. This value can be between 1 and 100. If this parameter is not used, then ListTaskDefinitionFamilies returns up to 100 results and a nextToken value if applicable.
The maximum number of task definition results returned by ListTaskDefinitions in paginated output. When this parameter is used, ListTaskDefinitions only returns maxResults results in a single page along with a nextToken response element. The remaining results of the initial request can be seen by sending another ListTaskDefinitions request with the returned nextToken value. This value can be between 1 and 100. If this parameter is not used, then ListTaskDefinitions returns up to 100 results and a nextToken value if applicable.
The maximum number of task results returned by ListTasks in paginated output. When this parameter is used, ListTasks only returns maxResults results in a single page along with a nextToken response element. The remaining results of the initial request can be seen by sending another ListTasks request with the returned nextToken value. This value can be between 1 and 100. If this parameter is not used, then ListTasks returns up to 100 results and a nextToken value if applicable.
The environment variables to pass to a container. This parameter maps to Env in the Create a container section of the Docker Remote API and the --env option to docker run.
The environment variables to pass to a container. This parameter maps to Env in the Create a container section of the Docker Remote API and the --env option to docker run.
We do not recommend using plain text environment variables for sensitive information, such as credential data.
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.
" } }, @@ -373,8 +373,8 @@ "Cluster$runningTasksCount": "The number of tasks in the cluster that are in the RUNNING state.
The number of tasks in the cluster that are in the PENDING state.
The number of services that are running on the cluster in an ACTIVE state. You can view these services with ListServices.
The number of cpu units reserved for the container. A container instance has 1,024 cpu units for every CPU core. This parameter specifies the minimum amount of CPU to reserve for a container, and containers share unallocated CPU units with other containers on the instance with the same ratio as their allocated amount. This parameter maps to CpuShares in the Create a container section of the Docker Remote API and the --cpu-shares option to docker run.
You can determine the number of CPU units that are available per EC2 instance type by multiplying the vCPUs listed for that instance type on the Amazon EC2 Instances detail page by 1,024.
For example, if you run a single-container task on a single-core instance type with 512 CPU units specified for that container, and that is the only task running on the container instance, that container could use the full 1,024 CPU unit share at any given time. However, if you launched another copy of the same task on that container instance, each task would be guaranteed a minimum of 512 CPU units when needed, and each container could float to higher CPU usage if the other container was not using it, but if both tasks were 100% active all of the time, they would be limited to 512 CPU units.
The Docker daemon on the container instance uses the CPU value to calculate the relative CPU share ratios for running containers. For more information, see CPU share constraint in the Docker documentation. The minimum valid CPU share value that the Linux kernel allows is 2; however, the CPU parameter is not required, and you can use CPU values below 2 in your container definitions. For CPU values below 2 (including null), the behavior varies based on your Amazon ECS container agent version:
The number of MiB of memory reserved for the container. If your container attempts to exceed the memory allocated here, the container is killed. This parameter maps to Memory in the Create a container section of the Docker Remote API and the --memory option to docker run.
The number of cpu units reserved for the container. A container instance has 1,024 cpu units for every CPU core. This parameter specifies the minimum amount of CPU to reserve for a container, and containers share unallocated CPU units with other containers on the instance with the same ratio as their allocated amount. This parameter maps to CpuShares in the Create a container section of the Docker Remote API and the --cpu-shares option to docker run.
You can determine the number of CPU units that are available per EC2 instance type by multiplying the vCPUs listed for that instance type on the Amazon EC2 Instances detail page by 1,024.
For example, if you run a single-container task on a single-core instance type with 512 CPU units specified for that container, and that is the only task running on the container instance, that container could use the full 1,024 CPU unit share at any given time. However, if you launched another copy of the same task on that container instance, each task would be guaranteed a minimum of 512 CPU units when needed, and each container could float to higher CPU usage if the other container was not using it, but if both tasks were 100% active all of the time, they would be limited to 512 CPU units.
The Docker daemon on the container instance uses the CPU value to calculate the relative CPU share ratios for running containers. For more information, see CPU share constraint in the Docker documentation. The minimum valid CPU share value that the Linux kernel allows is 2; however, the CPU parameter is not required, and you can use CPU values below 2 in your container definitions. For CPU values below 2 (including null), the behavior varies based on your Amazon ECS container agent version:
The number of MiB of memory to reserve for the container. You must specify a non-zero integer for this parameter; 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. If your container attempts to exceed the memory allocated here, the container is killed. This parameter maps to Memory in the Create a container section of the Docker Remote API and the --memory option to docker run.
The number of tasks on the container instance that are in the RUNNING status.
The number of tasks on the container instance that are in the PENDING status.
The most recent desired count of tasks that was specified for the service to deploy or maintain.
", @@ -771,6 +771,7 @@ "StartTaskRequest$startedBy": "An optional tag specified when a task is started. For example if you automatically trigger a task to run a batch process job, you could apply a unique identifier for that job to your task with the startedBy parameter. You can then identify which tasks belong to that job by filtering the results of a ListTasks call with the startedBy value.
If a task is started by an Amazon ECS service, then the startedBy parameter contains the deployment ID of the service that starts it.
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..
", "StopTaskRequest$task": "The task ID or full Amazon Resource Name (ARN) entry of the task to stop.
", + "StopTaskRequest$reason": "An optional message specified when a task is stopped. For example, if you are using a custom scheduler, you can use this parameter to specify the reason for stopping the task here, and the message will appear in subsequent DescribeTasks API operations on this task. Up to 255 characters are allowed in this message.
", "StringList$member": null, "SubmitContainerStateChangeRequest$cluster": "The short name or full Amazon Resource Name (ARN) of the cluster that hosts the container.
", "SubmitContainerStateChangeRequest$task": "The task ID or full Amazon Resource Name (ARN) of the task that hosts the container.
", @@ -790,6 +791,7 @@ "Task$lastStatus": "The last known status of the task.
", "Task$desiredStatus": "The desired status of the task.
", "Task$startedBy": "The tag specified when a task is started. If the task is started by an Amazon ECS service, then the startedBy parameter contains the deployment ID of the service that starts it.
The reason the task was stopped.
", "TaskDefinition$taskDefinitionArn": "The full Amazon Resource Name (ARN) of the of the task definition.
", "TaskDefinition$family": "The family of your task definition, used as the definition name.
", "UpdateContainerAgentRequest$cluster": "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.
", @@ -891,7 +893,10 @@ "refs": { "Deployment$createdAt": "The Unix time in seconds and milliseconds when the service was created.
", "Deployment$updatedAt": "The Unix time in seconds and milliseconds when the service was last updated.
", - "ServiceEvent$createdAt": "The Unix time in seconds and milliseconds when the event was triggered.
" + "ServiceEvent$createdAt": "The Unix time in seconds and milliseconds when the event was triggered.
", + "Task$createdAt": "The Unix time in seconds and milliseconds when the task was created (the task entered the PENDING state).
The Unix time in seconds and milliseconds when the task was started (the task transitioned from the PENDING state to the RUNNING state).
The Unix time in seconds and milliseconds when the task was stopped (the task transitioned from the RUNNING state to the STOPPED state).
Creates a new Amazon ECS cluster. By default, your account receives a default cluster when you launch your first container instance. However, you can create your own cluster with a unique name with the CreateCluster action.
Runs and maintains a desired number of tasks from a specified task definition. If the number of tasks running in a service drops below desiredCount, Amazon ECS spawns another instantiation of the task in the specified cluster.
Deletes the specified cluster. You must deregister all container instances from this cluster before you may delete it. You can list the container instances in a cluster with ListContainerInstances and deregister them with DeregisterContainerInstance.
', 'DeleteService' => 'Deletes a specified service within a cluster.
', 'DeregisterContainerInstance' => 'Deregisters an Amazon ECS container instance from the specified cluster. This instance is no longer available to run tasks.
If you intend to use the container instance for some other purpose after deregistration, you should stop all of the tasks running on the container instance before deregistration to avoid any orphaned tasks from consuming resources.
Deregistering a container instance removes the instance from a cluster, but it does not terminate the EC2 instance; if you are finished using the instance, be sure to terminate it in the Amazon EC2 console to stop billing.
When you terminate a container instance, it is automatically deregistered from your cluster.
Deregisters the specified task definition by family and revision. Upon deregistration, the task definition is marked as INACTIVE. Existing tasks and services that reference an INACTIVE task definition continue to run without disruption. Existing services that reference an INACTIVE task definition can still scale up or down by modifying the service\'s desired count.
You cannot use an INACTIVE task definition to run new tasks or create new services, and you cannot update an existing service to reference an INACTIVE task definition (although there may be up to a 10 minute window following deregistration where these restrictions have not yet taken effect].
Describes one or more of your clusters.
', 'DescribeContainerInstances' => 'Describes Amazon EC2 Container Service container instances. Returns metadata about registered and remaining resources on each container instance requested.
', 'DescribeServices' => 'Describes the specified services running in your cluster.
', 'DescribeTaskDefinition' => 'Describes a task definition. You can specify a family and revision to find information about a specific task definition, or you can simply specify the family to find the latest ACTIVE revision in that family.
You can only describe INACTIVE task definitions while an active task or service references them.
Describes a specified task or tasks.
', 'DiscoverPollEndpoint' => 'This action is only used by the Amazon EC2 Container Service agent, and it is not intended for use outside of the agent.
Returns an endpoint for the Amazon EC2 Container Service agent to poll for updates.
', 'ListClusters' => 'Returns a list of existing clusters.
', 'ListContainerInstances' => 'Returns a list of container instances in a specified cluster.
', 'ListServices' => 'Lists the services that are running in a specified cluster.
', 'ListTaskDefinitionFamilies' => 'Returns a list of task definition families that are registered to your account (which may include task definition families that no longer have any ACTIVE task definitions]. You can filter the results with the familyPrefix parameter.
Returns a list of task definitions that are registered to your account. You can filter the results by family name with the familyPrefix parameter or by status with the status parameter.
Returns a list of tasks for a specified cluster. You can filter the results by family name, by a particular container instance, or by the desired status of the task with the family, containerInstance, and desiredStatus parameters.
This action is only used by the Amazon EC2 Container Service agent, and it is not intended for use outside of the agent.
Registers an EC2 instance into the specified cluster. This instance becomes available to place containers on.
', 'RegisterTaskDefinition' => 'Registers a new task definition from the supplied family and containerDefinitions. Optionally, you can add data volumes to your containers with the volumes parameter. For more information about task definition parameters and defaults, see Amazon ECS Task Definitions in the Amazon EC2 Container Service Developer Guide.
Start a task using random placement and the default Amazon ECS scheduler. To use your own scheduler or place a task on a specific container instance, use StartTask instead.
The count parameter is limited to 10 tasks per call.
Starts a new task from the specified task definition on the specified container instance or instances. To use the default Amazon ECS scheduler to place your task, use RunTask instead.
The list of container instances to start tasks on is limited to 10.
Stops a running task.
When StopTask is called on a task, the equivalent of docker stop is issued to the containers running in the task. This results in a SIGTERM and a 30-second timeout, after which SIGKILL is sent and the containers are forcibly stopped. If the container handles the SIGTERM gracefully and exits within 30 seconds from receiving it, no SIGKILL is sent.
This action is only used by the Amazon EC2 Container Service agent, and it is not intended for use outside of the agent.
Sent to acknowledge that a container changed states.
', 'SubmitTaskStateChange' => 'This action is only used by the Amazon EC2 Container Service agent, and it is not intended for use outside of the agent.
Sent to acknowledge that a task changed states.
', 'UpdateContainerAgent' => 'Updates the Amazon ECS container agent on a specified container instance. Updating the Amazon ECS container agent does not interrupt running tasks or services on the container instance. The process for updating the agent differs depending on whether your container instance was launched with the Amazon ECS-optimized AMI or another operating system.
UpdateContainerAgent requires the Amazon ECS-optimized AMI or Amazon Linux with the ecs-init service installed and running. For help updating the Amazon ECS container agent on other operating systems, see Manually Updating the Amazon ECS Container Agent in the Amazon EC2 Container Service Developer Guide.
Modify the desired count or task definition used in a service.
You can add to or subtract from the number of instantiations of a task definition in a service by specifying the cluster that the service is running in and a new desiredCount parameter.
You can use UpdateService to modify your task definition and deploy a new version of your service, one task at a time. If you modify the task definition with UpdateService, Amazon ECS spawns a task with the new version of the task definition and then stops an old task after the new version is running. Because UpdateService starts a new version of the task before stopping an old version, your cluster must have capacity to support one more instantiation of the task when UpdateService is run. If your cluster cannot support another instantiation of the task used in your service, you can reduce the desired count of your service by one before modifying the task definition.
When UpdateService replaces a task during an update, the equivalent of docker stop is issued to the containers running in the task. This results in a SIGTERM and a 30-second timeout, after which SIGKILL is sent and the containers are forcibly stopped. If the container handles the SIGTERM gracefully and exits within 30 seconds from receiving it, no SIGKILL is sent.
Amazon EC2 Container Service (Amazon ECS] is a highly scalable, fast, container management service that makes it easy to run, stop, and manage Docker containers on a cluster of EC2 instances. Amazon ECS lets you launch and stop container-enabled applications with simple API calls, allows you to get the state of your cluster from a centralized service, and gives you access to many familiar Amazon EC2 features like security groups, Amazon EBS volumes, and IAM roles.
You can use Amazon ECS to schedule the placement of containers across your cluster based on your resource needs, isolation policies, and availability requirements. Amazon EC2 Container Service eliminates the need for you to operate your own cluster management and configuration management systems or worry about scaling your management infrastructure.
', 'shapes' => [ 'AgentUpdateStatus' => [ 'base' => NULL, 'refs' => [ 'ContainerInstance$agentUpdateStatus' => 'The status of the most recent agent update. If an update has never been requested, this value is NULL.
The attributes applicable to a container instance when it is registered.
', 'refs' => [ 'Attributes$member' => NULL, 'RequiresAttributes$member' => NULL, ], ], 'Attributes' => [ 'base' => NULL, 'refs' => [ 'ContainerInstance$attributes' => 'The attributes set for the container instance by the Amazon ECS container agent at instance registration.
', 'RegisterContainerInstanceRequest$attributes' => 'The container instance attributes that this container instance supports.
', ], ], 'Boolean' => [ 'base' => NULL, 'refs' => [ 'ContainerInstance$agentConnected' => 'This parameter returns true if the agent is actually connected to Amazon ECS. Registered instances with an agent that may be unhealthy or stopped return false, and instances without a connected agent cannot accept placement requests.
If the essential parameter of a container is marked as true, the failure of that container stops the task. If the essential parameter of a container is marked as false, then its failure does not affect the rest of the containers in a task. If this parameter is omitted, a container is assumed to be essential.
All tasks must have at least one essential container.
When this parameter is true, networking is disabled within the container. This parameter maps to NetworkDisabled in the Create a container section of the Docker Remote API.
When this parameter is true, the container is given elevated privileges on the host container instance (similar to the root user]. This parameter maps to Privileged in the Create a container section of the Docker Remote API and the --privileged option to docker run.
When this parameter is true, the container is given read-only access to its root file system. This parameter maps to ReadonlyRootfs in the Create a container section of the Docker Remote API and the --read-only option to docker run.
Forces the deregistration of the container instance. If you have tasks running on the container instance when you deregister it with the force option, these tasks remain running and they continue to pass Elastic Load Balancing load balancer health checks 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.
If this value is true, the container has read-only access to the volume. If this value is false, then the container can write to the volume. The default value is false.
If this value is true, the container has read-only access to the volume. If this value is false, then the container can write to the volume. The default value is false.
The exit code returned from the container.
', 'CreateServiceRequest$desiredCount' => 'The number of instantiations of the specified task definition to place and keep running on your cluster.
', 'ListClustersRequest$maxResults' => 'The maximum number of cluster results returned by ListClusters in paginated output. When this parameter is used, ListClusters only returns maxResults results in a single page along with a nextToken response element. The remaining results of the initial request can be seen by sending another ListClusters request with the returned nextToken value. This value can be between 1 and 100. If this parameter is not used, then ListClusters returns up to 100 results and a nextToken value if applicable.
The maximum number of container instance results returned by ListContainerInstances in paginated output. When this parameter is used, ListContainerInstances only returns maxResults results in a single page along with a nextToken response element. The remaining results of the initial request can be seen by sending another ListContainerInstances request with the returned nextToken value. This value can be between 1 and 100. If this parameter is not used, then ListContainerInstances returns up to 100 results and a nextToken value if applicable.
The maximum number of container instance results returned by ListServices in paginated output. When this parameter is used, ListServices only returns maxResults results in a single page along with a nextToken response element. The remaining results of the initial request can be seen by sending another ListServices request with the returned nextToken value. This value can be between 1 and 100. If this parameter is not used, then ListServices returns up to 100 results and a nextToken value if applicable.
The maximum number of task definition family results returned by ListTaskDefinitionFamilies in paginated output. When this parameter is used, ListTaskDefinitions only returns maxResults results in a single page along with a nextToken response element. The remaining results of the initial request can be seen by sending another ListTaskDefinitionFamilies request with the returned nextToken value. This value can be between 1 and 100. If this parameter is not used, then ListTaskDefinitionFamilies returns up to 100 results and a nextToken value if applicable.
The maximum number of task definition results returned by ListTaskDefinitions in paginated output. When this parameter is used, ListTaskDefinitions only returns maxResults results in a single page along with a nextToken response element. The remaining results of the initial request can be seen by sending another ListTaskDefinitions request with the returned nextToken value. This value can be between 1 and 100. If this parameter is not used, then ListTaskDefinitions returns up to 100 results and a nextToken value if applicable.
The maximum number of task results returned by ListTasks in paginated output. When this parameter is used, ListTasks only returns maxResults results in a single page along with a nextToken response element. The remaining results of the initial request can be seen by sending another ListTasks request with the returned nextToken value. This value can be between 1 and 100. If this parameter is not used, then ListTasks returns up to 100 results and a nextToken value if applicable.
The port on the container to associate with the load balancer. This port must correspond to a containerPort in the service\'s task definition. Your container instances must allow ingress traffic on the hostPort of the port mapping.
The port number on the container that is be used with the network binding.
', 'NetworkBinding$hostPort' => 'The port number on the host that is used with the network binding.
', 'RunTaskRequest$count' => 'The number of instantiations of the specified task to place on your cluster.
The count parameter is limited to 10 tasks per call.
The exit code returned for the state change request.
', 'UpdateServiceRequest$desiredCount' => 'The number of instantiations of the task to place and keep running in your service.
', ], ], 'ClientException' => [ 'base' => 'These errors are usually caused by a client action, such as using an action or resource on behalf of a user that doesn\'t have permission to use the action or resource, or specifying an identifier that is not valid.
', 'refs' => [], ], 'Cluster' => [ 'base' => '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.
', 'refs' => [ 'Clusters$member' => NULL, 'CreateClusterResponse$cluster' => 'The full description of your new cluster.
', 'DeleteClusterResponse$cluster' => 'The full description of the deleted cluster.
', ], ], 'ClusterContainsContainerInstancesException' => [ 'base' => '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 DeregisterContainerInstance.
', 'refs' => [], ], 'ClusterContainsServicesException' => [ 'base' => '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 UpdateService and DeleteService.
', 'refs' => [], ], 'ClusterNotFoundException' => [ 'base' => 'The specified cluster could not be found. You can view your available clusters with ListClusters. Amazon ECS clusters are region-specific.
', 'refs' => [], ], 'Clusters' => [ 'base' => NULL, 'refs' => [ 'DescribeClustersResponse$clusters' => 'The list of clusters.
', ], ], 'Container' => [ 'base' => 'A Docker container that is part of a task.
', 'refs' => [ 'Containers$member' => NULL, ], ], 'ContainerDefinition' => [ 'base' => 'Container definitions are used in task definitions to describe the different containers that are launched as part of a task.
', 'refs' => [ 'ContainerDefinitions$member' => NULL, ], ], 'ContainerDefinitions' => [ 'base' => NULL, 'refs' => [ 'RegisterTaskDefinitionRequest$containerDefinitions' => 'A list of container definitions in JSON format that describe the different containers that make up your task.
', 'TaskDefinition$containerDefinitions' => 'A list of container definitions in JSON format that describe the different containers that make up your task. For more information about container definition parameters and defaults, see Amazon ECS Task Definitions in the Amazon EC2 Container Service Developer Guide.
', ], ], 'ContainerInstance' => [ 'base' => 'An EC2 instance that is running the Amazon ECS agent and has been registered with a cluster.
', 'refs' => [ 'ContainerInstances$member' => NULL, 'DeregisterContainerInstanceResponse$containerInstance' => NULL, 'RegisterContainerInstanceResponse$containerInstance' => NULL, 'UpdateContainerAgentResponse$containerInstance' => NULL, ], ], 'ContainerInstances' => [ 'base' => NULL, 'refs' => [ 'DescribeContainerInstancesResponse$containerInstances' => 'The list of container instances.
', ], ], 'ContainerOverride' => [ 'base' => 'The overrides that should be sent to a container.
', 'refs' => [ 'ContainerOverrides$member' => NULL, ], ], 'ContainerOverrides' => [ 'base' => NULL, 'refs' => [ 'TaskOverride$containerOverrides' => 'One or more container overrides sent to a task.
', ], ], 'Containers' => [ 'base' => NULL, 'refs' => [ 'Task$containers' => 'The containers associated with the task.
', ], ], 'CreateClusterRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateClusterResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreateServiceRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateServiceResponse' => [ 'base' => NULL, 'refs' => [], ], 'DeleteClusterRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteClusterResponse' => [ 'base' => NULL, 'refs' => [], ], 'DeleteServiceRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteServiceResponse' => [ 'base' => NULL, 'refs' => [], ], 'Deployment' => [ 'base' => 'The details of an Amazon ECS service deployment.
', 'refs' => [ 'Deployments$member' => NULL, ], ], 'Deployments' => [ 'base' => NULL, 'refs' => [ 'Service$deployments' => 'The current state of deployments for the service.
', ], ], 'DeregisterContainerInstanceRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeregisterContainerInstanceResponse' => [ 'base' => NULL, 'refs' => [], ], 'DeregisterTaskDefinitionRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeregisterTaskDefinitionResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeClustersRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeClustersResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeContainerInstancesRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeContainerInstancesResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeServicesRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeServicesResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeTaskDefinitionRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeTaskDefinitionResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeTasksRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeTasksResponse' => [ 'base' => NULL, 'refs' => [], ], 'DesiredStatus' => [ 'base' => NULL, 'refs' => [ 'ListTasksRequest$desiredStatus' => 'The task status with which to filter the ListTasks results. Specifying a desiredStatus of STOPPED limits the results to tasks that are in the STOPPED status, which can be useful for debugging tasks that are not starting properly or have died or finished. The default status filter is RUNNING.
A key/value map of labels to add to the container. This parameter maps to Labels in the Create a container section of the Docker Remote API and the --label option to docker run. This parameter requires version 1.18 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log into your container instance and run the following command: sudo docker version | grep "Server API version"
When the doubleValue type is set, the value of the resource must be a double precision floating-point type.
The environment variables to pass to a container. This parameter maps to Env in the Create a container section of the Docker Remote API and the --env option to docker run.
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.
', ], ], 'Failure' => [ 'base' => 'A failed resource.
', 'refs' => [ 'Failures$member' => NULL, ], ], 'Failures' => [ 'base' => NULL, 'refs' => [ 'DescribeClustersResponse$failures' => 'Any failures associated with the call.
', 'DescribeContainerInstancesResponse$failures' => 'Any failures associated with the call.
', 'DescribeServicesResponse$failures' => 'Any failures associated with the call.
', 'DescribeTasksResponse$failures' => 'Any failures associated with the call.
', 'RunTaskResponse$failures' => 'Any failures associated with the call.
', 'StartTaskResponse$failures' => 'Any failures associated with the call.
', ], ], 'HostEntry' => [ 'base' => 'Hostnames and IP address entries that are added to the /etc/hosts file of a container via the extraHosts parameter of its ContainerDefinition.
A list of hostnames and IP address mappings to append to the /etc/hosts file on the container. This parameter maps to ExtraHosts in the Create a container section of the Docker Remote API and the --add-host option to docker run.
Details on a container instance host volume.
', 'refs' => [ 'Volume$host' => 'The path on the host container instance that is presented to the containers which access the volume. If this parameter is empty, then the Docker daemon assigns a host path for you.
', ], ], 'Integer' => [ 'base' => NULL, 'refs' => [ 'Cluster$registeredContainerInstancesCount' => 'The number of container instances registered into the cluster.
', 'Cluster$runningTasksCount' => 'The number of tasks in the cluster that are in the RUNNING state.
The number of tasks in the cluster that are in the PENDING state.
The number of services that are running on the cluster in an ACTIVE state. You can view these services with ListServices.
The number of cpu units reserved for the container. A container instance has 1,024 cpu units for every CPU core. This parameter specifies the minimum amount of CPU to reserve for a container, and containers share unallocated CPU units with other containers on the instance with the same ratio as their allocated amount. This parameter maps to CpuShares in the Create a container section of the Docker Remote API and the --cpu-shares option to docker run.
You can determine the number of CPU units that are available per EC2 instance type by multiplying the vCPUs listed for that instance type on the Amazon EC2 Instances detail page by 1,024.
For example, if you run a single-container task on a single-core instance type with 512 CPU units specified for that container, and that is the only task running on the container instance, that container could use the full 1,024 CPU unit share at any given time. However, if you launched another copy of the same task on that container instance, each task would be guaranteed a minimum of 512 CPU units when needed, and each container could float to higher CPU usage if the other container was not using it, but if both tasks were 100% active all of the time, they would be limited to 512 CPU units.
The Docker daemon on the container instance uses the CPU value to calculate the relative CPU share ratios for running containers. For more information, see CPU share constraint in the Docker documentation. The minimum valid CPU share value that the Linux kernel allows is 2; however, the CPU parameter is not required, and you can use CPU values below 2 in your container definitions. For CPU values below 2 (including null], the behavior varies based on your Amazon ECS container agent version:
The number of MiB of memory reserved for the container. If your container attempts to exceed the memory allocated here, the container is killed. This parameter maps to Memory in the Create a container section of the Docker Remote API and the --memory option to docker run.
The number of tasks on the container instance that are in the RUNNING status.
The number of tasks on the container instance that are in the PENDING status.
The most recent desired count of tasks that was specified for the service to deploy or maintain.
', 'Deployment$pendingCount' => 'The number of tasks in the deployment that are in the PENDING status.
The number of tasks in the deployment that are in the RUNNING status.
The port number on the container that is bound to the user-specified or automatically assigned host port. If you specify a container port and not a host port, your container automatically receives a host port in the ephemeral port range (for more information, see hostPort].
The port number on the container instance to reserve for your container. You can specify a non-reserved host port for your container port mapping, or you can omit the hostPort (or set it to 0] while specifying a containerPort and your container automatically receives a port in the ephemeral port range for your container instance operating system and Docker version.
The default ephemeral port range is 49153 to 65535, and this range is used for Docker versions prior to 1.6.0. For Docker version 1.6.0 and later, the Docker daemon tries to read the ephemeral port range from /proc/sys/net/ipv4/ip_local_port_range; if this kernel parameter is unavailable, the default ephemeral port range is used. You should not attempt to specify a host port in the ephemeral port range, because these are reserved for automatic assignment. In general, ports below 32768 are outside of the ephemeral port range.
The default reserved ports are 22 for SSH, the Docker ports 2375 and 2376, and the Amazon ECS container agent port 51678. Any host port that was previously specified in a running task is also reserved while the task is running (after a task stops, the host port is released].The current reserved ports are displayed in the remainingResources of DescribeContainerInstances output, and a container instance may have up to 50 reserved ports at a time, including the default reserved ports (automatically assigned ports do not count toward this limit].
When the integerValue type is set, the value of the resource must be an integer.
The desired number of instantiations of the task definition to keep running on the service. This value is specified when the service is created with CreateService, and it can be modified with UpdateService.
', 'Service$runningCount' => 'The number of tasks in the cluster that are in the RUNNING state.
The number of tasks in the cluster that are in the PENDING state.
The revision of the task in a particular family. The revision is a version number of a task definition in a family. When you register a task definition for the first time, the revision is 1; each time you register a new revision of a task definition in the same family, the revision value always increases by one (even if you have deregistered previous revisions in this family].
The soft limit for the ulimit type.
', 'Ulimit$hardLimit' => 'The hard limit for the ulimit type.
', ], ], 'InvalidParameterException' => [ 'base' => 'The specified parameter is invalid. Review the available parameters for the API request.
', 'refs' => [], ], 'KeyValuePair' => [ 'base' => 'A key and value pair object.
', 'refs' => [ 'EnvironmentVariables$member' => NULL, ], ], 'ListClustersRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListClustersResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListContainerInstancesRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListContainerInstancesResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListServicesRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListServicesResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListTaskDefinitionFamiliesRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListTaskDefinitionFamiliesResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListTaskDefinitionsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListTaskDefinitionsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListTasksRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListTasksResponse' => [ 'base' => NULL, 'refs' => [], ], 'LoadBalancer' => [ 'base' => 'Details on a load balancer that is used with a service.
', 'refs' => [ 'LoadBalancers$member' => NULL, ], ], 'LoadBalancers' => [ 'base' => NULL, 'refs' => [ 'CreateServiceRequest$loadBalancers' => 'A list of 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.
', 'Service$loadBalancers' => 'A list of 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.
', ], ], 'LogConfiguration' => [ 'base' => 'Log configuration options to send to a custom log driver for the container.
', 'refs' => [ 'ContainerDefinition$logConfiguration' => 'The log configuration specification for the container. This parameter maps to LogConfig in the Create a container section of the Docker Remote API and the --log-driver option to docker run. Valid log drivers are displayed in the LogConfiguration data type. This parameter requires version 1.18 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log into your container instance and run the following command: sudo docker version | grep "Server API version"
The Amazon ECS container agent running on a container instance must register the logging drivers available on that instance with the ECS_AVAILABLE_LOGGING_DRIVERS environment variable before containers placed on that instance can use these log configuration options. For more information, see Amazon ECS Container Agent Configuration in the Amazon EC2 Container Service Developer Guide.
The configuration options to send to the log driver. This parameter requires version 1.19 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log into your container instance and run the following command: sudo docker version | grep "Server API version"
The log driver to use for the container. This parameter requires version 1.18 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log into your container instance and run the following command: sudo docker version | grep "Server API version"
When the longValue type is set, the value of the resource must be an extended precision floating-point type.
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.
', 'refs' => [], ], 'MountPoint' => [ 'base' => 'Details on a volume mount point that is used in a container definition.
', 'refs' => [ 'MountPointList$member' => NULL, ], ], 'MountPointList' => [ 'base' => NULL, 'refs' => [ 'ContainerDefinition$mountPoints' => 'The mount points for data volumes in your container. This parameter maps to Volumes in the Create a container section of the Docker Remote API and the --volume option to docker run.
Details on the network bindings between a container and its host container instance. After a task reaches the RUNNING status, manual and automatic host and container port assignments are visible in the networkBindings section of DescribeTasks API responses.
The network bindings associated with the container.
', 'SubmitContainerStateChangeRequest$networkBindings' => 'The network bindings of the container.
', ], ], 'NoUpdateAvailableException' => [ 'base' => '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.
', 'refs' => [], ], 'PortMapping' => [ 'base' => 'Port mappings allow containers to access ports on the host container instance to send or receive traffic. Port mappings are specified as part of the container definition. After a task reaches the RUNNING status, manual and automatic host and container port assignments are visible in the networkBindings section of DescribeTasks API responses.
The list of port mappings for the container. Port mappings allow containers to access ports on the host container instance to send or receive traffic. This parameter maps to PortBindings in the Create a container section of the Docker Remote API and the --publish option to docker run.
The container instance attributes required by your task.
', ], ], 'Resource' => [ 'base' => 'Describes the resources available for a container instance.
', 'refs' => [ 'Resources$member' => NULL, ], ], 'Resources' => [ 'base' => NULL, 'refs' => [ 'ContainerInstance$remainingResources' => 'The remaining resources of the container instance that are available for new tasks.
', 'ContainerInstance$registeredResources' => 'The registered resources on the container instance that are in use by current tasks.
', 'RegisterContainerInstanceRequest$totalResources' => 'The resources available on the instance.
', ], ], 'RunTaskRequest' => [ 'base' => NULL, 'refs' => [], ], 'RunTaskResponse' => [ 'base' => NULL, 'refs' => [], ], 'ServerException' => [ 'base' => 'These errors are usually caused by a server issue.
', 'refs' => [], ], 'Service' => [ 'base' => 'Details on a service within a cluster
', 'refs' => [ 'CreateServiceResponse$service' => 'The full description of your service following the create call.
', 'DeleteServiceResponse$service' => 'The full description of the deleted service.
', 'Services$member' => NULL, 'UpdateServiceResponse$service' => 'The full description of your service following the update call.
', ], ], 'ServiceEvent' => [ 'base' => 'Details on an event associated with a service.
', 'refs' => [ 'ServiceEvents$member' => NULL, ], ], 'ServiceEvents' => [ 'base' => NULL, 'refs' => [ 'Service$events' => 'The event stream for your service. A maximum of 100 of the latest events are displayed.
', ], ], 'ServiceNotActiveException' => [ 'base' => 'The specified service is not active. You cannot update a service that is not active. If you have previously deleted a service, you can re-create it with CreateService.
', 'refs' => [], ], 'ServiceNotFoundException' => [ 'base' => 'The specified service could not be found. You can view your available services with ListServices. Amazon ECS services are cluster-specific and region-specific.
', 'refs' => [], ], 'Services' => [ 'base' => NULL, 'refs' => [ 'DescribeServicesResponse$services' => 'The list of services described.
', ], ], 'SortOrder' => [ 'base' => NULL, 'refs' => [ 'ListTaskDefinitionsRequest$sort' => 'The order in which to sort the results. Valid values are ASC and DESC. By default (ASC], task definitions are listed lexicographically by family name and in ascending numerical order by revision so that the newest task definitions in a family are listed last. Setting this parameter to DESC reverses the sort order on family name and revision so that the newest task definitions in a family are listed first.
The name of the container instance attribute.
', 'Attribute$value' => 'The value of the container instance attribute.
', 'ClientException$message' => NULL, 'Cluster$clusterArn' => 'The Amazon Resource Name (ARN] that identifies the cluster. The ARN contains the arn:aws:ecs namespace, followed by the region of the cluster, the AWS account ID of the cluster owner, the cluster namespace, and then the cluster name. For example, arn:aws:ecs:region:012345678910:cluster/test.
A user-generated string that you use to identify your cluster.
', 'Cluster$status' => 'The status of the cluster. The valid values are ACTIVE or INACTIVE. ACTIVE indicates that you can register container instances with the cluster and the associated instances can accept tasks.
The Amazon Resource Name (ARN] of the container.
', 'Container$taskArn' => 'The Amazon Resource Name (ARN] of the task.
', 'Container$name' => 'The name of the container.
', 'Container$lastStatus' => 'The last known status of the container.
', 'Container$reason' => 'A short (255 max characters] human-readable string to provide additional detail about a running or stopped container.
', 'ContainerDefinition$name' => 'The name of a container. If you are linking multiple containers together in a task definition, the name of one container can be entered in the links of another container to connect the containers. Up to 255 letters (uppercase and lowercase], numbers, hyphens, and underscores are allowed. This parameter maps to name in the Create a container section of the Docker Remote API and the --name option to docker run.
The image used to start a container. This string is passed directly to the Docker daemon. Images in the Docker Hub registry are available by default. Other repositories are specified with repository-url/image:tag. Up to 255 letters (uppercase and lowercase], numbers, hyphens, underscores, colons, periods, forward slashes, and number signs are allowed. This parameter maps to Image in the Create a container section of the Docker Remote API and the IMAGE parameter of docker run.
The hostname to use for your container. This parameter maps to Hostname in the Create a container section of the Docker Remote API and the --hostname option to docker run.
The user name to use inside the container. This parameter maps to User in the Create a container section of the Docker Remote API and the --user option to docker run.
The working directory in which to run commands inside the container. This parameter maps to WorkingDir in the Create a container section of the Docker Remote API and the --workdir option to docker run.
The Amazon Resource Name (ARN] of the container instance. The ARN contains the arn:aws:ecs namespace, followed by the region of the container instance, the AWS account ID of the container instance owner, the container-instance namespace, and then the container instance ID. For example, arn:aws:ecs:region:aws_account_id:container-instance/container_instance_ID.
The EC2 instance ID of the container instance.
', 'ContainerInstance$status' => 'The status of the container instance. The valid values are ACTIVE or INACTIVE. ACTIVE indicates that the container instance can accept tasks.
The name of the container that receives the override.
', 'CreateClusterRequest$clusterName' => 'The name of your cluster. If you do not specify a name for your cluster, you create a cluster named default. Up to 255 letters (uppercase and lowercase], numbers, hyphens, and underscores are allowed.
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.
', 'CreateServiceRequest$serviceName' => '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.
', 'CreateServiceRequest$taskDefinition' => 'The family and revision (family:revision] or full Amazon Resource Name (ARN] of the task definition to run in your service. If a revision is not specified, the latest ACTIVE revision is used.
Unique, case-sensitive identifier you provide to ensure the idempotency of the request. Up to 32 ASCII characters are allowed.
', 'CreateServiceRequest$role' => 'The name or full Amazon Resource Name (ARN] of the IAM role that allows your Amazon ECS container agent to make calls to your load balancer on your behalf. This parameter is only required if you are using a load balancer with your service.
', 'DeleteClusterRequest$cluster' => 'The short name or full Amazon Resource Name (ARN] of the cluster to delete.
', 'DeleteServiceRequest$cluster' => 'The name of the cluster that hosts the service to delete. If you do not specify a cluster, the default cluster is assumed.
', 'DeleteServiceRequest$service' => 'The name of the service to delete.
', 'Deployment$id' => 'The ID of the deployment.
', 'Deployment$status' => 'The status of the deployment. Valid values are PRIMARY (for the most recent deployment], ACTIVE (for previous deployments that still have tasks running, but are being replaced with the PRIMARY deployment], and INACTIVE (for deployments that have been completely replaced].
The most recent task definition that was specified for the service to use.
', 'DeregisterContainerInstanceRequest$cluster' => '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.
', 'DeregisterContainerInstanceRequest$containerInstance' => 'The container instance ID or full Amazon Resource Name (ARN] of the container instance to deregister. The ARN contains the arn:aws:ecs namespace, followed by the region of the container instance, the AWS account ID of the container instance owner, the container-instance namespace, and then the container instance ID. For example, arn:aws:ecs:region:aws_account_id:container-instance/container_instance_ID.
The family and revision (family:revision] or full Amazon Resource Name (ARN] of the task definition to deregister. You must specify a revision.
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.
', 'DescribeServicesRequest$cluster' => 'The name of the cluster that hosts the service to describe. If you do not specify a cluster, the default cluster is assumed.
', 'DescribeTaskDefinitionRequest$taskDefinition' => 'The family for the latest ACTIVE revision, family and revision (family:revision] for a specific revision in the family, or full Amazon Resource Name (ARN] of the task definition to describe.
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.
', 'DiscoverPollEndpointRequest$containerInstance' => 'The container instance ID or full Amazon Resource Name (ARN] of the container instance. The ARN contains the arn:aws:ecs namespace, followed by the region of the container instance, the AWS account ID of the container instance owner, the container-instance namespace, and then the container instance ID. For example, arn:aws:ecs:region:aws_account_id:container-instance/container_instance_ID.
The cluster that the container instance belongs to.
', 'DiscoverPollEndpointResponse$endpoint' => 'The endpoint for the Amazon ECS agent to poll.
', 'DiscoverPollEndpointResponse$telemetryEndpoint' => 'The telemetry endpoint for the Amazon ECS agent.
', 'DockerLabelsMap$key' => NULL, 'DockerLabelsMap$value' => NULL, 'Failure$arn' => 'The Amazon Resource Name (ARN] of the failed resource.
', 'Failure$reason' => 'The reason for the failure.
', 'HostEntry$hostname' => 'The hostname to use in the /etc/hosts entry.
The IP address to use in the /etc/hosts entry.
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.
', 'KeyValuePair$name' => 'The name of the key value pair. For environment variables, this is the name of the environment variable.
', 'KeyValuePair$value' => 'The value of the key value pair. For environment variables, this is the value of the environment variable.
', 'ListClustersRequest$nextToken' => 'The nextToken value returned from a previous paginated ListClusters request where maxResults was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the nextToken value. This value is null when there are no more results to return.
The nextToken value to include in a future ListClusters request. When the results of a ListClusters request exceed maxResults, this value can be used to retrieve the next page of results. This value is null when there are no more results to return.
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..
', 'ListContainerInstancesRequest$nextToken' => 'The nextToken value returned from a previous paginated ListContainerInstances request where maxResults was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the nextToken value. This value is null when there are no more results to return.
The nextToken value to include in a future ListContainerInstances request. When the results of a ListContainerInstances request exceed maxResults, this value can be used to retrieve the next page of results. This value is null when there are no more results to return.
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..
', 'ListServicesRequest$nextToken' => 'The nextToken value returned from a previous paginated ListServices request where maxResults was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the nextToken value. This value is null when there are no more results to return.
The nextToken value to include in a future ListServices request. When the results of a ListServices request exceed maxResults, this value can be used to retrieve the next page of results. This value is null when there are no more results to return.
The familyPrefix is a string that is used to filter the results of ListTaskDefinitionFamilies. If you specify a familyPrefix, only task definition family names that begin with the familyPrefix string are returned.
The nextToken value returned from a previous paginated ListTaskDefinitionFamilies request where maxResults was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the nextToken value. This value is null when there are no more results to return.
The nextToken value to include in a future ListTaskDefinitionFamilies request. When the results of a ListTaskDefinitionFamilies request exceed maxResults, this value can be used to retrieve the next page of results. This value is null when there are no more results to return.
The full family name with which to filter the ListTaskDefinitions results. Specifying a familyPrefix limits the listed task definitions to task definition revisions that belong to that family.
The nextToken value returned from a previous paginated ListTaskDefinitions request where maxResults was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the nextToken value. This value is null when there are no more results to return.
The nextToken value to include in a future ListTaskDefinitions request. When the results of a ListTaskDefinitions request exceed maxResults, this value can be used to retrieve the next page of results. This value is null when there are no more results to return.
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..
', 'ListTasksRequest$containerInstance' => 'The container instance ID or full Amazon Resource Name (ARN] of the container instance with which to filter the ListTasks results. Specifying a containerInstance limits the results to tasks that belong to that container instance.
The name of the family with which to filter the ListTasks results. Specifying a family limits the results to tasks that belong to that family.
The nextToken value returned from a previous paginated ListTasks request where maxResults was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the nextToken value. This value is null when there are no more results to return.
The startedBy value with which to filter the task results. Specifying a startedBy value limits the results to tasks that were started with that value.
The name of the service with which to filter the ListTasks results. Specifying a serviceName limits the results to tasks that belong to that service.
The nextToken value to include in a future ListTasks request. When the results of a ListTasks request exceed maxResults, this value can be used to retrieve the next page of results. This value is null when there are no more results to return.
The name of the load balancer.
', 'LoadBalancer$containerName' => 'The name of the container to associate with the load balancer.
', 'LogConfigurationOptionsMap$key' => NULL, 'LogConfigurationOptionsMap$value' => NULL, 'MountPoint$sourceVolume' => 'The name of the volume to mount.
', 'MountPoint$containerPath' => 'The path on the container to mount the host volume at.
', 'NetworkBinding$bindIP' => 'The IP address that the container is bound to on the container instance.
', 'RegisterContainerInstanceRequest$cluster' => '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..
', 'RegisterContainerInstanceRequest$instanceIdentityDocument' => 'The instance identity document for the EC2 instance to register. This document can be found by running the following command from the instance: curl http://169.254.169.254/latest/dynamic/instance-identity/document/
The instance identity document signature for the EC2 instance to register. This signature can be found by running the following command from the instance: curl http://169.254.169.254/latest/dynamic/instance-identity/signature/
The Amazon Resource Name (ARN] of the container instance (if it was previously registered].
', 'RegisterTaskDefinitionRequest$family' => 'You must specify a family for a task definition, which allows you to track multiple versions of the same task definition. The family is used as a name for your task definition. Up to 255 letters (uppercase and lowercase], numbers, hyphens, and underscores are allowed.
The name of the resource, such as CPU, MEMORY, PORTS, or a user-defined resource.
The type of the resource, such as INTEGER, DOUBLE, LONG, or STRINGSET.
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..
', 'RunTaskRequest$taskDefinition' => 'The family and revision (family:revision] or full Amazon Resource Name (ARN] of the task definition to run. If a revision is not specified, the latest ACTIVE revision is used.
An optional tag specified when a task is started. For example if you automatically trigger a task to run a batch process job, you could apply a unique identifier for that job to your task with the startedBy parameter. You can then identify which tasks belong to that job by filtering the results of a ListTasks call with the startedBy value.
If a task is started by an Amazon ECS service, then the startedBy parameter contains the deployment ID of the service that starts it.
The Amazon Resource Name (ARN] that identifies the service. The ARN contains the arn:aws:ecs namespace, followed by the region of the service, the AWS account ID of the service owner, the service namespace, and then the service name. For example, arn:aws:ecs:region:012345678910:service/my-service.
A user-generated string that you can use to identify your service.
', 'Service$clusterArn' => 'The Amazon Resource Name (ARN] of the of the cluster that hosts the service.
', 'Service$status' => 'The status of the service. The valid values are ACTIVE, DRAINING, or INACTIVE.
The task definition to use for tasks in the service. This value is specified when the service is created with CreateService, and it can be modified with UpdateService.
', 'Service$roleArn' => 'The Amazon Resource Name (ARN] of the IAM role associated with the service that allows the Amazon ECS container agent to register container instances with a load balancer.
', 'ServiceEvent$id' => 'The ID string of the event.
', 'ServiceEvent$message' => 'The event message.
', 'StartTaskRequest$cluster' => '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..
', 'StartTaskRequest$taskDefinition' => 'The family and revision (family:revision] or full Amazon Resource Name (ARN] of the task definition to start. If a revision is not specified, the latest ACTIVE revision is used.
An optional tag specified when a task is started. For example if you automatically trigger a task to run a batch process job, you could apply a unique identifier for that job to your task with the startedBy parameter. You can then identify which tasks belong to that job by filtering the results of a ListTasks call with the startedBy value.
If a task is started by an Amazon ECS service, then the startedBy parameter contains the deployment ID of the service that starts it.
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..
', 'StopTaskRequest$task' => 'The task ID or full Amazon Resource Name (ARN] entry of the task to stop.
', 'StringList$member' => NULL, 'SubmitContainerStateChangeRequest$cluster' => 'The short name or full Amazon Resource Name (ARN] of the cluster that hosts the container.
', 'SubmitContainerStateChangeRequest$task' => 'The task ID or full Amazon Resource Name (ARN] of the task that hosts the container.
', 'SubmitContainerStateChangeRequest$containerName' => 'The name of the container.
', 'SubmitContainerStateChangeRequest$status' => 'The status of the state change request.
', 'SubmitContainerStateChangeRequest$reason' => 'The reason for the state change request.
', 'SubmitContainerStateChangeResponse$acknowledgment' => 'Acknowledgement of the state change.
', 'SubmitTaskStateChangeRequest$cluster' => 'The short name or full Amazon Resource Name (ARN] of the cluster that hosts the task.
', 'SubmitTaskStateChangeRequest$task' => 'The task ID or full Amazon Resource Name (ARN] of the task in the state change request.
', 'SubmitTaskStateChangeRequest$status' => 'The status of the state change request.
', 'SubmitTaskStateChangeRequest$reason' => 'The reason for the state change request.
', 'SubmitTaskStateChangeResponse$acknowledgment' => 'Acknowledgement of the state change.
', 'Task$taskArn' => 'The Amazon Resource Name (ARN] of the task.
', 'Task$clusterArn' => 'The Amazon Resource Name (ARN] of the of the cluster that hosts the task.
', 'Task$taskDefinitionArn' => 'The Amazon Resource Name (ARN] of the of the task definition that creates the task.
', 'Task$containerInstanceArn' => 'The Amazon Resource Name (ARN] of the container instances that host the task.
', 'Task$lastStatus' => 'The last known status of the task.
', 'Task$desiredStatus' => 'The desired status of the task.
', 'Task$startedBy' => 'The tag specified when a task is started. If the task is started by an Amazon ECS service, then the startedBy parameter contains the deployment ID of the service that starts it.
The full Amazon Resource Name (ARN] of the of the task definition.
', 'TaskDefinition$family' => 'The family of your task definition, used as the definition name.
', 'UpdateContainerAgentRequest$cluster' => '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.
', 'UpdateContainerAgentRequest$containerInstance' => 'The container instance ID or full Amazon Resource Name (ARN] entries for the container instance on which you would like to update the Amazon ECS container agent.
', 'UpdateServiceRequest$cluster' => '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.
', 'UpdateServiceRequest$service' => 'The name of the service to update.
', 'UpdateServiceRequest$taskDefinition' => 'The family and revision (family:revision] or full Amazon Resource Name (ARN] of the task definition to run in your service. If a revision is not specified, the latest ACTIVE revision is used. If you modify the task definition with UpdateService, Amazon ECS spawns a task with the new version of the task definition and then stops an old task after the new version is running.
The version number of the Amazon ECS container agent.
', 'VersionInfo$agentHash' => 'The Git commit hash for the Amazon ECS container agent build on the amazon-ecs-agent GitHub repository.
', 'VersionInfo$dockerVersion' => 'The Docker version running on the container instance.
', 'Volume$name' => 'The name of the volume. This name is referenced in the sourceVolume parameter of container definition mountPoints.
The name of the container to mount volumes from.
', ], ], 'StringList' => [ 'base' => NULL, 'refs' => [ 'ContainerDefinition$links' => 'The link parameter allows containers to communicate with each other without the need for port mappings, using the name parameter and optionally, an alias for the link. This construct is analogous to name:alias in Docker links. Up to 255 letters (uppercase and lowercase], numbers, hyphens, and underscores are allowed for each name and alias. For more information on linking Docker containers, see https://docs.docker.com/userguide/dockerlinks/. This parameter maps to Links in the Create a container section of the Docker Remote API and the --link option to docker run.
Containers that are collocated on a single container instance may be able to communicate with each other without requiring links or host port mappings. Network isolation is achieved on the container instance using security groups and VPC settings.
Early versions of the Amazon ECS container agent do not properly handle entryPoint parameters. If you have problems using entryPoint, update your container agent or enter your commands and arguments as command array items instead.
The entry point that is passed to the container. This parameter maps to Entrypoint in the Create a container section of the Docker Remote API and the --entrypoint option to docker run. For more information, see https://docs.docker.com/reference/builder/#entrypoint.
The command that is passed to the container. This parameter maps to Cmd in the Create a container section of the Docker Remote API and the COMMAND parameter to docker run. For more information, see https://docs.docker.com/reference/builder/#cmd.
A list of DNS servers that are presented to the container. This parameter maps to Dns in the Create a container section of the Docker Remote API and the --dns option to docker run.
A list of DNS search domains that are presented to the container. This parameter maps to DnsSearch in the Create a container section of the Docker Remote API and the --dns-search option to docker run.
A list of strings to provide custom labels for SELinux and AppArmor multi-level security systems. This parameter maps to SecurityOpt in the Create a container section of the Docker Remote API and the --security-opt option to docker run.
The Amazon ECS container agent running on a container instance must register with the ECS_SELINUX_CAPABLE=true or ECS_APPARMOR_CAPABLE=true environment variables before containers placed on that instance can use these security options. For more information, see Amazon ECS Container Agent Configuration in the Amazon EC2 Container Service Developer Guide.
The command to send to the container that overrides the default command from the Docker image or the task definition.
', 'DescribeClustersRequest$clusters' => 'A space-separated list of cluster names or full cluster Amazon Resource Name (ARN] entries. If you do not specify a cluster, the default cluster is assumed.
', 'DescribeContainerInstancesRequest$containerInstances' => 'A space-separated list of container instance IDs or full Amazon Resource Name (ARN] entries.
', 'DescribeServicesRequest$services' => 'A list of services to describe.
', 'DescribeTasksRequest$tasks' => 'A space-separated list of task IDs or full Amazon Resource Name (ARN] entries.
', 'ListClustersResponse$clusterArns' => 'The list of full Amazon Resource Name (ARN] entries for each cluster associated with your account.
', 'ListContainerInstancesResponse$containerInstanceArns' => 'The list of container instances with full Amazon Resource Name (ARN] entries for each container instance associated with the specified cluster.
', 'ListServicesResponse$serviceArns' => 'The list of full Amazon Resource Name (ARN] entries for each service associated with the specified cluster.
', 'ListTaskDefinitionFamiliesResponse$families' => 'The list of task definition family names that match the ListTaskDefinitionFamilies request.
The list of task definition Amazon Resource Name (ARN] entries for the ListTaskDefinitions request.
The list of task Amazon Resource Name (ARN] entries for the ListTasks request.
When the stringSetValue type is set, the value of the resource must be a string type.
The container instance IDs or full Amazon Resource Name (ARN] entries for the container instances on which you would like to place your task.
The list of container instances to start tasks on is limited to 10.
Details on a task in a cluster.
', 'refs' => [ 'StopTaskResponse$task' => NULL, 'Tasks$member' => NULL, ], ], 'TaskDefinition' => [ 'base' => 'Details of a task definition.
', 'refs' => [ 'DeregisterTaskDefinitionResponse$taskDefinition' => 'The full description of the deregistered task.
', 'DescribeTaskDefinitionResponse$taskDefinition' => 'The full task definition description.
', 'RegisterTaskDefinitionResponse$taskDefinition' => 'The full description of the registered task definition.
', ], ], 'TaskDefinitionStatus' => [ 'base' => NULL, 'refs' => [ 'ListTaskDefinitionsRequest$status' => 'The task definition status with which to filter the ListTaskDefinitions results. By default, only ACTIVE task definitions are listed. By setting this parameter to INACTIVE, you can view task definitions that are INACTIVE as long as an active task or service still references them. If you paginate the resulting output, be sure to keep the status value constant in each subsequent request.
The status of the task definition.
', ], ], 'TaskOverride' => [ 'base' => 'The overrides associated with a task.
', 'refs' => [ 'RunTaskRequest$overrides' => 'A list of container overrides in JSON format that specify the name of a container in the specified task definition and the overrides it should receive. You can override the default command for a container (that is specified in the task definition or Docker image] with a command override. You can also override existing environment variables (that are specified in the task definition or Docker image] on a container or add new environment variables to it with an environment override.
A total of 8192 characters are allowed for overrides. This limit includes the JSON formatting characters of the override structure.
A list of container overrides in JSON format that specify the name of a container in the specified task definition and the overrides it should receive. You can override the default command for a container (that is specified in the task definition or Docker image] with a command override. You can also override existing environment variables (that are specified in the task definition or Docker image] on a container or add new environment variables to it with an environment override.
A total of 8192 characters are allowed for overrides. This limit includes the JSON formatting characters of the override structure.
One or more container overrides.
', ], ], 'Tasks' => [ 'base' => NULL, 'refs' => [ 'DescribeTasksResponse$tasks' => 'The list of tasks.
', 'RunTaskResponse$tasks' => 'A full description of the tasks that were run. Each task that was successfully placed on your cluster are described here.
', 'StartTaskResponse$tasks' => 'A full description of the tasks that were started. Each task that was successfully placed on your container instances are described here.
', ], ], 'Timestamp' => [ 'base' => NULL, 'refs' => [ 'Deployment$createdAt' => 'The Unix time in seconds and milliseconds when the service was created.
', 'Deployment$updatedAt' => 'The Unix time in seconds and milliseconds when the service was last updated.
', 'ServiceEvent$createdAt' => 'The Unix time in seconds and milliseconds when the event was triggered.
', ], ], 'TransportProtocol' => [ 'base' => NULL, 'refs' => [ 'NetworkBinding$protocol' => 'The protocol used for the network binding.
', 'PortMapping$protocol' => 'The protocol used for the port mapping. Valid values are tcp and udp. The default is tcp.
The ulimit settings to pass to the container.
A list of ulimits to set in the container. This parameter maps to Ulimits in the Create a container section of the Docker Remote API and the --ulimit option to docker run. Valid naming values are displayed in the Ulimit data type. This parameter requires version 1.18 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log into your container instance and run the following command: sudo docker version | grep "Server API version"
The type of the ulimit.
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 PENDING or STAGING, the update process can get stuck in that state. However, when the agent reconnects, it resumes where it stopped previously.
The Docker and Amazon ECS container agent version information about a container instance.
', 'refs' => [ 'ContainerInstance$versionInfo' => 'The version information for the Amazon ECS container agent and Docker daemon running on the container instance.
', 'RegisterContainerInstanceRequest$versionInfo' => 'The version information for the Amazon ECS container agent and Docker daemon running on the container instance.
', ], ], 'Volume' => [ 'base' => 'A data volume used in a task definition.
', 'refs' => [ 'VolumeList$member' => NULL, ], ], 'VolumeFrom' => [ 'base' => 'Details on a data volume from another container.
', 'refs' => [ 'VolumeFromList$member' => NULL, ], ], 'VolumeFromList' => [ 'base' => NULL, 'refs' => [ 'ContainerDefinition$volumesFrom' => 'Data volumes to mount from another container. This parameter maps to VolumesFrom in the Create a container section of the Docker Remote API and the --volumes-from option to docker run.
A list of volume definitions in JSON format that containers in your task may use.
', 'TaskDefinition$volumes' => 'The list of volumes in a task. For more information about volume definition parameters and defaults, see Amazon ECS Task Definitions in the Amazon EC2 Container Service Developer Guide.
', ], ], ],]; +return [ 'version' => '2.0', 'service' => 'Amazon EC2 Container Service (Amazon ECS] is a highly scalable, fast, container management service that makes it easy to run, stop, and manage Docker containers on a cluster of EC2 instances. Amazon ECS lets you launch and stop container-enabled applications with simple API calls, allows you to get the state of your cluster from a centralized service, and gives you access to many familiar Amazon EC2 features like security groups, Amazon EBS volumes, and IAM roles.
You can use Amazon ECS to schedule the placement of containers across your cluster based on your resource needs, isolation policies, and availability requirements. Amazon EC2 Container Service eliminates the need for you to operate your own cluster management and configuration management systems or worry about scaling your management infrastructure.
', 'operations' => [ 'CreateCluster' => 'Creates a new Amazon ECS cluster. By default, your account receives a default cluster when you launch your first container instance. However, you can create your own cluster with a unique name with the CreateCluster action.
Runs and maintains a desired number of tasks from a specified task definition. If the number of tasks running in a service drops below desiredCount, Amazon ECS spawns another instantiation of the task in the specified cluster. To update an existing service, see UpdateService.
When the service scheduler launches new tasks, it attempts to balance them across the Availability Zones in your cluster with the following logic:
Determine which of the container instances in your cluster can support your service\'s task definition (for example, they have the required CPU, memory, ports, and container instance attributes].
Sort the valid container instances by the fewest number of running tasks for this service in the same Availability Zone as the instance. For example, if zone A has one running service task and zones B and C each have zero, valid container instances in either zone B or C are considered optimal for placement.
Place the new service task on a valid container instance in an optimal Availability Zone (based on the previous steps], favoring container instances with the fewest number of running tasks for this service.
Deletes the specified cluster. You must deregister all container instances from this cluster before you may delete it. You can list the container instances in a cluster with ListContainerInstances and deregister them with DeregisterContainerInstance.
', 'DeleteService' => 'Deletes a specified service within a cluster. You can delete a service if you have no running tasks in it and the desired task count is zero. If the service is actively maintaining tasks, you cannot delete it, and you must update the service to a desired task count of zero. For more information, see UpdateService.
When you delete a service, if there are still running tasks that require cleanup, the service status moves from ACTIVE to DRAINING, and the service is no longer visible in the console or in ListServices API operations. After the tasks have stopped, then the service status moves from DRAINING to INACTIVE. Services in the DRAINING or INACTIVE status can still be viewed with DescribeServices API operations; however, in the future, INACTIVE services may be cleaned up and purged from Amazon ECS record keeping, and DescribeServices API operations on those services will return a ServiceNotFoundException error.
Deregisters an Amazon ECS container instance from the specified cluster. This instance is no longer available to run tasks.
If you intend to use the container instance for some other purpose after deregistration, you should stop all of the tasks running on the container instance before deregistration to avoid any orphaned tasks from consuming resources.
Deregistering a container instance removes the instance from a cluster, but it does not terminate the EC2 instance; if you are finished using the instance, be sure to terminate it in the Amazon EC2 console to stop billing.
When you terminate a container instance, it is automatically deregistered from your cluster.
Deregisters the specified task definition by family and revision. Upon deregistration, the task definition is marked as INACTIVE. Existing tasks and services that reference an INACTIVE task definition continue to run without disruption. Existing services that reference an INACTIVE task definition can still scale up or down by modifying the service\'s desired count.
You cannot use an INACTIVE task definition to run new tasks or create new services, and you cannot update an existing service to reference an INACTIVE task definition (although there may be up to a 10 minute window following deregistration where these restrictions have not yet taken effect].
Describes one or more of your clusters.
', 'DescribeContainerInstances' => 'Describes Amazon EC2 Container Service container instances. Returns metadata about registered and remaining resources on each container instance requested.
', 'DescribeServices' => 'Describes the specified services running in your cluster.
', 'DescribeTaskDefinition' => 'Describes a task definition. You can specify a family and revision to find information about a specific task definition, or you can simply specify the family to find the latest ACTIVE revision in that family.
You can only describe INACTIVE task definitions while an active task or service references them.
Describes a specified task or tasks.
', 'DiscoverPollEndpoint' => 'This action is only used by the Amazon EC2 Container Service agent, and it is not intended for use outside of the agent.
Returns an endpoint for the Amazon EC2 Container Service agent to poll for updates.
', 'ListClusters' => 'Returns a list of existing clusters.
', 'ListContainerInstances' => 'Returns a list of container instances in a specified cluster.
', 'ListServices' => 'Lists the services that are running in a specified cluster.
', 'ListTaskDefinitionFamilies' => 'Returns a list of task definition families that are registered to your account (which may include task definition families that no longer have any ACTIVE task definitions]. You can filter the results with the familyPrefix parameter.
Returns a list of task definitions that are registered to your account. You can filter the results by family name with the familyPrefix parameter or by status with the status parameter.
Returns a list of tasks for a specified cluster. You can filter the results by family name, by a particular container instance, or by the desired status of the task with the family, containerInstance, and desiredStatus parameters.
This action is only used by the Amazon EC2 Container Service agent, and it is not intended for use outside of the agent.
Registers an EC2 instance into the specified cluster. This instance becomes available to place containers on.
', 'RegisterTaskDefinition' => 'Registers a new task definition from the supplied family and containerDefinitions. Optionally, you can add data volumes to your containers with the volumes parameter. For more information about task definition parameters and defaults, see Amazon ECS Task Definitions in the Amazon EC2 Container Service Developer Guide.
Start a task using random placement and the default Amazon ECS scheduler. To use your own scheduler or place a task on a specific container instance, use StartTask instead.
The count parameter is limited to 10 tasks per call.
Starts a new task from the specified task definition on the specified container instance or instances. To use the default Amazon ECS scheduler to place your task, use RunTask instead.
The list of container instances to start tasks on is limited to 10.
Stops a running task.
When StopTask is called on a task, the equivalent of docker stop is issued to the containers running in the task. This results in a SIGTERM and a 30-second timeout, after which SIGKILL is sent and the containers are forcibly stopped. If the container handles the SIGTERM gracefully and exits within 30 seconds from receiving it, no SIGKILL is sent.
This action is only used by the Amazon EC2 Container Service agent, and it is not intended for use outside of the agent.
Sent to acknowledge that a container changed states.
', 'SubmitTaskStateChange' => 'This action is only used by the Amazon EC2 Container Service agent, and it is not intended for use outside of the agent.
Sent to acknowledge that a task changed states.
', 'UpdateContainerAgent' => 'Updates the Amazon ECS container agent on a specified container instance. Updating the Amazon ECS container agent does not interrupt running tasks or services on the container instance. The process for updating the agent differs depending on whether your container instance was launched with the Amazon ECS-optimized AMI or another operating system.
UpdateContainerAgent requires the Amazon ECS-optimized AMI or Amazon Linux with the ecs-init service installed and running. For help updating the Amazon ECS container agent on other operating systems, see Manually Updating the Amazon ECS Container Agent in the Amazon EC2 Container Service Developer Guide.
Modify the desired count or task definition used in a service.
You can add to or subtract from the number of instantiations of a task definition in a service by specifying the cluster that the service is running in and a new desiredCount parameter.
You can use UpdateService to modify your task definition and deploy a new version of your service, one task at a time. If you modify the task definition with UpdateService, Amazon ECS spawns a task with the new version of the task definition and then stops an old task after the new version is running. Because UpdateService starts a new version of the task before stopping an old version, your cluster must have capacity to support one more instantiation of the task when UpdateService is run. If your cluster cannot support another instantiation of the task used in your service, you can reduce the desired count of your service by one before modifying the task definition.
When UpdateService replaces a task during an update, the equivalent of docker stop is issued to the containers running in the task. This results in a SIGTERM and a 30-second timeout, after which SIGKILL is sent and the containers are forcibly stopped. If the container handles the SIGTERM gracefully and exits within 30 seconds from receiving it, no SIGKILL is sent.
When the service scheduler launches new tasks, it attempts to balance them across the Availability Zones in your cluster with the following logic:
Determine which of the container instances in your cluster can support your service\'s task definition (for example, they have the required CPU, memory, ports, and container instance attributes].
Sort the valid container instances by the fewest number of running tasks for this service in the same Availability Zone as the instance. For example, if zone A has one running service task and zones B and C each have zero, valid container instances in either zone B or C are considered optimal for placement.
Place the new service task on a valid container instance in an optimal Availability Zone (based on the previous steps], favoring container instances with the fewest number of running tasks for this service.
The status of the most recent agent update. If an update has never been requested, this value is NULL.
The attributes applicable to a container instance when it is registered.
', 'refs' => [ 'Attributes$member' => NULL, 'RequiresAttributes$member' => NULL, ], ], 'Attributes' => [ 'base' => NULL, 'refs' => [ 'ContainerInstance$attributes' => 'The attributes set for the container instance by the Amazon ECS container agent at instance registration.
', 'RegisterContainerInstanceRequest$attributes' => 'The container instance attributes that this container instance supports.
', ], ], 'Boolean' => [ 'base' => NULL, 'refs' => [ 'ContainerInstance$agentConnected' => 'This parameter returns true if the agent is actually connected to Amazon ECS. Registered instances with an agent that may be unhealthy or stopped return false, and instances without a connected agent cannot accept placement requests.
If the essential parameter of a container is marked as true, the failure of that container stops the task. If the essential parameter of a container is marked as false, then its failure does not affect the rest of the containers in a task. If this parameter is omitted, a container is assumed to be essential.
All tasks must have at least one essential container.
When this parameter is true, networking is disabled within the container. This parameter maps to NetworkDisabled in the Create a container section of the Docker Remote API.
When this parameter is true, the container is given elevated privileges on the host container instance (similar to the root user]. This parameter maps to Privileged in the Create a container section of the Docker Remote API and the --privileged option to docker run.
When this parameter is true, the container is given read-only access to its root file system. This parameter maps to ReadonlyRootfs in the Create a container section of the Docker Remote API and the --read-only option to docker run.
Forces the deregistration of the container instance. If you have tasks running on the container instance when you deregister it with the force option, these tasks remain running and they continue to pass Elastic Load Balancing load balancer health checks 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.
If this value is true, the container has read-only access to the volume. If this value is false, then the container can write to the volume. The default value is false.
If this value is true, the container has read-only access to the volume. If this value is false, then the container can write to the volume. The default value is false.
The exit code returned from the container.
', 'CreateServiceRequest$desiredCount' => 'The number of instantiations of the specified task definition to place and keep running on your cluster.
', 'ListClustersRequest$maxResults' => 'The maximum number of cluster results returned by ListClusters in paginated output. When this parameter is used, ListClusters only returns maxResults results in a single page along with a nextToken response element. The remaining results of the initial request can be seen by sending another ListClusters request with the returned nextToken value. This value can be between 1 and 100. If this parameter is not used, then ListClusters returns up to 100 results and a nextToken value if applicable.
The maximum number of container instance results returned by ListContainerInstances in paginated output. When this parameter is used, ListContainerInstances only returns maxResults results in a single page along with a nextToken response element. The remaining results of the initial request can be seen by sending another ListContainerInstances request with the returned nextToken value. This value can be between 1 and 100. If this parameter is not used, then ListContainerInstances returns up to 100 results and a nextToken value if applicable.
The maximum number of container instance results returned by ListServices in paginated output. When this parameter is used, ListServices only returns maxResults results in a single page along with a nextToken response element. The remaining results of the initial request can be seen by sending another ListServices request with the returned nextToken value. This value can be between 1 and 10. If this parameter is not used, then ListServices returns up to 10 results and a nextToken value if applicable.
The maximum number of task definition family results returned by ListTaskDefinitionFamilies in paginated output. When this parameter is used, ListTaskDefinitions only returns maxResults results in a single page along with a nextToken response element. The remaining results of the initial request can be seen by sending another ListTaskDefinitionFamilies request with the returned nextToken value. This value can be between 1 and 100. If this parameter is not used, then ListTaskDefinitionFamilies returns up to 100 results and a nextToken value if applicable.
The maximum number of task definition results returned by ListTaskDefinitions in paginated output. When this parameter is used, ListTaskDefinitions only returns maxResults results in a single page along with a nextToken response element. The remaining results of the initial request can be seen by sending another ListTaskDefinitions request with the returned nextToken value. This value can be between 1 and 100. If this parameter is not used, then ListTaskDefinitions returns up to 100 results and a nextToken value if applicable.
The maximum number of task results returned by ListTasks in paginated output. When this parameter is used, ListTasks only returns maxResults results in a single page along with a nextToken response element. The remaining results of the initial request can be seen by sending another ListTasks request with the returned nextToken value. This value can be between 1 and 100. If this parameter is not used, then ListTasks returns up to 100 results and a nextToken value if applicable.
The port on the container to associate with the load balancer. This port must correspond to a containerPort in the service\'s task definition. Your container instances must allow ingress traffic on the hostPort of the port mapping.
The port number on the container that is be used with the network binding.
', 'NetworkBinding$hostPort' => 'The port number on the host that is used with the network binding.
', 'RunTaskRequest$count' => 'The number of instantiations of the specified task to place on your cluster.
The count parameter is limited to 10 tasks per call.
The exit code returned for the state change request.
', 'UpdateServiceRequest$desiredCount' => 'The number of instantiations of the task to place and keep running in your service.
', ], ], 'ClientException' => [ 'base' => 'These errors are usually caused by a client action, such as using an action or resource on behalf of a user that doesn\'t have permission to use the action or resource, or specifying an identifier that is not valid.
', 'refs' => [], ], 'Cluster' => [ 'base' => '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.
', 'refs' => [ 'Clusters$member' => NULL, 'CreateClusterResponse$cluster' => 'The full description of your new cluster.
', 'DeleteClusterResponse$cluster' => 'The full description of the deleted cluster.
', ], ], 'ClusterContainsContainerInstancesException' => [ 'base' => '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 DeregisterContainerInstance.
', 'refs' => [], ], 'ClusterContainsServicesException' => [ 'base' => '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 UpdateService and DeleteService.
', 'refs' => [], ], 'ClusterNotFoundException' => [ 'base' => 'The specified cluster could not be found. You can view your available clusters with ListClusters. Amazon ECS clusters are region-specific.
', 'refs' => [], ], 'Clusters' => [ 'base' => NULL, 'refs' => [ 'DescribeClustersResponse$clusters' => 'The list of clusters.
', ], ], 'Container' => [ 'base' => 'A Docker container that is part of a task.
', 'refs' => [ 'Containers$member' => NULL, ], ], 'ContainerDefinition' => [ 'base' => 'Container definitions are used in task definitions to describe the different containers that are launched as part of a task.
', 'refs' => [ 'ContainerDefinitions$member' => NULL, ], ], 'ContainerDefinitions' => [ 'base' => NULL, 'refs' => [ 'RegisterTaskDefinitionRequest$containerDefinitions' => 'A list of container definitions in JSON format that describe the different containers that make up your task.
', 'TaskDefinition$containerDefinitions' => 'A list of container definitions in JSON format that describe the different containers that make up your task. For more information about container definition parameters and defaults, see Amazon ECS Task Definitions in the Amazon EC2 Container Service Developer Guide.
', ], ], 'ContainerInstance' => [ 'base' => 'An EC2 instance that is running the Amazon ECS agent and has been registered with a cluster.
', 'refs' => [ 'ContainerInstances$member' => NULL, 'DeregisterContainerInstanceResponse$containerInstance' => NULL, 'RegisterContainerInstanceResponse$containerInstance' => NULL, 'UpdateContainerAgentResponse$containerInstance' => NULL, ], ], 'ContainerInstances' => [ 'base' => NULL, 'refs' => [ 'DescribeContainerInstancesResponse$containerInstances' => 'The list of container instances.
', ], ], 'ContainerOverride' => [ 'base' => 'The overrides that should be sent to a container.
', 'refs' => [ 'ContainerOverrides$member' => NULL, ], ], 'ContainerOverrides' => [ 'base' => NULL, 'refs' => [ 'TaskOverride$containerOverrides' => 'One or more container overrides sent to a task.
', ], ], 'Containers' => [ 'base' => NULL, 'refs' => [ 'Task$containers' => 'The containers associated with the task.
', ], ], 'CreateClusterRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateClusterResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreateServiceRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateServiceResponse' => [ 'base' => NULL, 'refs' => [], ], 'DeleteClusterRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteClusterResponse' => [ 'base' => NULL, 'refs' => [], ], 'DeleteServiceRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteServiceResponse' => [ 'base' => NULL, 'refs' => [], ], 'Deployment' => [ 'base' => 'The details of an Amazon ECS service deployment.
', 'refs' => [ 'Deployments$member' => NULL, ], ], 'Deployments' => [ 'base' => NULL, 'refs' => [ 'Service$deployments' => 'The current state of deployments for the service.
', ], ], 'DeregisterContainerInstanceRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeregisterContainerInstanceResponse' => [ 'base' => NULL, 'refs' => [], ], 'DeregisterTaskDefinitionRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeregisterTaskDefinitionResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeClustersRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeClustersResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeContainerInstancesRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeContainerInstancesResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeServicesRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeServicesResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeTaskDefinitionRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeTaskDefinitionResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeTasksRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeTasksResponse' => [ 'base' => NULL, 'refs' => [], ], 'DesiredStatus' => [ 'base' => NULL, 'refs' => [ 'ListTasksRequest$desiredStatus' => 'The task status with which to filter the ListTasks results. Specifying a desiredStatus of STOPPED limits the results to tasks that are in the STOPPED status, which can be useful for debugging tasks that are not starting properly or have died or finished. The default status filter is RUNNING.
A key/value map of labels to add to the container. This parameter maps to Labels in the Create a container section of the Docker Remote API and the --label option to docker run. This parameter requires version 1.18 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log into your container instance and run the following command: sudo docker version | grep "Server API version"
When the doubleValue type is set, the value of the resource must be a double precision floating-point type.
The environment variables to pass to a container. This parameter maps to Env in the Create a container section of the Docker Remote API and the --env option to docker run.
We do not recommend using plain text environment variables for sensitive information, such as credential data.
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.
', ], ], 'Failure' => [ 'base' => 'A failed resource.
', 'refs' => [ 'Failures$member' => NULL, ], ], 'Failures' => [ 'base' => NULL, 'refs' => [ 'DescribeClustersResponse$failures' => 'Any failures associated with the call.
', 'DescribeContainerInstancesResponse$failures' => 'Any failures associated with the call.
', 'DescribeServicesResponse$failures' => 'Any failures associated with the call.
', 'DescribeTasksResponse$failures' => 'Any failures associated with the call.
', 'RunTaskResponse$failures' => 'Any failures associated with the call.
', 'StartTaskResponse$failures' => 'Any failures associated with the call.
', ], ], 'HostEntry' => [ 'base' => 'Hostnames and IP address entries that are added to the /etc/hosts file of a container via the extraHosts parameter of its ContainerDefinition.
A list of hostnames and IP address mappings to append to the /etc/hosts file on the container. This parameter maps to ExtraHosts in the Create a container section of the Docker Remote API and the --add-host option to docker run.
Details on a container instance host volume.
', 'refs' => [ 'Volume$host' => 'The path on the host container instance that is presented to the containers which access the volume. If this parameter is empty, then the Docker daemon assigns a host path for you.
', ], ], 'Integer' => [ 'base' => NULL, 'refs' => [ 'Cluster$registeredContainerInstancesCount' => 'The number of container instances registered into the cluster.
', 'Cluster$runningTasksCount' => 'The number of tasks in the cluster that are in the RUNNING state.
The number of tasks in the cluster that are in the PENDING state.
The number of services that are running on the cluster in an ACTIVE state. You can view these services with ListServices.
The number of cpu units reserved for the container. A container instance has 1,024 cpu units for every CPU core. This parameter specifies the minimum amount of CPU to reserve for a container, and containers share unallocated CPU units with other containers on the instance with the same ratio as their allocated amount. This parameter maps to CpuShares in the Create a container section of the Docker Remote API and the --cpu-shares option to docker run.
You can determine the number of CPU units that are available per EC2 instance type by multiplying the vCPUs listed for that instance type on the Amazon EC2 Instances detail page by 1,024.
For example, if you run a single-container task on a single-core instance type with 512 CPU units specified for that container, and that is the only task running on the container instance, that container could use the full 1,024 CPU unit share at any given time. However, if you launched another copy of the same task on that container instance, each task would be guaranteed a minimum of 512 CPU units when needed, and each container could float to higher CPU usage if the other container was not using it, but if both tasks were 100% active all of the time, they would be limited to 512 CPU units.
The Docker daemon on the container instance uses the CPU value to calculate the relative CPU share ratios for running containers. For more information, see CPU share constraint in the Docker documentation. The minimum valid CPU share value that the Linux kernel allows is 2; however, the CPU parameter is not required, and you can use CPU values below 2 in your container definitions. For CPU values below 2 (including null], the behavior varies based on your Amazon ECS container agent version:
The number of MiB of memory to reserve for the container. You must specify a non-zero integer for this parameter; 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. If your container attempts to exceed the memory allocated here, the container is killed. This parameter maps to Memory in the Create a container section of the Docker Remote API and the --memory option to docker run.
The number of tasks on the container instance that are in the RUNNING status.
The number of tasks on the container instance that are in the PENDING status.
The most recent desired count of tasks that was specified for the service to deploy or maintain.
', 'Deployment$pendingCount' => 'The number of tasks in the deployment that are in the PENDING status.
The number of tasks in the deployment that are in the RUNNING status.
The port number on the container that is bound to the user-specified or automatically assigned host port. If you specify a container port and not a host port, your container automatically receives a host port in the ephemeral port range (for more information, see hostPort].
The port number on the container instance to reserve for your container. You can specify a non-reserved host port for your container port mapping, or you can omit the hostPort (or set it to 0] while specifying a containerPort and your container automatically receives a port in the ephemeral port range for your container instance operating system and Docker version.
The default ephemeral port range is 49153 to 65535, and this range is used for Docker versions prior to 1.6.0. For Docker version 1.6.0 and later, the Docker daemon tries to read the ephemeral port range from /proc/sys/net/ipv4/ip_local_port_range; if this kernel parameter is unavailable, the default ephemeral port range is used. You should not attempt to specify a host port in the ephemeral port range, because these are reserved for automatic assignment. In general, ports below 32768 are outside of the ephemeral port range.
The default reserved ports are 22 for SSH, the Docker ports 2375 and 2376, and the Amazon ECS container agent port 51678. Any host port that was previously specified in a running task is also reserved while the task is running (after a task stops, the host port is released].The current reserved ports are displayed in the remainingResources of DescribeContainerInstances output, and a container instance may have up to 50 reserved ports at a time, including the default reserved ports (automatically assigned ports do not count toward this limit].
When the integerValue type is set, the value of the resource must be an integer.
The desired number of instantiations of the task definition to keep running on the service. This value is specified when the service is created with CreateService, and it can be modified with UpdateService.
', 'Service$runningCount' => 'The number of tasks in the cluster that are in the RUNNING state.
The number of tasks in the cluster that are in the PENDING state.
The revision of the task in a particular family. The revision is a version number of a task definition in a family. When you register a task definition for the first time, the revision is 1; each time you register a new revision of a task definition in the same family, the revision value always increases by one (even if you have deregistered previous revisions in this family].
The soft limit for the ulimit type.
', 'Ulimit$hardLimit' => 'The hard limit for the ulimit type.
', ], ], 'InvalidParameterException' => [ 'base' => 'The specified parameter is invalid. Review the available parameters for the API request.
', 'refs' => [], ], 'KeyValuePair' => [ 'base' => 'A key and value pair object.
', 'refs' => [ 'EnvironmentVariables$member' => NULL, ], ], 'ListClustersRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListClustersResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListContainerInstancesRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListContainerInstancesResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListServicesRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListServicesResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListTaskDefinitionFamiliesRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListTaskDefinitionFamiliesResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListTaskDefinitionsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListTaskDefinitionsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListTasksRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListTasksResponse' => [ 'base' => NULL, 'refs' => [], ], 'LoadBalancer' => [ 'base' => 'Details on a load balancer that is used with a service.
', 'refs' => [ 'LoadBalancers$member' => NULL, ], ], 'LoadBalancers' => [ 'base' => NULL, 'refs' => [ 'CreateServiceRequest$loadBalancers' => 'A list of 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.
', 'Service$loadBalancers' => 'A list of 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.
', ], ], 'LogConfiguration' => [ 'base' => 'Log configuration options to send to a custom log driver for the container.
', 'refs' => [ 'ContainerDefinition$logConfiguration' => 'The log configuration specification for the container. This parameter maps to LogConfig in the Create a container section of the Docker Remote API and the --log-driver option to docker run. Valid log drivers are displayed in the LogConfiguration data type. This parameter requires version 1.18 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log into your container instance and run the following command: sudo docker version | grep "Server API version"
The Amazon ECS container agent running on a container instance must register the logging drivers available on that instance with the ECS_AVAILABLE_LOGGING_DRIVERS environment variable before containers placed on that instance can use these log configuration options. For more information, see Amazon ECS Container Agent Configuration in the Amazon EC2 Container Service Developer Guide.
The configuration options to send to the log driver. This parameter requires version 1.19 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log into your container instance and run the following command: sudo docker version | grep "Server API version"
The log driver to use for the container. This parameter requires version 1.18 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log into your container instance and run the following command: sudo docker version | grep "Server API version"
When the longValue type is set, the value of the resource must be an extended precision floating-point type.
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.
', 'refs' => [], ], 'MountPoint' => [ 'base' => 'Details on a volume mount point that is used in a container definition.
', 'refs' => [ 'MountPointList$member' => NULL, ], ], 'MountPointList' => [ 'base' => NULL, 'refs' => [ 'ContainerDefinition$mountPoints' => 'The mount points for data volumes in your container. This parameter maps to Volumes in the Create a container section of the Docker Remote API and the --volume option to docker run.
Details on the network bindings between a container and its host container instance. After a task reaches the RUNNING status, manual and automatic host and container port assignments are visible in the networkBindings section of DescribeTasks API responses.
The network bindings associated with the container.
', 'SubmitContainerStateChangeRequest$networkBindings' => 'The network bindings of the container.
', ], ], 'NoUpdateAvailableException' => [ 'base' => '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.
', 'refs' => [], ], 'PortMapping' => [ 'base' => 'Port mappings allow containers to access ports on the host container instance to send or receive traffic. Port mappings are specified as part of the container definition. After a task reaches the RUNNING status, manual and automatic host and container port assignments are visible in the networkBindings section of DescribeTasks API responses.
The list of port mappings for the container. Port mappings allow containers to access ports on the host container instance to send or receive traffic. This parameter maps to PortBindings in the Create a container section of the Docker Remote API and the --publish option to docker run.
The container instance attributes required by your task.
', ], ], 'Resource' => [ 'base' => 'Describes the resources available for a container instance.
', 'refs' => [ 'Resources$member' => NULL, ], ], 'Resources' => [ 'base' => NULL, 'refs' => [ 'ContainerInstance$remainingResources' => 'The remaining resources of the container instance that are available for new tasks.
', 'ContainerInstance$registeredResources' => 'The registered resources on the container instance that are in use by current tasks.
', 'RegisterContainerInstanceRequest$totalResources' => 'The resources available on the instance.
', ], ], 'RunTaskRequest' => [ 'base' => NULL, 'refs' => [], ], 'RunTaskResponse' => [ 'base' => NULL, 'refs' => [], ], 'ServerException' => [ 'base' => 'These errors are usually caused by a server issue.
', 'refs' => [], ], 'Service' => [ 'base' => 'Details on a service within a cluster
', 'refs' => [ 'CreateServiceResponse$service' => 'The full description of your service following the create call.
', 'DeleteServiceResponse$service' => 'The full description of the deleted service.
', 'Services$member' => NULL, 'UpdateServiceResponse$service' => 'The full description of your service following the update call.
', ], ], 'ServiceEvent' => [ 'base' => 'Details on an event associated with a service.
', 'refs' => [ 'ServiceEvents$member' => NULL, ], ], 'ServiceEvents' => [ 'base' => NULL, 'refs' => [ 'Service$events' => 'The event stream for your service. A maximum of 100 of the latest events are displayed.
', ], ], 'ServiceNotActiveException' => [ 'base' => 'The specified service is not active. You cannot update a service that is not active. If you have previously deleted a service, you can re-create it with CreateService.
', 'refs' => [], ], 'ServiceNotFoundException' => [ 'base' => 'The specified service could not be found. You can view your available services with ListServices. Amazon ECS services are cluster-specific and region-specific.
', 'refs' => [], ], 'Services' => [ 'base' => NULL, 'refs' => [ 'DescribeServicesResponse$services' => 'The list of services described.
', ], ], 'SortOrder' => [ 'base' => NULL, 'refs' => [ 'ListTaskDefinitionsRequest$sort' => 'The order in which to sort the results. Valid values are ASC and DESC. By default (ASC], task definitions are listed lexicographically by family name and in ascending numerical order by revision so that the newest task definitions in a family are listed last. Setting this parameter to DESC reverses the sort order on family name and revision so that the newest task definitions in a family are listed first.
The name of the container instance attribute.
', 'Attribute$value' => 'The value of the container instance attribute.
', 'ClientException$message' => NULL, 'Cluster$clusterArn' => 'The Amazon Resource Name (ARN] that identifies the cluster. The ARN contains the arn:aws:ecs namespace, followed by the region of the cluster, the AWS account ID of the cluster owner, the cluster namespace, and then the cluster name. For example, arn:aws:ecs:region:012345678910:cluster/test.
A user-generated string that you use to identify your cluster.
', 'Cluster$status' => 'The status of the cluster. The valid values are ACTIVE or INACTIVE. ACTIVE indicates that you can register container instances with the cluster and the associated instances can accept tasks.
The Amazon Resource Name (ARN] of the container.
', 'Container$taskArn' => 'The Amazon Resource Name (ARN] of the task.
', 'Container$name' => 'The name of the container.
', 'Container$lastStatus' => 'The last known status of the container.
', 'Container$reason' => 'A short (255 max characters] human-readable string to provide additional detail about a running or stopped container.
', 'ContainerDefinition$name' => 'The name of a container. If you are linking multiple containers together in a task definition, the name of one container can be entered in the links of another container to connect the containers. Up to 255 letters (uppercase and lowercase], numbers, hyphens, and underscores are allowed. This parameter maps to name in the Create a container section of the Docker Remote API and the --name option to docker run.
The image used to start a container. This string is passed directly to the Docker daemon. Images in the Docker Hub registry are available by default. Other repositories are specified with repository-url/image:tag. Up to 255 letters (uppercase and lowercase], numbers, hyphens, underscores, colons, periods, forward slashes, and number signs are allowed. This parameter maps to Image in the Create a container section of the Docker Remote API and the IMAGE parameter of docker run.
The hostname to use for your container. This parameter maps to Hostname in the Create a container section of the Docker Remote API and the --hostname option to docker run.
The user name to use inside the container. This parameter maps to User in the Create a container section of the Docker Remote API and the --user option to docker run.
The working directory in which to run commands inside the container. This parameter maps to WorkingDir in the Create a container section of the Docker Remote API and the --workdir option to docker run.
The Amazon Resource Name (ARN] of the container instance. The ARN contains the arn:aws:ecs namespace, followed by the region of the container instance, the AWS account ID of the container instance owner, the container-instance namespace, and then the container instance ID. For example, arn:aws:ecs:region:aws_account_id:container-instance/container_instance_ID.
The EC2 instance ID of the container instance.
', 'ContainerInstance$status' => 'The status of the container instance. The valid values are ACTIVE or INACTIVE. ACTIVE indicates that the container instance can accept tasks.
The name of the container that receives the override.
', 'CreateClusterRequest$clusterName' => 'The name of your cluster. If you do not specify a name for your cluster, you create a cluster named default. Up to 255 letters (uppercase and lowercase], numbers, hyphens, and underscores are allowed.
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.
', 'CreateServiceRequest$serviceName' => '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.
', 'CreateServiceRequest$taskDefinition' => 'The family and revision (family:revision] or full Amazon Resource Name (ARN] of the task definition to run in your service. If a revision is not specified, the latest ACTIVE revision is used.
Unique, case-sensitive identifier you provide to ensure the idempotency of the request. Up to 32 ASCII characters are allowed.
', 'CreateServiceRequest$role' => 'The name or full Amazon Resource Name (ARN] of the IAM role that allows your Amazon ECS container agent to make calls to your load balancer on your behalf. This parameter is only required if you are using a load balancer with your service.
', 'DeleteClusterRequest$cluster' => 'The short name or full Amazon Resource Name (ARN] of the cluster to delete.
', 'DeleteServiceRequest$cluster' => 'The name of the cluster that hosts the service to delete. If you do not specify a cluster, the default cluster is assumed.
', 'DeleteServiceRequest$service' => 'The name of the service to delete.
', 'Deployment$id' => 'The ID of the deployment.
', 'Deployment$status' => 'The status of the deployment. Valid values are PRIMARY (for the most recent deployment], ACTIVE (for previous deployments that still have tasks running, but are being replaced with the PRIMARY deployment], and INACTIVE (for deployments that have been completely replaced].
The most recent task definition that was specified for the service to use.
', 'DeregisterContainerInstanceRequest$cluster' => '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.
', 'DeregisterContainerInstanceRequest$containerInstance' => 'The container instance ID or full Amazon Resource Name (ARN] of the container instance to deregister. The ARN contains the arn:aws:ecs namespace, followed by the region of the container instance, the AWS account ID of the container instance owner, the container-instance namespace, and then the container instance ID. For example, arn:aws:ecs:region:aws_account_id:container-instance/container_instance_ID.
The family and revision (family:revision] or full Amazon Resource Name (ARN] of the task definition to deregister. You must specify a revision.
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.
', 'DescribeServicesRequest$cluster' => 'The name of the cluster that hosts the service to describe. If you do not specify a cluster, the default cluster is assumed.
', 'DescribeTaskDefinitionRequest$taskDefinition' => 'The family for the latest ACTIVE revision, family and revision (family:revision] for a specific revision in the family, or full Amazon Resource Name (ARN] of the task definition to describe.
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.
', 'DiscoverPollEndpointRequest$containerInstance' => 'The container instance ID or full Amazon Resource Name (ARN] of the container instance. The ARN contains the arn:aws:ecs namespace, followed by the region of the container instance, the AWS account ID of the container instance owner, the container-instance namespace, and then the container instance ID. For example, arn:aws:ecs:region:aws_account_id:container-instance/container_instance_ID.
The cluster that the container instance belongs to.
', 'DiscoverPollEndpointResponse$endpoint' => 'The endpoint for the Amazon ECS agent to poll.
', 'DiscoverPollEndpointResponse$telemetryEndpoint' => 'The telemetry endpoint for the Amazon ECS agent.
', 'DockerLabelsMap$key' => NULL, 'DockerLabelsMap$value' => NULL, 'Failure$arn' => 'The Amazon Resource Name (ARN] of the failed resource.
', 'Failure$reason' => 'The reason for the failure.
', 'HostEntry$hostname' => 'The hostname to use in the /etc/hosts entry.
The IP address to use in the /etc/hosts entry.
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.
', 'KeyValuePair$name' => 'The name of the key value pair. For environment variables, this is the name of the environment variable.
', 'KeyValuePair$value' => 'The value of the key value pair. For environment variables, this is the value of the environment variable.
', 'ListClustersRequest$nextToken' => 'The nextToken value returned from a previous paginated ListClusters request where maxResults was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the nextToken value. This value is null when there are no more results to return.
The nextToken value to include in a future ListClusters request. When the results of a ListClusters request exceed maxResults, this value can be used to retrieve the next page of results. This value is null when there are no more results to return.
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..
', 'ListContainerInstancesRequest$nextToken' => 'The nextToken value returned from a previous paginated ListContainerInstances request where maxResults was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the nextToken value. This value is null when there are no more results to return.
The nextToken value to include in a future ListContainerInstances request. When the results of a ListContainerInstances request exceed maxResults, this value can be used to retrieve the next page of results. This value is null when there are no more results to return.
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..
', 'ListServicesRequest$nextToken' => 'The nextToken value returned from a previous paginated ListServices request where maxResults was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the nextToken value. This value is null when there are no more results to return.
The nextToken value to include in a future ListServices request. When the results of a ListServices request exceed maxResults, this value can be used to retrieve the next page of results. This value is null when there are no more results to return.
The familyPrefix is a string that is used to filter the results of ListTaskDefinitionFamilies. If you specify a familyPrefix, only task definition family names that begin with the familyPrefix string are returned.
The nextToken value returned from a previous paginated ListTaskDefinitionFamilies request where maxResults was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the nextToken value. This value is null when there are no more results to return.
The nextToken value to include in a future ListTaskDefinitionFamilies request. When the results of a ListTaskDefinitionFamilies request exceed maxResults, this value can be used to retrieve the next page of results. This value is null when there are no more results to return.
The full family name with which to filter the ListTaskDefinitions results. Specifying a familyPrefix limits the listed task definitions to task definition revisions that belong to that family.
The nextToken value returned from a previous paginated ListTaskDefinitions request where maxResults was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the nextToken value. This value is null when there are no more results to return.
The nextToken value to include in a future ListTaskDefinitions request. When the results of a ListTaskDefinitions request exceed maxResults, this value can be used to retrieve the next page of results. This value is null when there are no more results to return.
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..
', 'ListTasksRequest$containerInstance' => 'The container instance ID or full Amazon Resource Name (ARN] of the container instance with which to filter the ListTasks results. Specifying a containerInstance limits the results to tasks that belong to that container instance.
The name of the family with which to filter the ListTasks results. Specifying a family limits the results to tasks that belong to that family.
The nextToken value returned from a previous paginated ListTasks request where maxResults was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the nextToken value. This value is null when there are no more results to return.
The startedBy value with which to filter the task results. Specifying a startedBy value limits the results to tasks that were started with that value.
The name of the service with which to filter the ListTasks results. Specifying a serviceName limits the results to tasks that belong to that service.
The nextToken value to include in a future ListTasks request. When the results of a ListTasks request exceed maxResults, this value can be used to retrieve the next page of results. This value is null when there are no more results to return.
The name of the load balancer.
', 'LoadBalancer$containerName' => 'The name of the container to associate with the load balancer.
', 'LogConfigurationOptionsMap$key' => NULL, 'LogConfigurationOptionsMap$value' => NULL, 'MountPoint$sourceVolume' => 'The name of the volume to mount.
', 'MountPoint$containerPath' => 'The path on the container to mount the host volume at.
', 'NetworkBinding$bindIP' => 'The IP address that the container is bound to on the container instance.
', 'RegisterContainerInstanceRequest$cluster' => '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..
', 'RegisterContainerInstanceRequest$instanceIdentityDocument' => 'The instance identity document for the EC2 instance to register. This document can be found by running the following command from the instance: curl http://169.254.169.254/latest/dynamic/instance-identity/document/
The instance identity document signature for the EC2 instance to register. This signature can be found by running the following command from the instance: curl http://169.254.169.254/latest/dynamic/instance-identity/signature/
The Amazon Resource Name (ARN] of the container instance (if it was previously registered].
', 'RegisterTaskDefinitionRequest$family' => 'You must specify a family for a task definition, which allows you to track multiple versions of the same task definition. The family is used as a name for your task definition. Up to 255 letters (uppercase and lowercase], numbers, hyphens, and underscores are allowed.
The name of the resource, such as CPU, MEMORY, PORTS, or a user-defined resource.
The type of the resource, such as INTEGER, DOUBLE, LONG, or STRINGSET.
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..
', 'RunTaskRequest$taskDefinition' => 'The family and revision (family:revision] or full Amazon Resource Name (ARN] of the task definition to run. If a revision is not specified, the latest ACTIVE revision is used.
An optional tag specified when a task is started. For example if you automatically trigger a task to run a batch process job, you could apply a unique identifier for that job to your task with the startedBy parameter. You can then identify which tasks belong to that job by filtering the results of a ListTasks call with the startedBy value.
If a task is started by an Amazon ECS service, then the startedBy parameter contains the deployment ID of the service that starts it.
The Amazon Resource Name (ARN] that identifies the service. The ARN contains the arn:aws:ecs namespace, followed by the region of the service, the AWS account ID of the service owner, the service namespace, and then the service name. For example, arn:aws:ecs:region:012345678910:service/my-service.
A user-generated string that you can use to identify your service.
', 'Service$clusterArn' => 'The Amazon Resource Name (ARN] of the of the cluster that hosts the service.
', 'Service$status' => 'The status of the service. The valid values are ACTIVE, DRAINING, or INACTIVE.
The task definition to use for tasks in the service. This value is specified when the service is created with CreateService, and it can be modified with UpdateService.
', 'Service$roleArn' => 'The Amazon Resource Name (ARN] of the IAM role associated with the service that allows the Amazon ECS container agent to register container instances with a load balancer.
', 'ServiceEvent$id' => 'The ID string of the event.
', 'ServiceEvent$message' => 'The event message.
', 'StartTaskRequest$cluster' => '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..
', 'StartTaskRequest$taskDefinition' => 'The family and revision (family:revision] or full Amazon Resource Name (ARN] of the task definition to start. If a revision is not specified, the latest ACTIVE revision is used.
An optional tag specified when a task is started. For example if you automatically trigger a task to run a batch process job, you could apply a unique identifier for that job to your task with the startedBy parameter. You can then identify which tasks belong to that job by filtering the results of a ListTasks call with the startedBy value.
If a task is started by an Amazon ECS service, then the startedBy parameter contains the deployment ID of the service that starts it.
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..
', 'StopTaskRequest$task' => 'The task ID or full Amazon Resource Name (ARN] entry of the task to stop.
', 'StopTaskRequest$reason' => 'An optional message specified when a task is stopped. For example, if you are using a custom scheduler, you can use this parameter to specify the reason for stopping the task here, and the message will appear in subsequent DescribeTasks API operations on this task. Up to 255 characters are allowed in this message.
', 'StringList$member' => NULL, 'SubmitContainerStateChangeRequest$cluster' => 'The short name or full Amazon Resource Name (ARN] of the cluster that hosts the container.
', 'SubmitContainerStateChangeRequest$task' => 'The task ID or full Amazon Resource Name (ARN] of the task that hosts the container.
', 'SubmitContainerStateChangeRequest$containerName' => 'The name of the container.
', 'SubmitContainerStateChangeRequest$status' => 'The status of the state change request.
', 'SubmitContainerStateChangeRequest$reason' => 'The reason for the state change request.
', 'SubmitContainerStateChangeResponse$acknowledgment' => 'Acknowledgement of the state change.
', 'SubmitTaskStateChangeRequest$cluster' => 'The short name or full Amazon Resource Name (ARN] of the cluster that hosts the task.
', 'SubmitTaskStateChangeRequest$task' => 'The task ID or full Amazon Resource Name (ARN] of the task in the state change request.
', 'SubmitTaskStateChangeRequest$status' => 'The status of the state change request.
', 'SubmitTaskStateChangeRequest$reason' => 'The reason for the state change request.
', 'SubmitTaskStateChangeResponse$acknowledgment' => 'Acknowledgement of the state change.
', 'Task$taskArn' => 'The Amazon Resource Name (ARN] of the task.
', 'Task$clusterArn' => 'The Amazon Resource Name (ARN] of the of the cluster that hosts the task.
', 'Task$taskDefinitionArn' => 'The Amazon Resource Name (ARN] of the of the task definition that creates the task.
', 'Task$containerInstanceArn' => 'The Amazon Resource Name (ARN] of the container instances that host the task.
', 'Task$lastStatus' => 'The last known status of the task.
', 'Task$desiredStatus' => 'The desired status of the task.
', 'Task$startedBy' => 'The tag specified when a task is started. If the task is started by an Amazon ECS service, then the startedBy parameter contains the deployment ID of the service that starts it.
The reason the task was stopped.
', 'TaskDefinition$taskDefinitionArn' => 'The full Amazon Resource Name (ARN] of the of the task definition.
', 'TaskDefinition$family' => 'The family of your task definition, used as the definition name.
', 'UpdateContainerAgentRequest$cluster' => '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.
', 'UpdateContainerAgentRequest$containerInstance' => 'The container instance ID or full Amazon Resource Name (ARN] entries for the container instance on which you would like to update the Amazon ECS container agent.
', 'UpdateServiceRequest$cluster' => '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.
', 'UpdateServiceRequest$service' => 'The name of the service to update.
', 'UpdateServiceRequest$taskDefinition' => 'The family and revision (family:revision] or full Amazon Resource Name (ARN] of the task definition to run in your service. If a revision is not specified, the latest ACTIVE revision is used. If you modify the task definition with UpdateService, Amazon ECS spawns a task with the new version of the task definition and then stops an old task after the new version is running.
The version number of the Amazon ECS container agent.
', 'VersionInfo$agentHash' => 'The Git commit hash for the Amazon ECS container agent build on the amazon-ecs-agent GitHub repository.
', 'VersionInfo$dockerVersion' => 'The Docker version running on the container instance.
', 'Volume$name' => 'The name of the volume. This name is referenced in the sourceVolume parameter of container definition mountPoints.
The name of the container to mount volumes from.
', ], ], 'StringList' => [ 'base' => NULL, 'refs' => [ 'ContainerDefinition$links' => 'The link parameter allows containers to communicate with each other without the need for port mappings, using the name parameter and optionally, an alias for the link. This construct is analogous to name:alias in Docker links. Up to 255 letters (uppercase and lowercase], numbers, hyphens, and underscores are allowed for each name and alias. For more information on linking Docker containers, see https://docs.docker.com/userguide/dockerlinks/. This parameter maps to Links in the Create a container section of the Docker Remote API and the --link option to docker run.
Containers that are collocated on a single container instance may be able to communicate with each other without requiring links or host port mappings. Network isolation is achieved on the container instance using security groups and VPC settings.
Early versions of the Amazon ECS container agent do not properly handle entryPoint parameters. If you have problems using entryPoint, update your container agent or enter your commands and arguments as command array items instead.
The entry point that is passed to the container. This parameter maps to Entrypoint in the Create a container section of the Docker Remote API and the --entrypoint option to docker run. For more information, see https://docs.docker.com/reference/builder/#entrypoint.
The command that is passed to the container. This parameter maps to Cmd in the Create a container section of the Docker Remote API and the COMMAND parameter to docker run. For more information, see https://docs.docker.com/reference/builder/#cmd.
A list of DNS servers that are presented to the container. This parameter maps to Dns in the Create a container section of the Docker Remote API and the --dns option to docker run.
A list of DNS search domains that are presented to the container. This parameter maps to DnsSearch in the Create a container section of the Docker Remote API and the --dns-search option to docker run.
A list of strings to provide custom labels for SELinux and AppArmor multi-level security systems. This parameter maps to SecurityOpt in the Create a container section of the Docker Remote API and the --security-opt option to docker run.
The Amazon ECS container agent running on a container instance must register with the ECS_SELINUX_CAPABLE=true or ECS_APPARMOR_CAPABLE=true environment variables before containers placed on that instance can use these security options. For more information, see Amazon ECS Container Agent Configuration in the Amazon EC2 Container Service Developer Guide.
The command to send to the container that overrides the default command from the Docker image or the task definition.
', 'DescribeClustersRequest$clusters' => 'A space-separated list of cluster names or full cluster Amazon Resource Name (ARN] entries. If you do not specify a cluster, the default cluster is assumed.
', 'DescribeContainerInstancesRequest$containerInstances' => 'A space-separated list of container instance IDs or full Amazon Resource Name (ARN] entries.
', 'DescribeServicesRequest$services' => 'A list of services to describe.
', 'DescribeTasksRequest$tasks' => 'A space-separated list of task IDs or full Amazon Resource Name (ARN] entries.
', 'ListClustersResponse$clusterArns' => 'The list of full Amazon Resource Name (ARN] entries for each cluster associated with your account.
', 'ListContainerInstancesResponse$containerInstanceArns' => 'The list of container instances with full Amazon Resource Name (ARN] entries for each container instance associated with the specified cluster.
', 'ListServicesResponse$serviceArns' => 'The list of full Amazon Resource Name (ARN] entries for each service associated with the specified cluster.
', 'ListTaskDefinitionFamiliesResponse$families' => 'The list of task definition family names that match the ListTaskDefinitionFamilies request.
The list of task definition Amazon Resource Name (ARN] entries for the ListTaskDefinitions request.
The list of task Amazon Resource Name (ARN] entries for the ListTasks request.
When the stringSetValue type is set, the value of the resource must be a string type.
The container instance IDs or full Amazon Resource Name (ARN] entries for the container instances on which you would like to place your task.
The list of container instances to start tasks on is limited to 10.
Details on a task in a cluster.
', 'refs' => [ 'StopTaskResponse$task' => NULL, 'Tasks$member' => NULL, ], ], 'TaskDefinition' => [ 'base' => 'Details of a task definition.
', 'refs' => [ 'DeregisterTaskDefinitionResponse$taskDefinition' => 'The full description of the deregistered task.
', 'DescribeTaskDefinitionResponse$taskDefinition' => 'The full task definition description.
', 'RegisterTaskDefinitionResponse$taskDefinition' => 'The full description of the registered task definition.
', ], ], 'TaskDefinitionStatus' => [ 'base' => NULL, 'refs' => [ 'ListTaskDefinitionsRequest$status' => 'The task definition status with which to filter the ListTaskDefinitions results. By default, only ACTIVE task definitions are listed. By setting this parameter to INACTIVE, you can view task definitions that are INACTIVE as long as an active task or service still references them. If you paginate the resulting output, be sure to keep the status value constant in each subsequent request.
The status of the task definition.
', ], ], 'TaskOverride' => [ 'base' => 'The overrides associated with a task.
', 'refs' => [ 'RunTaskRequest$overrides' => 'A list of container overrides in JSON format that specify the name of a container in the specified task definition and the overrides it should receive. You can override the default command for a container (that is specified in the task definition or Docker image] with a command override. You can also override existing environment variables (that are specified in the task definition or Docker image] on a container or add new environment variables to it with an environment override.
A total of 8192 characters are allowed for overrides. This limit includes the JSON formatting characters of the override structure.
A list of container overrides in JSON format that specify the name of a container in the specified task definition and the overrides it should receive. You can override the default command for a container (that is specified in the task definition or Docker image] with a command override. You can also override existing environment variables (that are specified in the task definition or Docker image] on a container or add new environment variables to it with an environment override.
A total of 8192 characters are allowed for overrides. This limit includes the JSON formatting characters of the override structure.
One or more container overrides.
', ], ], 'Tasks' => [ 'base' => NULL, 'refs' => [ 'DescribeTasksResponse$tasks' => 'The list of tasks.
', 'RunTaskResponse$tasks' => 'A full description of the tasks that were run. Each task that was successfully placed on your cluster are described here.
', 'StartTaskResponse$tasks' => 'A full description of the tasks that were started. Each task that was successfully placed on your container instances are described here.
', ], ], 'Timestamp' => [ 'base' => NULL, 'refs' => [ 'Deployment$createdAt' => 'The Unix time in seconds and milliseconds when the service was created.
', 'Deployment$updatedAt' => 'The Unix time in seconds and milliseconds when the service was last updated.
', 'ServiceEvent$createdAt' => 'The Unix time in seconds and milliseconds when the event was triggered.
', 'Task$createdAt' => 'The Unix time in seconds and milliseconds when the task was created (the task entered the PENDING state].
The Unix time in seconds and milliseconds when the task was started (the task transitioned from the PENDING state to the RUNNING state].
The Unix time in seconds and milliseconds when the task was stopped (the task transitioned from the RUNNING state to the STOPPED state].
The protocol used for the network binding.
', 'PortMapping$protocol' => 'The protocol used for the port mapping. Valid values are tcp and udp. The default is tcp.
The ulimit settings to pass to the container.
A list of ulimits to set in the container. This parameter maps to Ulimits in the Create a container section of the Docker Remote API and the --ulimit option to docker run. Valid naming values are displayed in the Ulimit data type. This parameter requires version 1.18 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log into your container instance and run the following command: sudo docker version | grep "Server API version"
The type of the ulimit.
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 PENDING or STAGING, the update process can get stuck in that state. However, when the agent reconnects, it resumes where it stopped previously.
The Docker and Amazon ECS container agent version information about a container instance.
', 'refs' => [ 'ContainerInstance$versionInfo' => 'The version information for the Amazon ECS container agent and Docker daemon running on the container instance.
', 'RegisterContainerInstanceRequest$versionInfo' => 'The version information for the Amazon ECS container agent and Docker daemon running on the container instance.
', ], ], 'Volume' => [ 'base' => 'A data volume used in a task definition.
', 'refs' => [ 'VolumeList$member' => NULL, ], ], 'VolumeFrom' => [ 'base' => 'Details on a data volume from another container.
', 'refs' => [ 'VolumeFromList$member' => NULL, ], ], 'VolumeFromList' => [ 'base' => NULL, 'refs' => [ 'ContainerDefinition$volumesFrom' => 'Data volumes to mount from another container. This parameter maps to VolumesFrom in the Create a container section of the Docker Remote API and the --volumes-from option to docker run.
A list of volume definitions in JSON format that containers in your task may use.
', 'TaskDefinition$volumes' => 'The list of volumes in a task. For more information about volume definition parameters and defaults, see Amazon ECS Task Definitions in the Amazon EC2 Container Service Developer Guide.
', ], ], ],];