{ "version": "2.0", "operations": { "CreateCluster": "

Creates a new Amazon ECS cluster. By default, your account will receive 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.

During the preview, each account is limited to two clusters.

", "DeleteCluster": "

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.

", "DeregisterContainerInstance": "

Deregisters an Amazon ECS container instance from the specified cluster. This instance will no longer be available to run tasks.

", "DeregisterTaskDefinition": "

NOT YET IMPLEMENTED.

Deregisters the specified task definition. You will no longer be able to run tasks from this definition after deregistration.

", "DescribeClusters": "

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.

", "DescribeTaskDefinition": "

Describes a task definition. You can specify a family and revision to find information on a specific task definition, or you can simply specify the family to find the latest revision in that family.

", "DescribeTasks": "

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.

", "ListTaskDefinitionFamilies": "

Returns a list of task definition families that are registered to your account. You can filter the results with the familyPrefix parameter.

", "ListTaskDefinitions": "

Returns a list of task definitions that are registered to your account. You can filter the results by family name with the familyPrefix parameter.

", "ListTasks": "

Returns a list of tasks for a specified cluster. You can filter the results by family name or by a particular container instance with the family and containerInstance parameters.

", "RegisterContainerInstance": "

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 Amazon EC2 instance into the specified cluster. This instance will become 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 on task definition parameters and defaults, see Amazon ECS Task Definitions in the Amazon EC2 Container Service Developer Guide.

", "RunTask": "

Start a task using random placement and the default Amazon ECS scheduler. If you want to use your own scheduler or place a task on a specific container instance, use StartTask instead.

", "StartTask": "

Starts a new task from the specified task definition on the specified container instance or instances. If you want to use the default Amazon ECS scheduler to place your task, use RunTask instead.

", "StopTask": "

Stops a running task.

", "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.

" }, "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 Amazon 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": { "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 will return false, and instances without a connected agent cannot accept placement request.

" } }, "BoxedBoolean": { "base": null, "refs": { "ContainerDefinition$essential": "

If the essential parameter of a container is marked as true, the failure of that container will stop the task. If the essential parameter of a container is marked as false, then its failure will not affect the rest of the containers in a task.

", "DeregisterContainerInstanceRequest$force": "

Force the deregistration of the container instance. You can use the force parameter if you have several tasks running on a container instance and you don't want to run StopTask for each task before deregistering the container instance.

", "MountPoint$readOnly": "

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.

", "VolumeFrom$readOnly": "

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.

" } }, "BoxedInteger": { "base": null, "refs": { "Container$exitCode": "

The exit code returned from the container.

", "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.

", "ListContainerInstancesRequest$maxResults": "

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.

", "ListTaskDefinitionFamiliesRequest$maxResults": "

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.

", "ListTaskDefinitionsRequest$maxResults": "

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.

", "ListTasksRequest$maxResults": "

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.

", "NetworkBinding$containerPort": "

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 instances of the specified task that you would like to place on your cluster.

", "SubmitContainerStateChangeRequest$exitCode": "

The exit code returned for the state change request.

" } }, "ClientException": { "base": "

These errors are usually caused by something the client did, such as use an action or resource on behalf of a user that doesn't have permission to use the action or resource, or specify 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.

During the preview, each account is limited to two clusters.

", "refs": { "Clusters$member": null, "CreateClusterResponse$cluster": "

The full description of your new cluster.

", "DeleteClusterResponse$cluster": "

The full description of the deleted cluster.

" } }, "Clusters": { "base": null, "refs": { "DescribeClustersResponse$clusters": "

The list of clusters.

" } }, "Container": { "base": null, "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 on container definition parameters and defaults, see Amazon ECS Task Definitions in the Amazon EC2 Container Service Developer Guide.

" } }, "ContainerInstance": { "base": "

An Amazon 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 } }, "ContainerInstances": { "base": null, "refs": { "DescribeContainerInstancesResponse$containerInstances": "

The list of container instances.

" } }, "ContainerOverride": { "base": null, "refs": { "ContainerOverrides$member": null } }, "ContainerOverrides": { "base": null, "refs": { "TaskOverride$containerOverrides": "

One or more container overrides to send when running a task.

" } }, "Containers": { "base": null, "refs": { "Task$containers": "

The containers associated with the task.

" } }, "CreateClusterRequest": { "base": null, "refs": { } }, "CreateClusterResponse": { "base": null, "refs": { } }, "DeleteClusterRequest": { "base": null, "refs": { } }, "DeleteClusterResponse": { "base": null, "refs": { } }, "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": { } }, "DescribeTaskDefinitionRequest": { "base": null, "refs": { } }, "DescribeTaskDefinitionResponse": { "base": null, "refs": { } }, "DescribeTasksRequest": { "base": null, "refs": { } }, "DescribeTasksResponse": { "base": null, "refs": { } }, "DiscoverPollEndpointRequest": { "base": null, "refs": { } }, "DiscoverPollEndpointResponse": { "base": null, "refs": { } }, "Double": { "base": null, "refs": { "Resource$doubleValue": "

When the doubleValue type is set, the value of the resource must be a double precision floating-point type.

" } }, "EnvironmentVariables": { "base": null, "refs": { "ContainerDefinition$environment": "

The environment variables to pass to a container.

" } }, "Failure": { "base": null, "refs": { "Failures$member": null } }, "Failures": { "base": null, "refs": { "DescribeClustersResponse$failures": null, "DescribeContainerInstancesResponse$failures": null, "DescribeTasksResponse$failures": null, "RunTaskResponse$failures": "

Any failed tasks from your RunTask action are listed here.

", "StartTaskResponse$failures": "

Any failed tasks from your StartTask action are listed here.

" } }, "HostVolumeProperties": { "base": null, "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": { "ContainerDefinition$cpu": "

The number of cpu units reserved for the container. A container instance has 1,024 cpu units for every CPU core.

", "ContainerDefinition$memory": "

The number of MiB of memory reserved for the container. Docker will allocate a minimum of 4 MiB of memory to a container.

", "PortMapping$containerPort": "

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 will automatically receive a host port in the 49153 to 65535 port range.

", "PortMapping$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 while specifying a containerPort and your container will automatically receive a port in the 49153 to 65535 port range. You should not attempt to specify a host port in the 49153 to 65535 port range, since these are reserved for automatic assignment.

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 (once 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).

", "Resource$integerValue": "

When the integerValue type is set, the value of the resource must be an integer.

", "TaskDefinition$revision": "

The revision of the task in a particular family. You can think of the revision as a version number of a task definition in a family. When you register a task definition for the first time, the revision is 1, and each time you register a task definition in the same family, the revision value increases by one.

" } }, "KeyValuePair": { "base": null, "refs": { "EnvironmentVariables$member": null } }, "ListClustersRequest": { "base": null, "refs": { } }, "ListClustersResponse": { "base": null, "refs": { } }, "ListContainerInstancesRequest": { "base": null, "refs": { } }, "ListContainerInstancesResponse": { "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": { } }, "Long": { "base": null, "refs": { "Resource$longValue": "

When the longValue type is set, the value of the resource must be an extended precision floating-point type.

" } }, "MountPoint": { "base": null, "refs": { "MountPointList$member": null } }, "MountPointList": { "base": null, "refs": { "ContainerDefinition$mountPoints": "

The mount points for data volumes in your container.

" } }, "NetworkBinding": { "base": null, "refs": { "NetworkBindings$member": null } }, "NetworkBindings": { "base": null, "refs": { "Container$networkBindings": null, "SubmitContainerStateChangeRequest$networkBindings": "

The network bindings of the container.

" } }, "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.

", "refs": { "PortMappingList$member": null } }, "PortMappingList": { "base": null, "refs": { "ContainerDefinition$portMappings": "

The list of port mappings for the container.

" } }, "RegisterContainerInstanceRequest": { "base": null, "refs": { } }, "RegisterContainerInstanceResponse": { "base": null, "refs": { } }, "RegisterTaskDefinitionRequest": { "base": null, "refs": { } }, "RegisterTaskDefinitionResponse": { "base": null, "refs": { } }, "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": null } }, "RunTaskRequest": { "base": null, "refs": { } }, "RunTaskResponse": { "base": null, "refs": { } }, "ServerException": { "base": "

These errors are usually caused by a server-side issue.

", "refs": { } }, "StartTaskRequest": { "base": null, "refs": { } }, "StartTaskResponse": { "base": null, "refs": { } }, "StopTaskRequest": { "base": null, "refs": { } }, "StopTaskResponse": { "base": null, "refs": { } }, "String": { "base": null, "refs": { "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.

", "Cluster$clusterName": "

A user-generated string that you can 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.

", "Container$containerArn": "

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.

", "ContainerDefinition$image": "

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.

", "ContainerInstance$containerInstanceArn": "

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 UUID. For example, arn:aws:ecs:region:aws_account_id:container-instance/container_instance_UUID.

", "ContainerInstance$ec2InstanceId": "

The Amazon 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.

", "ContainerOverride$name": "

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 will create a cluster named default.

", "DeleteClusterRequest$cluster": "

The short name or full Amazon Resource Name (ARN) of the cluster that you want to delete.

", "DeregisterContainerInstanceRequest$cluster": "

The short name or full Amazon Resource Name (ARN) of the cluster that hosts the container instance you want to deregister. If you do not specify a cluster, the default cluster is assumed.

", "DeregisterContainerInstanceRequest$containerInstance": "

The container instance UUID or full Amazon Resource Name (ARN) of the container instance you want 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 UUID. For example, arn:aws:ecs:region:aws_account_id:container-instance/container_instance_UUID.

", "DeregisterTaskDefinitionRequest$taskDefinition": "

The family and revision (family:revision) or full Amazon Resource Name (ARN) of the task definition that you want to deregister.

", "DescribeContainerInstancesRequest$cluster": "

The short name or full Amazon Resource Name (ARN) of the cluster that hosts the container instances you want to describe. If you do not specify a cluster, the default cluster is assumed.

", "DescribeTaskDefinitionRequest$taskDefinition": "

The family for the latest revision, family and revision (family:revision) for a specific revision in the family, or full Amazon Resource Name (ARN) of the task definition that you want to describe.

", "DescribeTasksRequest$cluster": "

The short name or full Amazon Resource Name (ARN) of the cluster that hosts the task you want to describe. If you do not specify a cluster, the default cluster is assumed.

", "DiscoverPollEndpointRequest$containerInstance": "

The container instance UUID 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 UUID. For example, arn:aws:ecs:region:aws_account_id:container-instance/container_instance_UUID.

", "DiscoverPollEndpointRequest$cluster": "

The cluster that the container instance belongs to.

", "DiscoverPollEndpointResponse$endpoint": "

The endpoint for the Amazon ECS agent to poll.

", "Failure$arn": "

The Amazon Resource Name (ARN) of the failed resource.

", "Failure$reason": "

The reason for the failure.

", "HostVolumeProperties$sourcePath": "

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.

", "KeyValuePair$value": "

The value of the key value pair.

", "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.

", "ListClustersResponse$nextToken": "

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.

", "ListContainerInstancesRequest$cluster": "

The short name or full Amazon Resource Name (ARN) of the cluster that hosts the container instances you want 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.

", "ListContainerInstancesResponse$nextToken": "

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.

", "ListTaskDefinitionFamiliesRequest$familyPrefix": "

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.

", "ListTaskDefinitionFamiliesRequest$nextToken": "

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.

", "ListTaskDefinitionFamiliesResponse$nextToken": "

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.

", "ListTaskDefinitionsRequest$familyPrefix": "

The full family name that you want to filter the ListTaskDefinitions results with. Specifying a familyPrefix will limit the listed task definitions to task definition revisions that belong to that family.

", "ListTaskDefinitionsRequest$nextToken": "

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.

", "ListTaskDefinitionsResponse$nextToken": "

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.

", "ListTasksRequest$cluster": "

The short name or full Amazon Resource Name (ARN) of the cluster that hosts the tasks you want to list. If you do not specify a cluster, the default cluster is assumed..

", "ListTasksRequest$containerInstance": "

The container instance UUID or full Amazon Resource Name (ARN) of the container instance that you want to filter the ListTasks results with. Specifying a containerInstance will limit the results to tasks that belong to that container instance.

", "ListTasksRequest$family": "

The name of the family that you want to filter the ListTasks results with. Specifying a family will limit the results to tasks that belong to that family.

", "ListTasksRequest$nextToken": "

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.

", "ListTasksResponse$nextToken": "

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.

", "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 that you want to register your container instance with. If you do not specify a cluster, the default cluster is assumed..

", "RegisterContainerInstanceRequest$instanceIdentityDocument": null, "RegisterContainerInstanceRequest$instanceIdentityDocumentSignature": null, "RegisterTaskDefinitionRequest$family": "

You must specify a family for a task definition, which allows you to track multiple versions of the same task definition. You can think of the family as a name for your task definition.

", "Resource$name": "

The name of the resource, such as CPU, MEMORY, PORTS, or a user-defined resource.

", "Resource$type": "

The type of the resource, such as INTEGER, DOUBLE, LONG, or STRINGSET.

", "RunTaskRequest$cluster": "

The short name or full Amazon Resource Name (ARN) of the cluster that you want to run your task on. 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 that you want to run.

", "ServerException$message": null, "StartTaskRequest$cluster": "

The short name or full Amazon Resource Name (ARN) of the cluster that you want to start your task on. 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 that you want to start.

", "StopTaskRequest$cluster": "

The short name or full Amazon Resource Name (ARN) of the cluster that hosts the task you want to stop. If you do not specify a cluster, the default cluster is assumed..

", "StopTaskRequest$task": "

The task UUIDs or full Amazon Resource Name (ARN) entry of the task you would like 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 UUID 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 UUID 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.

", "TaskDefinition$taskDefinitionArn": "

The full Amazon Resource Name (ARN) of the of the task definition.

", "TaskDefinition$family": "

The family of your task definition. You can think of the family as the name of your task definition.

", "Volume$name": "

The name of the volume. This name is referenced in the sourceVolume parameter of container definition mountPoints.

", "VolumeFrom$sourceContainer": "

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. For more information on linking Docker containers, see https://docs.docker.com/userguide/dockerlinks/.

", "ContainerDefinition$entryPoint": "

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 ENTRYPOINT that is passed to the container. For more information on the Docker ENTRYPOINT parameter, see https://docs.docker.com/reference/builder/#entrypoint.

", "ContainerDefinition$command": "

The CMD that is passed to the container. For more information on the Docker CMD parameter, see https://docs.docker.com/reference/builder/#cmd.

", "ContainerOverride$command": "

The command to send to the container that receives the override.

", "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 UUIDs or full Amazon Resource Name (ARN) entries.

", "DescribeTasksRequest$tasks": "

A space-separated list of task UUIDs 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 instance full Amazon Resource Name (ARN) entries for each container instance associated with the specified cluster.

", "ListTaskDefinitionFamiliesResponse$families": "

The list of task definition family names that match the ListTaskDefinitionFamilies request.

", "ListTaskDefinitionsResponse$taskDefinitionArns": "

The list of task definition Amazon Resource Name (ARN) entries for the ListTaskDefintions request.

", "ListTasksResponse$taskArns": "

The list of task Amazon Resource Name (ARN) entries for the ListTasks request.

", "Resource$stringSetValue": "

When the stringSetValue type is set, the value of the resource must be a string type.

", "StartTaskRequest$containerInstances": "

The container instance UUIDs or full Amazon Resource Name (ARN) entries for the container instances on which you would like to place your task.

" } }, "SubmitContainerStateChangeRequest": { "base": null, "refs": { } }, "SubmitContainerStateChangeResponse": { "base": null, "refs": { } }, "SubmitTaskStateChangeRequest": { "base": null, "refs": { } }, "SubmitTaskStateChangeResponse": { "base": null, "refs": { } }, "Task": { "base": null, "refs": { "StopTaskResponse$task": null, "Tasks$member": null } }, "TaskDefinition": { "base": null, "refs": { "DeregisterTaskDefinitionResponse$taskDefinition": "

The full description of the deregistered task.

", "DescribeTaskDefinitionResponse$taskDefinition": "

The full task definition description.

", "RegisterTaskDefinitionResponse$taskDefinition": null } }, "TaskOverride": { "base": null, "refs": { "RunTaskRequest$overrides": null, "StartTaskRequest$overrides": null, "Task$overrides": "

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 will be described here.

", "StartTaskResponse$tasks": "

A full description of the tasks that were started. Each task that was successfully placed on your container instances will be described here.

" } }, "Volume": { "base": null, "refs": { "VolumeList$member": null } }, "VolumeFrom": { "base": null, "refs": { "VolumeFromList$member": null } }, "VolumeFromList": { "base": null, "refs": { "ContainerDefinition$volumesFrom": "

Data volumes to mount from another container.

" } }, "VolumeList": { "base": null, "refs": { "RegisterTaskDefinitionRequest$volumes": "

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 on volume definition parameters and defaults, see Amazon ECS Task Definitions in the Amazon EC2 Container Service Developer Guide.

" } } } }