{ "version":"2.0", "metadata":{ "apiVersion":"2014-11-13", "endpointPrefix":"ecs", "jsonVersion":"1.1", "protocol":"json", "serviceAbbreviation":"Amazon ECS", "serviceFullName":"Amazon EC2 Container Service", "serviceId":"ECS", "signatureVersion":"v4", "targetPrefix":"AmazonEC2ContainerServiceV20141113", "uid":"ecs-2014-11-13" }, "operations":{ "CreateCapacityProvider":{ "name":"CreateCapacityProvider", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreateCapacityProviderRequest"}, "output":{"shape":"CreateCapacityProviderResponse"}, "errors":[ {"shape":"ServerException"}, {"shape":"ClientException"}, {"shape":"InvalidParameterException"}, {"shape":"LimitExceededException"}, {"shape":"UpdateInProgressException"} ], "documentation":"

Creates a new capacity provider. Capacity providers are associated with an Amazon ECS cluster and are used in capacity provider strategies to facilitate cluster auto scaling.

Only capacity providers that use an Auto Scaling group can be created. Amazon ECS tasks on Fargate use the `FARGATE` and `FARGATE_SPOT` capacity providers. These providers are available to all accounts in the Amazon Web Services Regions that Fargate supports.

" }, "CreateCluster":{ "name":"CreateCluster", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreateClusterRequest"}, "output":{"shape":"CreateClusterResponse"}, "errors":[ {"shape":"ServerException"}, {"shape":"ClientException"}, {"shape":"InvalidParameterException"}, {"shape":"NamespaceNotFoundException"} ], "documentation":"

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 Amazon ECS service-linked role for your account. This is so that it can manage required resources in other Amazon Web Services services on your behalf. However, if the user that makes the call doesn't have permissions to create the service-linked role, it isn't created. For more information, see Using service-linked roles for Amazon ECS in the Amazon Elastic Container Service Developer Guide.

" }, "CreateService":{ "name":"CreateService", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreateServiceRequest"}, "output":{"shape":"CreateServiceResponse"}, "errors":[ {"shape":"ServerException"}, {"shape":"ClientException"}, {"shape":"InvalidParameterException"}, {"shape":"ClusterNotFoundException"}, {"shape":"UnsupportedFeatureException"}, {"shape":"PlatformUnknownException"}, {"shape":"PlatformTaskDefinitionIncompatibilityException"}, {"shape":"AccessDeniedException"}, {"shape":"NamespaceNotFoundException"} ], "documentation":"

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

Starting April 15, 2023, Amazon Web Services will not onboard new customers to Amazon Elastic Inference (EI), and will help current customers migrate their workloads to options that offer better price and performance. After April 15, 2023, new customers will not be able to launch instances with Amazon EI accelerators in Amazon SageMaker, Amazon ECS, or Amazon EC2. However, customers who have used Amazon EI at least once during the past 30-day period are considered current customers and will be able to continue using the service.

In addition to maintaining the desired count of tasks in your service, you can optionally run your service behind one or more load balancers. The load balancers distribute 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 attach Amazon EBS volumes to Amazon ECS tasks by configuring the volume when creating or updating a service. `volumeConfigurations` is only supported for REPLICA service and not DAEMON service. For more infomation, see Amazon EBS volumes in the Amazon Elastic Container Service Developer Guide.

Tasks for services that don't use a load balancer are considered healthy if they're in the `RUNNING` state. Tasks for services that use a load balancer are considered healthy if they're in the `RUNNING` state and are reported as healthy by the load balancer.

There are two service scheduler strategies available:

- `REPLICA` - The replica scheduling strategy places and maintains your 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. For more information, see Service scheduler concepts in the Amazon Elastic Container Service Developer Guide.

- `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. The service scheduler also evaluates the task placement constraints for running tasks. It also stops tasks that don't meet the placement constraints. When using this strategy, you don't need to specify a desired number of tasks, a task placement strategy, or use Service Auto Scaling policies. For more information, see Service scheduler concepts in the Amazon Elastic Container Service Developer Guide.

You can optionally specify a deployment configuration for your service. The deployment is initiated by changing properties. For example, the deployment might be initiated by the task definition or by your desired count of a service. This is done with an UpdateService operation. The default value for a replica service for `minimumHealthyPercent` is 100%. The default value for a daemon service for `minimumHealthyPercent` is 0%.

If a service uses 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. Specifically, it represents it as a percentage of your desired number of tasks (rounded up to the nearest integer). This happens when any of your container instances are in the `DRAINING` state if the service contains tasks using the EC2 launch type. Using this parameter, you can deploy without using additional cluster capacity. For example, if you set your service to have desired number of four tasks and a minimum healthy percent of 50%, the scheduler might stop two existing tasks to free up cluster capacity before starting two new tasks. If they're in the `RUNNING` state, tasks for services that don't use a load balancer are considered healthy . If they're in the `RUNNING` state and reported as healthy by the load balancer, tasks for services that do use a load balancer are considered healthy . The default value for minimum healthy percent is 100%.

If a service uses 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. Specifically, it represents it as a percentage of the desired number of tasks (rounded down to the nearest integer). This happens when any of your container instances are in the `DRAINING` state if the service contains tasks using the EC2 launch type. Using this parameter, you can 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 uses either the `CODE_DEPLOY` or `EXTERNAL` deployment controller types and tasks that use the EC2 launch type, the minimum healthy percent and maximum percent values are used only to define the lower and upper limit on the number of the tasks in the service that remain in the `RUNNING` state. This is 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 aren't used. This is the case even if they're currently visible when describing your service.

When creating a service that uses the `EXTERNAL` deployment controller, you can specify only parameters that aren't controlled at the task set level. The only required parameter is the service name. You control your services using the CreateTaskSet operation. For more information, see Amazon ECS deployment types in the Amazon Elastic Container Service Developer Guide.

When the service scheduler launches new tasks, it determines task placement. For information about task placement and task placement strategies, see Amazon ECS task placement in the Amazon Elastic Container Service Developer Guide.

" }, "CreateTaskSet":{ "name":"CreateTaskSet", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreateTaskSetRequest"}, "output":{"shape":"CreateTaskSetResponse"}, "errors":[ {"shape":"ServerException"}, {"shape":"ClientException"}, {"shape":"InvalidParameterException"}, {"shape":"ClusterNotFoundException"}, {"shape":"UnsupportedFeatureException"}, {"shape":"PlatformUnknownException"}, {"shape":"PlatformTaskDefinitionIncompatibilityException"}, {"shape":"AccessDeniedException"}, {"shape":"ServiceNotFoundException"}, {"shape":"ServiceNotActiveException"}, {"shape":"NamespaceNotFoundException"} ], "documentation":"

Create a task set in the specified cluster and service. This is used when a service uses the `EXTERNAL` deployment controller type. For more information, see Amazon ECS deployment types in the Amazon Elastic Container Service Developer Guide.

You can create a maximum of 5 tasks sets for a deployment.

" }, "DeleteAccountSetting":{ "name":"DeleteAccountSetting", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeleteAccountSettingRequest"}, "output":{"shape":"DeleteAccountSettingResponse"}, "errors":[ {"shape":"ServerException"}, {"shape":"ClientException"}, {"shape":"InvalidParameterException"} ], "documentation":"

Disables an account setting for a specified user, role, or the root user for an account.

" }, "DeleteAttributes":{ "name":"DeleteAttributes", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeleteAttributesRequest"}, "output":{"shape":"DeleteAttributesResponse"}, "errors":[ {"shape":"ClusterNotFoundException"}, {"shape":"TargetNotFoundException"}, {"shape":"InvalidParameterException"} ], "documentation":"

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

" }, "DeleteCapacityProvider":{ "name":"DeleteCapacityProvider", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeleteCapacityProviderRequest"}, "output":{"shape":"DeleteCapacityProviderResponse"}, "errors":[ {"shape":"ServerException"}, {"shape":"ClientException"}, {"shape":"InvalidParameterException"} ], "documentation":"

Deletes the specified capacity provider.

The `FARGATE` and `FARGATE_SPOT` capacity providers are reserved and can't be deleted. You can disassociate them from a cluster using either the PutClusterCapacityProviders API or by deleting the cluster.

Prior to a capacity provider being deleted, the capacity provider must be removed from the capacity provider strategy from all services. The UpdateService API can be used to remove a capacity provider from a service's capacity provider strategy. When updating a service, the `forceNewDeployment` option can be used to ensure that any tasks using the Amazon EC2 instance capacity provided by the capacity provider are transitioned to use the capacity from the remaining capacity providers. Only capacity providers that aren't associated with a cluster can be deleted. To remove a capacity provider from a cluster, you can either use PutClusterCapacityProviders or delete the cluster.

" }, "DeleteCluster":{ "name":"DeleteCluster", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeleteClusterRequest"}, "output":{"shape":"DeleteClusterResponse"}, "errors":[ {"shape":"ServerException"}, {"shape":"ClientException"}, {"shape":"InvalidParameterException"}, {"shape":"ClusterNotFoundException"}, {"shape":"ClusterContainsContainerInstancesException"}, {"shape":"ClusterContainsServicesException"}, {"shape":"ClusterContainsTasksException"}, {"shape":"UpdateInProgressException"} ], "documentation":"

Deletes the specified cluster. The cluster transitions to the `INACTIVE` state. Clusters with an `INACTIVE` status might remain discoverable in your account for a period of time. However, this behavior is subject to change in the future. We don't recommend that you rely on `INACTIVE` clusters persisting.

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":{ "name":"DeleteService", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeleteServiceRequest"}, "output":{"shape":"DeleteServiceResponse"}, "errors":[ {"shape":"ServerException"}, {"shape":"ClientException"}, {"shape":"InvalidParameterException"}, {"shape":"ClusterNotFoundException"}, {"shape":"ServiceNotFoundException"} ], "documentation":"

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 can't 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 all tasks have transitioned to either `STOPPING` or `STOPPED` status, 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.

" }, "DeleteTaskDefinitions":{ "name":"DeleteTaskDefinitions", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeleteTaskDefinitionsRequest"}, "output":{"shape":"DeleteTaskDefinitionsResponse"}, "errors":[ {"shape":"AccessDeniedException"}, {"shape":"ClientException"}, {"shape":"InvalidParameterException"}, {"shape":"ServerException"} ], "documentation":"

Deletes one or more task definitions.

You must deregister a task definition revision before you delete it. For more information, see DeregisterTaskDefinition.

When you delete a task definition revision, it is immediately transitions from the `INACTIVE` to `DELETE_IN_PROGRESS`. Existing tasks and services that reference a `DELETE_IN_PROGRESS` task definition revision continue to run without disruption. Existing services that reference a `DELETE_IN_PROGRESS` task definition revision can still scale up or down by modifying the service's desired count.

You can't use a `DELETE_IN_PROGRESS` task definition revision to run new tasks or create new services. You also can't update an existing service to reference a `DELETE_IN_PROGRESS` task definition revision.

A task definition revision will stay in `DELETE_IN_PROGRESS` status until all the associated tasks and services have been terminated.

When you delete all `INACTIVE` task definition revisions, the task definition name is not displayed in the console and not returned in the API. If a task definition revisions are in the `DELETE_IN_PROGRESS` state, the task definition name is displayed in the console and returned in the API. The task definition name is retained by Amazon ECS and the revision is incremented the next time you create a task definition with that name.

" }, "DeleteTaskSet":{ "name":"DeleteTaskSet", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeleteTaskSetRequest"}, "output":{"shape":"DeleteTaskSetResponse"}, "errors":[ {"shape":"ServerException"}, {"shape":"ClientException"}, {"shape":"InvalidParameterException"}, {"shape":"ClusterNotFoundException"}, {"shape":"UnsupportedFeatureException"}, {"shape":"AccessDeniedException"}, {"shape":"ServiceNotFoundException"}, {"shape":"ServiceNotActiveException"}, {"shape":"TaskSetNotFoundException"} ], "documentation":"

Deletes a specified task set within a service. This is used when a service uses the `EXTERNAL` deployment controller type. For more information, see Amazon ECS deployment types in the Amazon Elastic Container Service Developer Guide.

" }, "DeregisterContainerInstance":{ "name":"DeregisterContainerInstance", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeregisterContainerInstanceRequest"}, "output":{"shape":"DeregisterContainerInstanceResponse"}, "errors":[ {"shape":"ServerException"}, {"shape":"ClientException"}, {"shape":"InvalidParameterException"}, {"shape":"ClusterNotFoundException"} ], "documentation":"

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, we recommend that you 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 doesn't 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 aren't automatically deregistered when terminated).

" }, "DeregisterTaskDefinition":{ "name":"DeregisterTaskDefinition", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeregisterTaskDefinitionRequest"}, "output":{"shape":"DeregisterTaskDefinitionResponse"}, "errors":[ {"shape":"ServerException"}, {"shape":"ClientException"}, {"shape":"InvalidParameterException"} ], "documentation":"

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. If you want to delete a task definition revision, you must first deregister the task definition revision.

You can't use an `INACTIVE` task definition to run new tasks or create new services, and you can't 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. We don't recommend that you rely on `INACTIVE` task definitions persisting beyond the lifecycle of any associated tasks and services.

You must deregister a task definition revision before you delete it. For more information, see DeleteTaskDefinitions.

" }, "DescribeCapacityProviders":{ "name":"DescribeCapacityProviders", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeCapacityProvidersRequest"}, "output":{"shape":"DescribeCapacityProvidersResponse"}, "errors":[ {"shape":"ServerException"}, {"shape":"ClientException"}, {"shape":"InvalidParameterException"} ], "documentation":"

Describes one or more of your capacity providers.

" }, "DescribeClusters":{ "name":"DescribeClusters", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeClustersRequest"}, "output":{"shape":"DescribeClustersResponse"}, "errors":[ {"shape":"ServerException"}, {"shape":"ClientException"}, {"shape":"InvalidParameterException"} ], "documentation":"

Describes one or more of your clusters.

" }, "DescribeContainerInstances":{ "name":"DescribeContainerInstances", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeContainerInstancesRequest"}, "output":{"shape":"DescribeContainerInstancesResponse"}, "errors":[ {"shape":"ServerException"}, {"shape":"ClientException"}, {"shape":"InvalidParameterException"}, {"shape":"ClusterNotFoundException"} ], "documentation":"

Describes one or more container instances. Returns metadata about each container instance requested.

" }, "DescribeServices":{ "name":"DescribeServices", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeServicesRequest"}, "output":{"shape":"DescribeServicesResponse"}, "errors":[ {"shape":"ServerException"}, {"shape":"ClientException"}, {"shape":"InvalidParameterException"}, {"shape":"ClusterNotFoundException"} ], "documentation":"

Describes the specified services running in your cluster.

" }, "DescribeTaskDefinition":{ "name":"DescribeTaskDefinition", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeTaskDefinitionRequest"}, "output":{"shape":"DescribeTaskDefinitionResponse"}, "errors":[ {"shape":"ServerException"}, {"shape":"ClientException"}, {"shape":"InvalidParameterException"} ], "documentation":"

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.

" }, "DescribeTaskSets":{ "name":"DescribeTaskSets", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeTaskSetsRequest"}, "output":{"shape":"DescribeTaskSetsResponse"}, "errors":[ {"shape":"ServerException"}, {"shape":"ClientException"}, {"shape":"InvalidParameterException"}, {"shape":"ClusterNotFoundException"}, {"shape":"UnsupportedFeatureException"}, {"shape":"AccessDeniedException"}, {"shape":"ServiceNotFoundException"}, {"shape":"ServiceNotActiveException"} ], "documentation":"

Describes the task sets in the specified cluster and service. This is used when a service uses the `EXTERNAL` deployment controller type. For more information, see Amazon ECS Deployment Types in the Amazon Elastic Container Service Developer Guide.

" }, "DescribeTasks":{ "name":"DescribeTasks", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeTasksRequest"}, "output":{"shape":"DescribeTasksResponse"}, "errors":[ {"shape":"ServerException"}, {"shape":"ClientException"}, {"shape":"InvalidParameterException"}, {"shape":"ClusterNotFoundException"} ], "documentation":"

Describes a specified task or tasks.

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

If you have tasks with tags, and then delete the cluster, the tagged tasks are returned in the response. If you create a new cluster with the same name as the deleted cluster, the tagged tasks are not included in the response.

" }, "DiscoverPollEndpoint":{ "name":"DiscoverPollEndpoint", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DiscoverPollEndpointRequest"}, "output":{"shape":"DiscoverPollEndpointResponse"}, "errors":[ {"shape":"ServerException"}, {"shape":"ClientException"} ], "documentation":"

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.

" }, "ExecuteCommand":{ "name":"ExecuteCommand", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ExecuteCommandRequest"}, "output":{"shape":"ExecuteCommandResponse"}, "errors":[ {"shape":"ServerException"}, {"shape":"ClientException"}, {"shape":"InvalidParameterException"}, {"shape":"AccessDeniedException"}, {"shape":"ClusterNotFoundException"}, {"shape":"TargetNotConnectedException"} ], "documentation":"

Runs a command remotely on a container within a task.

If you use a condition key in your IAM policy to refine the conditions for the policy statement, for example limit the actions to a specific cluster, you receive an `AccessDeniedException` when there is a mismatch between the condition key value and the corresponding parameter value.

For information about required permissions and considerations, see Using Amazon ECS Exec for debugging in the Amazon ECS Developer Guide.

" }, "GetTaskProtection":{ "name":"GetTaskProtection", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"GetTaskProtectionRequest"}, "output":{"shape":"GetTaskProtectionResponse"}, "errors":[ {"shape":"AccessDeniedException"}, {"shape":"ClientException"}, {"shape":"ClusterNotFoundException"}, {"shape":"InvalidParameterException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ServerException"}, {"shape":"UnsupportedFeatureException"} ], "documentation":"

Retrieves the protection status of tasks in an Amazon ECS service.

" }, "ListAccountSettings":{ "name":"ListAccountSettings", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ListAccountSettingsRequest"}, "output":{"shape":"ListAccountSettingsResponse"}, "errors":[ {"shape":"ServerException"}, {"shape":"ClientException"}, {"shape":"InvalidParameterException"} ], "documentation":"

Lists the account settings for a specified principal.

" }, "ListAttributes":{ "name":"ListAttributes", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ListAttributesRequest"}, "output":{"shape":"ListAttributesResponse"}, "errors":[ {"shape":"ClusterNotFoundException"}, {"shape":"InvalidParameterException"} ], "documentation":"

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. You can do this, for example, to see which container instances in a cluster are running a Linux AMI (`ecs.os-type=linux`).

" }, "ListClusters":{ "name":"ListClusters", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ListClustersRequest"}, "output":{"shape":"ListClustersResponse"}, "errors":[ {"shape":"ServerException"}, {"shape":"ClientException"}, {"shape":"InvalidParameterException"} ], "documentation":"

Returns a list of existing clusters.

" }, "ListContainerInstances":{ "name":"ListContainerInstances", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ListContainerInstancesRequest"}, "output":{"shape":"ListContainerInstancesResponse"}, "errors":[ {"shape":"ServerException"}, {"shape":"ClientException"}, {"shape":"InvalidParameterException"}, {"shape":"ClusterNotFoundException"} ], "documentation":"

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":{ "name":"ListServices", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ListServicesRequest"}, "output":{"shape":"ListServicesResponse"}, "errors":[ {"shape":"ServerException"}, {"shape":"ClientException"}, {"shape":"InvalidParameterException"}, {"shape":"ClusterNotFoundException"} ], "documentation":"

Returns a list of services. You can filter the results by cluster, launch type, and scheduling strategy.

" }, "ListServicesByNamespace":{ "name":"ListServicesByNamespace", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ListServicesByNamespaceRequest"}, "output":{"shape":"ListServicesByNamespaceResponse"}, "errors":[ {"shape":"ServerException"}, {"shape":"ClientException"}, {"shape":"InvalidParameterException"}, {"shape":"NamespaceNotFoundException"} ], "documentation":"

This operation lists all of the services that are associated with a Cloud Map namespace. This list might include services in different clusters. In contrast, `ListServices` can only list services in one cluster at a time. If you need to filter the list of services in a single cluster by various parameters, use `ListServices`. For more information, see Service Connect in the Amazon Elastic Container Service Developer Guide.

" }, "ListTagsForResource":{ "name":"ListTagsForResource", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ListTagsForResourceRequest"}, "output":{"shape":"ListTagsForResourceResponse"}, "errors":[ {"shape":"ServerException"}, {"shape":"ClientException"}, {"shape":"ClusterNotFoundException"}, {"shape":"InvalidParameterException"} ], "documentation":"

List the tags for an Amazon ECS resource.

" }, "ListTaskDefinitionFamilies":{ "name":"ListTaskDefinitionFamilies", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ListTaskDefinitionFamiliesRequest"}, "output":{"shape":"ListTaskDefinitionFamiliesResponse"}, "errors":[ {"shape":"ServerException"}, {"shape":"ClientException"}, {"shape":"InvalidParameterException"} ], "documentation":"

Returns a list of task definition families that are registered to your account. This list includes task definition families that no longer have any `ACTIVE` task definition revisions.

You can filter out task definition families that don't contain any `ACTIVE` task definition revisions by setting the `status` parameter to `ACTIVE`. You can also filter the results with the `familyPrefix` parameter.

" }, "ListTaskDefinitions":{ "name":"ListTaskDefinitions", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ListTaskDefinitionsRequest"}, "output":{"shape":"ListTaskDefinitionsResponse"}, "errors":[ {"shape":"ServerException"}, {"shape":"ClientException"}, {"shape":"InvalidParameterException"} ], "documentation":"

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":{ "name":"ListTasks", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ListTasksRequest"}, "output":{"shape":"ListTasksResponse"}, "errors":[ {"shape":"ServerException"}, {"shape":"ClientException"}, {"shape":"InvalidParameterException"}, {"shape":"ClusterNotFoundException"}, {"shape":"ServiceNotFoundException"} ], "documentation":"

Returns a list of tasks. You can filter the results by cluster, task definition family, container instance, launch type, what IAM principal started the task, or by the desired status of the task.

Recently stopped tasks might appear in the returned results.

" }, "PutAccountSetting":{ "name":"PutAccountSetting", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"PutAccountSettingRequest"}, "output":{"shape":"PutAccountSettingResponse"}, "errors":[ {"shape":"ServerException"}, {"shape":"ClientException"}, {"shape":"InvalidParameterException"} ], "documentation":"

Modifies an account setting. Account settings are set on a per-Region basis.

If you change the root user account setting, the default settings are reset for users and roles that do not have specified individual account settings. For more information, see Account Settings in the Amazon Elastic Container Service Developer Guide.

When you specify `serviceLongArnFormat`, `taskLongArnFormat`, or `containerInstanceLongArnFormat`, the Amazon Resource Name (ARN) and resource ID format of the resource type for a specified user, role, or the root user for an account is affected. The opt-in and opt-out account setting must be set for each Amazon ECS resource separately. The ARN and resource ID format of a resource is defined by the opt-in status of the user or role that created the resource. You must turn on this setting to use Amazon ECS features such as resource tagging.

When you specify `awsvpcTrunking`, the elastic network interface (ENI) limit for any new container instances that support the feature is changed. If `awsvpcTrunking` is turned on, any new container instances that support the feature are launched have the increased ENI limits available to them. For more information, see Elastic Network Interface Trunking in the Amazon Elastic Container Service Developer Guide.

When you specify `containerInsights`, the default setting indicating whether Amazon Web Services CloudWatch Container Insights is turned on for your clusters is changed. If `containerInsights` is turned on, any new clusters that are created will have Container Insights turned on unless you disable it during cluster creation. For more information, see CloudWatch Container Insights in the Amazon Elastic Container Service Developer Guide.

Amazon ECS is introducing tagging authorization for resource creation. Users must have permissions for actions that create the resource, such as `ecsCreateCluster`. If tags are specified when you create a resource, Amazon Web Services performs additional authorization to verify if users or roles have permissions to create tags. Therefore, you must grant explicit permissions to use the `ecs:TagResource` action. For more information, see Grant permission to tag resources on creation in the Amazon ECS Developer Guide.

When Amazon Web Services determines that a security or infrastructure update is needed for an Amazon ECS task hosted on Fargate, the tasks need to be stopped and new tasks launched to replace them. Use `fargateTaskRetirementWaitPeriod` to configure the wait time to retire a Fargate task. For information about the Fargate tasks maintenance, see Amazon Web Services Fargate task maintenance in the Amazon ECS Developer Guide.

The `guardDutyActivate` parameter is read-only in Amazon ECS and indicates whether Amazon ECS Runtime Monitoring is enabled or disabled by your security administrator in your Amazon ECS account. Amazon GuardDuty controls this account setting on your behalf. For more information, see Protecting Amazon ECS workloads with Amazon ECS Runtime Monitoring.

" }, "PutAccountSettingDefault":{ "name":"PutAccountSettingDefault", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"PutAccountSettingDefaultRequest"}, "output":{"shape":"PutAccountSettingDefaultResponse"}, "errors":[ {"shape":"ServerException"}, {"shape":"ClientException"}, {"shape":"InvalidParameterException"} ], "documentation":"

Modifies an account setting for all users on an account for whom no individual account setting has been specified. Account settings are set on a per-Region basis.

" }, "PutAttributes":{ "name":"PutAttributes", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"PutAttributesRequest"}, "output":{"shape":"PutAttributesResponse"}, "errors":[ {"shape":"ClusterNotFoundException"}, {"shape":"TargetNotFoundException"}, {"shape":"AttributeLimitExceededException"}, {"shape":"InvalidParameterException"} ], "documentation":"

Create or update an attribute on an Amazon ECS resource. If the attribute doesn't exist, it's 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.

" }, "PutClusterCapacityProviders":{ "name":"PutClusterCapacityProviders", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"PutClusterCapacityProvidersRequest"}, "output":{"shape":"PutClusterCapacityProvidersResponse"}, "errors":[ {"shape":"ServerException"}, {"shape":"ClientException"}, {"shape":"InvalidParameterException"}, {"shape":"ClusterNotFoundException"}, {"shape":"ResourceInUseException"}, {"shape":"UpdateInProgressException"} ], "documentation":"

Modifies the available capacity providers and the default capacity provider strategy for a cluster.

You must specify both the available capacity providers and a default capacity provider strategy for the cluster. If the specified cluster has existing capacity providers associated with it, you must specify all existing capacity providers in addition to any new ones you want to add. Any existing capacity providers that are associated with a cluster that are omitted from a PutClusterCapacityProviders API call will be disassociated with the cluster. You can only disassociate an existing capacity provider from a cluster if it's not being used by any existing tasks.

When creating a service or running a task on a cluster, if no capacity provider or launch type is specified, then the cluster's default capacity provider strategy is used. We recommend that you define a default capacity provider strategy for your cluster. However, you must specify an empty array (`[]`) to bypass defining a default strategy.

" }, "RegisterContainerInstance":{ "name":"RegisterContainerInstance", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"RegisterContainerInstanceRequest"}, "output":{"shape":"RegisterContainerInstanceResponse"}, "errors":[ {"shape":"ServerException"}, {"shape":"ClientException"}, {"shape":"InvalidParameterException"} ], "documentation":"

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":{ "name":"RegisterTaskDefinition", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"RegisterTaskDefinitionRequest"}, "output":{"shape":"RegisterTaskDefinitionResponse"}, "errors":[ {"shape":"ServerException"}, {"shape":"ClientException"}, {"shape":"InvalidParameterException"} ], "documentation":"

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 a role for your task with the `taskRoleArn` parameter. When you specify a role for a task, its containers can then use the latest versions of the CLI or SDKs to make API requests to the Amazon Web Services services that are specified in the policy that's 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":{ "name":"RunTask", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"RunTaskRequest"}, "output":{"shape":"RunTaskResponse"}, "errors":[ {"shape":"ServerException"}, {"shape":"ClientException"}, {"shape":"InvalidParameterException"}, {"shape":"ClusterNotFoundException"}, {"shape":"UnsupportedFeatureException"}, {"shape":"PlatformUnknownException"}, {"shape":"PlatformTaskDefinitionIncompatibilityException"}, {"shape":"AccessDeniedException"}, {"shape":"BlockedException"}, {"shape":"ConflictException"} ], "documentation":"

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.

Starting April 15, 2023, Amazon Web Services will not onboard new customers to Amazon Elastic Inference (EI), and will help current customers migrate their workloads to options that offer better price and performance. After April 15, 2023, new customers will not be able to launch instances with Amazon EI accelerators in Amazon SageMaker, Amazon ECS, or Amazon EC2. However, customers who have used Amazon EI at least once during the past 30-day period are considered current customers and will be able to continue using the service.

You can attach Amazon EBS volumes to Amazon ECS tasks by configuring the volume when creating or updating a service. For more infomation, see Amazon EBS volumes in the Amazon Elastic Container Service Developer Guide.

The Amazon ECS API follows an eventual consistency model. This is because of 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:

- Confirm the state of the resource before you run a command to modify it. Run the DescribeTasks command using an exponential backoff algorithm to ensure that you allow enough time for the previous command to propagate through the system. To do this, run the DescribeTasks command repeatedly, starting with a couple of seconds of wait time and increasing gradually up to five minutes of wait time.

- Add wait time between subsequent commands, even if the DescribeTasks command returns an accurate response. Apply an exponential backoff algorithm starting with a couple of seconds of wait time, and increase gradually up to about five minutes of wait time.

" }, "StartTask":{ "name":"StartTask", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"StartTaskRequest"}, "output":{"shape":"StartTaskResponse"}, "errors":[ {"shape":"ServerException"}, {"shape":"ClientException"}, {"shape":"InvalidParameterException"}, {"shape":"ClusterNotFoundException"}, {"shape":"UnsupportedFeatureException"} ], "documentation":"

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

Starting April 15, 2023, Amazon Web Services will not onboard new customers to Amazon Elastic Inference (EI), and will help current customers migrate their workloads to options that offer better price and performance. After April 15, 2023, new customers will not be able to launch instances with Amazon EI accelerators in Amazon SageMaker, Amazon ECS, or Amazon EC2. However, customers who have used Amazon EI at least once during the past 30-day period are considered current customers and will be able to continue using the service.

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

You can attach Amazon EBS volumes to Amazon ECS tasks by configuring the volume when creating or updating a service. For more infomation, see Amazon EBS volumes in the Amazon Elastic Container Service Developer Guide.

" }, "StopTask":{ "name":"StopTask", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"StopTaskRequest"}, "output":{"shape":"StopTaskResponse"}, "errors":[ {"shape":"ServerException"}, {"shape":"ClientException"}, {"shape":"InvalidParameterException"}, {"shape":"ClusterNotFoundException"} ], "documentation":"

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.

" }, "SubmitAttachmentStateChanges":{ "name":"SubmitAttachmentStateChanges", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"SubmitAttachmentStateChangesRequest"}, "output":{"shape":"SubmitAttachmentStateChangesResponse"}, "errors":[ {"shape":"ServerException"}, {"shape":"ClientException"}, {"shape":"AccessDeniedException"}, {"shape":"InvalidParameterException"} ], "documentation":"

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 an attachment changed states.

" }, "SubmitContainerStateChange":{ "name":"SubmitContainerStateChange", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"SubmitContainerStateChangeRequest"}, "output":{"shape":"SubmitContainerStateChangeResponse"}, "errors":[ {"shape":"ServerException"}, {"shape":"ClientException"}, {"shape":"AccessDeniedException"} ], "documentation":"

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":{ "name":"SubmitTaskStateChange", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"SubmitTaskStateChangeRequest"}, "output":{"shape":"SubmitTaskStateChangeResponse"}, "errors":[ {"shape":"ServerException"}, {"shape":"ClientException"}, {"shape":"AccessDeniedException"}, {"shape":"InvalidParameterException"} ], "documentation":"

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":{ "name":"TagResource", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"TagResourceRequest"}, "output":{"shape":"TagResourceResponse"}, "errors":[ {"shape":"ServerException"}, {"shape":"ClientException"}, {"shape":"ClusterNotFoundException"}, {"shape":"ResourceNotFoundException"}, {"shape":"InvalidParameterException"} ], "documentation":"

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

" }, "UntagResource":{ "name":"UntagResource", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"UntagResourceRequest"}, "output":{"shape":"UntagResourceResponse"}, "errors":[ {"shape":"ServerException"}, {"shape":"ClientException"}, {"shape":"ClusterNotFoundException"}, {"shape":"ResourceNotFoundException"}, {"shape":"InvalidParameterException"} ], "documentation":"

Deletes specified tags from a resource.

" }, "UpdateCapacityProvider":{ "name":"UpdateCapacityProvider", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"UpdateCapacityProviderRequest"}, "output":{"shape":"UpdateCapacityProviderResponse"}, "errors":[ {"shape":"ServerException"}, {"shape":"ClientException"}, {"shape":"InvalidParameterException"} ], "documentation":"

Modifies the parameters for a capacity provider.

" }, "UpdateCluster":{ "name":"UpdateCluster", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"UpdateClusterRequest"}, "output":{"shape":"UpdateClusterResponse"}, "errors":[ {"shape":"ServerException"}, {"shape":"ClientException"}, {"shape":"ClusterNotFoundException"}, {"shape":"InvalidParameterException"}, {"shape":"NamespaceNotFoundException"} ], "documentation":"

Updates the cluster.

" }, "UpdateClusterSettings":{ "name":"UpdateClusterSettings", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"UpdateClusterSettingsRequest"}, "output":{"shape":"UpdateClusterSettingsResponse"}, "errors":[ {"shape":"ServerException"}, {"shape":"ClientException"}, {"shape":"ClusterNotFoundException"}, {"shape":"InvalidParameterException"} ], "documentation":"

Modifies the settings to use for a cluster.

" }, "UpdateContainerAgent":{ "name":"UpdateContainerAgent", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"UpdateContainerAgentRequest"}, "output":{"shape":"UpdateContainerAgentResponse"}, "errors":[ {"shape":"ServerException"}, {"shape":"ClientException"}, {"shape":"InvalidParameterException"}, {"shape":"ClusterNotFoundException"}, {"shape":"UpdateInProgressException"}, {"shape":"NoUpdateAvailableException"}, {"shape":"MissingVersionException"} ], "documentation":"

Updates the Amazon ECS container agent on a specified container instance. Updating the Amazon ECS container agent doesn't 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.

The `UpdateContainerAgent` API isn't supported for container instances using the Amazon ECS-optimized Amazon Linux 2 (arm64) AMI. To update the container agent, you can update the `ecs-init` package. This updates the agent. For more information, see Updating the Amazon ECS container agent in the Amazon Elastic Container Service Developer Guide.

Agent updates with the `UpdateContainerAgent` API operation do not apply to Windows container instances. We recommend that you launch new container instances to update the agent version in your Windows clusters.

The `UpdateContainerAgent` API requires an Amazon ECS-optimized AMI or Amazon Linux AMI 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":{ "name":"UpdateContainerInstancesState", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"UpdateContainerInstancesStateRequest"}, "output":{"shape":"UpdateContainerInstancesStateResponse"}, "errors":[ {"shape":"ServerException"}, {"shape":"ClientException"}, {"shape":"InvalidParameterException"}, {"shape":"ClusterNotFoundException"} ], "documentation":"

Modifies the status of an Amazon ECS container instance.

Once a container instance has reached an `ACTIVE` state, 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.

A container instance can't be changed to `DRAINING` until it has reached an `ACTIVE` status. If the instance is in any other status, an error will be received.

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.

- If `minimumHealthyPercent` is below 100%, the scheduler can ignore `desiredCount` temporarily during task replacement. For example, `desiredCount` is four tasks, a minimum of 50% allows the scheduler to stop two existing tasks before starting two new tasks. If the minimum is 100%, the service scheduler can't remove existing tasks until the replacement tasks are considered healthy. Tasks for services that do not use a load balancer are considered healthy if they're in the `RUNNING` state. Tasks for services that use a load balancer are considered healthy if they're in the `RUNNING` state and are reported as healthy by the load balancer.

- The `maximumPercent` parameter represents an upper limit on the number of running tasks during task replacement. You can use this to define the replacement batch size. For example, if `desiredCount` is four tasks, a maximum of 200% starts four new tasks before stopping the four tasks to be drained, provided that the cluster resources required to do this are available. If the maximum is 100%, then replacement tasks can't start until the draining tasks have stopped.

Any `PENDING` or `RUNNING` tasks that do not belong to a service aren't 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 a container instance has been drained, you can set a container instance to `ACTIVE` status and once it has reached that status the Amazon ECS scheduler can begin scheduling tasks on the instance again.

" }, "UpdateService":{ "name":"UpdateService", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"UpdateServiceRequest"}, "output":{"shape":"UpdateServiceResponse"}, "errors":[ {"shape":"ServerException"}, {"shape":"ClientException"}, {"shape":"InvalidParameterException"}, {"shape":"ClusterNotFoundException"}, {"shape":"ServiceNotFoundException"}, {"shape":"ServiceNotActiveException"}, {"shape":"PlatformUnknownException"}, {"shape":"PlatformTaskDefinitionIncompatibilityException"}, {"shape":"AccessDeniedException"}, {"shape":"NamespaceNotFoundException"}, {"shape":"UnsupportedFeatureException"} ], "documentation":"

Modifies the parameters of a service.

For services using the rolling update (`ECS`) you can update the desired count, deployment configuration, network configuration, load balancers, service registries, enable ECS managed tags option, propagate tags option, task placement constraints and strategies, and task definition. When you update any of these parameters, Amazon ECS starts new tasks with the new configuration.

You can attach Amazon EBS volumes to Amazon ECS tasks by configuring the volume when starting or running a task, or when creating or updating a service. For more infomation, see Amazon EBS volumes in the Amazon Elastic Container Service Developer Guide. You can update your volume configurations and trigger a new deployment. `volumeConfigurations` is only supported for REPLICA service and not DAEMON service. If you leave `volumeConfigurations` `null`, it doesn't trigger a new deployment. For more infomation on volumes, see Amazon EBS volumes in the Amazon Elastic Container Service Developer Guide.

For services using the blue/green (`CODE_DEPLOY`) deployment controller, only the desired count, deployment configuration, health check grace period, task placement constraints and strategies, enable ECS managed tags option, and propagate tags can be updated using this API. If the network configuration, platform version, task definition, or load balancer need to be updated, create a new CodeDeploy deployment. For more information, see CreateDeployment in the CodeDeploy API Reference.

For services using an external deployment controller, you can update only the desired count, task placement constraints and strategies, health check grace period, enable ECS managed tags option, and propagate tags option, using this API. If the launch type, load balancer, network configuration, platform version, or task definition need to be updated, create a new task set For more information, see CreateTaskSet.

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

You can attach Amazon EBS volumes to Amazon ECS tasks by configuring the volume when starting or running a task, or when creating or updating a service. For more infomation, see Amazon EBS volumes in the Amazon Elastic Container Service Developer Guide.

If you have updated the container 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 don't 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.

- If `minimumHealthyPercent` is below 100%, the scheduler can ignore `desiredCount` temporarily during a deployment. For example, if `desiredCount` is four tasks, a minimum of 50% allows the scheduler to stop two existing tasks before starting two new tasks. Tasks for services that don't use a load balancer are considered healthy if they're in the `RUNNING` state. Tasks for services that use a load balancer are considered healthy if they're in the `RUNNING` state and are reported as healthy by the load balancer.

- The `maximumPercent` parameter represents an upper limit on the number of running tasks during a deployment. You can use it to define the deployment batch size. For example, if `desiredCount` is four tasks, a maximum of 200% starts four new tasks before stopping the four older tasks (provided that the cluster resources required to do this are available).

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 this, `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.

- Determine which of the container instances in your cluster can support your service's task definition. For example, they have the required CPU, memory, ports, and container instance attributes.

- By default, the service scheduler attempts to balance tasks across Availability Zones in this manner even though you can choose a different placement strategy.

  - Sort the valid container instances by the fewest number of running tasks for this service in the same Availability Zone as the instance. For example, if zone A has one running service task and zones B and C each have zero, valid container instances in either zone B or C are considered optimal for placement.

  - Place the new service task on a valid container instance in an optimal Availability Zone (based on the previous steps), favoring container instances with the fewest number of running tasks for this service.

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

- Sort the container instances by the largest number of running tasks for this service in the same Availability Zone as the instance. For example, if zone A has one running service task and zones B and C each have two, container instances in either zone B or C are considered optimal for termination.

- Stop the task on a container instance in an optimal Availability Zone (based on the previous steps), favoring container instances with the largest number of running tasks for this service.

You must have a service-linked role when you update any of the following service properties:

- `loadBalancers`,

- `serviceRegistries`

For more information about the role see the `CreateService` request parameter `role` .

" }, "UpdateServicePrimaryTaskSet":{ "name":"UpdateServicePrimaryTaskSet", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"UpdateServicePrimaryTaskSetRequest"}, "output":{"shape":"UpdateServicePrimaryTaskSetResponse"}, "errors":[ {"shape":"ServerException"}, {"shape":"ClientException"}, {"shape":"InvalidParameterException"}, {"shape":"ClusterNotFoundException"}, {"shape":"UnsupportedFeatureException"}, {"shape":"ServiceNotFoundException"}, {"shape":"ServiceNotActiveException"}, {"shape":"TaskSetNotFoundException"}, {"shape":"AccessDeniedException"} ], "documentation":"

Modifies which task set in a service is the primary task set. Any parameters that are updated on the primary task set in a service will transition to the service. This is used when a service uses the `EXTERNAL` deployment controller type. For more information, see Amazon ECS Deployment Types in the Amazon Elastic Container Service Developer Guide.

" }, "UpdateTaskProtection":{ "name":"UpdateTaskProtection", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"UpdateTaskProtectionRequest"}, "output":{"shape":"UpdateTaskProtectionResponse"}, "errors":[ {"shape":"AccessDeniedException"}, {"shape":"ClientException"}, {"shape":"ClusterNotFoundException"}, {"shape":"InvalidParameterException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ServerException"}, {"shape":"UnsupportedFeatureException"} ], "documentation":"

Updates the protection status of a task. You can set `protectionEnabled` to `true` to protect your task from termination during scale-in events from Service Autoscaling or deployments.

Task-protection, by default, expires after 2 hours at which point Amazon ECS clears the `protectionEnabled` property making the task eligible for termination by a subsequent scale-in event.

You can specify a custom expiration period for task protection from 1 minute to up to 2,880 minutes (48 hours). To specify the custom expiration period, set the `expiresInMinutes` property. The `expiresInMinutes` property is always reset when you invoke this operation for a task that already has `protectionEnabled` set to `true`. You can keep extending the protection expiration period of a task by invoking this operation repeatedly.

To learn more about Amazon ECS task protection, see Task scale-in protection in the Amazon Elastic Container Service Developer Guide .

This operation is only supported for tasks belonging to an Amazon ECS service. Invoking this operation for a standalone task will result in an `TASK_NOT_VALID` failure. For more information, see API failure reasons.

If you prefer to set task protection from within the container, we recommend using the Task scale-in protection endpoint.

" }, "UpdateTaskSet":{ "name":"UpdateTaskSet", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"UpdateTaskSetRequest"}, "output":{"shape":"UpdateTaskSetResponse"}, "errors":[ {"shape":"ServerException"}, {"shape":"ClientException"}, {"shape":"InvalidParameterException"}, {"shape":"ClusterNotFoundException"}, {"shape":"UnsupportedFeatureException"}, {"shape":"AccessDeniedException"}, {"shape":"ServiceNotFoundException"}, {"shape":"ServiceNotActiveException"}, {"shape":"TaskSetNotFoundException"} ], "documentation":"

Modifies a task set. This is used when a service uses the `EXTERNAL` deployment controller type. For more information, see Amazon ECS Deployment Types in the Amazon Elastic Container Service Developer Guide.

" } }, "shapes":{ "AccessDeniedException":{ "type":"structure", "members":{ }, "documentation":"

You don't have authorization to perform the requested action.

", "exception":true }, "AgentUpdateStatus":{ "type":"string", "enum":[ "PENDING", "STAGING", "STAGED", "UPDATING", "UPDATED", "FAILED" ] }, "ApplicationProtocol":{ "type":"string", "enum":[ "http", "http2", "grpc" ] }, "AssignPublicIp":{ "type":"string", "enum":[ "ENABLED", "DISABLED" ] }, "Attachment":{ "type":"structure", "members":{ "id":{ "shape":"String", "documentation":"

The unique identifier for the attachment.

" }, "type":{ "shape":"String", "documentation":"

The type of the attachment, such as `ElasticNetworkInterface`, `Service Connect`, and `AmazonElasticBlockStorage`.

" }, "status":{ "shape":"String", "documentation":"

The status of the attachment. Valid values are `PRECREATED`, `CREATED`, `ATTACHING`, `ATTACHED`, `DETACHING`, `DETACHED`, `DELETED`, and `FAILED`.

" }, "details":{ "shape":"AttachmentDetails", "documentation":"

Details of the attachment.

For elastic network interfaces, this includes the network interface ID, the MAC address, the subnet ID, and the private IPv4 address.

For Service Connect services, this includes `portName`, `clientAliases`, `discoveryName`, and `ingressPortOverride`.

For elastic block storage, this includes `roleArn`, `encrypted`, `filesystemType`, `iops`, `kmsKeyId`, `sizeInGiB`, `snapshotId`, `tagSpecifications`, `throughput`, and `volumeType`.

" } }, "documentation":"

An object representing a container instance or task attachment.

" }, "AttachmentDetails":{ "type":"list", "member":{"shape":"KeyValuePair"} }, "AttachmentStateChange":{ "type":"structure", "required":[ "attachmentArn", "status" ], "members":{ "attachmentArn":{ "shape":"String", "documentation":"

The Amazon Resource Name (ARN) of the attachment.

" }, "status":{ "shape":"String", "documentation":"

The status of the attachment.

" } }, "documentation":"

An object representing a change in state for a task attachment.

" }, "AttachmentStateChanges":{ "type":"list", "member":{"shape":"AttachmentStateChange"} }, "Attachments":{ "type":"list", "member":{"shape":"Attachment"} }, "Attribute":{ "type":"structure", "required":["name"], "members":{ "name":{ "shape":"String", "documentation":"

The name of the attribute. The `name` must contain between 1 and 128 characters. The name may contain letters (uppercase and lowercase), numbers, hyphens (-), underscores (_), forward slashes (/), back slashes (\\), or periods (.).

" }, "value":{ "shape":"String", "documentation":"

The value of the attribute. The `value` must contain between 1 and 128 characters. It can contain letters (uppercase and lowercase), numbers, hyphens (-), underscores (_), periods (.), at signs (@), forward slashes (/), back slashes (\\), colons (:), or spaces. The value can't start or end with a space.

" }, "targetType":{ "shape":"TargetType", "documentation":"

The type of the target to attach the attribute with. This parameter is required if you use the short form ID for a resource instead of the full ARN.

" }, "targetId":{ "shape":"String", "documentation":"

The ID of the target. You can specify the short form ID for a resource or the full Amazon Resource Name (ARN).

" } }, "documentation":"

An attribute is a name-value pair that's associated with an Amazon ECS object. Use attributes to extend the Amazon ECS data model by adding custom metadata to your resources. For more information, see Attributes in the Amazon Elastic Container Service Developer Guide.

" }, "AttributeLimitExceededException":{ "type":"structure", "members":{ }, "documentation":"

You can apply up to 10 custom attributes for each resource. You can view the attributes of a resource with ListAttributes. You can remove existing attributes on a resource with DeleteAttributes.

", "exception":true }, "Attributes":{ "type":"list", "member":{"shape":"Attribute"} }, "AutoScalingGroupProvider":{ "type":"structure", "required":["autoScalingGroupArn"], "members":{ "autoScalingGroupArn":{ "shape":"String", "documentation":"

The Amazon Resource Name (ARN) that identifies the Auto Scaling group, or the Auto Scaling group name.

" }, "managedScaling":{ "shape":"ManagedScaling", "documentation":"

The managed scaling settings for the Auto Scaling group capacity provider.

" }, "managedTerminationProtection":{ "shape":"ManagedTerminationProtection", "documentation":"

The managed termination protection setting to use for the Auto Scaling group capacity provider. This determines whether the Auto Scaling group has managed termination protection. The default is off.

When using managed termination protection, managed scaling must also be used otherwise managed termination protection doesn't work.

When managed termination protection is on, Amazon ECS prevents the Amazon EC2 instances in an Auto Scaling group that contain tasks from being terminated during a scale-in action. The Auto Scaling group and each instance in the Auto Scaling group must have instance protection from scale-in actions on as well. For more information, see Instance Protection in the Auto Scaling User Guide.

When managed termination protection is off, your Amazon EC2 instances aren't protected from termination when the Auto Scaling group scales in.

" }, "managedDraining":{ "shape":"ManagedDraining", "documentation":"

The managed draining option for the Auto Scaling group capacity provider. When you enable this, Amazon ECS manages and gracefully drains the EC2 container instances that are in the Auto Scaling group capacity provider.

" } }, "documentation":"

The details of the Auto Scaling group for the capacity provider.

" }, "AutoScalingGroupProviderUpdate":{ "type":"structure", "members":{ "managedScaling":{ "shape":"ManagedScaling", "documentation":"

The managed scaling settings for the Auto Scaling group capacity provider.

" }, "managedTerminationProtection":{ "shape":"ManagedTerminationProtection", "documentation":"

The managed termination protection setting to use for the Auto Scaling group capacity provider. This determines whether the Auto Scaling group has managed termination protection.

When using managed termination protection, managed scaling must also be used otherwise managed termination protection doesn't work.

When managed termination protection is on, Amazon ECS prevents the Amazon EC2 instances in an Auto Scaling group that contain tasks from being terminated during a scale-in action. The Auto Scaling group and each instance in the Auto Scaling group must have instance protection from scale-in actions on. For more information, see Instance Protection in the Auto Scaling User Guide.

When managed termination protection is off, your Amazon EC2 instances aren't protected from termination when the Auto Scaling group scales in.

" }, "managedDraining":{ "shape":"ManagedDraining", "documentation":"

The managed draining option for the Auto Scaling group capacity provider. When you enable this, Amazon ECS manages and gracefully drains the EC2 container instances that are in the Auto Scaling group capacity provider.

" } }, "documentation":"

The details of the Auto Scaling group capacity provider to update.

" }, "AwsVpcConfiguration":{ "type":"structure", "required":["subnets"], "members":{ "subnets":{ "shape":"StringList", "documentation":"

The IDs of the subnets associated with the task or service. There's a limit of 16 subnets that can be specified per `AwsVpcConfiguration`.

All specified subnets must be from the same VPC.

" }, "securityGroups":{ "shape":"StringList", "documentation":"

The IDs of the security groups associated with the task or service. If you don't specify a security group, the default security group for the VPC is used. There's a limit of 5 security groups that can be specified per `AwsVpcConfiguration`.

All specified security groups must be from the same VPC.

" }, "assignPublicIp":{ "shape":"AssignPublicIp", "documentation":"

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

" } }, "documentation":"

An object representing the networking details for a task or service.

" }, "BlockedException":{ "type":"structure", "members":{ }, "documentation":"

Your Amazon Web Services account was blocked. For more information, contact Amazon Web Services Support.

", "exception":true }, "Boolean":{"type":"boolean"}, "BoxedBoolean":{ "type":"boolean", "box":true }, "BoxedInteger":{ "type":"integer", "box":true }, "CPUArchitecture":{ "type":"string", "enum":[ "X86_64", "ARM64" ] }, "CapacityProvider":{ "type":"structure", "members":{ "capacityProviderArn":{ "shape":"String", "documentation":"

The Amazon Resource Name (ARN) that identifies the capacity provider.

" }, "name":{ "shape":"String", "documentation":"

The name of the capacity provider.

" }, "status":{ "shape":"CapacityProviderStatus", "documentation":"

The current status of the capacity provider. Only capacity providers in an `ACTIVE` state can be used in a cluster. When a capacity provider is successfully deleted, it has an `INACTIVE` status.

" }, "autoScalingGroupProvider":{ "shape":"AutoScalingGroupProvider", "documentation":"

The Auto Scaling group settings for the capacity provider.

" }, "updateStatus":{ "shape":"CapacityProviderUpdateStatus", "documentation":"

The update status of the capacity provider. The following are the possible states that is returned.

DELETE_IN_PROGRESS

  The capacity provider is in the process of being deleted.

DELETE_COMPLETE

  The capacity provider was successfully deleted and has an `INACTIVE` status.

DELETE_FAILED

  The capacity provider can't be deleted. The update status reason provides further details about why the delete failed.

" }, "updateStatusReason":{ "shape":"String", "documentation":"

The update status reason. This provides further details about the update status for the capacity provider.

" }, "tags":{ "shape":"Tags", "documentation":"

The metadata that you apply to the capacity provider to help you categorize and organize it. Each tag consists of a key and an optional value. You define both.

The following basic restrictions apply to tags:

- Maximum number of tags per resource - 50

- For each resource, each tag key must be unique, and each tag key can have only one value.

- Maximum key length - 128 Unicode characters in UTF-8

- Maximum value length - 256 Unicode characters in UTF-8

- If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.

- Tag keys and values are case-sensitive.

- Do not use `aws:`, `AWS:`, or any upper or lowercase combination of such as a prefix for either keys or values as it is reserved for Amazon Web Services use. You cannot edit or delete tag keys or values with this prefix. Tags with this prefix do not count against your tags per resource limit.

" } }, "documentation":"

The details for a capacity provider.

" }, "CapacityProviderField":{ "type":"string", "enum":["TAGS"] }, "CapacityProviderFieldList":{ "type":"list", "member":{"shape":"CapacityProviderField"} }, "CapacityProviderStatus":{ "type":"string", "enum":[ "ACTIVE", "INACTIVE" ] }, "CapacityProviderStrategy":{ "type":"list", "member":{"shape":"CapacityProviderStrategyItem"} }, "CapacityProviderStrategyItem":{ "type":"structure", "required":["capacityProvider"], "members":{ "capacityProvider":{ "shape":"String", "documentation":"

The short name of the capacity provider.

" }, "weight":{ "shape":"CapacityProviderStrategyItemWeight", "documentation":"

The weight value designates the relative percentage of the total number of tasks launched that should use the specified capacity provider. The `weight` value is taken into consideration after the `base` value, if defined, is satisfied.

If no `weight` value is specified, the default value of `0` is used. When multiple capacity providers are specified within a capacity provider strategy, at least one of the capacity providers must have a weight value greater than zero and any capacity providers with a weight of `0` can't be used to place tasks. If you specify multiple capacity providers in a strategy that all have a weight of `0`, any `RunTask` or `CreateService` actions using the capacity provider strategy will fail.

An example scenario for using weights is defining a strategy that contains two capacity providers and both have a weight of `1`, then when the `base` is satisfied, the tasks will be split evenly across the two capacity providers. Using that same logic, if you specify a weight of `1` for capacityProviderA and a weight of `4` for capacityProviderB, then for every one task that's run using capacityProviderA, four tasks would use capacityProviderB.

" }, "base":{ "shape":"CapacityProviderStrategyItemBase", "documentation":"

The base value designates how many tasks, at a minimum, to run on the specified capacity provider. Only one capacity provider in a capacity provider strategy can have a base defined. If no value is specified, the default value of `0` is used.

" } }, "documentation":"

The details of a capacity provider strategy. A capacity provider strategy can be set when using the RunTask or CreateCluster APIs or as the default capacity provider strategy for a cluster with the CreateCluster API.

Only capacity providers that are already associated with a cluster and have an `ACTIVE` or `UPDATING` status can be used in a capacity provider strategy. The PutClusterCapacityProviders API is used to associate a capacity provider with a cluster.

If specifying a capacity provider that uses an Auto Scaling group, the capacity provider must already be created. New Auto Scaling group capacity providers can be created with the CreateCapacityProvider API operation.

To use a Fargate capacity provider, specify either the `FARGATE` or `FARGATE_SPOT` capacity providers. The Fargate capacity providers are available to all accounts and only need to be associated with a cluster to be used in a capacity provider strategy.

A capacity provider strategy may contain a maximum of 6 capacity providers.

" }, "CapacityProviderStrategyItemBase":{ "type":"integer", "max":100000, "min":0 }, "CapacityProviderStrategyItemWeight":{ "type":"integer", "max":1000, "min":0 }, "CapacityProviderUpdateStatus":{ "type":"string", "enum":[ "DELETE_IN_PROGRESS", "DELETE_COMPLETE", "DELETE_FAILED", "UPDATE_IN_PROGRESS", "UPDATE_COMPLETE", "UPDATE_FAILED" ] }, "CapacityProviders":{ "type":"list", "member":{"shape":"CapacityProvider"} }, "ClientException":{ "type":"structure", "members":{ "message":{ "shape":"String", "documentation":"

Message that describes the cause of the exception.

" } }, "documentation":"

These errors are usually caused by a client action. This client action might be using an action or resource on behalf of a user that doesn't have permissions to use the action or resource. Or, it might be specifying an identifier that isn't valid.

", "exception":true }, "Cluster":{ "type":"structure", "members":{ "clusterArn":{ "shape":"String", "documentation":"

The Amazon Resource Name (ARN) that identifies the cluster. For more information about the ARN format, see Amazon Resource Name (ARN) in the Amazon ECS Developer Guide.

" }, "clusterName":{ "shape":"String", "documentation":"

A user-generated string that you use to identify your cluster.

" }, "configuration":{ "shape":"ClusterConfiguration", "documentation":"

The execute command configuration for the cluster.

" }, "status":{ "shape":"String", "documentation":"

The status of the cluster. The following are the possible states that are returned.

ACTIVE

  The cluster is ready to accept tasks and if applicable you can register container instances with the cluster.

PROVISIONING

  The cluster has capacity providers that are associated with it and the resources needed for the capacity provider are being created.

DEPROVISIONING

  The cluster has capacity providers that are associated with it and the resources needed for the capacity provider are being deleted.

FAILED

  The cluster has capacity providers that are associated with it and the resources needed for the capacity provider have failed to create.

INACTIVE

  The cluster has been deleted. Clusters with an `INACTIVE` status may remain discoverable in your account for a period of time. However, this behavior is subject to change in the future. We don't recommend that you rely on `INACTIVE` clusters persisting.

" }, "registeredContainerInstancesCount":{ "shape":"Integer", "documentation":"

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

" }, "runningTasksCount":{ "shape":"Integer", "documentation":"

The number of tasks in the cluster that are in the `RUNNING` state.

" }, "pendingTasksCount":{ "shape":"Integer", "documentation":"

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

" }, "activeServicesCount":{ "shape":"Integer", "documentation":"

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

" }, "statistics":{ "shape":"Statistics", "documentation":"

Additional information about your clusters that are separated by launch type. They include the following:

- runningEC2TasksCount

- RunningFargateTasksCount

- pendingEC2TasksCount

- pendingFargateTasksCount

- activeEC2ServiceCount

- activeFargateServiceCount

- drainingEC2ServiceCount

- drainingFargateServiceCount

" }, "tags":{ "shape":"Tags", "documentation":"

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. You define both.

The following basic restrictions apply to tags:

- Maximum number of tags per resource - 50

- For each resource, each tag key must be unique, and each tag key can have only one value.

- Maximum key length - 128 Unicode characters in UTF-8

- Maximum value length - 256 Unicode characters in UTF-8

- If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.

- Tag keys and values are case-sensitive.

- Do not use `aws:`, `AWS:`, or any upper or lowercase combination of such as a prefix for either keys or values as it is reserved for Amazon Web Services use. You cannot edit or delete tag keys or values with this prefix. Tags with this prefix do not count against your tags per resource limit.

" }, "settings":{ "shape":"ClusterSettings", "documentation":"

The settings for the cluster. This parameter indicates whether CloudWatch Container Insights is on or off for a cluster.

" }, "capacityProviders":{ "shape":"StringList", "documentation":"

The capacity providers associated with the cluster.

" }, "defaultCapacityProviderStrategy":{ "shape":"CapacityProviderStrategy", "documentation":"

The default capacity provider strategy for the cluster. When services or tasks are run in the cluster with no launch type or capacity provider strategy specified, the default capacity provider strategy is used.

" }, "attachments":{ "shape":"Attachments", "documentation":"

The resources attached to a cluster. When using a capacity provider with a cluster, the capacity provider and associated resources are returned as cluster attachments.

" }, "attachmentsStatus":{ "shape":"String", "documentation":"

The status of the capacity providers associated with the cluster. The following are the states that are returned.

UPDATE_IN_PROGRESS

  The available capacity providers for the cluster are updating.

UPDATE_COMPLETE

  The capacity providers have successfully updated.

UPDATE_FAILED

  The capacity provider updates failed.

" }, "serviceConnectDefaults":{ "shape":"ClusterServiceConnectDefaults", "documentation":"

Use this parameter to set a default Service Connect namespace. After you set a default Service Connect namespace, any new services with Service Connect turned on that are created in the cluster are added as client services in the namespace. This setting only applies to new services that set the `enabled` parameter to `true` in the `ServiceConnectConfiguration`. You can set the namespace of each service individually in the `ServiceConnectConfiguration` to override this default parameter.

Tasks that run in a namespace can use short names to connect to services in the namespace. Tasks can connect to services across all of the clusters in the namespace. Tasks connect through a managed proxy container that collects logs and metrics for increased visibility. Only the tasks that Amazon ECS services create are supported with Service Connect. For more information, see Service Connect in the Amazon Elastic Container Service Developer Guide.

" } }, "documentation":"

A regional grouping of one or more container instances where you can run task requests. Each account receives a default cluster the first time you use the Amazon ECS service, but you may also create other clusters. Clusters may contain more than one instance type simultaneously.

" }, "ClusterConfiguration":{ "type":"structure", "members":{ "executeCommandConfiguration":{ "shape":"ExecuteCommandConfiguration", "documentation":"

The details of the execute command configuration.

" } }, "documentation":"

The execute command configuration for the cluster.

" }, "ClusterContainsContainerInstancesException":{ "type":"structure", "members":{ }, "documentation":"

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

", "exception":true }, "ClusterContainsServicesException":{ "type":"structure", "members":{ }, "documentation":"

You can't 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.

", "exception":true }, "ClusterContainsTasksException":{ "type":"structure", "members":{ }, "documentation":"

You can't delete a cluster that has active tasks.

", "exception":true }, "ClusterField":{ "type":"string", "enum":[ "ATTACHMENTS", "CONFIGURATIONS", "SETTINGS", "STATISTICS", "TAGS" ] }, "ClusterFieldList":{ "type":"list", "member":{"shape":"ClusterField"} }, "ClusterNotFoundException":{ "type":"structure", "members":{ }, "documentation":"

The specified cluster wasn't found. You can view your available clusters with ListClusters. Amazon ECS clusters are Region specific.

", "exception":true }, "ClusterServiceConnectDefaults":{ "type":"structure", "members":{ "namespace":{ "shape":"String", "documentation":"

The namespace name or full Amazon Resource Name (ARN) of the Cloud Map namespace. When you create a service and don't specify a Service Connect configuration, this namespace is used.

" } }, "documentation":"

Use this parameter to set a default Service Connect namespace. After you set a default Service Connect namespace, any new services with Service Connect turned on that are created in the cluster are added as client services in the namespace. This setting only applies to new services that set the `enabled` parameter to `true` in the `ServiceConnectConfiguration`. You can set the namespace of each service individually in the `ServiceConnectConfiguration` to override this default parameter.

Tasks that run in a namespace can use short names to connect to services in the namespace. Tasks can connect to services across all of the clusters in the namespace. Tasks connect through a managed proxy container that collects logs and metrics for increased visibility. Only the tasks that Amazon ECS services create are supported with Service Connect. For more information, see Service Connect in the Amazon Elastic Container Service Developer Guide.

" }, "ClusterServiceConnectDefaultsRequest":{ "type":"structure", "required":["namespace"], "members":{ "namespace":{ "shape":"String", "documentation":"

The namespace name or full Amazon Resource Name (ARN) of the Cloud Map namespace that's used when you create a service and don't specify a Service Connect configuration. The namespace name can include up to 1024 characters. The name is case-sensitive. The name can't include hyphens (-), tilde (~), greater than (>), less than (<), or slash (/).

If you enter an existing namespace name or ARN, then that namespace will be used. Any namespace type is supported. The namespace must be in this account and this Amazon Web Services Region.

If you enter a new name, a Cloud Map namespace will be created. Amazon ECS creates a Cloud Map namespace with the \"API calls\" method of instance discovery only. This instance discovery method is the \"HTTP\" namespace type in the Command Line Interface. Other types of instance discovery aren't used by Service Connect.

If you update the cluster with an empty string `\"\"` for the namespace name, the cluster configuration for Service Connect is removed. Note that the namespace will remain in Cloud Map and must be deleted separately.

For more information about Cloud Map, see Working with Services in the Cloud Map Developer Guide.

" } }, "documentation":"

Use this parameter to set a default Service Connect namespace. After you set a default Service Connect namespace, any new services with Service Connect turned on that are created in the cluster are added as client services in the namespace. This setting only applies to new services that set the `enabled` parameter to `true` in the `ServiceConnectConfiguration`. You can set the namespace of each service individually in the `ServiceConnectConfiguration` to override this default parameter.

Tasks that run in a namespace can use short names to connect to services in the namespace. Tasks can connect to services across all of the clusters in the namespace. Tasks connect through a managed proxy container that collects logs and metrics for increased visibility. Only the tasks that Amazon ECS services create are supported with Service Connect. For more information, see Service Connect in the Amazon Elastic Container Service Developer Guide.

" }, "ClusterSetting":{ "type":"structure", "members":{ "name":{ "shape":"ClusterSettingName", "documentation":"

The name of the cluster setting. The value is `containerInsights` .

" }, "value":{ "shape":"String", "documentation":"

The value to set for the cluster setting. The supported values are `enabled` and `disabled`.

If you set `name` to `containerInsights` and `value` to `enabled`, CloudWatch Container Insights will be on for the cluster, otherwise it will be off unless the `containerInsights` account setting is turned on. If a cluster value is specified, it will override the `containerInsights` value set with PutAccountSetting or PutAccountSettingDefault.

" } }, "documentation":"

The settings to use when creating a cluster. This parameter is used to turn on CloudWatch Container Insights for a cluster.

" }, "ClusterSettingName":{ "type":"string", "enum":["containerInsights"] }, "ClusterSettings":{ "type":"list", "member":{"shape":"ClusterSetting"} }, "Clusters":{ "type":"list", "member":{"shape":"Cluster"} }, "Compatibility":{ "type":"string", "enum":[ "EC2", "FARGATE", "EXTERNAL" ] }, "CompatibilityList":{ "type":"list", "member":{"shape":"Compatibility"} }, "ConflictException":{ "type":"structure", "members":{ "resourceIds":{ "shape":"ResourceIds", "documentation":"

The existing task ARNs which are already associated with the `clientToken`.

" } }, "documentation":"

The `RunTask` request could not be processed due to conflicts. The provided `clientToken` is already in use with a different `RunTask` request. The `resourceIds` are the existing task ARNs which are already associated with the `clientToken`.

To fix this issue:

- Run `RunTask` with a unique `clientToken`.

- Run `RunTask` with the `clientToken` and the original set of parameters

", "exception":true }, "Connectivity":{ "type":"string", "enum":[ "CONNECTED", "DISCONNECTED" ] }, "Container":{ "type":"structure", "members":{ "containerArn":{ "shape":"String", "documentation":"

The Amazon Resource Name (ARN) of the container.

" }, "taskArn":{ "shape":"String", "documentation":"

The ARN of the task.

" }, "name":{ "shape":"String", "documentation":"

The name of the container.

" }, "image":{ "shape":"String", "documentation":"

The image used for the container.

" }, "imageDigest":{ "shape":"String", "documentation":"

The container image manifest digest.

" }, "runtimeId":{ "shape":"String", "documentation":"

The ID of the Docker container.

" }, "lastStatus":{ "shape":"String", "documentation":"

The last known status of the container.

" }, "exitCode":{ "shape":"BoxedInteger", "documentation":"

The exit code returned from the container.

" }, "reason":{ "shape":"String", "documentation":"

A short (255 max characters) human-readable string to provide additional details about a running or stopped container.

" }, "networkBindings":{ "shape":"NetworkBindings", "documentation":"

The network bindings associated with the container.

" }, "networkInterfaces":{ "shape":"NetworkInterfaces", "documentation":"

The network interfaces associated with the container.

" }, "healthStatus":{ "shape":"HealthStatus", "documentation":"

The health status of the container. If health checks aren't configured for this container in its task definition, then it reports the health status as `UNKNOWN`.

" }, "managedAgents":{ "shape":"ManagedAgents", "documentation":"

The details of any Amazon ECS managed agents associated with the container.

" }, "cpu":{ "shape":"String", "documentation":"

The number of CPU units set for the container. The value is `0` if no value was specified in the container definition when the task definition was registered.

" }, "memory":{ "shape":"String", "documentation":"

The hard limit (in MiB) of memory set for the container.

" }, "memoryReservation":{ "shape":"String", "documentation":"

The soft limit (in MiB) of memory set for the container.

" }, "gpuIds":{ "shape":"GpuIds", "documentation":"

The IDs of each GPU assigned to the container.

" } }, "documentation":"

A Docker container that's part of a task.

" }, "ContainerCondition":{ "type":"string", "enum":[ "START", "COMPLETE", "SUCCESS", "HEALTHY" ] }, "ContainerDefinition":{ "type":"structure", "members":{ "name":{ "shape":"String", "documentation":"

The name of a container. If you're 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, underscores, and hyphens 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.

" }, "image":{ "shape":"String", "documentation":"

The image used to start a container. This string is passed directly to the Docker daemon. By default, images in the Docker Hub registry are available. 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.

- 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, subsequent updates to a repository image aren't propagated to already running tasks.

- Images in Amazon ECR repositories can be specified by either using the full `registry/repository:tag` or `registry/repository@digest`. For example, `012345678910.dkr.ecr.<region-name>.amazonaws.com/<repository-name>:latest` or `012345678910.dkr.ecr.<region-name>.amazonaws.com/<repository-name>@sha256:94afd1f2e64d908bc90dbca0035a5b567EXAMPLE`.

- Images in official repositories on Docker Hub use a single name (for example, `ubuntu` or `mongo`).

- Images in other repositories on Docker Hub are qualified with an organization name (for example, `amazon/amazon-ecs-agent`).

- Images in other online repositories are qualified further by a domain name (for example, `quay.io/assemblyline/ubuntu`).

" }, "repositoryCredentials":{ "shape":"RepositoryCredentials", "documentation":"

The private repository authentication credentials to use.

" }, "cpu":{ "shape":"Integer", "documentation":"

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.

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's 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 is guaranteed a minimum of 512 CPU units when needed. Moreover, each container could float to higher CPU usage if the other container was not using it. 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 isn't 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:

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

- Agent versions greater than or equal to 1.2.0: Null, zero, and CPU values of 1 are passed to Docker as 2.

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's described in the task definition. A null or zero CPU value is passed to Docker as `0`, which Windows interprets as 1% of one CPU.

" }, "memory":{ "shape":"BoxedInteger", "documentation":"

The amount (in MiB) of memory to present to the container. If your container attempts to exceed the memory specified here, the container is killed. The total amount of memory reserved for all containers within a task must be lower than the task `memory` value, if one is specified. This parameter maps to `Memory` in the Create a container section of the Docker Remote API and the `--memory` option to docker run.

If using the Fargate launch type, this parameter is optional.

If using the EC2 launch type, you must specify either a task-level memory value or a container-level memory value. If you specify both a container-level `memory` and `memoryReservation` value, `memory` must be greater than `memoryReservation`. If you specify `memoryReservation`, then that value is subtracted from the available memory resources for the container instance where the container is placed. Otherwise, the value of `memory` is used.

The Docker 20.10.0 or later daemon reserves a minimum of 6 MiB of memory for a container. So, don't specify less than 6 MiB of memory for your containers.

The Docker 19.03.13-ce or earlier daemon reserves a minimum of 4 MiB of memory for a container. So, don't specify less than 4 MiB of memory for your containers.

" }, "memoryReservation":{ "shape":"BoxedInteger", "documentation":"

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.

If a task-level memory value is not specified, you must specify a non-zero integer for one or both of `memory` or `memoryReservation` in a container definition. 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 where 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 20.10.0 or later daemon reserves a minimum of 6 MiB of memory for a container. So, don't specify less than 6 MiB of memory for your containers.

The Docker 19.03.13-ce or earlier daemon reserves a minimum of 4 MiB of memory for a container. So, don't specify less than 4 MiB of memory for your containers.

" }, "links":{ "shape":"StringList", "documentation":"

The `links` parameter allows containers to communicate with each other without the need for port mappings. This parameter is only supported if the network mode of a task definition is `bridge`. The `name:internalName` construct is analogous to `name:alias` in Docker links. Up to 255 letters (uppercase and lowercase), numbers, underscores, and hyphens are allowed. For more information about linking Docker containers, go to Legacy container links in the Docker documentation. 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.

" }, "portMappings":{ "shape":"PortMappingList", "documentation":"

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, 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's no loopback for port mappings on Windows, so you can't 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.

" }, "essential":{ "shape":"BoxedBoolean", "documentation":"

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`, its failure doesn't 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's composed of multiple containers, 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.

" }, "entryPoint":{ "shape":"StringList", "documentation":"

Early versions of the Amazon ECS container agent don't 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's 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.

" }, "command":{ "shape":"StringList", "documentation":"

The command that's 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. If there are multiple arguments, each argument is a separated string in the array.

" }, "environment":{ "shape":"EnvironmentVariables", "documentation":"

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 don't recommend that you use plaintext environment variables for sensitive information, such as credential data.

" }, "environmentFiles":{ "shape":"EnvironmentFiles", "documentation":"

A list of files containing the environment variables to pass to a container. This parameter maps to the `--env-file` option to docker run.

You can specify up to ten environment files. The file must have a `.env` file extension. Each line in an environment file contains an environment variable in `VARIABLE=VALUE` format. Lines beginning with `#` are treated as comments and are ignored. For more information about the environment variable file syntax, see Declare default environment variables in file.

If there are environment variables specified using the `environment` parameter in a container definition, they take precedence over the variables contained within an environment file. If multiple environment files are specified that contain the same variable, they're processed from the top down. We recommend that you use unique variable names. For more information, see Specifying Environment Variables in the Amazon Elastic Container Service Developer Guide.

" }, "mountPoints":{ "shape":"MountPointList", "documentation":"

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 can't mount directories on a different drive, and mount point can't be across drives.

" }, "volumesFrom":{ "shape":"VolumeFromList", "documentation":"

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.

" }, "linuxParameters":{ "shape":"LinuxParameters", "documentation":"

Linux-specific modifications that are applied to the container, such as Linux kernel capabilities. For more information see KernelCapabilities.

This parameter is not supported for Windows containers.

" }, "secrets":{ "shape":"SecretList", "documentation":"

The secrets to pass to the container. For more information, see Specifying Sensitive Data in the Amazon Elastic Container Service Developer Guide.

" }, "dependsOn":{ "shape":"ContainerDependencies", "documentation":"

The dependencies defined for container startup and shutdown. A container can contain multiple dependencies on other containers in a task definition. When a dependency is defined for container startup, for container shutdown it is reversed.

For tasks using the EC2 launch type, the container instances require at least version 1.26.0 of the container agent to turn on container dependencies. However, we recommend using the latest container agent version. For information about checking your agent version and updating to the latest version, see Updating the Amazon ECS Container Agent in the Amazon Elastic Container Service Developer Guide. If you're using an Amazon ECS-optimized Linux AMI, your instance needs at least version 1.26.0-1 of the `ecs-init` package. If your container instances are launched from version `20190301` or later, then they contain the required versions of the container agent and `ecs-init`. For more information, see Amazon ECS-optimized Linux AMI in the Amazon Elastic Container Service Developer Guide.

For tasks using the Fargate launch type, the task or service requires the following platforms:

- Linux platform version `1.3.0` or later.

- Windows platform version `1.0.0` or later.

" }, "startTimeout":{ "shape":"BoxedInteger", "documentation":"

Time duration (in seconds) to wait before giving up on resolving dependencies for a container. For example, you specify two containers in a task definition with containerA having a dependency on containerB reaching a `COMPLETE`, `SUCCESS`, or `HEALTHY` status. If a `startTimeout` value is specified for containerB and it doesn't reach the desired status within that time then containerA gives up and not start. This results in the task transitioning to a `STOPPED` state.

When the `ECS_CONTAINER_START_TIMEOUT` container agent configuration variable is used, it's enforced independently from this start timeout value.

For tasks using the Fargate launch type, the task or service requires the following platforms:

- Linux platform version `1.3.0` or later.

- Windows platform version `1.0.0` or later.

For tasks using the EC2 launch type, your container instances require at least version `1.26.0` of the container agent to use a container start timeout value. However, we recommend using the latest container agent version. For information about checking your agent version and updating to the latest version, see Updating the Amazon ECS Container Agent in the Amazon Elastic Container Service Developer Guide. If you're using an Amazon ECS-optimized Linux AMI, your instance needs at least version `1.26.0-1` of the `ecs-init` package. If your container instances are launched from version `20190301` or later, then they contain the required versions of the container agent and `ecs-init`. For more information, see Amazon ECS-optimized Linux AMI in the Amazon Elastic Container Service Developer Guide.

The valid values are 2-120 seconds.

" }, "stopTimeout":{ "shape":"BoxedInteger", "documentation":"

Time duration (in seconds) to wait before the container is forcefully killed if it doesn't exit normally on its own.

For tasks using the Fargate launch type, the task or service requires the following platforms:

- Linux platform version `1.3.0` or later.

- Windows platform version `1.0.0` or later.

The max stop timeout value is 120 seconds and if the parameter is not specified, the default value of 30 seconds is used.

For tasks that use the EC2 launch type, if the `stopTimeout` parameter isn't specified, the value set for the Amazon ECS container agent configuration variable `ECS_CONTAINER_STOP_TIMEOUT` is used. If neither the `stopTimeout` parameter or the `ECS_CONTAINER_STOP_TIMEOUT` agent configuration variable are set, then the default values of 30 seconds for Linux containers and 30 seconds on Windows containers are used. Your container instances require at least version 1.26.0 of the container agent to use a container stop timeout value. However, we recommend using the latest container agent version. For information about checking your agent version and updating to the latest version, see Updating the Amazon ECS Container Agent in the Amazon Elastic Container Service Developer Guide. If you're using an Amazon ECS-optimized Linux AMI, your instance needs at least version 1.26.0-1 of the `ecs-init` package. If your container instances are launched from version `20190301` or later, then they contain the required versions of the container agent and `ecs-init`. For more information, see Amazon ECS-optimized Linux AMI in the Amazon Elastic Container Service Developer Guide.

The valid values are 2-120 seconds.

" }, "hostname":{ "shape":"String", "documentation":"

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're using the `awsvpc` network mode.

" }, "user":{ "shape":"String", "documentation":"

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

When running tasks using the `host` network mode, don't run containers using the root user (UID 0). We recommend using a non-root user for better security.

You can specify the `user` using the following formats. If specifying a UID or GID, you must specify it as a positive integer.

- `user`

- `user:group`

- `uid`

- `uid:gid`

- `user:gid`

- `uid:group`

This parameter is not supported for Windows containers.

" }, "workingDirectory":{ "shape":"String", "documentation":"

The working directory to run commands inside the container in. This parameter maps to `WorkingDir` in the Create a container section of the Docker Remote API and the `--workdir` option to docker run.

" }, "disableNetworking":{ "shape":"BoxedBoolean", "documentation":"

When this parameter is true, networking is off 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.

" }, "privileged":{ "shape":"BoxedBoolean", "documentation":"

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 run on Fargate.

" }, "readonlyRootFilesystem":{ "shape":"BoxedBoolean", "documentation":"

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.

" }, "dnsServers":{ "shape":"StringList", "documentation":"

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.

" }, "dnsSearchDomains":{ "shape":"StringList", "documentation":"

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.

" }, "extraHosts":{ "shape":"HostEntryList", "documentation":"

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 isn't supported for Windows containers or tasks that use the `awsvpc` network mode.

" }, "dockerSecurityOptions":{ "shape":"StringList", "documentation":"

A list of strings to provide custom configuration for multiple security systems. For more information about valid values, see Docker Run Security Configuration. This field isn't valid for containers in tasks using the Fargate launch type.

For Linux tasks on EC2, this parameter can be used to reference custom labels for SELinux and AppArmor multi-level security systems.

For any tasks on EC2, this parameter can be used to reference a credential spec file that configures a container for Active Directory authentication. For more information, see Using gMSAs for Windows Containers and Using gMSAs for Linux Containers in the Amazon Elastic Container Service Developer Guide.

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.

For more information about valid values, see Docker Run Security Configuration.

Valid values: \"no-new-privileges\" | \"apparmor:PROFILE\" | \"label:value\" | \"credentialspec:CredentialSpecFilePath\"

" }, "interactive":{ "shape":"BoxedBoolean", "documentation":"

When this parameter is `true`, you can 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.

" }, "pseudoTerminal":{ "shape":"BoxedBoolean", "documentation":"

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.

" }, "dockerLabels":{ "shape":"DockerLabelsMap", "documentation":"

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}}'`

