diff --git a/agent/app/agent.go b/agent/app/agent.go index 7152c42154b..6583ca36398 100644 --- a/agent/app/agent.go +++ b/agent/app/agent.go @@ -556,8 +556,8 @@ func (agent *ecsAgent) startAsyncRoutines( statsEngine := stats.NewDockerStatsEngine(agent.cfg, agent.dockerClient, containerChangeEventStream) - // Start serving the endpoint to fetch IAM Role credentials and other task metadata state.SetECSClient(client) + // Start serving the endpoint to fetch IAM Role credentials and other task metadata go handlers.ServeTaskHTTPEndpoint(credentialsManager, state, agent.containerInstanceARN, agent.cfg, statsEngine, agent.availabilityZone) // Start sending events to the backend diff --git a/agent/ecs_client/model/api/api-2.json b/agent/ecs_client/model/api/api-2.json index a172ac4c866..a434e991bb3 100644 --- a/agent/ecs_client/model/api/api-2.json +++ b/agent/ecs_client/model/api/api-2.json @@ -223,20 +223,6 @@ {"shape":"ClientException"} ] }, - "ListAccountSettings":{ - "name":"ListAccountSettings", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"ListAccountSettingsRequest"}, - "output":{"shape":"ListAccountSettingsResponse"}, - "errors":[ - {"shape":"ServerException"}, - {"shape":"ClientException"}, - {"shape":"InvalidParameterException"} - ] - }, "ListAttributes":{ "name":"ListAttributes", "http":{ @@ -488,38 +474,6 @@ {"shape":"AccessDeniedException"} ] }, - "TagResource":{ - "name":"TagResource", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"TagResourceRequest"}, - "output":{"shape":"TagResourceResponse"}, - "errors":[ - {"shape":"ServerException"}, - {"shape":"ClientException"}, - {"shape":"ClusterNotFoundException"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"InvalidParameterException"} - ] - }, - "UntagResource":{ - "name":"UntagResource", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"UntagResourceRequest"}, - "output":{"shape":"UntagResourceResponse"}, - "errors":[ - {"shape":"ServerException"}, - {"shape":"ClientException"}, - {"shape":"ClusterNotFoundException"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"InvalidParameterException"} - ] - }, "UpdateContainerAgent":{ "name":"UpdateContainerAgent", "http":{ @@ -691,9 +645,7 @@ "registeredContainerInstancesCount":{"shape":"Integer"}, "runningTasksCount":{"shape":"Integer"}, "pendingTasksCount":{"shape":"Integer"}, - "activeServicesCount":{"shape":"Integer"}, - "statistics":{"shape":"Statistics"}, - "tags":{"shape":"Tags"} + "activeServicesCount":{"shape":"Integer"} } }, "ClusterContainsContainerInstancesException":{ @@ -716,10 +668,7 @@ }, "ClusterField":{ "type":"string", - "enum":[ - "STATISTICS", - "TAGS" - ] + "enum":["STATISTICS"] }, "ClusterFieldList":{ "type":"list", @@ -832,14 +781,6 @@ } } }, - "ContainerInstanceField":{ - "type":"string", - "enum":["TAGS"] - }, - "ContainerInstanceFieldList":{ - "type":"list", - "member":{"shape":"ContainerInstanceField"} - }, "ContainerInstanceStatus":{ "type":"string", "enum":[ @@ -887,8 +828,7 @@ "CreateClusterRequest":{ "type":"structure", "members":{ - "clusterName":{"shape":"String"}, - "tags":{"shape":"Tags"} + "clusterName":{"shape":"String"} } }, "CreateClusterResponse":{ @@ -919,11 +859,7 @@ "placementStrategy":{"shape":"PlacementStrategies"}, "networkConfiguration":{"shape":"NetworkConfiguration"}, "healthCheckGracePeriodSeconds":{"shape":"BoxedInteger"}, - "schedulingStrategy":{"shape":"SchedulingStrategy"}, - "deploymentController":{"shape":"DeploymentController"}, - "tags":{"shape":"Tags"}, - "enableECSManagedTags":{"shape":"Boolean"}, - "propagateTags":{"shape":"PropagateTags"} + "schedulingStrategy":{"shape":"SchedulingStrategy"} } }, "CreateServiceResponse":{ @@ -994,7 +930,7 @@ "id":{"shape":"String"}, "status":{"shape":"String"}, "taskDefinition":{"shape":"String"}, - "desiredCount":{"shape":"Integer"}, + "desiredCount":{"shape":"BoxedInteger"}, "pendingCount":{"shape":"Integer"}, "runningCount":{"shape":"Integer"}, "createdAt":{"shape":"Timestamp"}, @@ -1011,20 +947,6 @@ "minimumHealthyPercent":{"shape":"BoxedInteger"} } }, - "DeploymentController":{ - "type":"structure", - "required":["type"], - "members":{ - "type":{"shape":"DeploymentControllerType"} - } - }, - "DeploymentControllerType":{ - "type":"string", - "enum":[ - "ECS", - "CODE_DEPLOY" - ] - }, "Deployments":{ "type":"list", "member":{"shape":"Deployment"} @@ -1076,8 +998,7 @@ "required":["containerInstances"], "members":{ "cluster":{"shape":"String"}, - "containerInstances":{"shape":"StringList"}, - "include":{"shape":"ContainerInstanceFieldList"} + "containerInstances":{"shape":"StringList"} } }, "DescribeContainerInstancesResponse":{ @@ -1092,8 +1013,7 @@ "required":["services"], "members":{ "cluster":{"shape":"String"}, - "services":{"shape":"StringList"}, - "include":{"shape":"ServiceFieldList"} + "services":{"shape":"StringList"} } }, "DescribeServicesResponse":{ @@ -1107,15 +1027,13 @@ "type":"structure", "required":["taskDefinition"], "members":{ - "taskDefinition":{"shape":"String"}, - "include":{"shape":"TaskDefinitionFieldList"} + "taskDefinition":{"shape":"String"} } }, "DescribeTaskDefinitionResponse":{ "type":"structure", "members":{ - "taskDefinition":{"shape":"TaskDefinition"}, - "tags":{"shape":"Tags"} + "taskDefinition":{"shape":"TaskDefinition"} } }, "DescribeTasksRequest":{ @@ -1123,8 +1041,7 @@ "required":["tasks"], "members":{ "cluster":{"shape":"String"}, - "tasks":{"shape":"StringList"}, - "include":{"shape":"TaskFieldList"} + "tasks":{"shape":"StringList"} } }, "DescribeTasksResponse":{ @@ -1298,24 +1215,6 @@ "tmpfs":{"shape":"TmpfsList"} } }, - "ListAccountSettingsRequest":{ - "type":"structure", - "members":{ - "name":{"shape":"SettingName"}, - "value":{"shape":"String"}, - "principalArn":{"shape":"String"}, - "effectiveSettings":{"shape":"Boolean"}, - "nextToken":{"shape":"String"}, - "maxResults":{"shape":"Integer"} - } - }, - "ListAccountSettingsResponse":{ - "type":"structure", - "members":{ - "settings":{"shape":"Settings"}, - "nextToken":{"shape":"String"} - } - }, "ListAttributesRequest":{ "type":"structure", "required":["targetType"], @@ -1621,13 +1520,6 @@ "type":"list", "member":{"shape":"PortMapping"} }, - "PropagateTags":{ - "type":"string", - "enum":[ - "TASK_DEFINITION", - "SERVICE" - ] - }, "PutAccountSettingRequest":{ "type":"structure", "required":[ @@ -1699,16 +1591,15 @@ "requiresCompatibilities":{"shape":"CompatibilityList"}, "cpu":{"shape":"String"}, "memory":{"shape":"String"}, - "tags":{"shape":"Tags"}, "pidMode":{"shape":"PidMode"}, - "ipcMode":{"shape":"IpcMode"} + "ipcMode":{"shape":"IpcMode"}, + "tags":{"shape":"Tags"} } }, "RegisterTaskDefinitionResponse":{ "type":"structure", "members":{ - "taskDefinition":{"shape":"TaskDefinition"}, - "tags":{"shape":"Tags"} + "taskDefinition":{"shape":"TaskDefinition"} } }, "RepositoryCredentials":{ @@ -1757,10 +1648,7 @@ "placementStrategy":{"shape":"PlacementStrategies"}, "launchType":{"shape":"LaunchType"}, "platformVersion":{"shape":"String"}, - "networkConfiguration":{"shape":"NetworkConfiguration"}, - "tags":{"shape":"Tags"}, - "enableECSManagedTags":{"shape":"Boolean"}, - "propagateTags":{"shape":"PropagateTags"} + "networkConfiguration":{"shape":"NetworkConfiguration"} } }, "RunTaskResponse":{ @@ -1770,16 +1658,12 @@ "failures":{"shape":"Failures"} } }, - "Scale":{ - "type":"structure", - "members":{ - "value":{"shape":"Double"}, - "unit":{"shape":"ScaleUnit"} - } - }, - "ScaleUnit":{ + "Scope":{ "type":"string", - "enum":["PERCENT"] + "enum":[ + "task", + "shared" + ] }, "SchedulingStrategy":{ "type":"string", @@ -1820,14 +1704,13 @@ "loadBalancers":{"shape":"LoadBalancers"}, "serviceRegistries":{"shape":"ServiceRegistries"}, "status":{"shape":"String"}, - "desiredCount":{"shape":"Integer"}, + "desiredCount":{"shape":"BoxedInteger"}, "runningCount":{"shape":"Integer"}, "pendingCount":{"shape":"Integer"}, "launchType":{"shape":"LaunchType"}, "platformVersion":{"shape":"String"}, "taskDefinition":{"shape":"String"}, "deploymentConfiguration":{"shape":"DeploymentConfiguration"}, - "taskSets":{"shape":"TaskSets"}, "deployments":{"shape":"Deployments"}, "roleArn":{"shape":"String"}, "events":{"shape":"ServiceEvents"}, @@ -1836,12 +1719,7 @@ "placementStrategy":{"shape":"PlacementStrategies"}, "networkConfiguration":{"shape":"NetworkConfiguration"}, "healthCheckGracePeriodSeconds":{"shape":"BoxedInteger"}, - "schedulingStrategy":{"shape":"SchedulingStrategy"}, - "deploymentController":{"shape":"DeploymentController"}, - "tags":{"shape":"Tags"}, - "createdBy":{"shape":"String"}, - "enableECSManagedTags":{"shape":"Boolean"}, - "propagateTags":{"shape":"PropagateTags"} + "schedulingStrategy":{"shape":"SchedulingStrategy"} } }, "ServiceEvent":{ @@ -1856,14 +1734,6 @@ "type":"list", "member":{"shape":"ServiceEvent"} }, - "ServiceField":{ - "type":"string", - "enum":["TAGS"] - }, - "ServiceFieldList":{ - "type":"list", - "member":{"shape":"ServiceField"} - }, "ServiceNotActiveException":{ "type":"structure", "members":{ @@ -1909,10 +1779,6 @@ "containerInstanceLongArnFormat" ] }, - "Settings":{ - "type":"list", - "member":{"shape":"Setting"} - }, "SortOrder":{ "type":"string", "enum":[ @@ -1920,13 +1786,6 @@ "DESC" ] }, - "StabilityStatus":{ - "type":"string", - "enum":[ - "STEADY_STATE", - "STABILIZING" - ] - }, "StartTaskRequest":{ "type":"structure", "required":[ @@ -1940,10 +1799,7 @@ "containerInstances":{"shape":"StringList"}, "startedBy":{"shape":"String"}, "group":{"shape":"String"}, - "networkConfiguration":{"shape":"NetworkConfiguration"}, - "tags":{"shape":"Tags"}, - "enableECSManagedTags":{"shape":"Boolean"}, - "propagateTags":{"shape":"PropagateTags"} + "networkConfiguration":{"shape":"NetworkConfiguration"} } }, "StartTaskResponse":{ @@ -1953,10 +1809,6 @@ "failures":{"shape":"Failures"} } }, - "Statistics":{ - "type":"list", - "member":{"shape":"KeyValuePair"} - }, "StopTaskRequest":{ "type":"structure", "required":["task"], @@ -2023,8 +1875,8 @@ "SystemControl":{ "type":"structure", "members":{ - "namespace":{"shape":"String"}, - "value":{"shape":"String"} + "namespace":{"shape":"String"}, + "value":{"shape":"String"} } }, "SystemControls":{ @@ -2044,26 +1896,6 @@ "min":1, "pattern":"^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$" }, - "TagKeys":{ - "type":"list", - "member":{"shape":"TagKey"} - }, - "TagResourceRequest":{ - "type":"structure", - "required":[ - "resourceArn", - "tags" - ], - "members":{ - "resourceArn":{"shape":"String"}, - "tags":{"shape":"Tags"} - } - }, - "TagResourceResponse":{ - "type":"structure", - "members":{ - } - }, "TagValue":{ "type":"string", "max":256, @@ -2102,7 +1934,6 @@ "startedBy":{"shape":"String"}, "version":{"shape":"Long"}, "stoppedReason":{"shape":"String"}, - "stopCode":{"shape":"TaskStopCode"}, "connectivity":{"shape":"Connectivity"}, "connectivityAt":{"shape":"Timestamp"}, "pullStartedAt":{"shape":"Timestamp"}, @@ -2150,14 +1981,6 @@ "ALL" ] }, - "TaskDefinitionField":{ - "type":"string", - "enum":["TAGS"] - }, - "TaskDefinitionFieldList":{ - "type":"list", - "member":{"shape":"TaskDefinitionField"} - }, "TaskDefinitionPlacementConstraint":{ "type":"structure", "members":{ @@ -2180,14 +2003,6 @@ "INACTIVE" ] }, - "TaskField":{ - "type":"string", - "enum":["TAGS"] - }, - "TaskFieldList":{ - "type":"list", - "member":{"shape":"TaskField"} - }, "TaskOverride":{ "type":"structure", "members":{ @@ -2196,41 +2011,6 @@ "executionRoleArn":{"shape":"String"} } }, - "TaskSet":{ - "type":"structure", - "members":{ - "id":{"shape":"String"}, - "taskSetArn":{"shape":"String"}, - "startedBy":{"shape":"String"}, - "externalId":{"shape":"String"}, - "status":{"shape":"String"}, - "taskDefinition":{"shape":"String"}, - "computedDesiredCount":{"shape":"Integer"}, - "pendingCount":{"shape":"Integer"}, - "runningCount":{"shape":"Integer"}, - "createdAt":{"shape":"Timestamp"}, - "updatedAt":{"shape":"Timestamp"}, - "launchType":{"shape":"LaunchType"}, - "platformVersion":{"shape":"String"}, - "networkConfiguration":{"shape":"NetworkConfiguration"}, - "loadBalancers":{"shape":"LoadBalancers"}, - "scale":{"shape":"Scale"}, - "stabilityStatus":{"shape":"StabilityStatus"}, - "stabilityStatusAt":{"shape":"Timestamp"} - } - }, - "TaskSets":{ - "type":"list", - "member":{"shape":"TaskSet"} - }, - "TaskStopCode":{ - "type":"string", - "enum":[ - "TaskFailedToStart", - "EssentialContainerExited", - "UserInitiated" - ] - }, "Tasks":{ "type":"list", "member":{"shape":"Task"} @@ -2302,22 +2082,6 @@ }, "exception":true }, - "UntagResourceRequest":{ - "type":"structure", - "required":[ - "resourceArn", - "tagKeys" - ], - "members":{ - "resourceArn":{"shape":"String"}, - "tagKeys":{"shape":"TagKeys"} - } - }, - "UntagResourceResponse":{ - "type":"structure", - "members":{ - } - }, "UpdateContainerAgentRequest":{ "type":"structure", "required":["containerInstance"], diff --git a/agent/ecs_client/model/api/docs-2.json b/agent/ecs_client/model/api/docs-2.json index 56064435e72..4e346616d42 100644 --- a/agent/ecs_client/model/api/docs-2.json +++ b/agent/ecs_client/model/api/docs-2.json @@ -3,42 +3,36 @@ "service": "

Amazon Elastic Container Service (Amazon ECS) is a highly scalable, fast, container management service that makes it easy to run, stop, and manage Docker containers on a cluster. You can host your cluster on a serverless infrastructure that is managed by Amazon ECS by launching your services or tasks using the Fargate launch type. For more control, you can host your tasks on a cluster of Amazon Elastic Compute Cloud (Amazon EC2) instances that you manage by using the EC2 launch type. For more information about launch types, see Amazon ECS Launch Types.

Amazon ECS lets you launch and stop container-based applications with simple API calls, allows you to get the state of your cluster from a centralized service, and gives you access to many familiar Amazon EC2 features.

You can use Amazon ECS to schedule the placement of containers across your cluster based on your resource needs, isolation policies, and availability requirements. Amazon ECS eliminates the need for you to operate your own cluster management and configuration management systems or worry about scaling your management infrastructure.

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

When you call the CreateCluster API operation, Amazon ECS attempts to create the service-linked role for your account so that required resources in other AWS services can be managed on your behalf. However, if the IAM user that makes the call does not have permissions to create the service-linked role, it is not created. For more information, see Using Service-Linked Roles for Amazon ECS in the Amazon Elastic Container Service Developer Guide.

", - "CreateService": "

Runs and maintains a desired number of tasks from a specified task definition. If the number of tasks running in a service drops below desiredCount, Amazon ECS spawns another copy of the task in the specified cluster. To update an existing service, see UpdateService.

In addition to maintaining the desired count of tasks in your service, you can optionally run your service behind a load balancer. The load balancer distributes traffic across the tasks that are associated with the service. For more information, see Service Load Balancing in the Amazon Elastic Container Service Developer Guide.

You can optionally specify a deployment configuration for your service. The deployment is triggered by changing properties, such as the task definition or the desired count of a service, with an UpdateService operation.

If a service is using the ECS deployment controller, the minimum healthy percent represents a lower limit on the number of tasks in a service that must remain in the RUNNING state during a deployment, as a percentage of the desired number of tasks (rounded up to the nearest integer), and while any container instances are in the DRAINING state if the service contains tasks using the EC2 launch type. This parameter enables you to deploy without using additional cluster capacity. For example, if your service has a desired number of four tasks and a minimum healthy percent of 50%, the scheduler may stop two existing tasks to free up cluster capacity before starting two new tasks. Tasks for services that do not use a load balancer are considered healthy if they are in the RUNNING state; tasks for services that do use a load balancer are considered healthy if they are in the RUNNING state and they are reported as healthy by the load balancer. The default value for minimum healthy percent is 100%.

If a service is using the ECS deployment controller, the maximum percent parameter represents an upper limit on the number of tasks in a service that are allowed in the RUNNING or PENDING state during a deployment, as a percentage of the desired number of tasks (rounded down to the nearest integer), and while any container instances are in the DRAINING state if the service contains tasks using the EC2 launch type. This parameter enables you to define the deployment batch size. For example, if your service has a desired number of four tasks and a maximum percent value of 200%, the scheduler may start four new tasks before stopping the four older tasks (provided that the cluster resources required to do this are available). The default value for maximum percent is 200%.

If a service is using the CODE_DEPLOY deployment controller and tasks that use the EC2 launch type, the minimum healthy percent and maximum percent values are only used to define the lower and upper limit on the number of the tasks in the service that remain in the RUNNING state while the container instances are in the DRAINING state. If the tasks in the service use the Fargate launch type, the minimum healthy percent and maximum percent values are not used, although they are currently visible when describing your service.

Tasks for services that do not use a load balancer are considered healthy if they are in the RUNNING state. Tasks for services that do use a load balancer are considered healthy if they are in the RUNNING state and the container instance they are hosted on is reported as healthy by the load balancer. The default value for a replica service for minimumHealthyPercent is 100%. The default value for a daemon service for minimumHealthyPercent is 0%.

When the service scheduler launches new tasks, it determines task placement in your cluster using the following logic:

", - "DeleteAccountSetting": "

Modifies the ARN and resource ID format of a resource for a specified IAM user, IAM role, or the root user for an account. You can specify whether the new ARN and resource ID format are disabled for new resources that are created.

", + "CreateService": "

Runs and maintains a desired number of tasks from a specified task definition. If the number of tasks running in a service drops below desiredCount, Amazon ECS spawns another copy of the task in the specified cluster. To update an existing service, see UpdateService.

In addition to maintaining the desired count of tasks in your service, you can optionally run your service behind a load balancer. The load balancer distributes traffic across the tasks that are associated with the service. For more information, see Service Load Balancing in the Amazon Elastic Container Service Developer Guide.

You can optionally specify a deployment configuration for your service. During a deployment, the service scheduler uses the minimumHealthyPercent and maximumPercent parameters to determine the deployment strategy. The deployment is triggered by changing the task definition or the desired count of a service with an UpdateService operation.

The minimumHealthyPercent represents a lower limit on the number of your service's tasks that must remain in the RUNNING state during a deployment, as a percentage of the desiredCount (rounded up to the nearest integer). This parameter enables you to deploy without using additional cluster capacity. For example, if your service has a desiredCount of four tasks and a minimumHealthyPercent of 50%, the scheduler can stop two existing tasks to free up cluster capacity before starting two new tasks. Tasks for services that do not use a load balancer are considered healthy if they are in the RUNNING state. Tasks for services that do use a load balancer are considered healthy if they are in the RUNNING state and the container instance they are hosted on is reported as healthy by the load balancer. The default value for a replica service for minimumHealthyPercent is 50% in the console and 100% for the AWS CLI, the AWS SDKs, and the APIs. The default value for a daemon service for minimumHealthyPercent is 0% for the AWS CLI, the AWS SDKs, and the APIs and 50% for the console.

The maximumPercent parameter represents an upper limit on the number of your service's tasks that are allowed in the RUNNING or PENDING state during a deployment, as a percentage of the desiredCount (rounded down to the nearest integer). This parameter enables you to define the deployment batch size. For example, if your replica service has a desiredCount of four tasks and a maximumPercent value of 200%, the scheduler can start four new tasks before stopping the four older tasks (provided that the cluster resources required to do this are available). The default value for a replica service for maximumPercent is 200%. If you are using a daemon service type, the maximumPercent should remain at 100%, which is the default value.

When the service scheduler launches new tasks, it determines task placement in your cluster using the following logic:

", "DeleteAttributes": "

Deletes one or more custom attributes from an Amazon ECS resource.

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

", - "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 the ListServices API operation. 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 the DescribeServices API operation. However, in the future, INACTIVE services may be cleaned up and purged from Amazon ECS record keeping, and DescribeServices calls on those services return a ServiceNotFoundException error.

If you attempt to create a new service with the same name as an existing service in either ACTIVE or DRAINING status, you receive an error.

", - "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. That prevents any orphaned tasks from consuming resources.

Deregistering a container instance removes the instance from a cluster, but it does not terminate the EC2 instance. If you are finished using the instance, be sure to terminate it in the Amazon EC2 console to stop billing.

If you terminate a running container instance, Amazon ECS automatically deregisters the instance from your cluster (stopped container instances or instances with disconnected agents are not automatically deregistered when terminated).

", - "DeregisterTaskDefinition": "

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. However, there may be up to a 10-minute window following deregistration where these restrictions have not yet taken effect.

At this time, INACTIVE task definitions remain discoverable in your account indefinitely. However, this behavior is subject to change in the future, so you should not rely on INACTIVE task definitions persisting beyond the lifecycle of any associated tasks and services.

", + "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 return a ServiceNotFoundException error.

", + "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. That prevents any orphaned tasks from consuming resources.

Deregistering a container instance removes the instance from a cluster, but it does not terminate the EC2 instance; if you are finished using the instance, be sure to terminate it in the Amazon EC2 console to stop billing.

If you terminate a running container instance, Amazon ECS automatically deregisters the instance from your cluster (stopped container instances or instances with disconnected agents are not automatically deregistered when terminated).

", + "DeregisterTaskDefinition": "

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

At this time, INACTIVE task definitions remain discoverable in your account indefinitely; however, this behavior is subject to change in the future, so you should not rely on INACTIVE task definitions persisting beyond the lifecycle of any associated tasks and services.

", "DescribeClusters": "

Describes one or more of your clusters.

", "DescribeContainerInstances": "

Describes Amazon Elastic 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.

", "DescribeTasks": "

Describes a specified task or tasks.

", "DiscoverPollEndpoint": "

This action is only used by the Amazon ECS agent, and it is not intended for use outside of the agent.

Returns an endpoint for the Amazon ECS agent to poll for updates.

", - "ListAccountSettings": "

Lists the account settings for an Amazon ECS resource for a specified principal.

", "ListAttributes": "

Lists the attributes for Amazon ECS resources within a specified target type and cluster. When you specify a target type and cluster, ListAttributes returns a list of attribute objects, one for each attribute on each resource. You can filter the list of results to a single attribute name to only return results that have that name. You can also filter the results by attribute name and value, for example, to see which container instances in a cluster are running a Linux AMI (ecs.os-type=linux).

", "ListClusters": "

Returns a list of existing clusters.

", "ListContainerInstances": "

Returns a list of container instances in a specified cluster. You can filter the results of a ListContainerInstances operation with cluster query language statements inside the filter parameter. For more information, see Cluster Query Language in the Amazon Elastic Container Service Developer Guide.

", "ListServices": "

Lists the services that are running in a specified cluster.

", - "ListTagsForResource": "

List the tags for an Amazon ECS resource.

", "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 definition revisions).

You can filter out task definition families that do not contain any ACTIVE task definition revisions by setting the status parameter to ACTIVE. You can also filter the results with the familyPrefix parameter.

", "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 or by status with the status parameter.

", "ListTasks": "

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

Recently stopped tasks might appear in the returned results. Currently, stopped tasks appear in the returned results for at least one hour.

", - "PutAccountSetting": "

Modifies the ARN and resource ID format of a resource for a specified IAM user, IAM role, or the root user for an account. You can specify whether the new ARN and resource ID format are enabled for new resources that are created. Enabling this setting is required to use new Amazon ECS features such as resource tagging.

", "PutAttributes": "

Create or update an attribute on an Amazon ECS resource. If the attribute does not exist, it is created. If the attribute exists, its value is replaced with the specified value. To delete an attribute, use DeleteAttributes. For more information, see Attributes in the Amazon Elastic Container Service Developer Guide.

", "RegisterContainerInstance": "

This action is only used by the Amazon ECS 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 Elastic Container Service Developer Guide.

You can specify an IAM role for your task with the taskRoleArn parameter. When you specify an IAM role for a task, its containers can then use the latest versions of the AWS CLI or SDKs to make API requests to the AWS services that are specified in the IAM policy associated with the role. For more information, see IAM Roles for Tasks in the Amazon Elastic Container Service Developer Guide.

You can specify a Docker networking mode for the containers in your task definition with the networkMode parameter. The available network modes correspond to those described in Network settings in the Docker run reference. If you specify the awsvpc network mode, the task is allocated an elastic network interface, and you must specify a NetworkConfiguration when you create a service or run a task with the task definition. For more information, see Task Networking in the Amazon Elastic Container Service Developer Guide.

", - "RunTask": "

Starts a new task using the specified task definition.

You can allow Amazon ECS to place tasks for you, or you can customize how Amazon ECS places tasks using placement constraints and placement strategies. For more information, see Scheduling Tasks in the Amazon Elastic Container Service Developer Guide.

Alternatively, you can use StartTask to use your own scheduler or place tasks manually on specific container instances.

The Amazon ECS API follows an eventual consistency model, due to the distributed nature of the system supporting the API. This means that the result of an API command you run that affects your Amazon ECS resources might not be immediately visible to all subsequent commands you run. Keep this in mind when you carry out an API command that immediately follows a previous API command.

To manage eventual consistency, you can do the following:

", + "RunTask": "

Starts a new task using the specified task definition.

You can allow Amazon ECS to place tasks for you, or you can customize how Amazon ECS places tasks using placement constraints and placement strategies. For more information, see Scheduling Tasks in the Amazon Elastic Container Service Developer Guide.

Alternatively, you can use StartTask to use your own scheduler or place tasks manually on specific container instances.

The Amazon ECS API follows an eventual consistency model, due to the distributed nature of the system supporting the API. This means that the result of an API command you run that affects your Amazon ECS resources might not be immediately visible to all subsequent commands you run. You should keep this in mind when you carry out an API command that immediately follows a previous API command.

To manage eventual consistency, you can do the following:

", "StartTask": "

Starts a new task from the specified task definition on the specified container instance or instances.

Alternatively, you can use RunTask to place tasks for you. For more information, see Scheduling Tasks in the Amazon Elastic Container Service Developer Guide.

", - "StopTask": "

Stops a running task. Any tags associated with the task will be deleted.

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 value and a default 30-second timeout, after which the SIGKILL value is sent and the containers are forcibly stopped. If the container handles the SIGTERM value gracefully and exits within 30 seconds from receiving it, no SIGKILL value is sent.

The default 30-second timeout can be configured on the Amazon ECS container agent with the ECS_CONTAINER_STOP_TIMEOUT variable. For more information, see Amazon ECS Container Agent Configuration in the Amazon Elastic Container Service Developer Guide.

", + "StopTask": "

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 default 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.

The default 30-second timeout can be configured on the Amazon ECS container agent with the ECS_CONTAINER_STOP_TIMEOUT variable. For more information, see Amazon ECS Container Agent Configuration in the Amazon Elastic Container Service Developer Guide.

", "SubmitContainerStateChange": "

This action is only used by the Amazon ECS 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 ECS agent, and it is not intended for use outside of the agent.

Sent to acknowledge that a task changed states.

", - "TagResource": "

Associates the specified tags to a resource with the specified resourceArn. If existing tags on a resource are not specified in the request parameters, they are not changed. When a resource is deleted, the tags associated with that resource are deleted as well.

", - "UntagResource": "

Deletes specified tags from a resource.

", "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 Elastic Container Service Developer Guide.

", - "UpdateContainerInstancesState": "

Modifies the status of an Amazon ECS container instance.

You can change the status of a container instance to DRAINING to manually remove an instance from a cluster, for example to perform system updates, update the Docker daemon, or scale down the cluster size.

When you set a container instance to DRAINING, Amazon ECS prevents new tasks from being scheduled for placement on the container instance and replacement service tasks are started on other container instances in the cluster if the resources are available. Service tasks on the container instance that are in the PENDING state are stopped immediately.

Service tasks on the container instance that are in the RUNNING state are stopped and replaced according to the service's deployment configuration parameters, minimumHealthyPercent and maximumPercent. You can change the deployment configuration of your service using UpdateService.

Any PENDING or RUNNING tasks that do not belong to a service are not affected. You must wait for them to finish or stop them manually.

A container instance has completed draining when it has no more RUNNING tasks. You can verify this using ListTasks.

When you set a container instance to ACTIVE, the Amazon ECS scheduler can begin scheduling tasks on the instance again.

", - "UpdateService": "

Modifies the parameters of a service.

For services using the rolling update (ECS) deployment controller, the desired count, deployment configuration, network configuration, or task definition used can be updated.

For services using the blue/green (CODE_DEPLOY) deployment controller, only the desired count, deployment configuration, and health check grace period can be updated using this API. If the network configuration, platform version, or task definition need to be updated, a new AWS CodeDeploy deployment should be created. For more information, see CreateDeployment in the AWS CodeDeploy API Reference.

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.

If you have updated the Docker image of your application, you can create a new task definition with that image and deploy it to your service. The service scheduler uses the minimum healthy percent and maximum percent parameters (in the service's deployment configuration) to determine the deployment strategy.

If your updated Docker image uses the same tag as what is in the existing task definition for your service (for example, my_image:latest), you do not need to create a new revision of your task definition. You can update the service using the forceNewDeployment option. The new tasks launched by the deployment pull the current image/tag combination from your repository when they start.

You can also update the deployment configuration of a service. When a deployment is triggered by updating the task definition of a service, the service scheduler uses the deployment configuration parameters, minimumHealthyPercent and maximumPercent, to determine the deployment strategy.

When UpdateService stops a task during a deployment, the equivalent of docker stop is issued to the containers running in the task. This results in a SIGTERM and a 30-second timeout, after which SIGKILL is sent and the containers are forcibly stopped. If the container handles the SIGTERM gracefully and exits within 30 seconds from receiving it, no SIGKILL is sent.

When the service scheduler launches new tasks, it determines task placement in your cluster with the following logic:

When the service scheduler stops running tasks, it attempts to maintain balance across the Availability Zones in your cluster using the following logic:

" + "UpdateContainerInstancesState": "

Modifies the status of an Amazon ECS container instance.

You can change the status of a container instance to DRAINING to manually remove an instance from a cluster, for example to perform system updates, update the Docker daemon, or scale down the cluster size.

When you set a container instance to DRAINING, Amazon ECS prevents new tasks from being scheduled for placement on the container instance and replacement service tasks are started on other container instances in the cluster if the resources are available. Service tasks on the container instance that are in the PENDING state are stopped immediately.

Service tasks on the container instance that are in the RUNNING state are stopped and replaced according to the service's deployment configuration parameters, minimumHealthyPercent and maximumPercent. You can change the deployment configuration of your service using UpdateService.

Any PENDING or RUNNING tasks that do not belong to a service are not affected; you must wait for them to finish or stop them manually.

A container instance has completed draining when it has no more RUNNING tasks. You can verify this using ListTasks.

When you set a container instance to ACTIVE, the Amazon ECS scheduler can begin scheduling tasks on the instance again.

", + "UpdateService": "

Modifies the desired count, deployment configuration, network configuration, or task definition used in a service.

You can add to or subtract from the number of instantiations of a task definition in a service by specifying the cluster that the service is running in and a new desiredCount parameter.

If you have updated the Docker image of your application, you can create a new task definition with that image and deploy it to your service. The service scheduler uses the minimum healthy percent and maximum percent parameters (in the service's deployment configuration) to determine the deployment strategy.

If your updated Docker image uses the same tag as what is in the existing task definition for your service (for example, my_image:latest), you do not need to create a new revision of your task definition. You can update the service using the forceNewDeployment option. The new tasks launched by the deployment pull the current image/tag combination from your repository when they start.

You can also update the deployment configuration of a service. When a deployment is triggered by updating the task definition of a service, the service scheduler uses the deployment configuration parameters, minimumHealthyPercent and maximumPercent, to determine the deployment strategy.

When UpdateService stops a task during a deployment, the equivalent of docker stop is issued to the containers running in the task. This results in a SIGTERM and a 30-second timeout, after which SIGKILL is sent and the containers are forcibly stopped. If the container handles the SIGTERM gracefully and exits within 30 seconds from receiving it, no SIGKILL is sent.

When the service scheduler launches new tasks, it determines task placement in your cluster with the following logic:

When the service scheduler stops running tasks, it attempts to maintain balance across the Availability Zones in your cluster using the following logic:

" }, "shapes": { "AccessDeniedException": { @@ -55,7 +49,7 @@ "AssignPublicIp": { "base": null, "refs": { - "AwsVpcConfiguration$assignPublicIp": "

Whether the task's elastic network interface receives a public IP address. The default value is DISABLED.

" + "AwsVpcConfiguration$assignPublicIp": "

Whether the task's elastic network interface receives a public IP address.

" } }, "Attachment": { @@ -86,7 +80,7 @@ "base": null, "refs": { "ContainerInstance$attachments": "

The elastic network interfaces associated with the container instance.

", - "Task$attachments": "

The Elastic Network Adapter associated with the task if the task uses the awsvpc network mode.

" + "Task$attachments": "

The elastic network adapter associated with the task if the task uses the awsvpc network mode.

" } }, "Attribute": { @@ -120,7 +114,7 @@ } }, "BlockedException": { - "base": "

Your AWS account has been blocked. For more information, contact AWS Support.

", + "base": "

Your AWS account has been blocked. Contact AWS Support for more information.

", "refs": { } }, @@ -128,11 +122,6 @@ "base": null, "refs": { "ContainerInstance$agentConnected": "

This parameter returns true if the agent is connected to Amazon ECS. Registered instances with an agent that may be unhealthy or stopped return false. Only instances connected to an agent can accept placement requests.

", - "CreateServiceRequest$enableECSManagedTags": "

Specifies whether to enable Amazon ECS managed tags for the tasks within the service. For more information, see Tagging Your Amazon ECS Resources in the Amazon Elastic Container Service Developer Guide.

", - "ListAccountSettingsRequest$effectiveSettings": "

Specifies whether to return the effective settings. If true, the account settings for the root user or the default setting for the principalArn. If false, the account settings for the principalArn are returned if they are set. Otherwise, no account settings are returned.

", - "RunTaskRequest$enableECSManagedTags": "

Specifies whether to enable Amazon ECS managed tags for the task. For more information, see Tagging Your Amazon ECS Resources in the Amazon Elastic Container Service Developer Guide.

", - "Service$enableECSManagedTags": "

Specifies whether to enable Amazon ECS managed tags for the tasks in the service. For more information, see Tagging Your Amazon ECS Resources in the Amazon Elastic Container Service Developer Guide.

", - "StartTaskRequest$enableECSManagedTags": "

Specifies whether to enable Amazon ECS managed tags for the task. For more information, see Tagging Your Amazon ECS Resources in the Amazon Elastic Container Service Developer Guide.

", "UpdateServiceRequest$forceNewDeployment": "

Whether to force a new deployment of the service. Deployments are not forced by default. You can use this option to trigger a new deployment with no service definition changes. For example, you can update a service's tasks to use a newer Docker image with the same image/tag combination (my_image:latest) or to roll Fargate tasks onto a newer platform version.

" } }, @@ -140,15 +129,12 @@ "base": null, "refs": { "ContainerDefinition$essential": "

If the essential parameter of a container is marked as true, and that container fails or stops for any reason, all other containers that are part of the task are stopped. If the essential parameter of a container is marked as false, then its failure does not affect the rest of the containers in a task. If this parameter is omitted, a container is assumed to be essential.

All tasks must have at least one essential container. If you have an application that is composed of multiple containers, you should group containers that are used for a common purpose into components, and separate the different components into multiple task definitions. For more information, see Application Architecture in the Amazon Elastic Container Service Developer Guide.

", - "ContainerDefinition$disableNetworking": "

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.

This parameter is not supported for Windows containers.

", - "ContainerDefinition$privileged": "

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.

This parameter is not supported for Windows containers or tasks using the Fargate launch type.

", - "ContainerDefinition$readonlyRootFilesystem": "

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.

This parameter is not supported for Windows containers.

", - "ContainerDefinition$interactive": "

When this parameter is true, this allows you to deploy containerized applications that require stdin or a tty to be allocated. This parameter maps to OpenStdin in the Create a container section of the Docker Remote API and the --interactive option to docker run.

", - "ContainerDefinition$pseudoTerminal": "

When this parameter is true, a TTY is allocated. This parameter maps to Tty in the Create a container section of the Docker Remote API and the --tty option to docker run.

", + "ContainerDefinition$disableNetworking": "

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.

This parameter is not supported for Windows containers.

", + "ContainerDefinition$privileged": "

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.

This parameter is not supported for Windows containers or tasks using the Fargate launch type.

", + "ContainerDefinition$readonlyRootFilesystem": "

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.

This parameter is not supported for Windows containers.

", "DeleteServiceRequest$force": "

If true, allows you to delete a service even if it has not been scaled down to zero tasks. It is only necessary to use this if the service is using the REPLICA scheduling strategy.

", "DeregisterContainerInstanceRequest$force": "

Forces the deregistration of the container instance. If you have tasks running on the container instance when you deregister it with the force option, these tasks remain running until you terminate the instance or the tasks stop through some other means, but they are orphaned (no longer monitored or accounted for by Amazon ECS). If an orphaned task on your container instance is part of an Amazon ECS service, then the service scheduler starts another copy of that task, on a different container instance if possible.

Any containers in orphaned service tasks that are registered with a Classic Load Balancer or an Application Load Balancer target group are deregistered. They begin connection draining according to the settings on the load balancer or target group.

", - "DockerVolumeConfiguration$autoprovision": "

If this value is true, the Docker volume is created if it does not already exist.

This field is only used if the scope is shared.

", - "LinuxParameters$initProcessEnabled": "

Run an init process inside the container that forwards signals and reaps processes. This parameter maps to the --init option to docker run. This parameter requires version 1.25 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log in to your container instance and run the following command: sudo docker version --format '{{.Server.APIVersion}}'

", + "LinuxParameters$initProcessEnabled": "

Run an init process inside the container that forwards signals and reaps processes. This parameter maps to the --init option to docker run. This parameter requires version 1.25 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log in to your container instance and run the following command: sudo docker version | grep \"Server API version\"

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

" } @@ -157,16 +143,17 @@ "base": null, "refs": { "Container$exitCode": "

The exit code returned from the container.

", - "ContainerDefinition$memory": "

The hard limit (in MiB) of memory to present to the container. If your container attempts to exceed the memory specified here, the container is killed. This parameter maps to Memory in the Create a container section of the Docker Remote API and the --memory option to docker run.

If your containers are part of a task using the Fargate launch type, this field is optional and the only requirement is that the total amount of memory reserved for all containers within a task be lower than the task memory value.

For containers that are part of a task using the EC2 launch type, you must specify a non-zero integer for one or both of memory or memoryReservation in container definitions. If you specify both, memory must be greater than memoryReservation. If you specify memoryReservation, then that value is subtracted from the available memory resources for the container instance on which the container is placed. Otherwise, the value of memory is used.

The Docker daemon reserves a minimum of 4 MiB of memory for a container, so you should not specify fewer than 4 MiB of memory for your containers.

", - "ContainerDefinition$memoryReservation": "

The soft limit (in MiB) of memory to reserve for the container. When system memory is under heavy contention, Docker attempts to keep the container memory to this soft limit. However, your container can consume more memory when it needs to, up to either the hard limit specified with the memory parameter (if applicable), or all of the available memory on the container instance, whichever comes first. This parameter maps to MemoryReservation in the Create a container section of the Docker Remote API and the --memory-reservation option to docker run.

You must specify a non-zero integer for one or both of memory or memoryReservation in container definitions. If you specify both, memory must be greater than memoryReservation. If you specify memoryReservation, then that value is subtracted from the available memory resources for the container instance on which the container is placed. Otherwise, the value of memory is used.

For example, if your container normally uses 128 MiB of memory, but occasionally bursts to 256 MiB of memory for short periods of time, you can set a memoryReservation of 128 MiB, and a memory hard limit of 300 MiB. This configuration would allow the container to only reserve 128 MiB of memory from the remaining resources on the container instance, but also allow the container to consume more memory resources when needed.

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.

", + "ContainerDefinition$memory": "

The hard limit (in MiB) of memory to present to the container. If your container attempts to exceed the memory specified here, the container is killed. This parameter maps to Memory in the Create a container section of the Docker Remote API and the --memory option to docker run.

If your containers are part of a task using the Fargate launch type, this field is optional and the only requirement is that the total amount of memory reserved for all containers within a task be lower than the task memory value.

For containers that are part of a task using the EC2 launch type, you must specify a non-zero integer for one or both of memory or memoryReservation in container definitions. If you specify both, memory must be greater than memoryReservation. If you specify memoryReservation, then that value is subtracted from the available memory resources for the container instance on which the container is placed; otherwise, the value of memory is used.

The Docker daemon reserves a minimum of 4 MiB of memory for a container, so you should not specify fewer than 4 MiB of memory for your containers.

", + "ContainerDefinition$memoryReservation": "

The soft limit (in MiB) of memory to reserve for the container. When system memory is under heavy contention, Docker attempts to keep the container memory to this soft limit; however, your container can consume more memory when it needs to, up to either the hard limit specified with the memory parameter (if applicable), or all of the available memory on the container instance, whichever comes first. This parameter maps to MemoryReservation in the Create a container section of the Docker Remote API and the --memory-reservation option to docker run.

You must specify a non-zero integer for one or both of memory or memoryReservation in container definitions. If you specify both, memory must be greater than memoryReservation. If you specify memoryReservation, then that value is subtracted from the available memory resources for the container instance on which the container is placed; otherwise, the value of memory is used.

For example, if your container normally uses 128 MiB of memory, but occasionally bursts to 256 MiB of memory for short periods of time, you can set a memoryReservation of 128 MiB, and a memory hard limit of 300 MiB. This configuration would allow the container to only reserve 128 MiB of memory from the remaining resources on the container instance, but also allow the container to consume more memory resources when needed.

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.

", "ContainerOverride$cpu": "

The number of cpu units reserved for the container, instead of the default value from the task definition. You must also specify a container name.

", "ContainerOverride$memory": "

The hard limit (in MiB) of memory to present to the container, instead of the default value from the task definition. If your container attempts to exceed the memory specified here, the container is killed. You must also specify a container name.

", "ContainerOverride$memoryReservation": "

The soft limit (in MiB) of memory to reserve for the container, instead of the default value from the task definition. You must also specify a container name.

", "ContainerStateChange$exitCode": "

The exit code for the container, if the state change is a result of the container exiting.

", "CreateServiceRequest$desiredCount": "

The number of instantiations of the specified task definition to place and keep running on your cluster.

", - "CreateServiceRequest$healthCheckGracePeriodSeconds": "

The period of time, in seconds, that the Amazon ECS service scheduler should ignore unhealthy Elastic Load Balancing target health checks after a task has first started. This is only valid if your service is configured to use a load balancer. If your service's tasks take a while to start and respond to Elastic Load Balancing health checks, you can specify a health check grace period of up to 7,200 seconds. During that time, the ECS service scheduler ignores health check status. This grace period can prevent the ECS service scheduler from marking tasks as unhealthy and stopping them before they have time to come up.

", - "DeploymentConfiguration$maximumPercent": "

If a service is using the rolling update (ECS) deployment type, the maximum percent parameter represents an upper limit on the number of tasks in a service that are allowed in the RUNNING or PENDING state during a deployment, as a percentage of the desired number of tasks (rounded down to the nearest integer), and while any container instances are in the DRAINING state if the service contains tasks using the EC2 launch type. This parameter enables you to define the deployment batch size. For example, if your service has a desired number of four tasks and a maximum percent value of 200%, the scheduler may start four new tasks before stopping the four older tasks (provided that the cluster resources required to do this are available). The default value for maximum percent is 200%.

If a service is using the blue/green (CODE_DEPLOY) deployment type and tasks that use the EC2 launch type, the maximum percent value is set to the default value and is used to define the upper limit on the number of the tasks in the service that remain in the RUNNING state while the container instances are in the DRAINING state. If the tasks in the service use the Fargate launch type, the maximum percent value is not used, although it is returned when describing your service.

", - "DeploymentConfiguration$minimumHealthyPercent": "

If a service is using the rolling update (ECS) deployment type, the minimum healthy percent represents a lower limit on the number of tasks in a service that must remain in the RUNNING state during a deployment, as a percentage of the desired number of tasks (rounded up to the nearest integer), and while any container instances are in the DRAINING state if the service contains tasks using the EC2 launch type. This parameter enables you to deploy without using additional cluster capacity. For example, if your service has a desired number of four tasks and a minimum healthy percent of 50%, the scheduler may stop two existing tasks to free up cluster capacity before starting two new tasks. Tasks for services that do not use a load balancer are considered healthy if they are in the RUNNING state; tasks for services that do use a load balancer are considered healthy if they are in the RUNNING state and they are reported as healthy by the load balancer. The default value for minimum healthy percent is 100%.

If a service is using the blue/green (CODE_DEPLOY) deployment type and tasks that use the EC2 launch type, the minimum healthy percent value is set to the default value and is used to define the lower limit on the number of the tasks in the service that remain in the RUNNING state while the container instances are in the DRAINING state. If the tasks in the service use the Fargate launch type, the minimum healthy percent value is not used, although it is returned when describing your service.

", + "CreateServiceRequest$healthCheckGracePeriodSeconds": "

The period of time, in seconds, that the Amazon ECS service scheduler should ignore unhealthy Elastic Load Balancing target health checks after a task has first started. This is only valid if your service is configured to use a load balancer. If your service's tasks take a while to start and respond to Elastic Load Balancing health checks, you can specify a health check grace period of up to 7,200 seconds during which the ECS service scheduler ignores health check status. This grace period can prevent the ECS service scheduler from marking tasks as unhealthy and stopping them before they have time to come up.

", + "Deployment$desiredCount": "

The most recent desired count of tasks that was specified for the service to deploy or maintain.

", + "DeploymentConfiguration$maximumPercent": "

The upper limit (as a percentage of the service's desiredCount) of the number of tasks that are allowed in the RUNNING or PENDING state in a service during a deployment. The maximum number of tasks during a deployment is the desiredCount multiplied by maximumPercent/100, rounded down to the nearest integer value.

", + "DeploymentConfiguration$minimumHealthyPercent": "

The lower limit (as a percentage of the service's desiredCount) of the number of running tasks that must remain in the RUNNING state in a service during a deployment. The minimum number of healthy tasks during a deployment is the desiredCount multiplied by minimumHealthyPercent/100, rounded up to the nearest integer value.

", "HealthCheck$interval": "

The time period in seconds between each health check execution. You may specify between 5 and 300 seconds. The default value is 30 seconds.

", "HealthCheck$timeout": "

The time period in seconds to wait for a health check to succeed before it is considered a failure. You may specify between 2 and 60 seconds. The default value is 5.

", "HealthCheck$retries": "

The number of times to retry a failed health check before the container is considered unhealthy. You may specify between 1 and 10 retries. The default value is 3.

", @@ -175,22 +162,23 @@ "ListAttributesRequest$maxResults": "

The maximum number of cluster results returned by ListAttributes in paginated output. When this parameter is used, ListAttributes 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 ListAttributes request with the returned nextToken value. This value can be between 1 and 100. If this parameter is not used, then ListAttributes returns up to 100 results and a nextToken value if applicable.

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

", - "ListServicesRequest$maxResults": "

The maximum number of service 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 10 results and a nextToken value if applicable.

", + "ListServicesRequest$maxResults": "

The maximum number of service 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.

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

", "LoadBalancer$containerPort": "

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.

", "NetworkBinding$containerPort": "

The port number on the container that is used with the network binding.

", "NetworkBinding$hostPort": "

The port number on the host that is used with the network binding.

", - "PortMapping$containerPort": "

The port number on the container that is bound to the user-specified or automatically assigned host port.

If you are using containers in a task with the awsvpc or host network mode, exposed ports should be specified using containerPort.

If you are using containers in a task with the bridge network mode and you specify a container port and not a host port, your container automatically receives a host port in the ephemeral port range. For more information, see hostPort. Port mappings that are automatically assigned in this way do not count toward the 100 reserved ports limit of a container instance.

", - "PortMapping$hostPort": "

The port number on the container instance to reserve for your container.

If you are using containers in a task with the awsvpc or host network mode, the hostPort can either be left blank or set to the same value as the containerPort.

If you are using containers in a task with the bridge network mode, 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 for Docker version 1.6.0 and later is listed on the instance under /proc/sys/net/ipv4/ip_local_port_range. If this kernel parameter is unavailable, the default ephemeral port range from 49153 through 65535 is used. Do not attempt to specify a host port in the ephemeral port range as these are reserved for automatic assignment. In general, ports below 32768 are outside of the ephemeral port range.

The default ephemeral port range from 49153 through 65535 is always used for Docker versions before 1.6.0.

The default reserved ports are 22 for SSH, the Docker ports 2375 and 2376, and the Amazon ECS container agent ports 51678 and 51679. Any host port that was previously specified in a running task is also reserved while the task is running (after a task stops, the host port is released). The current reserved ports are displayed in the remainingResources of DescribeContainerInstances output. A container instance may have up to 100 reserved ports at a time, including the default reserved ports. Aautomatically assigned ports do not count toward the 100 reserved ports limit.

", + "PortMapping$containerPort": "

The port number on the container that is bound to the user-specified or automatically assigned host port.

If using containers in a task with the awsvpc or host network mode, exposed ports should be specified using containerPort.

If using containers in a task with the bridge network mode and you specify a container port and not a host port, your container automatically receives a host port in the ephemeral port range (for more information, see hostPort). Port mappings that are automatically assigned in this way do not count toward the 100 reserved ports limit of a container instance.

", + "PortMapping$hostPort": "

The port number on the container instance to reserve for your container.

If using containers in a task with the awsvpc or host network mode, the hostPort can either be left blank or set to the same value as the containerPort.

If using containers in a task with the bridge network mode, 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 for Docker version 1.6.0 and later is listed on the instance under /proc/sys/net/ipv4/ip_local_port_range; if this kernel parameter is unavailable, the default ephemeral port range from 49153 through 65535 is used. You should not attempt to specify a host port in the ephemeral port range as these are reserved for automatic assignment. In general, ports below 32768 are outside of the ephemeral port range.

The default ephemeral port range from 49153 through 65535 is always used for Docker versions before 1.6.0.

The default reserved ports are 22 for SSH, the Docker ports 2375 and 2376, and the Amazon ECS container agent ports 51678 and 51679. Any host port that was previously specified in a running task is also reserved while the task is running (after a task stops, the host port is released). The current reserved ports are displayed in the remainingResources of DescribeContainerInstances output, and a container instance may have up to 100 reserved ports at a time, including the default reserved ports (automatically assigned ports do not count toward the 100 reserved ports limit).

", "RunTaskRequest$count": "

The number of instantiations of the specified task to place on your cluster. You can specify up to 10 tasks per call.

", + "Service$desiredCount": "

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$healthCheckGracePeriodSeconds": "

The period of time, in seconds, that the Amazon ECS service scheduler ignores unhealthy Elastic Load Balancing target health checks after a task has first started.

", - "ServiceRegistry$port": "

The port value used if your service discovery service specified an SRV record. This field may be used if both the awsvpc network mode and SRV records are used.

", + "ServiceRegistry$port": "

The port value used if your service discovery service specified an SRV record. This field is required if both the awsvpc network mode and SRV records are used.

", "ServiceRegistry$containerPort": "

The port value, already specified in the task definition, to be used for your service discovery service. If the task definition your service task specifies uses the bridge or host network mode, you must specify a containerName and containerPort combination from the task definition. If the task definition your service task specifies uses the awsvpc network mode and a type SRV DNS record is used, you must specify either a containerName and containerPort combination or a port value, but not both.

", "SubmitContainerStateChangeRequest$exitCode": "

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.

", - "UpdateServiceRequest$healthCheckGracePeriodSeconds": "

The period of time, in seconds, that the Amazon ECS service scheduler should ignore unhealthy Elastic Load Balancing target health checks after a task has first started. This is only valid if your service is configured to use a load balancer. If your service's tasks take a while to start and respond to Elastic Load Balancing health checks, you can specify a health check grace period of up to 1,800 seconds. During that time, the ECS service scheduler ignores the Elastic Load Balancing health check status. This grace period can prevent the ECS service scheduler from marking tasks as unhealthy and stopping them before they have time to come up.

" + "UpdateServiceRequest$healthCheckGracePeriodSeconds": "

The period of time, in seconds, that the Amazon ECS service scheduler should ignore unhealthy Elastic Load Balancing target health checks after a task has first started. This is only valid if your service is configured to use a load balancer. If your service's tasks take a while to start and respond to Elastic Load Balancing health checks, you can specify a health check grace period of up to 1,800 seconds during which the ECS service scheduler ignores the Elastic Load Balancing health check status. This grace period can prevent the ECS service scheduler from marking tasks as unhealthy and stopping them before they have time to come up.

" } }, "ClientException": { @@ -207,12 +195,12 @@ } }, "ClusterContainsContainerInstancesException": { - "base": "

You cannot delete a cluster that has registered container instances. First, deregister the container instances before you can delete the cluster. For more information, see DeregisterContainerInstance.

", + "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. First, update the service to reduce its desired task count to 0 and then delete the service. For more information, see UpdateService and DeleteService.

", + "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": { } }, @@ -234,7 +222,7 @@ } }, "ClusterNotFoundException": { - "base": "

The specified cluster could not be found. You can view your available clusters with ListClusters. Amazon ECS clusters are Region-specific.

", + "base": "

The specified cluster could not be found. You can view your available clusters with ListClusters. Amazon ECS clusters are region-specific.

", "refs": { } }, @@ -255,7 +243,7 @@ "refs": { "RegisterTaskDefinitionRequest$requiresCompatibilities": "

The launch type required by the task. If no value is specified, it defaults to EC2.

", "TaskDefinition$compatibilities": "

The launch type to use with your task. For more information, see Amazon ECS Launch Types in the Amazon Elastic Container Service Developer Guide.

", - "TaskDefinition$requiresCompatibilities": "

The launch type that the task is using.

" + "TaskDefinition$requiresCompatibilities": "

The launch type the task is using.

" } }, "Connectivity": { @@ -292,18 +280,6 @@ "UpdateContainerAgentResponse$containerInstance": "

The container instance for which the container agent was updated.

" } }, - "ContainerInstanceField": { - "base": null, - "refs": { - "ContainerInstanceFieldList$member": null - } - }, - "ContainerInstanceFieldList": { - "base": null, - "refs": { - "DescribeContainerInstancesRequest$include": "

Specifies whether you want to see the resource tags for the container instance. If TAGS is specified, the tags are included in the response. If this field is omitted, tags are not included in the response.

" - } - }, "ContainerInstanceStatus": { "base": null, "refs": { @@ -368,16 +344,6 @@ "refs": { } }, - "DeleteAccountSettingRequest": { - "base": null, - "refs": { - } - }, - "DeleteAccountSettingResponse": { - "base": null, - "refs": { - } - }, "DeleteAttributesRequest": { "base": null, "refs": { @@ -409,7 +375,7 @@ } }, "Deployment": { - "base": "

The details of an Amazon ECS service deployment. This is used when a service uses the CODE_DEPLOY deployment controller type.

", + "base": "

The details of an Amazon ECS service deployment.

", "refs": { "Deployments$member": null } @@ -422,19 +388,6 @@ "UpdateServiceRequest$deploymentConfiguration": "

Optional deployment parameters that control how many tasks run during the deployment and the ordering of stopping and starting tasks.

" } }, - "DeploymentController": { - "base": "

The deployment controller to use for the service. For more information, see Amazon ECS Deployment Types in the Amazon Elastic Container Service Developer Guide.

", - "refs": { - "CreateServiceRequest$deploymentController": "

The deployment controller to use for the service.

", - "Service$deploymentController": "

The deployment controller type the service is using.

" - } - }, - "DeploymentControllerType": { - "base": null, - "refs": { - "DeploymentController$type": "

The deployment controller type to use.

There are two deployment controller types available:

ECS

The rolling update (ECS) deployment type involves replacing the current running version of the container with the latest version. The number of containers Amazon ECS adds or removes from the service during a rolling update is controlled by adjusting the minimum and maximum number of healthy tasks allowed during a service deployment, as specified in the DeploymentConfiguration.

CODE_DEPLOY

The blue/green (CODE_DEPLOY) deployment type uses the blue/green deployment model powered by AWS CodeDeploy, which allows you to verify a new deployment of a service before sending production traffic to it. For more information, see Amazon ECS Deployment Types in the Amazon Elastic Container Service Developer Guide.

" - } - }, "Deployments": { "base": null, "refs": { @@ -514,7 +467,7 @@ "DesiredStatus": { "base": null, "refs": { - "ListTasksRequest$desiredStatus": "

The task desired status with which to filter the ListTasks results. Specifying a desiredStatus of STOPPED limits the results to tasks that Amazon ECS has set the desired status to STOPPED. This can be useful for debugging tasks that are not starting properly or have died or finished. The default status filter is RUNNING, which shows tasks that Amazon ECS has set the desired status to RUNNING.

Although you can filter results based on a desired status of PENDING, this does not return any results. Amazon ECS never sets the desired status of a task to that value (only a task's lastStatus may have a value of PENDING).

" + "ListTasksRequest$desiredStatus": "

The task desired status with which to filter the ListTasks results. Specifying a desiredStatus of STOPPED limits the results to tasks that Amazon ECS has set the desired status to STOPPED, which can be useful for debugging tasks that are not starting properly or have died or finished. The default status filter is RUNNING, which shows tasks that Amazon ECS has set the desired status to RUNNING.

Although you can filter results based on a desired status of PENDING, this does not return any results because Amazon ECS never sets the desired status of a task to that value (only a task's lastStatus may have a value of PENDING).

" } }, "Device": { @@ -538,7 +491,7 @@ "DevicesList": { "base": null, "refs": { - "LinuxParameters$devices": "

Any host devices to expose to the container. This parameter maps to Devices in the Create a container section of the Docker Remote API and the --device option to docker run.

If you are using tasks that use the Fargate launch type, the devices parameter is not supported.

" + "LinuxParameters$devices": "

Any host devices to expose to the container. This parameter maps to Devices in the Create a container section of the Docker Remote API and the --device option to docker run.

If you are using tasks that use the Fargate launch type, the devices parameter is not supported.

" } }, "DiscoverPollEndpointRequest": { @@ -554,26 +507,19 @@ "DockerLabelsMap": { "base": null, "refs": { - "ContainerDefinition$dockerLabels": "

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 in to your container instance and run the following command: sudo docker version --format '{{.Server.APIVersion}}'

" - } - }, - "DockerVolumeConfiguration": { - "base": "

This parameter is specified when you are using Docker volumes. Docker volumes are only supported when you are using the EC2 launch type. Windows containers only support the use of the local driver. To use bind mounts, specify a host instead.

", - "refs": { - "Volume$dockerVolumeConfiguration": "

This parameter is specified when you are using Docker volumes. Docker volumes are only supported when you are using the EC2 launch type. Windows containers only support the use of the local driver. To use bind mounts, specify a host instead.

" + "ContainerDefinition$dockerLabels": "

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 in to your container instance and run the following command: sudo docker version | grep \"Server API version\"

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

", - "Scale$value": "

The value, specified as a percent total of a service's desiredCount, to scale the task set.

" + "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. 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 plaintext environment variables for sensitive information, such as credential data.

", + "ContainerDefinition$environment": "

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 plaintext environment variables for sensitive information, such as credential data.

", "ContainerOverride$environment": "

The environment variables to send to the container. You can add new environment variables, which are added to the container at launch, or you can override the existing environment variables from the Docker image or the task definition. You must also specify a container name.

" } }, @@ -596,15 +542,15 @@ } }, "HealthCheck": { - "base": "

An object representing a container health check. Health check parameters that are specified in a container definition override any Docker health checks that exist in the container image (such as those specified in a parent image or from the image's Dockerfile).

The following are notes about container health check support:

", + "base": "

An object representing a container health check. Health check parameters that are specified in a container definition override any Docker health checks that exist in the container image (such as those specified in a parent image or from the image's Dockerfile).

", "refs": { - "ContainerDefinition$healthCheck": "

The health check command and associated configuration parameters for the container. This parameter maps to HealthCheck in the Create a container section of the Docker Remote API and the HEALTHCHECK parameter of docker run.

" + "ContainerDefinition$healthCheck": "

The health check command and associated configuration parameters for the container. This parameter maps to HealthCheck in the Create a container section of the Docker Remote API and the HEALTHCHECK parameter of docker run.

" } }, "HealthStatus": { "base": null, "refs": { - "Container$healthStatus": "

The health status of the container. If health checks are not configured for this container in its task definition, then it reports the health status as UNKNOWN.

", + "Container$healthStatus": "

The health status of the container. If health checks are not configured for this container in its task definition, then it reports health status as UNKNOWN.

", "Task$healthStatus": "

The health status for the task, which is determined by the health of the essential containers in the task. If all essential containers in the task are reporting as HEALTHY, then the task status also reports as HEALTHY. If any essential containers in the task are reporting as UNHEALTHY or UNKNOWN, then the task status also reports as UNHEALTHY or UNKNOWN, accordingly.

The Amazon ECS container agent does not monitor or report on Docker health checks that are embedded in a container image (such as those specified in a parent image or from the image's Dockerfile) and not specified in the container definition. Health check parameters that are specified in a container definition override any Docker health checks that exist in the container image.

" } }, @@ -617,37 +563,31 @@ "HostEntryList": { "base": null, "refs": { - "ContainerDefinition$extraHosts": "

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.

This parameter is not supported for Windows containers or tasks that use the awsvpc network mode.

" + "ContainerDefinition$extraHosts": "

A list of hostnames and IP address mappings to append to the /etc/hosts file on the container. If using the Fargate launch type, this may be used to list non-Fargate hosts to which the container can talk. This parameter maps to ExtraHosts in the Create a container section of the Docker Remote API and the --add-host option to docker run.

This parameter is not supported for Windows containers.

" } }, "HostVolumeProperties": { - "base": "

Details on a container instance bind mount host volume.

", + "base": "

Details on a container instance host volume.

", "refs": { - "Volume$host": "

This parameter is specified when you are using bind mount host volumes. Bind mount host volumes are supported when you are using either the EC2 or Fargate launch types. The contents of the host parameter determine whether your bind mount host volume persists on the host container instance and where it is stored. If the host parameter is empty, then the Docker daemon assigns a host path for your data volume. However, the data is not guaranteed to persist after the containers associated with it stop running.

Windows containers can mount whole directories on the same drive as $env:ProgramData. Windows containers cannot mount directories on a different drive, and mount point cannot be across drives. For example, you can mount C:\\my\\path:C:\\my\\path and D:\\:D:\\, but not D:\\my\\path:C:\\my\\path or D:\\:C:\\my\\path.

" + "Volume$host": "

The contents of the host parameter determine whether your data volume persists on the host container instance and where it is stored. If the host parameter is empty, then the Docker daemon assigns a host path for your data volume, but the data is not guaranteed to persist after the containers associated with it stop running.

Windows containers can mount whole directories on the same drive as $env:ProgramData. Windows containers cannot mount directories on a different drive, and mount point cannot be across drives. For example, you can mount C:\\my\\path:C:\\my\\path and D:\\:D:\\, but not D:\\my\\path:C:\\my\\path or D:\\:C:\\my\\path.

" } }, "Integer": { "base": null, "refs": { - "Cluster$registeredContainerInstancesCount": "

The number of container instances registered into the cluster. This includes container instances in both ACTIVE and DRAINING status.

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

", "Cluster$pendingTasksCount": "

The number of tasks in the cluster that are in the PENDING state.

", "Cluster$activeServicesCount": "

The number of services that are running on the cluster in an ACTIVE state. You can view these services with ListServices.

", - "ContainerDefinition$cpu": "

The number of cpu units reserved for the container. This parameter maps to CpuShares in the Create a container section of the Docker Remote API and the --cpu-shares option to docker run.

This field is optional for tasks using the Fargate launch type, and the only requirement is that the total amount of CPU reserved for all containers within a task be lower than the task-level cpu value.

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.

Linux containers share unallocated CPU units with other containers on the container instance with the same ratio as their allocated amount. For example, if you run a single-container task on a single-core instance type with 512 CPU units specified for that container, and that is the only task running on the container instance, that container could use the full 1,024 CPU unit share at any given time. However, if you launched another copy of the same task on that container instance, each task would be guaranteed a minimum of 512 CPU units when needed, and each container could float to higher CPU usage if the other container was not using it, but if both tasks were 100% active all of the time, they would be limited to 512 CPU units.

On Linux container instances, the Docker daemon on the container instance uses the CPU value to calculate the relative CPU share ratios for running containers. For more information, see 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:

On Windows container instances, the CPU limit is enforced as an absolute limit, or a quota. Windows containers only have access to the specified amount of CPU that is described in the task definition.

", + "ContainerDefinition$cpu": "

The number of cpu units reserved for the container. This parameter maps to CpuShares in the Create a container section of the Docker Remote API and the --cpu-shares option to docker run.

This field is optional for tasks using the Fargate launch type, and the only requirement is that the total amount of CPU reserved for all containers within a task be lower than the task-level cpu value.

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.

Linux containers share unallocated CPU units with other containers on the container instance with the same ratio as their allocated amount. For example, if you run a single-container task on a single-core instance type with 512 CPU units specified for that container, and that is the only task running on the container instance, that container could use the full 1,024 CPU unit share at any given time. However, if you launched another copy of the same task on that container instance, each task would be guaranteed a minimum of 512 CPU units when needed, and each container could float to higher CPU usage if the other container was not using it, but if both tasks were 100% active all of the time, they would be limited to 512 CPU units.

On Linux container instances, the Docker daemon on the container instance uses the CPU value to calculate the relative CPU share ratios for running containers. For more information, see 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:

On Windows container instances, the CPU limit is enforced as an absolute limit, or a quota. Windows containers only have access to the specified amount of CPU that is described in the task definition.

", "ContainerInstance$runningTasksCount": "

The number of tasks on the container instance that are in the RUNNING status.

", "ContainerInstance$pendingTasksCount": "

The number of tasks on the container instance that are in the PENDING status.

", - "Deployment$desiredCount": "

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.

", "Deployment$runningCount": "

The number of tasks in the deployment that are in the RUNNING status.

", - "ListAccountSettingsRequest$maxResults": "

The maximum number of account setting results returned by ListAccountSettings in paginated output. When this parameter is used, ListAccountSettings 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 ListAccountSettings request with the returned nextToken value. This value can be between 1 and 10. If this parameter is not used, then ListAccountSettings returns up to 10 results and a nextToken value if applicable.

", "Resource$integerValue": "

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

", - "Service$desiredCount": "

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.

", "Service$pendingCount": "

The number of tasks in the cluster that are in the PENDING state.

", - "TaskDefinition$revision": "

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 that 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.

", - "TaskSet$computedDesiredCount": "

The computed desired count for the task set. This is calculated by multiplying the service's desiredCount by the task set's scale percentage.

", - "TaskSet$pendingCount": "

The number of tasks in the task set that are in the PENDING status during a deployment. A task in the PENDING state is preparing to enter the RUNNING state. A task set enters the PENDING status when it launches for the first time, or when it is restarted after being in the STOPPED state.

", - "TaskSet$runningCount": "

The number of tasks in the task set that are in the RUNNING status during a deployment. A task in the RUNNING state is running and ready for use.

", + "TaskDefinition$revision": "

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

", "Tmpfs$size": "

The size (in MiB) of the tmpfs volume.

", "Ulimit$softLimit": "

The soft limit for the ulimit type.

", "Ulimit$hardLimit": "

The hard limit for the ulimit type.

" @@ -661,8 +601,8 @@ "IpcMode": { "base": null, "refs": { - "RegisterTaskDefinitionRequest$ipcMode": "

The IPC resource namespace to use for the containers in the task. The valid values are host, task, or none. If host is specified, then all containers within the tasks that specified the host IPC mode on the same container instance share the same IPC resources with the host Amazon EC2 instance. If task is specified, all containers within the specified task share the same IPC resources. If none is specified, then IPC resources within the containers of a task are private and not shared with other containers in a task or on the container instance. If no value is specified, then the IPC resource namespace sharing depends on the Docker daemon setting on the container instance. For more information, see IPC settings in the Docker run reference.

If the host IPC mode is used, be aware that there is a heightened risk of undesired IPC namespace expose. For more information, see Docker security.

If you are setting namespaced kernel parameters using systemControls for the containers in the task, the following will apply to your IPC resource namespace. For more information, see System Controls in the Amazon Elastic Container Service Developer Guide.

This parameter is not supported for Windows containers or tasks using the Fargate launch type.

", - "TaskDefinition$ipcMode": "

The IPC resource namespace to use for the containers in the task. The valid values are host, task, or none. If host is specified, then all containers within the tasks that specified the host IPC mode on the same container instance share the same IPC resources with the host Amazon EC2 instance. If task is specified, all containers within the specified task share the same IPC resources. If none is specified, then IPC resources within the containers of a task are private and not shared with other containers in a task or on the container instance. If no value is specified, then the IPC resource namespace sharing depends on the Docker daemon setting on the container instance. For more information, see IPC settings in the Docker run reference.

If the host IPC mode is used, be aware that there is a heightened risk of undesired IPC namespace expose. For more information, see Docker security.

If you are setting namespaced kernel parameters using systemControls for the containers in the task, the following will apply to your IPC resource namespace. For more information, see System Controls in the Amazon Elastic Container Service Developer Guide.

This parameter is not supported for Windows containers or tasks using the Fargate launch type.

" + "RegisterTaskDefinitionRequest$ipcMode": null, + "TaskDefinition$ipcMode": null } }, "KernelCapabilities": { @@ -672,24 +612,22 @@ } }, "KeyValuePair": { - "base": "

A key-value pair object.

", + "base": "

A key and value pair object.

", "refs": { "AttachmentDetails$member": null, - "EnvironmentVariables$member": null, - "Statistics$member": null + "EnvironmentVariables$member": null } }, "LaunchType": { "base": null, "refs": { - "CreateServiceRequest$launchType": "

The launch type on which to run your service. For more information, see Amazon ECS Launch Types in the Amazon Elastic Container Service Developer Guide.

", - "Deployment$launchType": "

The launch type the tasks in the service are using. For more information, see Amazon ECS Launch Types in the Amazon Elastic Container Service Developer Guide.

", + "CreateServiceRequest$launchType": "

The launch type on which to run your service.

", + "Deployment$launchType": "

The launch type on which your service is running.

", "ListServicesRequest$launchType": "

The launch type for the services to list.

", "ListTasksRequest$launchType": "

The launch type for services to list.

", - "RunTaskRequest$launchType": "

The launch type on which to run your task. For more information, see Amazon ECS Launch Types in the Amazon Elastic Container Service Developer Guide.

", - "Service$launchType": "

The launch type on which your service is running. For more information, see Amazon ECS Launch Types in the Amazon Elastic Container Service Developer Guide.

", - "Task$launchType": "

The launch type on which your task is running. For more information, see Amazon ECS Launch Types in the Amazon Elastic Container Service Developer Guide.

", - "TaskSet$launchType": "

The launch type the tasks in the task set are using. For more information, see Amazon ECS Launch Types in the Amazon Elastic Container Service Developer Guide.

" + "RunTaskRequest$launchType": "

The launch type on which to run your task.

", + "Service$launchType": "

The launch type on which your service is running.

", + "Task$launchType": "

The launch type on which your task is running.

" } }, "LinuxParameters": { @@ -698,16 +636,6 @@ "ContainerDefinition$linuxParameters": "

Linux-specific modifications that are applied to the container, such as Linux KernelCapabilities.

This parameter is not supported for Windows containers.

" } }, - "ListAccountSettingsRequest": { - "base": null, - "refs": { - } - }, - "ListAccountSettingsResponse": { - "base": null, - "refs": { - } - }, "ListAttributesRequest": { "base": null, "refs": { @@ -789,7 +717,7 @@ } }, "LoadBalancer": { - "base": "

Details on a load balancer that is used with a service.

If the service is using the ECS deployment controller, you are limited to one load balancer or target group.

If the service is using the CODE_DEPLOY deployment controller, the service is required to use either an Application Load Balancer or Network Load Balancer. When you are creating an AWS CodeDeploy deployment group, you specify two target groups (referred to as a targetGroupPair). Each target group binds to a separate task set in the deployment. The load balancer can also have up to two listeners, a required listener for production traffic and an optional listener that allows you to test new revisions of the service before routing production traffic to it.

Services with tasks that use the awsvpc network mode (for example, those with the Fargate launch type) only support Application Load Balancers and Network Load Balancers. Classic Load Balancers are not supported. Also, when you create any target groups for these services, you must choose ip as the target type, not instance. Tasks that use the awsvpc network mode are associated with an elastic network interface, not an Amazon EC2 instance.

", + "base": "

Details on a load balancer that is used with a service.

Services with tasks that use the awsvpc network mode (for example, those with the Fargate launch type) only support Application Load Balancers and Network Load Balancers; Classic Load Balancers are not supported. Also, when you create any target groups for these services, you must choose ip as the target type, not instance, because tasks that use the awsvpc network mode are associated with an elastic network interface, not an Amazon EC2 instance.

", "refs": { "LoadBalancers$member": null } @@ -797,27 +725,26 @@ "LoadBalancers": { "base": null, "refs": { - "CreateServiceRequest$loadBalancers": "

A load balancer object representing the load balancer to use with your service.

If the service is using the ECS deployment controller, you are limited to one load balancer or target group.

If the service is using the CODE_DEPLOY deployment controller, the service is required to use either an Application Load Balancer or Network Load Balancer. When creating an AWS CodeDeploy deployment group, you specify two target groups (referred to as a targetGroupPair). During a deployment, AWS CodeDeploy determines which task set in your service has the status PRIMARY and associates one target group with it, and then associates the other target group with the replacement task set. The load balancer can also have up to two listeners: a required listener for production traffic and an optional listener that allows you perform validation tests with Lambda functions before routing production traffic to it.

After you create a service using the ECS deployment controller, the load balancer name or target group ARN, container name, and container port specified in the service definition are immutable. If you are using the CODE_DEPLOY deployment controller, these values can be changed when updating the service.

For Classic Load Balancers, this object must contain the load balancer name, the container name (as it appears in a container definition), and the container port to access from the load balancer. When a task from this service is placed on a container instance, the container instance is registered with the load balancer specified here.

For Application Load Balancers and Network Load Balancers, this object must contain the load balancer target group ARN, the container name (as it appears in a container definition), and the container port to access from the load balancer. When a task from this service is placed on a container instance, the container instance and port combination is registered as a target in the target group specified here.

Services with tasks that use the awsvpc network mode (for example, those with the Fargate launch type) only support Application Load Balancers and Network Load Balancers. Classic Load Balancers are not supported. Also, when you create any target groups for these services, you must choose ip as the target type, not instance, because tasks that use the awsvpc network mode are associated with an elastic network interface, not an Amazon EC2 instance.

", - "Service$loadBalancers": "

A list of Elastic Load Balancing load balancer objects, containing the load balancer name, the container name (as it appears in a container definition), and the container port to access from the load balancer.

Services with tasks that use the awsvpc network mode (for example, those with the Fargate launch type) only support Application Load Balancers and Network Load Balancers. Classic Load Balancers are not supported. Also, when you create any target groups for these services, you must choose ip as the target type, not instance. Tasks that use the awsvpc network mode are associated with an elastic network interface, not an Amazon EC2 instance.

", - "TaskSet$loadBalancers": "

Details on a load balancer that is used with a task set.

" + "CreateServiceRequest$loadBalancers": "

A load balancer object representing the load balancer to use with your service. Currently, you are limited to one load balancer or target group per service. After you create a service, the load balancer name or target group ARN, container name, and container port specified in the service definition are immutable.

For Classic Load Balancers, this object must contain the load balancer name, the container name (as it appears in a container definition), and the container port to access from the load balancer. When a task from this service is placed on a container instance, the container instance is registered with the load balancer specified here.

For Application Load Balancers and Network Load Balancers, this object must contain the load balancer target group ARN, the container name (as it appears in a container definition), and the container port to access from the load balancer. When a task from this service is placed on a container instance, the container instance and port combination is registered as a target in the target group specified here.

Services with tasks that use the awsvpc network mode (for example, those with the Fargate launch type) only support Application Load Balancers and Network Load Balancers; Classic Load Balancers are not supported. Also, when you create any target groups for these services, you must choose ip as the target type, not instance, because tasks that use the awsvpc network mode are associated with an elastic network interface, not an Amazon EC2 instance.

", + "Service$loadBalancers": "

A list of Elastic Load Balancing load balancer objects, containing the load balancer name, the container name (as it appears in a container definition), and the container port to access from the load balancer.

Services with tasks that use the awsvpc network mode (for example, those with the Fargate launch type) only support Application Load Balancers and Network Load Balancers; Classic Load Balancers are not supported. Also, when you create any target groups for these services, you must choose ip as the target type, not instance, because tasks that use the awsvpc network mode are associated with an elastic network interface, not an Amazon EC2 instance.

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

If you are using the Fargate launch type, the only supported value is awslogs.

This parameter maps to LogConfig in the Create a container section of the Docker Remote API and the --log-driver option to docker run. By default, containers use the same logging driver that the Docker daemon uses. However the container may use a different logging driver than the Docker daemon by specifying a log driver with this parameter in the container definition. To use a different logging driver for a container, the log system must be configured properly on the container instance (or on a different log server for remote logging options). For more information on the options for different supported log drivers, see Configure logging drivers in the Docker documentation.

Amazon ECS currently supports a subset of the logging drivers available to the Docker daemon (shown in the LogConfiguration data type). Additional log drivers may be available in future releases of the Amazon ECS container agent.

This parameter requires version 1.18 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log in to your container instance and run the following command: sudo docker version --format '{{.Server.APIVersion}}'

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 Elastic Container Service Developer Guide.

" + "ContainerDefinition$logConfiguration": "

The log configuration specification for the container.

If using the Fargate launch type, the only supported value is awslogs.

This parameter maps to LogConfig in the Create a container section of the Docker Remote API and the --log-driver option to docker run. By default, containers use the same logging driver that the Docker daemon uses; however the container may use a different logging driver than the Docker daemon by specifying a log driver with this parameter in the container definition. To use a different logging driver for a container, the log system must be configured properly on the container instance (or on a different log server for remote logging options). For more information on the options for different supported log drivers, see Configure logging drivers in the Docker documentation.

Amazon ECS currently supports a subset of the logging drivers available to the Docker daemon (shown in the LogConfiguration data type). Additional log drivers may be available in future releases of the Amazon ECS container agent.

This parameter requires version 1.18 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log in to 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 Elastic Container Service Developer Guide.

" } }, "LogConfigurationOptionsMap": { "base": null, "refs": { - "LogConfiguration$options": "

The configuration options to send to the log driver. This parameter requires version 1.19 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log in to your container instance and run the following command: sudo docker version --format '{{.Server.APIVersion}}'

" + "LogConfiguration$options": "

The configuration options to send to the log driver. This parameter requires version 1.19 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log in to your container instance and run the following command: sudo docker version | grep \"Server API version\"

" } }, "LogDriver": { "base": null, "refs": { - "LogConfiguration$logDriver": "

The log driver to use for the container. The valid values listed for this parameter are log drivers that the Amazon ECS container agent can communicate with by default. If you are using the Fargate launch type, the only supported value is awslogs. For more information about using the awslogs driver, see Using the awslogs Log Driver in the Amazon Elastic Container Service Developer Guide.

If you have a custom driver that is not listed above that you would like to work with the Amazon ECS container agent, you can fork the Amazon ECS container agent project that is available on GitHub and customize it to work with that driver. We encourage you to submit pull requests for changes that you would like to have included. However, Amazon Web Services does not currently support running modified copies of this software.

This parameter requires version 1.18 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log in to your container instance and run the following command: sudo docker version --format '{{.Server.APIVersion}}'

" + "LogConfiguration$logDriver": "

The log driver to use for the container. The valid values listed for this parameter are log drivers that the Amazon ECS container agent can communicate with by default. If using the Fargate launch type, the only supported value is awslogs. For more information about using the awslogs driver, see Using the awslogs Log Driver in the Amazon Elastic Container Service Developer Guide.

If you have a custom driver that is not listed above that you would like to work with the Amazon ECS container agent, you can fork the Amazon ECS container agent project that is available on GitHub and customize it to work with that driver. We encourage you to submit pull requests for changes that you would like to have included. However, Amazon Web Services does not currently support running modified copies of this software.

This parameter requires version 1.18 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log in to your container instance and run the following command: sudo docker version | grep \"Server API version\"

" } }, "Long": { @@ -825,7 +752,7 @@ "refs": { "ContainerInstance$version": "

The version counter for the container instance. Every time a container instance experiences a change that triggers a CloudWatch event, the version counter is incremented. If you are replicating your Amazon ECS container instance state with CloudWatch Events, you can compare the version of a container instance reported by the Amazon ECS APIs with the version reported in CloudWatch Events for the container instance (inside the detail object) to verify that the version in your event stream is current.

", "Resource$longValue": "

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

", - "Task$version": "

The version counter for the task. Every time a task experiences a change that triggers a CloudWatch event, the version counter is incremented. If you are replicating your Amazon ECS task state with CloudWatch Events, you can compare the version of a task reported by the Amazon ECS API actionss with the version reported in CloudWatch Events for the task (inside the detail object) to verify that the version in your event stream is current.

" + "Task$version": "

The version counter for the task. Every time a task experiences a change that triggers a CloudWatch event, the version counter is incremented. If you are replicating your Amazon ECS task state with CloudWatch Events, you can compare the version of a task reported by the Amazon ECS APIs with the version reported in CloudWatch Events for the task (inside the detail object) to verify that the version in your event stream is current.

" } }, "MissingVersionException": { @@ -842,7 +769,7 @@ "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.

Windows containers can mount whole directories on the same drive as $env:ProgramData. Windows containers cannot mount directories on a different drive, and mount point cannot be across drives.

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

Windows containers can mount whole directories on the same drive as $env:ProgramData. Windows containers cannot mount directories on a different drive, and mount point cannot be across drives.

" } }, "NetworkBinding": { @@ -862,12 +789,11 @@ "NetworkConfiguration": { "base": "

An object representing the network configuration for a task or service.

", "refs": { - "CreateServiceRequest$networkConfiguration": "

The network configuration for the service. This parameter is required for task definitions that use the awsvpc network mode to receive their own elastic network interface, and it is not supported for other network modes. For more information, see Task Networking in the Amazon Elastic Container Service Developer Guide.

", + "CreateServiceRequest$networkConfiguration": "

The network configuration for the service. This parameter is required for task definitions that use the awsvpc network mode to receive their own Elastic Network Interface, and it is not supported for other network modes. For more information, see Task Networking in the Amazon Elastic Container Service Developer Guide.

", "Deployment$networkConfiguration": "

The VPC subnet and security group configuration for tasks that receive their own elastic network interface by using the awsvpc networking mode.

", - "RunTaskRequest$networkConfiguration": "

The network configuration for the task. This parameter is required for task definitions that use the awsvpc network mode to receive their own elastic network interface, and it is not supported for other network modes. For more information, see Task Networking in the Amazon Elastic Container Service Developer Guide.

", + "RunTaskRequest$networkConfiguration": "

The network configuration for the task. This parameter is required for task definitions that use the awsvpc network mode to receive their own Elastic Network Interface, and it is not supported for other network modes. For more information, see Task Networking in the Amazon Elastic Container Service Developer Guide.

", "Service$networkConfiguration": "

The VPC subnet and security group configuration for tasks that receive their own elastic network interface by using the awsvpc networking mode.

", "StartTaskRequest$networkConfiguration": "

The VPC subnet and security group configuration for tasks that receive their own elastic network interface by using the awsvpc networking mode.

", - "TaskSet$networkConfiguration": "

The network configuration for the task set.

", "UpdateServiceRequest$networkConfiguration": "

The network configuration for the service. This parameter is required for task definitions that use the awsvpc network mode to receive their own elastic network interface, and it is not supported for other network modes. For more information, see Task Networking in the Amazon Elastic Container Service Developer Guide.

Updating a service to add a subnet to a list of existing subnets does not trigger a service deployment. For example, if your network configuration change is to keep the existing subnets and simply add another subnet to the network configuration, this does not trigger a new service deployment.

" } }, @@ -886,8 +812,8 @@ "NetworkMode": { "base": null, "refs": { - "RegisterTaskDefinitionRequest$networkMode": "

The Docker networking mode to use for the containers in the task. The valid values are none, bridge, awsvpc, and host. The default Docker network mode is bridge. If you are using the Fargate launch type, the awsvpc network mode is required. If you are using the EC2 launch type, any network mode can be used. If the network mode is set to none, you cannot specify port mappings in your container definitions, and the tasks containers do not have external connectivity. The host and awsvpc network modes offer the highest networking performance for containers because they use the EC2 network stack instead of the virtualized network stack provided by the bridge mode.

With the host and awsvpc network modes, exposed container ports are mapped directly to the corresponding host port (for the host network mode) or the attached elastic network interface port (for the awsvpc network mode), so you cannot take advantage of dynamic host port mappings.

If the network mode is awsvpc, the task is allocated an elastic network interface, and you must specify a NetworkConfiguration value when you create a service or run a task with the task definition. For more information, see Task Networking in the Amazon Elastic Container Service Developer Guide.

Currently, only Amazon ECS-optimized AMIs, other Amazon Linux variants with the ecs-init package, or AWS Fargate infrastructure support the awsvpc network mode.

If the network mode is host, you cannot run multiple instantiations of the same task on a single container instance when port mappings are used.

Docker for Windows uses different network modes than Docker for Linux. When you register a task definition with Windows containers, you must not specify a network mode. If you use the console to register a task definition with Windows containers, you must choose the <default> network mode object.

For more information, see Network settings in the Docker run reference.

", - "TaskDefinition$networkMode": "

The Docker networking mode to use for the containers in the task. The valid values are none, bridge, awsvpc, and host. The default Docker network mode is bridge. If you are using the Fargate launch type, the awsvpc network mode is required. If you are using the EC2 launch type, any network mode can be used. If the network mode is set to none, you cannot specify port mappings in your container definitions, and the tasks containers do not have external connectivity. The host and awsvpc network modes offer the highest networking performance for containers because they use the EC2 network stack instead of the virtualized network stack provided by the bridge mode.

With the host and awsvpc network modes, exposed container ports are mapped directly to the corresponding host port (for the host network mode) or the attached elastic network interface port (for the awsvpc network mode), so you cannot take advantage of dynamic host port mappings.

If the network mode is awsvpc, the task is allocated an elastic network interface, and you must specify a NetworkConfiguration value when you create a service or run a task with the task definition. For more information, see Task Networking in the Amazon Elastic Container Service Developer Guide.

Currently, only Amazon ECS-optimized AMIs, other Amazon Linux variants with the ecs-init package, or AWS Fargate infrastructure support the awsvpc network mode.

If the network mode is host, you cannot run multiple instantiations of the same task on a single container instance when port mappings are used.

Docker for Windows uses different network modes than Docker for Linux. When you register a task definition with Windows containers, you must not specify a network mode. If you use the console to register a task definition with Windows containers, you must choose the <default> network mode object.

For more information, see Network settings in the Docker run reference.

" + "RegisterTaskDefinitionRequest$networkMode": "

The Docker networking mode to use for the containers in the task. The valid values are none, bridge, awsvpc, and host. The default Docker network mode is bridge. If using the Fargate launch type, the awsvpc network mode is required. If using the EC2 launch type, any network mode can be used. If the network mode is set to none, you can't specify port mappings in your container definitions, and the task's containers do not have external connectivity. The host and awsvpc network modes offer the highest networking performance for containers because they use the EC2 network stack instead of the virtualized network stack provided by the bridge mode.

With the host and awsvpc network modes, exposed container ports are mapped directly to the corresponding host port (for the host network mode) or the attached elastic network interface port (for the awsvpc network mode), so you cannot take advantage of dynamic host port mappings.

If the network mode is awsvpc, the task is allocated an Elastic Network Interface, and you must specify a NetworkConfiguration when you create a service or run a task with the task definition. For more information, see Task Networking in the Amazon Elastic Container Service Developer Guide.

If the network mode is host, you can't run multiple instantiations of the same task on a single container instance when port mappings are used.

Docker for Windows uses different network modes than Docker for Linux. When you register a task definition with Windows containers, you must not specify a network mode.

For more information, see Network settings in the Docker run reference.

", + "TaskDefinition$networkMode": "

The Docker networking mode to use for the containers in the task. The valid values are none, bridge, awsvpc, and host. The default Docker network mode is bridge. If using the Fargate launch type, the awsvpc network mode is required. If using the EC2 launch type, any network mode can be used. If the network mode is set to none, you can't specify port mappings in your container definitions, and the task's containers do not have external connectivity. The host and awsvpc network modes offer the highest networking performance for containers because they use the EC2 network stack instead of the virtualized network stack provided by the bridge mode.

With the host and awsvpc network modes, exposed container ports are mapped directly to the corresponding host port (for the host network mode) or the attached elastic network interface port (for the awsvpc network mode), so you cannot take advantage of dynamic host port mappings.

If the network mode is awsvpc, the task is allocated an Elastic Network Interface, and you must specify a NetworkConfiguration when you create a service or run a task with the task definition. For more information, see Task Networking in the Amazon Elastic Container Service Developer Guide.

Currently, only the Amazon ECS-optimized AMI, other Amazon Linux variants with the ecs-init package, or AWS Fargate infrastructure support the awsvpc network mode.

If the network mode is host, you can't run multiple instantiations of the same task on a single container instance when port mappings are used.

Docker for Windows uses different network modes than Docker for Linux. When you register a task definition with Windows containers, you must not specify a network mode. If you use the console to register a task definition with Windows containers, you must choose the <default> network mode object.

For more information, see Network settings in the Docker run reference.

" } }, "NoUpdateAvailableException": { @@ -898,8 +824,8 @@ "PidMode": { "base": null, "refs": { - "RegisterTaskDefinitionRequest$pidMode": "

The process namespace to use for the containers in the task. The valid values are host or task. If host is specified, then all containers within the tasks that specified the host PID mode on the same container instance share the same IPC resources with the host Amazon EC2 instance. If task is specified, all containers within the specified task share the same process namespace. If no value is specified, the default is a private namespace. For more information, see PID settings in the Docker run reference.

If the host PID mode is used, be aware that there is a heightened risk of undesired process namespace expose. For more information, see Docker security.

This parameter is not supported for Windows containers or tasks using the Fargate launch type.

", - "TaskDefinition$pidMode": "

The process namespace to use for the containers in the task. The valid values are host or task. If host is specified, then all containers within the tasks that specified the host PID mode on the same container instance share the same IPC resources with the host Amazon EC2 instance. If task is specified, all containers within the specified task share the same process namespace. If no value is specified, the default is a private namespace. For more information, see PID settings in the Docker run reference.

If the host PID mode is used, be aware that there is a heightened risk of undesired process namespace expose. For more information, see Docker security.

This parameter is not supported for Windows containers or tasks using the Fargate launch type.

" + "RegisterTaskDefinitionRequest$pidMode": null, + "TaskDefinition$pidMode": null } }, "PlacementConstraint": { @@ -917,8 +843,8 @@ "PlacementConstraints": { "base": null, "refs": { - "CreateServiceRequest$placementConstraints": "

An array of placement constraint objects to use for tasks in your service. You can specify a maximum of 10 constraints per task (this limit includes constraints in the task definition and those specified at runtime).

", - "RunTaskRequest$placementConstraints": "

An array of placement constraint objects to use for the task. You can specify up to 10 constraints per task (including constraints in the task definition and those specified at runtime).

", + "CreateServiceRequest$placementConstraints": "

An array of placement constraint objects to use for tasks in your service. You can specify a maximum of 10 constraints per task (this limit includes constraints in the task definition and those specified at run time).

", + "RunTaskRequest$placementConstraints": "

An array of placement constraint objects to use for the task. You can specify up to 10 constraints per task (including constraints in the task definition and those specified at run time).

", "Service$placementConstraints": "

The placement constraints for the tasks in the service.

" } }, @@ -953,7 +879,7 @@ } }, "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.

If you are using containers in a task with the awsvpc or host network mode, exposed ports should be specified using containerPort. The hostPort can be left blank or it must be the same value as the containerPort.

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.

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

If using containers in a task with the awsvpc or host network mode, exposed ports should be specified using containerPort. The hostPort can be left blank or it must be the same value as the containerPort.

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.

", "refs": { "PortMappingList$member": null } @@ -961,26 +887,7 @@ "PortMappingList": { "base": null, "refs": { - "ContainerDefinition$portMappings": "

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.

For task definitions that use the awsvpc network mode, you should only specify the containerPort. The hostPort can be left blank or it must be the same value as the containerPort.

Port mappings on Windows use the NetNAT gateway address rather than localhost. There is no loopback for port mappings on Windows, so you cannot access a container's mapped port from the host itself.

This parameter maps to PortBindings in the Create a container section of the Docker Remote API and the --publish option to docker run. If the network mode of a task definition is set to none, then you can't specify port mappings. If the network mode of a task definition is set to host, then host ports must either be undefined or they must match the container port in the port mapping.

After a task reaches the RUNNING status, manual and automatic host and container port assignments are visible in the Network Bindings section of a container description for a selected task in the Amazon ECS console. The assignments are also visible in the networkBindings section DescribeTasks responses.

" - } - }, - "PropagateTags": { - "base": null, - "refs": { - "CreateServiceRequest$propagateTags": "

Specifies whether to propagate the tags from the task definition or the service to the tasks. If no value is specified, the tags are not propagated. Tags can only be propagated to the tasks within the service during service creation. To add tags to a task after service creation, use the TagResource API action.

", - "RunTaskRequest$propagateTags": "

Specifies whether to propagate the tags from the task definition or the service to the task. If no value is specified, the tags are not propagated.

", - "Service$propagateTags": "

Specifies whether to propagate the tags from the task definition or the service to the task. If no value is specified, the tags are not propagated.

", - "StartTaskRequest$propagateTags": "

Specifies whether to propagate the tags from the task definition or the service to the task. If no value is specified, the tags are not propagated.

" - } - }, - "PutAccountSettingRequest": { - "base": null, - "refs": { - } - }, - "PutAccountSettingResponse": { - "base": null, - "refs": { + "ContainerDefinition$portMappings": "

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.

For task definitions that use the awsvpc network mode, you should only specify the containerPort. The hostPort can be left blank or it must be the same value as the containerPort.

Port mappings on Windows use the NetNAT gateway address rather than localhost. There is no loopback for port mappings on Windows, so you cannot access a container's mapped port from the host itself.

This parameter maps to PortBindings in the Create a container section of the Docker Remote API and the --publish option to docker run. If the network mode of a task definition is set to none, then you can't specify port mappings. If the network mode of a task definition is set to host, then host ports must either be undefined or they must match the container port in the port mapping.

After a task reaches the RUNNING status, manual and automatic host and container port assignments are visible in the Network Bindings section of a container description for a selected task in the Amazon ECS console. The assignments are also visible in the networkBindings section DescribeTasks responses.

" } }, "PutAttributesRequest": { @@ -1022,7 +929,7 @@ "RequiresAttributes": { "base": null, "refs": { - "TaskDefinition$requiresAttributes": "

The container instance attributes required by your task. This field is not valid if you are using the Fargate launch type for your task.

" + "TaskDefinition$requiresAttributes": "

The container instance attributes required by your task. This field is not valid if using the Fargate launch type for your task.

" } }, "Resource": { @@ -1031,16 +938,11 @@ "Resources$member": null } }, - "ResourceNotFoundException": { - "base": "

The specified resource could not be found.

", - "refs": { - } - }, "Resources": { "base": null, "refs": { "ContainerInstance$remainingResources": "

For CPU and memory resource types, this parameter describes the remaining CPU and memory that has not already been allocated to tasks and is therefore available for new tasks. For port resource types, this parameter describes the ports that were reserved by the Amazon ECS container agent (at instance registration time) and any task containers that have reserved port mappings on the host (with the host or bridge network mode). Any port that is not specified here is available for new tasks.

", - "ContainerInstance$registeredResources": "

For CPU and memory resource types, this parameter describes the amount of each resource that was available on the container instance when the container agent registered it with Amazon ECS. This value represents the total amount of CPU and memory that can be allocated on this container instance to tasks. For port resource types, this parameter describes the ports that were reserved by the Amazon ECS container agent when it registered the container instance with Amazon ECS.

", + "ContainerInstance$registeredResources": "

For CPU and memory resource types, this parameter describes the amount of each resource that was available on the container instance when the container agent registered it with Amazon ECS; this value represents the total amount of CPU and memory that can be allocated on this container instance to tasks. For port resource types, this parameter describes the ports that were reserved by the Amazon ECS container agent when it registered the container instance with Amazon ECS.

", "RegisterContainerInstanceRequest$totalResources": "

The resources available on the instance.

" } }, @@ -1054,23 +956,12 @@ "refs": { } }, - "Scale": { - "base": "

A floating-point percentage of the desired number of tasks to place and keep running in the service. This is used when a service uses the CODE_DEPLOY deployment controller type.

", - "refs": { - "TaskSet$scale": "

A floating-point percentage of the desired number of tasks to place and keep running in the service.

" - } - }, - "ScaleUnit": { - "base": null, - "refs": { - "Scale$unit": "

The unit of measure for the scale value.

" - } - }, "SchedulingStrategy": { "base": null, "refs": { - "CreateServiceRequest$schedulingStrategy": "

The scheduling strategy to use for the service. For more information, see Services.

There are two service scheduler strategies available:

", + "CreateServiceRequest$schedulingStrategy": "

The scheduling strategy to use for the service. For more information, see Services.

There are two service scheduler strategies available:

", "ListServicesRequest$schedulingStrategy": "

The scheduling strategy for services to list.

", +<<<<<<< HEAD "Service$schedulingStrategy": "

The scheduling strategy to use for the service. For more information, see Services.

There are two service scheduler strategies available:

" } }, @@ -1078,6 +969,9 @@ "base": null, "refs": { "DockerVolumeConfiguration$scope": "

The scope for the Docker volume that determines its lifecycle. Docker volumes that are scoped to a task are automatically provisioned when the task starts and destroyed when the task stops. Docker volumes that are scoped as shared persist after the task stops.

" +======= + "Service$schedulingStrategy": "

The scheduling strategy to use for the service. For more information, see Services.

There are two service scheduler strategies available:

" +>>>>>>> 97f4938c... Address PR comments. Adding Tag support on v2/metadataWithTags endpoint } }, "Secret": { @@ -1100,7 +994,7 @@ "Service": { "base": "

Details on a service within a cluster

", "refs": { - "CreateServiceResponse$service": "

The full description of your service following the create call.

If a service is using the ECS deployment controller, the deploymentController and taskSets parameters will not be returned.

If the service is using the CODE_DEPLOY deployment controller, the deploymentController, taskSets and deployments parameters will be returned, however the deployments parameter will be an empty list.

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

" @@ -1118,32 +1012,20 @@ "Service$events": "

The event stream for your service. A maximum of 100 of the latest events are displayed.

" } }, - "ServiceField": { - "base": null, - "refs": { - "ServiceFieldList$member": null - } - }, - "ServiceFieldList": { - "base": null, - "refs": { - "DescribeServicesRequest$include": "

Specifies whether you want to see the resource tags for the service. If TAGS is specified, the tags are included in the response. If this field is omitted, tags are not included in the response.

" - } - }, "ServiceNotActiveException": { "base": "

The specified service is not active. You can't update a service that is inactive. If you have previously deleted a service, you can re-create it with 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.

", + "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": { } }, "ServiceRegistries": { "base": null, "refs": { - "CreateServiceRequest$serviceRegistries": "

The details of the service discovery registries to assign to this service. For more information, see Service Discovery.

Service discovery is supported for Fargate tasks if you are using platform version v1.1.0 or later. For more information, see AWS Fargate Platform Versions.

", + "CreateServiceRequest$serviceRegistries": "

The details of the service discovery registries to assign to this service. For more information, see Service Discovery.

Service discovery is supported for Fargate tasks if using platform version v1.1.0 or later. For more information, see AWS Fargate Platform Versions.

", "Service$serviceRegistries": "

" } }, @@ -1159,41 +1041,12 @@ "DescribeServicesResponse$services": "

The list of services described.

" } }, - "Setting": { - "base": "

The current account setting for a resource.

", - "refs": { - "DeleteAccountSettingResponse$setting": "

The account setting for the specified principal ARN.

", - "PutAccountSettingResponse$setting": "

The current account setting for a resource.

", - "Settings$member": null - } - }, - "SettingName": { - "base": null, - "refs": { - "DeleteAccountSettingRequest$name": "

The resource name for which to disable the new format. If serviceLongArnFormat is specified, the ARN for your Amazon ECS services is affected. If taskLongArnFormat is specified, the ARN and resource ID for your Amazon ECS tasks is affected. If containerInstanceLongArnFormat is specified, the ARN and resource ID for your Amazon ECS container instances is affected.

", - "ListAccountSettingsRequest$name": "

The resource name you want to list the account settings for.

", - "PutAccountSettingRequest$name": "

The resource name for which to enable the new format. If serviceLongArnFormat is specified, the ARN for your Amazon ECS services is affected. If taskLongArnFormat is specified, the ARN and resource ID for your Amazon ECS tasks is affected. If containerInstanceLongArnFormat is specified, the ARN and resource ID for your Amazon ECS container instances is affected.

", - "Setting$name": "

The account resource name.

" - } - }, - "Settings": { - "base": null, - "refs": { - "ListAccountSettingsResponse$settings": "

The account settings for the resource.

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

" } }, - "StabilityStatus": { - "base": null, - "refs": { - "TaskSet$stabilityStatus": "

The stability status, which indicates whether the task set has reached a steady state. If the following conditions are met, the task set will be in STEADY_STATE:

If any of those conditions are not met, the stability status returns STABILIZING.

" - } - }, "StartTaskRequest": { "base": null, "refs": { @@ -1204,12 +1057,6 @@ "refs": { } }, - "Statistics": { - "base": null, - "refs": { - "Cluster$statistics": "

Additional information about your clusters that are separated by launch type, including:

" - } - }, "StopTaskRequest": { "base": null, "refs": { @@ -1240,11 +1087,11 @@ "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 details 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.

", - "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 either repository-url/image:tag or repository-url/image@digest . 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.

", - "ContainerDefinition$hostname": "

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 hostname parameter is not supported if you are using the awsvpc network mode.

", - "ContainerDefinition$user": "

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.

This parameter is not supported for Windows containers.

", - "ContainerDefinition$workingDirectory": "

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.

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

", + "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 either repository-url/image:tag or repository-url/image@digest . 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.

", + "ContainerDefinition$hostname": "

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 hostname parameter is not supported if using the awsvpc networkMode.

", + "ContainerDefinition$user": "

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.

This parameter is not supported for Windows containers.

", + "ContainerDefinition$workingDirectory": "

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.

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

", "ContainerInstance$ec2InstanceId": "

The EC2 instance ID of the container instance.

", "ContainerInstance$status": "

The status of the container instance. The valid values are ACTIVE, INACTIVE, or DRAINING. ACTIVE indicates that the container instance can accept tasks. DRAINING indicates that new tasks are not placed on the container instance and any service tasks running on the container instance are removed if possible. For more information, see Container Instance Draining in the Amazon Elastic Container Service Developer Guide.

", @@ -1257,17 +1104,16 @@ "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 ARN of the task definition to run in your service. If a revision is not specified, the latest ACTIVE revision is used.

", "CreateServiceRequest$clientToken": "

Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Up to 32 ASCII characters are allowed.

", - "CreateServiceRequest$platformVersion": "

The platform version on which your tasks in the service are running. A platform version is only specified for tasks using the Fargate launch type. If one is not specified, the LATEST platform version is used by default. For more information, see AWS Fargate Platform Versions in the Amazon Elastic Container Service Developer Guide.

", + "CreateServiceRequest$platformVersion": "

The platform version on which to run your service. If one is not specified, the latest version is used by default.

", "CreateServiceRequest$role": "

The name or full Amazon Resource Name (ARN) of the IAM role that allows Amazon ECS to make calls to your load balancer on your behalf. This parameter is only permitted if you are using a load balancer with your service and your task definition does not use the awsvpc network mode. If you specify the role parameter, you must also specify a load balancer object with the loadBalancers parameter.

If your account has already created the Amazon ECS service-linked role, that role is used by default for your service unless you specify a role here. The service-linked role is required if your task definition uses the awsvpc network mode, in which case you should not specify a role here. For more information, see Using Service-Linked Roles for Amazon ECS in the Amazon Elastic Container Service Developer Guide.

If your specified role has a path other than /, then you must either specify the full role ARN (this is recommended) or prefix the role name with the path. For example, if a role with the name bar has a path of /foo/ then you would specify /foo/bar as the role name. For more information, see Friendly Names and Paths in the IAM User Guide.

", - "DeleteAccountSettingRequest$principalArn": "

The ARN of the principal, which can be an IAM user, IAM role, or the root user. If you specify the root user, it modifies the ARN and resource ID format for all IAM users, IAM roles, and the root user of the account unless an IAM user or role explicitly overrides these settings for themselves. If this field is omitted, the setting are changed only for the authenticated user.

", "DeleteAttributesRequest$cluster": "

The short name or full Amazon Resource Name (ARN) of the cluster that contains the resource to delete attributes. If you do not specify a cluster, the default cluster is assumed.

", "DeleteClusterRequest$cluster": "

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

", "DeleteServiceRequest$cluster": "

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

", "DeleteServiceRequest$service": "

The name of the service to delete.

", "Deployment$id": "

The ID of the deployment.

", - "Deployment$status": "

The status of the deployment. The following describes each state:

PRIMARY

The most recent deployment of a service.

ACTIVE

A service deployment that still has running tasks, but are in the process of being replaced with a new PRIMARY deployment.

INACTIVE

A deployment that has been completely replaced.

", - "Deployment$taskDefinition": "

The most recent task definition that was specified for the tasks in the service to use.

", - "Deployment$platformVersion": "

The platform version on which your tasks in the service are running. A platform version is only specified for tasks using the Fargate launch type. If one is not specified, the LATEST platform version is used by default. For more information, see AWS Fargate Platform Versions in the Amazon Elastic Container Service Developer Guide.

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

", + "Deployment$taskDefinition": "

The most recent task definition that was specified for the service to use.

", + "Deployment$platformVersion": "

The platform version on which your service is running.

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

", "DeregisterTaskDefinitionRequest$taskDefinition": "

The family and revision (family:revision) or full Amazon Resource Name (ARN) of the task definition to deregister. You must specify a revision.

", @@ -1278,23 +1124,18 @@ "Device$hostPath": "

The path for the device on the host container instance.

", "Device$containerPath": "

The path inside the container at which to expose the host device.

", "DiscoverPollEndpointRequest$containerInstance": "

The container instance ID or full 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 .

", - "DiscoverPollEndpointRequest$cluster": "

The short name or full Amazon Resource Name (ARN) of the cluster to which the container instance belongs.

", + "DiscoverPollEndpointRequest$cluster": "

The short name or full Amazon Resource Name (ARN) of 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, - "DockerVolumeConfiguration$driver": "

The Docker volume driver to use. The driver value must match the driver name provided by Docker because it is used for task placement. If the driver was installed using the Docker plugin CLI, use docker plugin ls to retrieve the driver name from your container instance. If the driver was installed using another method, use Docker plugin discovery to retrieve the driver name. For more information, see Docker plugin discovery. This parameter maps to Driver in the Create a volume section of the Docker Remote API and the xxdriver option to docker volume create .

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

", "HostEntry$ipAddress": "

The IP address to use in the /etc/hosts entry.

", - "HostVolumeProperties$sourcePath": "

When the host parameter is used, specify a sourcePath to declare the path on the host container instance that is presented to the container. If this parameter is empty, then the Docker daemon has assigned a host path for you. If the host parameter contains a sourcePath file location, then the data volume persists at the specified location on the host container instance until you delete it manually. If the sourcePath value does not exist on the host container instance, the Docker daemon creates it. If the location does exist, the contents of the source path folder are exported.

If you are using the Fargate launch type, the sourcePath parameter is not supported.

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

", - "ListAccountSettingsRequest$value": "

The value of the account settings with which to filter results. You must also specify an account setting name to use this parameter.

", - "ListAccountSettingsRequest$principalArn": "

The ARN of the principal, which can be an IAM user, IAM role, or the root user. If this field is omitted, the account settings are listed only for the authenticated user.

", - "ListAccountSettingsRequest$nextToken": "

The nextToken value returned from a previous paginated ListAccountSettings 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 token should be treated as an opaque identifier that is only used to retrieve the next items in a list and not for other programmatic purposes.

", - "ListAccountSettingsResponse$nextToken": "

The nextToken value to include in a future ListAccountSettings request. When the results of a ListAccountSettings 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.

", + "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. If the host parameter contains a sourcePath file location, then the data volume persists at the specified location on the host container instance until you delete it manually. If the sourcePath value does not exist on the host container instance, the Docker daemon creates it. If the location does exist, the contents of the source path folder are exported.

If you are using the Fargate launch type, the sourcePath parameter is not supported.

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

", "ListAttributesRequest$cluster": "

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

", "ListAttributesRequest$attributeName": "

The name of the attribute with which to filter the results.

", "ListAttributesRequest$attributeValue": "

The value of the attribute with which to filter results. You must also specify an attribute name to use this parameter.

", @@ -1323,12 +1164,12 @@ "ListTasksRequest$startedBy": "

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.

", "ListTasksRequest$serviceName": "

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.

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

", - "LoadBalancer$targetGroupArn": "

The full Amazon Resource Name (ARN) of the Elastic Load Balancing target group or groups associated with a service. For services using the ECS deployment controller, you are limited to one target group. For services using the CODE_DEPLOY deployment controller, you are required to define two target groups for the load balancer.

If your service's task definition uses the awsvpc network mode (which is required for the Fargate launch type), you must choose ip as the target type, not instance, because tasks that use the awsvpc network mode are associated with an elastic network interface, not an Amazon EC2 instance.

", + "LoadBalancer$targetGroupArn": "

The full Amazon Resource Name (ARN) of the Elastic Load Balancing target group associated with a service.

If your service's task definition uses the awsvpc network mode (which is required for the Fargate launch type), you must choose ip as the target type, not instance, because tasks that use the awsvpc network mode are associated with an elastic network interface, not an Amazon EC2 instance.

", "LoadBalancer$loadBalancerName": "

The name of a load balancer.

", "LoadBalancer$containerName": "

The name of the container (as it appears in a container definition) to associate with the load balancer.

", "LogConfigurationOptionsMap$key": null, "LogConfigurationOptionsMap$value": null, - "MountPoint$sourceVolume": "

The name of the volume to mount. Must be a volume name referenced in the name parameter of task definition volume.

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

", "NetworkInterface$attachmentId": "

The attachment ID for the network interface.

", @@ -1336,8 +1177,6 @@ "NetworkInterface$ipv6Address": "

The private IPv6 address for the network interface.

", "PlacementConstraint$expression": "

A cluster query language expression to apply to the constraint. You cannot specify an expression if the constraint type is distinctInstance. For more information, see Cluster Query Language in the Amazon Elastic Container Service Developer Guide.

", "PlacementStrategy$field": "

The field to apply the placement strategy against. For the spread placement strategy, valid values are instanceId (or host, which has the same effect), or any platform or custom attribute that is applied to a container instance, such as attribute:ecs.availability-zone. For the binpack placement strategy, valid values are cpu and memory. For the random placement strategy, this field is not used.

", - "PutAccountSettingRequest$value": "

The account setting value for the specified principal ARN. Accepted values are ENABLED and DISABLED.

", - "PutAccountSettingRequest$principalArn": "

The ARN of the principal, which can be an IAM user, IAM role, or the root user. If you specify the root user, it modifies the ARN and resource ID format for all IAM users, IAM roles, and the root user of the account unless an IAM user or role explicitly overrides these settings for themselves. If this field is omitted, the setting are changed only for the authenticated user.

", "PutAttributesRequest$cluster": "

The short name or full Amazon Resource Name (ARN) of the cluster that contains the resource to apply attributes. If you do not specify a cluster, the default cluster is assumed.

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

", @@ -1346,14 +1185,14 @@ "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.

", "RegisterTaskDefinitionRequest$taskRoleArn": "

The short name or full Amazon Resource Name (ARN) of the IAM role that containers in this task can assume. All containers in this task are granted the permissions that are specified in this role. For more information, see IAM Roles for Tasks in the Amazon Elastic Container Service Developer Guide.

", "RegisterTaskDefinitionRequest$executionRoleArn": "

The Amazon Resource Name (ARN) of the task execution role that the Amazon ECS container agent and the Docker daemon can assume.

", - "RegisterTaskDefinitionRequest$cpu": "

The number of CPU units used by the task. It can be expressed as an integer using CPU units, for example 1024, or as a string using vCPUs, for example 1 vCPU or 1 vcpu, in a task definition. String values are converted to an integer indicating the CPU units when the task definition is registered.

Task-level CPU and memory parameters are ignored for Windows containers. We recommend specifying container-level resources for Windows containers.

If you are using the EC2 launch type, this field is optional. Supported values are between 128 CPU units (0.125 vCPUs) and 10240 CPU units (10 vCPUs).

If you are using the Fargate launch type, this field is required and you must use one of the following values, which determines your range of supported values for the memory parameter:

", + "RegisterTaskDefinitionRequest$cpu": "

The number of CPU units used by the task. It can be expressed as an integer using CPU units, for example 1024, or as a string using vCPUs, for example 1 vCPU or 1 vcpu, in a task definition. String values are converted to an integer indicating the CPU units when the task definition is registered.

Task-level CPU and memory parameters are ignored for Windows containers. We recommend specifying container-level resources for Windows containers.

If using the EC2 launch type, this field is optional. Supported values are between 128 CPU units (0.125 vCPUs) and 10240 CPU units (10 vCPUs).

If using the Fargate launch type, this field is required and you must use one of the following values, which determines your range of supported values for the memory parameter:

", "RegisterTaskDefinitionRequest$memory": "

The amount of memory (in MiB) used by the task. It can be expressed as an integer using MiB, for example 1024, or as a string using GB, for example 1GB or 1 GB, in a task definition. String values are converted to an integer indicating the MiB when the task definition is registered.

Task-level CPU and memory parameters are ignored for Windows containers. We recommend specifying container-level resources for Windows containers.

If using the EC2 launch type, this field is optional.

If using the Fargate launch type, this field is required and you must use one of the following values, which determines your range of supported values for the cpu parameter:

", - "RepositoryCredentials$credentialsParameter": "

The Amazon Resource Name (ARN) of the secret containing the private repository credentials.

When you are using the Amazon ECS API, AWS CLI, or AWS SDK, if the secret exists in the same Region as the task that you are launching then you can use either the full ARN or the name of the secret. When you are using the AWS Management Console, you must specify the full ARN of the secret.

", + "RepositoryCredentials$credentialsParameter": "

The Amazon Resource Name (ARN) or name of the secret containing the private repository credentials.

", "Resource$name": "

The name of the resource, such as CPU, MEMORY, PORTS, PORTS_UDP, 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 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 ARN of the task definition to run. If a revision is not specified, the latest ACTIVE revision is used.

", - "RunTaskRequest$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. Up to 36 letters (uppercase and lowercase), numbers, hyphens, and underscores are allowed.

If a task is started by an Amazon ECS service, then the startedBy parameter contains the deployment ID of the service that starts it.

", + "RunTaskRequest$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. Up to 36 letters (uppercase and lowercase), numbers, hyphens, and underscores are allowed.

If a task is started by an Amazon ECS service, then the startedBy parameter contains the deployment ID of the service that starts it.

", "RunTaskRequest$group": "

The name of the task group to associate with the task. The default value is the family name of the task definition (for example, family:my-family-name).

", "RunTaskRequest$platformVersion": "

The platform version on which to run your task. If one is not specified, the latest version is used by default.

", "Secret$name": null, @@ -1363,26 +1202,21 @@ "Service$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.

", "Service$clusterArn": "

The Amazon Resource Name (ARN) of the cluster that hosts the service.

", "Service$status": "

The status of the service. The valid values are ACTIVE, DRAINING, or INACTIVE.

", - "Service$platformVersion": "

The platform version on which your tasks in the service are running. A platform version is only specified for tasks using the Fargate launch type. If one is not specified, the LATEST platform version is used by default. For more information, see AWS Fargate Platform Versions in the Amazon Elastic Container Service Developer Guide.

", + "Service$platformVersion": "

The platform version on which your task is running. For more information, see AWS Fargate Platform Versions in the Amazon Elastic Container Service Developer Guide.

", "Service$taskDefinition": "

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 ARN of the IAM role associated with the service that allows the Amazon ECS container agent to register container instances with an Elastic Load Balancing load balancer.

", - "Service$createdBy": "

The principal that created the service.

", "ServiceEvent$id": "

The ID string of the event.

", "ServiceEvent$message": "

The event message.

", "ServiceRegistry$registryArn": "

The Amazon Resource Name (ARN) of the service registry. The currently supported service registry is Amazon Route 53 Auto Naming. For more information, see Service.

", "ServiceRegistry$containerName": "

The container name value, already specified in the task definition, to be used for your service discovery service. If the task definition that your service task specifies uses the bridge or host network mode, you must specify a containerName and containerPort combination from the task definition. If the task definition that your service task specifies uses the awsvpc network mode and a type SRV DNS record is used, you must specify either a containerName and containerPort combination or a port value, but not both.

", - "Setting$value": "

The current account setting for the resource name. If ENABLED, then the resource will receive the new Amazon Resource Name (ARN) and resource identifier (ID) format. If DISABLED, then the resource will receive the old Amazon Resource Name (ARN) and resource identifier (ID) format.

", - "Setting$principalArn": "

The ARN of the principal, which can be an IAM user, IAM role, or the root user. If this field is omitted, the authenticated user is assumed.

", "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 ARN of the task definition to start. If a revision is not specified, the latest ACTIVE revision is used.

", - "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. Up to 36 letters (uppercase and lowercase), numbers, hyphens, and underscores are allowed.

If a task is started by an Amazon ECS service, then the startedBy parameter contains the deployment ID of the service that starts it.

", + "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. Up to 36 letters (uppercase and lowercase), numbers, hyphens, and underscores are allowed.

If a task is started by an Amazon ECS service, then the startedBy parameter contains the deployment ID of the service that starts it.

", "StartTaskRequest$group": "

The name of the task group to associate with the task. The default value is the family name of the task definition (for example, family:my-family-name).

", "StopTaskRequest$cluster": "

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 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 appears in subsequent DescribeTasks API operations on this task. Up to 255 characters are allowed in this message.

", "StringList$member": null, - "StringMap$key": null, - "StringMap$value": null, "SubmitContainerStateChangeRequest$cluster": "

The short name or full 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.

", @@ -1394,72 +1228,61 @@ "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.

", - "SystemControl$namespace": "

The namespaced kernel parameter for which to set a value.

", - "SystemControl$value": "

The value for the namespaced kernel parameter specified in namespace.

", - "TagResourceRequest$resourceArn": "

The Amazon Resource Name (ARN) of the resource to which to add tags. Currently, the supported resources are Amazon ECS tasks, services, task definitions, clusters, and container instances.

", "Task$taskArn": "

The Amazon Resource Name (ARN) of the task.

", "Task$clusterArn": "

The ARN of the cluster that hosts the task.

", "Task$taskDefinitionArn": "

The ARN of the task definition that creates the task.

", "Task$containerInstanceArn": "

The ARN of the container instances that host the task.

", - "Task$lastStatus": "

The last known status of the task. For more information, see Task Lifecycle.

", - "Task$desiredStatus": "

The desired status of the task. For more information, see Task Lifecycle.

", - "Task$cpu": "

The number of CPU units used by the task as expressed in a task definition. It can be expressed as an integer using CPU units, for example 1024. It can also be expressed as a string using vCPUs, for example 1 vCPU or 1 vcpu. String values are converted to an integer indicating the CPU units when the task definition is registered.

If you are using the EC2 launch type, this field is optional. Supported values are between 128 CPU units (0.125 vCPUs) and 10240 CPU units (10 vCPUs).

If you are using the Fargate launch type, this field is required and you must use one of the following values, which determines your range of supported values for the memory parameter:

", - "Task$memory": "

The amount of memory (in MiB) used by the task as expressed in a task definition. It can be expressed as an integer using MiB, for example 1024. It can also be expressed as a string using GB, for example 1GB or 1 GB. String values are converted to an integer indicating the MiB when the task definition is registered.

If you are using the EC2 launch type, this field is optional.

If you are using the Fargate launch type, this field is required and you must use one of the following values, which determines your range of supported values for the cpu parameter:

", + "Task$lastStatus": "

The last known status of the task.

", + "Task$desiredStatus": "

The desired status of the task.

", + "Task$cpu": "

The number of CPU units used by the task. It can be expressed as an integer using CPU units, for example 1024, or as a string using vCPUs, for example 1 vCPU or 1 vcpu, in a task definition. String values are converted to an integer indicating the CPU units when the task definition is registered.

If using the EC2 launch type, this field is optional. Supported values are between 128 CPU units (0.125 vCPUs) and 10240 CPU units (10 vCPUs).

If using the Fargate launch type, this field is required and you must use one of the following values, which determines your range of supported values for the memory parameter:

", + "Task$memory": "

The amount of memory (in MiB) used by the task. It can be expressed as an integer using MiB, for example 1024, or as a string using GB, for example 1GB or 1 GB, in a task definition. String values are converted to an integer indicating the MiB when the task definition is registered.

If using the EC2 launch type, this field is optional.

If using the Fargate launch type, this field is required and you must use one of the following values, which determines your range of supported values for the cpu parameter:

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

", - "Task$stoppedReason": "

The reason that the task was stopped.

", + "Task$stoppedReason": "

The reason the task was stopped.

", "Task$group": "

The name of the task group associated with the task.

", - "Task$platformVersion": "

The platform version on which your task is running. A platform version is only specified for tasks using the Fargate launch type. If one is not specified, the LATEST platform version is used by default. For more information, see AWS Fargate Platform Versions in the Amazon Elastic Container Service Developer Guide.

", + "Task$platformVersion": "

The platform version on which your task is running. For more information, see AWS Fargate Platform Versions in the Amazon Elastic Container Service Developer Guide.

", "TaskDefinition$taskDefinitionArn": "

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

", "TaskDefinition$family": "

The family of your task definition, used as the definition name.

", "TaskDefinition$taskRoleArn": "

The ARN of the IAM role that containers in this task can assume. All containers in this task are granted the permissions that are specified in this role.

IAM roles for tasks on Windows require that the -EnableTaskIAMRole option is set when you launch the Amazon ECS-optimized Windows AMI. Your containers must also run some configuration code in order to take advantage of the feature. For more information, see Windows IAM Roles for Tasks in the Amazon Elastic Container Service Developer Guide.

", "TaskDefinition$executionRoleArn": "

The Amazon Resource Name (ARN) of the task execution role that the Amazon ECS container agent and the Docker daemon can assume.

", - "TaskDefinition$cpu": "

The number of cpu units used by the task. If you are using the EC2 launch type, this field is optional and any value can be used. If you are using the Fargate launch type, this field is required and you must use one of the following values, which determines your range of valid values for the memory parameter:

", + "TaskDefinition$cpu": "

The number of cpu units used by the task. If using the EC2 launch type, this field is optional and any value can be used. If using the Fargate launch type, this field is required and you must use one of the following values, which determines your range of valid values for the memory parameter:

", "TaskDefinition$memory": "

The amount (in MiB) of memory used by the task. If using the EC2 launch type, this field is optional and any value can be used. If using the Fargate launch type, this field is required and you must use one of the following values, which determines your range of valid values for the cpu parameter:

", "TaskDefinitionPlacementConstraint$expression": "

A cluster query language expression to apply to the constraint. For more information, see Cluster Query Language in the Amazon Elastic Container Service Developer Guide.

", "TaskOverride$taskRoleArn": "

The Amazon Resource Name (ARN) of the IAM role that containers in this task can assume. All containers in this task are granted the permissions that are specified in this role.

", "TaskOverride$executionRoleArn": "

The Amazon Resource Name (ARN) of the task execution role that the Amazon ECS container agent and the Docker daemon can assume.

", - "TaskSet$id": "

The ID of the task set.

", - "TaskSet$taskSetArn": "

The Amazon Resource Name (ARN) of the task set.

", - "TaskSet$startedBy": "

The tag specified when a task set is started. If the task is started by an AWS CodeDeploy deployment, then the startedBy parameter is CODE_DEPLOY.

", - "TaskSet$externalId": "

The deployment ID of the AWS CodeDeploy deployment.

", - "TaskSet$status": "

The status of the task set. The following describes each state:

PRIMARY

The task set is serving production traffic.

ACTIVE

The task set is not serving production traffic.

DRAINING

The tasks in the task set are being stopped and their corresponding targets are being deregistered from their target group.

", - "TaskSet$taskDefinition": "

The task definition the task set is using.

", - "TaskSet$platformVersion": "

The platform version on which the tasks in the task set are running. A platform version is only specified for tasks using the Fargate launch type. If one is not specified, the LATEST platform version is used by default. For more information, see AWS Fargate Platform Versions in the Amazon Elastic Container Service Developer Guide.

", "Tmpfs$containerPath": "

The absolute file path where the tmpfs volume is to be mounted.

", - "UntagResourceRequest$resourceArn": "

The Amazon Resource Name (ARN) of the resource from which to delete tags. Currently, the supported resources are Amazon ECS tasks, services, task definitions, clusters, and container instances.

", "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 ARN entries for the container instance on which you would like to update the Amazon ECS container agent.

", "UpdateContainerInstancesStateRequest$cluster": "

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

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

", - "UpdateServiceRequest$platformVersion": "

The platform version on which your tasks in the service are running. A platform version is only specified for tasks using the Fargate launch type. If one is not specified, the LATEST platform version is used by default. For more information, see AWS Fargate Platform Versions in the Amazon Elastic Container Service Developer Guide.

", + "UpdateServiceRequest$platformVersion": "

The platform version that your service should run.

", "VersionInfo$agentVersion": "

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. Up to 255 letters (uppercase and lowercase), numbers, hyphens, and underscores are allowed. This name is referenced in the sourceVolume parameter of container definition mountPoints.

", - "VolumeFrom$sourceContainer": "

The name of another container within the same task definition from which to mount volumes.

" + "VolumeFrom$sourceContainer": "

The name of another container within the same task definition to mount volumes from.

" } }, "StringList": { "base": null, "refs": { - "AwsVpcConfiguration$subnets": "

The subnets associated with the task or service. There is a limit of 16 subnets able to be specified per AwsVpcConfiguration.

All specified subnets must be from the same VPC.

", - "AwsVpcConfiguration$securityGroups": "

The security groups associated with the task or service. If you do not specify a security group, the default security group for the VPC is used. There is a limit of five security groups able to be specified per AwsVpcConfiguration.

All specified security groups must be from the same VPC.

", - "ContainerDefinition$links": "

The link parameter allows containers to communicate with each other without the need for port mappings. Only supported if the network mode of a task definition is set to bridge. The name:internalName construct is analogous to name:alias in Docker links. Up to 255 letters (uppercase and lowercase), numbers, hyphens, and underscores are allowed. For more information about linking Docker containers, go to https://docs.docker.com/engine/userguide/networking/default_network/dockerlinks/. This parameter maps to Links in the Create a container section of the Docker Remote API and the --link option to docker run .

This parameter is not supported for Windows containers.

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.

", - "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 entry point that is passed to the container. This parameter maps to Entrypoint in the Create a container section of the Docker Remote API and the --entrypoint option to docker run. For more information, see https://docs.docker.com/engine/reference/builder/#entrypoint.

", - "ContainerDefinition$command": "

The command that is passed to the container. This parameter maps to Cmd in the Create a container section of the Docker Remote API and the COMMAND parameter to docker run. For more information, see https://docs.docker.com/engine/reference/builder/#cmd.

", - "ContainerDefinition$dnsServers": "

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.

This parameter is not supported for Windows containers.

", - "ContainerDefinition$dnsSearchDomains": "

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.

This parameter is not supported for Windows containers.

", - "ContainerDefinition$dockerSecurityOptions": "

A list of strings to provide custom labels for SELinux and AppArmor multi-level security systems. This field is not valid for containers in tasks using the Fargate launch type.

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 Elastic Container Service Developer Guide.

This parameter is not supported for Windows containers.

", + "AwsVpcConfiguration$subnets": "

The subnets associated with the task or service. There is a limit of 10 subnets able to be specified per AwsVpcConfiguration.

All specified subnets must be from the same VPC.

", + "AwsVpcConfiguration$securityGroups": "

The security groups associated with the task or service. If you do not specify a security group, the default security group for the VPC is used. There is a limit of 5 security groups able to be specified per AwsVpcConfiguration.

All specified security groups must be from the same VPC.

", + "ContainerDefinition$links": "

The link parameter allows containers to communicate with each other without the need for port mappings. Only supported if the network mode of a task definition is set to bridge. The name:internalName construct is analogous to name:alias in Docker links. Up to 255 letters (uppercase and lowercase), numbers, hyphens, and underscores are allowed. For more information about linking Docker containers, go to https://docs.docker.com/engine/userguide/networking/default_network/dockerlinks/. This parameter maps to Links in the Create a container section of the Docker Remote API and the --link option to docker run .

This parameter is not supported for Windows containers.

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.

", + "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 entry point that is passed to the container. This parameter maps to Entrypoint in the Create a container section of the Docker Remote API and the --entrypoint option to docker run. For more information, see https://docs.docker.com/engine/reference/builder/#entrypoint.

", + "ContainerDefinition$command": "

The command that is passed to the container. This parameter maps to Cmd in the Create a container section of the Docker Remote API and the COMMAND parameter to docker run. For more information, see https://docs.docker.com/engine/reference/builder/#cmd.

", + "ContainerDefinition$dnsServers": "

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.

This parameter is not supported for Windows containers.

", + "ContainerDefinition$dnsSearchDomains": "

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.

This parameter is not supported for Windows containers.

", + "ContainerDefinition$dockerSecurityOptions": "

A list of strings to provide custom labels for SELinux and AppArmor multi-level security systems. This field is not valid for containers in tasks using the Fargate launch type.

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 Elastic Container Service Developer Guide.

This parameter is not supported for Windows containers.

", "ContainerOverride$command": "

The command to send to the container that overrides the default command from the Docker image or the task definition. You must also specify a container name.

", "DescribeClustersRequest$clusters": "

A list of up to 100 cluster names or full cluster Amazon Resource Name (ARN) entries. If you do not specify a cluster, the default cluster is assumed.

", "DescribeContainerInstancesRequest$containerInstances": "

A list of up to 100 container instance IDs or full Amazon Resource Name (ARN) entries.

", "DescribeServicesRequest$services": "

A list of services to describe. You may specify up to 10 services to describe in a single operation.

", "DescribeTasksRequest$tasks": "

A list of up to 100 task IDs or full ARN entries.

", - "HealthCheck$command": "

A string array representing the command that the container runs to determine if it is healthy. The string array must start with CMD to execute the command arguments directly, or CMD-SHELL to run the command with the container's default shell. For example:

[ \"CMD-SHELL\", \"curl -f http://localhost/ || exit 1\" ]

An exit code of 0 indicates success, and non-zero exit code indicates failure. For more information, see HealthCheck in the Create a container section of the Docker Remote API.

", - "KernelCapabilities$add": "

The Linux capabilities for the container that have been added to the default configuration provided by Docker. This parameter maps to CapAdd in the Create a container section of the Docker Remote API and the --cap-add option to docker run.

If you are using tasks that use the Fargate launch type, the add parameter is not supported.

Valid values: \"ALL\" | \"AUDIT_CONTROL\" | \"AUDIT_WRITE\" | \"BLOCK_SUSPEND\" | \"CHOWN\" | \"DAC_OVERRIDE\" | \"DAC_READ_SEARCH\" | \"FOWNER\" | \"FSETID\" | \"IPC_LOCK\" | \"IPC_OWNER\" | \"KILL\" | \"LEASE\" | \"LINUX_IMMUTABLE\" | \"MAC_ADMIN\" | \"MAC_OVERRIDE\" | \"MKNOD\" | \"NET_ADMIN\" | \"NET_BIND_SERVICE\" | \"NET_BROADCAST\" | \"NET_RAW\" | \"SETFCAP\" | \"SETGID\" | \"SETPCAP\" | \"SETUID\" | \"SYS_ADMIN\" | \"SYS_BOOT\" | \"SYS_CHROOT\" | \"SYS_MODULE\" | \"SYS_NICE\" | \"SYS_PACCT\" | \"SYS_PTRACE\" | \"SYS_RAWIO\" | \"SYS_RESOURCE\" | \"SYS_TIME\" | \"SYS_TTY_CONFIG\" | \"SYSLOG\" | \"WAKE_ALARM\"

", - "KernelCapabilities$drop": "

The Linux capabilities for the container that have been removed from the default configuration provided by Docker. This parameter maps to CapDrop in the Create a container section of the Docker Remote API and the --cap-drop option to docker run.

Valid values: \"ALL\" | \"AUDIT_CONTROL\" | \"AUDIT_WRITE\" | \"BLOCK_SUSPEND\" | \"CHOWN\" | \"DAC_OVERRIDE\" | \"DAC_READ_SEARCH\" | \"FOWNER\" | \"FSETID\" | \"IPC_LOCK\" | \"IPC_OWNER\" | \"KILL\" | \"LEASE\" | \"LINUX_IMMUTABLE\" | \"MAC_ADMIN\" | \"MAC_OVERRIDE\" | \"MKNOD\" | \"NET_ADMIN\" | \"NET_BIND_SERVICE\" | \"NET_BROADCAST\" | \"NET_RAW\" | \"SETFCAP\" | \"SETGID\" | \"SETPCAP\" | \"SETUID\" | \"SYS_ADMIN\" | \"SYS_BOOT\" | \"SYS_CHROOT\" | \"SYS_MODULE\" | \"SYS_NICE\" | \"SYS_PACCT\" | \"SYS_PTRACE\" | \"SYS_RAWIO\" | \"SYS_RESOURCE\" | \"SYS_TIME\" | \"SYS_TTY_CONFIG\" | \"SYSLOG\" | \"WAKE_ALARM\"

", + "HealthCheck$command": "

A string array representing the command that the container runs to determine if it is healthy. The string array must start with CMD to execute the command arguments directly, or CMD-SHELL to run the command with the container's default shell. For example:

[ \"CMD-SHELL\", \"curl -f http://localhost/ || exit 1\" ]

An exit code of 0 indicates success, and non-zero exit code indicates failure. For more information, see HealthCheck in the Create a container section of the Docker Remote API.

", + "KernelCapabilities$add": "

The Linux capabilities for the container that have been added to the default configuration provided by Docker. This parameter maps to CapAdd in the Create a container section of the Docker Remote API and the --cap-add option to docker run.

If you are using tasks that use the Fargate launch type, the add parameter is not supported.

Valid values: \"ALL\" | \"AUDIT_CONTROL\" | \"AUDIT_WRITE\" | \"BLOCK_SUSPEND\" | \"CHOWN\" | \"DAC_OVERRIDE\" | \"DAC_READ_SEARCH\" | \"FOWNER\" | \"FSETID\" | \"IPC_LOCK\" | \"IPC_OWNER\" | \"KILL\" | \"LEASE\" | \"LINUX_IMMUTABLE\" | \"MAC_ADMIN\" | \"MAC_OVERRIDE\" | \"MKNOD\" | \"NET_ADMIN\" | \"NET_BIND_SERVICE\" | \"NET_BROADCAST\" | \"NET_RAW\" | \"SETFCAP\" | \"SETGID\" | \"SETPCAP\" | \"SETUID\" | \"SYS_ADMIN\" | \"SYS_BOOT\" | \"SYS_CHROOT\" | \"SYS_MODULE\" | \"SYS_NICE\" | \"SYS_PACCT\" | \"SYS_PTRACE\" | \"SYS_RAWIO\" | \"SYS_RESOURCE\" | \"SYS_TIME\" | \"SYS_TTY_CONFIG\" | \"SYSLOG\" | \"WAKE_ALARM\"

", + "KernelCapabilities$drop": "

The Linux capabilities for the container that have been removed from the default configuration provided by Docker. This parameter maps to CapDrop in the Create a container section of the Docker Remote API and the --cap-drop option to docker run.

Valid values: \"ALL\" | \"AUDIT_CONTROL\" | \"AUDIT_WRITE\" | \"BLOCK_SUSPEND\" | \"CHOWN\" | \"DAC_OVERRIDE\" | \"DAC_READ_SEARCH\" | \"FOWNER\" | \"FSETID\" | \"IPC_LOCK\" | \"IPC_OWNER\" | \"KILL\" | \"LEASE\" | \"LINUX_IMMUTABLE\" | \"MAC_ADMIN\" | \"MAC_OVERRIDE\" | \"MKNOD\" | \"NET_ADMIN\" | \"NET_BIND_SERVICE\" | \"NET_BROADCAST\" | \"NET_RAW\" | \"SETFCAP\" | \"SETGID\" | \"SETPCAP\" | \"SETUID\" | \"SYS_ADMIN\" | \"SYS_BOOT\" | \"SYS_CHROOT\" | \"SYS_MODULE\" | \"SYS_NICE\" | \"SYS_PACCT\" | \"SYS_PTRACE\" | \"SYS_RAWIO\" | \"SYS_RESOURCE\" | \"SYS_TIME\" | \"SYS_TTY_CONFIG\" | \"SYSLOG\" | \"WAKE_ALARM\"

", "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 ARN entries for each container instance associated with the specified cluster.

", "ListServicesResponse$serviceArns": "

The list of full ARN entries for each service associated with the specified cluster.

", @@ -1468,17 +1291,10 @@ "ListTasksResponse$taskArns": "

The list of task 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 IDs or full ARN entries for the container instances on which you would like to place your task. You can specify up to 10 container instances.

", - "Tmpfs$mountOptions": "

The list of tmpfs volume mount options.

Valid values: \"defaults\" | \"ro\" | \"rw\" | \"suid\" | \"nosuid\" | \"dev\" | \"nodev\" | \"exec\" | \"noexec\" | \"sync\" | \"async\" | \"dirsync\" | \"remount\" | \"mand\" | \"nomand\" | \"atime\" | \"noatime\" | \"diratime\" | \"nodiratime\" | \"bind\" | \"rbind\" | \"unbindable\" | \"runbindable\" | \"private\" | \"rprivate\" | \"shared\" | \"rshared\" | \"slave\" | \"rslave\" | \"relatime\" | \"norelatime\" | \"strictatime\" | \"nostrictatime\" | \"mode\" | \"uid\" | \"gid\" | \"nr_inodes\" | \"nr_blocks\" | \"mpol\"

", + "Tmpfs$mountOptions": "

The list of tmpfs volume mount options.

Valid values: \"defaults\" | \"ro\" | \"rw\" | \"suid\" | \"nosuid\" | \"dev\" | \"nodev\" | \"exec\" | \"noexec\" | \"sync\" | \"async\" | \"dirsync\" | \"remount\" | \"mand\" | \"nomand\" | \"atime\" | \"noatime\" | \"diratime\" | \"nodiratime\" | \"bind\" | \"rbind\" | \"unbindable\" | \"runbindable\" | \"private\" | \"rprivate\" | \"shared\" | \"rshared\" | \"slave\" | \"rslave\" | \"relatime\" | \"norelatime\" | \"strictatime\" | \"nostrictatime\"

", "UpdateContainerInstancesStateRequest$containerInstances": "

A list of container instance IDs or full ARN entries.

" } }, - "StringMap": { - "base": null, - "refs": { - "DockerVolumeConfiguration$driverOpts": "

A map of Docker driver-specific options passed through. This parameter maps to DriverOpts in the Create a volume section of the Docker Remote API and the xxopt option to docker volume create .

", - "DockerVolumeConfiguration$labels": "

Custom metadata to add to your Docker volume. This parameter maps to Labels in the Create a volume section of the Docker Remote API and the xxlabel option to docker volume create .

" - } - }, "SubmitContainerStateChangeRequest": { "base": null, "refs": { @@ -1499,74 +1315,16 @@ "refs": { } }, - "SystemControl": { - "base": "

A list of namespaced kernel parameters to set in the container. This parameter maps to Sysctls in the Create a container section of the Docker Remote API and the --sysctl option to docker run.

It is not recommended that you specify network-related systemControls parameters for multiple containers in a single task that also uses either the awsvpc or host network mode for the following reasons:

", - "refs": { - "SystemControls$member": null - } - }, - "SystemControls": { - "base": null, - "refs": { - "ContainerDefinition$systemControls": "

A list of namespaced kernel parameters to set in the container. This parameter maps to Sysctls in the Create a container section of the Docker Remote API and the --sysctl option to docker run.

It is not recommended that you specify network-related systemControls parameters for multiple containers in a single task that also uses either the awsvpc or host network modes. For tasks that use the awsvpc network mode, the container that is started last determines which systemControls parameters take effect. For tasks that use the host network mode, it changes the container instance's namespaced kernel parameters as well as the containers.

" - } - }, - "Tag": { - "base": "

The metadata that you apply to a resource to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define. Tag keys can have a maximum character length of 128 characters, and tag values can have a maximum length of 256 characters.

", - "refs": { - "Tags$member": null - } - }, - "TagKey": { - "base": null, - "refs": { - "Tag$key": "

One part of a key-value pair that make up a tag. A key is a general label that acts like a category for more specific tag values.

", - "TagKeys$member": null - } - }, - "TagKeys": { - "base": null, - "refs": { - "UntagResourceRequest$tagKeys": "

The keys of the tags to be removed.

" - } - }, - "TagResourceRequest": { - "base": null, - "refs": { - } - }, - "TagResourceResponse": { - "base": null, - "refs": { - } - }, - "TagValue": { - "base": null, - "refs": { - "Tag$value": "

The optional part of a key-value pair that make up a tag. A value acts as a descriptor within a tag category (key).

" - } - }, "Tags": { "base": null, "refs": { - "Cluster$tags": "

The metadata that you apply to the cluster to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define. Tag keys can have a maximum character length of 128 characters, and tag values can have a maximum length of 256 characters.

", "ContainerInstance$tags": "

The metadata that you apply to the container instance to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define. Tag keys can have a maximum character length of 128 characters, and tag values can have a maximum length of 256 characters.

", - "CreateClusterRequest$tags": "

The metadata that you apply to the cluster to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define. Tag keys can have a maximum character length of 128 characters, and tag values can have a maximum length of 256 characters.

", - "CreateServiceRequest$tags": "

The metadata that you apply to the service to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define. When a service is deleted, the tags are deleted as well. Tag keys can have a maximum character length of 128 characters, and tag values can have a maximum length of 256 characters.

", - "DescribeTaskDefinitionResponse$tags": "

The metadata that is applied to the task definition to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define. Tag keys can have a maximum character length of 128 characters, and tag values can have a maximum length of 256 characters.

", "ListTagsForResourceResponse$tags": "

The tags for the resource.

", - "RegisterContainerInstanceRequest$tags": "

The metadata that you apply to the container instance to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define. Tag keys can have a maximum character length of 128 characters, and tag values can have a maximum length of 256 characters.

", - "RegisterTaskDefinitionRequest$tags": "

The metadata that you apply to the task definition to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define. Tag keys can have a maximum character length of 128 characters, and tag values can have a maximum length of 256 characters.

", - "RegisterTaskDefinitionResponse$tags": "

The list of tags associated with the task definition.

", - "RunTaskRequest$tags": "

The metadata that you apply to the task to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define. Tag keys can have a maximum character length of 128 characters, and tag values can have a maximum length of 256 characters.

", - "Service$tags": "

The metadata that you apply to the service to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define. Tag keys can have a maximum character length of 128 characters, and tag values can have a maximum length of 256 characters.

", - "StartTaskRequest$tags": "

The metadata that you apply to the task to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define. Tag keys can have a maximum character length of 128 characters, and tag values can have a maximum length of 256 characters.

", - "TagResourceRequest$tags": "

The tags to add to the resource. A tag is an array of key-value pairs. Tag keys can have a maximum character length of 128 characters, and tag values can have a maximum length of 256 characters.

", "Task$tags": "

The metadata that you apply to the task to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define. Tag keys can have a maximum character length of 128 characters, and tag values can have a maximum length of 256 characters.

" } }, "TargetNotFoundException": { - "base": "

The specified target could not be found. You can view your available container instances with ListContainerInstances. Amazon ECS container instances are cluster-specific and Region-specific.

", + "base": "

The specified target could not be found. You can view your available container instances with ListContainerInstances. Amazon ECS container instances are cluster-specific and region-specific.

", "refs": { } }, @@ -1598,18 +1356,6 @@ "ListTaskDefinitionFamiliesRequest$status": "

The task definition family status with which to filter the ListTaskDefinitionFamilies results. By default, both ACTIVE and INACTIVE task definition families are listed. If this parameter is set to ACTIVE, only task definition families that have an ACTIVE task definition revision are returned. If this parameter is set to INACTIVE, only task definition families that do not have any ACTIVE task definition revisions are returned. If you paginate the resulting output, be sure to keep the status value constant in each subsequent request.

" } }, - "TaskDefinitionField": { - "base": null, - "refs": { - "TaskDefinitionFieldList$member": null - } - }, - "TaskDefinitionFieldList": { - "base": null, - "refs": { - "DescribeTaskDefinitionRequest$include": "

Specifies whether to see the resource tags for the task definition. If TAGS is specified, the tags are included in the response. If this field is omitted, tags are not included in the response.

" - } - }, "TaskDefinitionPlacementConstraint": { "base": "

An object representing a constraint on task placement in the task definition.

If you are using the Fargate launch type, task placement constraints are not supported.

For more information, see Task Placement Constraints in the Amazon Elastic Container Service Developer Guide.

", "refs": { @@ -1625,8 +1371,8 @@ "TaskDefinitionPlacementConstraints": { "base": null, "refs": { - "RegisterTaskDefinitionRequest$placementConstraints": "

An array of placement constraint objects to use for the task. You can specify a maximum of 10 constraints per task (this limit includes constraints in the task definition and those specified at runtime).

", - "TaskDefinition$placementConstraints": "

An array of placement constraint objects to use for tasks. This field is not valid if you are using the Fargate launch type for your task.

" + "RegisterTaskDefinitionRequest$placementConstraints": "

An array of placement constraint objects to use for the task. You can specify a maximum of 10 constraints per task (this limit includes constraints in the task definition and those specified at run time).

", + "TaskDefinition$placementConstraints": "

An array of placement constraint objects to use for tasks. This field is not valid if using the Fargate launch type for your task.

" } }, "TaskDefinitionStatus": { @@ -1636,18 +1382,6 @@ "TaskDefinition$status": "

The status of the task definition.

" } }, - "TaskField": { - "base": null, - "refs": { - "TaskFieldList$member": null - } - }, - "TaskFieldList": { - "base": null, - "refs": { - "DescribeTasksRequest$include": "

Specifies whether you want to see the resource tags for the task. If TAGS is specified, the tags are included in the response. If this field is omitted, tags are not included in the response.

" - } - }, "TaskOverride": { "base": "

The overrides associated with a task.

", "refs": { @@ -1656,24 +1390,6 @@ "Task$overrides": "

One or more container overrides.

" } }, - "TaskSet": { - "base": "

Information about a set of Amazon ECS tasks in an AWS CodeDeploy deployment. An Amazon ECS task set includes details such as the desired number of tasks, how many tasks are running, and whether the task set serves production traffic.

", - "refs": { - "TaskSets$member": null - } - }, - "TaskSets": { - "base": null, - "refs": { - "Service$taskSets": "

Information about a set of Amazon ECS tasks in an AWS CodeDeploy deployment. An Amazon ECS task set includes details such as the desired number of tasks, how many tasks are running, and whether the task set serves production traffic.

" - } - }, - "TaskStopCode": { - "base": null, - "refs": { - "Task$stopCode": "

The stop code indicating why a task was stopped. The stoppedReason may contain additional details.

" - } - }, "Tasks": { "base": null, "refs": { @@ -1685,25 +1401,22 @@ "Timestamp": { "base": null, "refs": { - "ContainerInstance$registeredAt": "

The Unix timestamp for when the container instance was registered.

", - "Deployment$createdAt": "

The Unix timestamp for when the service deployment was created.

", - "Deployment$updatedAt": "

The Unix timestamp for when the service deployment was last updated.

", - "Service$createdAt": "

The Unix timestamp for when the service was created.

", - "ServiceEvent$createdAt": "

The Unix timestamp for when the event was triggered.

", - "SubmitTaskStateChangeRequest$pullStartedAt": "

The Unix timestamp for when the container image pull began.

", - "SubmitTaskStateChangeRequest$pullStoppedAt": "

The Unix timestamp for when the container image pull completed.

", - "SubmitTaskStateChangeRequest$executionStoppedAt": "

The Unix timestamp for when the task execution stopped.

", - "Task$connectivityAt": "

The Unix timestamp for when the task last went into CONNECTED status.

", - "Task$pullStartedAt": "

The Unix timestamp for when the container image pull began.

", - "Task$pullStoppedAt": "

The Unix timestamp for when the container image pull completed.

", - "Task$executionStoppedAt": "

The Unix timestamp for when the task execution stopped.

", - "Task$createdAt": "

The Unix timestamp for when the task was created (the task entered the PENDING state).

", - "Task$startedAt": "

The Unix timestamp for when the task started (the task transitioned from the PENDING state to the RUNNING state).

", - "Task$stoppingAt": "

The Unix timestamp for when the task stops (transitions from the RUNNING state to STOPPED).

", - "Task$stoppedAt": "

The Unix timestamp for when the task was stopped (the task transitioned from the RUNNING state to the STOPPED state).

", - "TaskSet$createdAt": "

The Unix timestamp for when the task set was created.

", - "TaskSet$updatedAt": "

The Unix timestamp for when the task set was last updated.

", - "TaskSet$stabilityStatusAt": "

The Unix timestamp for when the task set stability status was retrieved.

" + "ContainerInstance$registeredAt": "

The Unix time stamp for when the container instance was registered.

", + "Deployment$createdAt": "

The Unix time stamp for when the service was created.

", + "Deployment$updatedAt": "

The Unix time stamp for when the service was last updated.

", + "Service$createdAt": "

The Unix time stamp for when the service was created.

", + "ServiceEvent$createdAt": "

The Unix time stamp for when the event was triggered.

", + "SubmitTaskStateChangeRequest$pullStartedAt": "

The Unix time stamp for when the container image pull began.

", + "SubmitTaskStateChangeRequest$pullStoppedAt": "

The Unix time stamp for when the container image pull completed.

", + "SubmitTaskStateChangeRequest$executionStoppedAt": "

The Unix time stamp for when the task execution stopped.

", + "Task$connectivityAt": "

The Unix time stamp for when the task last went into CONNECTED status.

", + "Task$pullStartedAt": "

The Unix time stamp for when the container image pull began.

", + "Task$pullStoppedAt": "

The Unix time stamp for when the container image pull completed.

", + "Task$executionStoppedAt": "

The Unix time stamp for when the task execution stopped.

", + "Task$createdAt": "

The Unix time stamp for when the task was created (the task entered the PENDING state).

", + "Task$startedAt": "

The Unix time stamp for when the task started (the task transitioned from the PENDING state to the RUNNING state).

", + "Task$stoppingAt": "

The Unix time stamp for when the task stops (transitions from the RUNNING state to STOPPED).

", + "Task$stoppedAt": "

The Unix time stamp for when the task was stopped (the task transitioned from the RUNNING state to the STOPPED state).

" } }, "Tmpfs": { @@ -1734,7 +1447,7 @@ "UlimitList": { "base": null, "refs": { - "ContainerDefinition$ulimits": "

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 in to your container instance and run the following command: sudo docker version --format '{{.Server.APIVersion}}'

This parameter is not supported for Windows containers.

" + "ContainerDefinition$ulimits": "

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 in to your container instance and run the following command: sudo docker version | grep \"Server API version\"

This parameter is not supported for Windows containers.

" } }, "UlimitName": { @@ -1744,17 +1457,7 @@ } }, "UnsupportedFeatureException": { - "base": "

The specified task is not supported in this Region.

", - "refs": { - } - }, - "UntagResourceRequest": { - "base": null, - "refs": { - } - }, - "UntagResourceResponse": { - "base": null, + "base": "

The specified task is not supported in this region.

", "refs": { } }, @@ -1801,7 +1504,7 @@ } }, "Volume": { - "base": "

A data volume used in a task definition. For tasks that use a Docker volume, specify a DockerVolumeConfiguration. For tasks that use a bind mount host volume, specify a host and optional sourcePath. For more information, see Using Data Volumes in Tasks.

", + "base": "

A data volume used in a task definition.

", "refs": { "VolumeList$member": null } @@ -1815,7 +1518,7 @@ "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.

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

" } }, "VolumeList": { diff --git a/agent/ecs_client/model/api/paginators-1.json b/agent/ecs_client/model/api/paginators-1.json index 46cea2a6f40..081a2df0025 100644 --- a/agent/ecs_client/model/api/paginators-1.json +++ b/agent/ecs_client/model/api/paginators-1.json @@ -1,40 +1,40 @@ { - "pagination": { - "ListClusters": { - "input_token": "nextToken", - "limit_key": "maxResults", - "output_token": "nextToken", - "result_key": "clusterArns" - }, - "ListContainerInstances": { - "input_token": "nextToken", - "limit_key": "maxResults", - "output_token": "nextToken", - "result_key": "containerInstanceArns" - }, - "ListServices": { - "input_token": "nextToken", - "limit_key": "maxResults", - "output_token": "nextToken", - "result_key": "serviceArns" - }, - "ListTaskDefinitionFamilies": { - "input_token": "nextToken", - "limit_key": "maxResults", - "output_token": "nextToken", - "result_key": "families" - }, - "ListTaskDefinitions": { - "input_token": "nextToken", - "limit_key": "maxResults", - "output_token": "nextToken", - "result_key": "taskDefinitionArns" - }, - "ListTasks": { - "input_token": "nextToken", - "limit_key": "maxResults", - "output_token": "nextToken", - "result_key": "taskArns" - } - } -} \ No newline at end of file + "pagination": { + "ListClusters": { + "input_token": "nextToken", + "output_token": "nextToken", + "limit_key": "maxResults", + "result_key": "clusterArns" + }, + "ListContainerInstances": { + "input_token": "nextToken", + "output_token": "nextToken", + "limit_key": "maxResults", + "result_key": "containerInstanceArns" + }, + "ListTaskDefinitions": { + "input_token": "nextToken", + "output_token": "nextToken", + "limit_key": "maxResults", + "result_key": "taskDefinitionArns" + }, + "ListTaskDefinitionFamilies": { + "input_token": "nextToken", + "output_token": "nextToken", + "limit_key": "maxResults", + "result_key": "families" + }, + "ListTasks": { + "input_token": "nextToken", + "output_token": "nextToken", + "limit_key": "maxResults", + "result_key": "taskArns" + }, + "ListServices": { + "input_token": "nextToken", + "output_token": "nextToken", + "limit_key": "maxResults", + "result_key": "serviceArns" + } + } +} diff --git a/agent/ecs_client/model/api/waiters-2.json b/agent/ecs_client/model/api/waiters-2.json index 8a0b19d8e37..8866d15fdd8 100644 --- a/agent/ecs_client/model/api/waiters-2.json +++ b/agent/ecs_client/model/api/waiters-2.json @@ -66,7 +66,7 @@ "expected": true, "matcher": "path", "state": "success", - "argument": "length(services[?!(length(deployments) == `1` && runningCount == desiredCount)]) == `0`" + "argument": "services | [@[?length(deployments)!=`1`], @[?desiredCount!=runningCount]][] | length(@) == `0`" } ] }, diff --git a/agent/ecs_client/model/ecs/api.go b/agent/ecs_client/model/ecs/api.go index a996c8dcd13..a88d6edcefe 100644 --- a/agent/ecs_client/model/ecs/api.go +++ b/agent/ecs_client/model/ecs/api.go @@ -170,51 +170,37 @@ func (c *ECS) CreateServiceRequest(input *CreateServiceInput) (req *request.Requ // For more information, see Service Load Balancing (http://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-load-balancing.html) // in the Amazon Elastic Container Service Developer Guide. // -// You can optionally specify a deployment configuration for your service. The -// deployment is triggered by changing properties, such as the task definition -// or the desired count of a service, with an UpdateService operation. -// -// If a service is using the ECS deployment controller, the minimum healthy -// percent represents a lower limit on the number of tasks in a service that -// must remain in the RUNNING state during a deployment, as a percentage of -// the desired number of tasks (rounded up to the nearest integer), and while -// any container instances are in the DRAINING state if the service contains -// tasks using the EC2 launch type. This parameter enables you to deploy without -// using additional cluster capacity. For example, if your service has a desired -// number of four tasks and a minimum healthy percent of 50%, the scheduler -// may stop two existing tasks to free up cluster capacity before starting two -// new tasks. Tasks for services that do not use a load balancer are considered -// healthy if they are in the RUNNING state; tasks for services that do use -// a load balancer are considered healthy if they are in the RUNNING state and -// they are reported as healthy by the load balancer. The default value for -// minimum healthy percent is 100%. -// -// If a service is using the ECS deployment controller, the maximum percent -// parameter represents an upper limit on the number of tasks in a service that -// are allowed in the RUNNING or PENDING state during a deployment, as a percentage -// of the desired number of tasks (rounded down to the nearest integer), and -// while any container instances are in the DRAINING state if the service contains -// tasks using the EC2 launch type. This parameter enables you to define the -// deployment batch size. For example, if your service has a desired number -// of four tasks and a maximum percent value of 200%, the scheduler may start -// four new tasks before stopping the four older tasks (provided that the cluster -// resources required to do this are available). The default value for maximum -// percent is 200%. -// -// If a service is using the CODE_DEPLOY deployment controller and tasks that -// use the EC2 launch type, the minimum healthy percent and maximum percent -// values are only used to define the lower and upper limit on the number of -// the tasks in the service that remain in the RUNNING state while the container -// instances are in the DRAINING state. If the tasks in the service use the -// Fargate launch type, the minimum healthy percent and maximum percent values -// are not used, although they are currently visible when describing your service. -// -// Tasks for services that do not use a load balancer are considered healthy -// if they are in the RUNNING state. Tasks for services that do use a load balancer -// are considered healthy if they are in the RUNNING state and the container -// instance they are hosted on is reported as healthy by the load balancer. -// The default value for a replica service for minimumHealthyPercent is 100%. -// The default value for a daemon service for minimumHealthyPercent is 0%. +// You can optionally specify a deployment configuration for your service. During +// a deployment, the service scheduler uses the minimumHealthyPercent and maximumPercent +// parameters to determine the deployment strategy. The deployment is triggered +// by changing the task definition or the desired count of a service with an +// UpdateService operation. +// +// The minimumHealthyPercent represents a lower limit on the number of your +// service's tasks that must remain in the RUNNING state during a deployment, +// as a percentage of the desiredCount (rounded up to the nearest integer). +// This parameter enables you to deploy without using additional cluster capacity. +// For example, if your service has a desiredCount of four tasks and a minimumHealthyPercent +// of 50%, the scheduler can stop two existing tasks to free up cluster capacity +// before starting two new tasks. Tasks for services that do not use a load +// balancer are considered healthy if they are in the RUNNING state. Tasks for +// services that do use a load balancer are considered healthy if they are in +// the RUNNING state and the container instance they are hosted on is reported +// as healthy by the load balancer. The default value for a replica service +// for minimumHealthyPercent is 50% in the console and 100% for the AWS CLI, +// the AWS SDKs, and the APIs. The default value for a daemon service for minimumHealthyPercent +// is 0% for the AWS CLI, the AWS SDKs, and the APIs and 50% for the console. +// +// The maximumPercent parameter represents an upper limit on the number of your +// service's tasks that are allowed in the RUNNING or PENDING state during a +// deployment, as a percentage of the desiredCount (rounded down to the nearest +// integer). This parameter enables you to define the deployment batch size. +// For example, if your replica service has a desiredCount of four tasks and +// a maximumPercent value of 200%, the scheduler can start four new tasks before +// stopping the four older tasks (provided that the cluster resources required +// to do this are available). The default value for a replica service for maximumPercent +// is 200%. If you are using a daemon service type, the maximumPercent should +// remain at 100%, which is the default value. // // When the service scheduler launches new tasks, it determines task placement // in your cluster using the following logic: @@ -259,10 +245,10 @@ func (c *ECS) CreateServiceRequest(input *CreateServiceInput) (req *request.Requ // // * ErrCodeClusterNotFoundException "ClusterNotFoundException" // The specified cluster could not be found. You can view your available clusters -// with ListClusters. Amazon ECS clusters are Region-specific. +// with ListClusters. Amazon ECS clusters are region-specific. // // * ErrCodeUnsupportedFeatureException "UnsupportedFeatureException" -// The specified task is not supported in this Region. +// The specified task is not supported in this region. // // * ErrCodePlatformUnknownException "PlatformUnknownException" // The specified platform version does not exist. @@ -337,11 +323,6 @@ func (c *ECS) DeleteAccountSettingRequest(input *DeleteAccountSettingInput) (req // DeleteAccountSetting API operation for Amazon EC2 Container Service. // -// Modifies the ARN and resource ID format of a resource for a specified IAM -// user, IAM role, or the root user for an account. You can specify whether -// the new ARN and resource ID format are disabled for new resources that are -// created. -// // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about // the error. @@ -437,12 +418,12 @@ func (c *ECS) DeleteAttributesRequest(input *DeleteAttributesInput) (req *reques // Returned Error Codes: // * ErrCodeClusterNotFoundException "ClusterNotFoundException" // The specified cluster could not be found. You can view your available clusters -// with ListClusters. Amazon ECS clusters are Region-specific. +// with ListClusters. Amazon ECS clusters are region-specific. // // * ErrCodeTargetNotFoundException "TargetNotFoundException" // The specified target could not be found. You can view your available container // instances with ListContainerInstances. Amazon ECS container instances are -// cluster-specific and Region-specific. +// cluster-specific and region-specific. // // * ErrCodeInvalidParameterException "InvalidParameterException" // The specified parameter is invalid. Review the available parameters for the @@ -537,17 +518,17 @@ func (c *ECS) DeleteClusterRequest(input *DeleteClusterInput) (req *request.Requ // // * ErrCodeClusterNotFoundException "ClusterNotFoundException" // The specified cluster could not be found. You can view your available clusters -// with ListClusters. Amazon ECS clusters are Region-specific. +// with ListClusters. Amazon ECS clusters are region-specific. // // * ErrCodeClusterContainsContainerInstancesException "ClusterContainsContainerInstancesException" -// You cannot delete a cluster that has registered container instances. First, -// deregister the container instances before you can delete the cluster. For -// more information, see DeregisterContainerInstance. +// 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. // // * ErrCodeClusterContainsServicesException "ClusterContainsServicesException" -// You cannot delete a cluster that contains services. First, update the service -// to reduce its desired task count to 0 and then delete the service. For more -// information, see UpdateService and DeleteService. +// 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. // // * ErrCodeClusterContainsTasksException "ClusterContainsTasksException" // You cannot delete a cluster that has active tasks. @@ -623,16 +604,12 @@ func (c *ECS) DeleteServiceRequest(input *DeleteServiceInput) (req *request.Requ // // 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 the ListServices API operation. -// 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 the DescribeServices API operation. However, in the future, INACTIVE -// services may be cleaned up and purged from Amazon ECS record keeping, and -// DescribeServices calls on those services return a ServiceNotFoundException -// error. -// -// If you attempt to create a new service with the same name as an existing -// service in either ACTIVE or DRAINING status, you receive an error. +// 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 return a ServiceNotFoundException error. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -656,11 +633,11 @@ func (c *ECS) DeleteServiceRequest(input *DeleteServiceInput) (req *request.Requ // // * ErrCodeClusterNotFoundException "ClusterNotFoundException" // The specified cluster could not be found. You can view your available clusters -// with ListClusters. Amazon ECS clusters are Region-specific. +// with ListClusters. Amazon ECS clusters are region-specific. // // * ErrCodeServiceNotFoundException "ServiceNotFoundException" // The specified service could not be found. You can view your available services -// with ListServices. Amazon ECS services are cluster-specific and Region-specific. +// with ListServices. Amazon ECS services are cluster-specific and region-specific. // func (c *ECS) DeleteService(input *DeleteServiceInput) (*DeleteServiceOutput, error) { req, out := c.DeleteServiceRequest(input) @@ -734,7 +711,7 @@ func (c *ECS) DeregisterContainerInstanceRequest(input *DeregisterContainerInsta // 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, +// it does not terminate the EC2 instance; if you are finished using the instance, // be sure to terminate it in the Amazon EC2 console to stop billing. // // If you terminate a running container instance, Amazon ECS automatically deregisters @@ -763,7 +740,7 @@ func (c *ECS) DeregisterContainerInstanceRequest(input *DeregisterContainerInsta // // * ErrCodeClusterNotFoundException "ClusterNotFoundException" // The specified cluster could not be found. You can view your available clusters -// with ListClusters. Amazon ECS clusters are Region-specific. +// with ListClusters. Amazon ECS clusters are region-specific. // func (c *ECS) DeregisterContainerInstance(input *DeregisterContainerInstanceInput) (*DeregisterContainerInstanceOutput, error) { req, out := c.DeregisterContainerInstanceRequest(input) @@ -836,11 +813,11 @@ func (c *ECS) DeregisterTaskDefinitionRequest(input *DeregisterTaskDefinitionInp // // 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. However, there may be up to a 10-minute window following -// deregistration where these restrictions have not yet taken effect. +// task definition (although there may be up to a 10-minute window following +// deregistration where these restrictions have not yet taken effect). // // At this time, INACTIVE task definitions remain discoverable in your account -// indefinitely. However, this behavior is subject to change in the future, +// indefinitely; however, this behavior is subject to change in the future, // so you should not rely on INACTIVE task definitions persisting beyond the // lifecycle of any associated tasks and services. // @@ -1037,7 +1014,7 @@ func (c *ECS) DescribeContainerInstancesRequest(input *DescribeContainerInstance // // * ErrCodeClusterNotFoundException "ClusterNotFoundException" // The specified cluster could not be found. You can view your available clusters -// with ListClusters. Amazon ECS clusters are Region-specific. +// with ListClusters. Amazon ECS clusters are region-specific. // func (c *ECS) DescribeContainerInstances(input *DescribeContainerInstancesInput) (*DescribeContainerInstancesOutput, error) { req, out := c.DescribeContainerInstancesRequest(input) @@ -1126,7 +1103,7 @@ func (c *ECS) DescribeServicesRequest(input *DescribeServicesInput) (req *reques // // * ErrCodeClusterNotFoundException "ClusterNotFoundException" // The specified cluster could not be found. You can view your available clusters -// with ListClusters. Amazon ECS clusters are Region-specific. +// with ListClusters. Amazon ECS clusters are region-specific. // func (c *ECS) DescribeServices(input *DescribeServicesInput) (*DescribeServicesOutput, error) { req, out := c.DescribeServicesRequest(input) @@ -1305,7 +1282,7 @@ func (c *ECS) DescribeTasksRequest(input *DescribeTasksInput) (req *request.Requ // // * ErrCodeClusterNotFoundException "ClusterNotFoundException" // The specified cluster could not be found. You can view your available clusters -// with ListClusters. Amazon ECS clusters are Region-specific. +// with ListClusters. Amazon ECS clusters are region-specific. // func (c *ECS) DescribeTasks(input *DescribeTasksInput) (*DescribeTasksOutput, error) { req, out := c.DescribeTasksRequest(input) @@ -1412,91 +1389,6 @@ func (c *ECS) DiscoverPollEndpointWithContext(ctx aws.Context, input *DiscoverPo return out, req.Send() } -const opListAccountSettings = "ListAccountSettings" - -// ListAccountSettingsRequest generates a "aws/request.Request" representing the -// client's request for the ListAccountSettings operation. The "output" return -// value will be populated with the request's response once the request completes -// successfully. -// -// Use "Send" method on the returned Request to send the API call to the service. -// the "output" return value is not valid until after Send returns without error. -// -// See ListAccountSettings for more information on using the ListAccountSettings -// API call, and error handling. -// -// This method is useful when you want to inject custom logic or configuration -// into the SDK's request lifecycle. Such as custom headers, or retry logic. -// -// -// // Example sending a request using the ListAccountSettingsRequest method. -// req, resp := client.ListAccountSettingsRequest(params) -// -// err := req.Send() -// if err == nil { // resp is now filled -// fmt.Println(resp) -// } -func (c *ECS) ListAccountSettingsRequest(input *ListAccountSettingsInput) (req *request.Request, output *ListAccountSettingsOutput) { - op := &request.Operation{ - Name: opListAccountSettings, - HTTPMethod: "POST", - HTTPPath: "/", - } - - if input == nil { - input = &ListAccountSettingsInput{} - } - - output = &ListAccountSettingsOutput{} - req = c.newRequest(op, input, output) - return -} - -// ListAccountSettings API operation for Amazon EC2 Container Service. -// -// Lists the account settings for an Amazon ECS resource for a specified principal. -// -// Returns awserr.Error for service API and SDK errors. Use runtime type assertions -// with awserr.Error's Code and Message methods to get detailed information about -// the error. -// -// See the AWS API reference guide for Amazon EC2 Container Service's -// API operation ListAccountSettings for usage and error information. -// -// Returned Error Codes: -// * ErrCodeServerException "ServerException" -// These errors are usually caused by a server issue. -// -// * ErrCodeClientException "ClientException" -// These errors are usually caused by a client action, such as using an action -// or resource on behalf of a user that doesn't have permissions to use the -// action or resource, or specifying an identifier that is not valid. -// -// * ErrCodeInvalidParameterException "InvalidParameterException" -// The specified parameter is invalid. Review the available parameters for the -// API request. -// -func (c *ECS) ListAccountSettings(input *ListAccountSettingsInput) (*ListAccountSettingsOutput, error) { - req, out := c.ListAccountSettingsRequest(input) - return out, req.Send() -} - -// ListAccountSettingsWithContext is the same as ListAccountSettings with the addition of -// the ability to pass a context and additional request options. -// -// See ListAccountSettings for details on how to use this API operation. -// -// The context must be non-nil and will be used for request cancellation. If -// the context is nil a panic will occur. In the future the SDK may create -// sub-contexts for http.Requests. See https://golang.org/pkg/context/ -// for more information on using Contexts. -func (c *ECS) ListAccountSettingsWithContext(ctx aws.Context, input *ListAccountSettingsInput, opts ...request.Option) (*ListAccountSettingsOutput, error) { - req, out := c.ListAccountSettingsRequest(input) - req.SetContext(ctx) - req.ApplyOptions(opts...) - return out, req.Send() -} - const opListAttributes = "ListAttributes" // ListAttributesRequest generates a "aws/request.Request" representing the @@ -1557,7 +1449,7 @@ func (c *ECS) ListAttributesRequest(input *ListAttributesInput) (req *request.Re // Returned Error Codes: // * ErrCodeClusterNotFoundException "ClusterNotFoundException" // The specified cluster could not be found. You can view your available clusters -// with ListClusters. Amazon ECS clusters are Region-specific. +// with ListClusters. Amazon ECS clusters are region-specific. // // * ErrCodeInvalidParameterException "InvalidParameterException" // The specified parameter is invalid. Review the available parameters for the @@ -1801,7 +1693,7 @@ func (c *ECS) ListContainerInstancesRequest(input *ListContainerInstancesInput) // // * ErrCodeClusterNotFoundException "ClusterNotFoundException" // The specified cluster could not be found. You can view your available clusters -// with ListClusters. Amazon ECS clusters are Region-specific. +// with ListClusters. Amazon ECS clusters are region-specific. // func (c *ECS) ListContainerInstances(input *ListContainerInstancesInput) (*ListContainerInstancesOutput, error) { req, out := c.ListContainerInstancesRequest(input) @@ -1946,7 +1838,7 @@ func (c *ECS) ListServicesRequest(input *ListServicesInput) (req *request.Reques // // * ErrCodeClusterNotFoundException "ClusterNotFoundException" // The specified cluster could not be found. You can view your available clusters -// with ListClusters. Amazon ECS clusters are Region-specific. +// with ListClusters. Amazon ECS clusters are region-specific. // func (c *ECS) ListServices(input *ListServicesInput) (*ListServicesOutput, error) { req, out := c.ListServicesRequest(input) @@ -2061,8 +1953,6 @@ func (c *ECS) ListTagsForResourceRequest(input *ListTagsForResourceInput) (req * // ListTagsForResource API operation for Amazon EC2 Container Service. // -// List the tags for an Amazon ECS resource. -// // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about // the error. @@ -2081,7 +1971,7 @@ func (c *ECS) ListTagsForResourceRequest(input *ListTagsForResourceInput) (req * // // * ErrCodeClusterNotFoundException "ClusterNotFoundException" // The specified cluster could not be found. You can view your available clusters -// with ListClusters. Amazon ECS clusters are Region-specific. +// with ListClusters. Amazon ECS clusters are region-specific. // // * ErrCodeInvalidParameterException "InvalidParameterException" // The specified parameter is invalid. Review the available parameters for the @@ -2475,11 +2365,11 @@ func (c *ECS) ListTasksRequest(input *ListTasksInput) (req *request.Request, out // // * ErrCodeClusterNotFoundException "ClusterNotFoundException" // The specified cluster could not be found. You can view your available clusters -// with ListClusters. Amazon ECS clusters are Region-specific. +// with ListClusters. Amazon ECS clusters are region-specific. // // * ErrCodeServiceNotFoundException "ServiceNotFoundException" // The specified service could not be found. You can view your available services -// with ListServices. Amazon ECS services are cluster-specific and Region-specific. +// with ListServices. Amazon ECS services are cluster-specific and region-specific. // func (c *ECS) ListTasks(input *ListTasksInput) (*ListTasksOutput, error) { req, out := c.ListTasksRequest(input) @@ -2594,12 +2484,6 @@ func (c *ECS) PutAccountSettingRequest(input *PutAccountSettingInput) (req *requ // PutAccountSetting API operation for Amazon EC2 Container Service. // -// Modifies the ARN and resource ID format of a resource for a specified IAM -// user, IAM role, or the root user for an account. You can specify whether -// the new ARN and resource ID format are enabled for new resources that are -// created. Enabling this setting is required to use new Amazon ECS features -// such as resource tagging. -// // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about // the error. @@ -2699,12 +2583,12 @@ func (c *ECS) PutAttributesRequest(input *PutAttributesInput) (req *request.Requ // Returned Error Codes: // * ErrCodeClusterNotFoundException "ClusterNotFoundException" // The specified cluster could not be found. You can view your available clusters -// with ListClusters. Amazon ECS clusters are Region-specific. +// with ListClusters. Amazon ECS clusters are region-specific. // // * ErrCodeTargetNotFoundException "TargetNotFoundException" // The specified target could not be found. You can view your available container // instances with ListContainerInstances. Amazon ECS container instances are -// cluster-specific and Region-specific. +// cluster-specific and region-specific. // // * ErrCodeAttributeLimitExceededException "AttributeLimitExceededException" // You can apply up to 10 custom attributes per resource. You can view the attributes @@ -2985,8 +2869,9 @@ func (c *ECS) RunTaskRequest(input *RunTaskInput) (req *request.Request, output // The Amazon ECS API follows an eventual consistency model, due to the distributed // nature of the system supporting the API. This means that the result of an // API command you run that affects your Amazon ECS resources might not be immediately -// visible to all subsequent commands you run. Keep this in mind when you carry -// out an API command that immediately follows a previous API command. +// visible to all subsequent commands you run. You should keep this in mind +// when you carry out an API command that immediately follows a previous API +// command. // // To manage eventual consistency, you can do the following: // @@ -3024,10 +2909,10 @@ func (c *ECS) RunTaskRequest(input *RunTaskInput) (req *request.Request, output // // * ErrCodeClusterNotFoundException "ClusterNotFoundException" // The specified cluster could not be found. You can view your available clusters -// with ListClusters. Amazon ECS clusters are Region-specific. +// with ListClusters. Amazon ECS clusters are region-specific. // // * ErrCodeUnsupportedFeatureException "UnsupportedFeatureException" -// The specified task is not supported in this Region. +// The specified task is not supported in this region. // // * ErrCodePlatformUnknownException "PlatformUnknownException" // The specified platform version does not exist. @@ -3040,8 +2925,8 @@ func (c *ECS) RunTaskRequest(input *RunTaskInput) (req *request.Request, output // You do not have authorization to perform the requested action. // // * ErrCodeBlockedException "BlockedException" -// Your AWS account has been blocked. For more information, contact AWS Support -// (http://aws.amazon.com/contact-us/). +// Your AWS account has been blocked. Contact AWS Support (http://aws.amazon.com/contact-us/) +// for more information. // func (c *ECS) RunTask(input *RunTaskInput) (*RunTaskOutput, error) { req, out := c.RunTaskRequest(input) @@ -3135,7 +3020,7 @@ func (c *ECS) StartTaskRequest(input *StartTaskInput) (req *request.Request, out // // * ErrCodeClusterNotFoundException "ClusterNotFoundException" // The specified cluster could not be found. You can view your available clusters -// with ListClusters. Amazon ECS clusters are Region-specific. +// with ListClusters. Amazon ECS clusters are region-specific. // func (c *ECS) StartTask(input *StartTaskInput) (*StartTaskOutput, error) { req, out := c.StartTaskRequest(input) @@ -3200,14 +3085,13 @@ func (c *ECS) StopTaskRequest(input *StopTaskInput) (req *request.Request, outpu // StopTask API operation for Amazon EC2 Container Service. // -// Stops a running task. Any tags associated with the task will be deleted. +// 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 value and -// a default 30-second timeout, after which the SIGKILL value is sent and the -// containers are forcibly stopped. If the container handles the SIGTERM value -// gracefully and exits within 30 seconds from receiving it, no SIGKILL value -// is sent. +// to the containers running in the task. This results in a SIGTERM and a default +// 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. // // The default 30-second timeout can be configured on the Amazon ECS container // agent with the ECS_CONTAINER_STOP_TIMEOUT variable. For more information, @@ -3236,7 +3120,7 @@ func (c *ECS) StopTaskRequest(input *StopTaskInput) (req *request.Request, outpu // // * ErrCodeClusterNotFoundException "ClusterNotFoundException" // The specified cluster could not be found. You can view your available clusters -// with ListClusters. Amazon ECS clusters are Region-specific. +// with ListClusters. Amazon ECS clusters are region-specific. // func (c *ECS) StopTask(input *StopTaskInput) (*StopTaskOutput, error) { req, out := c.StopTaskRequest(input) @@ -3433,193 +3317,6 @@ func (c *ECS) SubmitTaskStateChangeWithContext(ctx aws.Context, input *SubmitTas return out, req.Send() } -const opTagResource = "TagResource" - -// TagResourceRequest generates a "aws/request.Request" representing the -// client's request for the TagResource operation. The "output" return -// value will be populated with the request's response once the request completes -// successfully. -// -// Use "Send" method on the returned Request to send the API call to the service. -// the "output" return value is not valid until after Send returns without error. -// -// See TagResource for more information on using the TagResource -// API call, and error handling. -// -// This method is useful when you want to inject custom logic or configuration -// into the SDK's request lifecycle. Such as custom headers, or retry logic. -// -// -// // Example sending a request using the TagResourceRequest method. -// req, resp := client.TagResourceRequest(params) -// -// err := req.Send() -// if err == nil { // resp is now filled -// fmt.Println(resp) -// } -func (c *ECS) TagResourceRequest(input *TagResourceInput) (req *request.Request, output *TagResourceOutput) { - op := &request.Operation{ - Name: opTagResource, - HTTPMethod: "POST", - HTTPPath: "/", - } - - if input == nil { - input = &TagResourceInput{} - } - - output = &TagResourceOutput{} - req = c.newRequest(op, input, output) - return -} - -// TagResource API operation for Amazon EC2 Container Service. -// -// Associates the specified tags to a resource with the specified resourceArn. -// If existing tags on a resource are not specified in the request parameters, -// they are not changed. When a resource is deleted, the tags associated with -// that resource are deleted as well. -// -// Returns awserr.Error for service API and SDK errors. Use runtime type assertions -// with awserr.Error's Code and Message methods to get detailed information about -// the error. -// -// See the AWS API reference guide for Amazon EC2 Container Service's -// API operation TagResource for usage and error information. -// -// Returned Error Codes: -// * ErrCodeServerException "ServerException" -// These errors are usually caused by a server issue. -// -// * ErrCodeClientException "ClientException" -// These errors are usually caused by a client action, such as using an action -// or resource on behalf of a user that doesn't have permissions to use the -// action or resource, or specifying an identifier that is not valid. -// -// * ErrCodeClusterNotFoundException "ClusterNotFoundException" -// The specified cluster could not be found. You can view your available clusters -// with ListClusters. Amazon ECS clusters are Region-specific. -// -// * ErrCodeResourceNotFoundException "ResourceNotFoundException" -// The specified resource could not be found. -// -// * ErrCodeInvalidParameterException "InvalidParameterException" -// The specified parameter is invalid. Review the available parameters for the -// API request. -// -func (c *ECS) TagResource(input *TagResourceInput) (*TagResourceOutput, error) { - req, out := c.TagResourceRequest(input) - return out, req.Send() -} - -// TagResourceWithContext is the same as TagResource with the addition of -// the ability to pass a context and additional request options. -// -// See TagResource for details on how to use this API operation. -// -// The context must be non-nil and will be used for request cancellation. If -// the context is nil a panic will occur. In the future the SDK may create -// sub-contexts for http.Requests. See https://golang.org/pkg/context/ -// for more information on using Contexts. -func (c *ECS) TagResourceWithContext(ctx aws.Context, input *TagResourceInput, opts ...request.Option) (*TagResourceOutput, error) { - req, out := c.TagResourceRequest(input) - req.SetContext(ctx) - req.ApplyOptions(opts...) - return out, req.Send() -} - -const opUntagResource = "UntagResource" - -// UntagResourceRequest generates a "aws/request.Request" representing the -// client's request for the UntagResource operation. The "output" return -// value will be populated with the request's response once the request completes -// successfully. -// -// Use "Send" method on the returned Request to send the API call to the service. -// the "output" return value is not valid until after Send returns without error. -// -// See UntagResource for more information on using the UntagResource -// API call, and error handling. -// -// This method is useful when you want to inject custom logic or configuration -// into the SDK's request lifecycle. Such as custom headers, or retry logic. -// -// -// // Example sending a request using the UntagResourceRequest method. -// req, resp := client.UntagResourceRequest(params) -// -// err := req.Send() -// if err == nil { // resp is now filled -// fmt.Println(resp) -// } -func (c *ECS) UntagResourceRequest(input *UntagResourceInput) (req *request.Request, output *UntagResourceOutput) { - op := &request.Operation{ - Name: opUntagResource, - HTTPMethod: "POST", - HTTPPath: "/", - } - - if input == nil { - input = &UntagResourceInput{} - } - - output = &UntagResourceOutput{} - req = c.newRequest(op, input, output) - return -} - -// UntagResource API operation for Amazon EC2 Container Service. -// -// Deletes specified tags from a resource. -// -// Returns awserr.Error for service API and SDK errors. Use runtime type assertions -// with awserr.Error's Code and Message methods to get detailed information about -// the error. -// -// See the AWS API reference guide for Amazon EC2 Container Service's -// API operation UntagResource for usage and error information. -// -// Returned Error Codes: -// * ErrCodeServerException "ServerException" -// These errors are usually caused by a server issue. -// -// * ErrCodeClientException "ClientException" -// These errors are usually caused by a client action, such as using an action -// or resource on behalf of a user that doesn't have permissions to use the -// action or resource, or specifying an identifier that is not valid. -// -// * ErrCodeClusterNotFoundException "ClusterNotFoundException" -// The specified cluster could not be found. You can view your available clusters -// with ListClusters. Amazon ECS clusters are Region-specific. -// -// * ErrCodeResourceNotFoundException "ResourceNotFoundException" -// The specified resource could not be found. -// -// * ErrCodeInvalidParameterException "InvalidParameterException" -// The specified parameter is invalid. Review the available parameters for the -// API request. -// -func (c *ECS) UntagResource(input *UntagResourceInput) (*UntagResourceOutput, error) { - req, out := c.UntagResourceRequest(input) - return out, req.Send() -} - -// UntagResourceWithContext is the same as UntagResource with the addition of -// the ability to pass a context and additional request options. -// -// See UntagResource for details on how to use this API operation. -// -// The context must be non-nil and will be used for request cancellation. If -// the context is nil a panic will occur. In the future the SDK may create -// sub-contexts for http.Requests. See https://golang.org/pkg/context/ -// for more information on using Contexts. -func (c *ECS) UntagResourceWithContext(ctx aws.Context, input *UntagResourceInput, opts ...request.Option) (*UntagResourceOutput, error) { - req, out := c.UntagResourceRequest(input) - req.SetContext(ctx) - req.ApplyOptions(opts...) - return out, req.Send() -} - const opUpdateContainerAgent = "UpdateContainerAgent" // UpdateContainerAgentRequest generates a "aws/request.Request" representing the @@ -3696,7 +3393,7 @@ func (c *ECS) UpdateContainerAgentRequest(input *UpdateContainerAgentInput) (req // // * ErrCodeClusterNotFoundException "ClusterNotFoundException" // The specified cluster could not be found. You can view your available clusters -// with ListClusters. Amazon ECS clusters are Region-specific. +// with ListClusters. Amazon ECS clusters are region-specific. // // * ErrCodeUpdateInProgressException "UpdateInProgressException" // There is already a current Amazon ECS container agent update in progress @@ -3809,14 +3506,14 @@ func (c *ECS) UpdateContainerInstancesStateRequest(input *UpdateContainerInstanc // // * The maximumPercent parameter represents an upper limit on the number // of running tasks during task replacement, which enables you to define -// the replacement batch size. For example, if desiredCount is four tasks, +// the replacement batch size. For example, if desiredCount of four tasks, // a maximum of 200% starts four new tasks before stopping the four tasks -// to be drained, provided that the cluster resources required to do this -// are available. If the maximum is 100%, then replacement tasks can't start +// to be drained (provided that the cluster resources required to do this +// are available). If the maximum is 100%, then replacement tasks can't start // until the draining tasks have stopped. // -// Any PENDING or RUNNING tasks that do not belong to a service are not affected. -// You must wait for them to finish or stop them manually. +// Any PENDING or RUNNING tasks that do not belong to a service are not affected; +// you must wait for them to finish or stop them manually. // // A container instance has completed draining when it has no more RUNNING tasks. // You can verify this using ListTasks. @@ -3846,7 +3543,7 @@ func (c *ECS) UpdateContainerInstancesStateRequest(input *UpdateContainerInstanc // // * ErrCodeClusterNotFoundException "ClusterNotFoundException" // The specified cluster could not be found. You can view your available clusters -// with ListClusters. Amazon ECS clusters are Region-specific. +// with ListClusters. Amazon ECS clusters are region-specific. // func (c *ECS) UpdateContainerInstancesState(input *UpdateContainerInstancesStateInput) (*UpdateContainerInstancesStateOutput, error) { req, out := c.UpdateContainerInstancesStateRequest(input) @@ -3911,18 +3608,8 @@ func (c *ECS) UpdateServiceRequest(input *UpdateServiceInput) (req *request.Requ // UpdateService API operation for Amazon EC2 Container Service. // -// Modifies the parameters of a service. -// -// For services using the rolling update (ECS) deployment controller, the desired -// count, deployment configuration, network configuration, or task definition -// used can be updated. -// -// For services using the blue/green (CODE_DEPLOY) deployment controller, only -// the desired count, deployment configuration, and health check grace period -// can be updated using this API. If the network configuration, platform version, -// or task definition need to be updated, a new AWS CodeDeploy deployment should -// be created. For more information, see CreateDeployment (https://docs.aws.amazon.com/codedeploy/latest/APIReference/API_CreateDeployment.html) -// in the AWS CodeDeploy API Reference. +// Modifies the desired count, deployment configuration, network configuration, +// or task definition used in a service. // // You can add to or subtract from the number of instantiations of a task definition // in a service by specifying the cluster that the service is running in and @@ -4020,11 +3707,11 @@ func (c *ECS) UpdateServiceRequest(input *UpdateServiceInput) (req *request.Requ // // * ErrCodeClusterNotFoundException "ClusterNotFoundException" // The specified cluster could not be found. You can view your available clusters -// with ListClusters. Amazon ECS clusters are Region-specific. +// with ListClusters. Amazon ECS clusters are region-specific. // // * ErrCodeServiceNotFoundException "ServiceNotFoundException" // The specified service could not be found. You can view your available services -// with ListServices. Amazon ECS services are cluster-specific and Region-specific. +// with ListServices. Amazon ECS services are cluster-specific and region-specific. // // * ErrCodeServiceNotActiveException "ServiceNotActiveException" // The specified service is not active. You can't update a service that is inactive. @@ -4248,17 +3935,16 @@ type AwsVpcConfiguration struct { _ struct{} `type:"structure"` // Whether the task's elastic network interface receives a public IP address. - // The default value is DISABLED. AssignPublicIp *string `locationName:"assignPublicIp" type:"string" enum:"AssignPublicIp"` // The security groups associated with the task or service. If you do not specify // a security group, the default security group for the VPC is used. There is - // a limit of five security groups able to be specified per AwsVpcConfiguration. + // a limit of 5 security groups able to be specified per AwsVpcConfiguration. // // All specified security groups must be from the same VPC. SecurityGroups []*string `locationName:"securityGroups" type:"list"` - // The subnets associated with the task or service. There is a limit of 16 subnets + // The subnets associated with the task or service. There is a limit of 10 subnets // able to be specified per AwsVpcConfiguration. // // All specified subnets must be from the same VPC. @@ -4331,43 +4017,16 @@ type Cluster struct { // The number of tasks in the cluster that are in the PENDING state. PendingTasksCount *int64 `locationName:"pendingTasksCount" type:"integer"` - // The number of container instances registered into the cluster. This includes - // container instances in both ACTIVE and DRAINING status. + // The number of container instances registered into the cluster. RegisteredContainerInstancesCount *int64 `locationName:"registeredContainerInstancesCount" type:"integer"` // The number of tasks in the cluster that are in the RUNNING state. RunningTasksCount *int64 `locationName:"runningTasksCount" type:"integer"` - // Additional information about your clusters that are separated by launch type, - // including: - // - // * runningEC2TasksCount - // - // * RunningFargateTasksCount - // - // * pendingEC2TasksCount - // - // * pendingFargateTasksCount - // - // * activeEC2ServiceCount - // - // * activeFargateServiceCount - // - // * drainingEC2ServiceCount - // - // * drainingFargateServiceCount - Statistics []*KeyValuePair `locationName:"statistics" type:"list"` - // 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. Status *string `locationName:"status" type:"string"` - - // The metadata that you apply to the cluster to help you categorize and organize - // them. Each tag consists of a key and an optional value, both of which you - // define. Tag keys can have a maximum character length of 128 characters, and - // tag values can have a maximum length of 256 characters. - Tags []*Tag `locationName:"tags" type:"list"` } // String returns the string representation @@ -4416,24 +4075,12 @@ func (s *Cluster) SetRunningTasksCount(v int64) *Cluster { return s } -// SetStatistics sets the Statistics field's value. -func (s *Cluster) SetStatistics(v []*KeyValuePair) *Cluster { - s.Statistics = v - return s -} - // SetStatus sets the Status field's value. func (s *Cluster) SetStatus(v string) *Cluster { s.Status = &v return s } -// SetTags sets the Tags field's value. -func (s *Cluster) SetTags(v []*Tag) *Cluster { - s.Tags = v - return s -} - // A Docker container that is part of a task. type Container struct { _ struct{} `type:"structure"` @@ -4445,8 +4092,7 @@ type Container struct { ExitCode *int64 `locationName:"exitCode" type:"integer"` // The health status of the container. If health checks are not configured for - // this container in its task definition, then it reports the health status - // as UNKNOWN. + // this container in its task definition, then it reports health status as UNKNOWN. HealthStatus *string `locationName:"healthStatus" type:"string" enum:"HealthStatus"` // The last known status of the container. @@ -4539,16 +4185,16 @@ type ContainerDefinition struct { _ struct{} `type:"structure"` // The command that is passed to the container. This parameter maps to Cmd in - // the Create a container (https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) - // section of the Docker Remote API (https://docs.docker.com/engine/api/v1.35/) + // the Create a container (https://docs.docker.com/engine/reference/api/docker_remote_api_v1.27/#create-a-container) + // section of the Docker Remote API (https://docs.docker.com/engine/reference/api/docker_remote_api_v1.27/) // and the COMMAND parameter to docker run (https://docs.docker.com/engine/reference/run/). // For more information, see https://docs.docker.com/engine/reference/builder/#cmd // (https://docs.docker.com/engine/reference/builder/#cmd). Command []*string `locationName:"command" type:"list"` // The number of cpu units reserved for the container. This parameter maps to - // CpuShares in the Create a container (https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) - // section of the Docker Remote API (https://docs.docker.com/engine/api/v1.35/) + // CpuShares in the Create a container (https://docs.docker.com/engine/reference/api/docker_remote_api_v1.27/#create-a-container) + // section of the Docker Remote API (https://docs.docker.com/engine/reference/api/docker_remote_api_v1.27/) // and the --cpu-shares option to docker run (https://docs.docker.com/engine/reference/run/). // // This field is optional for tasks using the Fargate launch type, and the only @@ -4584,7 +4230,7 @@ type ContainerDefinition struct { // uses the CPU value to calculate the relative CPU share ratios for running // containers. For more information, see CPU share constraint (https://docs.docker.com/engine/reference/run/#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 + // 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: @@ -4592,7 +4238,7 @@ type ContainerDefinition struct { // * Agent versions less than or equal to 1.1.0: Null and zero CPU values // are passed to Docker as 0, which Docker then converts to 1,024 CPU shares. // CPU values of 1 are passed to Docker as 1, which the Linux kernel converts - // to two CPU shares. + // to 2 CPU shares. // // * Agent versions greater than or equal to 1.2.0: Null, zero, and CPU values // of 1 are passed to Docker as 2. @@ -4603,44 +4249,44 @@ type ContainerDefinition struct { Cpu *int64 `locationName:"cpu" type:"integer"` // When this parameter is true, networking is disabled within the container. - // This parameter maps to NetworkDisabled in the Create a container (https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) - // section of the Docker Remote API (https://docs.docker.com/engine/api/v1.35/). + // This parameter maps to NetworkDisabled in the Create a container (https://docs.docker.com/engine/reference/api/docker_remote_api_v1.27/#create-a-container) + // section of the Docker Remote API (https://docs.docker.com/engine/reference/api/docker_remote_api_v1.27/). // // This parameter is not supported for Windows containers. DisableNetworking *bool `locationName:"disableNetworking" type:"boolean"` // A list of DNS search domains that are presented to the container. This parameter - // maps to DnsSearch in the Create a container (https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) - // section of the Docker Remote API (https://docs.docker.com/engine/api/v1.35/) + // maps to DnsSearch in the Create a container (https://docs.docker.com/engine/reference/api/docker_remote_api_v1.27/#create-a-container) + // section of the Docker Remote API (https://docs.docker.com/engine/reference/api/docker_remote_api_v1.27/) // and the --dns-search option to docker run (https://docs.docker.com/engine/reference/run/). // // This parameter is not supported for Windows containers. DnsSearchDomains []*string `locationName:"dnsSearchDomains" type:"list"` // A list of DNS servers that are presented to the container. This parameter - // maps to Dns in the Create a container (https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) - // section of the Docker Remote API (https://docs.docker.com/engine/api/v1.35/) + // maps to Dns in the Create a container (https://docs.docker.com/engine/reference/api/docker_remote_api_v1.27/#create-a-container) + // section of the Docker Remote API (https://docs.docker.com/engine/reference/api/docker_remote_api_v1.27/) // and the --dns option to docker run (https://docs.docker.com/engine/reference/run/). // // This parameter is not supported for Windows containers. DnsServers []*string `locationName:"dnsServers" type:"list"` // A key/value map of labels to add to the container. This parameter maps to - // Labels in the Create a container (https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) - // section of the Docker Remote API (https://docs.docker.com/engine/api/v1.35/) + // Labels in the Create a container (https://docs.docker.com/engine/reference/api/docker_remote_api_v1.27/#create-a-container) + // section of the Docker Remote API (https://docs.docker.com/engine/reference/api/docker_remote_api_v1.27/) // and the --label option to docker run (https://docs.docker.com/engine/reference/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 in to your container instance and run the following - // command: sudo docker version --format '{{.Server.APIVersion}}' + // command: sudo docker version | grep "Server API version" DockerLabels map[string]*string `locationName:"dockerLabels" type:"map"` // A list of strings to provide custom labels for SELinux and AppArmor multi-level // security systems. This field is not valid for containers in tasks using the // Fargate launch type. // - // This parameter maps to SecurityOpt in the Create a container (https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) - // section of the Docker Remote API (https://docs.docker.com/engine/api/v1.35/) + // This parameter maps to SecurityOpt in the Create a container (https://docs.docker.com/engine/reference/api/docker_remote_api_v1.27/#create-a-container) + // section of the Docker Remote API (https://docs.docker.com/engine/reference/api/docker_remote_api_v1.27/) // and the --security-opt option to docker run (https://docs.docker.com/engine/reference/run/). // // The Amazon ECS container agent running on a container instance must register @@ -4658,16 +4304,16 @@ type ContainerDefinition struct { // 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 (https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) - // section of the Docker Remote API (https://docs.docker.com/engine/api/v1.35/) + // in the Create a container (https://docs.docker.com/engine/reference/api/docker_remote_api_v1.27/#create-a-container) + // section of the Docker Remote API (https://docs.docker.com/engine/reference/api/docker_remote_api_v1.27/) // and the --entrypoint option to docker run (https://docs.docker.com/engine/reference/run/). // For more information, see https://docs.docker.com/engine/reference/builder/#entrypoint // (https://docs.docker.com/engine/reference/builder/#entrypoint). EntryPoint []*string `locationName:"entryPoint" type:"list"` // The environment variables to pass to a container. This parameter maps to - // Env in the Create a container (https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) - // section of the Docker Remote API (https://docs.docker.com/engine/api/v1.35/) + // Env in the Create a container (https://docs.docker.com/engine/reference/api/docker_remote_api_v1.27/#create-a-container) + // section of the Docker Remote API (https://docs.docker.com/engine/reference/api/docker_remote_api_v1.27/) // and the --env option to docker run (https://docs.docker.com/engine/reference/run/). // // We do not recommend using plaintext environment variables for sensitive information, @@ -4689,28 +4335,27 @@ type ContainerDefinition struct { Essential *bool `locationName:"essential" type:"boolean"` // 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 - // (https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) section - // of the Docker Remote API (https://docs.docker.com/engine/api/v1.35/) and - // the --add-host option to docker run (https://docs.docker.com/engine/reference/run/). + // on the container. If using the Fargate launch type, this may be used to list + // non-Fargate hosts to which the container can talk. This parameter maps to + // ExtraHosts in the Create a container (https://docs.docker.com/engine/reference/api/docker_remote_api_v1.27/#create-a-container) + // section of the Docker Remote API (https://docs.docker.com/engine/reference/api/docker_remote_api_v1.27/) + // and the --add-host option to docker run (https://docs.docker.com/engine/reference/run/). // - // This parameter is not supported for Windows containers or tasks that use - // the awsvpc network mode. + // This parameter is not supported for Windows containers. ExtraHosts []*HostEntry `locationName:"extraHosts" type:"list"` // The health check command and associated configuration parameters for the - // container. This parameter maps to HealthCheck in the Create a container (https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) - // section of the Docker Remote API (https://docs.docker.com/engine/api/v1.35/) + // container. This parameter maps to HealthCheck in the Create a container (https://docs.docker.com/engine/reference/api/docker_remote_api_v1.27/#create-a-container) + // section of the Docker Remote API (https://docs.docker.com/engine/reference/api/docker_remote_api_v1.27/) // and the HEALTHCHECK parameter of docker run (https://docs.docker.com/engine/reference/run/). HealthCheck *HealthCheck `locationName:"healthCheck" type:"structure"` // The hostname to use for your container. This parameter maps to Hostname in - // the Create a container (https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) - // section of the Docker Remote API (https://docs.docker.com/engine/api/v1.35/) + // the Create a container (https://docs.docker.com/engine/reference/api/docker_remote_api_v1.27/#create-a-container) + // section of the Docker Remote API (https://docs.docker.com/engine/reference/api/docker_remote_api_v1.27/) // and the --hostname option to docker run (https://docs.docker.com/engine/reference/run/). // - // The hostname parameter is not supported if you are using the awsvpc network - // mode. + // The hostname parameter is not supported if using the awsvpc networkMode. Hostname *string `locationName:"hostname" type:"string"` // The image used to start a container. This string is passed directly to the @@ -4719,9 +4364,9 @@ type ContainerDefinition struct { // repository-url/image@digest. 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 - // (https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) section - // of the Docker Remote API (https://docs.docker.com/engine/api/v1.35/) and - // the IMAGE parameter of docker run (https://docs.docker.com/engine/reference/run/). + // (https://docs.docker.com/engine/reference/api/docker_remote_api_v1.27/#create-a-container) + // section of the Docker Remote API (https://docs.docker.com/engine/reference/api/docker_remote_api_v1.27/) + // and the IMAGE parameter of docker run (https://docs.docker.com/engine/reference/run/). // // * When a new task starts, the Amazon ECS container agent pulls the latest // version of the specified image and tag for the container to use. However, @@ -4744,11 +4389,6 @@ type ContainerDefinition struct { // name (for example, quay.io/assemblyline/ubuntu). Image *string `locationName:"image" type:"string"` - // When this parameter is true, this allows you to deploy containerized applications - // that require stdin or a tty to be allocated. This parameter maps to OpenStdin - // in the Create a container (https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) - // section of the Docker Remote API (https://docs.docker.com/engine/api/v1.35/) - // and the --interactive option to docker run (https://docs.docker.com/engine/reference/run/). Interactive *bool `locationName:"interactive" type:"boolean"` // The link parameter allows containers to communicate with each other without @@ -4758,8 +4398,8 @@ type ContainerDefinition struct { // numbers, hyphens, and underscores are allowed. For more information about // linking Docker containers, go to https://docs.docker.com/engine/userguide/networking/default_network/dockerlinks/ // (https://docs.docker.com/engine/userguide/networking/default_network/dockerlinks/). - // This parameter maps to Links in the Create a container (https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) - // section of the Docker Remote API (https://docs.docker.com/engine/api/v1.35/) + // This parameter maps to Links in the Create a container (https://docs.docker.com/engine/reference/api/docker_remote_api_v1.27/#create-a-container) + // section of the Docker Remote API (https://docs.docker.com/engine/reference/api/docker_remote_api_v1.27/) // and the --link option to docker run (https://docs.docker.com/engine/reference/commandline/run/). // // This parameter is not supported for Windows containers. @@ -4778,13 +4418,13 @@ type ContainerDefinition struct { // The log configuration specification for the container. // - // If you are using the Fargate launch type, the only supported value is awslogs. + // If using the Fargate launch type, the only supported value is awslogs. // - // This parameter maps to LogConfig in the Create a container (https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) - // section of the Docker Remote API (https://docs.docker.com/engine/api/v1.35/) + // This parameter maps to LogConfig in the Create a container (https://docs.docker.com/engine/reference/api/docker_remote_api_v1.27/#create-a-container) + // section of the Docker Remote API (https://docs.docker.com/engine/reference/api/docker_remote_api_v1.27/) // and the --log-driver option to docker run (https://docs.docker.com/engine/reference/run/). // By default, containers use the same logging driver that the Docker daemon - // uses. However the container may use a different logging driver than the Docker + // uses; however the container may use a different logging driver than the Docker // daemon by specifying a log driver with this parameter in the container definition. // To use a different logging driver for a container, the log system must be // configured properly on the container instance (or on a different log server @@ -4799,7 +4439,7 @@ type ContainerDefinition struct { // This parameter requires version 1.18 of the Docker Remote API or greater // on your container instance. To check the Docker Remote API version on your // container instance, log in to your container instance and run the following - // command: sudo docker version --format '{{.Server.APIVersion}}' + // 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 @@ -4811,8 +4451,8 @@ type ContainerDefinition struct { // The hard limit (in MiB) of memory to present to the container. If your container // attempts to exceed the memory specified here, the container is killed. This - // parameter maps to Memory in the Create a container (https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) - // section of the Docker Remote API (https://docs.docker.com/engine/api/v1.35/) + // parameter maps to Memory in the Create a container (https://docs.docker.com/engine/reference/api/docker_remote_api_v1.27/#create-a-container) + // section of the Docker Remote API (https://docs.docker.com/engine/reference/api/docker_remote_api_v1.27/) // and the --memory option to docker run (https://docs.docker.com/engine/reference/run/). // // If your containers are part of a task using the Fargate launch type, this @@ -4824,7 +4464,7 @@ type ContainerDefinition struct { // in container definitions. If you specify both, memory must be greater than // memoryReservation. If you specify memoryReservation, then that value is subtracted // from the available memory resources for the container instance on which the - // container is placed. Otherwise, the value of memory is used. + // container is placed; otherwise, the value of memory is used. // // The Docker daemon reserves a minimum of 4 MiB of memory for a container, // so you should not specify fewer than 4 MiB of memory for your containers. @@ -4832,19 +4472,19 @@ type ContainerDefinition struct { // The soft limit (in MiB) of memory to reserve for the container. When system // memory is under heavy contention, Docker attempts to keep the container memory - // to this soft limit. However, your container can consume more memory when + // to this soft limit; however, your container can consume more memory when // it needs to, up to either the hard limit specified with the memory parameter // (if applicable), or all of the available memory on the container instance, // whichever comes first. This parameter maps to MemoryReservation in the Create - // a container (https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) - // section of the Docker Remote API (https://docs.docker.com/engine/api/v1.35/) + // a container (https://docs.docker.com/engine/reference/api/docker_remote_api_v1.27/#create-a-container) + // section of the Docker Remote API (https://docs.docker.com/engine/reference/api/docker_remote_api_v1.27/) // and the --memory-reservation option to docker run (https://docs.docker.com/engine/reference/run/). // // You must specify a non-zero integer for one or both of memory or memoryReservation // in container definitions. If you specify both, memory must be greater than // memoryReservation. If you specify memoryReservation, then that value is subtracted // from the available memory resources for the container instance on which the - // container is placed. Otherwise, the value of memory is used. + // container is placed; otherwise, the value of memory is used. // // For example, if your container normally uses 128 MiB of memory, but occasionally // bursts to 256 MiB of memory for short periods of time, you can set a memoryReservation @@ -4859,8 +4499,8 @@ type ContainerDefinition struct { // The mount points for data volumes in your container. // - // This parameter maps to Volumes in the Create a container (https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) - // section of the Docker Remote API (https://docs.docker.com/engine/api/v1.35/) + // This parameter maps to Volumes in the Create a container (https://docs.docker.com/engine/reference/api/docker_remote_api_v1.27/#create-a-container) + // section of the Docker Remote API (https://docs.docker.com/engine/reference/api/docker_remote_api_v1.27/) // and the --volume option to docker run (https://docs.docker.com/engine/reference/run/). // // Windows containers can mount whole directories on the same drive as $env:ProgramData. @@ -4872,8 +4512,8 @@ type ContainerDefinition struct { // 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 (https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) - // section of the Docker Remote API (https://docs.docker.com/engine/api/v1.35/) + // maps to name in the Create a container (https://docs.docker.com/engine/reference/api/docker_remote_api_v1.27/#create-a-container) + // section of the Docker Remote API (https://docs.docker.com/engine/reference/api/docker_remote_api_v1.27/) // and the --name option to docker run (https://docs.docker.com/engine/reference/run/). Name *string `locationName:"name" type:"string"` @@ -4888,8 +4528,8 @@ type ContainerDefinition struct { // There is no loopback for port mappings on Windows, so you cannot access a // container's mapped port from the host itself. // - // This parameter maps to PortBindings in the Create a container (https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) - // section of the Docker Remote API (https://docs.docker.com/engine/api/v1.35/) + // This parameter maps to PortBindings in the Create a container (https://docs.docker.com/engine/reference/api/docker_remote_api_v1.27/#create-a-container) + // section of the Docker Remote API (https://docs.docker.com/engine/reference/api/docker_remote_api_v1.27/) // and the --publish option to docker run (https://docs.docker.com/engine/reference/run/). // If the network mode of a task definition is set to none, then you can't specify // port mappings. If the network mode of a task definition is set to host, then @@ -4904,25 +4544,21 @@ type ContainerDefinition struct { // 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 (https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) - // section of the Docker Remote API (https://docs.docker.com/engine/api/v1.35/) + // to Privileged in the Create a container (https://docs.docker.com/engine/reference/api/docker_remote_api_v1.27/#create-a-container) + // section of the Docker Remote API (https://docs.docker.com/engine/reference/api/docker_remote_api_v1.27/) // and the --privileged option to docker run (https://docs.docker.com/engine/reference/run/). // // This parameter is not supported for Windows containers or tasks using the // Fargate launch type. Privileged *bool `locationName:"privileged" type:"boolean"` - // When this parameter is true, a TTY is allocated. This parameter maps to Tty - // in the Create a container (https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) - // section of the Docker Remote API (https://docs.docker.com/engine/api/v1.35/) - // and the --tty option to docker run (https://docs.docker.com/engine/reference/run/). PseudoTerminal *bool `locationName:"pseudoTerminal" type:"boolean"` // 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 - // (https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) section - // of the Docker Remote API (https://docs.docker.com/engine/api/v1.35/) and - // the --read-only option to docker run (https://docs.docker.com/engine/reference/run/). + // (https://docs.docker.com/engine/reference/api/docker_remote_api_v1.27/#create-a-container) + // section of the Docker Remote API (https://docs.docker.com/engine/reference/api/docker_remote_api_v1.27/) + // and the --read-only option to docker run. // // This parameter is not supported for Windows containers. ReadonlyRootFilesystem *bool `locationName:"readonlyRootFilesystem" type:"boolean"` @@ -4935,35 +4571,35 @@ type ContainerDefinition struct { SystemControls []*SystemControl `locationName:"systemControls" type:"list"` // A list of ulimits to set in the container. This parameter maps to Ulimits - // in the Create a container (https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) - // section of the Docker Remote API (https://docs.docker.com/engine/api/v1.35/) + // in the Create a container (https://docs.docker.com/engine/reference/api/docker_remote_api_v1.27/#create-a-container) + // section of the Docker Remote API (https://docs.docker.com/engine/reference/api/docker_remote_api_v1.27/) // and the --ulimit option to docker run (https://docs.docker.com/engine/reference/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 in to your container instance and run the following command: sudo docker - // version --format '{{.Server.APIVersion}}' + // version | grep "Server API version" // // This parameter is not supported for Windows containers. Ulimits []*Ulimit `locationName:"ulimits" type:"list"` // The user name to use inside the container. This parameter maps to User in - // the Create a container (https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) - // section of the Docker Remote API (https://docs.docker.com/engine/api/v1.35/) + // the Create a container (https://docs.docker.com/engine/reference/api/docker_remote_api_v1.27/#create-a-container) + // section of the Docker Remote API (https://docs.docker.com/engine/reference/api/docker_remote_api_v1.27/) // and the --user option to docker run (https://docs.docker.com/engine/reference/run/). // // This parameter is not supported for Windows containers. User *string `locationName:"user" type:"string"` // Data volumes to mount from another container. This parameter maps to VolumesFrom - // in the Create a container (https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) - // section of the Docker Remote API (https://docs.docker.com/engine/api/v1.35/) + // in the Create a container (https://docs.docker.com/engine/reference/api/docker_remote_api_v1.27/#create-a-container) + // section of the Docker Remote API (https://docs.docker.com/engine/reference/api/docker_remote_api_v1.27/) // and the --volumes-from option to docker run (https://docs.docker.com/engine/reference/run/). VolumesFrom []*VolumeFrom `locationName:"volumesFrom" type:"list"` // The working directory in which to run commands inside the container. This - // parameter maps to WorkingDir in the Create a container (https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) - // section of the Docker Remote API (https://docs.docker.com/engine/api/v1.35/) + // parameter maps to WorkingDir in the Create a container (https://docs.docker.com/engine/reference/api/docker_remote_api_v1.27/#create-a-container) + // section of the Docker Remote API (https://docs.docker.com/engine/reference/api/docker_remote_api_v1.27/) // and the --workdir option to docker run (https://docs.docker.com/engine/reference/run/). WorkingDirectory *string `locationName:"workingDirectory" type:"string"` } @@ -5271,12 +4907,12 @@ type ContainerInstance struct { // The number of tasks on the container instance that are in the PENDING status. PendingTasksCount *int64 `locationName:"pendingTasksCount" type:"integer"` - // The Unix timestamp for when the container instance was registered. + // The Unix time stamp for when the container instance was registered. RegisteredAt *time.Time `locationName:"registeredAt" type:"timestamp"` // For CPU and memory resource types, this parameter describes the amount of // each resource that was available on the container instance when the container - // agent registered it with Amazon ECS. This value represents the total amount + // agent registered it with Amazon ECS; this value represents the total amount // of CPU and memory that can be allocated on this container instance to tasks. // For port resource types, this parameter describes the ports that were reserved // by the Amazon ECS container agent when it registered the container instance @@ -5578,12 +5214,6 @@ type CreateClusterInput struct { // you create a cluster named default. Up to 255 letters (uppercase and lowercase), // numbers, hyphens, and underscores are allowed. ClusterName *string `locationName:"clusterName" type:"string"` - - // The metadata that you apply to the cluster to help you categorize and organize - // them. Each tag consists of a key and an optional value, both of which you - // define. Tag keys can have a maximum character length of 128 characters, and - // tag values can have a maximum length of 256 characters. - Tags []*Tag `locationName:"tags" type:"list"` } // String returns the string representation @@ -5596,38 +5226,12 @@ func (s CreateClusterInput) GoString() string { return s.String() } -// Validate inspects the fields of the type to determine if they are valid. -func (s *CreateClusterInput) Validate() error { - invalidParams := request.ErrInvalidParams{Context: "CreateClusterInput"} - if s.Tags != nil { - for i, v := range s.Tags { - if v == nil { - continue - } - if err := v.Validate(); err != nil { - invalidParams.AddNested(fmt.Sprintf("%s[%v]", "Tags", i), err.(request.ErrInvalidParams)) - } - } - } - - if invalidParams.Len() > 0 { - return invalidParams - } - return nil -} - // SetClusterName sets the ClusterName field's value. func (s *CreateClusterInput) SetClusterName(v string) *CreateClusterInput { s.ClusterName = &v return s } -// SetTags sets the Tags field's value. -func (s *CreateClusterInput) SetTags(v []*Tag) *CreateClusterInput { - s.Tags = v - return s -} - type CreateClusterOutput struct { _ struct{} `type:"structure"` @@ -5667,55 +5271,28 @@ type CreateServiceInput struct { // deployment and the ordering of stopping and starting tasks. DeploymentConfiguration *DeploymentConfiguration `locationName:"deploymentConfiguration" type:"structure"` - // The deployment controller to use for the service. - DeploymentController *DeploymentController `locationName:"deploymentController" type:"structure"` - // The number of instantiations of the specified task definition to place and // keep running on your cluster. DesiredCount *int64 `locationName:"desiredCount" type:"integer"` - // Specifies whether to enable Amazon ECS managed tags for the tasks within - // the service. For more information, see Tagging Your Amazon ECS Resources - // (http://docs.aws.amazon.com/AmazonECS/latest/developerguide/Using_Tags.html) - // in the Amazon Elastic Container Service Developer Guide. - EnableECSManagedTags *bool `locationName:"enableECSManagedTags" type:"boolean"` - // The period of time, in seconds, that the Amazon ECS service scheduler should // ignore unhealthy Elastic Load Balancing target health checks after a task // has first started. This is only valid if your service is configured to use // a load balancer. If your service's tasks take a while to start and respond // to Elastic Load Balancing health checks, you can specify a health check grace - // period of up to 7,200 seconds. During that time, the ECS service scheduler - // ignores health check status. This grace period can prevent the ECS service - // scheduler from marking tasks as unhealthy and stopping them before they have - // time to come up. + // period of up to 7,200 seconds during which the ECS service scheduler ignores + // health check status. This grace period can prevent the ECS service scheduler + // from marking tasks as unhealthy and stopping them before they have time to + // come up. HealthCheckGracePeriodSeconds *int64 `locationName:"healthCheckGracePeriodSeconds" type:"integer"` - // The launch type on which to run your service. For more information, see Amazon - // ECS Launch Types (http://docs.aws.amazon.com/AmazonECS/latest/developerguide/launch_types.html) - // in the Amazon Elastic Container Service Developer Guide. + // The launch type on which to run your service. LaunchType *string `locationName:"launchType" type:"string" enum:"LaunchType"` // A load balancer object representing the load balancer to use with your service. - // - // If the service is using the ECS deployment controller, you are limited to - // one load balancer or target group. - // - // If the service is using the CODE_DEPLOY deployment controller, the service - // is required to use either an Application Load Balancer or Network Load Balancer. - // When creating an AWS CodeDeploy deployment group, you specify two target - // groups (referred to as a targetGroupPair). During a deployment, AWS CodeDeploy - // determines which task set in your service has the status PRIMARY and associates - // one target group with it, and then associates the other target group with - // the replacement task set. The load balancer can also have up to two listeners: - // a required listener for production traffic and an optional listener that - // allows you perform validation tests with Lambda functions before routing - // production traffic to it. - // - // After you create a service using the ECS deployment controller, the load - // balancer name or target group ARN, container name, and container port specified - // in the service definition are immutable. If you are using the CODE_DEPLOY - // deployment controller, these values can be changed when updating the service. + // Currently, you are limited to one load balancer or target group per service. + // After you create a service, the load balancer name or target group ARN, container + // name, and container port specified in the service definition are immutable. // // For Classic Load Balancers, this object must contain the load balancer name, // the container name (as it appears in a container definition), and the container @@ -5732,41 +5309,32 @@ type CreateServiceInput struct { // // Services with tasks that use the awsvpc network mode (for example, those // with the Fargate launch type) only support Application Load Balancers and - // Network Load Balancers. Classic Load Balancers are not supported. Also, when + // Network Load Balancers; Classic Load Balancers are not supported. Also, when // you create any target groups for these services, you must choose ip as the // target type, not instance, because tasks that use the awsvpc network mode // are associated with an elastic network interface, not an Amazon EC2 instance. LoadBalancers []*LoadBalancer `locationName:"loadBalancers" type:"list"` // The network configuration for the service. This parameter is required for - // task definitions that use the awsvpc network mode to receive their own elastic - // network interface, and it is not supported for other network modes. For more + // task definitions that use the awsvpc network mode to receive their own Elastic + // Network Interface, and it is not supported for other network modes. For more // information, see Task Networking (http://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-networking.html) // in the Amazon Elastic Container Service Developer Guide. NetworkConfiguration *NetworkConfiguration `locationName:"networkConfiguration" type:"structure"` // An array of placement constraint objects to use for tasks in your service. // You can specify a maximum of 10 constraints per task (this limit includes - // constraints in the task definition and those specified at runtime). + // constraints in the task definition and those specified at run time). PlacementConstraints []*PlacementConstraint `locationName:"placementConstraints" type:"list"` // The placement strategy objects to use for tasks in your service. You can // specify a maximum of five strategy rules per service. PlacementStrategy []*PlacementStrategy `locationName:"placementStrategy" type:"list"` - // The platform version on which your tasks in the service are running. A platform - // version is only specified for tasks using the Fargate launch type. If one - // is not specified, the LATEST platform version is used by default. For more - // information, see AWS Fargate Platform Versions (http://docs.aws.amazon.com/AmazonECS/latest/developerguide/platform_versions.html) - // in the Amazon Elastic Container Service Developer Guide. + // The platform version on which to run your service. If one is not specified, + // the latest version is used by default. PlatformVersion *string `locationName:"platformVersion" type:"string"` - // Specifies whether to propagate the tags from the task definition or the service - // to the tasks. If no value is specified, the tags are not propagated. Tags - // can only be propagated to the tasks within the service during service creation. - // To add tags to a task after service creation, use the TagResource API action. - PropagateTags *string `locationName:"propagateTags" type:"string" enum:"PropagateTags"` - // The name or full Amazon Resource Name (ARN) of the IAM role that allows Amazon // ECS to make calls to your load balancer on your behalf. This parameter is // only permitted if you are using a load balancer with your service and your @@ -5790,24 +5358,22 @@ type CreateServiceInput struct { Role *string `locationName:"role" type:"string"` // The scheduling strategy to use for the service. For more information, see - // Services (http://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs_services.html). + // Services (http://docs.aws.amazon.com/AmazonECS/latest/developerguideecs_services.html). // // There are two service scheduler strategies available: // // * REPLICA-The replica scheduling strategy places and maintains the desired // number of tasks across your cluster. By default, the service scheduler // spreads tasks across Availability Zones. You can use task placement strategies - // and constraints to customize task placement decisions. This scheduler - // strategy is required if using the CODE_DEPLOY deployment controller. + // and constraints to customize task placement decisions. // // * DAEMON-The daemon scheduling strategy deploys exactly one task on each // active container instance that meets all of the task placement constraints - // that you specify in your cluster. When you are using this strategy, there - // is no need to specify a desired number of tasks, a task placement strategy, + // that you specify in your cluster. When using this strategy, there is no + // need to specify a desired number of tasks, a task placement strategy, // or use Service Auto Scaling policies. // - // Tasks using the Fargate launch type or the CODE_DEPLOY deploymenet controller - // do not support the DAEMON scheduling strategy. + // Fargate tasks do not support the DAEMON scheduling strategy. SchedulingStrategy *string `locationName:"schedulingStrategy" type:"string" enum:"SchedulingStrategy"` // The name of your service. Up to 255 letters (uppercase and lowercase), numbers, @@ -5821,18 +5387,11 @@ type CreateServiceInput struct { // The details of the service discovery registries to assign to this service. // For more information, see Service Discovery (http://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-discovery.html). // - // Service discovery is supported for Fargate tasks if you are using platform - // version v1.1.0 or later. For more information, see AWS Fargate Platform Versions + // Service discovery is supported for Fargate tasks if using platform version + // v1.1.0 or later. For more information, see AWS Fargate Platform Versions // (http://docs.aws.amazon.com/AmazonECS/latest/developerguide/platform_versions.html). ServiceRegistries []*ServiceRegistry `locationName:"serviceRegistries" type:"list"` - // The metadata that you apply to the service to help you categorize and organize - // them. Each tag consists of a key and an optional value, both of which you - // define. When a service is deleted, the tags are deleted as well. Tag keys - // can have a maximum character length of 128 characters, and tag values can - // have a maximum length of 256 characters. - Tags []*Tag `locationName:"tags" type:"list"` - // The family and revision (family:revision) or full ARN of the task definition // to run in your service. If a revision is not specified, the latest ACTIVE // revision is used. @@ -5860,26 +5419,11 @@ func (s *CreateServiceInput) Validate() error { if s.TaskDefinition == nil { invalidParams.Add(request.NewErrParamRequired("TaskDefinition")) } - if s.DeploymentController != nil { - if err := s.DeploymentController.Validate(); err != nil { - invalidParams.AddNested("DeploymentController", err.(request.ErrInvalidParams)) - } - } if s.NetworkConfiguration != nil { if err := s.NetworkConfiguration.Validate(); err != nil { invalidParams.AddNested("NetworkConfiguration", err.(request.ErrInvalidParams)) } } - if s.Tags != nil { - for i, v := range s.Tags { - if v == nil { - continue - } - if err := v.Validate(); err != nil { - invalidParams.AddNested(fmt.Sprintf("%s[%v]", "Tags", i), err.(request.ErrInvalidParams)) - } - } - } if invalidParams.Len() > 0 { return invalidParams @@ -5905,24 +5449,12 @@ func (s *CreateServiceInput) SetDeploymentConfiguration(v *DeploymentConfigurati return s } -// SetDeploymentController sets the DeploymentController field's value. -func (s *CreateServiceInput) SetDeploymentController(v *DeploymentController) *CreateServiceInput { - s.DeploymentController = v - return s -} - // SetDesiredCount sets the DesiredCount field's value. func (s *CreateServiceInput) SetDesiredCount(v int64) *CreateServiceInput { s.DesiredCount = &v return s } -// SetEnableECSManagedTags sets the EnableECSManagedTags field's value. -func (s *CreateServiceInput) SetEnableECSManagedTags(v bool) *CreateServiceInput { - s.EnableECSManagedTags = &v - return s -} - // SetHealthCheckGracePeriodSeconds sets the HealthCheckGracePeriodSeconds field's value. func (s *CreateServiceInput) SetHealthCheckGracePeriodSeconds(v int64) *CreateServiceInput { s.HealthCheckGracePeriodSeconds = &v @@ -5965,12 +5497,6 @@ func (s *CreateServiceInput) SetPlatformVersion(v string) *CreateServiceInput { return s } -// SetPropagateTags sets the PropagateTags field's value. -func (s *CreateServiceInput) SetPropagateTags(v string) *CreateServiceInput { - s.PropagateTags = &v - return s -} - // SetRole sets the Role field's value. func (s *CreateServiceInput) SetRole(v string) *CreateServiceInput { s.Role = &v @@ -5995,12 +5521,6 @@ func (s *CreateServiceInput) SetServiceRegistries(v []*ServiceRegistry) *CreateS return s } -// SetTags sets the Tags field's value. -func (s *CreateServiceInput) SetTags(v []*Tag) *CreateServiceInput { - s.Tags = v - return s -} - // SetTaskDefinition sets the TaskDefinition field's value. func (s *CreateServiceInput) SetTaskDefinition(v string) *CreateServiceInput { s.TaskDefinition = &v @@ -6011,13 +5531,6 @@ type CreateServiceOutput struct { _ struct{} `type:"structure"` // The full description of your service following the create call. - // - // If a service is using the ECS deployment controller, the deploymentController - // and taskSets parameters will not be returned. - // - // If the service is using the CODE_DEPLOY deployment controller, the deploymentController, - // taskSets and deployments parameters will be returned, however the deployments - // parameter will be an empty list. Service *Service `locationName:"service" type:"structure"` } @@ -6040,20 +5553,9 @@ func (s *CreateServiceOutput) SetService(v *Service) *CreateServiceOutput { type DeleteAccountSettingInput struct { _ struct{} `type:"structure"` - // The resource name for which to disable the new format. If serviceLongArnFormat - // is specified, the ARN for your Amazon ECS services is affected. If taskLongArnFormat - // is specified, the ARN and resource ID for your Amazon ECS tasks is affected. - // If containerInstanceLongArnFormat is specified, the ARN and resource ID for - // your Amazon ECS container instances is affected. - // // Name is a required field Name *string `locationName:"name" type:"string" required:"true" enum:"SettingName"` - // The ARN of the principal, which can be an IAM user, IAM role, or the root - // user. If you specify the root user, it modifies the ARN and resource ID format - // for all IAM users, IAM roles, and the root user of the account unless an - // IAM user or role explicitly overrides these settings for themselves. If this - // field is omitted, the setting are changed only for the authenticated user. PrincipalArn *string `locationName:"principalArn" type:"string"` } @@ -6095,7 +5597,6 @@ func (s *DeleteAccountSettingInput) SetPrincipalArn(v string) *DeleteAccountSett type DeleteAccountSettingOutput struct { _ struct{} `type:"structure"` - // The account setting for the specified principal ARN. Setting *Setting `locationName:"setting" type:"structure"` } @@ -6344,12 +5845,11 @@ func (s *DeleteServiceOutput) SetService(v *Service) *DeleteServiceOutput { return s } -// The details of an Amazon ECS service deployment. This is used when a service -// uses the CODE_DEPLOY deployment controller type. +// The details of an Amazon ECS service deployment. type Deployment struct { _ struct{} `type:"structure"` - // The Unix timestamp for when the service deployment was created. + // The Unix time stamp for when the service was created. CreatedAt *time.Time `locationName:"createdAt" type:"timestamp"` // The most recent desired count of tasks that was specified for the service @@ -6359,9 +5859,7 @@ type Deployment struct { // The ID of the deployment. Id *string `locationName:"id" type:"string"` - // The launch type the tasks in the service are using. For more information, - // see Amazon ECS Launch Types (http://docs.aws.amazon.com/AmazonECS/latest/developerguide/launch_types.html) - // in the Amazon Elastic Container Service Developer Guide. + // The launch type on which your service is running. LaunchType *string `locationName:"launchType" type:"string" enum:"LaunchType"` // The VPC subnet and security group configuration for tasks that receive their @@ -6371,31 +5869,22 @@ type Deployment struct { // The number of tasks in the deployment that are in the PENDING status. PendingCount *int64 `locationName:"pendingCount" type:"integer"` - // The platform version on which your tasks in the service are running. A platform - // version is only specified for tasks using the Fargate launch type. If one - // is not specified, the LATEST platform version is used by default. For more - // information, see AWS Fargate Platform Versions (http://docs.aws.amazon.com/AmazonECS/latest/developerguide/platform_versions.html) - // in the Amazon Elastic Container Service Developer Guide. + // The platform version on which your service is running. PlatformVersion *string `locationName:"platformVersion" type:"string"` // The number of tasks in the deployment that are in the RUNNING status. RunningCount *int64 `locationName:"runningCount" type:"integer"` - // The status of the deployment. The following describes each state: - // - // PRIMARYThe most recent deployment of a service. - // - // ACTIVEA service deployment that still has running tasks, but are in the process - // of being replaced with a new PRIMARY deployment. - // - // INACTIVEA deployment that has been completely replaced. + // 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). Status *string `locationName:"status" type:"string"` - // The most recent task definition that was specified for the tasks in the service - // to use. + // The most recent task definition that was specified for the service to use. TaskDefinition *string `locationName:"taskDefinition" type:"string"` - // The Unix timestamp for when the service deployment was last updated. + // The Unix time stamp for when the service was last updated. UpdatedAt *time.Time `locationName:"updatedAt" type:"timestamp"` } @@ -6480,49 +5969,17 @@ func (s *Deployment) SetUpdatedAt(v time.Time) *Deployment { type DeploymentConfiguration struct { _ struct{} `type:"structure"` - // If a service is using the rolling update (ECS) deployment type, the maximum - // percent parameter represents an upper limit on the number of tasks in a service - // that are allowed in the RUNNING or PENDING state during a deployment, as - // a percentage of the desired number of tasks (rounded down to the nearest - // integer), and while any container instances are in the DRAINING state if - // the service contains tasks using the EC2 launch type. This parameter enables - // you to define the deployment batch size. For example, if your service has - // a desired number of four tasks and a maximum percent value of 200%, the scheduler - // may start four new tasks before stopping the four older tasks (provided that - // the cluster resources required to do this are available). The default value - // for maximum percent is 200%. - // - // If a service is using the blue/green (CODE_DEPLOY) deployment type and tasks - // that use the EC2 launch type, the maximum percent value is set to the default - // value and is used to define the upper limit on the number of the tasks in - // the service that remain in the RUNNING state while the container instances - // are in the DRAINING state. If the tasks in the service use the Fargate launch - // type, the maximum percent value is not used, although it is returned when - // describing your service. + // The upper limit (as a percentage of the service's desiredCount) of the number + // of tasks that are allowed in the RUNNING or PENDING state in a service during + // a deployment. The maximum number of tasks during a deployment is the desiredCount + // multiplied by maximumPercent/100, rounded down to the nearest integer value. MaximumPercent *int64 `locationName:"maximumPercent" type:"integer"` - // If a service is using the rolling update (ECS) deployment type, the minimum - // healthy percent represents a lower limit on the number of tasks in a service - // that must remain in the RUNNING state during a deployment, as a percentage - // of the desired number of tasks (rounded up to the nearest integer), and while - // any container instances are in the DRAINING state if the service contains - // tasks using the EC2 launch type. This parameter enables you to deploy without - // using additional cluster capacity. For example, if your service has a desired - // number of four tasks and a minimum healthy percent of 50%, the scheduler - // may stop two existing tasks to free up cluster capacity before starting two - // new tasks. Tasks for services that do not use a load balancer are considered - // healthy if they are in the RUNNING state; tasks for services that do use - // a load balancer are considered healthy if they are in the RUNNING state and - // they are reported as healthy by the load balancer. The default value for - // minimum healthy percent is 100%. - // - // If a service is using the blue/green (CODE_DEPLOY) deployment type and tasks - // that use the EC2 launch type, the minimum healthy percent value is set to - // the default value and is used to define the lower limit on the number of - // the tasks in the service that remain in the RUNNING state while the container - // instances are in the DRAINING state. If the tasks in the service use the - // Fargate launch type, the minimum healthy percent value is not used, although - // it is returned when describing your service. + // The lower limit (as a percentage of the service's desiredCount) of the number + // of running tasks that must remain in the RUNNING state in a service during + // a deployment. The minimum number of healthy tasks during a deployment is + // the desiredCount multiplied by minimumHealthyPercent/100, rounded up to the + // nearest integer value. MinimumHealthyPercent *int64 `locationName:"minimumHealthyPercent" type:"integer"` } @@ -6548,61 +6005,6 @@ func (s *DeploymentConfiguration) SetMinimumHealthyPercent(v int64) *DeploymentC return s } -// The deployment controller to use for the service. For more information, see -// Amazon ECS Deployment Types (http://docs.aws.amazon.com/AmazonECS/latest/developerguide/deployment-types.html) -// in the Amazon Elastic Container Service Developer Guide. -type DeploymentController struct { - _ struct{} `type:"structure"` - - // The deployment controller type to use. - // - // There are two deployment controller types available: - // - // ECSThe rolling update (ECS) deployment type involves replacing the current - // running version of the container with the latest version. The number of containers - // Amazon ECS adds or removes from the service during a rolling update is controlled - // by adjusting the minimum and maximum number of healthy tasks allowed during - // a service deployment, as specified in the DeploymentConfiguration. - // - // CODE_DEPLOYThe blue/green (CODE_DEPLOY) deployment type uses the blue/green - // deployment model powered by AWS CodeDeploy, which allows you to verify a - // new deployment of a service before sending production traffic to it. For - // more information, see Amazon ECS Deployment Types (http://docs.aws.amazon.com/AmazonECS/latest/developerguide/deployment-types.html) - // in the Amazon Elastic Container Service Developer Guide. - // - // Type is a required field - Type *string `locationName:"type" type:"string" required:"true" enum:"DeploymentControllerType"` -} - -// String returns the string representation -func (s DeploymentController) String() string { - return awsutil.Prettify(s) -} - -// GoString returns the string representation -func (s DeploymentController) GoString() string { - return s.String() -} - -// Validate inspects the fields of the type to determine if they are valid. -func (s *DeploymentController) Validate() error { - invalidParams := request.ErrInvalidParams{Context: "DeploymentController"} - if s.Type == nil { - invalidParams.Add(request.NewErrParamRequired("Type")) - } - - if invalidParams.Len() > 0 { - return invalidParams - } - return nil -} - -// SetType sets the Type field's value. -func (s *DeploymentController) SetType(v string) *DeploymentController { - s.Type = &v - return s -} - type DeregisterContainerInstanceInput struct { _ struct{} `type:"structure"` @@ -6856,11 +6258,6 @@ type DescribeContainerInstancesInput struct { // // ContainerInstances is a required field ContainerInstances []*string `locationName:"containerInstances" type:"list" required:"true"` - - // Specifies whether you want to see the resource tags for the container instance. - // If TAGS is specified, the tags are included in the response. If this field - // is omitted, tags are not included in the response. - Include []*string `locationName:"include" type:"list"` } // String returns the string representation @@ -6898,12 +6295,6 @@ func (s *DescribeContainerInstancesInput) SetContainerInstances(v []*string) *De return s } -// SetInclude sets the Include field's value. -func (s *DescribeContainerInstancesInput) SetInclude(v []*string) *DescribeContainerInstancesInput { - s.Include = v - return s -} - type DescribeContainerInstancesOutput struct { _ struct{} `type:"structure"` @@ -6944,11 +6335,6 @@ type DescribeServicesInput struct { // is assumed. Cluster *string `locationName:"cluster" type:"string"` - // Specifies whether you want to see the resource tags for the service. If TAGS - // is specified, the tags are included in the response. If this field is omitted, - // tags are not included in the response. - Include []*string `locationName:"include" type:"list"` - // A list of services to describe. You may specify up to 10 services to describe // in a single operation. // @@ -6985,12 +6371,6 @@ func (s *DescribeServicesInput) SetCluster(v string) *DescribeServicesInput { return s } -// SetInclude sets the Include field's value. -func (s *DescribeServicesInput) SetInclude(v []*string) *DescribeServicesInput { - s.Include = v - return s -} - // SetServices sets the Services field's value. func (s *DescribeServicesInput) SetServices(v []*string) *DescribeServicesInput { s.Services = v @@ -7032,11 +6412,6 @@ func (s *DescribeServicesOutput) SetServices(v []*Service) *DescribeServicesOutp type DescribeTaskDefinitionInput struct { _ struct{} `type:"structure"` - // Specifies whether to see the resource tags for the task definition. If TAGS - // is specified, the tags are included in the response. If this field is omitted, - // tags are not included in the response. - Include []*string `locationName:"include" type:"list"` - // 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. @@ -7068,12 +6443,6 @@ func (s *DescribeTaskDefinitionInput) Validate() error { return nil } -// SetInclude sets the Include field's value. -func (s *DescribeTaskDefinitionInput) SetInclude(v []*string) *DescribeTaskDefinitionInput { - s.Include = v - return s -} - // SetTaskDefinition sets the TaskDefinition field's value. func (s *DescribeTaskDefinitionInput) SetTaskDefinition(v string) *DescribeTaskDefinitionInput { s.TaskDefinition = &v @@ -7083,12 +6452,6 @@ func (s *DescribeTaskDefinitionInput) SetTaskDefinition(v string) *DescribeTaskD type DescribeTaskDefinitionOutput struct { _ struct{} `type:"structure"` - // The metadata that is applied to the task definition to help you categorize - // and organize them. Each tag consists of a key and an optional value, both - // of which you define. Tag keys can have a maximum character length of 128 - // characters, and tag values can have a maximum length of 256 characters. - Tags []*Tag `locationName:"tags" type:"list"` - // The full task definition description. TaskDefinition *TaskDefinition `locationName:"taskDefinition" type:"structure"` } @@ -7103,12 +6466,6 @@ func (s DescribeTaskDefinitionOutput) GoString() string { return s.String() } -// SetTags sets the Tags field's value. -func (s *DescribeTaskDefinitionOutput) SetTags(v []*Tag) *DescribeTaskDefinitionOutput { - s.Tags = v - return s -} - // SetTaskDefinition sets the TaskDefinition field's value. func (s *DescribeTaskDefinitionOutput) SetTaskDefinition(v *TaskDefinition) *DescribeTaskDefinitionOutput { s.TaskDefinition = v @@ -7123,11 +6480,6 @@ type DescribeTasksInput struct { // is assumed. Cluster *string `locationName:"cluster" type:"string"` - // Specifies whether you want to see the resource tags for the task. If TAGS - // is specified, the tags are included in the response. If this field is omitted, - // tags are not included in the response. - Include []*string `locationName:"include" type:"list"` - // A list of up to 100 task IDs or full ARN entries. // // Tasks is a required field @@ -7163,12 +6515,6 @@ func (s *DescribeTasksInput) SetCluster(v string) *DescribeTasksInput { return s } -// SetInclude sets the Include field's value. -func (s *DescribeTasksInput) SetInclude(v []*string) *DescribeTasksInput { - s.Include = v - return s -} - // SetTasks sets the Tasks field's value. func (s *DescribeTasksInput) SetTasks(v []*string) *DescribeTasksInput { s.Tasks = v @@ -7268,8 +6614,8 @@ func (s *Device) SetPermissions(v []*string) *Device { type DiscoverPollEndpointInput struct { _ struct{} `type:"structure"` - // The short name or full Amazon Resource Name (ARN) of the cluster to which - // the container instance belongs. + // The short name or full Amazon Resource Name (ARN) of the cluster that the + // container instance belongs to. Cluster *string `locationName:"cluster" type:"string"` // The container instance ID or full ARN of the container instance. The ARN @@ -7333,46 +6679,17 @@ func (s *DiscoverPollEndpointOutput) SetTelemetryEndpoint(v string) *DiscoverPol return s } -// This parameter is specified when you are using Docker volumes. Docker volumes -// are only supported when you are using the EC2 launch type. Windows containers -// only support the use of the local driver. To use bind mounts, specify a host -// instead. type DockerVolumeConfiguration struct { _ struct{} `type:"structure"` - // If this value is true, the Docker volume is created if it does not already - // exist. - // - // This field is only used if the scope is shared. Autoprovision *bool `locationName:"autoprovision" type:"boolean"` - // The Docker volume driver to use. The driver value must match the driver name - // provided by Docker because it is used for task placement. If the driver was - // installed using the Docker plugin CLI, use docker plugin ls to retrieve the - // driver name from your container instance. If the driver was installed using - // another method, use Docker plugin discovery to retrieve the driver name. - // For more information, see Docker plugin discovery (https://docs.docker.com/engine/extend/plugin_api/#plugin-discovery). - // This parameter maps to Driver in the Create a volume (https://docs.docker.com/engine/api/v1.35/#operation/VolumeCreate) - // section of the Docker Remote API (https://docs.docker.com/engine/api/v1.35/) - // and the xxdriver option to docker volume create (https://docs.docker.com/engine/reference/commandline/volume_create/). Driver *string `locationName:"driver" type:"string"` - // A map of Docker driver-specific options passed through. This parameter maps - // to DriverOpts in the Create a volume (https://docs.docker.com/engine/api/v1.35/#operation/VolumeCreate) - // section of the Docker Remote API (https://docs.docker.com/engine/api/v1.35/) - // and the xxopt option to docker volume create (https://docs.docker.com/engine/reference/commandline/volume_create/). DriverOpts map[string]*string `locationName:"driverOpts" type:"map"` - // Custom metadata to add to your Docker volume. This parameter maps to Labels - // in the Create a volume (https://docs.docker.com/engine/api/v1.35/#operation/VolumeCreate) - // section of the Docker Remote API (https://docs.docker.com/engine/api/v1.35/) - // and the xxlabel option to docker volume create (https://docs.docker.com/engine/reference/commandline/volume_create/). Labels map[string]*string `locationName:"labels" type:"map"` - // The scope for the Docker volume that determines its lifecycle. Docker volumes - // that are scoped to a task are automatically provisioned when the task starts - // and destroyed when the task stops. Docker volumes that are scoped as shared - // persist after the task stops. Scope *string `locationName:"scope" type:"string" enum:"Scope"` } @@ -7453,19 +6770,6 @@ func (s *Failure) SetReason(v string) *Failure { // that are specified in a container definition override any Docker health checks // that exist in the container image (such as those specified in a parent image // or from the image's Dockerfile). -// -// The following are notes about container health check support: -// -// * Container health checks require version 1.17.0 or greater of the Amazon -// ECS container agent. For more information, see Updating the Amazon ECS -// Container Agent (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-agent-update.html). -// -// * Container health checks are supported for Fargate tasks if you are using -// platform version 1.1.0 or greater. For more information, see AWS Fargate -// Platform Versions (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/platform_versions.html). -// -// * Container health checks are not supported for tasks that are part of -// a service that is configured to use a Classic Load Balancer. type HealthCheck struct { _ struct{} `type:"structure"` @@ -7477,8 +6781,8 @@ type HealthCheck struct { // [ "CMD-SHELL", "curl -f http://localhost/ || exit 1" ] // // An exit code of 0 indicates success, and non-zero exit code indicates failure. - // For more information, see HealthCheck in the Create a container (https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) - // section of the Docker Remote API (https://docs.docker.com/engine/api/v1.35/). + // For more information, see HealthCheck in the Create a container (https://docs.docker.com/engine/reference/api/docker_remote_api_v1.27/#create-a-container) + // section of the Docker Remote API (https://docs.docker.com/engine/reference/api/docker_remote_api_v1.27/). // // Command is a required field Command []*string `locationName:"command" type:"list" required:"true"` @@ -7615,18 +6919,17 @@ func (s *HostEntry) SetIpAddress(v string) *HostEntry { return s } -// Details on a container instance bind mount host volume. +// Details on a container instance host volume. type HostVolumeProperties struct { _ struct{} `type:"structure"` - // When the host parameter is used, specify a sourcePath to declare the path - // on the host container instance that is presented to the container. If this - // parameter is empty, then the Docker daemon has assigned a host path for you. - // If the host parameter contains a sourcePath file location, then the data - // volume persists at the specified location on the host container instance - // until you delete it manually. If the sourcePath value does not exist on the - // host container instance, the Docker daemon creates it. If the location does - // exist, the contents of the source path folder are exported. + // The path on the host container instance that is presented to the container. + // If this parameter is empty, then the Docker daemon has assigned a host path + // for you. If the host parameter contains a sourcePath file location, then + // the data volume persists at the specified location on the host container + // instance until you delete it manually. If the sourcePath value does not exist + // on the host container instance, the Docker daemon creates it. If the location + // does exist, the contents of the source path folder are exported. // // If you are using the Fargate launch type, the sourcePath parameter is not // supported. @@ -7661,8 +6964,8 @@ type KernelCapabilities struct { // The Linux capabilities for the container that have been added to the default // configuration provided by Docker. This parameter maps to CapAdd in the Create - // a container (https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) - // section of the Docker Remote API (https://docs.docker.com/engine/api/v1.35/) + // a container (https://docs.docker.com/engine/reference/api/docker_remote_api_v1.27/#create-a-container) + // section of the Docker Remote API (https://docs.docker.com/engine/reference/api/docker_remote_api_v1.27/) // and the --cap-add option to docker run (https://docs.docker.com/engine/reference/run/). // // If you are using tasks that use the Fargate launch type, the add parameter @@ -7680,8 +6983,8 @@ type KernelCapabilities struct { // The Linux capabilities for the container that have been removed from the // default configuration provided by Docker. This parameter maps to CapDrop - // in the Create a container (https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) - // section of the Docker Remote API (https://docs.docker.com/engine/api/v1.35/) + // in the Create a container (https://docs.docker.com/engine/reference/api/docker_remote_api_v1.27/#create-a-container) + // section of the Docker Remote API (https://docs.docker.com/engine/reference/api/docker_remote_api_v1.27/) // and the --cap-drop option to docker run (https://docs.docker.com/engine/reference/run/). // // Valid values: "ALL" | "AUDIT_CONTROL" | "AUDIT_WRITE" | "BLOCK_SUSPEND" | @@ -7717,15 +7020,15 @@ func (s *KernelCapabilities) SetDrop(v []*string) *KernelCapabilities { return s } -// A key-value pair object. +// A key and value pair object. type KeyValuePair struct { _ struct{} `type:"structure"` - // The name of the key-value pair. For environment variables, this is the name + // The name of the key value pair. For environment variables, this is the name // of the environment variable. Name *string `locationName:"name" type:"string"` - // The value of the key-value pair. For environment variables, this is the value + // The value of the key value pair. For environment variables, this is the value // of the environment variable. Value *string `locationName:"value" type:"string"` } @@ -7764,8 +7067,8 @@ type LinuxParameters struct { Capabilities *KernelCapabilities `locationName:"capabilities" type:"structure"` // Any host devices to expose to the container. This parameter maps to Devices - // in the Create a container (https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) - // section of the Docker Remote API (https://docs.docker.com/engine/api/v1.35/) + // in the Create a container (https://docs.docker.com/engine/reference/api/docker_remote_api_v1.27/#create-a-container) + // section of the Docker Remote API (https://docs.docker.com/engine/reference/api/docker_remote_api_v1.27/) // and the --device option to docker run (https://docs.docker.com/engine/reference/run/). // // If you are using tasks that use the Fargate launch type, the devices parameter @@ -7777,7 +7080,7 @@ type LinuxParameters struct { // This parameter requires version 1.25 of the Docker Remote API or greater // on your container instance. To check the Docker Remote API version on your // container instance, log in to your container instance and run the following - // command: sudo docker version --format '{{.Server.APIVersion}}' + // command: sudo docker version | grep "Server API version" InitProcessEnabled *bool `locationName:"initProcessEnabled" type:"boolean"` // The value for the size (in MiB) of the /dev/shm volume. This parameter maps @@ -7865,127 +7168,6 @@ func (s *LinuxParameters) SetTmpfs(v []*Tmpfs) *LinuxParameters { return s } -type ListAccountSettingsInput struct { - _ struct{} `type:"structure"` - - // Specifies whether to return the effective settings. If true, the account - // settings for the root user or the default setting for the principalArn. If - // false, the account settings for the principalArn are returned if they are - // set. Otherwise, no account settings are returned. - EffectiveSettings *bool `locationName:"effectiveSettings" type:"boolean"` - - // The maximum number of account setting results returned by ListAccountSettings - // in paginated output. When this parameter is used, ListAccountSettings 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 ListAccountSettings request with the returned nextToken value. This - // value can be between 1 and 10. If this parameter is not used, then ListAccountSettings - // returns up to 10 results and a nextToken value if applicable. - MaxResults *int64 `locationName:"maxResults" type:"integer"` - - // The resource name you want to list the account settings for. - Name *string `locationName:"name" type:"string" enum:"SettingName"` - - // The nextToken value returned from a previous paginated ListAccountSettings - // 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 token should be treated as an opaque identifier that is only used to - // retrieve the next items in a list and not for other programmatic purposes. - NextToken *string `locationName:"nextToken" type:"string"` - - // The ARN of the principal, which can be an IAM user, IAM role, or the root - // user. If this field is omitted, the account settings are listed only for - // the authenticated user. - PrincipalArn *string `locationName:"principalArn" type:"string"` - - // The value of the account settings with which to filter results. You must - // also specify an account setting name to use this parameter. - Value *string `locationName:"value" type:"string"` -} - -// String returns the string representation -func (s ListAccountSettingsInput) String() string { - return awsutil.Prettify(s) -} - -// GoString returns the string representation -func (s ListAccountSettingsInput) GoString() string { - return s.String() -} - -// SetEffectiveSettings sets the EffectiveSettings field's value. -func (s *ListAccountSettingsInput) SetEffectiveSettings(v bool) *ListAccountSettingsInput { - s.EffectiveSettings = &v - return s -} - -// SetMaxResults sets the MaxResults field's value. -func (s *ListAccountSettingsInput) SetMaxResults(v int64) *ListAccountSettingsInput { - s.MaxResults = &v - return s -} - -// SetName sets the Name field's value. -func (s *ListAccountSettingsInput) SetName(v string) *ListAccountSettingsInput { - s.Name = &v - return s -} - -// SetNextToken sets the NextToken field's value. -func (s *ListAccountSettingsInput) SetNextToken(v string) *ListAccountSettingsInput { - s.NextToken = &v - return s -} - -// SetPrincipalArn sets the PrincipalArn field's value. -func (s *ListAccountSettingsInput) SetPrincipalArn(v string) *ListAccountSettingsInput { - s.PrincipalArn = &v - return s -} - -// SetValue sets the Value field's value. -func (s *ListAccountSettingsInput) SetValue(v string) *ListAccountSettingsInput { - s.Value = &v - return s -} - -type ListAccountSettingsOutput struct { - _ struct{} `type:"structure"` - - // The nextToken value to include in a future ListAccountSettings request. When - // the results of a ListAccountSettings 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. - NextToken *string `locationName:"nextToken" type:"string"` - - // The account settings for the resource. - Settings []*Setting `locationName:"settings" type:"list"` -} - -// String returns the string representation -func (s ListAccountSettingsOutput) String() string { - return awsutil.Prettify(s) -} - -// GoString returns the string representation -func (s ListAccountSettingsOutput) GoString() string { - return s.String() -} - -// SetNextToken sets the NextToken field's value. -func (s *ListAccountSettingsOutput) SetNextToken(v string) *ListAccountSettingsOutput { - s.NextToken = &v - return s -} - -// SetSettings sets the Settings field's value. -func (s *ListAccountSettingsOutput) SetSettings(v []*Setting) *ListAccountSettingsOutput { - s.Settings = v - return s -} - type ListAttributesInput struct { _ struct{} `type:"structure"` @@ -8331,7 +7513,7 @@ type ListServicesInput struct { // 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 10 results + // 10. If this parameter is not used, then ListServices returns up to 10 results // and a nextToken value if applicable. MaxResults *int64 `locationName:"maxResults" type:"integer"` @@ -8727,14 +7909,14 @@ type ListTasksInput struct { // The task desired status with which to filter the ListTasks results. Specifying // a desiredStatus of STOPPED limits the results to tasks that Amazon ECS has - // set the desired status to STOPPED. This can be useful for debugging tasks + // set the desired status to STOPPED, which can be useful for debugging tasks // that are not starting properly or have died or finished. The default status // filter is RUNNING, which shows tasks that Amazon ECS has set the desired // status to RUNNING. // // Although you can filter results based on a desired status of PENDING, this - // does not return any results. Amazon ECS never sets the desired status of - // a task to that value (only a task's lastStatus may have a value of PENDING). + // does not return any results because Amazon ECS never sets the desired status + // of a task to that value (only a task's lastStatus may have a value of PENDING). DesiredStatus *string `locationName:"desiredStatus" type:"string" enum:"DesiredStatus"` // The name of the family with which to filter the ListTasks results. Specifying @@ -8872,24 +8054,12 @@ func (s *ListTasksOutput) SetTaskArns(v []*string) *ListTasksOutput { // Details on a load balancer that is used with a service. // -// If the service is using the ECS deployment controller, you are limited to -// one load balancer or target group. -// -// If the service is using the CODE_DEPLOY deployment controller, the service -// is required to use either an Application Load Balancer or Network Load Balancer. -// When you are creating an AWS CodeDeploy deployment group, you specify two -// target groups (referred to as a targetGroupPair). Each target group binds -// to a separate task set in the deployment. The load balancer can also have -// up to two listeners, a required listener for production traffic and an optional -// listener that allows you to test new revisions of the service before routing -// production traffic to it. -// // Services with tasks that use the awsvpc network mode (for example, those // with the Fargate launch type) only support Application Load Balancers and -// Network Load Balancers. Classic Load Balancers are not supported. Also, when +// Network Load Balancers; Classic Load Balancers are not supported. Also, when // you create any target groups for these services, you must choose ip as the -// target type, not instance. Tasks that use the awsvpc network mode are associated -// with an elastic network interface, not an Amazon EC2 instance. +// target type, not instance, because tasks that use the awsvpc network mode +// are associated with an elastic network interface, not an Amazon EC2 instance. type LoadBalancer struct { _ struct{} `type:"structure"` @@ -8907,10 +8077,7 @@ type LoadBalancer struct { LoadBalancerName *string `locationName:"loadBalancerName" type:"string"` // The full Amazon Resource Name (ARN) of the Elastic Load Balancing target - // group or groups associated with a service. For services using the ECS deployment - // controller, you are limited to one target group. For services using the CODE_DEPLOY - // deployment controller, you are required to define two target groups for the - // load balancer. + // group associated with a service. // // If your service's task definition uses the awsvpc network mode (which is // required for the Fargate launch type), you must choose ip as the target type, @@ -8959,9 +8126,9 @@ type LogConfiguration struct { // The log driver to use for the container. The valid values listed for this // parameter are log drivers that the Amazon ECS container agent can communicate - // with by default. If you are using the Fargate launch type, the only supported - // value is awslogs. For more information about using the awslogs driver, see - // Using the awslogs Log Driver (http://docs.aws.amazon.com/AmazonECS/latest/developerguide/using_awslogs.html) + // with by default. If using the Fargate launch type, the only supported value + // is awslogs. For more information about using the awslogs driver, see Using + // the awslogs Log Driver (http://docs.aws.amazon.com/AmazonECS/latest/developerguide/using_awslogs.html) // in the Amazon Elastic Container Service Developer Guide. // // If you have a custom driver that is not listed above that you would like @@ -8974,7 +8141,7 @@ type LogConfiguration struct { // This parameter requires version 1.18 of the Docker Remote API or greater // on your container instance. To check the Docker Remote API version on your // container instance, log in to your container instance and run the following - // command: sudo docker version --format '{{.Server.APIVersion}}' + // command: sudo docker version | grep "Server API version" // // LogDriver is a required field LogDriver *string `locationName:"logDriver" type:"string" required:"true" enum:"LogDriver"` @@ -8983,7 +8150,7 @@ type LogConfiguration struct { // version 1.19 of the Docker Remote API or greater on your container instance. // To check the Docker Remote API version on your container instance, log in // to your container instance and run the following command: sudo docker version - // --format '{{.Server.APIVersion}}' + // | grep "Server API version" Options map[string]*string `locationName:"options" type:"map"` } @@ -9034,8 +8201,7 @@ type MountPoint struct { // value is false. ReadOnly *bool `locationName:"readOnly" type:"boolean"` - // The name of the volume to mount. Must be a volume name referenced in the - // name parameter of task definition volume. + // The name of the volume to mount. SourceVolume *string `locationName:"sourceVolume" type:"string"` } @@ -9296,9 +8462,9 @@ func (s *PlacementStrategy) SetType(v string) *PlacementStrategy { // to send or receive traffic. Port mappings are specified as part of the container // definition. // -// If you are using containers in a task with the awsvpc or host network mode, -// exposed ports should be specified using containerPort. The hostPort can be -// left blank or it must be the same value as the containerPort. +// If using containers in a task with the awsvpc or host network mode, exposed +// ports should be specified using containerPort. The hostPort can be left blank +// or it must be the same value as the containerPort. // // After a task reaches the RUNNING status, manual and automatic host and container // port assignments are visible in the networkBindings section of DescribeTasks @@ -9309,33 +8475,33 @@ type PortMapping struct { // The port number on the container that is bound to the user-specified or automatically // assigned host port. // - // If you are using containers in a task with the awsvpc or host network mode, - // exposed ports should be specified using containerPort. + // If using containers in a task with the awsvpc or host network mode, exposed + // ports should be specified using containerPort. // - // If you are using containers in a task with the bridge network mode and you - // specify a container port and not a host port, your container automatically - // receives a host port in the ephemeral port range. For more information, see - // hostPort. Port mappings that are automatically assigned in this way do not - // count toward the 100 reserved ports limit of a container instance. + // If using containers in a task with the bridge network mode and you specify + // a container port and not a host port, your container automatically receives + // a host port in the ephemeral port range (for more information, see hostPort). + // Port mappings that are automatically assigned in this way do not count toward + // the 100 reserved ports limit of a container instance. ContainerPort *int64 `locationName:"containerPort" type:"integer"` // The port number on the container instance to reserve for your container. // - // If you are using containers in a task with the awsvpc or host network mode, - // the hostPort can either be left blank or set to the same value as the containerPort. + // If using containers in a task with the awsvpc or host network mode, the hostPort + // can either be left blank or set to the same value as the containerPort. // - // If you are using containers in a task with the bridge network mode, 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. + // If using containers in a task with the bridge network mode, 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 for Docker version 1.6.0 and later is listed - // on the instance under /proc/sys/net/ipv4/ip_local_port_range. If this kernel + // on the instance under /proc/sys/net/ipv4/ip_local_port_range; if this kernel // parameter is unavailable, the default ephemeral port range from 49153 through - // 65535 is used. Do not attempt to specify a host port in the ephemeral port - // range as these are reserved for automatic assignment. In general, ports below - // 32768 are outside of the ephemeral port range. + // 65535 is used. You should not attempt to specify a host port in the ephemeral + // port range as these are reserved for automatic assignment. In general, ports + // below 32768 are outside of the ephemeral port range. // // The default ephemeral port range from 49153 through 65535 is always used // for Docker versions before 1.6.0. @@ -9345,9 +8511,9 @@ type PortMapping struct { // 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. A container instance may have up to 100 reserved ports at a time, - // including the default reserved ports. Aautomatically assigned ports do not - // count toward the 100 reserved ports limit. + // output, and a container instance may have up to 100 reserved ports at a time, + // including the default reserved ports (automatically assigned ports do not + // count toward the 100 reserved ports limit). HostPort *int64 `locationName:"hostPort" type:"integer"` // The protocol used for the port mapping. Valid values are tcp and udp. The @@ -9386,25 +8552,11 @@ func (s *PortMapping) SetProtocol(v string) *PortMapping { type PutAccountSettingInput struct { _ struct{} `type:"structure"` - // The resource name for which to enable the new format. If serviceLongArnFormat - // is specified, the ARN for your Amazon ECS services is affected. If taskLongArnFormat - // is specified, the ARN and resource ID for your Amazon ECS tasks is affected. - // If containerInstanceLongArnFormat is specified, the ARN and resource ID for - // your Amazon ECS container instances is affected. - // // Name is a required field Name *string `locationName:"name" type:"string" required:"true" enum:"SettingName"` - // The ARN of the principal, which can be an IAM user, IAM role, or the root - // user. If you specify the root user, it modifies the ARN and resource ID format - // for all IAM users, IAM roles, and the root user of the account unless an - // IAM user or role explicitly overrides these settings for themselves. If this - // field is omitted, the setting are changed only for the authenticated user. PrincipalArn *string `locationName:"principalArn" type:"string"` - // The account setting value for the specified principal ARN. Accepted values - // are ENABLED and DISABLED. - // // Value is a required field Value *string `locationName:"value" type:"string" required:"true"` } @@ -9456,7 +8608,6 @@ func (s *PutAccountSettingInput) SetValue(v string) *PutAccountSettingInput { type PutAccountSettingOutput struct { _ struct{} `type:"structure"` - // The current account setting for a resource. Setting *Setting `locationName:"setting" type:"structure"` } @@ -9585,10 +8736,6 @@ type RegisterContainerInstanceInput struct { // curl http://169.254.169.254/latest/dynamic/instance-identity/signature/ InstanceIdentityDocumentSignature *string `locationName:"instanceIdentityDocumentSignature" type:"string"` - // The metadata that you apply to the container instance to help you categorize - // and organize them. Each tag consists of a key and an optional value, both - // of which you define. Tag keys can have a maximum character length of 128 - // characters, and tag values can have a maximum length of 256 characters. Tags []*Tag `locationName:"tags" type:"list"` // The resources available on the instance. @@ -9733,12 +8880,12 @@ type RegisterTaskDefinitionInput struct { // Task-level CPU and memory parameters are ignored for Windows containers. // We recommend specifying container-level resources for Windows containers. // - // If you are using the EC2 launch type, this field is optional. Supported values - // are between 128 CPU units (0.125 vCPUs) and 10240 CPU units (10 vCPUs). + // If using the EC2 launch type, this field is optional. Supported values are + // between 128 CPU units (0.125 vCPUs) and 10240 CPU units (10 vCPUs). // - // If you are using the Fargate launch type, this field is required and you - // must use one of the following values, which determines your range of supported - // values for the memory parameter: + // If using the Fargate launch type, this field is required and you must use + // one of the following values, which determines your range of supported values + // for the memory parameter: // // * 256 (.25 vCPU) - Available memory values: 512 (0.5 GB), 1024 (1 GB), // 2048 (2 GB) @@ -9768,35 +8915,6 @@ type RegisterTaskDefinitionInput struct { // Family is a required field Family *string `locationName:"family" type:"string" required:"true"` - // The IPC resource namespace to use for the containers in the task. The valid - // values are host, task, or none. If host is specified, then all containers - // within the tasks that specified the host IPC mode on the same container instance - // share the same IPC resources with the host Amazon EC2 instance. If task is - // specified, all containers within the specified task share the same IPC resources. - // If none is specified, then IPC resources within the containers of a task - // are private and not shared with other containers in a task or on the container - // instance. If no value is specified, then the IPC resource namespace sharing - // depends on the Docker daemon setting on the container instance. For more - // information, see IPC settings (https://docs.docker.com/engine/reference/run/#ipc-settings---ipc) - // in the Docker run reference. - // - // If the host IPC mode is used, be aware that there is a heightened risk of - // undesired IPC namespace expose. For more information, see Docker security - // (https://docs.docker.com/engine/security/security/). - // - // If you are setting namespaced kernel parameters using systemControls for - // the containers in the task, the following will apply to your IPC resource - // namespace. For more information, see System Controls (http://docs.aws.amazon.com/AmazonECS/latest/developerguide/task_definition_parameters.html) - // in the Amazon Elastic Container Service Developer Guide. - // - // * For tasks that use the host IPC mode, IPC namespace related systemControls - // are not supported. - // - // * For tasks that use the task IPC mode, IPC namespace related systemControls - // will apply to all containers within a task. - // - // This parameter is not supported for Windows containers or tasks using the - // Fargate launch type. IpcMode *string `locationName:"ipcMode" type:"string" enum:"IpcMode"` // The amount of memory (in MiB) used by the task. It can be expressed as an @@ -9831,71 +8949,47 @@ type RegisterTaskDefinitionInput struct { // The Docker networking mode to use for the containers in the task. The valid // values are none, bridge, awsvpc, and host. The default Docker network mode - // is bridge. If you are using the Fargate launch type, the awsvpc network mode - // is required. If you are using the EC2 launch type, any network mode can be - // used. If the network mode is set to none, you cannot specify port mappings - // in your container definitions, and the tasks containers do not have external - // connectivity. The host and awsvpc network modes offer the highest networking - // performance for containers because they use the EC2 network stack instead - // of the virtualized network stack provided by the bridge mode. + // is bridge. If using the Fargate launch type, the awsvpc network mode is required. + // If using the EC2 launch type, any network mode can be used. If the network + // mode is set to none, you can't specify port mappings in your container definitions, + // and the task's containers do not have external connectivity. The host and + // awsvpc network modes offer the highest networking performance for containers + // because they use the EC2 network stack instead of the virtualized network + // stack provided by the bridge mode. // // With the host and awsvpc network modes, exposed container ports are mapped // directly to the corresponding host port (for the host network mode) or the // attached elastic network interface port (for the awsvpc network mode), so // you cannot take advantage of dynamic host port mappings. // - // If the network mode is awsvpc, the task is allocated an elastic network interface, - // and you must specify a NetworkConfiguration value when you create a service - // or run a task with the task definition. For more information, see Task Networking + // If the network mode is awsvpc, the task is allocated an Elastic Network Interface, + // and you must specify a NetworkConfiguration when you create a service or + // run a task with the task definition. For more information, see Task Networking // (http://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-networking.html) // in the Amazon Elastic Container Service Developer Guide. // - // Currently, only Amazon ECS-optimized AMIs, other Amazon Linux variants with - // the ecs-init package, or AWS Fargate infrastructure support the awsvpc network - // mode. - // - // If the network mode is host, you cannot run multiple instantiations of the + // If the network mode is host, you can't run multiple instantiations of the // same task on a single container instance when port mappings are used. // // Docker for Windows uses different network modes than Docker for Linux. When // you register a task definition with Windows containers, you must not specify - // a network mode. If you use the console to register a task definition with - // Windows containers, you must choose the network mode object. + // a network mode. // // For more information, see Network settings (https://docs.docker.com/engine/reference/run/#network-settings) // in the Docker run reference. NetworkMode *string `locationName:"networkMode" type:"string" enum:"NetworkMode"` - // The process namespace to use for the containers in the task. The valid values - // are host or task. If host is specified, then all containers within the tasks - // that specified the host PID mode on the same container instance share the - // same IPC resources with the host Amazon EC2 instance. If task is specified, - // all containers within the specified task share the same process namespace. - // If no value is specified, the default is a private namespace. For more information, - // see PID settings (https://docs.docker.com/engine/reference/run/#pid-settings---pid) - // in the Docker run reference. - // - // If the host PID mode is used, be aware that there is a heightened risk of - // undesired process namespace expose. For more information, see Docker security - // (https://docs.docker.com/engine/security/security/). - // - // This parameter is not supported for Windows containers or tasks using the - // Fargate launch type. PidMode *string `locationName:"pidMode" type:"string" enum:"PidMode"` // An array of placement constraint objects to use for the task. You can specify // a maximum of 10 constraints per task (this limit includes constraints in - // the task definition and those specified at runtime). + // the task definition and those specified at run time). PlacementConstraints []*TaskDefinitionPlacementConstraint `locationName:"placementConstraints" type:"list"` // The launch type required by the task. If no value is specified, it defaults // to EC2. RequiresCompatibilities []*string `locationName:"requiresCompatibilities" type:"list"` - // The metadata that you apply to the task definition to help you categorize - // and organize them. Each tag consists of a key and an optional value, both - // of which you define. Tag keys can have a maximum character length of 128 - // characters, and tag values can have a maximum length of 256 characters. Tags []*Tag `locationName:"tags" type:"list"` // The short name or full Amazon Resource Name (ARN) of the IAM role that containers @@ -10037,9 +9131,6 @@ func (s *RegisterTaskDefinitionInput) SetVolumes(v []*Volume) *RegisterTaskDefin type RegisterTaskDefinitionOutput struct { _ struct{} `type:"structure"` - // The list of tags associated with the task definition. - Tags []*Tag `locationName:"tags" type:"list"` - // The full description of the registered task definition. TaskDefinition *TaskDefinition `locationName:"taskDefinition" type:"structure"` } @@ -10054,12 +9145,6 @@ func (s RegisterTaskDefinitionOutput) GoString() string { return s.String() } -// SetTags sets the Tags field's value. -func (s *RegisterTaskDefinitionOutput) SetTags(v []*Tag) *RegisterTaskDefinitionOutput { - s.Tags = v - return s -} - // SetTaskDefinition sets the TaskDefinition field's value. func (s *RegisterTaskDefinitionOutput) SetTaskDefinition(v *TaskDefinition) *RegisterTaskDefinitionOutput { s.TaskDefinition = v @@ -10070,13 +9155,8 @@ func (s *RegisterTaskDefinitionOutput) SetTaskDefinition(v *TaskDefinition) *Reg type RepositoryCredentials struct { _ struct{} `type:"structure"` - // The Amazon Resource Name (ARN) of the secret containing the private repository - // credentials. - // - // When you are using the Amazon ECS API, AWS CLI, or AWS SDK, if the secret - // exists in the same Region as the task that you are launching then you can - // use either the full ARN or the name of the secret. When you are using the - // AWS Management Console, you must specify the full ARN of the secret. + // The Amazon Resource Name (ARN) or name of the secret containing the private + // repository credentials. // // CredentialsParameter is a required field CredentialsParameter *string `locationName:"credentialsParameter" type:"string" required:"true"` @@ -10196,23 +9276,16 @@ type RunTaskInput struct { // You can specify up to 10 tasks per call. Count *int64 `locationName:"count" type:"integer"` - // Specifies whether to enable Amazon ECS managed tags for the task. For more - // information, see Tagging Your Amazon ECS Resources (http://docs.aws.amazon.com/AmazonECS/latest/developerguide/Using_Tags.html) - // in the Amazon Elastic Container Service Developer Guide. - EnableECSManagedTags *bool `locationName:"enableECSManagedTags" type:"boolean"` - // The name of the task group to associate with the task. The default value // is the family name of the task definition (for example, family:my-family-name). Group *string `locationName:"group" type:"string"` - // The launch type on which to run your task. For more information, see Amazon - // ECS Launch Types (http://docs.aws.amazon.com/AmazonECS/latest/developerguide/launch_types.html) - // in the Amazon Elastic Container Service Developer Guide. + // The launch type on which to run your task. LaunchType *string `locationName:"launchType" type:"string" enum:"LaunchType"` // The network configuration for the task. This parameter is required for task - // definitions that use the awsvpc network mode to receive their own elastic - // network interface, and it is not supported for other network modes. For more + // definitions that use the awsvpc network mode to receive their own Elastic + // Network Interface, and it is not supported for other network modes. For more // information, see Task Networking (http://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-networking.html) // in the Amazon Elastic Container Service Developer Guide. NetworkConfiguration *NetworkConfiguration `locationName:"networkConfiguration" type:"structure"` @@ -10231,25 +9304,18 @@ type RunTaskInput struct { // An array of placement constraint objects to use for the task. You can specify // up to 10 constraints per task (including constraints in the task definition - // and those specified at runtime). + // and those specified at run time). PlacementConstraints []*PlacementConstraint `locationName:"placementConstraints" type:"list"` // The placement strategy objects to use for the task. You can specify a maximum // of five strategy rules per task. PlacementStrategy []*PlacementStrategy `locationName:"placementStrategy" type:"list"` - // The platform version the task should run. A platform version is only specified - // for tasks using the Fargate launch type. If one is not specified, the LATEST - // platform version is used by default. For more information, see AWS Fargate - // Platform Versions (http://docs.aws.amazon.com/AmazonECS/latest/developerguide/platform_versions.html) - // in the Amazon Elastic Container Service Developer Guide. + // The platform version on which to run your task. If one is not specified, + // the latest version is used by default. PlatformVersion *string `locationName:"platformVersion" type:"string"` - // Specifies whether to propagate the tags from the task definition or the service - // to the task. If no value is specified, the tags are not propagated. - PropagateTags *string `locationName:"propagateTags" type:"string" enum:"PropagateTags"` - - // An optional tag specified when a task is started. For example, if you automatically + // 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 @@ -10260,12 +9326,6 @@ type RunTaskInput struct { // contains the deployment ID of the service that starts it. StartedBy *string `locationName:"startedBy" type:"string"` - // The metadata that you apply to the task to help you categorize and organize - // them. Each tag consists of a key and an optional value, both of which you - // define. Tag keys can have a maximum character length of 128 characters, and - // tag values can have a maximum length of 256 characters. - Tags []*Tag `locationName:"tags" type:"list"` - // The family and revision (family:revision) or full ARN of the task definition // to run. If a revision is not specified, the latest ACTIVE revision is used. // @@ -10294,16 +9354,6 @@ func (s *RunTaskInput) Validate() error { invalidParams.AddNested("NetworkConfiguration", err.(request.ErrInvalidParams)) } } - if s.Tags != nil { - for i, v := range s.Tags { - if v == nil { - continue - } - if err := v.Validate(); err != nil { - invalidParams.AddNested(fmt.Sprintf("%s[%v]", "Tags", i), err.(request.ErrInvalidParams)) - } - } - } if invalidParams.Len() > 0 { return invalidParams @@ -10323,12 +9373,6 @@ func (s *RunTaskInput) SetCount(v int64) *RunTaskInput { return s } -// SetEnableECSManagedTags sets the EnableECSManagedTags field's value. -func (s *RunTaskInput) SetEnableECSManagedTags(v bool) *RunTaskInput { - s.EnableECSManagedTags = &v - return s -} - // SetGroup sets the Group field's value. func (s *RunTaskInput) SetGroup(v string) *RunTaskInput { s.Group = &v @@ -10371,24 +9415,12 @@ func (s *RunTaskInput) SetPlatformVersion(v string) *RunTaskInput { return s } -// SetPropagateTags sets the PropagateTags field's value. -func (s *RunTaskInput) SetPropagateTags(v string) *RunTaskInput { - s.PropagateTags = &v - return s -} - // SetStartedBy sets the StartedBy field's value. func (s *RunTaskInput) SetStartedBy(v string) *RunTaskInput { s.StartedBy = &v return s } -// SetTags sets the Tags field's value. -func (s *RunTaskInput) SetTags(v []*Tag) *RunTaskInput { - s.Tags = v - return s -} - // SetTaskDefinition sets the TaskDefinition field's value. func (s *RunTaskInput) SetTaskDefinition(v string) *RunTaskInput { s.TaskDefinition = &v @@ -10483,19 +9515,13 @@ type Service struct { // The Amazon Resource Name (ARN) of the cluster that hosts the service. ClusterArn *string `locationName:"clusterArn" type:"string"` - // The Unix timestamp for when the service was created. + // The Unix time stamp for when the service was created. CreatedAt *time.Time `locationName:"createdAt" type:"timestamp"` - // The principal that created the service. - CreatedBy *string `locationName:"createdBy" type:"string"` - // Optional deployment parameters that control how many tasks run during the // deployment and the ordering of stopping and starting tasks. DeploymentConfiguration *DeploymentConfiguration `locationName:"deploymentConfiguration" type:"structure"` - // The deployment controller type the service is using. - DeploymentController *DeploymentController `locationName:"deploymentController" type:"structure"` - // The current state of deployments for the service. Deployments []*Deployment `locationName:"deployments" type:"list"` @@ -10504,11 +9530,6 @@ type Service struct { // CreateService, and it can be modified with UpdateService. DesiredCount *int64 `locationName:"desiredCount" type:"integer"` - // Specifies whether to enable Amazon ECS managed tags for the tasks in the - // service. For more information, see Tagging Your Amazon ECS Resources (http://docs.aws.amazon.com/AmazonECS/latest/developerguide/Using_Tags.html) - // in the Amazon Elastic Container Service Developer Guide. - EnableECSManagedTags *bool `locationName:"enableECSManagedTags" type:"boolean"` - // The event stream for your service. A maximum of 100 of the latest events // are displayed. Events []*ServiceEvent `locationName:"events" type:"list"` @@ -10518,9 +9539,7 @@ type Service struct { // started. HealthCheckGracePeriodSeconds *int64 `locationName:"healthCheckGracePeriodSeconds" type:"integer"` - // The launch type on which your service is running. For more information, see - // Amazon ECS Launch Types (http://docs.aws.amazon.com/AmazonECS/latest/developerguide/launch_types.html) - // in the Amazon Elastic Container Service Developer Guide. + // The launch type on which your service is running. LaunchType *string `locationName:"launchType" type:"string" enum:"LaunchType"` // A list of Elastic Load Balancing load balancer objects, containing the load @@ -10529,10 +9548,10 @@ type Service struct { // // Services with tasks that use the awsvpc network mode (for example, those // with the Fargate launch type) only support Application Load Balancers and - // Network Load Balancers. Classic Load Balancers are not supported. Also, when + // Network Load Balancers; Classic Load Balancers are not supported. Also, when // you create any target groups for these services, you must choose ip as the - // target type, not instance. Tasks that use the awsvpc network mode are associated - // with an elastic network interface, not an Amazon EC2 instance. + // target type, not instance, because tasks that use the awsvpc network mode + // are associated with an elastic network interface, not an Amazon EC2 instance. LoadBalancers []*LoadBalancer `locationName:"loadBalancers" type:"list"` // The VPC subnet and security group configuration for tasks that receive their @@ -10548,17 +9567,11 @@ type Service struct { // The placement strategy that determines how tasks for the service are placed. PlacementStrategy []*PlacementStrategy `locationName:"placementStrategy" type:"list"` - // The platform version on which your tasks in the service are running. A platform - // version is only specified for tasks using the Fargate launch type. If one - // is not specified, the LATEST platform version is used by default. For more - // information, see AWS Fargate Platform Versions (http://docs.aws.amazon.com/AmazonECS/latest/developerguide/platform_versions.html) + // The platform version on which your task is running. For more information, + // see AWS Fargate Platform Versions (http://docs.aws.amazon.com/AmazonECS/latest/developerguide/platform_versions.html) // in the Amazon Elastic Container Service Developer Guide. PlatformVersion *string `locationName:"platformVersion" type:"string"` - // Specifies whether to propagate the tags from the task definition or the service - // to the task. If no value is specified, the tags are not propagated. - PropagateTags *string `locationName:"propagateTags" type:"string" enum:"PropagateTags"` - // The ARN of the IAM role associated with the service that allows the Amazon // ECS container agent to register container instances with an Elastic Load // Balancing load balancer. @@ -10568,7 +9581,7 @@ type Service struct { RunningCount *int64 `locationName:"runningCount" type:"integer"` // The scheduling strategy to use for the service. For more information, see - // Services (http://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs_services.html). + // Services (http://docs.aws.amazon.com/AmazonECS/latest/developerguideecs_services.html). // // There are two service scheduler strategies available: // @@ -10578,8 +9591,8 @@ type Service struct { // and constraints to customize task placement decisions. // // * DAEMON-The daemon scheduling strategy deploys exactly one task on each - // container instance in your cluster. When you are using this strategy, - // do not specify a desired number of tasks or any task placement strategies. + // container instance in your cluster. When using this strategy, do not specify + // a desired number of tasks or any task placement strategies. // // Fargate tasks do not support the DAEMON scheduling strategy. SchedulingStrategy *string `locationName:"schedulingStrategy" type:"string" enum:"SchedulingStrategy"` @@ -10600,21 +9613,10 @@ type Service struct { // The status of the service. The valid values are ACTIVE, DRAINING, or INACTIVE. Status *string `locationName:"status" type:"string"` - // The metadata that you apply to the service to help you categorize and organize - // them. Each tag consists of a key and an optional value, both of which you - // define. Tag keys can have a maximum character length of 128 characters, and - // tag values can have a maximum length of 256 characters. - Tags []*Tag `locationName:"tags" type:"list"` - // 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. TaskDefinition *string `locationName:"taskDefinition" type:"string"` - - // Information about a set of Amazon ECS tasks in an AWS CodeDeploy deployment. - // An Amazon ECS task set includes details such as the desired number of tasks, - // how many tasks are running, and whether the task set serves production traffic. - TaskSets []*TaskSet `locationName:"taskSets" type:"list"` } // String returns the string representation @@ -10639,24 +9641,12 @@ func (s *Service) SetCreatedAt(v time.Time) *Service { return s } -// SetCreatedBy sets the CreatedBy field's value. -func (s *Service) SetCreatedBy(v string) *Service { - s.CreatedBy = &v - return s -} - // SetDeploymentConfiguration sets the DeploymentConfiguration field's value. func (s *Service) SetDeploymentConfiguration(v *DeploymentConfiguration) *Service { s.DeploymentConfiguration = v return s } -// SetDeploymentController sets the DeploymentController field's value. -func (s *Service) SetDeploymentController(v *DeploymentController) *Service { - s.DeploymentController = v - return s -} - // SetDeployments sets the Deployments field's value. func (s *Service) SetDeployments(v []*Deployment) *Service { s.Deployments = v @@ -10669,12 +9659,6 @@ func (s *Service) SetDesiredCount(v int64) *Service { return s } -// SetEnableECSManagedTags sets the EnableECSManagedTags field's value. -func (s *Service) SetEnableECSManagedTags(v bool) *Service { - s.EnableECSManagedTags = &v - return s -} - // SetEvents sets the Events field's value. func (s *Service) SetEvents(v []*ServiceEvent) *Service { s.Events = v @@ -10729,12 +9713,6 @@ func (s *Service) SetPlatformVersion(v string) *Service { return s } -// SetPropagateTags sets the PropagateTags field's value. -func (s *Service) SetPropagateTags(v string) *Service { - s.PropagateTags = &v - return s -} - // SetRoleArn sets the RoleArn field's value. func (s *Service) SetRoleArn(v string) *Service { s.RoleArn = &v @@ -10777,29 +9755,17 @@ func (s *Service) SetStatus(v string) *Service { return s } -// SetTags sets the Tags field's value. -func (s *Service) SetTags(v []*Tag) *Service { - s.Tags = v - return s -} - // SetTaskDefinition sets the TaskDefinition field's value. func (s *Service) SetTaskDefinition(v string) *Service { s.TaskDefinition = &v return s } -// SetTaskSets sets the TaskSets field's value. -func (s *Service) SetTaskSets(v []*TaskSet) *Service { - s.TaskSets = v - return s -} - // Details on an event associated with a service. type ServiceEvent struct { _ struct{} `type:"structure"` - // The Unix timestamp for when the event was triggered. + // The Unix time stamp for when the event was triggered. CreatedAt *time.Time `locationName:"createdAt" type:"timestamp"` // The ID string of the event. @@ -10860,7 +9826,7 @@ type ServiceRegistry struct { ContainerPort *int64 `locationName:"containerPort" type:"integer"` // The port value used if your service discovery service specified an SRV record. - // This field may be used if both the awsvpc network mode and SRV records are + // This field is required if both the awsvpc network mode and SRV records are // used. Port *int64 `locationName:"port" type:"integer"` @@ -10904,21 +9870,13 @@ func (s *ServiceRegistry) SetRegistryArn(v string) *ServiceRegistry { return s } -// The current account setting for a resource. type Setting struct { _ struct{} `type:"structure"` - // The account resource name. Name *string `locationName:"name" type:"string" enum:"SettingName"` - // The ARN of the principal, which can be an IAM user, IAM role, or the root - // user. If this field is omitted, the authenticated user is assumed. PrincipalArn *string `locationName:"principalArn" type:"string"` - // The current account setting for the resource name. If ENABLED, then the resource - // will receive the new Amazon Resource Name (ARN) and resource identifier (ID) - // format. If DISABLED, then the resource will receive the old Amazon Resource - // Name (ARN) and resource identifier (ID) format. Value *string `locationName:"value" type:"string"` } @@ -10965,11 +9923,6 @@ type StartTaskInput struct { // ContainerInstances is a required field ContainerInstances []*string `locationName:"containerInstances" type:"list" required:"true"` - // Specifies whether to enable Amazon ECS managed tags for the task. For more - // information, see Tagging Your Amazon ECS Resources (http://docs.aws.amazon.com/AmazonECS/latest/developerguide/Using_Tags.html) - // in the Amazon Elastic Container Service Developer Guide. - EnableECSManagedTags *bool `locationName:"enableECSManagedTags" type:"boolean"` - // The name of the task group to associate with the task. The default value // is the family name of the task definition (for example, family:my-family-name). Group *string `locationName:"group" type:"string"` @@ -10990,11 +9943,7 @@ type StartTaskInput struct { // the JSON formatting characters of the override structure. Overrides *TaskOverride `locationName:"overrides" type:"structure"` - // Specifies whether to propagate the tags from the task definition or the service - // to the task. If no value is specified, the tags are not propagated. - PropagateTags *string `locationName:"propagateTags" type:"string" enum:"PropagateTags"` - - // An optional tag specified when a task is started. For example, if you automatically + // 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 @@ -11005,12 +9954,6 @@ type StartTaskInput struct { // contains the deployment ID of the service that starts it. StartedBy *string `locationName:"startedBy" type:"string"` - // The metadata that you apply to the task to help you categorize and organize - // them. Each tag consists of a key and an optional value, both of which you - // define. Tag keys can have a maximum character length of 128 characters, and - // tag values can have a maximum length of 256 characters. - Tags []*Tag `locationName:"tags" type:"list"` - // The family and revision (family:revision) or full ARN of the task definition // to start. If a revision is not specified, the latest ACTIVE revision is used. // @@ -11042,16 +9985,6 @@ func (s *StartTaskInput) Validate() error { invalidParams.AddNested("NetworkConfiguration", err.(request.ErrInvalidParams)) } } - if s.Tags != nil { - for i, v := range s.Tags { - if v == nil { - continue - } - if err := v.Validate(); err != nil { - invalidParams.AddNested(fmt.Sprintf("%s[%v]", "Tags", i), err.(request.ErrInvalidParams)) - } - } - } if invalidParams.Len() > 0 { return invalidParams @@ -11071,12 +10004,6 @@ func (s *StartTaskInput) SetContainerInstances(v []*string) *StartTaskInput { return s } -// SetEnableECSManagedTags sets the EnableECSManagedTags field's value. -func (s *StartTaskInput) SetEnableECSManagedTags(v bool) *StartTaskInput { - s.EnableECSManagedTags = &v - return s -} - // SetGroup sets the Group field's value. func (s *StartTaskInput) SetGroup(v string) *StartTaskInput { s.Group = &v @@ -11095,24 +10022,12 @@ func (s *StartTaskInput) SetOverrides(v *TaskOverride) *StartTaskInput { return s } -// SetPropagateTags sets the PropagateTags field's value. -func (s *StartTaskInput) SetPropagateTags(v string) *StartTaskInput { - s.PropagateTags = &v - return s -} - // SetStartedBy sets the StartedBy field's value. func (s *StartTaskInput) SetStartedBy(v string) *StartTaskInput { s.StartedBy = &v return s } -// SetTags sets the Tags field's value. -func (s *StartTaskInput) SetTags(v []*Tag) *StartTaskInput { - s.Tags = v - return s -} - // SetTaskDefinition sets the TaskDefinition field's value. func (s *StartTaskInput) SetTaskDefinition(v string) *StartTaskInput { s.TaskDefinition = &v @@ -11350,13 +10265,13 @@ type SubmitTaskStateChangeInput struct { // Any containers associated with the state change request. Containers []*ContainerStateChange `locationName:"containers" type:"list"` - // The Unix timestamp for when the task execution stopped. + // The Unix time stamp for when the task execution stopped. ExecutionStoppedAt *time.Time `locationName:"executionStoppedAt" type:"timestamp"` - // The Unix timestamp for when the container image pull began. + // The Unix time stamp for when the container image pull began. PullStartedAt *time.Time `locationName:"pullStartedAt" type:"timestamp"` - // The Unix timestamp for when the container image pull completed. + // The Unix time stamp for when the container image pull completed. PullStoppedAt *time.Time `locationName:"pullStoppedAt" type:"timestamp"` // The reason for the state change request. @@ -11476,30 +10391,11 @@ func (s *SubmitTaskStateChangeOutput) SetAcknowledgment(v string) *SubmitTaskSta return s } -// A list of namespaced kernel parameters to set in the container. This parameter -// maps to Sysctls in the Create a container (https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) -// section of the Docker Remote API (https://docs.docker.com/engine/api/v1.35/) -// and the --sysctl option to docker run (https://docs.docker.com/engine/reference/run/). -// -// It is not recommended that you specify network-related systemControls parameters -// for multiple containers in a single task that also uses either the awsvpc -// or host network mode for the following reasons: -// -// * For tasks that use the awsvpc network mode, if you set systemControls -// for any container, it applies to all containers in the task. If you set -// different systemControls for multiple containers in a single task, the -// container that is started last determines which systemControls take effect. -// -// * For tasks that use the host network mode, the systemControls parameter -// applies to the container instance's kernel parameter as well as that of -// all containers of any tasks running on that container instance. type SystemControl struct { _ struct{} `type:"structure"` - // The namespaced kernel parameter for which to set a value. Namespace *string `locationName:"namespace" type:"string"` - // The value for the namespaced kernel parameter specified in namespace. Value *string `locationName:"value" type:"string"` } @@ -11525,19 +10421,11 @@ func (s *SystemControl) SetValue(v string) *SystemControl { return s } -// The metadata that you apply to a resource to help you categorize and organize -// them. Each tag consists of a key and an optional value, both of which you -// define. Tag keys can have a maximum character length of 128 characters, and -// tag values can have a maximum length of 256 characters. type Tag struct { _ struct{} `type:"structure"` - // One part of a key-value pair that make up a tag. A key is a general label - // that acts like a category for more specific tag values. Key *string `locationName:"key" min:"1" type:"string"` - // The optional part of a key-value pair that make up a tag. A value acts as - // a descriptor within a tag category (key). Value *string `locationName:"value" type:"string"` } @@ -11576,91 +10464,11 @@ func (s *Tag) SetValue(v string) *Tag { return s } -type TagResourceInput struct { - _ struct{} `type:"structure"` - - // The Amazon Resource Name (ARN) of the resource to which to add tags. Currently, - // the supported resources are Amazon ECS tasks, services, task definitions, - // clusters, and container instances. - // - // ResourceArn is a required field - ResourceArn *string `locationName:"resourceArn" type:"string" required:"true"` - - // The tags to add to the resource. A tag is an array of key-value pairs. Tag - // keys can have a maximum character length of 128 characters, and tag values - // can have a maximum length of 256 characters. - // - // Tags is a required field - Tags []*Tag `locationName:"tags" type:"list" required:"true"` -} - -// String returns the string representation -func (s TagResourceInput) String() string { - return awsutil.Prettify(s) -} - -// GoString returns the string representation -func (s TagResourceInput) GoString() string { - return s.String() -} - -// Validate inspects the fields of the type to determine if they are valid. -func (s *TagResourceInput) Validate() error { - invalidParams := request.ErrInvalidParams{Context: "TagResourceInput"} - if s.ResourceArn == nil { - invalidParams.Add(request.NewErrParamRequired("ResourceArn")) - } - if s.Tags == nil { - invalidParams.Add(request.NewErrParamRequired("Tags")) - } - if s.Tags != nil { - for i, v := range s.Tags { - if v == nil { - continue - } - if err := v.Validate(); err != nil { - invalidParams.AddNested(fmt.Sprintf("%s[%v]", "Tags", i), err.(request.ErrInvalidParams)) - } - } - } - - if invalidParams.Len() > 0 { - return invalidParams - } - return nil -} - -// SetResourceArn sets the ResourceArn field's value. -func (s *TagResourceInput) SetResourceArn(v string) *TagResourceInput { - s.ResourceArn = &v - return s -} - -// SetTags sets the Tags field's value. -func (s *TagResourceInput) SetTags(v []*Tag) *TagResourceInput { - s.Tags = v - return s -} - -type TagResourceOutput struct { - _ struct{} `type:"structure"` -} - -// String returns the string representation -func (s TagResourceOutput) String() string { - return awsutil.Prettify(s) -} - -// GoString returns the string representation -func (s TagResourceOutput) GoString() string { - return s.String() -} - // Details on a task in a cluster. type Task struct { _ struct{} `type:"structure"` - // The Elastic Network Adapter associated with the task if the task uses the + // The elastic network adapter associated with the task if the task uses the // awsvpc network mode. Attachments []*Attachment `locationName:"attachments" type:"list"` @@ -11670,7 +10478,7 @@ type Task struct { // The connectivity status of a task. Connectivity *string `locationName:"connectivity" type:"string" enum:"Connectivity"` - // The Unix timestamp for when the task last went into CONNECTED status. + // The Unix time stamp for when the task last went into CONNECTED status. ConnectivityAt *time.Time `locationName:"connectivityAt" type:"timestamp"` // The ARN of the container instances that host the task. @@ -11679,18 +10487,17 @@ type Task struct { // The containers associated with the task. Containers []*Container `locationName:"containers" type:"list"` - // The number of CPU units used by the task as expressed in a task definition. - // It can be expressed as an integer using CPU units, for example 1024. It can - // also be expressed as a string using vCPUs, for example 1 vCPU or 1 vcpu. - // String values are converted to an integer indicating the CPU units when the - // task definition is registered. + // The number of CPU units used by the task. It can be expressed as an integer + // using CPU units, for example 1024, or as a string using vCPUs, for example + // 1 vCPU or 1 vcpu, in a task definition. String values are converted to an + // integer indicating the CPU units when the task definition is registered. // - // If you are using the EC2 launch type, this field is optional. Supported values - // are between 128 CPU units (0.125 vCPUs) and 10240 CPU units (10 vCPUs). + // If using the EC2 launch type, this field is optional. Supported values are + // between 128 CPU units (0.125 vCPUs) and 10240 CPU units (10 vCPUs). // - // If you are using the Fargate launch type, this field is required and you - // must use one of the following values, which determines your range of supported - // values for the memory parameter: + // If using the Fargate launch type, this field is required and you must use + // one of the following values, which determines your range of supported values + // for the memory parameter: // // * 256 (.25 vCPU) - Available memory values: 512 (0.5 GB), 1024 (1 GB), // 2048 (2 GB) @@ -11708,15 +10515,14 @@ type Task struct { // (30 GB) in increments of 1024 (1 GB) Cpu *string `locationName:"cpu" type:"string"` - // The Unix timestamp for when the task was created (the task entered the PENDING + // The Unix time stamp for when the task was created (the task entered the PENDING // state). CreatedAt *time.Time `locationName:"createdAt" type:"timestamp"` - // The desired status of the task. For more information, see Task Lifecycle - // (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task_life_cycle.html). + // The desired status of the task. DesiredStatus *string `locationName:"desiredStatus" type:"string"` - // The Unix timestamp for when the task execution stopped. + // The Unix time stamp for when the task execution stopped. ExecutionStoppedAt *time.Time `locationName:"executionStoppedAt" type:"timestamp"` // The name of the task group associated with the task. @@ -11735,26 +10541,22 @@ type Task struct { // override any Docker health checks that exist in the container image. HealthStatus *string `locationName:"healthStatus" type:"string" enum:"HealthStatus"` - // The last known status of the task. For more information, see Task Lifecycle - // (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task_life_cycle.html). + // The last known status of the task. LastStatus *string `locationName:"lastStatus" type:"string"` - // The launch type on which your task is running. For more information, see - // Amazon ECS Launch Types (http://docs.aws.amazon.com/AmazonECS/latest/developerguide/launch_types.html) - // in the Amazon Elastic Container Service Developer Guide. + // The launch type on which your task is running. LaunchType *string `locationName:"launchType" type:"string" enum:"LaunchType"` - // The amount of memory (in MiB) used by the task as expressed in a task definition. - // It can be expressed as an integer using MiB, for example 1024. It can also - // be expressed as a string using GB, for example 1GB or 1 GB. String values - // are converted to an integer indicating the MiB when the task definition is - // registered. + // The amount of memory (in MiB) used by the task. It can be expressed as an + // integer using MiB, for example 1024, or as a string using GB, for example + // 1GB or 1 GB, in a task definition. String values are converted to an integer + // indicating the MiB when the task definition is registered. // - // If you are using the EC2 launch type, this field is optional. + // If using the EC2 launch type, this field is optional. // - // If you are using the Fargate launch type, this field is required and you - // must use one of the following values, which determines your range of supported - // values for the cpu parameter: + // If using the Fargate launch type, this field is required and you must use + // one of the following values, which determines your range of supported values + // for the cpu parameter: // // * 512 (0.5 GB), 1024 (1 GB), 2048 (2 GB) - Available cpu values: 256 (.25 // vCPU) @@ -11775,20 +10577,18 @@ type Task struct { // One or more container overrides. Overrides *TaskOverride `locationName:"overrides" type:"structure"` - // The platform version on which your task is running. A platform version is - // only specified for tasks using the Fargate launch type. If one is not specified, - // the LATEST platform version is used by default. For more information, see - // AWS Fargate Platform Versions (http://docs.aws.amazon.com/AmazonECS/latest/developerguide/platform_versions.html) + // The platform version on which your task is running. For more information, + // see AWS Fargate Platform Versions (http://docs.aws.amazon.com/AmazonECS/latest/developerguide/platform_versions.html) // in the Amazon Elastic Container Service Developer Guide. PlatformVersion *string `locationName:"platformVersion" type:"string"` - // The Unix timestamp for when the container image pull began. + // The Unix time stamp for when the container image pull began. PullStartedAt *time.Time `locationName:"pullStartedAt" type:"timestamp"` - // The Unix timestamp for when the container image pull completed. + // The Unix time stamp for when the container image pull completed. PullStoppedAt *time.Time `locationName:"pullStoppedAt" type:"timestamp"` - // The Unix timestamp for when the task started (the task transitioned from + // The Unix time stamp for when the task started (the task transitioned from // the PENDING state to the RUNNING state). StartedAt *time.Time `locationName:"startedAt" type:"timestamp"` @@ -11797,18 +10597,14 @@ type Task struct { // service that starts it. StartedBy *string `locationName:"startedBy" type:"string"` - // The stop code indicating why a task was stopped. The stoppedReason may contain - // additional details. - StopCode *string `locationName:"stopCode" type:"string" enum:"TaskStopCode"` - - // The Unix timestamp for when the task was stopped (the task transitioned from - // the RUNNING state to the STOPPED state). + // The Unix time stamp for when the task was stopped (the task transitioned + // from the RUNNING state to the STOPPED state). StoppedAt *time.Time `locationName:"stoppedAt" type:"timestamp"` - // The reason that the task was stopped. + // The reason the task was stopped. StoppedReason *string `locationName:"stoppedReason" type:"string"` - // The Unix timestamp for when the task stops (transitions from the RUNNING + // The Unix time stamp for when the task stops (transitions from the RUNNING // state to STOPPED). StoppingAt *time.Time `locationName:"stoppingAt" type:"timestamp"` @@ -11827,9 +10623,9 @@ type Task struct { // The version counter for the task. Every time a task experiences a change // that triggers a CloudWatch event, the version counter is incremented. If // you are replicating your Amazon ECS task state with CloudWatch Events, you - // can compare the version of a task reported by the Amazon ECS API actionss - // with the version reported in CloudWatch Events for the task (inside the detail - // object) to verify that the version in your event stream is current. + // can compare the version of a task reported by the Amazon ECS APIs with the + // version reported in CloudWatch Events for the task (inside the detail object) + // to verify that the version in your event stream is current. Version *int64 `locationName:"version" type:"long"` } @@ -11969,12 +10765,6 @@ func (s *Task) SetStartedBy(v string) *Task { return s } -// SetStopCode sets the StopCode field's value. -func (s *Task) SetStopCode(v string) *Task { - s.StopCode = &v - return s -} - // SetStoppedAt sets the StoppedAt field's value. func (s *Task) SetStoppedAt(v time.Time) *Task { s.StoppedAt = &v @@ -12032,11 +10822,10 @@ type TaskDefinition struct { // in the Amazon Elastic Container Service Developer Guide. ContainerDefinitions []*ContainerDefinition `locationName:"containerDefinitions" type:"list"` - // The number of cpu units used by the task. If you are using the EC2 launch - // type, this field is optional and any value can be used. If you are using - // the Fargate launch type, this field is required and you must use one of the - // following values, which determines your range of valid values for the memory - // parameter: + // The number of cpu units used by the task. If using the EC2 launch type, this + // field is optional and any value can be used. If using the Fargate launch + // type, this field is required and you must use one of the following values, + // which determines your range of valid values for the memory parameter: // // * 256 (.25 vCPU) - Available memory values: 512 (0.5 GB), 1024 (1 GB), // 2048 (2 GB) @@ -12061,35 +10850,6 @@ type TaskDefinition struct { // The family of your task definition, used as the definition name. Family *string `locationName:"family" type:"string"` - // The IPC resource namespace to use for the containers in the task. The valid - // values are host, task, or none. If host is specified, then all containers - // within the tasks that specified the host IPC mode on the same container instance - // share the same IPC resources with the host Amazon EC2 instance. If task is - // specified, all containers within the specified task share the same IPC resources. - // If none is specified, then IPC resources within the containers of a task - // are private and not shared with other containers in a task or on the container - // instance. If no value is specified, then the IPC resource namespace sharing - // depends on the Docker daemon setting on the container instance. For more - // information, see IPC settings (https://docs.docker.com/engine/reference/run/#ipc-settings---ipc) - // in the Docker run reference. - // - // If the host IPC mode is used, be aware that there is a heightened risk of - // undesired IPC namespace expose. For more information, see Docker security - // (https://docs.docker.com/engine/security/security/). - // - // If you are setting namespaced kernel parameters using systemControls for - // the containers in the task, the following will apply to your IPC resource - // namespace. For more information, see System Controls (http://docs.aws.amazon.com/AmazonECS/latest/developerguide/task_definition_parameters.html) - // in the Amazon Elastic Container Service Developer Guide. - // - // * For tasks that use the host IPC mode, IPC namespace related systemControls - // are not supported. - // - // * For tasks that use the task IPC mode, IPC namespace related systemControls - // will apply to all containers within a task. - // - // This parameter is not supported for Windows containers or tasks using the - // Fargate launch type. IpcMode *string `locationName:"ipcMode" type:"string" enum:"IpcMode"` // The amount (in MiB) of memory used by the task. If using the EC2 launch type, @@ -12115,30 +10875,30 @@ type TaskDefinition struct { // The Docker networking mode to use for the containers in the task. The valid // values are none, bridge, awsvpc, and host. The default Docker network mode - // is bridge. If you are using the Fargate launch type, the awsvpc network mode - // is required. If you are using the EC2 launch type, any network mode can be - // used. If the network mode is set to none, you cannot specify port mappings - // in your container definitions, and the tasks containers do not have external - // connectivity. The host and awsvpc network modes offer the highest networking - // performance for containers because they use the EC2 network stack instead - // of the virtualized network stack provided by the bridge mode. + // is bridge. If using the Fargate launch type, the awsvpc network mode is required. + // If using the EC2 launch type, any network mode can be used. If the network + // mode is set to none, you can't specify port mappings in your container definitions, + // and the task's containers do not have external connectivity. The host and + // awsvpc network modes offer the highest networking performance for containers + // because they use the EC2 network stack instead of the virtualized network + // stack provided by the bridge mode. // // With the host and awsvpc network modes, exposed container ports are mapped // directly to the corresponding host port (for the host network mode) or the // attached elastic network interface port (for the awsvpc network mode), so // you cannot take advantage of dynamic host port mappings. // - // If the network mode is awsvpc, the task is allocated an elastic network interface, - // and you must specify a NetworkConfiguration value when you create a service - // or run a task with the task definition. For more information, see Task Networking + // If the network mode is awsvpc, the task is allocated an Elastic Network Interface, + // and you must specify a NetworkConfiguration when you create a service or + // run a task with the task definition. For more information, see Task Networking // (http://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-networking.html) // in the Amazon Elastic Container Service Developer Guide. // - // Currently, only Amazon ECS-optimized AMIs, other Amazon Linux variants with - // the ecs-init package, or AWS Fargate infrastructure support the awsvpc network - // mode. + // Currently, only the Amazon ECS-optimized AMI, other Amazon Linux variants + // with the ecs-init package, or AWS Fargate infrastructure support the awsvpc + // network mode. // - // If the network mode is host, you cannot run multiple instantiations of the + // If the network mode is host, you can't run multiple instantiations of the // same task on a single container instance when port mappings are used. // // Docker for Windows uses different network modes than Docker for Linux. When @@ -12150,40 +10910,24 @@ type TaskDefinition struct { // in the Docker run reference. NetworkMode *string `locationName:"networkMode" type:"string" enum:"NetworkMode"` - // The process namespace to use for the containers in the task. The valid values - // are host or task. If host is specified, then all containers within the tasks - // that specified the host PID mode on the same container instance share the - // same IPC resources with the host Amazon EC2 instance. If task is specified, - // all containers within the specified task share the same process namespace. - // If no value is specified, the default is a private namespace. For more information, - // see PID settings (https://docs.docker.com/engine/reference/run/#pid-settings---pid) - // in the Docker run reference. - // - // If the host PID mode is used, be aware that there is a heightened risk of - // undesired process namespace expose. For more information, see Docker security - // (https://docs.docker.com/engine/security/security/). - // - // This parameter is not supported for Windows containers or tasks using the - // Fargate launch type. PidMode *string `locationName:"pidMode" type:"string" enum:"PidMode"` // An array of placement constraint objects to use for tasks. This field is - // not valid if you are using the Fargate launch type for your task. + // not valid if using the Fargate launch type for your task. PlacementConstraints []*TaskDefinitionPlacementConstraint `locationName:"placementConstraints" type:"list"` // The container instance attributes required by your task. This field is not - // valid if you are using the Fargate launch type for your task. + // valid if using the Fargate launch type for your task. RequiresAttributes []*Attribute `locationName:"requiresAttributes" type:"list"` - // The launch type that the task is using. + // The launch type the task is using. RequiresCompatibilities []*string `locationName:"requiresCompatibilities" type:"list"` // 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 that 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. + // 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). Revision *int64 `locationName:"revision" type:"integer"` // The status of the task definition. @@ -12413,218 +11157,6 @@ func (s *TaskOverride) SetTaskRoleArn(v string) *TaskOverride { return s } -// Information about a set of Amazon ECS tasks in an AWS CodeDeploy deployment. -// An Amazon ECS task set includes details such as the desired number of tasks, -// how many tasks are running, and whether the task set serves production traffic. -type TaskSet struct { - _ struct{} `type:"structure"` - - // The computed desired count for the task set. This is calculated by multiplying - // the service's desiredCount by the task set's scale percentage. - ComputedDesiredCount *int64 `locationName:"computedDesiredCount" type:"integer"` - - // The Unix timestamp for when the task set was created. - CreatedAt *time.Time `locationName:"createdAt" type:"timestamp"` - - // The deployment ID of the AWS CodeDeploy deployment. - ExternalId *string `locationName:"externalId" type:"string"` - - // The ID of the task set. - Id *string `locationName:"id" type:"string"` - - // The launch type the tasks in the task set are using. For more information, - // see Amazon ECS Launch Types (http://docs.aws.amazon.com/AmazonECS/latest/developerguide/launch_types.html) - // in the Amazon Elastic Container Service Developer Guide. - LaunchType *string `locationName:"launchType" type:"string" enum:"LaunchType"` - - // Details on a load balancer that is used with a task set. - LoadBalancers []*LoadBalancer `locationName:"loadBalancers" type:"list"` - - // The network configuration for the task set. - NetworkConfiguration *NetworkConfiguration `locationName:"networkConfiguration" type:"structure"` - - // The number of tasks in the task set that are in the PENDING status during - // a deployment. A task in the PENDING state is preparing to enter the RUNNING - // state. A task set enters the PENDING status when it launches for the first - // time, or when it is restarted after being in the STOPPED state. - PendingCount *int64 `locationName:"pendingCount" type:"integer"` - - // The platform version on which the tasks in the task set are running. A platform - // version is only specified for tasks using the Fargate launch type. If one - // is not specified, the LATEST platform version is used by default. For more - // information, see AWS Fargate Platform Versions (http://docs.aws.amazon.com/AmazonECS/latest/developerguide/platform_versions.html) - // in the Amazon Elastic Container Service Developer Guide. - PlatformVersion *string `locationName:"platformVersion" type:"string"` - - // The number of tasks in the task set that are in the RUNNING status during - // a deployment. A task in the RUNNING state is running and ready for use. - RunningCount *int64 `locationName:"runningCount" type:"integer"` - - // A floating-point percentage of the desired number of tasks to place and keep - // running in the service. - Scale *Scale `locationName:"scale" type:"structure"` - - // The stability status, which indicates whether the task set has reached a - // steady state. If the following conditions are met, the task set will be in - // STEADY_STATE: - // - // * The task runningCount is equal to the computedDesiredCount. - // - // * The pendingCount is 0. - // - // * There are no tasks running on container instances in the DRAINING status. - // - // * All tasks are reporting a healthy status from the load balancers, service - // discovery, and container health checks. - // - // If any of those conditions are not met, the stability status returns STABILIZING. - StabilityStatus *string `locationName:"stabilityStatus" type:"string" enum:"StabilityStatus"` - - // The Unix timestamp for when the task set stability status was retrieved. - StabilityStatusAt *time.Time `locationName:"stabilityStatusAt" type:"timestamp"` - - // The tag specified when a task set is started. If the task is started by an - // AWS CodeDeploy deployment, then the startedBy parameter is CODE_DEPLOY. - StartedBy *string `locationName:"startedBy" type:"string"` - - // The status of the task set. The following describes each state: - // - // PRIMARYThe task set is serving production traffic. - // - // ACTIVEThe task set is not serving production traffic. - // - // DRAININGThe tasks in the task set are being stopped and their corresponding - // targets are being deregistered from their target group. - Status *string `locationName:"status" type:"string"` - - // The task definition the task set is using. - TaskDefinition *string `locationName:"taskDefinition" type:"string"` - - // The Amazon Resource Name (ARN) of the task set. - TaskSetArn *string `locationName:"taskSetArn" type:"string"` - - // The Unix timestamp for when the task set was last updated. - UpdatedAt *time.Time `locationName:"updatedAt" type:"timestamp"` -} - -// String returns the string representation -func (s TaskSet) String() string { - return awsutil.Prettify(s) -} - -// GoString returns the string representation -func (s TaskSet) GoString() string { - return s.String() -} - -// SetComputedDesiredCount sets the ComputedDesiredCount field's value. -func (s *TaskSet) SetComputedDesiredCount(v int64) *TaskSet { - s.ComputedDesiredCount = &v - return s -} - -// SetCreatedAt sets the CreatedAt field's value. -func (s *TaskSet) SetCreatedAt(v time.Time) *TaskSet { - s.CreatedAt = &v - return s -} - -// SetExternalId sets the ExternalId field's value. -func (s *TaskSet) SetExternalId(v string) *TaskSet { - s.ExternalId = &v - return s -} - -// SetId sets the Id field's value. -func (s *TaskSet) SetId(v string) *TaskSet { - s.Id = &v - return s -} - -// SetLaunchType sets the LaunchType field's value. -func (s *TaskSet) SetLaunchType(v string) *TaskSet { - s.LaunchType = &v - return s -} - -// SetLoadBalancers sets the LoadBalancers field's value. -func (s *TaskSet) SetLoadBalancers(v []*LoadBalancer) *TaskSet { - s.LoadBalancers = v - return s -} - -// SetNetworkConfiguration sets the NetworkConfiguration field's value. -func (s *TaskSet) SetNetworkConfiguration(v *NetworkConfiguration) *TaskSet { - s.NetworkConfiguration = v - return s -} - -// SetPendingCount sets the PendingCount field's value. -func (s *TaskSet) SetPendingCount(v int64) *TaskSet { - s.PendingCount = &v - return s -} - -// SetPlatformVersion sets the PlatformVersion field's value. -func (s *TaskSet) SetPlatformVersion(v string) *TaskSet { - s.PlatformVersion = &v - return s -} - -// SetRunningCount sets the RunningCount field's value. -func (s *TaskSet) SetRunningCount(v int64) *TaskSet { - s.RunningCount = &v - return s -} - -// SetScale sets the Scale field's value. -func (s *TaskSet) SetScale(v *Scale) *TaskSet { - s.Scale = v - return s -} - -// SetStabilityStatus sets the StabilityStatus field's value. -func (s *TaskSet) SetStabilityStatus(v string) *TaskSet { - s.StabilityStatus = &v - return s -} - -// SetStabilityStatusAt sets the StabilityStatusAt field's value. -func (s *TaskSet) SetStabilityStatusAt(v time.Time) *TaskSet { - s.StabilityStatusAt = &v - return s -} - -// SetStartedBy sets the StartedBy field's value. -func (s *TaskSet) SetStartedBy(v string) *TaskSet { - s.StartedBy = &v - return s -} - -// SetStatus sets the Status field's value. -func (s *TaskSet) SetStatus(v string) *TaskSet { - s.Status = &v - return s -} - -// SetTaskDefinition sets the TaskDefinition field's value. -func (s *TaskSet) SetTaskDefinition(v string) *TaskSet { - s.TaskDefinition = &v - return s -} - -// SetTaskSetArn sets the TaskSetArn field's value. -func (s *TaskSet) SetTaskSetArn(v string) *TaskSet { - s.TaskSetArn = &v - return s -} - -// SetUpdatedAt sets the UpdatedAt field's value. -func (s *TaskSet) SetUpdatedAt(v time.Time) *TaskSet { - s.UpdatedAt = &v - return s -} - // The container path, mount options, and size of the tmpfs mount. type Tmpfs struct { _ struct{} `type:"structure"` @@ -12641,7 +11173,6 @@ type Tmpfs struct { // "nomand" | "atime" | "noatime" | "diratime" | "nodiratime" | "bind" | "rbind" // | "unbindable" | "runbindable" | "private" | "rprivate" | "shared" | "rshared" // | "slave" | "rslave" | "relatime" | "norelatime" | "strictatime" | "nostrictatime" - // | "mode" | "uid" | "gid" | "nr_inodes" | "nr_blocks" | "mpol" MountOptions []*string `locationName:"mountOptions" type:"list"` // The size (in MiB) of the tmpfs volume. @@ -12761,74 +11292,6 @@ func (s *Ulimit) SetSoftLimit(v int64) *Ulimit { return s } -type UntagResourceInput struct { - _ struct{} `type:"structure"` - - // The Amazon Resource Name (ARN) of the resource from which to delete tags. - // Currently, the supported resources are Amazon ECS tasks, services, task definitions, - // clusters, and container instances. - // - // ResourceArn is a required field - ResourceArn *string `locationName:"resourceArn" type:"string" required:"true"` - - // The keys of the tags to be removed. - // - // TagKeys is a required field - TagKeys []*string `locationName:"tagKeys" type:"list" required:"true"` -} - -// String returns the string representation -func (s UntagResourceInput) String() string { - return awsutil.Prettify(s) -} - -// GoString returns the string representation -func (s UntagResourceInput) GoString() string { - return s.String() -} - -// Validate inspects the fields of the type to determine if they are valid. -func (s *UntagResourceInput) Validate() error { - invalidParams := request.ErrInvalidParams{Context: "UntagResourceInput"} - if s.ResourceArn == nil { - invalidParams.Add(request.NewErrParamRequired("ResourceArn")) - } - if s.TagKeys == nil { - invalidParams.Add(request.NewErrParamRequired("TagKeys")) - } - - if invalidParams.Len() > 0 { - return invalidParams - } - return nil -} - -// SetResourceArn sets the ResourceArn field's value. -func (s *UntagResourceInput) SetResourceArn(v string) *UntagResourceInput { - s.ResourceArn = &v - return s -} - -// SetTagKeys sets the TagKeys field's value. -func (s *UntagResourceInput) SetTagKeys(v []*string) *UntagResourceInput { - s.TagKeys = v - return s -} - -type UntagResourceOutput struct { - _ struct{} `type:"structure"` -} - -// String returns the string representation -func (s UntagResourceOutput) String() string { - return awsutil.Prettify(s) -} - -// GoString returns the string representation -func (s UntagResourceOutput) GoString() string { - return s.String() -} - type UpdateContainerAgentInput struct { _ struct{} `type:"structure"` @@ -13025,10 +11488,10 @@ type UpdateServiceInput struct { // has first started. This is only valid if your service is configured to use // a load balancer. If your service's tasks take a while to start and respond // to Elastic Load Balancing health checks, you can specify a health check grace - // period of up to 1,800 seconds. During that time, the ECS service scheduler - // ignores the Elastic Load Balancing health check status. This grace period - // can prevent the ECS service scheduler from marking tasks as unhealthy and - // stopping them before they have time to come up. + // period of up to 1,800 seconds during which the ECS service scheduler ignores + // the Elastic Load Balancing health check status. This grace period can prevent + // the ECS service scheduler from marking tasks as unhealthy and stopping them + // before they have time to come up. HealthCheckGracePeriodSeconds *int64 `locationName:"healthCheckGracePeriodSeconds" type:"integer"` // The network configuration for the service. This parameter is required for @@ -13043,11 +11506,7 @@ type UpdateServiceInput struct { // network configuration, this does not trigger a new service deployment. NetworkConfiguration *NetworkConfiguration `locationName:"networkConfiguration" type:"structure"` - // The platform version on which your tasks in the service are running. A platform - // version is only specified for tasks using the Fargate launch type. If one - // is not specified, the LATEST platform version is used by default. For more - // information, see AWS Fargate Platform Versions (http://docs.aws.amazon.com/AmazonECS/latest/developerguide/platform_versions.html) - // in the Amazon Elastic Container Service Developer Guide. + // The platform version that your service should run. PlatformVersion *string `locationName:"platformVersion" type:"string"` // The name of the service to update. @@ -13212,26 +11671,17 @@ func (s *VersionInfo) SetDockerVersion(v string) *VersionInfo { return s } -// A data volume used in a task definition. For tasks that use a Docker volume, -// specify a DockerVolumeConfiguration. For tasks that use a bind mount host -// volume, specify a host and optional sourcePath. For more information, see -// Using Data Volumes in Tasks (http://docs.aws.amazon.com/AmazonECS/latest/developerguide/using_data_volumes.html). +// A data volume used in a task definition. type Volume struct { _ struct{} `type:"structure"` - // This parameter is specified when you are using Docker volumes. Docker volumes - // are only supported when you are using the EC2 launch type. Windows containers - // only support the use of the local driver. To use bind mounts, specify a host - // instead. DockerVolumeConfiguration *DockerVolumeConfiguration `locationName:"dockerVolumeConfiguration" type:"structure"` - // This parameter is specified when you are using bind mount host volumes. Bind - // mount host volumes are supported when you are using either the EC2 or Fargate - // launch types. The contents of the host parameter determine whether your bind - // mount host volume persists on the host container instance and where it is - // stored. If the host parameter is empty, then the Docker daemon assigns a - // host path for your data volume. However, the data is not guaranteed to persist - // after the containers associated with it stop running. + // The contents of the host parameter determine whether your data volume persists + // on the host container instance and where it is stored. If the host parameter + // is empty, then the Docker daemon assigns a host path for your data volume, + // but the data is not guaranteed to persist after the containers associated + // with it stop running. // // Windows containers can mount whole directories on the same drive as $env:ProgramData. // Windows containers cannot mount directories on a different drive, and mount @@ -13282,8 +11732,8 @@ type VolumeFrom struct { // value is false. ReadOnly *bool `locationName:"readOnly" type:"boolean"` - // The name of another container within the same task definition from which - // to mount volumes. + // The name of another container within the same task definition to mount volumes + // from. SourceContainer *string `locationName:"sourceContainer" type:"string"` } @@ -13340,9 +11790,6 @@ const ( const ( // ClusterFieldStatistics is a ClusterField enum value ClusterFieldStatistics = "STATISTICS" - - // ClusterFieldTags is a ClusterField enum value - ClusterFieldTags = "TAGS" ) const ( @@ -13361,11 +11808,6 @@ const ( ConnectivityDisconnected = "DISCONNECTED" ) -const ( - // ContainerInstanceFieldTags is a ContainerInstanceField enum value - ContainerInstanceFieldTags = "TAGS" -) - const ( // ContainerInstanceStatusActive is a ContainerInstanceStatus enum value ContainerInstanceStatusActive = "ACTIVE" @@ -13374,14 +11816,6 @@ const ( ContainerInstanceStatusDraining = "DRAINING" ) -const ( - // DeploymentControllerTypeEcs is a DeploymentControllerType enum value - DeploymentControllerTypeEcs = "ECS" - - // DeploymentControllerTypeCodeDeploy is a DeploymentControllerType enum value - DeploymentControllerTypeCodeDeploy = "CODE_DEPLOY" -) - const ( // DesiredStatusRunning is a DesiredStatus enum value DesiredStatusRunning = "RUNNING" @@ -13498,19 +11932,6 @@ const ( PlacementStrategyTypeBinpack = "binpack" ) -const ( - // PropagateTagsTaskDefinition is a PropagateTags enum value - PropagateTagsTaskDefinition = "TASK_DEFINITION" - - // PropagateTagsService is a PropagateTags enum value - PropagateTagsService = "SERVICE" -) - -const ( - // ScaleUnitPercent is a ScaleUnit enum value - ScaleUnitPercent = "PERCENT" -) - const ( // SchedulingStrategyReplica is a SchedulingStrategy enum value SchedulingStrategyReplica = "REPLICA" @@ -13527,11 +11948,6 @@ const ( ScopeShared = "shared" ) -const ( - // ServiceFieldTags is a ServiceField enum value - ServiceFieldTags = "TAGS" -) - const ( // SettingNameServiceLongArnFormat is a SettingName enum value SettingNameServiceLongArnFormat = "serviceLongArnFormat" @@ -13551,14 +11967,6 @@ const ( SortOrderDesc = "DESC" ) -const ( - // StabilityStatusSteadyState is a StabilityStatus enum value - StabilityStatusSteadyState = "STEADY_STATE" - - // StabilityStatusStabilizing is a StabilityStatus enum value - StabilityStatusStabilizing = "STABILIZING" -) - const ( // TargetTypeContainerInstance is a TargetType enum value TargetTypeContainerInstance = "container-instance" @@ -13575,11 +11983,6 @@ const ( TaskDefinitionFamilyStatusAll = "ALL" ) -const ( - // TaskDefinitionFieldTags is a TaskDefinitionField enum value - TaskDefinitionFieldTags = "TAGS" -) - const ( // TaskDefinitionPlacementConstraintTypeMemberOf is a TaskDefinitionPlacementConstraintType enum value TaskDefinitionPlacementConstraintTypeMemberOf = "memberOf" @@ -13593,22 +11996,6 @@ const ( TaskDefinitionStatusInactive = "INACTIVE" ) -const ( - // TaskFieldTags is a TaskField enum value - TaskFieldTags = "TAGS" -) - -const ( - // TaskStopCodeTaskFailedToStart is a TaskStopCode enum value - TaskStopCodeTaskFailedToStart = "TaskFailedToStart" - - // TaskStopCodeEssentialContainerExited is a TaskStopCode enum value - TaskStopCodeEssentialContainerExited = "EssentialContainerExited" - - // TaskStopCodeUserInitiated is a TaskStopCode enum value - TaskStopCodeUserInitiated = "UserInitiated" -) - const ( // TransportProtocolTcp is a TransportProtocol enum value TransportProtocolTcp = "tcp" diff --git a/agent/ecs_client/model/ecs/errors.go b/agent/ecs_client/model/ecs/errors.go index ae42f9b3ea2..8ed00c7cf8b 100644 --- a/agent/ecs_client/model/ecs/errors.go +++ b/agent/ecs_client/model/ecs/errors.go @@ -32,8 +32,8 @@ const ( // ErrCodeBlockedException for service response error code // "BlockedException". // - // Your AWS account has been blocked. For more information, contact AWS Support - // (http://aws.amazon.com/contact-us/). + // Your AWS account has been blocked. Contact AWS Support (http://aws.amazon.com/contact-us/) + // for more information. ErrCodeBlockedException = "BlockedException" // ErrCodeClientException for service response error code @@ -47,17 +47,17 @@ const ( // ErrCodeClusterContainsContainerInstancesException for service response error code // "ClusterContainsContainerInstancesException". // - // You cannot delete a cluster that has registered container instances. First, - // deregister the container instances before you can delete the cluster. For - // more information, see DeregisterContainerInstance. + // 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. ErrCodeClusterContainsContainerInstancesException = "ClusterContainsContainerInstancesException" // ErrCodeClusterContainsServicesException for service response error code // "ClusterContainsServicesException". // - // You cannot delete a cluster that contains services. First, update the service - // to reduce its desired task count to 0 and then delete the service. For more - // information, see UpdateService and DeleteService. + // 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. ErrCodeClusterContainsServicesException = "ClusterContainsServicesException" // ErrCodeClusterContainsTasksException for service response error code @@ -70,7 +70,7 @@ const ( // "ClusterNotFoundException". // // The specified cluster could not be found. You can view your available clusters - // with ListClusters. Amazon ECS clusters are Region-specific. + // with ListClusters. Amazon ECS clusters are region-specific. ErrCodeClusterNotFoundException = "ClusterNotFoundException" // ErrCodeInvalidParameterException for service response error code @@ -110,12 +110,6 @@ const ( // The specified platform version does not exist. ErrCodePlatformUnknownException = "PlatformUnknownException" - // ErrCodeResourceNotFoundException for service response error code - // "ResourceNotFoundException". - // - // The specified resource could not be found. - ErrCodeResourceNotFoundException = "ResourceNotFoundException" - // ErrCodeServerException for service response error code // "ServerException". // @@ -133,7 +127,7 @@ const ( // "ServiceNotFoundException". // // The specified service could not be found. You can view your available services - // with ListServices. Amazon ECS services are cluster-specific and Region-specific. + // with ListServices. Amazon ECS services are cluster-specific and region-specific. ErrCodeServiceNotFoundException = "ServiceNotFoundException" // ErrCodeTargetNotFoundException for service response error code @@ -141,13 +135,13 @@ const ( // // The specified target could not be found. You can view your available container // instances with ListContainerInstances. Amazon ECS container instances are - // cluster-specific and Region-specific. + // cluster-specific and region-specific. ErrCodeTargetNotFoundException = "TargetNotFoundException" // ErrCodeUnsupportedFeatureException for service response error code // "UnsupportedFeatureException". // - // The specified task is not supported in this Region. + // The specified task is not supported in this region. ErrCodeUnsupportedFeatureException = "UnsupportedFeatureException" // ErrCodeUpdateInProgressException for service response error code diff --git a/agent/engine/dockerstate/docker_task_engine_state.go b/agent/engine/dockerstate/docker_task_engine_state.go index 6169298d8d2..3703a86ab3c 100644 --- a/agent/engine/dockerstate/docker_task_engine_state.go +++ b/agent/engine/dockerstate/docker_task_engine_state.go @@ -528,8 +528,8 @@ func (state *DockerTaskEngineState) GetECSClient() api.ECSClient { } func (state *DockerTaskEngineState) SetECSClient(client api.ECSClient) { - state.lock.RLock() - defer state.lock.RUnlock() + state.lock.Lock() + defer state.lock.Unlock() state.client = client } diff --git a/agent/functional_tests/testdata/taskdefinitions/taskmetadata-validator-awsvpc/task-definition.json b/agent/functional_tests/testdata/taskdefinitions/taskmetadata-validator-awsvpc/task-definition.json index 59f1993aceb..b980c499ff9 100644 --- a/agent/functional_tests/testdata/taskdefinitions/taskmetadata-validator-awsvpc/task-definition.json +++ b/agent/functional_tests/testdata/taskdefinitions/taskmetadata-validator-awsvpc/task-definition.json @@ -12,6 +12,7 @@ "retries": 2, "startPeriod": 1 }, + "command": ["$$$CHECK_TAGS$$$"], "logConfiguration": { "logDriver": "awslogs", "options": { diff --git a/agent/functional_tests/tests/functionaltests_test.go b/agent/functional_tests/tests/functionaltests_test.go index 4279c36e421..1f0e9dd56c6 100644 --- a/agent/functional_tests/tests/functionaltests_test.go +++ b/agent/functional_tests/tests/functionaltests_test.go @@ -732,7 +732,6 @@ func testV3TaskEndpointTags(t *testing.T, taskName, containerName, networkMode s awslogsPrefix := "ecs-functional-tests-v3-task-endpoint-validator" agentOptions := &AgentOptions{ - EnableTaskENI: true, ExtraEnvironment: map[string]string{ "ECS_AVAILABLE_LOGGING_DRIVERS": `["awslogs"]`, "ECS_CONTAINER_INSTANCE_PROPAGATE_TAGS_FROM": "ec2_instance", diff --git a/agent/functional_tests/tests/functionaltests_unix_test.go b/agent/functional_tests/tests/functionaltests_unix_test.go index b0ed01d53ac..e713ebd0c66 100644 --- a/agent/functional_tests/tests/functionaltests_unix_test.go +++ b/agent/functional_tests/tests/functionaltests_unix_test.go @@ -665,6 +665,17 @@ func TestAgentIntrospectionValidator(t *testing.T) { func TestTaskMetadataValidator(t *testing.T) { RequireDockerVersion(t, ">=17.06.0-ce") + + // Added to test presence of tags in metadata endpoint + // We need long container instance ARN for tagging APIs, PutAccountSettingInput + // will enable long container instance ARN. + putAccountSettingInput := ecsapi.PutAccountSettingInput{ + Name: aws.String("containerInstanceLongArnFormat"), + Value: aws.String("enabled"), + } + _, err := ECS.PutAccountSetting(&putAccountSettingInput) + assert.NoError(t, err) + // Best effort to create a log group. It should be safe to even not do this // as the log group gets created in the TestAWSLogsDriver functional test. cwlClient := cloudwatchlogs.New(session.New(), aws.NewConfig().WithRegion(*ECS.Config.Region)) @@ -674,7 +685,10 @@ func TestTaskMetadataValidator(t *testing.T) { agent := RunAgent(t, &AgentOptions{ EnableTaskENI: true, ExtraEnvironment: map[string]string{ - "ECS_AVAILABLE_LOGGING_DRIVERS": `["awslogs"]`, + "ECS_AVAILABLE_LOGGING_DRIVERS": `["awslogs"]`, + "ECS_CONTAINER_INSTANCE_PROPAGATE_TAGS_FROM": "ec2_instance", + "ECS_CONTAINER_INSTANCE_TAGS": fmt.Sprintf(`{"%s": "%s"}`, + "localKey", "localValue"), }, }) defer agent.Cleanup() @@ -682,6 +696,7 @@ func TestTaskMetadataValidator(t *testing.T) { tdOverrides := make(map[string]string) tdOverrides["$$$TEST_REGION$$$"] = *ECS.Config.Region + tdOverrides["$$$CHECK_TAGS$$$"] = "CheckTags" // Added to test presence of tags in metadata endpoint task, err := agent.StartAWSVPCTask("taskmetadata-validator-awsvpc", tdOverrides) require.NoError(t, err, "Unable to start task with 'awsvpc' network mode") @@ -697,6 +712,12 @@ func TestTaskMetadataValidator(t *testing.T) { exitCode, _ := task.ContainerExitcode("taskmetadata-validator") assert.Equal(t, 42, exitCode, fmt.Sprintf("Expected exit code of 42; got %d", exitCode)) + + DeleteAccountSettingInput := ecsapi.DeleteAccountSettingInput{ + Name: aws.String("containerInstanceLongArnFormat"), + } + _, err = ECS.DeleteAccountSetting(&DeleteAccountSettingInput) + assert.NoError(t, err) } // TestExecutionRole verifies that task can use the execution credentials to pull from ECR and diff --git a/agent/handlers/task_server_setup.go b/agent/handlers/task_server_setup.go index ce3e59b0f88..65967b7d442 100644 --- a/agent/handlers/task_server_setup.go +++ b/agent/handlers/task_server_setup.go @@ -99,9 +99,10 @@ func v2HandlersSetup(muxRouter *mux.Router, availabilityZone string, containerInstanceArn string) { muxRouter.HandleFunc(v2.CredentialsPath, v2.CredentialsHandler(credentialsManager, auditLogger)) - muxRouter.HandleFunc(v2.ContainerMetadataPath, v2.TaskContainerMetadataHandler(state, cluster, availabilityZone, containerInstanceArn)) - muxRouter.HandleFunc(v2.TaskMetadataPath, v2.TaskContainerMetadataHandler(state, cluster, availabilityZone, containerInstanceArn)) - muxRouter.HandleFunc(v2.TaskMetadataPathWithSlash, v2.TaskContainerMetadataHandler(state, cluster, availabilityZone, containerInstanceArn)) + muxRouter.HandleFunc(v2.ContainerMetadataPath, v2.TaskContainerMetadataHandler(state, cluster, availabilityZone, containerInstanceArn, false)) + muxRouter.HandleFunc(v2.TaskMetadataPath, v2.TaskContainerMetadataHandler(state, cluster, availabilityZone, containerInstanceArn, false)) + muxRouter.HandleFunc(v2.TaskWithTagsMetadataPath, v2.TaskContainerMetadataHandler(state, cluster, availabilityZone, containerInstanceArn, true)) + muxRouter.HandleFunc(v2.TaskMetadataPathWithSlash, v2.TaskContainerMetadataHandler(state, cluster, availabilityZone, containerInstanceArn, false)) muxRouter.HandleFunc(v2.ContainerStatsPath, v2.TaskContainerStatsHandler(state, statsEngine)) muxRouter.HandleFunc(v2.TaskStatsPath, v2.TaskContainerStatsHandler(state, statsEngine)) muxRouter.HandleFunc(v2.TaskStatsPathWithSlash, v2.TaskContainerStatsHandler(state, statsEngine)) diff --git a/agent/handlers/task_server_setup_test.go b/agent/handlers/task_server_setup_test.go index 51501aeb7f9..8d689bf903c 100644 --- a/agent/handlers/task_server_setup_test.go +++ b/agent/handlers/task_server_setup_test.go @@ -50,33 +50,34 @@ import ( ) const ( - clusterName = "default" - remoteIP = "169.254.170.3" - remotePort = "32146" - taskARN = "t1" - family = "sleep" - version = "1" - containerID = "cid" - containerName = "sleepy" - imageName = "busybox" - imageID = "bUsYbOx" - cpu = 1024 - memory = 512 - statusRunning = "RUNNING" - containerType = "NORMAL" - containerPort = 80 - containerPortProtocol = "tcp" - eniIPv4Address = "10.0.0.2" - roleArn = "r1" - accessKeyID = "ak" - secretAccessKey = "sk" - credentialsID = "credentialsId" - v2BaseStatsPath = "/v2/stats" - v2BaseMetadataPath = "/v2/metadata" - v3BasePath = "/v3/" - v3EndpointID = "v3eid" - availabilityzone = "us-west-2b" - containerInstanceArn = "containerInstanceArn-test" + clusterName = "default" + remoteIP = "169.254.170.3" + remotePort = "32146" + taskARN = "t1" + family = "sleep" + version = "1" + containerID = "cid" + containerName = "sleepy" + imageName = "busybox" + imageID = "bUsYbOx" + cpu = 1024 + memory = 512 + statusRunning = "RUNNING" + containerType = "NORMAL" + containerPort = 80 + containerPortProtocol = "tcp" + eniIPv4Address = "10.0.0.2" + roleArn = "r1" + accessKeyID = "ak" + secretAccessKey = "sk" + credentialsID = "credentialsId" + v2BaseStatsPath = "/v2/stats" + v2BaseMetadataPath = "/v2/metadata" + v2BaseMetadataWithTagsPath = "/v2/metadataWithTags" + v3BasePath = "/v3/" + v3EndpointID = "v3eid" + availabilityzone = "us-west-2b" + containerInstanceArn = "containerInstanceArn-test" ) var ( @@ -433,6 +434,78 @@ func TestV2TaskMetadata(t *testing.T) { } } +func TestV2TaskWithTagsMetadata(t *testing.T) { + ctrl := gomock.NewController(t) + defer ctrl.Finish() + + state := mock_dockerstate.NewMockTaskEngineState(ctrl) + auditLog := mock_audit.NewMockAuditLogger(ctrl) + statsEngine := mock_stats.NewMockEngine(ctrl) + ecsClient := mock_api.NewMockECSClient(ctrl) + + expectedTaskResponseWithTags := expectedTaskResponse + expectedContainerInstanceTags := map[string]string{ + "ContainerInstanceTag1": "firstTag", + "ContainerInstanceTag2": "secondTag", + } + expectedTaskResponseWithTags.ContainerInstanceTags = expectedContainerInstanceTags + expectedTaskTags := map[string]string{ + "TaskTag1": "firstTag", + "TaskTag2": "secondTag", + } + expectedTaskResponseWithTags.TaskTags = expectedTaskTags + + contInstTag1Key := "ContainerInstanceTag1" + contInstTag1Val := "firstTag" + contInstTag2Key := "ContainerInstanceTag2" + contInstTag2Val := "secondTag" + taskTag1Key := "TaskTag1" + taskTag1Val := "firstTag" + taskTag2Key := "TaskTag2" + taskTag2Val := "secondTag" + + gomock.InOrder( + state.EXPECT().GetTaskByIPAddress(remoteIP).Return(taskARN, true), + state.EXPECT().TaskByArn(taskARN).Return(task, true), + state.EXPECT().ContainerMapByArn(taskARN).Return(containerNameToDockerContainer, true), + state.EXPECT().GetECSClient().Return(ecsClient), + ecsClient.EXPECT().GetResourceTags(containerInstanceArn).Return([]*ecs.Tag{ + &ecs.Tag{ + Key: &contInstTag1Key, + Value: &contInstTag1Val, + }, + &ecs.Tag{ + Key: &contInstTag2Key, + Value: &contInstTag2Val, + }, + }, nil), + state.EXPECT().GetECSClient().Return(ecsClient), + ecsClient.EXPECT().GetResourceTags(taskARN).Return([]*ecs.Tag{ + &ecs.Tag{ + Key: &taskTag1Key, + Value: &taskTag1Val, + }, + &ecs.Tag{ + Key: &taskTag2Key, + Value: &taskTag2Val, + }, + }, nil), + ) + server := taskServerSetup(credentials.NewManager(), auditLog, state, clusterName, statsEngine, + config.DefaultTaskMetadataSteadyStateRate, config.DefaultTaskMetadataBurstRate, availabilityzone, containerInstanceArn) + recorder := httptest.NewRecorder() + req, _ := http.NewRequest("GET", v2BaseMetadataWithTagsPath, nil) + req.RemoteAddr = remoteIP + ":" + remotePort + server.Handler.ServeHTTP(recorder, req) + res, err := ioutil.ReadAll(recorder.Body) + assert.NoError(t, err) + assert.Equal(t, http.StatusOK, recorder.Code) + var taskResponse v2.TaskResponse + err = json.Unmarshal(res, &taskResponse) + assert.NoError(t, err) + assert.Equal(t, expectedTaskResponseWithTags, taskResponse) +} + func TestV2ContainerMetadata(t *testing.T) { ctrl := gomock.NewController(t) defer ctrl.Finish() diff --git a/agent/handlers/v2/task_container_metadata_handler.go b/agent/handlers/v2/task_container_metadata_handler.go index e58532d2db8..781d505d894 100644 --- a/agent/handlers/v2/task_container_metadata_handler.go +++ b/agent/handlers/v2/task_container_metadata_handler.go @@ -31,6 +31,9 @@ const ( // TaskMetadataPath specifies the relative URI path for serving task metadata. TaskMetadataPath = "/v2/metadata" + // TaskWithTagsMetadataPath specifies the relative URI path for serving task metadata with Container Instance and Task Tags. + TaskWithTagsMetadataPath = "/v2/metadataWithTags" + // TaskMetadataPathWithSlash specifies the relative URI path for serving task metadata. TaskMetadataPathWithSlash = TaskMetadataPath + "/" ) @@ -39,7 +42,7 @@ const ( var ContainerMetadataPath = TaskMetadataPathWithSlash + utils.ConstructMuxVar(metadataContainerIDMuxName, utils.AnythingButEmptyRegEx) // TaskContainerMetadataHandler returns the handler method for handling task and container metadata requests. -func TaskContainerMetadataHandler(state dockerstate.TaskEngineState, cluster, az, containerInstanceArn string) func(http.ResponseWriter, *http.Request) { +func TaskContainerMetadataHandler(state dockerstate.TaskEngineState, cluster, az, containerInstanceArn string, propagateTags bool) func(http.ResponseWriter, *http.Request) { return func(w http.ResponseWriter, r *http.Request) { taskARN, err := getTaskARNByRequest(r, state) if err != nil { @@ -55,7 +58,7 @@ func TaskContainerMetadataHandler(state dockerstate.TaskEngineState, cluster, az } seelog.Infof("V2 task/container metadata handler: writing response for task '%s'", taskARN) - WriteTaskMetadataResponse(w, taskARN, cluster, state, az, containerInstanceArn, false) + WriteTaskMetadataResponse(w, taskARN, cluster, state, az, containerInstanceArn, propagateTags) } } diff --git a/misc/taskmetadata-validator/taskmetadata-validator.go b/misc/taskmetadata-validator/taskmetadata-validator.go index dffbffd135f..bae5eecc740 100644 --- a/misc/taskmetadata-validator/taskmetadata-validator.go +++ b/misc/taskmetadata-validator/taskmetadata-validator.go @@ -25,23 +25,26 @@ import ( ) const ( - v2MetadataEndpoint = "http://169.254.170.2/v2/metadata" - v2StatsEndpoint = "http://169.254.170.2/v2/stats" - maxRetries = 4 - durationBetweenRetries = time.Second + v2MetadataEndpoint = "http://169.254.170.2/v2/metadata" + v2MetadataWithTagsEndpoint = "http://169.254.170.2/v2/metadataWithTags" + v2StatsEndpoint = "http://169.254.170.2/v2/stats" + maxRetries = 4 + durationBetweenRetries = time.Second ) // TaskResponse defines the schema for the task response JSON object type TaskResponse struct { - Cluster string - TaskARN string - Family string - Revision string - DesiredStatus string `json:",omitempty"` - KnownStatus string - AvailabilityZone string - Containers []ContainerResponse `json:",omitempty"` - Limits LimitsResponse `json:",omitempty"` + Cluster string + TaskARN string + Family string + Revision string + DesiredStatus string `json:",omitempty"` + KnownStatus string + AvailabilityZone string + Containers []ContainerResponse `json:",omitempty"` + Limits LimitsResponse `json:",omitempty"` + TaskTags map[string]string `json:"TaskTags,omitempty"` + ContainerInstanceTags map[string]string `json:"ContainerInstanceTags,omitempty"` } // ContainerResponse defines the schema for the container response @@ -120,6 +123,23 @@ func taskMetadata(client *http.Client) (*TaskResponse, error) { return &taskMetadata, nil } +func taskWithTagsMetadata(client *http.Client) (*TaskResponse, error) { + body, err := metadataResponse(client, v2MetadataWithTagsEndpoint, "task with tags metadata") + if err != nil { + return nil, err + } + + fmt.Printf("Received task with tags metadata: %s \n", string(body)) + + var taskMetadata TaskResponse + err = json.Unmarshal(body, &taskMetadata) + if err != nil { + return nil, fmt.Errorf("task with tags metadata: unable to parse response body: %v", err) + } + + return &taskMetadata, nil +} + func containerMetadata(client *http.Client, id string) (*ContainerResponse, error) { body, err := metadataResponse(client, v2MetadataEndpoint+"/"+id, "container metadata") if err != nil { @@ -214,6 +234,21 @@ func main() { // Wait for the Health information to be ready time.Sleep(5 * time.Second) + // If the image is built with option to check Tags + argsWithoutProg := os.Args[1:] + if len(argsWithoutProg) > 0 && argsWithoutProg[0] == "CheckTags" { + taskWithTagsMetadata, err := taskWithTagsMetadata(client) + if err != nil { + fmt.Fprintf(os.Stderr, "Unable to get task stats: %v", err) + os.Exit(1) + } + + if len(taskWithTagsMetadata.ContainerInstanceTags) == 0 { + fmt.Fprintf(os.Stderr, "ContainerInstanceTags not found: %v", err) + os.Exit(1) + } + } + taskMetadata, err := taskMetadata(client) if err != nil { fmt.Fprintf(os.Stderr, "Unable to get task metadata: %v", err) diff --git a/misc/v3-task-endpoint-validator-windows/v3-task-endpoint-validator-windows.go b/misc/v3-task-endpoint-validator-windows/v3-task-endpoint-validator-windows.go index e15feed957d..71434bdb008 100644 --- a/misc/v3-task-endpoint-validator-windows/v3-task-endpoint-validator-windows.go +++ b/misc/v3-task-endpoint-validator-windows/v3-task-endpoint-validator-windows.go @@ -328,9 +328,11 @@ func main() { v3BaseEndpoint := os.Getenv(containerMetadataEnvVar) containerMetadataPath := v3BaseEndpoint - taskMetadataPath := v3BaseEndpoint + "/task" + taskMetadataPath := v3BaseEndpoint if checkContainerInstanceTags { - taskMetadataPath += "WithTags" + taskMetadataPath += "/taskWithTags" + } else { + taskMetadataPath += "/task" } containerStatsPath := v3BaseEndpoint + "/stats" taskStatsPath := v3BaseEndpoint + "/task/stats" diff --git a/misc/v3-task-endpoint-validator/v3-task-endpoint-validator.go b/misc/v3-task-endpoint-validator/v3-task-endpoint-validator.go index 31576c4931c..272477f23cc 100644 --- a/misc/v3-task-endpoint-validator/v3-task-endpoint-validator.go +++ b/misc/v3-task-endpoint-validator/v3-task-endpoint-validator.go @@ -430,9 +430,11 @@ func main() { isAWSVPCNetworkMode = false v3BaseEndpoint := os.Getenv(containerMetadataEnvVar) containerMetadataPath := v3BaseEndpoint - taskMetadataPath := v3BaseEndpoint + "/task" + taskMetadataPath := v3BaseEndpoint if checkContainerInstanceTags { - taskMetadataPath += "WithTags" + taskMetadataPath += "/taskWithTags" + } else { + taskMetadataPath += "/task" } containerStatsPath := v3BaseEndpoint + "/stats" taskStatsPath := v3BaseEndpoint + "/task/stats"