" }, "ulimits":{ "shape":"UlimitList", "documentation":"

A list of `ulimits` to set in the container. If a `ulimit` value is specified in a task definition, it overrides the default values set by Docker. 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.

Amazon ECS tasks hosted on Fargate use the default resource limit values set by the operating system with the exception of the `nofile` resource limit parameter which Fargate overrides. The `nofile` resource limit sets a restriction on the number of open files that a container can use. The default `nofile` soft limit is `1024` and the default hard limit is `4096`.

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.

" }, "logConfiguration":{ "shape":"LogConfiguration", "documentation":"

The log configuration specification for the container.

This parameter maps to `LogConfig` in the Create a container section of the Docker Remote API and the `--log-driver` option to docker run. By default, containers use the same logging driver that the Docker daemon uses. However the container can 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 about 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.

" }, "healthCheck":{ "shape":"HealthCheck", "documentation":"

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

" }, "systemControls":{ "shape":"SystemControls", "documentation":"

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. For example, you can configure `net.ipv4.tcp_keepalive_time` setting to maintain longer lived connections.

We don't 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's 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.

This parameter is not supported for Windows containers.

This parameter is only supported for tasks that are hosted on Fargate if the tasks are using platform version `1.4.0` or later (Linux). This isn't supported for Windows containers on Fargate.

" }, "resourceRequirements":{ "shape":"ResourceRequirements", "documentation":"

The type and amount of a resource to assign to a container. The only supported resource is a GPU.

" }, "firelensConfiguration":{ "shape":"FirelensConfiguration", "documentation":"

The FireLens configuration for the container. This is used to specify and configure a log router for container logs. For more information, see Custom Log Routing in the Amazon Elastic Container Service Developer Guide.

" }, "credentialSpecs":{ "shape":"StringList", "documentation":"

A list of ARNs in SSM or Amazon S3 to a credential spec (`CredSpec`) file that configures the container for Active Directory authentication. We recommend that you use this parameter instead of the `dockerSecurityOptions`. The maximum number of ARNs is 1.

There are two formats for each ARN.

credentialspecdomainless:MyARN

  You use `credentialspecdomainless:MyARN` to provide a `CredSpec` with an additional section for a secret in Secrets Manager. You provide the login credentials to the domain in the secret.

  Each task that runs on any container instance can join different domains.

  You can use this format without joining the container instance to a domain.

credentialspec:MyARN

  You use `credentialspec:MyARN` to provide a `CredSpec` for a single domain.

  You must join the container instance to the domain before you start any tasks that use this task definition.

In both formats, replace `MyARN` with the ARN in SSM or Amazon S3.

If you provide a `credentialspecdomainless:MyARN`, the `credspec` must provide a ARN in Secrets Manager for a secret containing the username, password, and the domain to connect to. For better security, the instance isn't joined to the domain for domainless authentication. Other applications on the instance can't use the domainless credentials. You can use this parameter to run tasks on the same instance, even it the tasks need to join different domains. For more information, see Using gMSAs for Windows Containers and Using gMSAs for Linux Containers.

" } }, "documentation":"

Container definitions are used in task definitions to describe the different containers that are launched as part of a task.

" }, "ContainerDefinitions":{ "type":"list", "member":{"shape":"ContainerDefinition"} }, "ContainerDependencies":{ "type":"list", "member":{"shape":"ContainerDependency"} }, "ContainerDependency":{ "type":"structure", "required":[ "containerName", "condition" ], "members":{ "containerName":{ "shape":"String", "documentation":"

The name of a container.

" }, "condition":{ "shape":"ContainerCondition", "documentation":"

The dependency condition of the container. The following are the available conditions and their behavior:

- `START` - This condition emulates the behavior of links and volumes today. It validates that a dependent container is started before permitting other containers to start.

- `COMPLETE` - This condition validates that a dependent container runs to completion (exits) before permitting other containers to start. This can be useful for nonessential containers that run a script and then exit. This condition can't be set on an essential container.

- `SUCCESS` - This condition is the same as `COMPLETE`, but it also requires that the container exits with a `zero` status. This condition can't be set on an essential container.

- `HEALTHY` - This condition validates that the dependent container passes its Docker health check before permitting other containers to start. This requires that the dependent container has health checks configured. This condition is confirmed only at task startup.

" } }, "documentation":"

The dependencies defined for container startup and shutdown. A container can contain multiple dependencies. When a dependency is defined for container startup, for container shutdown it is reversed.

Your Amazon ECS container instances require at least version 1.26.0 of the container agent to use container dependencies. However, we recommend using the latest container agent version. For information about checking your agent version and updating to the latest version, see Updating the Amazon ECS Container Agent in the Amazon Elastic Container Service Developer Guide. If you're using an Amazon ECS-optimized Linux AMI, your instance needs at least version 1.26.0-1 of the `ecs-init` package. If your container instances are launched from version `20190301` or later, then they contain the required versions of the container agent and `ecs-init`. For more information, see Amazon ECS-optimized Linux AMI in the Amazon Elastic Container Service Developer Guide.

For tasks that use the Fargate launch type, the task or service requires the following platforms:

- Linux platform version `1.3.0` or later.

- Windows platform version `1.0.0` or later.

" }, "ContainerInstance":{ "type":"structure", "members":{ "containerInstanceArn":{ "shape":"String", "documentation":"

The Amazon Resource Name (ARN) of the container instance. For more information about the ARN format, see Amazon Resource Name (ARN) in the Amazon ECS Developer Guide.

" }, "ec2InstanceId":{ "shape":"String", "documentation":"

The ID of the container instance. For Amazon EC2 instances, this value is the Amazon EC2 instance ID. For external instances, this value is the Amazon Web Services Systems Manager managed instance ID.

" }, "capacityProviderName":{ "shape":"String", "documentation":"

The capacity provider that's associated with the container instance.

" }, "version":{ "shape":"Long", "documentation":"

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're 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.

" }, "versionInfo":{ "shape":"VersionInfo", "documentation":"

The version information for the Amazon ECS container agent and Docker daemon running on the container instance.

" }, "remainingResources":{ "shape":"Resources", "documentation":"

For CPU and memory resource types, this parameter describes the remaining CPU and memory that wasn't already 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's not specified here is available for new tasks.

" }, "registeredResources":{ "shape":"Resources", "documentation":"

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.

" }, "status":{ "shape":"String", "documentation":"

The status of the container instance. The valid values are `REGISTERING`, `REGISTRATION_FAILED`, `ACTIVE`, `INACTIVE`, `DEREGISTERING`, or `DRAINING`.

If your account has opted in to the `awsvpcTrunking` account setting, then any newly registered container instance will transition to a `REGISTERING` status while the trunk elastic network interface is provisioned for the instance. If the registration fails, the instance will transition to a `REGISTRATION_FAILED` status. You can describe the container instance and see the reason for failure in the `statusReason` parameter. Once the container instance is terminated, the instance transitions to a `DEREGISTERING` status while the trunk elastic network interface is deprovisioned. The instance then transitions to an `INACTIVE` status.

The `ACTIVE` status indicates that the container instance can accept tasks. The `DRAINING` indicates that new tasks aren't 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.

" }, "statusReason":{ "shape":"String", "documentation":"

The reason that the container instance reached its current status.

" }, "agentConnected":{ "shape":"Boolean", "documentation":"

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

" }, "runningTasksCount":{ "shape":"Integer", "documentation":"

The number of tasks on the container instance that have a desired status (`desiredStatus`) of `RUNNING`.

" }, "pendingTasksCount":{ "shape":"Integer", "documentation":"

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

" }, "agentUpdateStatus":{ "shape":"AgentUpdateStatus", "documentation":"

The status of the most recent agent update. If an update wasn't ever requested, this value is `NULL`.

" }, "attributes":{ "shape":"Attributes", "documentation":"

The attributes set for the container instance, either by the Amazon ECS container agent at instance registration or manually with the PutAttributes operation.

" }, "registeredAt":{ "shape":"Timestamp", "documentation":"

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

" }, "attachments":{ "shape":"Attachments", "documentation":"

The resources attached to a container instance, such as an elastic network interface.

" }, "tags":{ "shape":"Tags", "documentation":"

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. You define both.

The following basic restrictions apply to tags:

- Maximum number of tags per resource - 50

- For each resource, each tag key must be unique, and each tag key can have only one value.

- Maximum key length - 128 Unicode characters in UTF-8

- Maximum value length - 256 Unicode characters in UTF-8

- If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.

- Tag keys and values are case-sensitive.

- Do not use `aws:`, `AWS:`, or any upper or lowercase combination of such as a prefix for either keys or values as it is reserved for Amazon Web Services use. You cannot edit or delete tag keys or values with this prefix. Tags with this prefix do not count against your tags per resource limit.

" }, "healthStatus":{ "shape":"ContainerInstanceHealthStatus", "documentation":"

An object representing the health status of the container instance.

" } }, "documentation":"

An Amazon EC2 or External instance that's running the Amazon ECS agent and has been registered with a cluster.

" }, "ContainerInstanceField":{ "type":"string", "enum":[ "TAGS", "CONTAINER_INSTANCE_HEALTH" ] }, "ContainerInstanceFieldList":{ "type":"list", "member":{"shape":"ContainerInstanceField"} }, "ContainerInstanceHealthStatus":{ "type":"structure", "members":{ "overallStatus":{ "shape":"InstanceHealthCheckState", "documentation":"

The overall health status of the container instance. This is an aggregate status of all container instance health checks.

" }, "details":{ "shape":"InstanceHealthCheckResultList", "documentation":"

An array of objects representing the details of the container instance health status.

" } }, "documentation":"

An object representing the health status of the container instance.

" }, "ContainerInstanceStatus":{ "type":"string", "enum":[ "ACTIVE", "DRAINING", "REGISTERING", "DEREGISTERING", "REGISTRATION_FAILED" ] }, "ContainerInstances":{ "type":"list", "member":{"shape":"ContainerInstance"} }, "ContainerOverride":{ "type":"structure", "members":{ "name":{ "shape":"String", "documentation":"

The name of the container that receives the override. This parameter is required if any override is specified.

" }, "command":{ "shape":"StringList", "documentation":"

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.

" }, "environment":{ "shape":"EnvironmentVariables", "documentation":"

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.

" }, "environmentFiles":{ "shape":"EnvironmentFiles", "documentation":"

A list of files containing the environment variables to pass to a container, instead of the value from the container definition.

" }, "cpu":{ "shape":"BoxedInteger", "documentation":"

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.

" }, "memory":{ "shape":"BoxedInteger", "documentation":"

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.

" }, "memoryReservation":{ "shape":"BoxedInteger", "documentation":"

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.

" }, "resourceRequirements":{ "shape":"ResourceRequirements", "documentation":"

The type and amount of a resource to assign to a container, instead of the default value from the task definition. The only supported resource is a GPU.

" } }, "documentation":"

The overrides that are sent to a container. An empty container override can be passed in. An example of an empty container override is `{\"containerOverrides\": [ ] }`. If a non-empty container override is specified, the `name` parameter must be included.

You can use Secrets Manager or Amazon Web Services Systems Manager Parameter Store to store the sensitive data. For more information, see Retrieve secrets through environment variables in the Amazon ECS Developer Guide.

" }, "ContainerOverrides":{ "type":"list", "member":{"shape":"ContainerOverride"} }, "ContainerStateChange":{ "type":"structure", "members":{ "containerName":{ "shape":"String", "documentation":"

The name of the container.

" }, "imageDigest":{ "shape":"String", "documentation":"

The container image SHA 256 digest.

" }, "runtimeId":{ "shape":"String", "documentation":"

The ID of the Docker container.

" }, "exitCode":{ "shape":"BoxedInteger", "documentation":"

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

" }, "networkBindings":{ "shape":"NetworkBindings", "documentation":"

Any network bindings that are associated with the container.

" }, "reason":{ "shape":"String", "documentation":"

The reason for the state change.

" }, "status":{ "shape":"String", "documentation":"

The status of the container.

" } }, "documentation":"

An object that represents a change in state for a container.

" }, "ContainerStateChanges":{ "type":"list", "member":{"shape":"ContainerStateChange"} }, "Containers":{ "type":"list", "member":{"shape":"Container"} }, "CreateCapacityProviderRequest":{ "type":"structure", "required":[ "name", "autoScalingGroupProvider" ], "members":{ "name":{ "shape":"String", "documentation":"

The name of the capacity provider. Up to 255 characters are allowed. They include letters (both upper and lowercase letters), numbers, underscores (_), and hyphens (-). The name can't be prefixed with \"`aws`\", \"`ecs`\", or \"`fargate`\".

" }, "autoScalingGroupProvider":{ "shape":"AutoScalingGroupProvider", "documentation":"

The details of the Auto Scaling group for the capacity provider.

" }, "tags":{ "shape":"Tags", "documentation":"

The metadata that you apply to the capacity provider to categorize and organize them more conveniently. Each tag consists of a key and an optional value. You define both of them.

The following basic restrictions apply to tags:

- Maximum number of tags per resource - 50

- For each resource, each tag key must be unique, and each tag key can have only one value.

- Maximum key length - 128 Unicode characters in UTF-8

- Maximum value length - 256 Unicode characters in UTF-8

- If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.

- Tag keys and values are case-sensitive.

- Do not use `aws:`, `AWS:`, or any upper or lowercase combination of such as a prefix for either keys or values as it is reserved for Amazon Web Services use. You cannot edit or delete tag keys or values with this prefix. Tags with this prefix do not count against your tags per resource limit.

" } } }, "CreateCapacityProviderResponse":{ "type":"structure", "members":{ "capacityProvider":{ "shape":"CapacityProvider", "documentation":"

The full description of the new capacity provider.

" } } }, "CreateClusterRequest":{ "type":"structure", "members":{ "clusterName":{ "shape":"String", "documentation":"

The name of your cluster. If you don't specify a name for your cluster, you create a cluster that's named `default`. Up to 255 letters (uppercase and lowercase), numbers, underscores, and hyphens are allowed.

" }, "tags":{ "shape":"Tags", "documentation":"

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. You define both.

The following basic restrictions apply to tags:

- Maximum number of tags per resource - 50

- For each resource, each tag key must be unique, and each tag key can have only one value.

- Maximum key length - 128 Unicode characters in UTF-8

- Maximum value length - 256 Unicode characters in UTF-8

- If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.

- Tag keys and values are case-sensitive.

- Do not use `aws:`, `AWS:`, or any upper or lowercase combination of such as a prefix for either keys or values as it is reserved for Amazon Web Services use. You cannot edit or delete tag keys or values with this prefix. Tags with this prefix do not count against your tags per resource limit.

" }, "settings":{ "shape":"ClusterSettings", "documentation":"

The setting to use when creating a cluster. This parameter is used to turn on CloudWatch Container Insights for a cluster. If this value is specified, it overrides the `containerInsights` value set with PutAccountSetting or PutAccountSettingDefault.

" }, "configuration":{ "shape":"ClusterConfiguration", "documentation":"

The `execute` command configuration for the cluster.

" }, "capacityProviders":{ "shape":"StringList", "documentation":"

The short name of one or more capacity providers to associate with the cluster. A capacity provider must be associated with a cluster before it can be included as part of the default capacity provider strategy of the cluster or used in a capacity provider strategy when calling the CreateService or RunTask actions.

If specifying a capacity provider that uses an Auto Scaling group, the capacity provider must be created but not associated with another cluster. New Auto Scaling group capacity providers can be created with the CreateCapacityProvider API operation.

To use a Fargate capacity provider, specify either the `FARGATE` or `FARGATE_SPOT` capacity providers. The Fargate capacity providers are available to all accounts and only need to be associated with a cluster to be used.

The PutCapacityProvider API operation is used to update the list of available capacity providers for a cluster after the cluster is created.

" }, "defaultCapacityProviderStrategy":{ "shape":"CapacityProviderStrategy", "documentation":"

The capacity provider strategy to set as the default for the cluster. After a default capacity provider strategy is set for a cluster, when you call the CreateService or RunTask APIs with no capacity provider strategy or launch type specified, the default capacity provider strategy for the cluster is used.

If a default capacity provider strategy isn't defined for a cluster when it was created, it can be defined later with the PutClusterCapacityProviders API operation.

" }, "serviceConnectDefaults":{ "shape":"ClusterServiceConnectDefaultsRequest", "documentation":"

Use this parameter to set a default Service Connect namespace. After you set a default Service Connect namespace, any new services with Service Connect turned on that are created in the cluster are added as client services in the namespace. This setting only applies to new services that set the `enabled` parameter to `true` in the `ServiceConnectConfiguration`. You can set the namespace of each service individually in the `ServiceConnectConfiguration` to override this default parameter.

Tasks that run in a namespace can use short names to connect to services in the namespace. Tasks can connect to services across all of the clusters in the namespace. Tasks connect through a managed proxy container that collects logs and metrics for increased visibility. Only the tasks that Amazon ECS services create are supported with Service Connect. For more information, see Service Connect in the Amazon Elastic Container Service Developer Guide.

" } } }, "CreateClusterResponse":{ "type":"structure", "members":{ "cluster":{ "shape":"Cluster", "documentation":"

The full description of your new cluster.

" } } }, "CreateServiceRequest":{ "type":"structure", "required":["serviceName"], "members":{ "cluster":{ "shape":"String", "documentation":"

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

" }, "serviceName":{ "shape":"String", "documentation":"

The name of your service. Up to 255 letters (uppercase and lowercase), numbers, underscores, and hyphens 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.

" }, "taskDefinition":{ "shape":"String", "documentation":"

The `family` and `revision` (`family:revision`) or full ARN of the task definition to run in your service. If a `revision` isn't specified, the latest `ACTIVE` revision is used.

A task definition must be specified if the service uses either the `ECS` or `CODE_DEPLOY` deployment controllers.

For more information about deployment types, see Amazon ECS deployment types.

" }, "loadBalancers":{ "shape":"LoadBalancers", "documentation":"

A load balancer object representing the load balancers to use with your service. For more information, see Service load balancing in the Amazon Elastic Container Service Developer Guide.

If the service uses the rolling update (`ECS`) deployment controller and using either an Application Load Balancer or Network Load Balancer, you must specify one or more target group ARNs to attach to the service. The service-linked role is required for services that use multiple target groups. For more information, see Using service-linked roles for Amazon ECS in the Amazon Elastic Container Service Developer Guide.

If the service uses the `CODE_DEPLOY` deployment controller, the service is required to use either an Application Load Balancer or Network Load Balancer. When creating an CodeDeploy deployment group, you specify two target groups (referred to as a `targetGroupPair`). During a deployment, CodeDeploy determines which task set in your service has the status `PRIMARY`, and it associates one target group with it. Then, it also 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 you can use to perform validation tests with Lambda functions before routing production traffic to it.

If you use the `CODE_DEPLOY` deployment controller, these values can be changed when updating the service.

For Application Load Balancers and Network Load Balancers, this object must contain the load balancer target group ARN, the container name, and the container port to access from the load balancer. The container name must be as it appears in a container definition. The load balancer name parameter must be omitted. 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 that's specified here.

For Classic Load Balancers, this object must contain the load balancer name, the container name , and the container port to access from the load balancer. The container name must be as it appears in a container definition. The target group ARN parameter must be omitted. When a task from this service is placed on a container instance, the container instance is registered with the load balancer that's 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 aren't supported. Also, when you create any target groups for these services, you must choose `ip` as the target type, not `instance`. This is because tasks that use the `awsvpc` network mode are associated with an elastic network interface, not an Amazon EC2 instance.

" }, "serviceRegistries":{ "shape":"ServiceRegistries", "documentation":"

The details of the service discovery registry to associate with this service. For more information, see Service discovery.

Each service may be associated with one service registry. Multiple service registries for each service isn't supported.

" }, "desiredCount":{ "shape":"BoxedInteger", "documentation":"

The number of instantiations of the specified task definition to place and keep running in your service.

This is required if `schedulingStrategy` is `REPLICA` or isn't specified. If `schedulingStrategy` is `DAEMON` then this isn't required.

" }, "clientToken":{ "shape":"String", "documentation":"

An identifier that you provide to ensure the idempotency of the request. It must be unique and is case sensitive. Up to 36 ASCII characters in the range of 33-126 (inclusive) are allowed.

" }, "launchType":{ "shape":"LaunchType", "documentation":"

The infrastructure that you run your service on. For more information, see Amazon ECS launch types in the Amazon Elastic Container Service Developer Guide.

The `FARGATE` launch type runs your tasks on Fargate On-Demand infrastructure.

Fargate Spot infrastructure is available for use but a capacity provider strategy must be used. For more information, see Fargate capacity providers in the Amazon ECS User Guide for Fargate.

The `EC2` launch type runs your tasks on Amazon EC2 instances registered to your cluster.

The `EXTERNAL` launch type runs your tasks on your on-premises server or virtual machine (VM) capacity registered to your cluster.

A service can use either a launch type or a capacity provider strategy. If a `launchType` is specified, the `capacityProviderStrategy` parameter must be omitted.

" }, "capacityProviderStrategy":{ "shape":"CapacityProviderStrategy", "documentation":"

The capacity provider strategy to use for the service.

If a `capacityProviderStrategy` is specified, the `launchType` parameter must be omitted. If no `capacityProviderStrategy` or `launchType` is specified, the `defaultCapacityProviderStrategy` for the cluster is used.

A capacity provider strategy may contain a maximum of 6 capacity providers.

" }, "platformVersion":{ "shape":"String", "documentation":"

The platform version that your tasks in the service are running on. A platform version is specified only for tasks using the Fargate launch type. If one isn't specified, the `LATEST` platform version is used. For more information, see Fargate platform versions in the Amazon Elastic Container Service Developer Guide.

" }, "role":{ "shape":"String", "documentation":"

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 doesn't 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 for your service unless you specify a role here. The service-linked role is required if your task definition uses the `awsvpc` network mode or if the service is configured to use service discovery, an external deployment controller, multiple target groups, or Elastic Inference accelerators in which case you don't 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.

" }, "deploymentConfiguration":{ "shape":"DeploymentConfiguration", "documentation":"

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

" }, "placementConstraints":{ "shape":"PlacementConstraints", "documentation":"

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

" }, "placementStrategy":{ "shape":"PlacementStrategies", "documentation":"

The placement strategy objects to use for tasks in your service. You can specify a maximum of 5 strategy rules for each service.

" }, "networkConfiguration":{ "shape":"NetworkConfiguration", "documentation":"

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 isn't supported for other network modes. For more information, see Task networking in the Amazon Elastic Container Service Developer Guide.

" }, "healthCheckGracePeriodSeconds":{ "shape":"BoxedInteger", "documentation":"

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. This is only used when your service is configured to use a load balancer. If your service has a load balancer defined and you don't specify a health check grace period value, the default value of `0` is used.

If you do not use an Elastic Load Balancing, we recommend that you use the `startPeriod` in the task definition health check parameters. For more information, see Health check.

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 2,147,483,647 seconds (about 69 years). During that time, the Amazon ECS service scheduler ignores health check status. This grace period can prevent the service scheduler from marking tasks as unhealthy and stopping them before they have time to come up.

" }, "schedulingStrategy":{ "shape":"SchedulingStrategy", "documentation":"

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

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 the service uses the `CODE_DEPLOY` or `EXTERNAL` deployment controller types.

- `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. The service scheduler also evaluates the task placement constraints for running tasks and will stop tasks that don't meet the placement constraints. When you're using this strategy, you don't 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` or `EXTERNAL` deployment controller types don't support the `DAEMON` scheduling strategy.

" }, "deploymentController":{ "shape":"DeploymentController", "documentation":"

The deployment controller to use for the service. If no deployment controller is specified, the default value of `ECS` is used.

" }, "tags":{ "shape":"Tags", "documentation":"

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.

The following basic restrictions apply to tags:

- Maximum number of tags per resource - 50

- For each resource, each tag key must be unique, and each tag key can have only one value.

- Maximum key length - 128 Unicode characters in UTF-8

- Maximum value length - 256 Unicode characters in UTF-8

- If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.

- Tag keys and values are case-sensitive.

- Do not use `aws:`, `AWS:`, or any upper or lowercase combination of such as a prefix for either keys or values as it is reserved for Amazon Web Services use. You cannot edit or delete tag keys or values with this prefix. Tags with this prefix do not count against your tags per resource limit.

" }, "enableECSManagedTags":{ "shape":"Boolean", "documentation":"

Specifies whether to turn on 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.

When you use Amazon ECS managed tags, you need to set the `propagateTags` request parameter.

" }, "propagateTags":{ "shape":"PropagateTags", "documentation":"

Specifies whether to propagate the tags from the task definition to the task. If no value is specified, the tags aren't propagated. Tags can only be propagated to the task during task creation. To add tags to a task after task creation, use the TagResource API action.

The default is `NONE`.

" }, "enableExecuteCommand":{ "shape":"Boolean", "documentation":"

Determines whether the execute command functionality is turned on for the service. If `true`, this enables execute command functionality on all containers in the service tasks.

" }, "serviceConnectConfiguration":{ "shape":"ServiceConnectConfiguration", "documentation":"

The configuration for this service to discover and connect to services, and be discovered by, and connected from, other services within a namespace.

Tasks that run in a namespace can use short names to connect to services in the namespace. Tasks can connect to services across all of the clusters in the namespace. Tasks connect through a managed proxy container that collects logs and metrics for increased visibility. Only the tasks that Amazon ECS services create are supported with Service Connect. For more information, see Service Connect in the Amazon Elastic Container Service Developer Guide.

" }, "volumeConfigurations":{ "shape":"ServiceVolumeConfigurations", "documentation":"

The configuration for a volume specified in the task definition as a volume that is configured at launch time. Currently, the only supported volume type is an Amazon EBS volume.

" } } }, "CreateServiceResponse":{ "type":"structure", "members":{ "service":{ "shape":"Service", "documentation":"

The full description of your service following the create call.

A service will return either a `capacityProviderStrategy` or `launchType` parameter, but not both, depending where one was specified when it was created.

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

if the service uses the `CODE_DEPLOY` deployment controller, the `deploymentController`, `taskSets` and `deployments` parameters will be returned, however the `deployments` parameter will be an empty list.

" } } }, "CreateTaskSetRequest":{ "type":"structure", "required":[ "service", "cluster", "taskDefinition" ], "members":{ "service":{ "shape":"String", "documentation":"

The short name or full Amazon Resource Name (ARN) of the service to create the task set in.

" }, "cluster":{ "shape":"String", "documentation":"

The short name or full Amazon Resource Name (ARN) of the cluster that hosts the service to create the task set in.

" }, "externalId":{ "shape":"String", "documentation":"

An optional non-unique tag that identifies this task set in external systems. If the task set is associated with a service discovery registry, the tasks in this task set will have the `ECS_TASK_SET_EXTERNAL_ID` Cloud Map attribute set to the provided value.

" }, "taskDefinition":{ "shape":"String", "documentation":"

The task definition for the tasks in the task set to use. If a revision isn't specified, the latest `ACTIVE` revision is used.

" }, "networkConfiguration":{ "shape":"NetworkConfiguration", "documentation":"

An object representing the network configuration for a task set.

" }, "loadBalancers":{ "shape":"LoadBalancers", "documentation":"

A load balancer object representing the load balancer to use with the task set. The supported load balancer types are either an Application Load Balancer or a Network Load Balancer.

" }, "serviceRegistries":{ "shape":"ServiceRegistries", "documentation":"

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

" }, "launchType":{ "shape":"LaunchType", "documentation":"

The launch type that new tasks in the task set uses. For more information, see Amazon ECS launch types in the Amazon Elastic Container Service Developer Guide.

If a `launchType` is specified, the `capacityProviderStrategy` parameter must be omitted.

" }, "capacityProviderStrategy":{ "shape":"CapacityProviderStrategy", "documentation":"

The capacity provider strategy to use for the task set.

A capacity provider strategy consists of one or more capacity providers along with the `base` and `weight` to assign to them. A capacity provider must be associated with the cluster to be used in a capacity provider strategy. The PutClusterCapacityProviders API is used to associate a capacity provider with a cluster. Only capacity providers with an `ACTIVE` or `UPDATING` status can be used.

If a `capacityProviderStrategy` is specified, the `launchType` parameter must be omitted. If no `capacityProviderStrategy` or `launchType` is specified, the `defaultCapacityProviderStrategy` for the cluster is used.

If specifying a capacity provider that uses an Auto Scaling group, the capacity provider must already be created. New capacity providers can be created with the CreateCapacityProvider API operation.

To use a Fargate capacity provider, specify either the `FARGATE` or `FARGATE_SPOT` capacity providers. The Fargate capacity providers are available to all accounts and only need to be associated with a cluster to be used.

The PutClusterCapacityProviders API operation is used to update the list of available capacity providers for a cluster after the cluster is created.

" }, "platformVersion":{ "shape":"String", "documentation":"

The platform version that the tasks in the task set uses. A platform version is specified only for tasks using the Fargate launch type. If one isn't specified, the `LATEST` platform version is used.

" }, "scale":{ "shape":"Scale", "documentation":"

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

" }, "clientToken":{ "shape":"String", "documentation":"

An identifier that you provide to ensure the idempotency of the request. It must be unique and is case sensitive. Up to 36 ASCII characters in the range of 33-126 (inclusive) are allowed.

" }, "tags":{ "shape":"Tags", "documentation":"

The metadata that you apply to the task set to help you categorize and organize them. Each tag consists of a key and an optional value. You define both. When a service is deleted, the tags are deleted.

The following basic restrictions apply to tags:

- Maximum number of tags per resource - 50

- For each resource, each tag key must be unique, and each tag key can have only one value.

- Maximum key length - 128 Unicode characters in UTF-8

- Maximum value length - 256 Unicode characters in UTF-8

- If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.

- Tag keys and values are case-sensitive.

- Do not use `aws:`, `AWS:`, or any upper or lowercase combination of such as a prefix for either keys or values as it is reserved for Amazon Web Services use. You cannot edit or delete tag keys or values with this prefix. Tags with this prefix do not count against your tags per resource limit.

" } } }, "CreateTaskSetResponse":{ "type":"structure", "members":{ "taskSet":{ "shape":"TaskSet", "documentation":"

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

" } } }, "DeleteAccountSettingRequest":{ "type":"structure", "required":["name"], "members":{ "name":{ "shape":"SettingName", "documentation":"

The resource name to disable the account setting for. 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. If `awsvpcTrunking` is specified, the ENI limit for your Amazon ECS container instances is affected.

" }, "principalArn":{ "shape":"String", "documentation":"

The Amazon Resource Name (ARN) of the principal. It can be an user, role, or the root user. If you specify the root user, it disables the account setting for all users, roles, and the root user of the account unless a user or role explicitly overrides these settings. If this field is omitted, the setting is changed only for the authenticated user.

" } } }, "DeleteAccountSettingResponse":{ "type":"structure", "members":{ "setting":{ "shape":"Setting", "documentation":"

The account setting for the specified principal ARN.

" } } }, "DeleteAttributesRequest":{ "type":"structure", "required":["attributes"], "members":{ "cluster":{ "shape":"String", "documentation":"

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.

" }, "attributes":{ "shape":"Attributes", "documentation":"

The attributes to delete from your resource. You can specify up to 10 attributes for each request. For custom attributes, specify the attribute name and target ID, but don't specify the value. If you specify the target ID using the short form, you must also specify the target type.

" } } }, "DeleteAttributesResponse":{ "type":"structure", "members":{ "attributes":{ "shape":"Attributes", "documentation":"

A list of attribute objects that were successfully deleted from your resource.

" } } }, "DeleteCapacityProviderRequest":{ "type":"structure", "required":["capacityProvider"], "members":{ "capacityProvider":{ "shape":"String", "documentation":"

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

" } } }, "DeleteCapacityProviderResponse":{ "type":"structure", "members":{ "capacityProvider":{ "shape":"CapacityProvider", "documentation":"

The details of the capacity provider.

" } } }, "DeleteClusterRequest":{ "type":"structure", "required":["cluster"], "members":{ "cluster":{ "shape":"String", "documentation":"

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

" } } }, "DeleteClusterResponse":{ "type":"structure", "members":{ "cluster":{ "shape":"Cluster", "documentation":"

The full description of the deleted cluster.

" } } }, "DeleteServiceRequest":{ "type":"structure", "required":["service"], "members":{ "cluster":{ "shape":"String", "documentation":"

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.

" }, "service":{ "shape":"String", "documentation":"

The name of the service to delete.

" }, "force":{ "shape":"BoxedBoolean", "documentation":"

If `true`, allows you to delete a service even if it wasn't scaled down to zero tasks. It's only necessary to use this if the service uses the `REPLICA` scheduling strategy.

" } } }, "DeleteServiceResponse":{ "type":"structure", "members":{ "service":{ "shape":"Service", "documentation":"

The full description of the deleted service.

" } } }, "DeleteTaskDefinitionsRequest":{ "type":"structure", "required":["taskDefinitions"], "members":{ "taskDefinitions":{ "shape":"StringList", "documentation":"

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

You can specify up to 10 task definitions as a comma separated list.

" } } }, "DeleteTaskDefinitionsResponse":{ "type":"structure", "members":{ "taskDefinitions":{ "shape":"TaskDefinitionList", "documentation":"

The list of deleted task definitions.

" }, "failures":{ "shape":"Failures", "documentation":"

Any failures associated with the call.

" } } }, "DeleteTaskSetRequest":{ "type":"structure", "required":[ "cluster", "service", "taskSet" ], "members":{ "cluster":{ "shape":"String", "documentation":"

The short name or full Amazon Resource Name (ARN) of the cluster that hosts the service that the task set found in to delete.

" }, "service":{ "shape":"String", "documentation":"

The short name or full Amazon Resource Name (ARN) of the service that hosts the task set to delete.

" }, "taskSet":{ "shape":"String", "documentation":"

The task set ID or full Amazon Resource Name (ARN) of the task set to delete.

" }, "force":{ "shape":"BoxedBoolean", "documentation":"

If `true`, you can delete a task set even if it hasn't been scaled down to zero.

" } } }, "DeleteTaskSetResponse":{ "type":"structure", "members":{ "taskSet":{ "shape":"TaskSet", "documentation":"

Details about the task set.

" } } }, "Deployment":{ "type":"structure", "members":{ "id":{ "shape":"String", "documentation":"

The ID of the deployment.

" }, "status":{ "shape":"String", "documentation":"

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.

" }, "taskDefinition":{ "shape":"String", "documentation":"

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

" }, "desiredCount":{ "shape":"Integer", "documentation":"

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

" }, "pendingCount":{ "shape":"Integer", "documentation":"

The number of tasks in the deployment that are in the `PENDING` status.

" }, "runningCount":{ "shape":"Integer", "documentation":"

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

" }, "failedTasks":{ "shape":"Integer", "documentation":"

The number of consecutively failed tasks in the deployment. A task is considered a failure if the service scheduler can't launch the task, the task doesn't transition to a `RUNNING` state, or if it fails any of its defined health checks and is stopped.

Once a service deployment has one or more successfully running tasks, the failed task count resets to zero and stops being evaluated.

" }, "createdAt":{ "shape":"Timestamp", "documentation":"

The Unix timestamp for the time when the service deployment was created.

" }, "updatedAt":{ "shape":"Timestamp", "documentation":"

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

" }, "capacityProviderStrategy":{ "shape":"CapacityProviderStrategy", "documentation":"

The capacity provider strategy that the deployment is using.

" }, "launchType":{ "shape":"LaunchType", "documentation":"

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.

" }, "platformVersion":{ "shape":"String", "documentation":"

The platform version that your tasks in the service run on. A platform version is only specified for tasks using the Fargate launch type. If one isn't specified, the `LATEST` platform version is used. For more information, see Fargate Platform Versions in the Amazon Elastic Container Service Developer Guide.

" }, "platformFamily":{ "shape":"String", "documentation":"

The operating system that your tasks in the service, or tasks are running on. A platform family is specified only for tasks using the Fargate launch type.

All tasks that run as part of this service must use the same `platformFamily` value as the service, for example, `LINUX.`.

" }, "networkConfiguration":{ "shape":"NetworkConfiguration", "documentation":"

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

" }, "rolloutState":{ "shape":"DeploymentRolloutState", "documentation":"

The `rolloutState` of a service is only returned for services that use the rolling update (`ECS`) deployment type that aren't behind a Classic Load Balancer.

The rollout state of the deployment. When a service deployment is started, it begins in an `IN_PROGRESS` state. When the service reaches a steady state, the deployment transitions to a `COMPLETED` state. If the service fails to reach a steady state and circuit breaker is turned on, the deployment transitions to a `FAILED` state. A deployment in `FAILED` state doesn't launch any new tasks. For more information, see DeploymentCircuitBreaker.

" }, "rolloutStateReason":{ "shape":"String", "documentation":"

A description of the rollout state of a deployment.

" }, "serviceConnectConfiguration":{ "shape":"ServiceConnectConfiguration", "documentation":"

The details of the Service Connect configuration that's used by this deployment. Compare the configuration between multiple deployments when troubleshooting issues with new deployments.

The configuration for this service to discover and connect to services, and be discovered by, and connected from, other services within a namespace.

Tasks that run in a namespace can use short names to connect to services in the namespace. Tasks can connect to services across all of the clusters in the namespace. Tasks connect through a managed proxy container that collects logs and metrics for increased visibility. Only the tasks that Amazon ECS services create are supported with Service Connect. For more information, see Service Connect in the Amazon Elastic Container Service Developer Guide.

" }, "serviceConnectResources":{ "shape":"ServiceConnectServiceResourceList", "documentation":"

The list of Service Connect resources that are associated with this deployment. Each list entry maps a discovery name to a Cloud Map service name.

" }, "volumeConfigurations":{ "shape":"ServiceVolumeConfigurations", "documentation":"

The details of the volume that was `configuredAtLaunch`. You can configure different settings like the size, throughput, volumeType, and ecryption in ServiceManagedEBSVolumeConfiguration. The `name` of the volume must match the `name` from the task definition.

" } }, "documentation":"

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

" }, "DeploymentAlarms":{ "type":"structure", "required":[ "alarmNames", "enable", "rollback" ], "members":{ "alarmNames":{ "shape":"StringList", "documentation":"

One or more CloudWatch alarm names. Use a \",\" to separate the alarms.

" }, "enable":{ "shape":"Boolean", "documentation":"

Determines whether to use the CloudWatch alarm option in the service deployment process.

" }, "rollback":{ "shape":"Boolean", "documentation":"

Determines whether to configure Amazon ECS to roll back the service if a service deployment fails. If rollback is used, when a service deployment fails, the service is rolled back to the last deployment that completed successfully.

" } }, "documentation":"

One of the methods which provide a way for you to quickly identify when a deployment has failed, and then to optionally roll back the failure to the last working deployment.

When the alarms are generated, Amazon ECS sets the service deployment to failed. Set the rollback parameter to have Amazon ECS to roll back your service to the last completed deployment after a failure.

You can only use the `DeploymentAlarms` method to detect failures when the `DeploymentController` is set to `ECS` (rolling update).

For more information, see Rolling update in the Amazon Elastic Container Service Developer Guide .

" }, "DeploymentCircuitBreaker":{ "type":"structure", "required":[ "enable", "rollback" ], "members":{ "enable":{ "shape":"Boolean", "documentation":"

Determines whether to use the deployment circuit breaker logic for the service.

" }, "rollback":{ "shape":"Boolean", "documentation":"

Determines whether to configure Amazon ECS to roll back the service if a service deployment fails. If rollback is on, when a service deployment fails, the service is rolled back to the last deployment that completed successfully.

" } }, "documentation":"

The deployment circuit breaker can only be used for services using the rolling update (`ECS`) deployment type.

The deployment circuit breaker determines whether a service deployment will fail if the service can't reach a steady state. If it is turned on, a service deployment will transition to a failed state and stop launching new tasks. You can also configure Amazon ECS to roll back your service to the last completed deployment after a failure. For more information, see Rolling update in the Amazon Elastic Container Service Developer Guide.

For more information about API failure reasons, see API failure reasons in the Amazon Elastic Container Service Developer Guide.

" }, "DeploymentConfiguration":{ "type":"structure", "members":{ "deploymentCircuitBreaker":{ "shape":"DeploymentCircuitBreaker", "documentation":"

The deployment circuit breaker can only be used for services using the rolling update (`ECS`) deployment type.

The deployment circuit breaker determines whether a service deployment will fail if the service can't reach a steady state. If you use the deployment circuit breaker, a service deployment will transition to a failed state and stop launching new tasks. If you use the rollback option, when a service deployment fails, the service is rolled back to the last deployment that completed successfully. For more information, see Rolling update in the Amazon Elastic Container Service Developer Guide

" }, "maximumPercent":{ "shape":"BoxedInteger", "documentation":"

If a service is using the rolling update (`ECS`) deployment type, 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 service is using the `REPLICA` service scheduler and has a `desiredCount` of four tasks and a `maximumPercent` 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 `maximumPercent` value for a service using the `REPLICA` service scheduler is 200%.

If a service is using either the blue/green (`CODE_DEPLOY`) or `EXTERNAL` deployment types 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.

" }, "minimumHealthyPercent":{ "shape":"BoxedInteger", "documentation":"

If a service is using the rolling update (`ECS`) deployment type, 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 service scheduler may stop two existing tasks to free up cluster capacity before starting two new tasks.

For services that do not use a load balancer, the following should be noted:

- A service is considered healthy if all essential containers within the tasks in the service pass their health checks.

- If a task has no essential containers with a health check defined, the service scheduler will wait for 40 seconds after a task reaches a `RUNNING` state before the task is counted towards the minimum healthy percent total.

- If a task has one or more essential containers with a health check defined, the service scheduler will wait for the task to reach a healthy status before counting it towards the minimum healthy percent total. A task is considered healthy when all essential containers within the task have passed their health checks. The amount of time the service scheduler can wait for is determined by the container health check settings.

For services are that do use a load balancer, the following should be noted:

- If a task has no essential containers with a health check defined, the service scheduler will wait for the load balancer target group health check to return a healthy status before counting the task towards the minimum healthy percent total.

- If a task has an essential container with a health check defined, the service scheduler will wait for both the task to reach a healthy status and the load balancer target group health check to return a healthy status before counting the task towards the minimum healthy percent total.

If a service is using either the blue/green (`CODE_DEPLOY`) or `EXTERNAL` deployment types and is running 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 a service is using either the blue/green (`CODE_DEPLOY`) or `EXTERNAL` deployment types and is running tasks that use the Fargate launch type, the minimum healthy percent value is not used, although it is returned when describing your service.

" }, "alarms":{ "shape":"DeploymentAlarms", "documentation":"

Information about the CloudWatch alarms.

" } }, "documentation":"

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

" }, "DeploymentController":{ "type":"structure", "required":["type"], "members":{ "type":{ "shape":"DeploymentControllerType", "documentation":"

The deployment controller type to use.

There are three 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 CodeDeploy, which allows you to verify a new deployment of a service before sending production traffic to it.

EXTERNAL

  The external (`EXTERNAL`) deployment type enables you to use any third-party deployment controller for full control over the deployment process for an Amazon ECS service.

" } }, "documentation":"

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

" }, "DeploymentControllerType":{ "type":"string", "enum":[ "ECS", "CODE_DEPLOY", "EXTERNAL" ] }, "DeploymentRolloutState":{ "type":"string", "enum":[ "COMPLETED", "FAILED", "IN_PROGRESS" ] }, "Deployments":{ "type":"list", "member":{"shape":"Deployment"} }, "DeregisterContainerInstanceRequest":{ "type":"structure", "required":["containerInstance"], "members":{ "cluster":{ "shape":"String", "documentation":"

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.

" }, "containerInstance":{ "shape":"String", "documentation":"

The container instance ID or full ARN of the container instance to deregister. For more information about the ARN format, see Amazon Resource Name (ARN) in the Amazon ECS Developer Guide.

" }, "force":{ "shape":"BoxedBoolean", "documentation":"

Forces the container instance to be deregistered. 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're 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.

" } } }, "DeregisterContainerInstanceResponse":{ "type":"structure", "members":{ "containerInstance":{ "shape":"ContainerInstance", "documentation":"

The container instance that was deregistered.

" } } }, "DeregisterTaskDefinitionRequest":{ "type":"structure", "required":["taskDefinition"], "members":{ "taskDefinition":{ "shape":"String", "documentation":"

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

" } } }, "DeregisterTaskDefinitionResponse":{ "type":"structure", "members":{ "taskDefinition":{ "shape":"TaskDefinition", "documentation":"

The full description of the deregistered task.

" } } }, "DescribeCapacityProvidersRequest":{ "type":"structure", "members":{ "capacityProviders":{ "shape":"StringList", "documentation":"

The short name or full Amazon Resource Name (ARN) of one or more capacity providers. Up to `100` capacity providers can be described in an action.

" }, "include":{ "shape":"CapacityProviderFieldList", "documentation":"

Specifies whether or not you want to see the resource tags for the capacity provider. If `TAGS` is specified, the tags are included in the response. If this field is omitted, tags aren't included in the response.

" }, "maxResults":{ "shape":"BoxedInteger", "documentation":"

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

" }, "nextToken":{ "shape":"String", "documentation":"

The `nextToken` value returned from a previous paginated `DescribeCapacityProviders` 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.

" } } }, "DescribeCapacityProvidersResponse":{ "type":"structure", "members":{ "capacityProviders":{ "shape":"CapacityProviders", "documentation":"

The list of capacity providers.

" }, "failures":{ "shape":"Failures", "documentation":"

Any failures associated with the call.

" }, "nextToken":{ "shape":"String", "documentation":"

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

" } } }, "DescribeClustersRequest":{ "type":"structure", "members":{ "clusters":{ "shape":"StringList", "documentation":"

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.

" }, "include":{ "shape":"ClusterFieldList", "documentation":"

Determines whether to include additional information about the clusters in the response. If this field is omitted, this information isn't included.

If `ATTACHMENTS` is specified, the attachments for the container instances or tasks within the cluster are included, for example the capacity providers.

If `SETTINGS` is specified, the settings for the cluster are included.

If `CONFIGURATIONS` is specified, the configuration for the cluster is included.

If `STATISTICS` is specified, the task and service count is included, separated by launch type.

If `TAGS` is specified, the metadata tags associated with the cluster are included.

" } } }, "DescribeClustersResponse":{ "type":"structure", "members":{ "clusters":{ "shape":"Clusters", "documentation":"

The list of clusters.

" }, "failures":{ "shape":"Failures", "documentation":"

Any failures associated with the call.

" } } }, "DescribeContainerInstancesRequest":{ "type":"structure", "required":["containerInstances"], "members":{ "cluster":{ "shape":"String", "documentation":"

The short name or full Amazon Resource Name (ARN) of the cluster that hosts the container instances to describe. If you do not specify a cluster, the default cluster is assumed. This parameter is required if the container instance or container instances you are describing were launched in any cluster other than the default cluster.

" }, "containerInstances":{ "shape":"StringList", "documentation":"

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

" }, "include":{ "shape":"ContainerInstanceFieldList", "documentation":"

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 `CONTAINER_INSTANCE_HEALTH` is specified, the container instance health is included in the response. If this field is omitted, tags and container instance health status aren't included in the response.

" } } }, "DescribeContainerInstancesResponse":{ "type":"structure", "members":{ "containerInstances":{ "shape":"ContainerInstances", "documentation":"

The list of container instances.

" }, "failures":{ "shape":"Failures", "documentation":"

Any failures associated with the call.

" } } }, "DescribeServicesRequest":{ "type":"structure", "required":["services"], "members":{ "cluster":{ "shape":"String", "documentation":"

The short name or full Amazon Resource Name (ARN)the cluster that hosts the service to describe. If you do not specify a cluster, the default cluster is assumed. This parameter is required if the service or services you are describing were launched in any cluster other than the default cluster.

" }, "services":{ "shape":"StringList", "documentation":"

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

" }, "include":{ "shape":"ServiceFieldList", "documentation":"

Determines 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 aren't included in the response.

" } } }, "DescribeServicesResponse":{ "type":"structure", "members":{ "services":{ "shape":"Services", "documentation":"

The list of services described.

" }, "failures":{ "shape":"Failures", "documentation":"

Any failures associated with the call.

" } } }, "DescribeTaskDefinitionRequest":{ "type":"structure", "required":["taskDefinition"], "members":{ "taskDefinition":{ "shape":"String", "documentation":"

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.

" }, "include":{ "shape":"TaskDefinitionFieldList", "documentation":"

Determines 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 aren't included in the response.

" } } }, "DescribeTaskDefinitionResponse":{ "type":"structure", "members":{ "taskDefinition":{ "shape":"TaskDefinition", "documentation":"

The full task definition description.

" }, "tags":{ "shape":"Tags", "documentation":"

The metadata that's applied to the task definition to help you categorize and organize them. Each tag consists of a key and an optional value. You define both.

The following basic restrictions apply to tags:

- Maximum number of tags per resource - 50

- For each resource, each tag key must be unique, and each tag key can have only one value.

- Maximum key length - 128 Unicode characters in UTF-8

- Maximum value length - 256 Unicode characters in UTF-8

- If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.

- Tag keys and values are case-sensitive.

- Do not use `aws:`, `AWS:`, or any upper or lowercase combination of such as a prefix for either keys or values as it is reserved for Amazon Web Services use. You cannot edit or delete tag keys or values with this prefix. Tags with this prefix do not count against your tags per resource limit.

" } } }, "DescribeTaskSetsRequest":{ "type":"structure", "required":[ "cluster", "service" ], "members":{ "cluster":{ "shape":"String", "documentation":"

The short name or full Amazon Resource Name (ARN) of the cluster that hosts the service that the task sets exist in.

" }, "service":{ "shape":"String", "documentation":"

The short name or full Amazon Resource Name (ARN) of the service that the task sets exist in.

" }, "taskSets":{ "shape":"StringList", "documentation":"

The ID or full Amazon Resource Name (ARN) of task sets to describe.

" }, "include":{ "shape":"TaskSetFieldList", "documentation":"

Specifies whether to see the resource tags for the task set. If `TAGS` is specified, the tags are included in the response. If this field is omitted, tags aren't included in the response.

" } } }, "DescribeTaskSetsResponse":{ "type":"structure", "members":{ "taskSets":{ "shape":"TaskSets", "documentation":"

The list of task sets described.

" }, "failures":{ "shape":"Failures", "documentation":"

Any failures associated with the call.

" } } }, "DescribeTasksRequest":{ "type":"structure", "required":["tasks"], "members":{ "cluster":{ "shape":"String", "documentation":"

The short name or full Amazon Resource Name (ARN) of the cluster that hosts the task or tasks to describe. If you do not specify a cluster, the default cluster is assumed. This parameter is required if the task or tasks you are describing were launched in any cluster other than the default cluster.

" }, "tasks":{ "shape":"StringList", "documentation":"

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

" }, "include":{ "shape":"TaskFieldList", "documentation":"

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 aren't included in the response.

" } } }, "DescribeTasksResponse":{ "type":"structure", "members":{ "tasks":{ "shape":"Tasks", "documentation":"

The list of tasks.

" }, "failures":{ "shape":"Failures", "documentation":"

Any failures associated with the call.

" } } }, "DesiredStatus":{ "type":"string", "enum":[ "RUNNING", "PENDING", "STOPPED" ] }, "Device":{ "type":"structure", "required":["hostPath"], "members":{ "hostPath":{ "shape":"String", "documentation":"

The path for the device on the host container instance.

" }, "containerPath":{ "shape":"String", "documentation":"

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

" }, "permissions":{ "shape":"DeviceCgroupPermissions", "documentation":"

The explicit permissions to provide to the container for the device. By default, the container has permissions for `read`, `write`, and `mknod` for the device.

" } }, "documentation":"

An object representing a container instance host device.

" }, "DeviceCgroupPermission":{ "type":"string", "enum":[ "read", "write", "mknod" ] }, "DeviceCgroupPermissions":{ "type":"list", "member":{"shape":"DeviceCgroupPermission"} }, "DevicesList":{ "type":"list", "member":{"shape":"Device"} }, "DiscoverPollEndpointRequest":{ "type":"structure", "members":{ "containerInstance":{ "shape":"String", "documentation":"

The container instance ID or full ARN of the container instance. For more information about the ARN format, see Amazon Resource Name (ARN) in the Amazon ECS Developer Guide.

" }, "cluster":{ "shape":"String", "documentation":"

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

" } } }, "DiscoverPollEndpointResponse":{ "type":"structure", "members":{ "endpoint":{ "shape":"String", "documentation":"

The endpoint for the Amazon ECS agent to poll.

" }, "telemetryEndpoint":{ "shape":"String", "documentation":"

The telemetry endpoint for the Amazon ECS agent.

" }, "serviceConnectEndpoint":{ "shape":"String", "documentation":"

The endpoint for the Amazon ECS agent to poll for Service Connect configuration. For more information, see Service Connect in the Amazon Elastic Container Service Developer Guide.

" } } }, "DockerLabelsMap":{ "type":"map", "key":{"shape":"String"}, "value":{"shape":"String"} }, "DockerVolumeConfiguration":{ "type":"structure", "members":{ "scope":{ "shape":"Scope", "documentation":"

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.

" }, "autoprovision":{ "shape":"BoxedBoolean", "documentation":"

If this value is `true`, the Docker volume is created if it doesn't already exist.

This field is only used if the `scope` is `shared`.

" }, "driver":{ "shape":"String", "documentation":"

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.

" }, "driverOpts":{ "shape":"StringMap", "documentation":"

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.

" }, "labels":{ "shape":"StringMap", "documentation":"

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.

" } }, "documentation":"

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

" }, "Double":{"type":"double"}, "EBSKMSKeyId":{"type":"string"}, "EBSResourceType":{ "type":"string", "enum":["volume"] }, "EBSSnapshotId":{"type":"string"}, "EBSTagSpecification":{ "type":"structure", "required":["resourceType"], "members":{ "resourceType":{ "shape":"EBSResourceType", "documentation":"

The type of volume resource.

" }, "tags":{ "shape":"Tags", "documentation":"

The tags applied to this Amazon EBS volume. `AmazonECSCreated` and `AmazonECSManaged` are reserved tags that can't be used.

" }, "propagateTags":{ "shape":"PropagateTags", "documentation":"

Determines whether to propagate the tags from the task definition to  the Amazon EBS volume. Tags can only propagate to a `SERVICE` specified in`ServiceVolumeConfiguration`. If no value is specified, the tags aren't  propagated.

" } }, "documentation":"

The tag specifications of an Amazon EBS volume.

" }, "EBSTagSpecifications":{ "type":"list", "member":{"shape":"EBSTagSpecification"} }, "EBSVolumeType":{"type":"string"}, "ECSVolumeName":{"type":"string"}, "EFSAuthorizationConfig":{ "type":"structure", "members":{ "accessPointId":{ "shape":"String", "documentation":"

The Amazon EFS access point ID to use. If an access point is specified, the root directory value specified in the `EFSVolumeConfiguration` must either be omitted or set to `/` which will enforce the path set on the EFS access point. If an access point is used, transit encryption must be on in the `EFSVolumeConfiguration`. For more information, see Working with Amazon EFS access points in the Amazon Elastic File System User Guide.

" }, "iam":{ "shape":"EFSAuthorizationConfigIAM", "documentation":"

Determines whether to use the Amazon ECS task role defined in a task definition when mounting the Amazon EFS file system. If it is turned on, transit encryption must be turned on in the `EFSVolumeConfiguration`. If this parameter is omitted, the default value of `DISABLED` is used. For more information, see Using Amazon EFS access points in the Amazon Elastic Container Service Developer Guide.

" } }, "documentation":"

The authorization configuration details for the Amazon EFS file system.

" }, "EFSAuthorizationConfigIAM":{ "type":"string", "enum":[ "ENABLED", "DISABLED" ] }, "EFSTransitEncryption":{ "type":"string", "enum":[ "ENABLED", "DISABLED" ] }, "EFSVolumeConfiguration":{ "type":"structure", "required":["fileSystemId"], "members":{ "fileSystemId":{ "shape":"String", "documentation":"

The Amazon EFS file system ID to use.

" }, "rootDirectory":{ "shape":"String", "documentation":"

The directory within the Amazon EFS file system to mount as the root directory inside the host. If this parameter is omitted, the root of the Amazon EFS volume will be used. Specifying `/` will have the same effect as omitting this parameter.

If an EFS access point is specified in the `authorizationConfig`, the root directory parameter must either be omitted or set to `/` which will enforce the path set on the EFS access point.

" }, "transitEncryption":{ "shape":"EFSTransitEncryption", "documentation":"

Determines whether to use encryption for Amazon EFS data in transit between the Amazon ECS host and the Amazon EFS server. Transit encryption must be turned on if Amazon EFS IAM authorization is used. If this parameter is omitted, the default value of `DISABLED` is used. For more information, see Encrypting data in transit in the Amazon Elastic File System User Guide.

" }, "transitEncryptionPort":{ "shape":"BoxedInteger", "documentation":"

The port to use when sending encrypted data between the Amazon ECS host and the Amazon EFS server. If you do not specify a transit encryption port, it will use the port selection strategy that the Amazon EFS mount helper uses. For more information, see EFS mount helper in the Amazon Elastic File System User Guide.

" }, "authorizationConfig":{ "shape":"EFSAuthorizationConfig", "documentation":"

The authorization configuration details for the Amazon EFS file system.

" } }, "documentation":"

This parameter is specified when you're using an Amazon Elastic File System file system for task storage. For more information, see Amazon EFS volumes in the Amazon Elastic Container Service Developer Guide.

" }, "EnvironmentFile":{ "type":"structure", "required":[ "value", "type" ], "members":{ "value":{ "shape":"String", "documentation":"

The Amazon Resource Name (ARN) of the Amazon S3 object containing the environment variable file.

" }, "type":{ "shape":"EnvironmentFileType", "documentation":"

The file type to use. The only supported value is `s3`.

" } }, "documentation":"

A list of files containing the environment variables to pass to a container. You can specify up to ten environment files. The file must have a `.env` file extension. Each line in an environment file should contain an environment variable in `VARIABLE=VALUE` format. Lines beginning with `#` are treated as comments and are ignored.

If there are environment variables specified using the `environment` parameter in a container definition, they take precedence over the variables contained within an environment file. If multiple environment files are specified that contain the same variable, they're processed from the top down. We recommend that you use unique variable names. For more information, see Specifying environment variables in the Amazon Elastic Container Service Developer Guide.

You must use the following platforms for the Fargate launch type:

- Linux platform version `1.4.0` or later.

- Windows platform version `1.0.0` or later.

Consider the following when using the Fargate launch type:

- The file is handled like a native Docker env-file.

- There is no support for shell escape handling.

- The container entry point interperts the `VARIABLE` values.

" }, "EnvironmentFileType":{ "type":"string", "enum":["s3"] }, "EnvironmentFiles":{ "type":"list", "member":{"shape":"EnvironmentFile"} }, "EnvironmentVariables":{ "type":"list", "member":{"shape":"KeyValuePair"} }, "EphemeralStorage":{ "type":"structure", "required":["sizeInGiB"], "members":{ "sizeInGiB":{ "shape":"Integer", "documentation":"

The total amount, in GiB, of ephemeral storage to set for the task. The minimum supported value is `21` GiB and the maximum supported value is `200` GiB.

" } }, "documentation":"

The amount of ephemeral storage to allocate for the task. This parameter is used to expand the total amount of ephemeral storage available, beyond the default amount, for tasks hosted on Fargate. For more information, see Fargate task storage in the Amazon ECS User Guide for Fargate.

For tasks using the Fargate launch type, the task requires the following platforms:

- Linux platform version `1.4.0` or later.

- Windows platform version `1.0.0` or later.

" }, "ExecuteCommandConfiguration":{ "type":"structure", "members":{ "kmsKeyId":{ "shape":"String", "documentation":"

Specify an Key Management Service key ID to encrypt the data between the local client and the container.

" }, "logging":{ "shape":"ExecuteCommandLogging", "documentation":"

The log setting to use for redirecting logs for your execute command results. The following log settings are available.

- `NONE`: The execute command session is not logged.

- `DEFAULT`: The `awslogs` configuration in the task definition is used. If no logging parameter is specified, it defaults to this value. If no `awslogs` log driver is configured in the task definition, the output won't be logged.

- `OVERRIDE`: Specify the logging details as a part of `logConfiguration`. If the `OVERRIDE` logging option is specified, the `logConfiguration` is required.

" }, "logConfiguration":{ "shape":"ExecuteCommandLogConfiguration", "documentation":"

The log configuration for the results of the execute command actions. The logs can be sent to CloudWatch Logs or an Amazon S3 bucket. When `logging=OVERRIDE` is specified, a `logConfiguration` must be provided.

" } }, "documentation":"

The details of the execute command configuration.

" }, "ExecuteCommandLogConfiguration":{ "type":"structure", "members":{ "cloudWatchLogGroupName":{ "shape":"String", "documentation":"

The name of the CloudWatch log group to send logs to.

The CloudWatch log group must already be created.

" }, "cloudWatchEncryptionEnabled":{ "shape":"Boolean", "documentation":"

Determines whether to use encryption on the CloudWatch logs. If not specified, encryption will be off.

" }, "s3BucketName":{ "shape":"String", "documentation":"

The name of the S3 bucket to send logs to.

The S3 bucket must already be created.

" }, "s3EncryptionEnabled":{ "shape":"Boolean", "documentation":"

Determines whether to use encryption on the S3 logs. If not specified, encryption is not used.

" }, "s3KeyPrefix":{ "shape":"String", "documentation":"

An optional folder in the S3 bucket to place logs in.

" } }, "documentation":"

The log configuration for the results of the execute command actions. The logs can be sent to CloudWatch Logs or an Amazon S3 bucket.

" }, "ExecuteCommandLogging":{ "type":"string", "enum":[ "NONE", "DEFAULT", "OVERRIDE" ] }, "ExecuteCommandRequest":{ "type":"structure", "required":[ "command", "interactive", "task" ], "members":{ "cluster":{ "shape":"String", "documentation":"

The Amazon Resource Name (ARN) or short name of the cluster the task is running in. If you do not specify a cluster, the default cluster is assumed.

" }, "container":{ "shape":"String", "documentation":"

The name of the container to execute the command on. A container name only needs to be specified for tasks containing multiple containers.

" }, "command":{ "shape":"String", "documentation":"

The command to run on the container.

" }, "interactive":{ "shape":"Boolean", "documentation":"

Use this flag to run your command in interactive mode.

" }, "task":{ "shape":"String", "documentation":"

The Amazon Resource Name (ARN) or ID of the task the container is part of.

" } } }, "ExecuteCommandResponse":{ "type":"structure", "members":{ "clusterArn":{ "shape":"String", "documentation":"

The Amazon Resource Name (ARN) of the cluster.

" }, "containerArn":{ "shape":"String", "documentation":"

The Amazon Resource Name (ARN) of the container.

" }, "containerName":{ "shape":"String", "documentation":"

The name of the container.

" }, "interactive":{ "shape":"Boolean", "documentation":"

Determines whether the execute command session is running in interactive mode. Amazon ECS only supports initiating interactive sessions, so you must specify `true` for this value.

" }, "session":{ "shape":"Session", "documentation":"

The details of the SSM session that was created for this instance of execute-command.

" }, "taskArn":{ "shape":"String", "documentation":"

The Amazon Resource Name (ARN) of the task.

" } } }, "FSxWindowsFileServerAuthorizationConfig":{ "type":"structure", "required":[ "credentialsParameter", "domain" ], "members":{ "credentialsParameter":{ "shape":"String", "documentation":"

The authorization credential option to use. The authorization credential options can be provided using either the Amazon Resource Name (ARN) of an Secrets Manager secret or SSM Parameter Store parameter. The ARN refers to the stored credentials.

" }, "domain":{ "shape":"String", "documentation":"

A fully qualified domain name hosted by an Directory Service Managed Microsoft AD (Active Directory) or self-hosted AD on Amazon EC2.

" } }, "documentation":"

The authorization configuration details for Amazon FSx for Windows File Server file system. See FSxWindowsFileServerVolumeConfiguration in the Amazon ECS API Reference.

For more information and the input format, see Amazon FSx for Windows File Server Volumes in the Amazon Elastic Container Service Developer Guide.

" }, "FSxWindowsFileServerVolumeConfiguration":{ "type":"structure", "required":[ "fileSystemId", "rootDirectory", "authorizationConfig" ], "members":{ "fileSystemId":{ "shape":"String", "documentation":"

The Amazon FSx for Windows File Server file system ID to use.

" }, "rootDirectory":{ "shape":"String", "documentation":"

The directory within the Amazon FSx for Windows File Server file system to mount as the root directory inside the host.

" }, "authorizationConfig":{ "shape":"FSxWindowsFileServerAuthorizationConfig", "documentation":"

The authorization configuration details for the Amazon FSx for Windows File Server file system.

" } }, "documentation":"

This parameter is specified when you're using Amazon FSx for Windows File Server file system for task storage.

For more information and the input format, see Amazon FSx for Windows File Server volumes in the Amazon Elastic Container Service Developer Guide.

" }, "Failure":{ "type":"structure", "members":{ "arn":{ "shape":"String", "documentation":"

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

" }, "reason":{ "shape":"String", "documentation":"

The reason for the failure.

" }, "detail":{ "shape":"String", "documentation":"

The details of the failure.

" } }, "documentation":"

A failed resource. For a list of common causes, see API failure reasons in the Amazon Elastic Container Service Developer Guide.

" }, "Failures":{ "type":"list", "member":{"shape":"Failure"} }, "FirelensConfiguration":{ "type":"structure", "required":["type"], "members":{ "type":{ "shape":"FirelensConfigurationType", "documentation":"

The log router to use. The valid values are `fluentd` or `fluentbit`.

" }, "options":{ "shape":"FirelensConfigurationOptionsMap", "documentation":"

The options to use when configuring the log router. This field is optional and can be used to specify a custom configuration file or to add additional metadata, such as the task, task definition, cluster, and container instance details to the log event. If specified, the syntax to use is `\"options\":{\"enable-ecs-log-metadata\":\"true|false\",\"config-file-type:\"s3|file\",\"config-file-value\":\"arn:aws:s3:::mybucket/fluent.conf|filepath\"}`. For more information, see Creating a task definition that uses a FireLens configuration in the Amazon Elastic Container Service Developer Guide.

Tasks hosted on Fargate only support the `file` configuration file type.

" } }, "documentation":"

The FireLens configuration for the container. This is used to specify and configure a log router for container logs. For more information, see Custom log routing in the Amazon Elastic Container Service Developer Guide.

" }, "FirelensConfigurationOptionsMap":{ "type":"map", "key":{"shape":"String"}, "value":{"shape":"String"} }, "FirelensConfigurationType":{ "type":"string", "enum":[ "fluentd", "fluentbit" ] }, "GetTaskProtectionRequest":{ "type":"structure", "required":["cluster"], "members":{ "cluster":{ "shape":"String", "documentation":"

The short name or full Amazon Resource Name (ARN) of the cluster that hosts the service that the task sets exist in.

" }, "tasks":{ "shape":"StringList", "documentation":"

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

" } } }, "GetTaskProtectionResponse":{ "type":"structure", "members":{ "protectedTasks":{ "shape":"ProtectedTasks", "documentation":"

A list of tasks with the following information.

- `taskArn`: The task ARN.

- `protectionEnabled`: The protection status of the task. If scale-in protection is turned on for a task, the value is `true`. Otherwise, it is `false`.

- `expirationDate`: The epoch time when protection for the task will expire.

" }, "failures":{ "shape":"Failures", "documentation":"

Any failures associated with the call.

" } } }, "GpuIds":{ "type":"list", "member":{"shape":"String"} }, "HealthCheck":{ "type":"structure", "required":["command"], "members":{ "command":{ "shape":"StringList", "documentation":"

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

When you use the Amazon Web Services Management Console JSON panel, the Command Line Interface, or the APIs, enclose the list of commands in double quotes and brackets.

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

You don't include the double quotes and brackets when you use the Amazon Web Services Management Console.

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

" }, "interval":{ "shape":"BoxedInteger", "documentation":"

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

" }, "timeout":{ "shape":"BoxedInteger", "documentation":"

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.

" }, "retries":{ "shape":"BoxedInteger", "documentation":"

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.

" }, "startPeriod":{ "shape":"BoxedInteger", "documentation":"

The optional grace period to provide containers time to bootstrap before failed health checks count towards the maximum number of retries. You can specify between 0 and 300 seconds. By default, the `startPeriod` is off.

If a health check succeeds within the `startPeriod`, then the container is considered healthy and any subsequent failures count toward the maximum number of retries.

" } }, "documentation":"

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). This configuration maps to the `HEALTHCHECK` parameter of docker run.

The Amazon ECS container agent only monitors and reports on the health checks specified in the task definition. Amazon ECS does not monitor Docker health checks that are embedded in a container image 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.

You can view the health status of both individual containers and a task with the DescribeTasks API operation or when viewing the task details in the console.

The health check is designed to make sure that your containers survive agent restarts, upgrades, or temporary unavailability.

The following describes the possible `healthStatus` values for a container:

- `HEALTHY`-The container health check has passed successfully.

- `UNHEALTHY`-The container health check has failed.

- `UNKNOWN`-The container health check is being evaluated, there's no container health check defined, or Amazon ECS doesn't have the health status of the container.

The following describes the possible `healthStatus` values based on the container health checker status of essential containers in the task with the following priority order (high to low):

- `UNHEALTHY`-One or more essential containers have failed their health check.

- `UNKNOWN`-Any essential container running within the task is in an `UNKNOWN` state and no other essential containers have an `UNHEALTHY` state.

- `HEALTHY`-All essential containers within the task have passed their health checks.

Consider the following task health example with 2 containers.

- If Container1 is `UNHEALTHY` and Container2 is `UNKNOWN`, the task health is `UNHEALTHY`.

- If Container1 is `UNHEALTHY` and Container2 is `HEALTHY`, the task health is `UNHEALTHY`.

- If Container1 is `HEALTHY` and Container2 is `UNKNOWN`, the task health is `UNKNOWN`.

- If Container1 is `HEALTHY` and Container2 is `HEALTHY`, the task health is `HEALTHY`.

Consider the following task health example with 3 containers.

- If Container1 is `UNHEALTHY` and Container2 is `UNKNOWN`, and Container3 is `UNKNOWN`, the task health is `UNHEALTHY`.

- If Container1 is `UNHEALTHY` and Container2 is `UNKNOWN`, and Container3 is `HEALTHY`, the task health is `UNHEALTHY`.

- If Container1 is `UNHEALTHY` and Container2 is `HEALTHY`, and Container3 is `HEALTHY`, the task health is `UNHEALTHY`.

- If Container1 is `HEALTHY` and Container2 is `UNKNOWN`, and Container3 is `HEALTHY`, the task health is `UNKNOWN`.

- If Container1 is `HEALTHY` and Container2 is `UNKNOWN`, and Container3 is `UNKNOWN`, the task health is `UNKNOWN`.

- If Container1 is `HEALTHY` and Container2 is `HEALTHY`, and Container3 is `HEALTHY`, the task health is `HEALTHY`.

If a task is run manually, and not as part of a service, the task will continue its lifecycle regardless of its health status. For tasks that are part of a service, if the task reports as unhealthy then the task will be stopped and the service scheduler will replace it.

The following are notes about container health check support:

- When the Amazon ECS agent cannot connect to the Amazon ECS service, the service reports the container as `UNHEALTHY`.

- The health check statuses are the \"last heard from\" response from the Amazon ECS agent. There are no assumptions made about the status of the container health checks.

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

- Container health checks are supported for Fargate tasks if you're using platform version `1.1.0` or greater. For more information, see Fargate platform versions.

- Container health checks aren't supported for tasks that are part of a service that's configured to use a Classic Load Balancer.

" }, "HealthStatus":{ "type":"string", "enum":[ "HEALTHY", "UNHEALTHY", "UNKNOWN" ] }, "HostEntry":{ "type":"structure", "required":[ "hostname", "ipAddress" ], "members":{ "hostname":{ "shape":"String", "documentation":"

The hostname to use in the `/etc/hosts` entry.

" }, "ipAddress":{ "shape":"String", "documentation":"

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

" } }, "documentation":"

Hostnames and IP address entries that are added to the `/etc/hosts` file of a container via the `extraHosts` parameter of its ContainerDefinition.

" }, "HostEntryList":{ "type":"list", "member":{"shape":"HostEntry"} }, "HostVolumeProperties":{ "type":"structure", "members":{ "sourcePath":{ "shape":"String", "documentation":"

When the `host` parameter is used, specify a `sourcePath` to declare the path on the host container instance that's 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 doesn't 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're using the Fargate launch type, the `sourcePath` parameter is not supported.

" } }, "documentation":"

Details on a container instance bind mount host volume.

" }, "IAMRoleArn":{"type":"string"}, "InferenceAccelerator":{ "type":"structure", "required":[ "deviceName", "deviceType" ], "members":{ "deviceName":{ "shape":"String", "documentation":"

The Elastic Inference accelerator device name. The `deviceName` must also be referenced in a container definition as a ResourceRequirement.

" }, "deviceType":{ "shape":"String", "documentation":"

The Elastic Inference accelerator type to use.

" } }, "documentation":"

Details on an Elastic Inference accelerator. For more information, see Working with Amazon Elastic Inference on Amazon ECS in the Amazon Elastic Container Service Developer Guide.

" }, "InferenceAcceleratorOverride":{ "type":"structure", "members":{ "deviceName":{ "shape":"String", "documentation":"

The Elastic Inference accelerator device name to override for the task. This parameter must match a `deviceName` specified in the task definition.

" }, "deviceType":{ "shape":"String", "documentation":"

The Elastic Inference accelerator type to use.

" } }, "documentation":"

Details on an Elastic Inference accelerator task override. This parameter is used to override the Elastic Inference accelerator specified in the task definition. For more information, see Working with Amazon Elastic Inference on Amazon ECS in the Amazon Elastic Container Service Developer Guide.

" }, "InferenceAcceleratorOverrides":{ "type":"list", "member":{"shape":"InferenceAcceleratorOverride"} }, "InferenceAccelerators":{ "type":"list", "member":{"shape":"InferenceAccelerator"} }, "InstanceHealthCheckResult":{ "type":"structure", "members":{ "type":{ "shape":"InstanceHealthCheckType", "documentation":"

The type of container instance health status that was verified.

" }, "status":{ "shape":"InstanceHealthCheckState", "documentation":"

The container instance health status.

" }, "lastUpdated":{ "shape":"Timestamp", "documentation":"

The Unix timestamp for when the container instance health status was last updated.

" }, "lastStatusChange":{ "shape":"Timestamp", "documentation":"

The Unix timestamp for when the container instance health status last changed.

" } }, "documentation":"

An object representing the result of a container instance health status check.

" }, "InstanceHealthCheckResultList":{ "type":"list", "member":{"shape":"InstanceHealthCheckResult"} }, "InstanceHealthCheckState":{ "type":"string", "enum":[ "OK", "IMPAIRED", "INSUFFICIENT_DATA", "INITIALIZING" ] }, "InstanceHealthCheckType":{ "type":"string", "enum":["CONTAINER_RUNTIME"] }, "Integer":{"type":"integer"}, "InvalidParameterException":{ "type":"structure", "members":{ }, "documentation":"

The specified parameter isn't valid. Review the available parameters for the API request.

", "exception":true }, "IpcMode":{ "type":"string", "enum":[ "host", "task", "none" ] }, "KernelCapabilities":{ "type":"structure", "members":{ "add":{ "shape":"StringList", "documentation":"

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.

Tasks launched on Fargate only support adding the `SYS_PTRACE` kernel capability.

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\"`

" }, "drop":{ "shape":"StringList", "documentation":"

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\"`

" } }, "documentation":"

The Linux capabilities for the container that are added to or dropped from the default configuration provided by Docker. For more information about the default capabilities and the non-default available capabilities, see Runtime privilege and Linux capabilities in the Docker run reference. For more detailed information about these Linux capabilities, see the capabilities(7) Linux manual page.

" }, "KeyValuePair":{ "type":"structure", "members":{ "name":{ "shape":"String", "documentation":"

The name of the key-value pair. For environment variables, this is the name of the environment variable.

" }, "value":{ "shape":"String", "documentation":"

The value of the key-value pair. For environment variables, this is the value of the environment variable.

" } }, "documentation":"

A key-value pair object.

" }, "LaunchType":{ "type":"string", "enum":[ "EC2", "FARGATE", "EXTERNAL" ] }, "LimitExceededException":{ "type":"structure", "members":{ }, "documentation":"

The limit for the resource was exceeded.

", "exception":true }, "LinuxParameters":{ "type":"structure", "members":{ "capabilities":{ "shape":"KernelCapabilities", "documentation":"

The Linux capabilities for the container that are added to or dropped from the default configuration provided by Docker.

For tasks that use the Fargate launch type, `capabilities` is supported for all platform versions but the `add` parameter is only supported if using platform version 1.4.0 or later.

" }, "devices":{ "shape":"DevicesList", "documentation":"

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're using tasks that use the Fargate launch type, the `devices` parameter isn't supported.

" }, "initProcessEnabled":{ "shape":"BoxedBoolean", "documentation":"

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}}'`

" }, "sharedMemorySize":{ "shape":"BoxedInteger", "documentation":"

The value for the size (in MiB) of the `/dev/shm` volume. This parameter maps to the `--shm-size` option to docker run.

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

" }, "tmpfs":{ "shape":"TmpfsList", "documentation":"

The container path, mount options, and size (in MiB) of the tmpfs mount. This parameter maps to the `--tmpfs` option to docker run.

If you're using tasks that use the Fargate launch type, the `tmpfs` parameter isn't supported.

" }, "maxSwap":{ "shape":"BoxedInteger", "documentation":"

The total amount of swap memory (in MiB) a container can use. This parameter will be translated to the `--memory-swap` option to docker run where the value would be the sum of the container memory plus the `maxSwap` value.

If a `maxSwap` value of `0` is specified, the container will not use swap. Accepted values are `0` or any positive integer. If the `maxSwap` parameter is omitted, the container will use the swap configuration for the container instance it is running on. A `maxSwap` value must be set for the `swappiness` parameter to be used.

If you're using tasks that use the Fargate launch type, the `maxSwap` parameter isn't supported.

If you're using tasks on Amazon Linux 2023 the `swappiness` parameter isn't supported.

" }, "swappiness":{ "shape":"BoxedInteger", "documentation":"

This allows you to tune a container's memory swappiness behavior. A `swappiness` value of `0` will cause swapping to not happen unless absolutely necessary. A `swappiness` value of `100` will cause pages to be swapped very aggressively. Accepted values are whole numbers between `0` and `100`. If the `swappiness` parameter is not specified, a default value of `60` is used. If a value is not specified for `maxSwap` then this parameter is ignored. This parameter maps to the `--memory-swappiness` option to docker run.

If you're using tasks that use the Fargate launch type, the `swappiness` parameter isn't supported.

If you're using tasks on Amazon Linux 2023 the `swappiness` parameter isn't supported.

" } }, "documentation":"

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

" }, "ListAccountSettingsRequest":{ "type":"structure", "members":{ "name":{ "shape":"SettingName", "documentation":"

The name of the account setting you want to list the settings for.

" }, "value":{ "shape":"String", "documentation":"

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

" }, "principalArn":{ "shape":"String", "documentation":"

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

Federated users assume the account setting of the root user and can't have explicit account settings set for them.

" }, "effectiveSettings":{ "shape":"Boolean", "documentation":"

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

" }, "nextToken":{ "shape":"String", "documentation":"

The `nextToken` value returned from a `ListAccountSettings` request indicating that more results are available to fulfill the request and further calls will be needed. If `maxResults` was provided, it's possible the number of results to be fewer than `maxResults`.

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.

" }, "maxResults":{ "shape":"Integer", "documentation":"

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 isn't used, then `ListAccountSettings` returns up to 10 results and a `nextToken` value if applicable.

" } } }, "ListAccountSettingsResponse":{ "type":"structure", "members":{ "settings":{ "shape":"Settings", "documentation":"

The account settings for the resource.

" }, "nextToken":{ "shape":"String", "documentation":"

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.

" } } }, "ListAttributesRequest":{ "type":"structure", "required":["targetType"], "members":{ "cluster":{ "shape":"String", "documentation":"

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.

" }, "targetType":{ "shape":"TargetType", "documentation":"

The type of the target to list attributes with.

" }, "attributeName":{ "shape":"String", "documentation":"

The name of the attribute to filter the results with.

" }, "attributeValue":{ "shape":"String", "documentation":"

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

" }, "nextToken":{ "shape":"String", "documentation":"

The `nextToken` value returned from a `ListAttributes` request indicating that more results are available to fulfill the request and further calls are needed. If `maxResults` was provided, it's possible the number of results to be fewer than `maxResults`.

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.

" }, "maxResults":{ "shape":"BoxedInteger", "documentation":"

The maximum number of cluster results that `ListAttributes` returned 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 isn't used, then `ListAttributes` returns up to 100 results and a `nextToken` value if applicable.

" } } }, "ListAttributesResponse":{ "type":"structure", "members":{ "attributes":{ "shape":"Attributes", "documentation":"

A list of attribute objects that meet the criteria of the request.

" }, "nextToken":{ "shape":"String", "documentation":"

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

" } } }, "ListClustersRequest":{ "type":"structure", "members":{ "nextToken":{ "shape":"String", "documentation":"

The `nextToken` value returned from a `ListClusters` request indicating that more results are available to fulfill the request and further calls are needed. If `maxResults` was provided, it's possible the number of results to be fewer than `maxResults`.

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.

" }, "maxResults":{ "shape":"BoxedInteger", "documentation":"

The maximum number of cluster results that `ListClusters` returned 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 isn't used, then `ListClusters` returns up to 100 results and a `nextToken` value if applicable.

" } } }, "ListClustersResponse":{ "type":"structure", "members":{ "clusterArns":{ "shape":"StringList", "documentation":"

The list of full Amazon Resource Name (ARN) entries for each cluster that's associated with your account.

" }, "nextToken":{ "shape":"String", "documentation":"

The `nextToken` value to include in a future `ListClusters` request. When the results of a `ListClusters` request exceed `maxResults`, this value can be used to retrieve the next page of results. This value is `null` when there are no more results to return.

" } } }, "ListContainerInstancesRequest":{ "type":"structure", "members":{ "cluster":{ "shape":"String", "documentation":"

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

" }, "filter":{ "shape":"String", "documentation":"

You can filter the results of a `ListContainerInstances` operation with cluster query language statements. For more information, see Cluster Query Language in the Amazon Elastic Container Service Developer Guide.

" }, "nextToken":{ "shape":"String", "documentation":"

The `nextToken` value returned from a `ListContainerInstances` request indicating that more results are available to fulfill the request and further calls are needed. If `maxResults` was provided, it's possible the number of results to be fewer than `maxResults`.

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.

" }, "maxResults":{ "shape":"BoxedInteger", "documentation":"

The maximum number of container instance results that `ListContainerInstances` returned 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 isn't used, then `ListContainerInstances` returns up to 100 results and a `nextToken` value if applicable.

" }, "status":{ "shape":"ContainerInstanceStatus", "documentation":"

Filters the container instances by status. For example, if you specify the `DRAINING` status, the results include only container instances that have been set to `DRAINING` using UpdateContainerInstancesState. If you don't specify this parameter, the default is to include container instances set to all states other than `INACTIVE`.

" } } }, "ListContainerInstancesResponse":{ "type":"structure", "members":{ "containerInstanceArns":{ "shape":"StringList", "documentation":"

The list of container instances with full ARN entries for each container instance associated with the specified cluster.

" }, "nextToken":{ "shape":"String", "documentation":"

The `nextToken` value to include in a future `ListContainerInstances` request. When the results of a `ListContainerInstances` request exceed `maxResults`, this value can be used to retrieve the next page of results. This value is `null` when there are no more results to return.

" } } }, "ListServicesByNamespaceRequest":{ "type":"structure", "required":["namespace"], "members":{ "namespace":{ "shape":"String", "documentation":"

The namespace name or full Amazon Resource Name (ARN) of the Cloud Map namespace to list the services in.

Tasks that run in a namespace can use short names to connect to services in the namespace. Tasks can connect to services across all of the clusters in the namespace. Tasks connect through a managed proxy container that collects logs and metrics for increased visibility. Only the tasks that Amazon ECS services create are supported with Service Connect. For more information, see Service Connect in the Amazon Elastic Container Service Developer Guide.

" }, "nextToken":{ "shape":"String", "documentation":"

The `nextToken` value that's returned from a `ListServicesByNamespace` request. It indicates that more results are available to fulfill the request and further calls are needed. If `maxResults` is returned, it is possible the number of results is less than `maxResults`.

" }, "maxResults":{ "shape":"BoxedInteger", "documentation":"

The maximum number of service results that `ListServicesByNamespace` returns in paginated output. When this parameter is used, `ListServicesByNamespace` 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 `ListServicesByNamespace` request with the returned `nextToken` value. This value can be between 1 and 100. If this parameter isn't used, then `ListServicesByNamespace` returns up to 10 results and a `nextToken` value if applicable.

" } } }, "ListServicesByNamespaceResponse":{ "type":"structure", "members":{ "serviceArns":{ "shape":"StringList", "documentation":"

The list of full ARN entries for each service that's associated with the specified namespace.

" }, "nextToken":{ "shape":"String", "documentation":"

The `nextToken` value to include in a future `ListServicesByNamespace` request. When the results of a `ListServicesByNamespace` request exceed `maxResults`, this value can be used to retrieve the next page of results. When there are no more results to return, this value is `null`.

" } } }, "ListServicesRequest":{ "type":"structure", "members":{ "cluster":{ "shape":"String", "documentation":"

The short name or full Amazon Resource Name (ARN) of the cluster to use when filtering the `ListServices` results. If you do not specify a cluster, the default cluster is assumed.

" }, "nextToken":{ "shape":"String", "documentation":"

The `nextToken` value returned from a `ListServices` request indicating that more results are available to fulfill the request and further calls will be needed. If `maxResults` was provided, it is possible the number of results to be fewer than `maxResults`.

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.

" }, "maxResults":{ "shape":"BoxedInteger", "documentation":"

The maximum number of service results that `ListServices` returned 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 isn't used, then `ListServices` returns up to 10 results and a `nextToken` value if applicable.

" }, "launchType":{ "shape":"LaunchType", "documentation":"

The launch type to use when filtering the `ListServices` results.

" }, "schedulingStrategy":{ "shape":"SchedulingStrategy", "documentation":"

The scheduling strategy to use when filtering the `ListServices` results.

" } } }, "ListServicesResponse":{ "type":"structure", "members":{ "serviceArns":{ "shape":"StringList", "documentation":"

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

" }, "nextToken":{ "shape":"String", "documentation":"

The `nextToken` value to include in a future `ListServices` request. When the results of a `ListServices` request exceed `maxResults`, this value can be used to retrieve the next page of results. This value is `null` when there are no more results to return.

" } } }, "ListTagsForResourceRequest":{ "type":"structure", "required":["resourceArn"], "members":{ "resourceArn":{ "shape":"String", "documentation":"

The Amazon Resource Name (ARN) that identifies the resource to list the tags for. Currently, the supported resources are Amazon ECS tasks, services, task definitions, clusters, and container instances.

" } } }, "ListTagsForResourceResponse":{ "type":"structure", "members":{ "tags":{ "shape":"Tags", "documentation":"

The tags for the resource.

" } } }, "ListTaskDefinitionFamiliesRequest":{ "type":"structure", "members":{ "familyPrefix":{ "shape":"String", "documentation":"

The `familyPrefix` is a string that's used to filter the results of `ListTaskDefinitionFamilies`. If you specify a `familyPrefix`, only task definition family names that begin with the `familyPrefix` string are returned.

" }, "status":{ "shape":"TaskDefinitionFamilyStatus", "documentation":"

The task definition family status to filter the `ListTaskDefinitionFamilies` results with. 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.

" }, "nextToken":{ "shape":"String", "documentation":"

The `nextToken` value returned from a `ListTaskDefinitionFamilies` request indicating that more results are available to fulfill the request and further calls will be needed. If `maxResults` was provided, it is possible the number of results to be fewer than `maxResults`.

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.

" }, "maxResults":{ "shape":"BoxedInteger", "documentation":"

The maximum number of task definition family results that `ListTaskDefinitionFamilies` returned 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 isn't used, then `ListTaskDefinitionFamilies` returns up to 100 results and a `nextToken` value if applicable.

" } } }, "ListTaskDefinitionFamiliesResponse":{ "type":"structure", "members":{ "families":{ "shape":"StringList", "documentation":"

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

" }, "nextToken":{ "shape":"String", "documentation":"

The `nextToken` value to include in a future `ListTaskDefinitionFamilies` request. When the results of a `ListTaskDefinitionFamilies` request exceed `maxResults`, this value can be used to retrieve the next page of results. This value is `null` when there are no more results to return.

" } } }, "ListTaskDefinitionsRequest":{ "type":"structure", "members":{ "familyPrefix":{ "shape":"String", "documentation":"

The full family name to filter the `ListTaskDefinitions` results with. Specifying a `familyPrefix` limits the listed task definitions to task definition revisions that belong to that family.

" }, "status":{ "shape":"TaskDefinitionStatus", "documentation":"

The task definition status to filter the `ListTaskDefinitions` results with. By default, only `ACTIVE` task definitions are listed. By setting this parameter to `INACTIVE`, you can view task definitions that are `INACTIVE` as long as an active task or service still references them. If you paginate the resulting output, be sure to keep the `status` value constant in each subsequent request.

" }, "sort":{ "shape":"SortOrder", "documentation":"

The order to sort the results in. 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. This is so that the newest task definitions in a family are listed first.

" }, "nextToken":{ "shape":"String", "documentation":"

The `nextToken` value returned from a `ListTaskDefinitions` request indicating that more results are available to fulfill the request and further calls will be needed. If `maxResults` was provided, it is possible the number of results to be fewer than `maxResults`.

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.

" }, "maxResults":{ "shape":"BoxedInteger", "documentation":"

The maximum number of task definition results that `ListTaskDefinitions` returned 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 isn't used, then `ListTaskDefinitions` returns up to 100 results and a `nextToken` value if applicable.

" } } }, "ListTaskDefinitionsResponse":{ "type":"structure", "members":{ "taskDefinitionArns":{ "shape":"StringList", "documentation":"

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

" }, "nextToken":{ "shape":"String", "documentation":"

The `nextToken` value to include in a future `ListTaskDefinitions` request. When the results of a `ListTaskDefinitions` request exceed `maxResults`, this value can be used to retrieve the next page of results. This value is `null` when there are no more results to return.

" } } }, "ListTasksRequest":{ "type":"structure", "members":{ "cluster":{ "shape":"String", "documentation":"

The short name or full Amazon Resource Name (ARN) of the cluster to use when filtering the `ListTasks` results. If you do not specify a cluster, the default cluster is assumed.

" }, "containerInstance":{ "shape":"String", "documentation":"

The container instance ID or full ARN of the container instance to use when filtering the `ListTasks` results. Specifying a `containerInstance` limits the results to tasks that belong to that container instance.

" }, "family":{ "shape":"String", "documentation":"

The name of the task definition family to use when filtering the `ListTasks` results. Specifying a `family` limits the results to tasks that belong to that family.

" }, "nextToken":{ "shape":"String", "documentation":"

The `nextToken` value returned from a `ListTasks` request indicating that more results are available to fulfill the request and further calls will be needed. If `maxResults` was provided, it's possible the number of results to be fewer than `maxResults`.

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.

" }, "maxResults":{ "shape":"BoxedInteger", "documentation":"

The maximum number of task results that `ListTasks` returned 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 isn't used, then `ListTasks` returns up to 100 results and a `nextToken` value if applicable.

" }, "startedBy":{ "shape":"String", "documentation":"

The `startedBy` value to filter the task results with. Specifying a `startedBy` value limits the results to tasks that were started with that value.

When you specify `startedBy` as the filter, it must be the only filter that you use.

" }, "serviceName":{ "shape":"String", "documentation":"

The name of the service to use when filtering the `ListTasks` results. Specifying a `serviceName` limits the results to tasks that belong to that service.

" }, "desiredStatus":{ "shape":"DesiredStatus", "documentation":"

The task desired status to use when filtering 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 aren't 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 doesn't 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`).

" }, "launchType":{ "shape":"LaunchType", "documentation":"

The launch type to use when filtering the `ListTasks` results.

" } } }, "ListTasksResponse":{ "type":"structure", "members":{ "taskArns":{ "shape":"StringList", "documentation":"

The list of task ARN entries for the `ListTasks` request.

" }, "nextToken":{ "shape":"String", "documentation":"

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":{ "type":"structure", "members":{ "targetGroupArn":{ "shape":"String", "documentation":"

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

A target group ARN is only specified when using an Application Load Balancer or Network Load Balancer.

For services using the `ECS` deployment controller, you can specify one or multiple target groups. For more information, see Registering multiple target groups with a service in the Amazon Elastic Container Service Developer Guide.

For services using the `CODE_DEPLOY` deployment controller, you're required to define two target groups for the load balancer. For more information, see Blue/green deployment with CodeDeploy in the Amazon Elastic Container Service Developer Guide.

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

" }, "loadBalancerName":{ "shape":"String", "documentation":"

The name of the load balancer to associate with the Amazon ECS service or task set.

If you are using an Application Load Balancer or a Network Load Balancer the load balancer name parameter should be omitted.

" }, "containerName":{ "shape":"String", "documentation":"

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

" }, "containerPort":{ "shape":"BoxedInteger", "documentation":"

The port on the container to associate with the load balancer. This port must correspond to a `containerPort` in the task definition the tasks in the service are using. For tasks that use the EC2 launch type, the container instance they're launched on must allow ingress traffic on the `hostPort` of the port mapping.

" } }, "documentation":"

The load balancer configuration to use with a service or task set.

When you add, update, or remove a load balancer configuration, Amazon ECS starts a new deployment with the updated Elastic Load Balancing configuration. This causes tasks to register to and deregister from load balancers.

We recommend that you verify this on a test environment before you update the Elastic Load Balancing configuration.

A service-linked role is required for services that use multiple target groups. For more information, see Using service-linked roles in the Amazon Elastic Container Service Developer Guide.

" }, "LoadBalancers":{ "type":"list", "member":{"shape":"LoadBalancer"} }, "LogConfiguration":{ "type":"structure", "required":["logDriver"], "members":{ "logDriver":{ "shape":"LogDriver", "documentation":"

The log driver to use for the container.

For tasks on Fargate, the supported log drivers are `awslogs`, `splunk`, and `awsfirelens`.

For tasks hosted on Amazon EC2 instances, the supported log drivers are `awslogs`, `fluentd`, `gelf`, `json-file`, `journald`, `logentries`,`syslog`, `splunk`, and `awsfirelens`.

For more information about using the `awslogs` log driver, see Using the awslogs log driver in the Amazon Elastic Container Service Developer Guide.

For more information about using the `awsfirelens` log driver, see Custom log routing in the Amazon Elastic Container Service Developer Guide.

If you have a custom driver that isn't listed, you can fork the Amazon ECS container agent project that's 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, we don't currently provide support for running modified copies of this software.

" }, "options":{ "shape":"LogConfigurationOptionsMap", "documentation":"

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}}'`

" }, "secretOptions":{ "shape":"SecretList", "documentation":"

The secrets to pass to the log configuration. For more information, see Specifying sensitive data in the Amazon Elastic Container Service Developer Guide.

" } }, "documentation":"

The log configuration for the container. This parameter maps to `LogConfig` in the Create a container section of the Docker Remote API and the `--log-driver` option to `docker run` .

By default, containers use the same logging driver that the Docker daemon uses. However, the container might use a different logging driver than the Docker daemon by specifying a log driver configuration in the container definition. For more information about the options for different supported log drivers, see Configure logging drivers in the Docker documentation.

Understand the following when specifying a log configuration for your containers.

- Amazon ECS currently supports a subset of the logging drivers available to the Docker daemon. Additional log drivers may be available in future releases of the Amazon ECS container agent.

  For tasks on Fargate, the supported log drivers are `awslogs`, `splunk`, and `awsfirelens`.

  For tasks hosted on Amazon EC2 instances, the supported log drivers are `awslogs`, `fluentd`, `gelf`, `json-file`, `journald`, `logentries`,`syslog`, `splunk`, and `awsfirelens`.

- This parameter requires version 1.18 of the Docker Remote API or greater on your container instance.

- For tasks that are hosted on Amazon EC2 instances, the Amazon ECS container agent must register the available logging drivers 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.

- For tasks that are on Fargate, because you don't have access to the underlying infrastructure your tasks are hosted on, any additional software needed must be installed outside of the task. For example, the Fluentd output aggregators or a remote host running Logstash to send Gelf logs to.

" }, "LogConfigurationOptionsMap":{ "type":"map", "key":{"shape":"String"}, "value":{"shape":"String"} }, "LogDriver":{ "type":"string", "enum":[ "json-file", "syslog", "journald", "gelf", "fluentd", "awslogs", "splunk", "awsfirelens" ] }, "Long":{"type":"long"}, "ManagedAgent":{ "type":"structure", "members":{ "lastStartedAt":{ "shape":"Timestamp", "documentation":"

The Unix timestamp for the time when the managed agent was last started.

" }, "name":{ "shape":"ManagedAgentName", "documentation":"

The name of the managed agent. When the execute command feature is turned on, the managed agent name is `ExecuteCommandAgent`.

" }, "reason":{ "shape":"String", "documentation":"

The reason for why the managed agent is in the state it is in.

" }, "lastStatus":{ "shape":"String", "documentation":"

The last known status of the managed agent.

" } }, "documentation":"

Details about the managed agent status for the container.

" }, "ManagedAgentName":{ "type":"string", "enum":["ExecuteCommandAgent"] }, "ManagedAgentStateChange":{ "type":"structure", "required":[ "containerName", "managedAgentName", "status" ], "members":{ "containerName":{ "shape":"String", "documentation":"

The name of the container that's associated with the managed agent.

" }, "managedAgentName":{ "shape":"ManagedAgentName", "documentation":"

The name of the managed agent.

" }, "status":{ "shape":"String", "documentation":"

The status of the managed agent.

" }, "reason":{ "shape":"String", "documentation":"

The reason for the status of the managed agent.

" } }, "documentation":"

An object representing a change in state for a managed agent.

" }, "ManagedAgentStateChanges":{ "type":"list", "member":{"shape":"ManagedAgentStateChange"} }, "ManagedAgents":{ "type":"list", "member":{"shape":"ManagedAgent"} }, "ManagedDraining":{ "type":"string", "enum":[ "ENABLED", "DISABLED" ] }, "ManagedScaling":{ "type":"structure", "members":{ "status":{ "shape":"ManagedScalingStatus", "documentation":"

Determines whether to use managed scaling for the capacity provider.

" }, "targetCapacity":{ "shape":"ManagedScalingTargetCapacity", "documentation":"

The target capacity utilization as a percentage for the capacity provider. The specified value must be greater than `0` and less than or equal to `100`. For example, if you want the capacity provider to maintain 10% spare capacity, then that means the utilization is 90%, so use a `targetCapacity` of `90`. The default value of `100` percent results in the Amazon EC2 instances in your Auto Scaling group being completely used.

" }, "minimumScalingStepSize":{ "shape":"ManagedScalingStepSize", "documentation":"

The minimum number of Amazon EC2 instances that Amazon ECS will scale out at one time. The scale in process is not affected by this parameter If this parameter is omitted, the default value of `1` is used.

When additional capacity is required, Amazon ECS will scale up the minimum scaling step size even if the actual demand is less than the minimum scaling step size.

If you use a capacity provider with an Auto Scaling group configured with more than one Amazon EC2 instance type or Availability Zone, Amazon ECS will scale up by the exact minimum scaling step size value and will ignore both the maximum scaling step size as well as the capacity demand.

" }, "maximumScalingStepSize":{ "shape":"ManagedScalingStepSize", "documentation":"

The maximum number of Amazon EC2 instances that Amazon ECS will scale out at one time. The scale in process is not affected by this parameter. If this parameter is omitted, the default value of `10000` is used.

" }, "instanceWarmupPeriod":{ "shape":"ManagedScalingInstanceWarmupPeriod", "documentation":"

The period of time, in seconds, after a newly launched Amazon EC2 instance can contribute to CloudWatch metrics for Auto Scaling group. If this parameter is omitted, the default value of `300` seconds is used.

" } }, "documentation":"

The managed scaling settings for the Auto Scaling group capacity provider.

When managed scaling is turned on, Amazon ECS manages the scale-in and scale-out actions of the Auto Scaling group. Amazon ECS manages a target tracking scaling policy using an Amazon ECS managed CloudWatch metric with the specified `targetCapacity` value as the target value for the metric. For more information, see Using managed scaling in the Amazon Elastic Container Service Developer Guide.

If managed scaling is off, the user must manage the scaling of the Auto Scaling group.

" }, "ManagedScalingInstanceWarmupPeriod":{ "type":"integer", "max":10000, "min":0 }, "ManagedScalingStatus":{ "type":"string", "enum":[ "ENABLED", "DISABLED" ] }, "ManagedScalingStepSize":{ "type":"integer", "max":10000, "min":1 }, "ManagedScalingTargetCapacity":{ "type":"integer", "max":100, "min":1 }, "ManagedTerminationProtection":{ "type":"string", "enum":[ "ENABLED", "DISABLED" ] }, "MissingVersionException":{ "type":"structure", "members":{ }, "documentation":"

Amazon ECS can't determine the current version of the Amazon ECS container agent on the container instance and doesn't have enough information to proceed with an update. This could be because the agent running on the container instance is a previous or custom version that doesn't use our version information.

", "exception":true }, "MountPoint":{ "type":"structure", "members":{ "sourceVolume":{ "shape":"String", "documentation":"

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

" }, "containerPath":{ "shape":"String", "documentation":"

The path on the container to mount the host volume at.

" }, "readOnly":{ "shape":"BoxedBoolean", "documentation":"

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

" } }, "documentation":"

The details for a volume mount point that's used in a container definition.

" }, "MountPointList":{ "type":"list", "member":{"shape":"MountPoint"} }, "NamespaceNotFoundException":{ "type":"structure", "members":{ }, "documentation":"

The specified namespace wasn't found.

", "exception":true }, "NetworkBinding":{ "type":"structure", "members":{ "bindIP":{ "shape":"String", "documentation":"

The IP address that the container is bound to on the container instance.

" }, "containerPort":{ "shape":"BoxedInteger", "documentation":"

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

" }, "hostPort":{ "shape":"BoxedInteger", "documentation":"

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

" }, "protocol":{ "shape":"TransportProtocol", "documentation":"

The protocol used for the network binding.

" }, "containerPortRange":{ "shape":"String", "documentation":"

The port number range on the container that's bound to the dynamically mapped host port range.

The following rules apply when you specify a `containerPortRange`:

- You must use either the `bridge` network mode or the `awsvpc` network mode.

- This parameter is available for both the EC2 and Fargate launch types.

- This parameter is available for both the Linux and Windows operating systems.

- The container instance must have at least version 1.67.0 of the container agent and at least version 1.67.0-1 of the `ecs-init` package

- You can specify a maximum of 100 port ranges per container.

- You do not specify a `hostPortRange`. The value of the `hostPortRange` is set as follows:

  - For containers in a task with the `awsvpc` network mode, the `hostPortRange` is set to the same value as the `containerPortRange`. This is a static mapping strategy.

  - For containers in a task with the `bridge` network mode, the Amazon ECS agent finds open host ports from the default ephemeral range and passes it to docker to bind them to the container ports.

- The `containerPortRange` valid values are between 1 and 65535.

- A port can only be included in one port mapping per container.

- You cannot specify overlapping port ranges.

- The first port in the range must be less than last port in the range.

- Docker recommends that you turn off the docker-proxy in the Docker daemon config file when you have a large number of ports.

  For more information, see Issue #11185 on the Github website.

  For information about how to turn off the docker-proxy in the Docker daemon config file, see Docker daemon in the Amazon ECS Developer Guide.

You can call `DescribeTasks` to view the `hostPortRange` which are the host ports that are bound to the container ports.

" }, "hostPortRange":{ "shape":"String", "documentation":"

The port number range on the host that's used with the network binding. This is assigned is assigned by Docker and delivered by the Amazon ECS agent.

" } }, "documentation":"

Details on the network bindings between a container and its host container instance. After a task reaches the `RUNNING` status, manual and automatic host and container port assignments are visible in the `networkBindings` section of DescribeTasks API responses.

" }, "NetworkBindings":{ "type":"list", "member":{"shape":"NetworkBinding"} }, "NetworkConfiguration":{ "type":"structure", "members":{ "awsvpcConfiguration":{ "shape":"AwsVpcConfiguration", "documentation":"

The VPC subnets and security groups that are associated with a task.

All specified subnets and security groups must be from the same VPC.

" } }, "documentation":"

The network configuration for a task or service.

" }, "NetworkInterface":{ "type":"structure", "members":{ "attachmentId":{ "shape":"String", "documentation":"

The attachment ID for the network interface.

" }, "privateIpv4Address":{ "shape":"String", "documentation":"

The private IPv4 address for the network interface.

" }, "ipv6Address":{ "shape":"String", "documentation":"

The private IPv6 address for the network interface.

" } }, "documentation":"

An object representing the elastic network interface for tasks that use the `awsvpc` network mode.

" }, "NetworkInterfaces":{ "type":"list", "member":{"shape":"NetworkInterface"} }, "NetworkMode":{ "type":"string", "enum":[ "bridge", "host", "awsvpc", "none" ] }, "NoUpdateAvailableException":{ "type":"structure", "members":{ }, "documentation":"

There's no update available for this Amazon ECS container agent. This might be because the agent is already running the latest version or because it's so old that there's no update path to the current version.

", "exception":true }, "OSFamily":{ "type":"string", "enum":[ "WINDOWS_SERVER_2019_FULL", "WINDOWS_SERVER_2019_CORE", "WINDOWS_SERVER_2016_FULL", "WINDOWS_SERVER_2004_CORE", "WINDOWS_SERVER_2022_CORE", "WINDOWS_SERVER_2022_FULL", "WINDOWS_SERVER_20H2_CORE", "LINUX" ] }, "PidMode":{ "type":"string", "enum":[ "host", "task" ] }, "PlacementConstraint":{ "type":"structure", "members":{ "type":{ "shape":"PlacementConstraintType", "documentation":"

The type of constraint. Use `distinctInstance` to ensure that each task in a particular group is running on a different container instance. Use `memberOf` to restrict the selection to a group of valid candidates.

" }, "expression":{ "shape":"String", "documentation":"

A cluster query language expression to apply to the constraint. The expression can have a maximum length of 2000 characters. You can't specify an expression if the constraint type is `distinctInstance`. For more information, see Cluster query language in the Amazon Elastic Container Service Developer Guide.

" } }, "documentation":"

An object representing a constraint on task placement. For more information, see Task placement constraints in the Amazon Elastic Container Service Developer Guide.

If you're using the Fargate launch type, task placement constraints aren't supported.

" }, "PlacementConstraintType":{ "type":"string", "enum":[ "distinctInstance", "memberOf" ] }, "PlacementConstraints":{ "type":"list", "member":{"shape":"PlacementConstraint"} }, "PlacementStrategies":{ "type":"list", "member":{"shape":"PlacementStrategy"} }, "PlacementStrategy":{ "type":"structure", "members":{ "type":{ "shape":"PlacementStrategyType", "documentation":"

The type of placement strategy. The `random` placement strategy randomly places tasks on available candidates. The `spread` placement strategy spreads placement across available candidates evenly based on the `field` parameter. The `binpack` strategy places tasks on available candidates that have the least available amount of the resource that's specified with the `field` parameter. For example, if you binpack on memory, a task is placed on the instance with the least amount of remaining memory but still enough to run the task.

" }, "field":{ "shape":"String", "documentation":"

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's 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.

" } }, "documentation":"

The task placement strategy for a task or service. For more information, see Task placement strategies in the Amazon Elastic Container Service Developer Guide.

" }, "PlacementStrategyType":{ "type":"string", "enum":[ "random", "spread", "binpack" ] }, "PlatformDevice":{ "type":"structure", "required":[ "id", "type" ], "members":{ "id":{ "shape":"String", "documentation":"

The ID for the GPUs on the container instance. The available GPU IDs can also be obtained on the container instance in the `/var/lib/ecs/gpu/nvidia_gpu_info.json` file.

" }, "type":{ "shape":"PlatformDeviceType", "documentation":"

The type of device that's available on the container instance. The only supported value is `GPU`.

" } }, "documentation":"

The devices that are available on the container instance. The only supported device type is a GPU.

" }, "PlatformDeviceType":{ "type":"string", "enum":["GPU"] }, "PlatformDevices":{ "type":"list", "member":{"shape":"PlatformDevice"} }, "PlatformTaskDefinitionIncompatibilityException":{ "type":"structure", "members":{ }, "documentation":"

The specified platform version doesn't satisfy the required capabilities of the task definition.

", "exception":true }, "PlatformUnknownException":{ "type":"structure", "members":{ }, "documentation":"

The specified platform version doesn't exist.

", "exception":true }, "PortMapping":{ "type":"structure", "members":{ "containerPort":{ "shape":"BoxedInteger", "documentation":"

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

If you use containers in a task with the `awsvpc` or `host` network mode, specify the exposed ports using `containerPort`.

If you use 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.

" }, "hostPort":{ "shape":"BoxedInteger", "documentation":"

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

If you specify a `containerPortRange`, leave this field empty and the value of the `hostPort` is set as follows:

- For containers in a task with the `awsvpc` network mode, the `hostPort` is set to the same value as the `containerPort`. This is a static mapping strategy.

- For containers in a task with the `bridge` network mode, the Amazon ECS agent finds open ports on the host and automatically binds them to the container ports. This is a dynamic mapping strategy.

If you use 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 use 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 (Linux) or 49152 through 65535 (Windows) 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 reserved ports are 22 for SSH, the Docker ports 2375 and 2376, and the Amazon ECS container agent ports 51678-51680. Any host port that was previously specified in a running task is also reserved while the task is running. That is, after a task stops, the host port is released. The current reserved ports are displayed in the `remainingResources` of DescribeContainerInstances output. A container instance can have up to 100 reserved ports at a time. This number includes the default reserved ports. Automatically assigned ports aren't included in the 100 reserved ports quota.

" }, "protocol":{ "shape":"TransportProtocol", "documentation":"

The protocol used for the port mapping. Valid values are `tcp` and `udp`. The default is `tcp`. `protocol` is immutable in a Service Connect service. Updating this field requires a service deletion and redeployment.

" }, "name":{ "shape":"String", "documentation":"

The name that's used for the port mapping. This parameter only applies to Service Connect. This parameter is the name that you use in the `serviceConnectConfiguration` of a service. The name can include up to 64 characters. The characters can include lowercase letters, numbers, underscores (_), and hyphens (-). The name can't start with a hyphen.

For more information, see Service Connect in the Amazon Elastic Container Service Developer Guide.

" }, "appProtocol":{ "shape":"ApplicationProtocol", "documentation":"

The application protocol that's used for the port mapping. This parameter only applies to Service Connect. We recommend that you set this parameter to be consistent with the protocol that your application uses. If you set this parameter, Amazon ECS adds protocol-specific connection handling to the Service Connect proxy. If you set this parameter, Amazon ECS adds protocol-specific telemetry in the Amazon ECS console and CloudWatch.

If you don't set a value for this parameter, then TCP is used. However, Amazon ECS doesn't add protocol-specific telemetry for TCP.

`appProtocol` is immutable in a Service Connect service. Updating this field requires a service deletion and redeployment.

Tasks that run in a namespace can use short names to connect to services in the namespace. Tasks can connect to services across all of the clusters in the namespace. Tasks connect through a managed proxy container that collects logs and metrics for increased visibility. Only the tasks that Amazon ECS services create are supported with Service Connect. For more information, see Service Connect in the Amazon Elastic Container Service Developer Guide.

" }, "containerPortRange":{ "shape":"String", "documentation":"

The port number range on the container that's bound to the dynamically mapped host port range.

The following rules apply when you specify a `containerPortRange`:

- You must use either the `bridge` network mode or the `awsvpc` network mode.

- This parameter is available for both the EC2 and Fargate launch types.

- This parameter is available for both the Linux and Windows operating systems.

- The container instance must have at least version 1.67.0 of the container agent and at least version 1.67.0-1 of the `ecs-init` package

- You can specify a maximum of 100 port ranges per container.

- You do not specify a `hostPortRange`. The value of the `hostPortRange` is set as follows:

  - For containers in a task with the `awsvpc` network mode, the `hostPortRange` is set to the same value as the `containerPortRange`. This is a static mapping strategy.

  - For containers in a task with the `bridge` network mode, the Amazon ECS agent finds open host ports from the default ephemeral range and passes it to docker to bind them to the container ports.

- The `containerPortRange` valid values are between 1 and 65535.

- A port can only be included in one port mapping per container.

- You cannot specify overlapping port ranges.

- The first port in the range must be less than last port in the range.

- Docker recommends that you turn off the docker-proxy in the Docker daemon config file when you have a large number of ports.

  For more information, see Issue #11185 on the Github website.

  For information about how to turn off the docker-proxy in the Docker daemon config file, see Docker daemon in the Amazon ECS Developer Guide.

You can call `DescribeTasks` to view the `hostPortRange` which are the host ports that are bound to the container ports.

" } }, "documentation":"

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 use containers in a task with the `awsvpc` or `host` network mode, specify the exposed ports using `containerPort`. The `hostPort` can be left blank or it must be the same value as the `containerPort`.

Most fields of this parameter (`containerPort`, `hostPort`, `protocol`) 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 `host`, host ports must either be undefined or match the container port in the port mapping.

You can't expose the same container port for multiple protocols. If you attempt this, an error is returned.

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.

" }, "PortMappingList":{ "type":"list", "member":{"shape":"PortMapping"} }, "PortNumber":{ "type":"integer", "box":true, "max":65535, "min":0 }, "PropagateTags":{ "type":"string", "enum":[ "TASK_DEFINITION", "SERVICE", "NONE" ] }, "ProtectedTask":{ "type":"structure", "members":{ "taskArn":{ "shape":"String", "documentation":"

The task ARN.

" }, "protectionEnabled":{ "shape":"Boolean", "documentation":"

The protection status of the task. If scale-in protection is on for a task, the value is `true`. Otherwise, it is `false`.

" }, "expirationDate":{ "shape":"Timestamp", "documentation":"

The epoch time when protection for the task will expire.

" } }, "documentation":"

An object representing the protection status details for a task. You can set the protection status with the UpdateTaskProtection API and get the status of tasks with the GetTaskProtection API.

" }, "ProtectedTasks":{ "type":"list", "member":{"shape":"ProtectedTask"} }, "ProxyConfiguration":{ "type":"structure", "required":["containerName"], "members":{ "type":{ "shape":"ProxyConfigurationType", "documentation":"

The proxy type. The only supported value is `APPMESH`.

" }, "containerName":{ "shape":"String", "documentation":"

The name of the container that will serve as the App Mesh proxy.

" }, "properties":{ "shape":"ProxyConfigurationProperties", "documentation":"

The set of network configuration parameters to provide the Container Network Interface (CNI) plugin, specified as key-value pairs.

- `IgnoredUID` - (Required) The user ID (UID) of the proxy container as defined by the `user` parameter in a container definition. This is used to ensure the proxy ignores its own traffic. If `IgnoredGID` is specified, this field can be empty.

- `IgnoredGID` - (Required) The group ID (GID) of the proxy container as defined by the `user` parameter in a container definition. This is used to ensure the proxy ignores its own traffic. If `IgnoredUID` is specified, this field can be empty.

- `AppPorts` - (Required) The list of ports that the application uses. Network traffic to these ports is forwarded to the `ProxyIngressPort` and `ProxyEgressPort`.

- `ProxyIngressPort` - (Required) Specifies the port that incoming traffic to the `AppPorts` is directed to.

- `ProxyEgressPort` - (Required) Specifies the port that outgoing traffic from the `AppPorts` is directed to.

- `EgressIgnoredPorts` - (Required) The egress traffic going to the specified ports is ignored and not redirected to the `ProxyEgressPort`. It can be an empty list.

- `EgressIgnoredIPs` - (Required) The egress traffic going to the specified IP addresses is ignored and not redirected to the `ProxyEgressPort`. It can be an empty list.

" } }, "documentation":"

The configuration details for the App Mesh proxy.

For tasks that use the EC2 launch type, the container instances require at least version 1.26.0 of the container agent and at least version 1.26.0-1 of the `ecs-init` package to use a proxy configuration. If your container instances are launched from the Amazon ECS optimized AMI version `20190301` or later, then they contain the required versions of the container agent and `ecs-init`. For more information, see Amazon ECS-optimized Linux AMI

" }, "ProxyConfigurationProperties":{ "type":"list", "member":{"shape":"KeyValuePair"} }, "ProxyConfigurationType":{ "type":"string", "enum":["APPMESH"] }, "PutAccountSettingDefaultRequest":{ "type":"structure", "required":[ "name", "value" ], "members":{ "name":{ "shape":"SettingName", "documentation":"

The resource name for which to modify the account setting. If you specify `serviceLongArnFormat`, the ARN for your Amazon ECS services is affected. If you specify `taskLongArnFormat`, the ARN and resource ID for your Amazon ECS tasks is affected. If you specify `containerInstanceLongArnFormat`, the ARN and resource ID for your Amazon ECS container instances is affected. If you specify `awsvpcTrunking`, the ENI limit for your Amazon ECS container instances is affected. If you specify `containerInsights`, the default setting for Amazon Web Services CloudWatch Container Insights for your clusters is affected. If you specify `tagResourceAuthorization`, the opt-in option for tagging resources on creation is affected. For information about the opt-in timeline, see Tagging authorization timeline in the Amazon ECS Developer Guide. If you specify `fargateTaskRetirementWaitPeriod`, the default wait time to retire a Fargate task due to required maintenance is affected.

When you specify `fargateFIPSMode` for the `name` and `enabled` for the `value`, Fargate uses FIPS-140 compliant cryptographic algorithms on your tasks. For more information about FIPS-140 compliance with Fargate, see Amazon Web Services Fargate Federal Information Processing Standard (FIPS) 140-2 compliance in the Amazon Elastic Container Service Developer Guide.

When Amazon Web Services determines that a security or infrastructure update is needed for an Amazon ECS task hosted on Fargate, the tasks need to be stopped and new tasks launched to replace them. Use `fargateTaskRetirementWaitPeriod` to set the wait time to retire a Fargate task to the default. For information about the Fargate tasks maintenance, see Amazon Web Services Fargate task maintenance in the Amazon ECS Developer Guide.

The `guardDutyActivate` parameter is read-only in Amazon ECS and indicates whether Amazon ECS Runtime Monitoring is enabled or disabled by your security administrator in your Amazon ECS account. Amazon GuardDuty controls this account setting on your behalf. For more information, see Protecting Amazon ECS workloads with Amazon ECS Runtime Monitoring.

" }, "value":{ "shape":"String", "documentation":"

The account setting value for the specified principal ARN. Accepted values are `enabled`, `disabled`, `on`, and `off`.

When you specify `fargateTaskRetirementWaitPeriod` for the `name`, the following are the valid values:

- `0` - Amazon Web Services sends the notification, and immediately retires the affected tasks.

- `7` - Amazon Web Services sends the notification, and waits 7 calendar days to retire the tasks.

- `14` - Amazon Web Services sends the notification, and waits 14 calendar days to retire the tasks.

" } } }, "PutAccountSettingDefaultResponse":{ "type":"structure", "members":{ "setting":{ "shape":"Setting", "documentation":"

The current setting for a resource.

" } } }, "PutAccountSettingRequest":{ "type":"structure", "required":[ "name", "value" ], "members":{ "name":{ "shape":"SettingName", "documentation":"

The Amazon ECS resource name for which to modify the account setting. If you specify `serviceLongArnFormat`, the ARN for your Amazon ECS services is affected. If you specify `taskLongArnFormat`, the ARN and resource ID for your Amazon ECS tasks is affected. If you specify `containerInstanceLongArnFormat`, the ARN and resource ID for your Amazon ECS container instances is affected. If you specify `awsvpcTrunking`, the elastic network interface (ENI) limit for your Amazon ECS container instances is affected. If you specify `containerInsights`, the default setting for Amazon Web Services CloudWatch Container Insights for your clusters is affected. If you specify `fargateFIPSMode`, Fargate FIPS 140 compliance is affected. If you specify `tagResourceAuthorization`, the opt-in option for tagging resources on creation is affected. For information about the opt-in timeline, see Tagging authorization timeline in the Amazon ECS Developer Guide. If you specify `fargateTaskRetirementWaitPeriod`, the wait time to retire a Fargate task is affected.

The `guardDutyActivate` parameter is read-only in Amazon ECS and indicates whether Amazon ECS Runtime Monitoring is enabled or disabled by your security administrator in your Amazon ECS account. Amazon GuardDuty controls this account setting on your behalf. For more information, see Protecting Amazon ECS workloads with Amazon ECS Runtime Monitoring.

" }, "value":{ "shape":"String", "documentation":"

The account setting value for the specified principal ARN. Accepted values are `enabled`, `disabled`, `on`, and `off`.

When you specify `fargateTaskRetirementWaitPeriod` for the `name`, the following are the valid values:

- `0` - Amazon Web Services sends the notification, and immediately retires the affected tasks.

- `7` - Amazon Web Services sends the notification, and waits 7 calendar days to retire the tasks.

- `14` - Amazon Web Services sends the notification, and waits 14 calendar days to retire the tasks.

" }, "principalArn":{ "shape":"String", "documentation":"

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

You must use the root user when you set the Fargate wait time (`fargateTaskRetirementWaitPeriod`).

Federated users assume the account setting of the root user and can't have explicit account settings set for them.

" } } }, "PutAccountSettingResponse":{ "type":"structure", "members":{ "setting":{ "shape":"Setting", "documentation":"

The current account setting for a resource.

" } } }, "PutAttributesRequest":{ "type":"structure", "required":["attributes"], "members":{ "cluster":{ "shape":"String", "documentation":"

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.

" }, "attributes":{ "shape":"Attributes", "documentation":"

The attributes to apply to your resource. You can specify up to 10 custom attributes for each resource. You can specify up to 10 attributes in a single call.

" } } }, "PutAttributesResponse":{ "type":"structure", "members":{ "attributes":{ "shape":"Attributes", "documentation":"

The attributes applied to your resource.

" } } }, "PutClusterCapacityProvidersRequest":{ "type":"structure", "required":[ "cluster", "capacityProviders", "defaultCapacityProviderStrategy" ], "members":{ "cluster":{ "shape":"String", "documentation":"

The short name or full Amazon Resource Name (ARN) of the cluster to modify the capacity provider settings for. If you don't specify a cluster, the default cluster is assumed.

" }, "capacityProviders":{ "shape":"StringList", "documentation":"

The name of one or more capacity providers to associate with the cluster.

If specifying a capacity provider that uses an Auto Scaling group, the capacity provider must already be created. New capacity providers can be created with the CreateCapacityProvider API operation.

To use a Fargate capacity provider, specify either the `FARGATE` or `FARGATE_SPOT` capacity providers. The Fargate capacity providers are available to all accounts and only need to be associated with a cluster to be used.

" }, "defaultCapacityProviderStrategy":{ "shape":"CapacityProviderStrategy", "documentation":"

The capacity provider strategy to use by default for the cluster.

When creating a service or running a task on a cluster, if no capacity provider or launch type is specified then the default capacity provider strategy for the cluster is used.

A capacity provider strategy consists of one or more capacity providers along with the `base` and `weight` to assign to them. A capacity provider must be associated with the cluster to be used in a capacity provider strategy. The PutClusterCapacityProviders API is used to associate a capacity provider with a cluster. Only capacity providers with an `ACTIVE` or `UPDATING` status can be used.

If specifying a capacity provider that uses an Auto Scaling group, the capacity provider must already be created. New capacity providers can be created with the CreateCapacityProvider API operation.

To use a Fargate capacity provider, specify either the `FARGATE` or `FARGATE_SPOT` capacity providers. The Fargate capacity providers are available to all accounts and only need to be associated with a cluster to be used.

" } } }, "PutClusterCapacityProvidersResponse":{ "type":"structure", "members":{ "cluster":{ "shape":"Cluster", "documentation":"

Details about the cluster.

" } } }, "RegisterContainerInstanceRequest":{ "type":"structure", "members":{ "cluster":{ "shape":"String", "documentation":"

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

" }, "instanceIdentityDocument":{ "shape":"String", "documentation":"

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/`

" }, "instanceIdentityDocumentSignature":{ "shape":"String", "documentation":"

The instance identity document signature for the EC2 instance to register. This signature can be found by running the following command from the instance: `curl http://169.254.169.254/latest/dynamic/instance-identity/signature/`

" }, "totalResources":{ "shape":"Resources", "documentation":"

The resources available on the instance.

" }, "versionInfo":{ "shape":"VersionInfo", "documentation":"

The version information for the Amazon ECS container agent and Docker daemon that runs on the container instance.

" }, "containerInstanceArn":{ "shape":"String", "documentation":"

The ARN of the container instance (if it was previously registered).

" }, "attributes":{ "shape":"Attributes", "documentation":"

The container instance attributes that this container instance supports.

" }, "platformDevices":{ "shape":"PlatformDevices", "documentation":"

The devices that are available on the container instance. The only supported device type is a GPU.

" }, "tags":{ "shape":"Tags", "documentation":"

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. You define both.

The following basic restrictions apply to tags:

- Maximum number of tags per resource - 50

- For each resource, each tag key must be unique, and each tag key can have only one value.

- Maximum key length - 128 Unicode characters in UTF-8

- Maximum value length - 256 Unicode characters in UTF-8

- If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.

- Tag keys and values are case-sensitive.

- Do not use `aws:`, `AWS:`, or any upper or lowercase combination of such as a prefix for either keys or values as it is reserved for Amazon Web Services use. You cannot edit or delete tag keys or values with this prefix. Tags with this prefix do not count against your tags per resource limit.

" } } }, "RegisterContainerInstanceResponse":{ "type":"structure", "members":{ "containerInstance":{ "shape":"ContainerInstance", "documentation":"

The container instance that was registered.

" } } }, "RegisterTaskDefinitionRequest":{ "type":"structure", "required":[ "family", "containerDefinitions" ], "members":{ "family":{ "shape":"String", "documentation":"

You must specify a `family` for a task definition. You can use it 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, underscores, and hyphens are allowed.

" }, "taskRoleArn":{ "shape":"String", "documentation":"

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.

" }, "executionRoleArn":{ "shape":"String", "documentation":"

The Amazon Resource Name (ARN) of the task execution role that grants the Amazon ECS container agent permission to make Amazon Web Services API calls on your behalf. The task execution IAM role is required depending on the requirements of your task. For more information, see Amazon ECS task execution IAM role in the Amazon Elastic Container Service Developer Guide.

" }, "networkMode":{ "shape":"NetworkMode", "documentation":"

The Docker networking mode to use for the containers in the task. The valid values are `none`, `bridge`, `awsvpc`, and `host`. If no network mode is specified, the default is `bridge`.

For Amazon ECS tasks on Fargate, the `awsvpc` network mode is required. For Amazon ECS tasks on Amazon EC2 Linux instances, any network mode can be used. For Amazon ECS tasks on Amazon EC2 Windows instances, `<default>` or `awsvpc` 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.

When using the `host` network mode, you should not run containers using the root user (UID 0). It is considered best practice to use a non-root user.

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.

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.

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

" }, "containerDefinitions":{ "shape":"ContainerDefinitions", "documentation":"

A list of container definitions in JSON format that describe the different containers that make up your task.

" }, "volumes":{ "shape":"VolumeList", "documentation":"

A list of volume definitions in JSON format that containers in your task might use.

" }, "placementConstraints":{ "shape":"TaskDefinitionPlacementConstraints", "documentation":"

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

" }, "requiresCompatibilities":{ "shape":"CompatibilityList", "documentation":"

The task launch type that Amazon ECS validates the task definition against. A client exception is returned if the task definition doesn't validate against the compatibilities specified. If no value is specified, the parameter is omitted from the response.

" }, "cpu":{ "shape":"String", "documentation":"

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're 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 do not specify a value, the parameter is ignored.

If you're 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:

The CPU units cannot be less than 1 vCPU when you use Windows containers on Fargate.

- 256 (.25 vCPU) - Available `memory` values: 512 (0.5 GB), 1024 (1 GB), 2048 (2 GB)

- 512 (.5 vCPU) - Available `memory` values: 1024 (1 GB), 2048 (2 GB), 3072 (3 GB), 4096 (4 GB)

- 1024 (1 vCPU) - Available `memory` values: 2048 (2 GB), 3072 (3 GB), 4096 (4 GB), 5120 (5 GB), 6144 (6 GB), 7168 (7 GB), 8192 (8 GB)

- 2048 (2 vCPU) - Available `memory` values: 4096 (4 GB) and 16384 (16 GB) in increments of 1024 (1 GB)

- 4096 (4 vCPU) - Available `memory` values: 8192 (8 GB) and 30720 (30 GB) in increments of 1024 (1 GB)

- 8192 (8 vCPU) - Available `memory` values: 16 GB and 60 GB in 4 GB increments

  This option requires Linux platform `1.4.0` or later.

- 16384 (16vCPU) - Available `memory` values: 32GB and 120 GB in 8 GB increments

  This option requires Linux platform `1.4.0` or later.

" }, "memory":{ "shape":"String", "documentation":"

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. This determines your range of supported values for the `cpu` parameter.

The CPU units cannot be less than 1 vCPU when you use Windows containers on Fargate.

- 512 (0.5 GB), 1024 (1 GB), 2048 (2 GB) - Available `cpu` values: 256 (.25 vCPU)

- 1024 (1 GB), 2048 (2 GB), 3072 (3 GB), 4096 (4 GB) - Available `cpu` values: 512 (.5 vCPU)

- 2048 (2 GB), 3072 (3 GB), 4096 (4 GB), 5120 (5 GB), 6144 (6 GB), 7168 (7 GB), 8192 (8 GB) - Available `cpu` values: 1024 (1 vCPU)

- Between 4096 (4 GB) and 16384 (16 GB) in increments of 1024 (1 GB) - Available `cpu` values: 2048 (2 vCPU)

- Between 8192 (8 GB) and 30720 (30 GB) in increments of 1024 (1 GB) - Available `cpu` values: 4096 (4 vCPU)

- Between 16 GB and 60 GB in 4 GB increments - Available `cpu` values: 8192 (8 vCPU)

  This option requires Linux platform `1.4.0` or later.

- Between 32GB and 120 GB in 8 GB increments - Available `cpu` values: 16384 (16 vCPU)

  This option requires Linux platform `1.4.0` or later.

" }, "tags":{ "shape":"Tags", "documentation":"

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. You define both of them.

The following basic restrictions apply to tags:

- Maximum number of tags per resource - 50

- For each resource, each tag key must be unique, and each tag key can have only one value.

- Maximum key length - 128 Unicode characters in UTF-8

- Maximum value length - 256 Unicode characters in UTF-8

- If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.

- Tag keys and values are case-sensitive.

- Do not use `aws:`, `AWS:`, or any upper or lowercase combination of such as a prefix for either keys or values as it is reserved for Amazon Web Services use. You cannot edit or delete tag keys or values with this prefix. Tags with this prefix do not count against your tags per resource limit.

" }, "pidMode":{ "shape":"PidMode", "documentation":"

The process namespace to use for the containers in the task. The valid values are `host` or `task`. On Fargate for Linux containers, the only valid value is `task`. For example, monitoring sidecars might need `pidMode` to access information about other containers running in the same task.

If `host` is specified, all containers within the tasks that specified the `host` PID mode on the same container instance share the same process namespace 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 each container. For more information, see PID settings in the Docker run reference.

If the `host` PID mode is used, there's a heightened risk of undesired process namespace exposure. For more information, see Docker security.

This parameter is not supported for Windows containers.

This parameter is only supported for tasks that are hosted on Fargate if the tasks are using platform version `1.4.0` or later (Linux). This isn't supported for Windows containers on Fargate.

" }, "ipcMode":{ "shape":"IpcMode", "documentation":"

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.

- 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 run on Fargate.

" }, "proxyConfiguration":{ "shape":"ProxyConfiguration", "documentation":"

The configuration details for the App Mesh proxy.

For tasks hosted on Amazon EC2 instances, the container instances require at least version `1.26.0` of the container agent and at least version `1.26.0-1` of the `ecs-init` package to use a proxy configuration. If your container instances are launched from the Amazon ECS-optimized AMI version `20190301` or later, then they contain the required versions of the container agent and `ecs-init`. For more information, see Amazon ECS-optimized AMI versions in the Amazon Elastic Container Service Developer Guide.

" }, "inferenceAccelerators":{ "shape":"InferenceAccelerators", "documentation":"

The Elastic Inference accelerators to use for the containers in the task.

" }, "ephemeralStorage":{ "shape":"EphemeralStorage", "documentation":"

The amount of ephemeral storage to allocate for the task. This parameter is used to expand the total amount of ephemeral storage available, beyond the default amount, for tasks hosted on Fargate. For more information, see Fargate task storage in the Amazon ECS User Guide for Fargate.

For tasks using the Fargate launch type, the task requires the following platforms:

- Linux platform version `1.4.0` or later.

- Windows platform version `1.0.0` or later.

" }, "runtimePlatform":{ "shape":"RuntimePlatform", "documentation":"

The operating system that your tasks definitions run on. A platform family is specified only for tasks using the Fargate launch type.

When you specify a task definition in a service, this value must match the `runtimePlatform` value of the service.

" } } }, "RegisterTaskDefinitionResponse":{ "type":"structure", "members":{ "taskDefinition":{ "shape":"TaskDefinition", "documentation":"

The full description of the registered task definition.

" }, "tags":{ "shape":"Tags", "documentation":"

The list of tags associated with the task definition.

" } } }, "RepositoryCredentials":{ "type":"structure", "required":["credentialsParameter"], "members":{ "credentialsParameter":{ "shape":"String", "documentation":"

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

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

" } }, "documentation":"

The repository credentials for private registry authentication.

" }, "RequiresAttributes":{ "type":"list", "member":{"shape":"Attribute"} }, "Resource":{ "type":"structure", "members":{ "name":{ "shape":"String", "documentation":"

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

" }, "type":{ "shape":"String", "documentation":"

The type of the resource. Valid values: `INTEGER`, `DOUBLE`, `LONG`, or `STRINGSET`.

" }, "doubleValue":{ "shape":"Double", "documentation":"

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

" }, "longValue":{ "shape":"Long", "documentation":"

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

" }, "integerValue":{ "shape":"Integer", "documentation":"

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

" }, "stringSetValue":{ "shape":"StringList", "documentation":"

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

" } }, "documentation":"

Describes the resources available for a container instance.

" }, "ResourceIds":{ "type":"list", "member":{"shape":"String"} }, "ResourceInUseException":{ "type":"structure", "members":{ }, "documentation":"

The specified resource is in-use and can't be removed.

", "exception":true }, "ResourceNotFoundException":{ "type":"structure", "members":{ }, "documentation":"

The specified resource wasn't found.

", "exception":true }, "ResourceRequirement":{ "type":"structure", "required":[ "value", "type" ], "members":{ "value":{ "shape":"String", "documentation":"

The value for the specified resource type.

If the `GPU` type is used, the value is the number of physical `GPUs` the Amazon ECS container agent reserves for the container. The number of GPUs that's reserved for all containers in a task can't exceed the number of available GPUs on the container instance that the task is launched on.

If the `InferenceAccelerator` type is used, the `value` matches the `deviceName` for an InferenceAccelerator specified in a task definition.

" }, "type":{ "shape":"ResourceType", "documentation":"

The type of resource to assign to a container. The supported values are `GPU` or `InferenceAccelerator`.

" } }, "documentation":"

The type and amount of a resource to assign to a container. The supported resource types are GPUs and Elastic Inference accelerators. For more information, see Working with GPUs on Amazon ECS or Working with Amazon Elastic Inference on Amazon ECS in the Amazon Elastic Container Service Developer Guide

" }, "ResourceRequirements":{ "type":"list", "member":{"shape":"ResourceRequirement"} }, "ResourceType":{ "type":"string", "enum":[ "GPU", "InferenceAccelerator" ] }, "Resources":{ "type":"list", "member":{"shape":"Resource"} }, "RunTaskRequest":{ "type":"structure", "required":["taskDefinition"], "members":{ "capacityProviderStrategy":{ "shape":"CapacityProviderStrategy", "documentation":"

The capacity provider strategy to use for the task.

If a `capacityProviderStrategy` is specified, the `launchType` parameter must be omitted. If no `capacityProviderStrategy` or `launchType` is specified, the `defaultCapacityProviderStrategy` for the cluster is used.

When you use cluster auto scaling, you must specify `capacityProviderStrategy` and not `launchType`.

A capacity provider strategy may contain a maximum of 6 capacity providers.

" }, "cluster":{ "shape":"String", "documentation":"

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

" }, "count":{ "shape":"BoxedInteger", "documentation":"

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

" }, "enableECSManagedTags":{ "shape":"Boolean", "documentation":"

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

" }, "enableExecuteCommand":{ "shape":"Boolean", "documentation":"

Determines whether to use the execute command functionality for the containers in this task. If `true`, this enables execute command functionality on all containers in the task.

If `true`, then the task definition must have a task role, or you must provide one as an override.

" }, "group":{ "shape":"String", "documentation":"

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

" }, "launchType":{ "shape":"LaunchType", "documentation":"

The infrastructure to run your standalone task on. For more information, see Amazon ECS launch types in the Amazon Elastic Container Service Developer Guide.

The `FARGATE` launch type runs your tasks on Fargate On-Demand infrastructure.

Fargate Spot infrastructure is available for use but a capacity provider strategy must be used. For more information, see Fargate capacity providers in the Amazon ECS User Guide for Fargate.

The `EC2` launch type runs your tasks on Amazon EC2 instances registered to your cluster.

The `EXTERNAL` launch type runs your tasks on your on-premises server or virtual machine (VM) capacity registered to your cluster.

A task can use either a launch type or a capacity provider strategy. If a `launchType` is specified, the `capacityProviderStrategy` parameter must be omitted.

When you use cluster auto scaling, you must specify `capacityProviderStrategy` and not `launchType`.

" }, "networkConfiguration":{ "shape":"NetworkConfiguration", "documentation":"

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 isn't supported for other network modes. For more information, see Task networking in the Amazon Elastic Container Service Developer Guide.

" }, "overrides":{ "shape":"TaskOverride", "documentation":"

A list of container overrides in JSON format that specify the name of a container in the specified task definition and the overrides it should receive. You can override the default command for a container (that's specified in the task definition or Docker image) with a `command` override. You can also override existing environment variables (that are specified in the task definition or Docker image) on a container or add new environment variables to it with an `environment` override.

A total of 8192 characters are allowed for overrides. This limit includes the JSON formatting characters of the override structure.

" }, "placementConstraints":{ "shape":"PlacementConstraints", "documentation":"

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

" }, "placementStrategy":{ "shape":"PlacementStrategies", "documentation":"

The placement strategy objects to use for the task. You can specify a maximum of 5 strategy rules for each task.

" }, "platformVersion":{ "shape":"String", "documentation":"

The platform version the task uses. A platform version is only specified for tasks hosted on Fargate. If one isn't specified, the `LATEST` platform version is used. For more information, see Fargate platform versions in the Amazon Elastic Container Service Developer Guide.

" }, "propagateTags":{ "shape":"PropagateTags", "documentation":"

Specifies whether to propagate the tags from the task definition to the task. If no value is specified, the tags aren't propagated. Tags can only be propagated to the task during task creation. To add tags to a task after task creation, use the TagResource API action.

An error will be received if you specify the `SERVICE` option when running a task.

" }, "referenceId":{ "shape":"String", "documentation":"

The reference ID to use for the task. The reference ID can have a maximum length of 1024 characters.

" }, "startedBy":{ "shape":"String", "documentation":"

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

" }, "tags":{ "shape":"Tags", "documentation":"

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.

The following basic restrictions apply to tags:

- Maximum number of tags per resource - 50

- For each resource, each tag key must be unique, and each tag key can have only one value.

- Maximum key length - 128 Unicode characters in UTF-8

- Maximum value length - 256 Unicode characters in UTF-8

- If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.

- Tag keys and values are case-sensitive.

- Do not use `aws:`, `AWS:`, or any upper or lowercase combination of such as a prefix for either keys or values as it is reserved for Amazon Web Services use. You cannot edit or delete tag keys or values with this prefix. Tags with this prefix do not count against your tags per resource limit.

" }, "taskDefinition":{ "shape":"String", "documentation":"

The `family` and `revision` (`family:revision`) or full ARN of the task definition to run. If a `revision` isn't specified, the latest `ACTIVE` revision is used.

When you create a policy for run-task, you can set the resource to be the latest task definition revision, or a specific revision.

The full ARN value must match the value that you specified as the `Resource` of the principal's permissions policy.

When you specify the policy resource as the latest task definition version (by setting the `Resource` in the policy to `arn:aws:ecs:us-east-1:111122223333:task-definition/TaskFamilyName`), then set this value to `arn:aws:ecs:us-east-1:111122223333:task-definition/TaskFamilyName`.

When you specify the policy resource as a specific task definition version (by setting the `Resource` in the policy to `arn:aws:ecs:us-east-1:111122223333:task-definition/TaskFamilyName:1` or `arn:aws:ecs:us-east-1:111122223333:task-definition/TaskFamilyName:*`), then set this value to `arn:aws:ecs:us-east-1:111122223333:task-definition/TaskFamilyName:1`.

For more information, see Policy Resources for Amazon ECS in the Amazon Elastic Container Service developer Guide.

" }, "clientToken":{ "shape":"String", "documentation":"

An identifier that you provide to ensure the idempotency of the request. It must be unique and is case sensitive. Up to 64 characters are allowed. The valid characters are characters in the range of 33-126, inclusive. For more information, see Ensuring idempotency.

", "idempotencyToken":true }, "volumeConfigurations":{ "shape":"TaskVolumeConfigurations", "documentation":"

The details of the volume that was `configuredAtLaunch`. You can configure the size, volumeType, IOPS, throughput, snapshot and encryption in in TaskManagedEBSVolumeConfiguration. The `name` of the volume must match the `name` from the task definition.

" } } }, "RunTaskResponse":{ "type":"structure", "members":{ "tasks":{ "shape":"Tasks", "documentation":"

A full description of the tasks that were run. The tasks that were successfully placed on your cluster are described here.

" }, "failures":{ "shape":"Failures", "documentation":"

Any failures associated with the call.

" } } }, "RuntimePlatform":{ "type":"structure", "members":{ "cpuArchitecture":{ "shape":"CPUArchitecture", "documentation":"

The CPU architecture.

You can run your Linux tasks on an ARM-based platform by setting the value to `ARM64`. This option is available for tasks that run on Linux Amazon EC2 instance or Linux containers on Fargate.

" }, "operatingSystemFamily":{ "shape":"OSFamily", "documentation":"

The operating system.

" } }, "documentation":"

Information about the platform for the Amazon ECS service or task.

For more information about `RuntimePlatform`, see RuntimePlatform in the Amazon Elastic Container Service Developer Guide.

" }, "Scale":{ "type":"structure", "members":{ "value":{ "shape":"Double", "documentation":"

The value, specified as a percent total of a service's `desiredCount`, to scale the task set. Accepted values are numbers between 0 and 100.

" }, "unit":{ "shape":"ScaleUnit", "documentation":"

The unit of measure for the scale value.

" } }, "documentation":"

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

" }, "ScaleUnit":{ "type":"string", "enum":["PERCENT"] }, "SchedulingStrategy":{ "type":"string", "enum":[ "REPLICA", "DAEMON" ] }, "Scope":{ "type":"string", "enum":[ "task", "shared" ] }, "Secret":{ "type":"structure", "required":[ "name", "valueFrom" ], "members":{ "name":{ "shape":"String", "documentation":"

The name of the secret.

" }, "valueFrom":{ "shape":"String", "documentation":"

The secret to expose to the container. The supported values are either the full ARN of the Secrets Manager secret or the full ARN of the parameter in the SSM Parameter Store.

For information about the require Identity and Access Management permissions, see Required IAM permissions for Amazon ECS secrets (for Secrets Manager) or Required IAM permissions for Amazon ECS secrets (for Systems Manager Parameter store) in the Amazon Elastic Container Service Developer Guide.

If the SSM Parameter Store parameter exists in the same Region as the task you're launching, then you can use either the full ARN or name of the parameter. If the parameter exists in a different Region, then the full ARN must be specified.

" } }, "documentation":"

An object representing the secret to expose to your container. Secrets can be exposed to a container in the following ways:

- To inject sensitive data into your containers as environment variables, use the `secrets` container definition parameter.

- To reference sensitive information in the log configuration of a container, use the `secretOptions` container definition parameter.

For more information, see Specifying sensitive data in the Amazon Elastic Container Service Developer Guide.

" }, "SecretList":{ "type":"list", "member":{"shape":"Secret"} }, "SensitiveString":{ "type":"string", "sensitive":true }, "ServerException":{ "type":"structure", "members":{ "message":{ "shape":"String", "documentation":"

Message that describes the cause of the exception.

" } }, "documentation":"

These errors are usually caused by a server issue.

", "exception":true, "fault":true }, "Service":{ "type":"structure", "members":{ "serviceArn":{ "shape":"String", "documentation":"

The ARN that identifies the service. For more information about the ARN format, see Amazon Resource Name (ARN) in the Amazon ECS Developer Guide.

" }, "serviceName":{ "shape":"String", "documentation":"

The name of your service. Up to 255 letters (uppercase and lowercase), numbers, underscores, and hyphens are allowed. Service names must be unique within a cluster. However, you can have similarly named services in multiple clusters within a Region or across multiple Regions.

" }, "clusterArn":{ "shape":"String", "documentation":"

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

" }, "loadBalancers":{ "shape":"LoadBalancers", "documentation":"

A list of Elastic Load Balancing load balancer objects. It contains the load balancer name, the container name, and the container port to access from the load balancer. The container name is as it appears in a container definition.

" }, "serviceRegistries":{ "shape":"ServiceRegistries", "documentation":"

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

" }, "status":{ "shape":"String", "documentation":"

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

" }, "desiredCount":{ "shape":"Integer", "documentation":"

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.

" }, "runningCount":{ "shape":"Integer", "documentation":"

The number of tasks in the cluster that are in the `RUNNING` state.

" }, "pendingCount":{ "shape":"Integer", "documentation":"

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

" }, "launchType":{ "shape":"LaunchType", "documentation":"

The launch type the service is using. When using the DescribeServices API, this field is omitted if the service was created using a capacity provider strategy.

" }, "capacityProviderStrategy":{ "shape":"CapacityProviderStrategy", "documentation":"

The capacity provider strategy the service uses. When using the DescribeServices API, this field is omitted if the service was created using a launch type.

" }, "platformVersion":{ "shape":"String", "documentation":"

The platform version to run your service on. A platform version is only specified for tasks that are hosted on Fargate. If one isn't specified, the `LATEST` platform version is used. For more information, see Fargate Platform Versions in the Amazon Elastic Container Service Developer Guide.

" }, "platformFamily":{ "shape":"String", "documentation":"

The operating system that your tasks in the service run on. A platform family is specified only for tasks using the Fargate launch type.

All tasks that run as part of this service must use the same `platformFamily` value as the service (for example, `LINUX`).

" }, "taskDefinition":{ "shape":"String", "documentation":"

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.

" }, "deploymentConfiguration":{ "shape":"DeploymentConfiguration", "documentation":"

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

" }, "taskSets":{ "shape":"TaskSets", "documentation":"

Information about a set of Amazon ECS tasks in either an CodeDeploy or an `EXTERNAL` 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.

" }, "deployments":{ "shape":"Deployments", "documentation":"

The current state of deployments for the service.

" }, "roleArn":{ "shape":"String", "documentation":"

The ARN of the IAM role that's associated with the service. It allows the Amazon ECS container agent to register container instances with an Elastic Load Balancing load balancer.

" }, "events":{ "shape":"ServiceEvents", "documentation":"

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

" }, "createdAt":{ "shape":"Timestamp", "documentation":"

The Unix timestamp for the time when the service was created.

" }, "placementConstraints":{ "shape":"PlacementConstraints", "documentation":"

The placement constraints for the tasks in the service.

" }, "placementStrategy":{ "shape":"PlacementStrategies", "documentation":"

The placement strategy that determines how tasks for the service are placed.

" }, "networkConfiguration":{ "shape":"NetworkConfiguration", "documentation":"

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

" }, "healthCheckGracePeriodSeconds":{ "shape":"BoxedInteger", "documentation":"

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.

" }, "schedulingStrategy":{ "shape":"SchedulingStrategy", "documentation":"

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

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.

- `DAEMON`-The daemon scheduling strategy deploys exactly one task on each active container instance. This task meets all of the task placement constraints that you specify in your cluster. The service scheduler also evaluates the task placement constraints for running tasks. It stop tasks that don't meet the placement constraints.

  Fargate tasks don't support the `DAEMON` scheduling strategy.

" }, "deploymentController":{ "shape":"DeploymentController", "documentation":"

The deployment controller type the service is using.

" }, "tags":{ "shape":"Tags", "documentation":"

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. You define bot the key and value.

The following basic restrictions apply to tags:

- Maximum number of tags per resource - 50

- For each resource, each tag key must be unique, and each tag key can have only one value.

- Maximum key length - 128 Unicode characters in UTF-8

- Maximum value length - 256 Unicode characters in UTF-8

- If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.

- Tag keys and values are case-sensitive.

- Do not use `aws:`, `AWS:`, or any upper or lowercase combination of such as a prefix for either keys or values as it is reserved for Amazon Web Services use. You cannot edit or delete tag keys or values with this prefix. Tags with this prefix do not count against your tags per resource limit.

" }, "createdBy":{ "shape":"String", "documentation":"

The principal that created the service.

" }, "enableECSManagedTags":{ "shape":"Boolean", "documentation":"

Determines whether to use 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.

" }, "propagateTags":{ "shape":"PropagateTags", "documentation":"

Determines whether to propagate the tags from the task definition or the service to the task. If no value is specified, the tags aren't propagated.

" }, "enableExecuteCommand":{ "shape":"Boolean", "documentation":"

Determines whether the execute command functionality is turned on for the service. If `true`, the execute command functionality is turned on for all containers in tasks as part of the service.

" } }, "documentation":"

Details on a service within a cluster.

" }, "ServiceConnectClientAlias":{ "type":"structure", "required":["port"], "members":{ "port":{ "shape":"PortNumber", "documentation":"

The listening port number for the Service Connect proxy. This port is available inside of all of the tasks within the same namespace.

To avoid changing your applications in client Amazon ECS services, set this to the same port that the client application uses by default. For more information, see Service Connect in the Amazon Elastic Container Service Developer Guide.

" }, "dnsName":{ "shape":"String", "documentation":"

The `dnsName` is the name that you use in the applications of client tasks to connect to this service. The name must be a valid DNS name but doesn't need to be fully-qualified. The name can include up to 127 characters. The name can include lowercase letters, numbers, underscores (_), hyphens (-), and periods (.). The name can't start with a hyphen.

If this parameter isn't specified, the default value of `discoveryName.namespace` is used. If the `discoveryName` isn't specified, the port mapping name from the task definition is used in `portName.namespace`.

To avoid changing your applications in client Amazon ECS services, set this to the same name that the client application uses by default. For example, a few common names are `database`, `db`, or the lowercase name of a database, such as `mysql` or `redis`. For more information, see Service Connect in the Amazon Elastic Container Service Developer Guide.

" } }, "documentation":"

Each alias (\"endpoint\") is a fully-qualified name and port number that other tasks (\"clients\") can use to connect to this service.

Each name and port mapping must be unique within the namespace.

Tasks that run in a namespace can use short names to connect to services in the namespace. Tasks can connect to services across all of the clusters in the namespace. Tasks connect through a managed proxy container that collects logs and metrics for increased visibility. Only the tasks that Amazon ECS services create are supported with Service Connect. For more information, see Service Connect in the Amazon Elastic Container Service Developer Guide.

" }, "ServiceConnectClientAliasList":{ "type":"list", "member":{"shape":"ServiceConnectClientAlias"} }, "ServiceConnectConfiguration":{ "type":"structure", "required":["enabled"], "members":{ "enabled":{ "shape":"Boolean", "documentation":"

Specifies whether to use Service Connect with this service.

" }, "namespace":{ "shape":"String", "documentation":"

The namespace name or full Amazon Resource Name (ARN) of the Cloud Map namespace for use with Service Connect. The namespace must be in the same Amazon Web Services Region as the Amazon ECS service and cluster. The type of namespace doesn't affect Service Connect. For more information about Cloud Map, see Working with Services in the Cloud Map Developer Guide.

" }, "services":{ "shape":"ServiceConnectServiceList", "documentation":"

The list of Service Connect service objects. These are names and aliases (also known as endpoints) that are used by other Amazon ECS services to connect to this service.

This field is not required for a \"client\" Amazon ECS service that's a member of a namespace only to connect to other services within the namespace. An example of this would be a frontend application that accepts incoming requests from either a load balancer that's attached to the service or by other means.

An object selects a port from the task definition, assigns a name for the Cloud Map service, and a list of aliases (endpoints) and ports for client applications to refer to this service.

" }, "logConfiguration":{"shape":"LogConfiguration"} }, "documentation":"

The Service Connect configuration of your Amazon ECS service. The configuration for this service to discover and connect to services, and be discovered by, and connected from, other services within a namespace.

Tasks that run in a namespace can use short names to connect to services in the namespace. Tasks can connect to services across all of the clusters in the namespace. Tasks connect through a managed proxy container that collects logs and metrics for increased visibility. Only the tasks that Amazon ECS services create are supported with Service Connect. For more information, see Service Connect in the Amazon Elastic Container Service Developer Guide.

" }, "ServiceConnectService":{ "type":"structure", "required":["portName"], "members":{ "portName":{ "shape":"String", "documentation":"

The `portName` must match the name of one of the `portMappings` from all the containers in the task definition of this Amazon ECS service.

" }, "discoveryName":{ "shape":"String", "documentation":"

The `discoveryName` is the name of the new Cloud Map service that Amazon ECS creates for this Amazon ECS service. This must be unique within the Cloud Map namespace. The name can contain up to 64 characters. The name can include lowercase letters, numbers, underscores (_), and hyphens (-). The name can't start with a hyphen.

If the `discoveryName` isn't specified, the port mapping name from the task definition is used in `portName.namespace`.

" }, "clientAliases":{ "shape":"ServiceConnectClientAliasList", "documentation":"

The list of client aliases for this Service Connect service. You use these to assign names that can be used by client applications. The maximum number of client aliases that you can have in this list is 1.

Each alias (\"endpoint\") is a fully-qualified name and port number that other Amazon ECS tasks (\"clients\") can use to connect to this service.

Each name and port mapping must be unique within the namespace.

For each `ServiceConnectService`, you must provide at least one `clientAlias` with one `port`.

" }, "ingressPortOverride":{ "shape":"PortNumber", "documentation":"

The port number for the Service Connect proxy to listen on.

Use the value of this field to bypass the proxy for traffic on the port number specified in the named `portMapping` in the task definition of this application, and then use it in your VPC security groups to allow traffic into the proxy for this Amazon ECS service.

In `awsvpc` mode and Fargate, the default value is the container port number. The container port number is in the `portMapping` in the task definition. In bridge mode, the default value is the ephemeral port of the Service Connect proxy.

" } }, "documentation":"

The Service Connect service object configuration. For more information, see Service Connect in the Amazon Elastic Container Service Developer Guide.

" }, "ServiceConnectServiceList":{ "type":"list", "member":{"shape":"ServiceConnectService"} }, "ServiceConnectServiceResource":{ "type":"structure", "members":{ "discoveryName":{ "shape":"String", "documentation":"

The discovery name of this Service Connect resource.

The `discoveryName` is the name of the new Cloud Map service that Amazon ECS creates for this Amazon ECS service. This must be unique within the Cloud Map namespace. The name can contain up to 64 characters. The name can include lowercase letters, numbers, underscores (_), and hyphens (-). The name can't start with a hyphen.

If the `discoveryName` isn't specified, the port mapping name from the task definition is used in `portName.namespace`.

" }, "discoveryArn":{ "shape":"String", "documentation":"

The Amazon Resource Name (ARN) for the namespace in Cloud Map that matches the discovery name for this Service Connect resource. You can use this ARN in other integrations with Cloud Map. However, Service Connect can't ensure connectivity outside of Amazon ECS.

" } }, "documentation":"

The Service Connect resource. Each configuration maps a discovery name to a Cloud Map service name. The data is stored in Cloud Map as part of the Service Connect configuration for each discovery name of this Amazon ECS service.

A task can resolve the `dnsName` for each of the `clientAliases` of a service. However a task can't resolve the discovery names. If you want to connect to a service, refer to the `ServiceConnectConfiguration` of that service for the list of `clientAliases` that you can use.

" }, "ServiceConnectServiceResourceList":{ "type":"list", "member":{"shape":"ServiceConnectServiceResource"} }, "ServiceEvent":{ "type":"structure", "members":{ "id":{ "shape":"String", "documentation":"

The ID string for the event.

" }, "createdAt":{ "shape":"Timestamp", "documentation":"

The Unix timestamp for the time when the event was triggered.

" }, "message":{ "shape":"String", "documentation":"

The event message.

" } }, "documentation":"

The details for an event that's associated with a service.

" }, "ServiceEvents":{ "type":"list", "member":{"shape":"ServiceEvent"} }, "ServiceField":{ "type":"string", "enum":["TAGS"] }, "ServiceFieldList":{ "type":"list", "member":{"shape":"ServiceField"} }, "ServiceManagedEBSVolumeConfiguration":{ "type":"structure", "required":["roleArn"], "members":{ "encrypted":{ "shape":"BoxedBoolean", "documentation":"

Indicates whether the volume should be encrypted. If no value is specified, encryption is turned on by default. This parameter maps 1:1 with the `Encrypted` parameter of the CreateVolume API in the Amazon EC2 API Reference.

" }, "kmsKeyId":{ "shape":"EBSKMSKeyId", "documentation":"

The Amazon Resource Name (ARN) identifier of the Amazon Web Services Key Management Service key to use for Amazon EBS encryption. When encryption is turned on and no Amazon Web Services Key Management Service key is specified, the default Amazon Web Services managed key for Amazon EBS volumes is used. This parameter maps 1:1 with the `KmsKeyId` parameter of the CreateVolume API in the Amazon EC2 API Reference.

Amazon Web Services authenticates the Amazon Web Services Key Management Service key asynchronously. Therefore, if you specify an ID, alias, or ARN that is invalid, the action can appear to complete, but eventually fails.

" }, "volumeType":{ "shape":"EBSVolumeType", "documentation":"

The volume type. This parameter maps 1:1 with the `VolumeType` parameter of the CreateVolume API in the Amazon EC2 API Reference. For more information, see Amazon EBS volume types in the Amazon EC2 User Guide.

The following are the supported volume types.

- General Purpose SSD: `gp2`|`gp3`

- Provisioned IOPS SSD: `io1`|`io2`

- Throughput Optimized HDD: `st1`

- Cold HDD: `sc1`

- Magnetic: `standard`

  The magnetic volume type is not supported on Fargate.

" }, "sizeInGiB":{ "shape":"BoxedInteger", "documentation":"

The size of the volume in GiB. You must specify either a volume size or a snapshot ID. If you specify a snapshot ID, the snapshot size is used for the volume size by default. You can optionally specify a volume size greater than or equal to the snapshot size. This parameter maps 1:1 with the `Size` parameter of the CreateVolume API in the Amazon EC2 API Reference.

The following are the supported volume size values for each volume type.

- `gp2` and `gp3`: 1-16,384

- `io1` and `io2`: 4-16,384

- `st1` and `sc1`: 125-16,384

- `standard`: 1-1,024

" }, "snapshotId":{ "shape":"EBSSnapshotId", "documentation":"

The snapshot that Amazon ECS uses to create the volume. You must specify either a snapshot ID or a volume size. This parameter maps 1:1 with the `SnapshotId` parameter of the CreateVolume API in the Amazon EC2 API Reference.

" }, "iops":{ "shape":"BoxedInteger", "documentation":"

The number of I/O operations per second (IOPS). For `gp3`, `io1`, and `io2` volumes, this represents the number of IOPS that are provisioned for the volume. For `gp2` volumes, this represents the baseline performance of the volume and the rate at which the volume accumulates I/O credits for bursting.

The following are the supported values for each volume type.

- `gp3`: 3,000 - 16,000 IOPS

- `io1`: 100 - 64,000 IOPS

- `io2`: 100 - 256,000 IOPS

This parameter is required for `io1` and `io2` volume types. The default for `gp3` volumes is `3,000 IOPS`. This parameter is not supported for `st1`, `sc1`, or `standard` volume types.

This parameter maps 1:1 with the `Iops` parameter of the CreateVolume API in the Amazon EC2 API Reference.

" }, "throughput":{ "shape":"BoxedInteger", "documentation":"

The throughput to provision for a volume, in MiB/s, with a maximum of 1,000 MiB/s. This parameter maps 1:1 with the `Throughput` parameter of the CreateVolume API in the Amazon EC2 API Reference.

This parameter is only supported for the `gp3` volume type.

" }, "tagSpecifications":{ "shape":"EBSTagSpecifications", "documentation":"

The tags to apply to the volume. Amazon ECS applies service-managed tags by default. This parameter maps 1:1 with the `TagSpecifications.N` parameter of the CreateVolume API in the Amazon EC2 API Reference.

" }, "roleArn":{ "shape":"IAMRoleArn", "documentation":"

The ARN of the IAM role to associate with this volume. This is the Amazon ECS infrastructure IAM role that is used to manage your Amazon Web Services infrastructure. We recommend using the Amazon ECS-managed `AmazonECSInfrastructureRolePolicyForVolumes` IAM policy with this role. For more information, see Amazon ECS infrastructure IAM role in the Amazon ECS Developer Guide.

" }, "filesystemType":{ "shape":"TaskFilesystemType", "documentation":"

The Linux filesystem type for the volume. For volumes created from a snapshot, you must specify the same filesystem type that the volume was using when the snapshot was created. If there is a filesystem type mismatch, the task will fail to start.

The available filesystem types are `ext3`, `ext4`, and `xfs`. If no value is specified, the `xfs` filesystem type is used by default.

" } }, "documentation":"

The configuration for the Amazon EBS volume that Amazon ECS creates and manages on your behalf. These settings are used to create each Amazon EBS volume, with one volume created for each task in the service.

Many of these parameters map 1:1 with the Amazon EBS `CreateVolume` API request parameters.

" }, "ServiceNotActiveException":{ "type":"structure", "members":{ }, "documentation":"

The specified service isn't active. You can't update a service that's inactive. If you have previously deleted a service, you can re-create it with CreateService.

", "exception":true }, "ServiceNotFoundException":{ "type":"structure", "members":{ }, "documentation":"

The specified service wasn't found. You can view your available services with ListServices. Amazon ECS services are cluster specific and Region specific.

", "exception":true }, "ServiceRegistries":{ "type":"list", "member":{"shape":"ServiceRegistry"} }, "ServiceRegistry":{ "type":"structure", "members":{ "registryArn":{ "shape":"String", "documentation":"

The Amazon Resource Name (ARN) of the service registry. The currently supported service registry is Cloud Map. For more information, see CreateService.

" }, "port":{ "shape":"BoxedInteger", "documentation":"

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

" }, "containerName":{ "shape":"String", "documentation":"

The container name value to be used for your service discovery service. It's already specified in the task definition. 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. However, you can't specify both.

" }, "containerPort":{ "shape":"BoxedInteger", "documentation":"

The port value to be used for your service discovery service. It's already specified in the task definition. 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. However, you can't specify both.

" } }, "documentation":"

The details for the service registry.

Each service may be associated with one service registry. Multiple service registries for each service are not supported.

When you add, update, or remove the service registries configuration, Amazon ECS starts a new deployment. New tasks are registered and deregistered to the updated service registry configuration.

" }, "ServiceVolumeConfiguration":{ "type":"structure", "required":["name"], "members":{ "name":{ "shape":"ECSVolumeName", "documentation":"

The name of the volume. This value must match the volume name from the `Volume` object in the task definition.

" }, "managedEBSVolume":{ "shape":"ServiceManagedEBSVolumeConfiguration", "documentation":"

The configuration for the Amazon EBS volume that Amazon ECS creates and manages on your behalf. These settings are used to create each Amazon EBS volume, with one volume created for each task in the service. The Amazon EBS volumes are visible in your account in the Amazon EC2 console once they are created.

" } }, "documentation":"

The configuration for a volume specified in the task definition as a volume that is configured at launch time. Currently, the only supported volume type is an Amazon EBS volume.

" }, "ServiceVolumeConfigurations":{ "type":"list", "member":{"shape":"ServiceVolumeConfiguration"} }, "Services":{ "type":"list", "member":{"shape":"Service"} }, "Session":{ "type":"structure", "members":{ "sessionId":{ "shape":"String", "documentation":"

The ID of the execute command session.

" }, "streamUrl":{ "shape":"String", "documentation":"

A URL to the managed agent on the container that the SSM Session Manager client uses to send commands and receive output from the container.

" }, "tokenValue":{ "shape":"SensitiveString", "documentation":"

An encrypted token value containing session and caller information. It's used to authenticate the connection to the container.

" } }, "documentation":"

The details for the execute command session.

" }, "Setting":{ "type":"structure", "members":{ "name":{ "shape":"SettingName", "documentation":"

The Amazon ECS resource name.

" }, "value":{ "shape":"String", "documentation":"

Determines whether the account setting is on or off for the specified resource.

" }, "principalArn":{ "shape":"String", "documentation":"

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

" }, "type":{ "shape":"SettingType", "documentation":"

Indicates whether Amazon Web Services manages the account setting, or if the user manages it.

`aws_managed` account settings are read-only, as Amazon Web Services manages such on the customer's behalf. Currently, the `guardDutyActivate` account setting is the only one Amazon Web Services manages.

" } }, "documentation":"

The current account setting for a resource.

" }, "SettingName":{ "type":"string", "enum":[ "serviceLongArnFormat", "taskLongArnFormat", "containerInstanceLongArnFormat", "awsvpcTrunking", "containerInsights", "fargateFIPSMode", "tagResourceAuthorization", "fargateTaskRetirementWaitPeriod", "guardDutyActivate" ] }, "SettingType":{ "type":"string", "enum":[ "user", "aws_managed" ] }, "Settings":{ "type":"list", "member":{"shape":"Setting"} }, "SortOrder":{ "type":"string", "enum":[ "ASC", "DESC" ] }, "StabilityStatus":{ "type":"string", "enum":[ "STEADY_STATE", "STABILIZING" ] }, "StartTaskRequest":{ "type":"structure", "required":[ "containerInstances", "taskDefinition" ], "members":{ "cluster":{ "shape":"String", "documentation":"

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

" }, "containerInstances":{ "shape":"StringList", "documentation":"

The container instance IDs or full ARN entries for the container instances where you would like to place your task. You can specify up to 10 container instances.

" }, "enableECSManagedTags":{ "shape":"Boolean", "documentation":"

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

" }, "enableExecuteCommand":{ "shape":"Boolean", "documentation":"

Whether or not the execute command functionality is turned on for the task. If `true`, this turns on the execute command functionality on all containers in the task.

" }, "group":{ "shape":"String", "documentation":"

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

" }, "networkConfiguration":{ "shape":"NetworkConfiguration", "documentation":"

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

" }, "overrides":{ "shape":"TaskOverride", "documentation":"

A list of container overrides in JSON format that specify the name of a container in the specified task definition and the overrides it receives. You can override the default command for a container (that's specified in the task definition or Docker image) with a `command` override. You can also override existing environment variables (that are specified in the task definition or Docker image) on a container or add new environment variables to it with an `environment` override.

A total of 8192 characters are allowed for overrides. This limit includes the JSON formatting characters of the override structure.

" }, "propagateTags":{ "shape":"PropagateTags", "documentation":"

Specifies whether to propagate the tags from the task definition or the service to the task. If no value is specified, the tags aren't propagated.

" }, "referenceId":{ "shape":"String", "documentation":"

The reference ID to use for the task.

" }, "startedBy":{ "shape":"String", "documentation":"

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, the `startedBy` parameter contains the deployment ID of the service that starts it.

" }, "tags":{ "shape":"Tags", "documentation":"

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.

The following basic restrictions apply to tags:

- Maximum number of tags per resource - 50

- For each resource, each tag key must be unique, and each tag key can have only one value.

- Maximum key length - 128 Unicode characters in UTF-8

- Maximum value length - 256 Unicode characters in UTF-8

- If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.

- Tag keys and values are case-sensitive.

- Do not use `aws:`, `AWS:`, or any upper or lowercase combination of such as a prefix for either keys or values as it is reserved for Amazon Web Services use. You cannot edit or delete tag keys or values with this prefix. Tags with this prefix do not count against your tags per resource limit.

" }, "taskDefinition":{ "shape":"String", "documentation":"

The `family` and `revision` (`family:revision`) or full ARN of the task definition to start. If a `revision` isn't specified, the latest `ACTIVE` revision is used.

" }, "volumeConfigurations":{ "shape":"TaskVolumeConfigurations", "documentation":"

The details of the volume that was `configuredAtLaunch`. You can configure the size, volumeType, IOPS, throughput, snapshot and encryption in TaskManagedEBSVolumeConfiguration. The `name` of the volume must match the `name` from the task definition.

" } } }, "StartTaskResponse":{ "type":"structure", "members":{ "tasks":{ "shape":"Tasks", "documentation":"

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

" }, "failures":{ "shape":"Failures", "documentation":"

Any failures associated with the call.

" } } }, "Statistics":{ "type":"list", "member":{"shape":"KeyValuePair"} }, "StopTaskRequest":{ "type":"structure", "required":["task"], "members":{ "cluster":{ "shape":"String", "documentation":"

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.

" }, "task":{ "shape":"String", "documentation":"

The task ID of the task to stop.

" }, "reason":{ "shape":"String", "documentation":"

An optional message specified when a task is stopped. For example, if you're 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.

" } } }, "StopTaskResponse":{ "type":"structure", "members":{ "task":{ "shape":"Task", "documentation":"

The task that was stopped.

" } } }, "String":{"type":"string"}, "StringList":{ "type":"list", "member":{"shape":"String"} }, "StringMap":{ "type":"map", "key":{"shape":"String"}, "value":{"shape":"String"} }, "SubmitAttachmentStateChangesRequest":{ "type":"structure", "required":["attachments"], "members":{ "cluster":{ "shape":"String", "documentation":"

The short name or full ARN of the cluster that hosts the container instance the attachment belongs to.

" }, "attachments":{ "shape":"AttachmentStateChanges", "documentation":"

Any attachments associated with the state change request.

" } } }, "SubmitAttachmentStateChangesResponse":{ "type":"structure", "members":{ "acknowledgment":{ "shape":"String", "documentation":"

Acknowledgement of the state change.

" } } }, "SubmitContainerStateChangeRequest":{ "type":"structure", "members":{ "cluster":{ "shape":"String", "documentation":"

The short name or full ARN of the cluster that hosts the container.

" }, "task":{ "shape":"String", "documentation":"

The task ID or full Amazon Resource Name (ARN) of the task that hosts the container.

" }, "containerName":{ "shape":"String", "documentation":"

The name of the container.

" }, "runtimeId":{ "shape":"String", "documentation":"

The ID of the Docker container.

" }, "status":{ "shape":"String", "documentation":"

The status of the state change request.

" }, "exitCode":{ "shape":"BoxedInteger", "documentation":"

The exit code that's returned for the state change request.

" }, "reason":{ "shape":"String", "documentation":"

The reason for the state change request.

" }, "networkBindings":{ "shape":"NetworkBindings", "documentation":"

The network bindings of the container.

" } } }, "SubmitContainerStateChangeResponse":{ "type":"structure", "members":{ "acknowledgment":{ "shape":"String", "documentation":"

Acknowledgement of the state change.

" } } }, "SubmitTaskStateChangeRequest":{ "type":"structure", "members":{ "cluster":{ "shape":"String", "documentation":"

The short name or full Amazon Resource Name (ARN) of the cluster that hosts the task.

" }, "task":{ "shape":"String", "documentation":"

The task ID or full ARN of the task in the state change request.

" }, "status":{ "shape":"String", "documentation":"

The status of the state change request.

" }, "reason":{ "shape":"String", "documentation":"

The reason for the state change request.

" }, "containers":{ "shape":"ContainerStateChanges", "documentation":"

Any containers that's associated with the state change request.

" }, "attachments":{ "shape":"AttachmentStateChanges", "documentation":"

Any attachments associated with the state change request.

" }, "managedAgents":{ "shape":"ManagedAgentStateChanges", "documentation":"

The details for the managed agent that's associated with the task.

" }, "pullStartedAt":{ "shape":"Timestamp", "documentation":"

The Unix timestamp for the time when the container image pull started.

" }, "pullStoppedAt":{ "shape":"Timestamp", "documentation":"

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

" }, "executionStoppedAt":{ "shape":"Timestamp", "documentation":"

The Unix timestamp for the time when the task execution stopped.

" } } }, "SubmitTaskStateChangeResponse":{ "type":"structure", "members":{ "acknowledgment":{ "shape":"String", "documentation":"

Acknowledgement of the state change.

" } } }, "SystemControl":{ "type":"structure", "members":{ "namespace":{ "shape":"String", "documentation":"

The namespaced kernel parameter to set a `value` for.

" }, "value":{ "shape":"String", "documentation":"

The namespaced kernel parameter to set a `value` for.

Valid IPC namespace values: `\"kernel.msgmax\" | \"kernel.msgmnb\" | \"kernel.msgmni\" | \"kernel.sem\" | \"kernel.shmall\" | \"kernel.shmmax\" | \"kernel.shmmni\" | \"kernel.shm_rmid_forced\"`, and `Sysctls` that start with `\"fs.mqueue.*\"`

Valid network namespace values: `Sysctls` that start with `\"net.*\"`

All of these values are supported by Fargate.

" } }, "documentation":"

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.

We don't recommend that you specify network-related `systemControls` parameters for multiple containers in a single task. This task also uses either the `awsvpc` or `host` network mode. It does it 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's 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 and that of all containers of any tasks running on that container instance.

" }, "SystemControls":{ "type":"list", "member":{"shape":"SystemControl"} }, "Tag":{ "type":"structure", "members":{ "key":{ "shape":"TagKey", "documentation":"

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.

" }, "value":{ "shape":"TagValue", "documentation":"

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

" } }, "documentation":"

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. You define them.

The following basic restrictions apply to tags:

- Maximum number of tags per resource - 50

- For each resource, each tag key must be unique, and each tag key can have only one value.

- Maximum key length - 128 Unicode characters in UTF-8

- Maximum value length - 256 Unicode characters in UTF-8

- If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.

- Tag keys and values are case-sensitive.

- Do not use `aws:`, `AWS:`, or any upper or lowercase combination of such as a prefix for either keys or values as it is reserved for Amazon Web Services use. You cannot edit or delete tag keys or values with this prefix. Tags with this prefix do not count against your tags per resource limit.

" }, "TagKey":{ "type":"string", "max":128, "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", "documentation":"

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

" }, "tags":{ "shape":"Tags", "documentation":"

The tags to add to the resource. A tag is an array of key-value pairs.

The following basic restrictions apply to tags:

- Maximum number of tags per resource - 50

- For each resource, each tag key must be unique, and each tag key can have only one value.

- Maximum key length - 128 Unicode characters in UTF-8

- Maximum value length - 256 Unicode characters in UTF-8

- If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.

- Tag keys and values are case-sensitive.

- Do not use `aws:`, `AWS:`, or any upper or lowercase combination of such as a prefix for either keys or values as it is reserved for Amazon Web Services use. You cannot edit or delete tag keys or values with this prefix. Tags with this prefix do not count against your tags per resource limit.

" } } }, "TagResourceResponse":{ "type":"structure", "members":{ } }, "TagValue":{ "type":"string", "max":256, "min":0, "pattern":"^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$" }, "Tags":{ "type":"list", "member":{"shape":"Tag"}, "max":50, "min":0 }, "TargetNotConnectedException":{ "type":"structure", "members":{ }, "documentation":"

The execute command cannot run. This error can be caused by any of the following configuration issues:

- Incorrect IAM permissions

- The SSM agent is not installed or is not running

- There is an interface Amazon VPC endpoint for Amazon ECS, but there is not one for Systems Manager Session Manager

For information about how to troubleshoot the issues, see Troubleshooting issues with ECS Exec in the Amazon Elastic Container Service Developer Guide.

", "exception":true }, "TargetNotFoundException":{ "type":"structure", "members":{ }, "documentation":"

The specified target wasn't found. You can view your available container instances with ListContainerInstances. Amazon ECS container instances are cluster-specific and Region-specific.

", "exception":true }, "TargetType":{ "type":"string", "enum":["container-instance"] }, "Task":{ "type":"structure", "members":{ "attachments":{ "shape":"Attachments", "documentation":"

The Elastic Network Adapter that's associated with the task if the task uses the `awsvpc` network mode.

" }, "attributes":{ "shape":"Attributes", "documentation":"

The attributes of the task

" }, "availabilityZone":{ "shape":"String", "documentation":"

The Availability Zone for the task.

" }, "capacityProviderName":{ "shape":"String", "documentation":"

The capacity provider that's associated with the task.

" }, "clusterArn":{ "shape":"String", "documentation":"

The ARN of the cluster that hosts the task.

" }, "connectivity":{ "shape":"Connectivity", "documentation":"

The connectivity status of a task.

" }, "connectivityAt":{ "shape":"Timestamp", "documentation":"

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

" }, "containerInstanceArn":{ "shape":"String", "documentation":"

The ARN of the container instances that host the task.

" }, "containers":{ "shape":"Containers", "documentation":"

The containers that's associated with the task.

" }, "cpu":{ "shape":"String", "documentation":"

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 that indicates the CPU units when the task definition is registered.

If you use 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 use the Fargate launch type, this field is required. You must use one of the following values. These values determine the range of supported values for the `memory` parameter:

The CPU units cannot be less than 1 vCPU when you use Windows containers on Fargate.

- 256 (.25 vCPU) - Available `memory` values: 512 (0.5 GB), 1024 (1 GB), 2048 (2 GB)

- 512 (.5 vCPU) - Available `memory` values: 1024 (1 GB), 2048 (2 GB), 3072 (3 GB), 4096 (4 GB)

- 1024 (1 vCPU) - Available `memory` values: 2048 (2 GB), 3072 (3 GB), 4096 (4 GB), 5120 (5 GB), 6144 (6 GB), 7168 (7 GB), 8192 (8 GB)

- 2048 (2 vCPU) - Available `memory` values: 4096 (4 GB) and 16384 (16 GB) in increments of 1024 (1 GB)

- 4096 (4 vCPU) - Available `memory` values: 8192 (8 GB) and 30720 (30 GB) in increments of 1024 (1 GB)

- 8192 (8 vCPU) - Available `memory` values: 16 GB and 60 GB in 4 GB increments

  This option requires Linux platform `1.4.0` or later.

- 16384 (16vCPU) - Available `memory` values: 32GB and 120 GB in 8 GB increments

  This option requires Linux platform `1.4.0` or later.

" }, "createdAt":{ "shape":"Timestamp", "documentation":"

The Unix timestamp for the time when the task was created. More specifically, it's for the time when the task entered the `PENDING` state.

" }, "desiredStatus":{ "shape":"String", "documentation":"

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

" }, "enableExecuteCommand":{ "shape":"Boolean", "documentation":"

Determines whether execute command functionality is turned on for this task. If `true`, execute command functionality is turned on all the containers in the task.

" }, "executionStoppedAt":{ "shape":"Timestamp", "documentation":"

The Unix timestamp for the time when the task execution stopped.

" }, "group":{ "shape":"String", "documentation":"

The name of the task group that's associated with the task.

" }, "healthStatus":{ "shape":"HealthStatus", "documentation":"

The health status for the task. It's determined by the health of the essential containers in the task. If all essential containers in the task are reporting as `HEALTHY`, the task status also reports as `HEALTHY`. If any essential containers in the task are reporting as `UNHEALTHY` or `UNKNOWN`, the task status also reports as `UNHEALTHY` or `UNKNOWN`.

The Amazon ECS container agent doesn't monitor or report on Docker health checks that are embedded in a container image and not specified in the container definition. For example, this includes those specified in a parent image or from the image's Dockerfile. Health check parameters that are specified in a container definition override any Docker health checks that are found in the container image.

" }, "inferenceAccelerators":{ "shape":"InferenceAccelerators", "documentation":"

The Elastic Inference accelerator that's associated with the task.

" }, "lastStatus":{ "shape":"String", "documentation":"

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

" }, "launchType":{ "shape":"LaunchType", "documentation":"

The infrastructure where your task runs on. For more information, see Amazon ECS launch types in the Amazon Elastic Container Service Developer Guide.

" }, "memory":{ "shape":"String", "documentation":"

The amount of memory (in MiB) that the task uses as expressed in a task definition. It can be expressed as an integer using MiB (for example, `1024`). If it's expressed as a string using GB (for example, `1GB` or `1 GB`), it's converted to an integer indicating the MiB when the task definition is registered.

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

If you use the Fargate launch type, this field is required. You must use one of the following values. The value that you choose determines the range of supported values for the `cpu` parameter.

- 512 (0.5 GB), 1024 (1 GB), 2048 (2 GB) - Available `cpu` values: 256 (.25 vCPU)

- 1024 (1 GB), 2048 (2 GB), 3072 (3 GB), 4096 (4 GB) - Available `cpu` values: 512 (.5 vCPU)

- 2048 (2 GB), 3072 (3 GB), 4096 (4 GB), 5120 (5 GB), 6144 (6 GB), 7168 (7 GB), 8192 (8 GB) - Available `cpu` values: 1024 (1 vCPU)

- Between 4096 (4 GB) and 16384 (16 GB) in increments of 1024 (1 GB) - Available `cpu` values: 2048 (2 vCPU)

- Between 8192 (8 GB) and 30720 (30 GB) in increments of 1024 (1 GB) - Available `cpu` values: 4096 (4 vCPU)

- Between 16 GB and 60 GB in 4 GB increments - Available `cpu` values: 8192 (8 vCPU)

  This option requires Linux platform `1.4.0` or later.

- Between 32GB and 120 GB in 8 GB increments - Available `cpu` values: 16384 (16 vCPU)

  This option requires Linux platform `1.4.0` or later.

" }, "overrides":{ "shape":"TaskOverride", "documentation":"

One or more container overrides.

" }, "platformVersion":{ "shape":"String", "documentation":"

The platform version where your task runs on. A platform version is only specified for tasks that use the Fargate launch type. If you didn't specify one, the `LATEST` platform version is used. For more information, see Fargate Platform Versions in the Amazon Elastic Container Service Developer Guide.

" }, "platformFamily":{ "shape":"String", "documentation":"

The operating system that your tasks are running on. A platform family is specified only for tasks that use the Fargate launch type.

All tasks that run as part of this service must use the same `platformFamily` value as the service (for example, `LINUX.`).

" }, "pullStartedAt":{ "shape":"Timestamp", "documentation":"

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

" }, "pullStoppedAt":{ "shape":"Timestamp", "documentation":"

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

" }, "startedAt":{ "shape":"Timestamp", "documentation":"

The Unix timestamp for the time when the task started. More specifically, it's for the time when the task transitioned from the `PENDING` state to the `RUNNING` state.

" }, "startedBy":{ "shape":"String", "documentation":"

The tag specified when a task is started. If an Amazon ECS service started the task, the `startedBy` parameter contains the deployment ID of that service.

" }, "stopCode":{ "shape":"TaskStopCode", "documentation":"

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

For more information about stop code, see Stopped tasks error codes in the Amazon ECS User Guide.

The following are valid values:

- `TaskFailedToStart`

- `EssentialContainerExited`

- `UserInitiated`

- `TerminationNotice`

- `ServiceSchedulerInitiated`

- `SpotInterruption`

" }, "stoppedAt":{ "shape":"Timestamp", "documentation":"

The Unix timestamp for the time when the task was stopped. More specifically, it's for the time when the task transitioned from the `RUNNING` state to the `STOPPED` state.

" }, "stoppedReason":{ "shape":"String", "documentation":"

The reason that the task was stopped.

" }, "stoppingAt":{ "shape":"Timestamp", "documentation":"

The Unix timestamp for the time when the task stops. More specifically, it's for the time when the task transitions from the `RUNNING` state to `STOPPING`.

" }, "tags":{ "shape":"Tags", "documentation":"

The metadata that you apply to the task to help you categorize and organize the task. Each tag consists of a key and an optional value. You define both the key and value.

The following basic restrictions apply to tags:

- Maximum number of tags per resource - 50

- For each resource, each tag key must be unique, and each tag key can have only one value.

- Maximum key length - 128 Unicode characters in UTF-8

- Maximum value length - 256 Unicode characters in UTF-8

- If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.

- Tag keys and values are case-sensitive.

- Do not use `aws:`, `AWS:`, or any upper or lowercase combination of such as a prefix for either keys or values as it is reserved for Amazon Web Services use. You cannot edit or delete tag keys or values with this prefix. Tags with this prefix do not count against your tags per resource limit.

" }, "taskArn":{ "shape":"String", "documentation":"

The Amazon Resource Name (ARN) of the task.

" }, "taskDefinitionArn":{ "shape":"String", "documentation":"

The ARN of the task definition that creates the task.

" }, "version":{ "shape":"Long", "documentation":"

The version counter for the task. Every time a task experiences a change that starts a CloudWatch event, the version counter is incremented. If you replicate your Amazon ECS task state with CloudWatch Events, you can compare the version of a task reported by the Amazon ECS API actions 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.

" }, "ephemeralStorage":{ "shape":"EphemeralStorage", "documentation":"

The ephemeral storage settings for the task.

" } }, "documentation":"

Details on a task in a cluster.

" }, "TaskDefinition":{ "type":"structure", "members":{ "taskDefinitionArn":{ "shape":"String", "documentation":"

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

" }, "containerDefinitions":{ "shape":"ContainerDefinitions", "documentation":"

A list of container definitions in JSON format that describe the different containers that make up your task. For more information about container definition parameters and defaults, see Amazon ECS Task Definitions in the Amazon Elastic Container Service Developer Guide.

" }, "family":{ "shape":"String", "documentation":"

The name of a family that this task definition is registered to. Up to 255 characters are allowed. Letters (both uppercase and lowercase letters), numbers, hyphens (-), and underscores (_) are allowed.

A family groups multiple versions of a task definition. Amazon ECS gives the first task definition that you registered to a family a revision number of 1. Amazon ECS gives sequential revision numbers to each task definition that you add.

" }, "taskRoleArn":{ "shape":"String", "documentation":"

The short name or full Amazon Resource Name (ARN) of the Identity and Access Management role that grants containers in the task permission to call Amazon Web Services APIs on your behalf. For more information, see Amazon ECS Task Role in the Amazon Elastic Container Service Developer Guide.

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 to use the feature. For more information, see Windows IAM roles for tasks in the Amazon Elastic Container Service Developer Guide.

" }, "executionRoleArn":{ "shape":"String", "documentation":"

The Amazon Resource Name (ARN) of the task execution role that grants the Amazon ECS container agent permission to make Amazon Web Services API calls on your behalf. The task execution IAM role is required depending on the requirements of your task. For more information, see Amazon ECS task execution IAM role in the Amazon Elastic Container Service Developer Guide.

" }, "networkMode":{ "shape":"NetworkMode", "documentation":"

The Docker networking mode to use for the containers in the task. The valid values are `none`, `bridge`, `awsvpc`, and `host`. If no network mode is specified, the default is `bridge`.

For Amazon ECS tasks on Fargate, the `awsvpc` network mode is required. For Amazon ECS tasks on Amazon EC2 Linux instances, any network mode can be used. For Amazon ECS tasks on Amazon EC2 Windows instances, `<default>` or `awsvpc` 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.

When using the `host` network mode, you should not run containers using the root user (UID 0). It is considered best practice to use a non-root user.

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.

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.

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

" }, "revision":{ "shape":"Integer", "documentation":"

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. This is even if you deregistered previous revisions in this family.

" }, "volumes":{ "shape":"VolumeList", "documentation":"

The list of data volume definitions for the task. For more information, see Using data volumes in tasks in the Amazon Elastic Container Service Developer Guide.

The `host` and `sourcePath` parameters aren't supported for tasks run on Fargate.

" }, "status":{ "shape":"TaskDefinitionStatus", "documentation":"

The status of the task definition.

" }, "requiresAttributes":{ "shape":"RequiresAttributes", "documentation":"

The container instance attributes required by your task. When an Amazon EC2 instance is registered to your cluster, the Amazon ECS container agent assigns some standard attributes to the instance. You can apply custom attributes. These are specified as key-value pairs using the Amazon ECS console or the PutAttributes API. These attributes are used when determining task placement for tasks hosted on Amazon EC2 instances. For more information, see Attributes in the Amazon Elastic Container Service Developer Guide.

This parameter isn't supported for tasks run on Fargate.

" }, "placementConstraints":{ "shape":"TaskDefinitionPlacementConstraints", "documentation":"

An array of placement constraint objects to use for tasks.

This parameter isn't supported for tasks run on Fargate.

" }, "compatibilities":{ "shape":"CompatibilityList", "documentation":"

The task launch types the task definition validated against during task definition registration. For more information, see Amazon ECS launch types in the Amazon Elastic Container Service Developer Guide.

" }, "runtimePlatform":{ "shape":"RuntimePlatform", "documentation":"

The operating system that your task definitions are running on. A platform family is specified only for tasks using the Fargate launch type.

When you specify a task in a service, this value must match the `runtimePlatform` value of the service.

" }, "requiresCompatibilities":{ "shape":"CompatibilityList", "documentation":"

The task launch types the task definition was validated against. The valid values are `EC2`, `FARGATE`, and `EXTERNAL`. For more information, see Amazon ECS launch types in the Amazon Elastic Container Service Developer Guide.

" }, "cpu":{ "shape":"String", "documentation":"

The number of `cpu` units used by the task. If you use the EC2 launch type, this field is optional. Any value can be used. If you use the Fargate launch type, this field is required. You must use one of the following values. The value that you choose determines your range of valid values for the `memory` parameter.

The CPU units cannot be less than 1 vCPU when you use Windows containers on Fargate.

- 256 (.25 vCPU) - Available `memory` values: 512 (0.5 GB), 1024 (1 GB), 2048 (2 GB)

- 512 (.5 vCPU) - Available `memory` values: 1024 (1 GB), 2048 (2 GB), 3072 (3 GB), 4096 (4 GB)

- 1024 (1 vCPU) - Available `memory` values: 2048 (2 GB), 3072 (3 GB), 4096 (4 GB), 5120 (5 GB), 6144 (6 GB), 7168 (7 GB), 8192 (8 GB)

- 2048 (2 vCPU) - Available `memory` values: 4096 (4 GB) and 16384 (16 GB) in increments of 1024 (1 GB)

- 4096 (4 vCPU) - Available `memory` values: 8192 (8 GB) and 30720 (30 GB) in increments of 1024 (1 GB)

- 8192 (8 vCPU) - Available `memory` values: 16 GB and 60 GB in 4 GB increments

  This option requires Linux platform `1.4.0` or later.

- 16384 (16vCPU) - Available `memory` values: 32GB and 120 GB in 8 GB increments

  This option requires Linux platform `1.4.0` or later.

" }, "memory":{ "shape":"String", "documentation":"

The amount (in MiB) of memory used by the task.

If your tasks runs on Amazon EC2 instances, you must specify either a task-level memory value or a container-level memory value. This field is optional and any value can be used. If a task-level memory value is specified, the container-level memory value is optional. For more information regarding container-level memory and memory reservation, see ContainerDefinition.

If your tasks runs on Fargate, this field is required. You must use one of the following values. The value you choose determines your range of valid values for the `cpu` parameter.

- 512 (0.5 GB), 1024 (1 GB), 2048 (2 GB) - Available `cpu` values: 256 (.25 vCPU)

- 1024 (1 GB), 2048 (2 GB), 3072 (3 GB), 4096 (4 GB) - Available `cpu` values: 512 (.5 vCPU)

- 2048 (2 GB), 3072 (3 GB), 4096 (4 GB), 5120 (5 GB), 6144 (6 GB), 7168 (7 GB), 8192 (8 GB) - Available `cpu` values: 1024 (1 vCPU)

- Between 4096 (4 GB) and 16384 (16 GB) in increments of 1024 (1 GB) - Available `cpu` values: 2048 (2 vCPU)

- Between 8192 (8 GB) and 30720 (30 GB) in increments of 1024 (1 GB) - Available `cpu` values: 4096 (4 vCPU)

- Between 16 GB and 60 GB in 4 GB increments - Available `cpu` values: 8192 (8 vCPU)

  This option requires Linux platform `1.4.0` or later.

- Between 32GB and 120 GB in 8 GB increments - Available `cpu` values: 16384 (16 vCPU)

  This option requires Linux platform `1.4.0` or later.

" }, "inferenceAccelerators":{ "shape":"InferenceAccelerators", "documentation":"

The Elastic Inference accelerator that's associated with the task.

" }, "pidMode":{ "shape":"PidMode", "documentation":"

The process namespace to use for the containers in the task. The valid values are `host` or `task`. On Fargate for Linux containers, the only valid value is `task`. For example, monitoring sidecars might need `pidMode` to access information about other containers running in the same task.

If `host` is specified, all containers within the tasks that specified the `host` PID mode on the same container instance share the same process namespace 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 each container. For more information, see PID settings in the Docker run reference.

If the `host` PID mode is used, there's a heightened risk of undesired process namespace exposure. For more information, see Docker security.

This parameter is not supported for Windows containers.

This parameter is only supported for tasks that are hosted on Fargate if the tasks are using platform version `1.4.0` or later (Linux). This isn't supported for Windows containers on Fargate.

" }, "ipcMode":{ "shape":"IpcMode", "documentation":"

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.

- 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 run on Fargate.

" }, "proxyConfiguration":{ "shape":"ProxyConfiguration", "documentation":"

The configuration details for the App Mesh proxy.

Your Amazon ECS container instances require at least version 1.26.0 of the container agent and at least version 1.26.0-1 of the `ecs-init` package to use a proxy configuration. If your container instances are launched from the Amazon ECS optimized AMI version `20190301` or later, they contain the required versions of the container agent and `ecs-init`. For more information, see Amazon ECS-optimized Linux AMI in the Amazon Elastic Container Service Developer Guide.

" }, "registeredAt":{ "shape":"Timestamp", "documentation":"

The Unix timestamp for the time when the task definition was registered.

" }, "deregisteredAt":{ "shape":"Timestamp", "documentation":"

The Unix timestamp for the time when the task definition was deregistered.

" }, "registeredBy":{ "shape":"String", "documentation":"

The principal that registered the task definition.

" }, "ephemeralStorage":{ "shape":"EphemeralStorage", "documentation":"

The ephemeral storage settings to use for tasks run with the task definition.

" } }, "documentation":"

The details of a task definition which describes the container and volume definitions of an Amazon Elastic Container Service task. You can specify which Docker images to use, the required resources, and other configurations related to launching the task definition through an Amazon ECS service or task.

" }, "TaskDefinitionFamilyStatus":{ "type":"string", "enum":[ "ACTIVE", "INACTIVE", "ALL" ] }, "TaskDefinitionField":{ "type":"string", "enum":["TAGS"] }, "TaskDefinitionFieldList":{ "type":"list", "member":{"shape":"TaskDefinitionField"} }, "TaskDefinitionList":{ "type":"list", "member":{"shape":"TaskDefinition"} }, "TaskDefinitionPlacementConstraint":{ "type":"structure", "members":{ "type":{ "shape":"TaskDefinitionPlacementConstraintType", "documentation":"

The type of constraint. The `MemberOf` constraint restricts selection to be from a group of valid candidates.

" }, "expression":{ "shape":"String", "documentation":"

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.

" } }, "documentation":"

The constraint on task placement in the task definition. For more information, see Task placement constraints in the Amazon Elastic Container Service Developer Guide.

Task placement constraints aren't supported for tasks run on Fargate.

" }, "TaskDefinitionPlacementConstraintType":{ "type":"string", "enum":["memberOf"] }, "TaskDefinitionPlacementConstraints":{ "type":"list", "member":{"shape":"TaskDefinitionPlacementConstraint"} }, "TaskDefinitionStatus":{ "type":"string", "enum":[ "ACTIVE", "INACTIVE", "DELETE_IN_PROGRESS" ] }, "TaskField":{ "type":"string", "enum":["TAGS"] }, "TaskFieldList":{ "type":"list", "member":{"shape":"TaskField"} }, "TaskFilesystemType":{ "type":"string", "enum":[ "ext3", "ext4", "xfs" ] }, "TaskManagedEBSVolumeConfiguration":{ "type":"structure", "required":["roleArn"], "members":{ "encrypted":{ "shape":"BoxedBoolean", "documentation":"

Indicates whether the volume should be encrypted. If no value is specified, encryption is turned on by default. This parameter maps 1:1 with the `Encrypted` parameter of the CreateVolume API in the Amazon EC2 API Reference.

" }, "kmsKeyId":{ "shape":"EBSKMSKeyId", "documentation":"

The Amazon Resource Name (ARN) identifier of the Amazon Web Services Key Management Service key to use for Amazon EBS encryption. When encryption is turned on and no Amazon Web Services Key Management Service key is specified, the default Amazon Web Services managed key for Amazon EBS volumes is used. This parameter maps 1:1 with the `KmsKeyId` parameter of the CreateVolume API in the Amazon EC2 API Reference.

Amazon Web Services authenticates the Amazon Web Services Key Management Service key asynchronously. Therefore, if you specify an ID, alias, or ARN that is invalid, the action can appear to complete, but eventually fails.

" }, "volumeType":{ "shape":"EBSVolumeType", "documentation":"

The volume type. This parameter maps 1:1 with the `VolumeType` parameter of the CreateVolume API in the Amazon EC2 API Reference. For more information, see Amazon EBS volume types in the Amazon EC2 User Guide.

The following are the supported volume types.

- General Purpose SSD: `gp2`|`gp3`

- Provisioned IOPS SSD: `io1`|`io2`

- Throughput Optimized HDD: `st1`

- Cold HDD: `sc1`

- Magnetic: `standard`

  The magnetic volume type is not supported on Fargate.

" }, "sizeInGiB":{ "shape":"BoxedInteger", "documentation":"

The size of the volume in GiB. You must specify either a volume size or a snapshot ID. If you specify a snapshot ID, the snapshot size is used for the volume size by default. You can optionally specify a volume size greater than or equal to the snapshot size. This parameter maps 1:1 with the `Size` parameter of the CreateVolume API in the Amazon EC2 API Reference.

The following are the supported volume size values for each volume type.

- `gp2` and `gp3`: 1-16,384

- `io1` and `io2`: 4-16,384

- `st1` and `sc1`: 125-16,384

- `standard`: 1-1,024

" }, "snapshotId":{ "shape":"EBSSnapshotId", "documentation":"

The snapshot that Amazon ECS uses to create the volume. You must specify either a snapshot ID or a volume size. This parameter maps 1:1 with the `SnapshotId` parameter of the CreateVolume API in the Amazon EC2 API Reference.

" }, "iops":{ "shape":"BoxedInteger", "documentation":"

The number of I/O operations per second (IOPS). For `gp3`, `io1`, and `io2` volumes, this represents the number of IOPS that are provisioned for the volume. For `gp2` volumes, this represents the baseline performance of the volume and the rate at which the volume accumulates I/O credits for bursting.

The following are the supported values for each volume type.

- `gp3`: 3,000 - 16,000 IOPS

- `io1`: 100 - 64,000 IOPS

- `io2`: 100 - 256,000 IOPS

This parameter is required for `io1` and `io2` volume types. The default for `gp3` volumes is `3,000 IOPS`. This parameter is not supported for `st1`, `sc1`, or `standard` volume types.

This parameter maps 1:1 with the `Iops` parameter of the CreateVolume API in the Amazon EC2 API Reference.

" }, "throughput":{ "shape":"BoxedInteger", "documentation":"

The throughput to provision for a volume, in MiB/s, with a maximum of 1,000 MiB/s. This parameter maps 1:1 with the `Throughput` parameter of the CreateVolume API in the Amazon EC2 API Reference.

This parameter is only supported for the `gp3` volume type.

" }, "tagSpecifications":{ "shape":"EBSTagSpecifications", "documentation":"

The tags to apply to the volume. Amazon ECS applies service-managed tags by default. This parameter maps 1:1 with the `TagSpecifications.N` parameter of the CreateVolume API in the Amazon EC2 API Reference.

" }, "roleArn":{ "shape":"IAMRoleArn", "documentation":"

The ARN of the IAM role to associate with this volume. This is the Amazon ECS infrastructure IAM role that is used to manage your Amazon Web Services infrastructure. We recommend using the Amazon ECS-managed `AmazonECSInfrastructureRolePolicyForVolumes` IAM policy with this role. For more information, see Amazon ECS infrastructure IAM role in the Amazon ECS Developer Guide.

" }, "terminationPolicy":{ "shape":"TaskManagedEBSVolumeTerminationPolicy", "documentation":"

The termination policy for the volume when the task exits. This provides a way to control whether Amazon ECS terminates the Amazon EBS volume when the task stops.

" }, "filesystemType":{ "shape":"TaskFilesystemType", "documentation":"

The Linux filesystem type for the volume. For volumes created from a snapshot, you must specify the same filesystem type that the volume was using when the snapshot was created. If there is a filesystem type mismatch, the task will fail to start.

The available filesystem types are `ext3`, `ext4`, and `xfs`. If no value is specified, the `xfs` filesystem type is used by default.

" } }, "documentation":"

The configuration for the Amazon EBS volume that Amazon ECS creates and manages on your behalf. These settings are used to create each Amazon EBS volume, with one volume created for each task.

" }, "TaskManagedEBSVolumeTerminationPolicy":{ "type":"structure", "required":["deleteOnTermination"], "members":{ "deleteOnTermination":{ "shape":"BoxedBoolean", "documentation":"

Indicates whether the volume should be deleted on when the task stops. If a value of `true` is specified,  Amazon ECS deletes the Amazon EBS volume on your behalf when the task goes into the `STOPPED` state. If no value is specified, the  default value is `true` is used. When set to `false`, Amazon ECS leaves the volume in your  account.

" } }, "documentation":"

The termination policy for the Amazon EBS volume when the task exits. For more information, see Amazon ECS volume termination policy.

" }, "TaskOverride":{ "type":"structure", "members":{ "containerOverrides":{ "shape":"ContainerOverrides", "documentation":"

One or more container overrides that are sent to a task.

" }, "cpu":{ "shape":"String", "documentation":"

The CPU override for the task.

" }, "inferenceAcceleratorOverrides":{ "shape":"InferenceAcceleratorOverrides", "documentation":"

The Elastic Inference accelerator override for the task.

" }, "executionRoleArn":{ "shape":"String", "documentation":"

The Amazon Resource Name (ARN) of the task execution role override for the task. For more information, see Amazon ECS task execution IAM role in the Amazon Elastic Container Service Developer Guide.

" }, "memory":{ "shape":"String", "documentation":"

The memory override for the task.

" }, "taskRoleArn":{ "shape":"String", "documentation":"

The Amazon Resource Name (ARN) of the 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 Role for Tasks in the Amazon Elastic Container Service Developer Guide.

" }, "ephemeralStorage":{ "shape":"EphemeralStorage", "documentation":"

The ephemeral storage setting override for the task.

This parameter is only supported for tasks hosted on Fargate that use the following platform versions:

- Linux platform version `1.4.0` or later.

- Windows platform version `1.0.0` or later.

" } }, "documentation":"

The overrides that are associated with a task.

" }, "TaskSet":{ "type":"structure", "members":{ "id":{ "shape":"String", "documentation":"

The ID of the task set.

" }, "taskSetArn":{ "shape":"String", "documentation":"

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

" }, "serviceArn":{ "shape":"String", "documentation":"

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

" }, "clusterArn":{ "shape":"String", "documentation":"

The Amazon Resource Name (ARN) of the cluster that the service that hosts the task set exists in.

" }, "startedBy":{ "shape":"String", "documentation":"

The tag specified when a task set is started. If an CodeDeploy deployment created the task set, the `startedBy` parameter is `CODE_DEPLOY`. If an external deployment created the task set, the `startedBy` field isn't used.

" }, "externalId":{ "shape":"String", "documentation":"

The external ID associated with the task set.

If an CodeDeploy deployment created a task set, the `externalId` parameter contains the CodeDeploy deployment ID.

If a task set is created for an external deployment and is associated with a service discovery registry, the `externalId` parameter contains the `ECS_TASK_SET_EXTERNAL_ID` Cloud Map attribute.

" }, "status":{ "shape":"String", "documentation":"

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

PRIMARY

  The task set is serving production traffic.

ACTIVE

  The task set isn't serving production traffic.

DRAINING

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

" }, "taskDefinition":{ "shape":"String", "documentation":"

The task definition that the task set is using.

" }, "computedDesiredCount":{ "shape":"Integer", "documentation":"

The computed desired count for the task set. This is calculated by multiplying the service's `desiredCount` by the task set's `scale` percentage. The result is always rounded up. For example, if the computed desired count is 1.2, it rounds up to 2 tasks.

" }, "pendingCount":{ "shape":"Integer", "documentation":"

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's restarted after being in the `STOPPED` state.

" }, "runningCount":{ "shape":"Integer", "documentation":"

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.

" }, "createdAt":{ "shape":"Timestamp", "documentation":"

The Unix timestamp for the time when the task set was created.

" }, "updatedAt":{ "shape":"Timestamp", "documentation":"

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

" }, "launchType":{ "shape":"LaunchType", "documentation":"

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.

" }, "capacityProviderStrategy":{ "shape":"CapacityProviderStrategy", "documentation":"

The capacity provider strategy that are associated with the task set.

" }, "platformVersion":{ "shape":"String", "documentation":"

The Fargate platform version where the tasks in the task set are running. A platform version is only specified for tasks run on Fargate. For more information, see Fargate platform versions in the Amazon Elastic Container Service Developer Guide.

" }, "platformFamily":{ "shape":"String", "documentation":"

The operating system that your tasks in the set are running on. A platform family is specified only for tasks that use the Fargate launch type.

All tasks in the set must have the same value.

" }, "networkConfiguration":{ "shape":"NetworkConfiguration", "documentation":"

The network configuration for the task set.

" }, "loadBalancers":{ "shape":"LoadBalancers", "documentation":"

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

" }, "serviceRegistries":{ "shape":"ServiceRegistries", "documentation":"

The details for the service discovery registries to assign to this task set. For more information, see Service discovery.

" }, "scale":{ "shape":"Scale", "documentation":"

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

" }, "stabilityStatus":{ "shape":"StabilityStatus", "documentation":"

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

- The task `runningCount` is equal to the `computedDesiredCount`.

- The `pendingCount` is `0`.

- There are no tasks that are 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 aren't met, the stability status returns `STABILIZING`.

" }, "stabilityStatusAt":{ "shape":"Timestamp", "documentation":"

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

" }, "tags":{ "shape":"Tags", "documentation":"

The metadata that you apply to the task set to help you categorize and organize them. Each tag consists of a key and an optional value. You define both.

The following basic restrictions apply to tags:

- Maximum number of tags per resource - 50

- For each resource, each tag key must be unique, and each tag key can have only one value.

- Maximum key length - 128 Unicode characters in UTF-8

- Maximum value length - 256 Unicode characters in UTF-8

- If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.

- Tag keys and values are case-sensitive.

- Do not use `aws:`, `AWS:`, or any upper or lowercase combination of such as a prefix for either keys or values as it is reserved for Amazon Web Services use. You cannot edit or delete tag keys or values with this prefix. Tags with this prefix do not count against your tags per resource limit.

" } }, "documentation":"

Information about a set of Amazon ECS tasks in either an CodeDeploy or an `EXTERNAL` 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.

" }, "TaskSetField":{ "type":"string", "enum":["TAGS"] }, "TaskSetFieldList":{ "type":"list", "member":{"shape":"TaskSetField"} }, "TaskSetNotFoundException":{ "type":"structure", "members":{ }, "documentation":"

The specified task set wasn't found. You can view your available task sets with DescribeTaskSets. Task sets are specific to each cluster, service and Region.

", "exception":true }, "TaskSets":{ "type":"list", "member":{"shape":"TaskSet"} }, "TaskStopCode":{ "type":"string", "enum":[ "TaskFailedToStart", "EssentialContainerExited", "UserInitiated", "ServiceSchedulerInitiated", "SpotInterruption", "TerminationNotice" ] }, "TaskVolumeConfiguration":{ "type":"structure", "required":["name"], "members":{ "name":{ "shape":"ECSVolumeName", "documentation":"

The name of the volume. This value must match the volume name from the `Volume` object in the task definition.

" }, "managedEBSVolume":{ "shape":"TaskManagedEBSVolumeConfiguration", "documentation":"

The configuration for the Amazon EBS volume that Amazon ECS creates and manages on your behalf. These settings are used to create each Amazon EBS volume, with one volume created for each task. The Amazon EBS volumes are visible in your account in the Amazon EC2 console once they are created.

" } }, "documentation":"

Configuration settings for the task volume that was `configuredAtLaunch` that weren't set during `RegisterTaskDef`.

" }, "TaskVolumeConfigurations":{ "type":"list", "member":{"shape":"TaskVolumeConfiguration"} }, "Tasks":{ "type":"list", "member":{"shape":"Task"} }, "Timestamp":{"type":"timestamp"}, "Tmpfs":{ "type":"structure", "required":[ "containerPath", "size" ], "members":{ "containerPath":{ "shape":"String", "documentation":"

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

" }, "size":{ "shape":"Integer", "documentation":"

The maximum size (in MiB) of the tmpfs volume.

" }, "mountOptions":{ "shape":"StringList", "documentation":"

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\"`

" } }, "documentation":"

The container path, mount options, and size of the tmpfs mount.

" }, "TmpfsList":{ "type":"list", "member":{"shape":"Tmpfs"} }, "TransportProtocol":{ "type":"string", "enum":[ "tcp", "udp" ] }, "Ulimit":{ "type":"structure", "required":[ "name", "softLimit", "hardLimit" ], "members":{ "name":{ "shape":"UlimitName", "documentation":"

The `type` of the `ulimit`.

" }, "softLimit":{ "shape":"Integer", "documentation":"

The soft limit for the `ulimit` type.

" }, "hardLimit":{ "shape":"Integer", "documentation":"

The hard limit for the `ulimit` type.

" } }, "documentation":"

The `ulimit` settings to pass to the container.

Amazon ECS tasks hosted on Fargate use the default resource limit values set by the operating system with the exception of the `nofile` resource limit parameter which Fargate overrides. The `nofile` resource limit sets a restriction on the number of open files that a container can use. The default `nofile` soft limit is `1024` and the default hard limit is `4096`.

You can specify the `ulimit` settings for a container in a task definition.

" }, "UlimitList":{ "type":"list", "member":{"shape":"Ulimit"} }, "UlimitName":{ "type":"string", "enum":[ "core", "cpu", "data", "fsize", "locks", "memlock", "msgqueue", "nice", "nofile", "nproc", "rss", "rtprio", "rttime", "sigpending", "stack" ] }, "UnsupportedFeatureException":{ "type":"structure", "members":{ }, "documentation":"

The specified task isn't supported in this Region.

", "exception":true }, "UntagResourceRequest":{ "type":"structure", "required":[ "resourceArn", "tagKeys" ], "members":{ "resourceArn":{ "shape":"String", "documentation":"

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

" }, "tagKeys":{ "shape":"TagKeys", "documentation":"

The keys of the tags to be removed.

" } } }, "UntagResourceResponse":{ "type":"structure", "members":{ } }, "UpdateCapacityProviderRequest":{ "type":"structure", "required":[ "name", "autoScalingGroupProvider" ], "members":{ "name":{ "shape":"String", "documentation":"

The name of the capacity provider to update.

" }, "autoScalingGroupProvider":{ "shape":"AutoScalingGroupProviderUpdate", "documentation":"

An object that represent the parameters to update for the Auto Scaling group capacity provider.

" } } }, "UpdateCapacityProviderResponse":{ "type":"structure", "members":{ "capacityProvider":{ "shape":"CapacityProvider", "documentation":"

Details about the capacity provider.

" } } }, "UpdateClusterRequest":{ "type":"structure", "required":["cluster"], "members":{ "cluster":{ "shape":"String", "documentation":"

The name of the cluster to modify the settings for.

" }, "settings":{ "shape":"ClusterSettings", "documentation":"

The cluster settings for your cluster.

" }, "configuration":{ "shape":"ClusterConfiguration", "documentation":"

The execute command configuration for the cluster.

" }, "serviceConnectDefaults":{ "shape":"ClusterServiceConnectDefaultsRequest", "documentation":"

Use this parameter to set a default Service Connect namespace. After you set a default Service Connect namespace, any new services with Service Connect turned on that are created in the cluster are added as client services in the namespace. This setting only applies to new services that set the `enabled` parameter to `true` in the `ServiceConnectConfiguration`. You can set the namespace of each service individually in the `ServiceConnectConfiguration` to override this default parameter.

Tasks that run in a namespace can use short names to connect to services in the namespace. Tasks can connect to services across all of the clusters in the namespace. Tasks connect through a managed proxy container that collects logs and metrics for increased visibility. Only the tasks that Amazon ECS services create are supported with Service Connect. For more information, see Service Connect in the Amazon Elastic Container Service Developer Guide.

" } } }, "UpdateClusterResponse":{ "type":"structure", "members":{ "cluster":{ "shape":"Cluster", "documentation":"

Details about the cluster.

" } } }, "UpdateClusterSettingsRequest":{ "type":"structure", "required":[ "cluster", "settings" ], "members":{ "cluster":{ "shape":"String", "documentation":"

The name of the cluster to modify the settings for.

" }, "settings":{ "shape":"ClusterSettings", "documentation":"

The setting to use by default for a cluster. This parameter is used to turn on CloudWatch Container Insights for a cluster. If this value is specified, it overrides the `containerInsights` value set with PutAccountSetting or PutAccountSettingDefault.

Currently, if you delete an existing cluster that does not have Container Insights turned on, and then create a new cluster with the same name with Container Insights tuned on, Container Insights will not actually be turned on. If you want to preserve the same name for your existing cluster and turn on Container Insights, you must wait 7 days before you can re-create it.

" } } }, "UpdateClusterSettingsResponse":{ "type":"structure", "members":{ "cluster":{ "shape":"Cluster", "documentation":"

Details about the cluster

" } } }, "UpdateContainerAgentRequest":{ "type":"structure", "required":["containerInstance"], "members":{ "cluster":{ "shape":"String", "documentation":"

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.

" }, "containerInstance":{ "shape":"String", "documentation":"

The container instance ID or full ARN entries for the container instance where you would like to update the Amazon ECS container agent.

" } } }, "UpdateContainerAgentResponse":{ "type":"structure", "members":{ "containerInstance":{ "shape":"ContainerInstance", "documentation":"

The container instance that the container agent was updated for.

" } } }, "UpdateContainerInstancesStateRequest":{ "type":"structure", "required":[ "containerInstances", "status" ], "members":{ "cluster":{ "shape":"String", "documentation":"

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.

" }, "containerInstances":{ "shape":"StringList", "documentation":"

A list of up to 10 container instance IDs or full ARN entries.

" }, "status":{ "shape":"ContainerInstanceStatus", "documentation":"

The container instance state to update the container instance with. The only valid values for this action are `ACTIVE` and `DRAINING`. A container instance can only be updated to `DRAINING` status once it has reached an `ACTIVE` state. If a container instance is in `REGISTERING`, `DEREGISTERING`, or `REGISTRATION_FAILED` state you can describe the container instance but can't update the container instance state.

" } } }, "UpdateContainerInstancesStateResponse":{ "type":"structure", "members":{ "containerInstances":{ "shape":"ContainerInstances", "documentation":"

The list of container instances.

" }, "failures":{ "shape":"Failures", "documentation":"

Any failures associated with the call.

" } } }, "UpdateInProgressException":{ "type":"structure", "members":{ }, "documentation":"

There's already a current Amazon ECS container agent update in progress on the container instance that's specified. If the container agent becomes disconnected while it's in a transitional stage, such as `PENDING` or `STAGING`, the update process can get stuck in that state. However, when the agent reconnects, it resumes where it stopped previously.

", "exception":true }, "UpdateServicePrimaryTaskSetRequest":{ "type":"structure", "required":[ "cluster", "service", "primaryTaskSet" ], "members":{ "cluster":{ "shape":"String", "documentation":"

The short name or full Amazon Resource Name (ARN) of the cluster that hosts the service that the task set exists in.

" }, "service":{ "shape":"String", "documentation":"

The short name or full Amazon Resource Name (ARN) of the service that the task set exists in.

" }, "primaryTaskSet":{ "shape":"String", "documentation":"

The short name or full Amazon Resource Name (ARN) of the task set to set as the primary task set in the deployment.

" } } }, "UpdateServicePrimaryTaskSetResponse":{ "type":"structure", "members":{ "taskSet":{ "shape":"TaskSet", "documentation":"

The details about the task set.

" } } }, "UpdateServiceRequest":{ "type":"structure", "required":["service"], "members":{ "cluster":{ "shape":"String", "documentation":"

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

" }, "service":{ "shape":"String", "documentation":"

The name of the service to update.

" }, "desiredCount":{ "shape":"BoxedInteger", "documentation":"

The number of instantiations of the task to place and keep running in your service.

" }, "taskDefinition":{ "shape":"String", "documentation":"

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.

" }, "capacityProviderStrategy":{ "shape":"CapacityProviderStrategy", "documentation":"

The capacity provider strategy to update the service to use.

if the service uses the default capacity provider strategy for the cluster, the service can be updated to use one or more capacity providers as opposed to the default capacity provider strategy. However, when a service is using a capacity provider strategy that's not the default capacity provider strategy, the service can't be updated to use the cluster's default capacity provider strategy.

A capacity provider strategy consists of one or more capacity providers along with the `base` and `weight` to assign to them. A capacity provider must be associated with the cluster to be used in a capacity provider strategy. The PutClusterCapacityProviders API is used to associate a capacity provider with a cluster. Only capacity providers with an `ACTIVE` or `UPDATING` status can be used.

If specifying a capacity provider that uses an Auto Scaling group, the capacity provider must already be created. New capacity providers can be created with the CreateCapacityProvider API operation.

To use a Fargate capacity provider, specify either the `FARGATE` or `FARGATE_SPOT` capacity providers. The Fargate capacity providers are available to all accounts and only need to be associated with a cluster to be used.

The PutClusterCapacityProviders API operation is used to update the list of available capacity providers for a cluster after the cluster is created.

" }, "deploymentConfiguration":{ "shape":"DeploymentConfiguration", "documentation":"

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

" }, "networkConfiguration":{ "shape":"NetworkConfiguration", "documentation":"

An object representing the network configuration for the service.

" }, "placementConstraints":{ "shape":"PlacementConstraints", "documentation":"

An array of task placement constraint objects to update the service to use. If no value is specified, the existing placement constraints for the service will remain unchanged. If this value is specified, it will override any existing placement constraints defined for the service. To remove all existing placement constraints, specify an empty array.

You can specify a maximum of 10 constraints for each task. This limit includes constraints in the task definition and those specified at runtime.

" }, "placementStrategy":{ "shape":"PlacementStrategies", "documentation":"

The task placement strategy objects to update the service to use. If no value is specified, the existing placement strategy for the service will remain unchanged. If this value is specified, it will override the existing placement strategy defined for the service. To remove an existing placement strategy, specify an empty object.

You can specify a maximum of five strategy rules for each service.

" }, "platformVersion":{ "shape":"String", "documentation":"

The platform version that your tasks in the service run on. A platform version is only specified for tasks using the Fargate launch type. If a platform version is not specified, the `LATEST` platform version is used. For more information, see Fargate Platform Versions in the Amazon Elastic Container Service Developer Guide.

" }, "forceNewDeployment":{ "shape":"Boolean", "documentation":"

Determines whether to force a new deployment of the service. By default, deployments aren't forced. You can use this option to start 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.

" }, "healthCheckGracePeriodSeconds":{ "shape":"BoxedInteger", "documentation":"

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. 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 2,147,483,647 seconds. During that time, the Amazon 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.

" }, "enableExecuteCommand":{ "shape":"BoxedBoolean", "documentation":"

If `true`, this enables execute command functionality on all task containers.

If you do not want to override the value that was set when the service was created, you can set this to `null` when performing this action.

" }, "enableECSManagedTags":{ "shape":"BoxedBoolean", "documentation":"

Determines whether to turn on 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.

Only tasks launched after the update will reflect the update. To update the tags on all tasks, set `forceNewDeployment` to `true`, so that Amazon ECS starts new tasks with the updated tags.

" }, "loadBalancers":{ "shape":"LoadBalancers", "documentation":"

A list of Elastic Load Balancing load balancer objects. It contains the load balancer name, the container name, and the container port to access from the load balancer. The container name is as it appears in a container definition.

When you add, update, or remove a load balancer configuration, Amazon ECS starts new tasks with the updated Elastic Load Balancing configuration, and then stops the old tasks when the new tasks are running.

For services that use rolling updates, you can add, update, or remove Elastic Load Balancing target groups. You can update from a single target group to multiple target groups and from multiple target groups to a single target group.

For services that use blue/green deployments, you can update Elastic Load Balancing target groups by using `CreateDeployment` through CodeDeploy. Note that multiple target groups are not supported for blue/green deployments. For more information see Register multiple target groups with a service in the Amazon Elastic Container Service Developer Guide.

For services that use the external deployment controller, you can add, update, or remove load balancers by using CreateTaskSet. Note that multiple target groups are not supported for external deployments. For more information see Register multiple target groups with a service in the Amazon Elastic Container Service Developer Guide.

You can remove existing `loadBalancers` by passing an empty list.

" }, "propagateTags":{ "shape":"PropagateTags", "documentation":"

Determines whether to propagate the tags from the task definition or the service to the task. If no value is specified, the tags aren't propagated.

Only tasks launched after the update will reflect the update. To update the tags on all tasks, set `forceNewDeployment` to `true`, so that Amazon ECS starts new tasks with the updated tags.

" }, "serviceRegistries":{ "shape":"ServiceRegistries", "documentation":"

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

When you add, update, or remove the service registries configuration, Amazon ECS starts new tasks with the updated service registries configuration, and then stops the old tasks when the new tasks are running.

You can remove existing `serviceRegistries` by passing an empty list.

" }, "serviceConnectConfiguration":{ "shape":"ServiceConnectConfiguration", "documentation":"

The configuration for this service to discover and connect to services, and be discovered by, and connected from, other services within a namespace.

Tasks that run in a namespace can use short names to connect to services in the namespace. Tasks can connect to services across all of the clusters in the namespace. Tasks connect through a managed proxy container that collects logs and metrics for increased visibility. Only the tasks that Amazon ECS services create are supported with Service Connect. For more information, see Service Connect in the Amazon Elastic Container Service Developer Guide.

" }, "volumeConfigurations":{ "shape":"ServiceVolumeConfigurations", "documentation":"

The details of the volume that was `configuredAtLaunch`. You can configure the size, volumeType, IOPS, throughput, snapshot and encryption in ServiceManagedEBSVolumeConfiguration. The `name` of the volume must match the `name` from the task definition. If set to null, no new deployment is triggered. Otherwise, if this configuration differs from the existing one, it triggers a new deployment.

" } } }, "UpdateServiceResponse":{ "type":"structure", "members":{ "service":{ "shape":"Service", "documentation":"

The full description of your service following the update call.

" } } }, "UpdateTaskProtectionRequest":{ "type":"structure", "required":[ "cluster", "tasks", "protectionEnabled" ], "members":{ "cluster":{ "shape":"String", "documentation":"

The short name or full Amazon Resource Name (ARN) of the cluster that hosts the service that the task sets exist in.

" }, "tasks":{ "shape":"StringList", "documentation":"

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

" }, "protectionEnabled":{ "shape":"Boolean", "documentation":"

Specify `true` to mark a task for protection and `false` to unset protection, making it eligible for termination.

" }, "expiresInMinutes":{ "shape":"BoxedInteger", "documentation":"

If you set `protectionEnabled` to `true`, you can specify the duration for task protection in minutes. You can specify a value from 1 minute to up to 2,880 minutes (48 hours). During this time, your task will not be terminated by scale-in events from Service Auto Scaling or deployments. After this time period lapses, `protectionEnabled` will be reset to `false`.

If you don’t specify the time, then the task is automatically protected for 120 minutes (2 hours).

" } } }, "UpdateTaskProtectionResponse":{ "type":"structure", "members":{ "protectedTasks":{ "shape":"ProtectedTasks", "documentation":"

A list of tasks with the following information.

- `taskArn`: The task ARN.

- `protectionEnabled`: The protection status of the task. If scale-in protection is turned on for a task, the value is `true`. Otherwise, it is `false`.

- `expirationDate`: The epoch time when protection for the task will expire.

" }, "failures":{ "shape":"Failures", "documentation":"

Any failures associated with the call.

" } } }, "UpdateTaskSetRequest":{ "type":"structure", "required":[ "cluster", "service", "taskSet", "scale" ], "members":{ "cluster":{ "shape":"String", "documentation":"

The short name or full Amazon Resource Name (ARN) of the cluster that hosts the service that the task set is found in.

" }, "service":{ "shape":"String", "documentation":"

The short name or full Amazon Resource Name (ARN) of the service that the task set is found in.

" }, "taskSet":{ "shape":"String", "documentation":"

The short name or full Amazon Resource Name (ARN) of the task set to update.

" }, "scale":{ "shape":"Scale", "documentation":"

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

" } } }, "UpdateTaskSetResponse":{ "type":"structure", "members":{ "taskSet":{ "shape":"TaskSet", "documentation":"

Details about the task set.

" } } }, "VersionInfo":{ "type":"structure", "members":{ "agentVersion":{ "shape":"String", "documentation":"

The version number of the Amazon ECS container agent.

" }, "agentHash":{ "shape":"String", "documentation":"

The Git commit hash for the Amazon ECS container agent build on the amazon-ecs-agent GitHub repository.

" }, "dockerVersion":{ "shape":"String", "documentation":"

The Docker version that's running on the container instance.

" } }, "documentation":"

The Docker and Amazon ECS container agent version information about a container instance.

" }, "Volume":{ "type":"structure", "members":{ "name":{ "shape":"String", "documentation":"

The name of the volume. Up to 255 letters (uppercase and lowercase), numbers, underscores, and hyphens are allowed.

When using a volume configured at launch, the `name` is required and must also be specified as the volume name in the `ServiceVolumeConfiguration` or `TaskVolumeConfiguration` parameter when creating your service or standalone task.

For all other types of volumes, this name is referenced in the `sourceVolume` parameter of the `mountPoints` object in the container definition.

When a volume is using the `efsVolumeConfiguration`, the name is required.

" }, "host":{ "shape":"HostVolumeProperties", "documentation":"

This parameter is specified when you use bind mount host volumes. The contents of the `host` parameter determine whether your bind mount host volume persists on the host container instance and where it's stored. If the `host` parameter is empty, then the Docker daemon assigns a host path for your data volume. However, the data isn't guaranteed to persist after the containers that are associated with it stop running.

Windows containers can mount whole directories on the same drive as `$env:ProgramData`. Windows containers can't mount directories on a different drive, and mount point can't 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`.

" }, "dockerVolumeConfiguration":{ "shape":"DockerVolumeConfiguration", "documentation":"

This parameter is specified when you use Docker volumes.

Windows containers only support the use of the `local` driver. To use bind mounts, specify the `host` parameter instead.

Docker volumes aren't supported by tasks run on Fargate.

" }, "efsVolumeConfiguration":{ "shape":"EFSVolumeConfiguration", "documentation":"

This parameter is specified when you use an Amazon Elastic File System file system for task storage.

" }, "fsxWindowsFileServerVolumeConfiguration":{ "shape":"FSxWindowsFileServerVolumeConfiguration", "documentation":"

This parameter is specified when you use Amazon FSx for Windows File Server file system for task storage.

" }, "configuredAtLaunch":{ "shape":"BoxedBoolean", "documentation":"

Indicates whether the volume should be configured at launch time. This is used to create Amazon EBS volumes for standalone tasks or tasks created as part of a service. Each task definition revision may only have one volume configured at launch in the volume configuration.

To configure a volume at launch time, use this task definition revision and specify a `volumeConfigurations` object when calling the `CreateService`, `UpdateService`, `RunTask` or `StartTask` APIs.

" } }, "documentation":"

The data volume configuration for tasks launched using this task definition. Specifying a volume configuration in a task definition is optional. The volume configuration may contain multiple volumes but only one volume configured at launch is supported. Each volume defined in the volume configuration may only specify a `name` and one of either `configuredAtLaunch`, `dockerVolumeConfiguration`, `efsVolumeConfiguration`, `fsxWindowsFileServerVolumeConfiguration`, or `host`. If an empty volume configuration is specified, by default Amazon ECS uses a host volume. For more information, see Using data volumes in tasks.

" }, "VolumeFrom":{ "type":"structure", "members":{ "sourceContainer":{ "shape":"String", "documentation":"

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

" }, "readOnly":{ "shape":"BoxedBoolean", "documentation":"

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

" } }, "documentation":"

Details on a data volume from another container in the same task definition.

" }, "VolumeFromList":{ "type":"list", "member":{"shape":"VolumeFrom"} }, "VolumeList":{ "type":"list", "member":{"shape":"Volume"} } }, "documentation":"Amazon Elastic Container Service

Amazon Elastic Container Service (Amazon ECS) is a highly scalable, fast, container management service. It makes it easy to run, stop, and manage Docker containers. You can host your cluster on a serverless infrastructure that's managed by Amazon ECS by launching your services or tasks on Fargate. For more control, you can host your tasks on a cluster of Amazon Elastic Compute Cloud (Amazon EC2) or External (on-premises) instances that you manage.

Amazon ECS makes it easy to launch and stop container-based applications with simple API calls. This makes it easy 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. With Amazon ECS, you don't need to operate your own cluster management and configuration management systems. You also don't need to worry about scaling your management infrastructure.

" }