{ "smithy": "1.0", "metadata": { "suppressions": [ { "id": "HttpMethodSemantics", "namespace": "*" }, { "id": "HttpResponseCodeSemantics", "namespace": "*" }, { "id": "PaginatedTrait", "namespace": "*" }, { "id": "HttpHeaderTrait", "namespace": "*" }, { "id": "HttpUriConflict", "namespace": "*" }, { "id": "Service", "namespace": "*" } ] }, "shapes": { "com.amazonaws.ecs#AccessDeniedException": { "type": "structure", "members": { "message": { "target": "com.amazonaws.ecs#String" } }, "traits": { "smithy.api#documentation": "
You do not have authorization to perform the requested action.
", "smithy.api#error": "client" } }, "com.amazonaws.ecs#AgentUpdateStatus": { "type": "string", "traits": { "smithy.api#enum": [ { "value": "PENDING", "name": "PENDING" }, { "value": "STAGING", "name": "STAGING" }, { "value": "STAGED", "name": "STAGED" }, { "value": "UPDATING", "name": "UPDATING" }, { "value": "UPDATED", "name": "UPDATED" }, { "value": "FAILED", "name": "FAILED" } ] } }, "com.amazonaws.ecs#AmazonEC2ContainerServiceV20141113": { "type": "service", "version": "2014-11-13", "operations": [ { "target": "com.amazonaws.ecs#CreateCapacityProvider" }, { "target": "com.amazonaws.ecs#CreateCluster" }, { "target": "com.amazonaws.ecs#CreateService" }, { "target": "com.amazonaws.ecs#CreateTaskSet" }, { "target": "com.amazonaws.ecs#DeleteAccountSetting" }, { "target": "com.amazonaws.ecs#DeleteAttributes" }, { "target": "com.amazonaws.ecs#DeleteCapacityProvider" }, { "target": "com.amazonaws.ecs#DeleteCluster" }, { "target": "com.amazonaws.ecs#DeleteService" }, { "target": "com.amazonaws.ecs#DeleteTaskSet" }, { "target": "com.amazonaws.ecs#DeregisterContainerInstance" }, { "target": "com.amazonaws.ecs#DeregisterTaskDefinition" }, { "target": "com.amazonaws.ecs#DescribeCapacityProviders" }, { "target": "com.amazonaws.ecs#DescribeClusters" }, { "target": "com.amazonaws.ecs#DescribeContainerInstances" }, { "target": "com.amazonaws.ecs#DescribeServices" }, { "target": "com.amazonaws.ecs#DescribeTaskDefinition" }, { "target": "com.amazonaws.ecs#DescribeTasks" }, { "target": "com.amazonaws.ecs#DescribeTaskSets" }, { "target": "com.amazonaws.ecs#DiscoverPollEndpoint" }, { "target": "com.amazonaws.ecs#ExecuteCommand" }, { "target": "com.amazonaws.ecs#ListAccountSettings" }, { "target": "com.amazonaws.ecs#ListAttributes" }, { "target": "com.amazonaws.ecs#ListClusters" }, { "target": "com.amazonaws.ecs#ListContainerInstances" }, { "target": "com.amazonaws.ecs#ListServices" }, { "target": "com.amazonaws.ecs#ListTagsForResource" }, { "target": "com.amazonaws.ecs#ListTaskDefinitionFamilies" }, { "target": "com.amazonaws.ecs#ListTaskDefinitions" }, { "target": "com.amazonaws.ecs#ListTasks" }, { "target": "com.amazonaws.ecs#PutAccountSetting" }, { "target": "com.amazonaws.ecs#PutAccountSettingDefault" }, { "target": "com.amazonaws.ecs#PutAttributes" }, { "target": "com.amazonaws.ecs#PutClusterCapacityProviders" }, { "target": "com.amazonaws.ecs#RegisterContainerInstance" }, { "target": "com.amazonaws.ecs#RegisterTaskDefinition" }, { "target": "com.amazonaws.ecs#RunTask" }, { "target": "com.amazonaws.ecs#StartTask" }, { "target": "com.amazonaws.ecs#StopTask" }, { "target": "com.amazonaws.ecs#SubmitAttachmentStateChanges" }, { "target": "com.amazonaws.ecs#SubmitContainerStateChange" }, { "target": "com.amazonaws.ecs#SubmitTaskStateChange" }, { "target": "com.amazonaws.ecs#TagResource" }, { "target": "com.amazonaws.ecs#UntagResource" }, { "target": "com.amazonaws.ecs#UpdateCapacityProvider" }, { "target": "com.amazonaws.ecs#UpdateCluster" }, { "target": "com.amazonaws.ecs#UpdateClusterSettings" }, { "target": "com.amazonaws.ecs#UpdateContainerAgent" }, { "target": "com.amazonaws.ecs#UpdateContainerInstancesState" }, { "target": "com.amazonaws.ecs#UpdateService" }, { "target": "com.amazonaws.ecs#UpdateServicePrimaryTaskSet" }, { "target": "com.amazonaws.ecs#UpdateTaskSet" } ], "traits": { "aws.api#service": { "sdkId": "ECS", "arnNamespace": "ecs", "cloudFormationName": "ECS", "cloudTrailEventSource": "ecs.amazonaws.com", "endpointPrefix": "ecs" }, "aws.auth#sigv4": { "name": "ecs" }, "aws.protocols#awsJson1_1": {}, "smithy.api#documentation": "Amazon Elastic Container Service (Amazon ECS) is a highly scalable, fast, container management service that makes\n\t\t\tit easy to run, stop, and manage Docker containers on a cluster. You can host your\n\t\t\tcluster on a serverless infrastructure that is managed by Amazon ECS by launching your\n\t\t\tservices or tasks on AWS Fargate. For more control, you can host your tasks on a cluster\n\t\t\tof Amazon Elastic Compute Cloud (Amazon EC2) instances that you manage.
\n\t\tAmazon ECS makes it easy to launch and stop container-based applications with simple API\n\t\t\tcalls, allows you to get the state of your cluster from a centralized service, and gives\n\t\t\tyou access to many familiar Amazon EC2 features.
\n\t\tYou can use Amazon ECS to schedule the placement of containers across your cluster based on\n\t\t\tyour resource needs, isolation policies, and availability requirements. Amazon ECS eliminates\n\t\t\tthe need for you to operate your own cluster management and configuration management\n\t\t\tsystems or worry about scaling your management infrastructure.
", "smithy.api#title": "Amazon EC2 Container Service", "smithy.api#xmlNamespace": { "uri": "http://ecs.amazonaws.com/doc/2014-11-13/" } } }, "com.amazonaws.ecs#AssignPublicIp": { "type": "string", "traits": { "smithy.api#enum": [ { "value": "ENABLED", "name": "ENABLED" }, { "value": "DISABLED", "name": "DISABLED" } ] } }, "com.amazonaws.ecs#Attachment": { "type": "structure", "members": { "id": { "target": "com.amazonaws.ecs#String", "traits": { "smithy.api#documentation": "The unique identifier for the attachment.
" } }, "type": { "target": "com.amazonaws.ecs#String", "traits": { "smithy.api#documentation": "The type of the attachment, such as ElasticNetworkInterface
.
The status of the attachment. Valid values are PRECREATED
,\n\t\t\t\tCREATED
, ATTACHING
, ATTACHED
,\n\t\t\t\tDETACHING
, DETACHED
, and DELETED
.
Details of the attachment. For elastic network interfaces, this includes the network\n\t\t\tinterface ID, the MAC address, the subnet ID, and the private IPv4 address.
" } } }, "traits": { "smithy.api#documentation": "An object representing a container instance or task attachment.
" } }, "com.amazonaws.ecs#AttachmentDetails": { "type": "list", "member": { "target": "com.amazonaws.ecs#KeyValuePair" } }, "com.amazonaws.ecs#AttachmentStateChange": { "type": "structure", "members": { "attachmentArn": { "target": "com.amazonaws.ecs#String", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the attachment.
", "smithy.api#required": {} } }, "status": { "target": "com.amazonaws.ecs#String", "traits": { "smithy.api#documentation": "The status of the attachment.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "An object representing a change in state for a task attachment.
" } }, "com.amazonaws.ecs#AttachmentStateChanges": { "type": "list", "member": { "target": "com.amazonaws.ecs#AttachmentStateChange" } }, "com.amazonaws.ecs#Attachments": { "type": "list", "member": { "target": "com.amazonaws.ecs#Attachment" } }, "com.amazonaws.ecs#Attribute": { "type": "structure", "members": { "name": { "target": "com.amazonaws.ecs#String", "traits": { "smithy.api#documentation": "The name of the attribute. The name
must contain between 1 and 128\n\t\t\tcharacters and name may contain letters (uppercase and lowercase), numbers, hyphens,\n\t\t\tunderscores, forward slashes, back slashes, or periods.
The value of the attribute. The value
must contain between 1 and 128\n\t\t\tcharacters and may contain letters (uppercase and lowercase), numbers, hyphens,\n\t\t\tunderscores, periods, at signs (@), forward slashes, back slashes, colons, or spaces.\n\t\t\tThe value cannot contain any leading or trailing whitespace.
The type of the target with which to attach the attribute. This parameter is required\n\t\t\tif you use the short form ID for a resource instead of the full ARN.
" } }, "targetId": { "target": "com.amazonaws.ecs#String", "traits": { "smithy.api#documentation": "The ID of the target. You can specify the short form ID for a resource or the full\n\t\t\tAmazon Resource Name (ARN).
" } } }, "traits": { "smithy.api#documentation": "An attribute is a name-value pair associated with an Amazon ECS object. Attributes enable\n\t\t\tyou to extend the Amazon ECS data model by adding custom metadata to your resources. For more\n\t\t\tinformation, see Attributes in the Amazon Elastic Container Service Developer Guide.
" } }, "com.amazonaws.ecs#AttributeLimitExceededException": { "type": "structure", "members": { "message": { "target": "com.amazonaws.ecs#String" } }, "traits": { "smithy.api#documentation": "You can apply up to 10 custom attributes per resource. You can view the attributes of\n\t\t\ta resource with ListAttributes. You can remove existing attributes on\n\t\t\ta resource with DeleteAttributes.
", "smithy.api#error": "client" } }, "com.amazonaws.ecs#Attributes": { "type": "list", "member": { "target": "com.amazonaws.ecs#Attribute" } }, "com.amazonaws.ecs#AutoScalingGroupProvider": { "type": "structure", "members": { "autoScalingGroupArn": { "target": "com.amazonaws.ecs#String", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) that identifies the Auto Scaling group.
", "smithy.api#required": {} } }, "managedScaling": { "target": "com.amazonaws.ecs#ManagedScaling", "traits": { "smithy.api#documentation": "The managed scaling settings for the Auto Scaling group capacity provider.
" } }, "managedTerminationProtection": { "target": "com.amazonaws.ecs#ManagedTerminationProtection", "traits": { "smithy.api#documentation": "The managed termination protection setting to use for the Auto Scaling group capacity\n\t\t\tprovider. This determines whether the Auto Scaling group has managed termination\n\t\t\tprotection.
\n\t\tWhen using managed termination protection, managed scaling must also be used\n\t\t\t\totherwise managed termination protection will not work.
\n\t\tWhen managed termination protection is enabled, Amazon ECS prevents the Amazon EC2 instances in\n\t\t\tan Auto Scaling group that contain tasks from being terminated during a scale-in action.\n\t\t\tThe Auto Scaling group and each instance in the Auto Scaling group must have instance\n\t\t\tprotection from scale-in actions enabled as well. For more information, see Instance Protection in the AWS Auto Scaling User Guide.
\n\t\tWhen managed termination protection is disabled, your Amazon EC2 instances are not\n\t\t\tprotected from termination when the Auto Scaling group scales in.
" } } }, "traits": { "smithy.api#documentation": "The details of the Auto Scaling group for the capacity provider.
" } }, "com.amazonaws.ecs#AutoScalingGroupProviderUpdate": { "type": "structure", "members": { "managedScaling": { "target": "com.amazonaws.ecs#ManagedScaling", "traits": { "smithy.api#documentation": "The managed scaling settings for the Auto Scaling group capacity provider.
" } }, "managedTerminationProtection": { "target": "com.amazonaws.ecs#ManagedTerminationProtection", "traits": { "smithy.api#documentation": "The managed termination protection setting to use for the Auto Scaling group capacity\n\t\t\tprovider. This determines whether the Auto Scaling group has managed termination\n\t\t\tprotection.
\n\t\tWhen using managed termination protection, managed scaling must also be used\n\t\t\t\totherwise managed termination protection will not work.
\n\t\tWhen managed termination protection is enabled, Amazon ECS prevents the Amazon EC2 instances in\n\t\t\tan Auto Scaling group that contain tasks from being terminated during a scale-in action.\n\t\t\tThe Auto Scaling group and each instance in the Auto Scaling group must have instance\n\t\t\tprotection from scale-in actions enabled as well. For more information, see Instance Protection in the AWS Auto Scaling User Guide.
\n\t\tWhen managed termination protection is disabled, your Amazon EC2 instances are not\n\t\t\tprotected from termination when the Auto Scaling group scales in.
" } } }, "traits": { "smithy.api#documentation": "The details of the Auto Scaling group capacity provider to update.
" } }, "com.amazonaws.ecs#AwsVpcConfiguration": { "type": "structure", "members": { "subnets": { "target": "com.amazonaws.ecs#StringList", "traits": { "smithy.api#documentation": "The IDs of the subnets associated with the task or service. There is a limit of 16\n\t\t\tsubnets that can be specified per AwsVpcConfiguration
.
All specified subnets must be from the same VPC.
\n\t\tThe IDs of the security groups associated with the task or service. If you do not\n\t\t\tspecify a security group, the default security group for the VPC is used. There is a\n\t\t\tlimit of 5 security groups that can be specified per\n\t\t\tAwsVpcConfiguration
.
All specified security groups must be from the same VPC.
\n\t\tWhether the task's elastic network interface receives a public IP address. The default\n\t\t\tvalue is DISABLED
.
An object representing the networking details for a task or service.
" } }, "com.amazonaws.ecs#BlockedException": { "type": "structure", "members": { "message": { "target": "com.amazonaws.ecs#String" } }, "traits": { "smithy.api#documentation": "Your AWS account has been blocked. For more information, contact AWS Support.
", "smithy.api#error": "client" } }, "com.amazonaws.ecs#Boolean": { "type": "boolean" }, "com.amazonaws.ecs#BoxedBoolean": { "type": "boolean", "traits": { "smithy.api#box": {} } }, "com.amazonaws.ecs#BoxedInteger": { "type": "integer", "traits": { "smithy.api#box": {} } }, "com.amazonaws.ecs#CapacityProvider": { "type": "structure", "members": { "capacityProviderArn": { "target": "com.amazonaws.ecs#String", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) that identifies the capacity provider.
" } }, "name": { "target": "com.amazonaws.ecs#String", "traits": { "smithy.api#documentation": "The name of the capacity provider.
" } }, "status": { "target": "com.amazonaws.ecs#CapacityProviderStatus", "traits": { "smithy.api#documentation": "The current status of the capacity provider. Only capacity providers in an\n\t\t\t\tACTIVE
state can be used in a cluster. When a capacity provider is\n\t\t\tsuccessfully deleted, it will have an INACTIVE
status.
The Auto Scaling group settings for the capacity provider.
" } }, "updateStatus": { "target": "com.amazonaws.ecs#CapacityProviderUpdateStatus", "traits": { "smithy.api#documentation": "The update status of the capacity provider. The following are the possible states that\n\t\t\twill be returned.
\n\t\tThe capacity provider is in the process of being deleted.
\n\t\t\t\tThe capacity provider has been successfully deleted and will have an\n\t\t\t\t\t\t\tINACTIVE
status.
The capacity provider was unable to be deleted. The update status reason\n\t\t\t\t\t\twill provide further details about why the delete failed.
\n\t\t\t\tThe update status reason. This provides further details about the update status for\n\t\t\tthe capacity provider.
" } }, "tags": { "target": "com.amazonaws.ecs#Tags", "traits": { "smithy.api#documentation": "The metadata that you apply to the capacity provider to help you categorize and\n\t\t\torganize it. Each tag consists of a key and an optional value, both of which you\n\t\t\tdefine.
\nThe following basic restrictions apply to tags:
\nMaximum number of tags per resource - 50
\nFor each resource, each tag key must be unique, and each tag key can have only\n one value.
\nMaximum key length - 128 Unicode characters in UTF-8
\nMaximum value length - 256 Unicode characters in UTF-8
\nIf your tagging schema is used across multiple services and resources,\n remember that other services may have restrictions on allowed characters.\n Generally allowed characters are: letters, numbers, and spaces representable in\n UTF-8, and the following characters: + - = . _ : / @.
\nTag keys and values are case-sensitive.
\nDo not use aws:
, AWS:
, or any upper or lowercase\n combination of such as a prefix for either keys or values as it is reserved for\n AWS use. You cannot edit or delete tag keys or values with this prefix. Tags with\n this prefix do not count against your tags per resource limit.
The details of a capacity provider.
" } }, "com.amazonaws.ecs#CapacityProviderField": { "type": "string", "traits": { "smithy.api#enum": [ { "value": "TAGS", "name": "TAGS" } ] } }, "com.amazonaws.ecs#CapacityProviderFieldList": { "type": "list", "member": { "target": "com.amazonaws.ecs#CapacityProviderField" } }, "com.amazonaws.ecs#CapacityProviderStatus": { "type": "string", "traits": { "smithy.api#enum": [ { "value": "ACTIVE", "name": "ACTIVE" }, { "value": "INACTIVE", "name": "INACTIVE" } ] } }, "com.amazonaws.ecs#CapacityProviderStrategy": { "type": "list", "member": { "target": "com.amazonaws.ecs#CapacityProviderStrategyItem" } }, "com.amazonaws.ecs#CapacityProviderStrategyItem": { "type": "structure", "members": { "capacityProvider": { "target": "com.amazonaws.ecs#String", "traits": { "smithy.api#documentation": "The short name of the capacity provider.
", "smithy.api#required": {} } }, "weight": { "target": "com.amazonaws.ecs#CapacityProviderStrategyItemWeight", "traits": { "smithy.api#documentation": "The weight value designates the relative percentage of the total\n\t\t\tnumber of tasks launched that should use the specified capacity provider. The\n\t\t\t\tweight
value is taken into consideration after the base
\n\t\t\tvalue, if defined, is satisfied.
If no weight
value is specified, the default value of 0
is\n\t\t\tused. When multiple capacity providers are specified within a capacity provider\n\t\t\tstrategy, at least one of the capacity providers must have a weight value greater than\n\t\t\tzero and any capacity providers with a weight of 0
will not be used to\n\t\t\tplace tasks. If you specify multiple capacity providers in a strategy that all have a\n\t\t\tweight of 0
, any RunTask
or CreateService
actions\n\t\t\tusing the capacity provider strategy will fail.
An example scenario for using weights is defining a strategy that contains two\n\t\t\tcapacity providers and both have a weight of 1
, then when the\n\t\t\t\tbase
is satisfied, the tasks will be split evenly across the two\n\t\t\tcapacity providers. Using that same logic, if you specify a weight of 1
for\n\t\t\t\tcapacityProviderA and a weight of 4
for\n\t\t\t\tcapacityProviderB, then for every one task that is run using\n\t\t\t\tcapacityProviderA, four tasks would use\n\t\t\t\tcapacityProviderB.
The base value designates how many tasks, at a minimum, to run on\n\t\t\tthe specified capacity provider. Only one capacity provider in a capacity provider\n\t\t\tstrategy can have a base defined. If no value is specified, the\n\t\t\tdefault value of 0
is used.
The details of a capacity provider strategy. A capacity provider strategy can be set\n\t\t\twhen using the RunTask or CreateCluster APIs or as\n\t\t\tthe default capacity provider strategy for a cluster with the CreateCluster API.
\n\t\tOnly capacity providers that are already associated with a cluster and have an\n\t\t\t\tACTIVE
or UPDATING
status can be used in a capacity\n\t\t\tprovider strategy. The PutClusterCapacityProviders API is used to\n\t\t\tassociate a capacity provider with a cluster.
If specifying a capacity provider that uses an Auto Scaling group, the capacity\n\t\t\tprovider must already be created. New Auto Scaling group capacity providers can be\n\t\t\tcreated with the CreateCapacityProvider API operation.
\n\t\tTo use a AWS Fargate capacity provider, specify either the FARGATE
or\n\t\t\t\tFARGATE_SPOT
capacity providers. The AWS Fargate capacity providers are\n\t\t\tavailable to all accounts and only need to be associated with a cluster to be used in a\n\t\t\tcapacity provider strategy.
These errors are usually caused by a client action, such as using an action or\n\t\t\tresource on behalf of a user that doesn't have permissions to use the action or\n\t\t\tresource, or specifying an identifier that is not valid.
", "smithy.api#error": "client" } }, "com.amazonaws.ecs#Cluster": { "type": "structure", "members": { "clusterArn": { "target": "com.amazonaws.ecs#String", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) that identifies the cluster. The ARN contains the arn:aws:ecs
namespace, followed by the Region of the cluster, the AWS account ID of the cluster owner, the cluster
namespace, and then the cluster name. For example, arn:aws:ecs:region:012345678910:cluster/test
.
A user-generated string that you use to identify your cluster.
" } }, "configuration": { "target": "com.amazonaws.ecs#ClusterConfiguration", "traits": { "smithy.api#documentation": "The execute command configuration for the cluster.
" } }, "status": { "target": "com.amazonaws.ecs#String", "traits": { "smithy.api#documentation": "The status of the cluster. The following are the possible states that will be\n\t\t\treturned.
\n\t\tThe cluster is ready to accept tasks and if applicable you can register\n\t\t\t\t\t\tcontainer instances with the cluster.
\n\t\t\t\tThe cluster has capacity providers associated with it and the resources\n\t\t\t\t\t\tneeded for the capacity provider are being created.
\n\t\t\t\tThe cluster has capacity providers associated with it and the resources\n\t\t\t\t\t\tneeded for the capacity provider are being deleted.
\n\t\t\t\tThe cluster has capacity providers associated with it and the resources\n\t\t\t\t\t\tneeded for the capacity provider have failed to create.
\n\t\t\t\tThe cluster has been deleted. Clusters with an INACTIVE
\n\t\t\t\t\t\tstatus may remain discoverable in your account for a period of time.\n\t\t\t\t\t\tHowever, this behavior is subject to change in the future, so you should not\n\t\t\t\t\t\trely on INACTIVE
clusters persisting.
The number of container instances registered into the cluster. This includes container\n\t\t\tinstances in both ACTIVE
and DRAINING
status.
The number of tasks in the cluster that are in the RUNNING
state.
The number of tasks in the cluster that are in the PENDING
state.
The number of services that are running on the cluster in an ACTIVE
\n\t\t\tstate. You can view these services with ListServices.
Additional information about your clusters that are separated by launch type,\n\t\t\tincluding:
\n\t\trunningEC2TasksCount
\n\t\t\tRunningFargateTasksCount
\n\t\t\tpendingEC2TasksCount
\n\t\t\tpendingFargateTasksCount
\n\t\t\tactiveEC2ServiceCount
\n\t\t\tactiveFargateServiceCount
\n\t\t\tdrainingEC2ServiceCount
\n\t\t\tdrainingFargateServiceCount
\n\t\t\tThe metadata that you apply to the cluster to help you categorize and organize them.\n\t\t\tEach tag consists of a key and an optional value, both of which you define.
\n\t\tThe following basic restrictions apply to tags:
\nMaximum number of tags per resource - 50
\nFor each resource, each tag key must be unique, and each tag key can have only\n one value.
\nMaximum key length - 128 Unicode characters in UTF-8
\nMaximum value length - 256 Unicode characters in UTF-8
\nIf your tagging schema is used across multiple services and resources,\n remember that other services may have restrictions on allowed characters.\n Generally allowed characters are: letters, numbers, and spaces representable in\n UTF-8, and the following characters: + - = . _ : / @.
\nTag keys and values are case-sensitive.
\nDo not use aws:
, AWS:
, or any upper or lowercase\n combination of such as a prefix for either keys or values as it is reserved for\n AWS use. You cannot edit or delete tag keys or values with this prefix. Tags with\n this prefix do not count against your tags per resource limit.
The settings for the cluster. This parameter indicates whether CloudWatch Container Insights\n\t\t\tis enabled or disabled for a cluster.
" } }, "capacityProviders": { "target": "com.amazonaws.ecs#StringList", "traits": { "smithy.api#documentation": "The capacity providers associated with the cluster.
" } }, "defaultCapacityProviderStrategy": { "target": "com.amazonaws.ecs#CapacityProviderStrategy", "traits": { "smithy.api#documentation": "The default capacity provider strategy for the cluster. When services or tasks are run\n\t\t\tin the cluster with no launch type or capacity provider strategy specified, the default\n\t\t\tcapacity provider strategy is used.
" } }, "attachments": { "target": "com.amazonaws.ecs#Attachments", "traits": { "smithy.api#documentation": "The resources attached to a cluster. When using a capacity provider with a cluster,\n\t\t\tthe Auto Scaling plan that is created will be returned as a cluster attachment.
" } }, "attachmentsStatus": { "target": "com.amazonaws.ecs#String", "traits": { "smithy.api#documentation": "The status of the capacity providers associated with the cluster. The following are\n\t\t\tthe states that will be returned:
\n\t\tThe available capacity providers for the cluster are updating. This occurs\n\t\t\t\t\t\twhen the Auto Scaling plan is provisioning or deprovisioning.
\n\t\t\t\tThe capacity providers have successfully updated.
\n\t\t\t\tThe capacity provider updates failed.
\n\t\t\t\tA regional grouping of one or more container instances on which you can run task\n\t\t\trequests. Each account receives a default cluster the first time you use the Amazon ECS\n\t\t\tservice, but you may also create other clusters. Clusters may contain more than one\n\t\t\tinstance type simultaneously.
" } }, "com.amazonaws.ecs#ClusterConfiguration": { "type": "structure", "members": { "executeCommandConfiguration": { "target": "com.amazonaws.ecs#ExecuteCommandConfiguration", "traits": { "smithy.api#documentation": "The details of the execute command configuration.
" } } }, "traits": { "smithy.api#documentation": "The execute command configuration for the cluster.
" } }, "com.amazonaws.ecs#ClusterContainsContainerInstancesException": { "type": "structure", "members": { "message": { "target": "com.amazonaws.ecs#String" } }, "traits": { "smithy.api#documentation": "You cannot delete a cluster that has registered container instances. First, deregister\n\t\t\tthe container instances before you can delete the cluster. For more information, see\n\t\t\t\tDeregisterContainerInstance.
", "smithy.api#error": "client" } }, "com.amazonaws.ecs#ClusterContainsServicesException": { "type": "structure", "members": { "message": { "target": "com.amazonaws.ecs#String" } }, "traits": { "smithy.api#documentation": "You cannot delete a cluster that contains services. First, update the service to\n\t\t\treduce its desired task count to 0 and then delete the service. For more information,\n\t\t\tsee UpdateService and DeleteService.
", "smithy.api#error": "client" } }, "com.amazonaws.ecs#ClusterContainsTasksException": { "type": "structure", "members": { "message": { "target": "com.amazonaws.ecs#String" } }, "traits": { "smithy.api#documentation": "You cannot delete a cluster that has active tasks.
", "smithy.api#error": "client" } }, "com.amazonaws.ecs#ClusterField": { "type": "string", "traits": { "smithy.api#enum": [ { "value": "ATTACHMENTS", "name": "ATTACHMENTS" }, { "value": "CONFIGURATIONS", "name": "CONFIGURATIONS" }, { "value": "SETTINGS", "name": "SETTINGS" }, { "value": "STATISTICS", "name": "STATISTICS" }, { "value": "TAGS", "name": "TAGS" } ] } }, "com.amazonaws.ecs#ClusterFieldList": { "type": "list", "member": { "target": "com.amazonaws.ecs#ClusterField" } }, "com.amazonaws.ecs#ClusterNotFoundException": { "type": "structure", "members": { "message": { "target": "com.amazonaws.ecs#String" } }, "traits": { "smithy.api#documentation": "The specified cluster could not be found. You can view your available clusters with\n\t\t\t\tListClusters. Amazon ECS clusters are Region-specific.
", "smithy.api#error": "client" } }, "com.amazonaws.ecs#ClusterSetting": { "type": "structure", "members": { "name": { "target": "com.amazonaws.ecs#ClusterSettingName", "traits": { "smithy.api#documentation": "The name of the cluster setting. The only supported value is\n\t\t\t\tcontainerInsights
.
The value to set for the cluster setting. The supported values are\n\t\t\t\tenabled
and disabled
. If enabled
is\n\t\t\tspecified, CloudWatch Container Insights will be enabled for the cluster, otherwise it will be\n\t\t\tdisabled unless the containerInsights
account setting is enabled. If a\n\t\t\tcluster value is specified, it will override the containerInsights
value\n\t\t\tset with PutAccountSetting or PutAccountSettingDefault.
The settings to use when creating a cluster. This parameter is used to enable CloudWatch\n\t\t\tContainer Insights for a cluster.
" } }, "com.amazonaws.ecs#ClusterSettingName": { "type": "string", "traits": { "smithy.api#enum": [ { "value": "containerInsights", "name": "CONTAINER_INSIGHTS" } ] } }, "com.amazonaws.ecs#ClusterSettings": { "type": "list", "member": { "target": "com.amazonaws.ecs#ClusterSetting" } }, "com.amazonaws.ecs#Clusters": { "type": "list", "member": { "target": "com.amazonaws.ecs#Cluster" } }, "com.amazonaws.ecs#Compatibility": { "type": "string", "traits": { "smithy.api#enum": [ { "value": "EC2", "name": "EC2" }, { "value": "FARGATE", "name": "FARGATE" } ] } }, "com.amazonaws.ecs#CompatibilityList": { "type": "list", "member": { "target": "com.amazonaws.ecs#Compatibility" } }, "com.amazonaws.ecs#Connectivity": { "type": "string", "traits": { "smithy.api#enum": [ { "value": "CONNECTED", "name": "CONNECTED" }, { "value": "DISCONNECTED", "name": "DISCONNECTED" } ] } }, "com.amazonaws.ecs#Container": { "type": "structure", "members": { "containerArn": { "target": "com.amazonaws.ecs#String", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the container.
" } }, "taskArn": { "target": "com.amazonaws.ecs#String", "traits": { "smithy.api#documentation": "The ARN of the task.
" } }, "name": { "target": "com.amazonaws.ecs#String", "traits": { "smithy.api#documentation": "The name of the container.
" } }, "image": { "target": "com.amazonaws.ecs#String", "traits": { "smithy.api#documentation": "The image used for the container.
" } }, "imageDigest": { "target": "com.amazonaws.ecs#String", "traits": { "smithy.api#documentation": "The container image manifest digest.
\n\t\tThe imageDigest
is only returned if the container is using an image\n\t\t\t\thosted in Amazon ECR, otherwise it is omitted.
The ID of the Docker container.
" } }, "lastStatus": { "target": "com.amazonaws.ecs#String", "traits": { "smithy.api#documentation": "The last known status of the container.
" } }, "exitCode": { "target": "com.amazonaws.ecs#BoxedInteger", "traits": { "smithy.api#documentation": "The exit code returned from the container.
" } }, "reason": { "target": "com.amazonaws.ecs#String", "traits": { "smithy.api#documentation": "A short (255 max characters) human-readable string to provide additional details about\n\t\t\ta running or stopped container.
" } }, "networkBindings": { "target": "com.amazonaws.ecs#NetworkBindings", "traits": { "smithy.api#documentation": "The network bindings associated with the container.
" } }, "networkInterfaces": { "target": "com.amazonaws.ecs#NetworkInterfaces", "traits": { "smithy.api#documentation": "The network interfaces associated with the container.
" } }, "healthStatus": { "target": "com.amazonaws.ecs#HealthStatus", "traits": { "smithy.api#documentation": "The health status of the container. If health checks are not configured for this\n\t\t\tcontainer in its task definition, then it reports the health status as\n\t\t\t\tUNKNOWN
.
The details of any Amazon ECS managed agents associated with the container.
" } }, "cpu": { "target": "com.amazonaws.ecs#String", "traits": { "smithy.api#documentation": "The number of CPU units set for the container. The value will be 0
if no\n\t\t\tvalue was specified in the container definition when the task definition was\n\t\t\tregistered.
The hard limit (in MiB) of memory set for the container.
" } }, "memoryReservation": { "target": "com.amazonaws.ecs#String", "traits": { "smithy.api#documentation": "The soft limit (in MiB) of memory set for the container.
" } }, "gpuIds": { "target": "com.amazonaws.ecs#GpuIds", "traits": { "smithy.api#documentation": "The IDs of each GPU assigned to the container.
" } } }, "traits": { "smithy.api#documentation": "A Docker container that is part of a task.
" } }, "com.amazonaws.ecs#ContainerCondition": { "type": "string", "traits": { "smithy.api#enum": [ { "value": "START", "name": "START" }, { "value": "COMPLETE", "name": "COMPLETE" }, { "value": "SUCCESS", "name": "SUCCESS" }, { "value": "HEALTHY", "name": "HEALTHY" } ] } }, "com.amazonaws.ecs#ContainerDefinition": { "type": "structure", "members": { "name": { "target": "com.amazonaws.ecs#String", "traits": { "smithy.api#documentation": "The name of a container. If you are linking multiple containers together in a task\n\t\t\tdefinition, the name
of one container can be entered in the\n\t\t\t\tlinks
of another container to connect the containers.\n\t\t\tUp to 255 letters (uppercase and lowercase), numbers, underscores, and hyphens are allowed. This parameter maps to name
in the\n\t\t\tCreate a container section of the Docker Remote API and the\n\t\t\t\t--name
option to docker\n\t\t\trun.
The image used to start a container. This string is passed directly to the Docker\n\t\t\tdaemon. Images in the Docker Hub registry are available by default. Other repositories\n\t\t\tare specified with either \n\t\t\t\t repository-url/image:tag\n\t\t\t
or \n\t\t\t\t repository-url/image@digest\n\t\t\t
. 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\n\t\t\tCreate a container section of the Docker Remote API and the\n\t\t\t\tIMAGE
parameter of docker\n\t\t\t\trun.
When a new task starts, the Amazon ECS container agent pulls the latest version of\n\t\t\t\t\tthe specified image and tag for the container to use. However, subsequent\n\t\t\t\t\tupdates to a repository image are not propagated to already running\n\t\t\t\t\ttasks.
\n\t\t\tImages in Amazon ECR repositories can be specified by either using the full\n\t\t\t\t\t\tregistry/repository:tag
or\n\t\t\t\t\t\tregistry/repository@digest
. For example,\n\t\t\t\t\t\t012345678910.dkr.ecr.
\n\t\t\t\t\tor\n\t\t\t\t\t\t012345678910.dkr.ecr.
.\n\t\t\t\t
Images in official repositories on Docker Hub use a single name (for example,\n\t\t\t\t\t\tubuntu
or mongo
).
Images in other repositories on Docker Hub are qualified with an organization\n\t\t\t\t\tname (for example, amazon/amazon-ecs-agent
).
Images in other online repositories are qualified further by a domain name\n\t\t\t\t\t(for example, quay.io/assemblyline/ubuntu
).
The private repository authentication credentials to use.
" } }, "cpu": { "target": "com.amazonaws.ecs#Integer", "traits": { "smithy.api#documentation": "The number of cpu
units reserved for the container. This parameter maps\n\t\t\tto CpuShares
in the Create a container section of the\n\t\t\tDocker Remote API and the --cpu-shares
option to docker run.
This field is optional for tasks using the Fargate launch type, and the\n\t\t\tonly requirement is that the total amount of CPU reserved for all containers within a\n\t\t\ttask be lower than the task-level cpu
value.
You can determine the number of CPU units that are available per EC2 instance type\n\t\t\t\tby multiplying the vCPUs listed for that instance type on the Amazon EC2 Instances detail page\n\t\t\t\tby 1,024.
\n\t\tLinux containers share unallocated CPU units with other containers on the container\n\t\t\tinstance with the same ratio as their allocated amount. For example, if you run a\n\t\t\tsingle-container task on a single-core instance type with 512 CPU units specified for\n\t\t\tthat container, and that is the only task running on the container instance, that\n\t\t\tcontainer could use the full 1,024 CPU unit share at any given time. However, if you\n\t\t\tlaunched another copy of the same task on that container instance, each task would be\n\t\t\tguaranteed a minimum of 512 CPU units when needed, and each container could float to\n\t\t\thigher CPU usage if the other container was not using it, but if both tasks were 100%\n\t\t\tactive all of the time, they would be limited to 512 CPU units.
\n\t\tOn Linux container instances, the Docker daemon on the container instance uses the CPU\n\t\t\tvalue to calculate the relative CPU share ratios for running containers. For more\n\t\t\tinformation, see CPU share\n\t\t\t\tconstraint in the Docker documentation. The minimum valid CPU share value\n\t\t\tthat the Linux kernel allows is 2. However, the CPU parameter is not required, and you\n\t\t\tcan use CPU values below 2 in your container definitions. For CPU values below 2\n\t\t\t(including null), the behavior varies based on your Amazon ECS container agent\n\t\t\tversion:
\n\t\t\n\t\t\t\t\t Agent versions less than or equal to 1.1.0:\n\t\t\t\t\tNull and zero CPU values are passed to Docker as 0, which Docker then converts\n\t\t\t\t\tto 1,024 CPU shares. CPU values of 1 are passed to Docker as 1, which the Linux\n\t\t\t\t\tkernel converts to two CPU shares.
\n\t\t\t\n\t\t\t\t\t Agent versions greater than or equal to 1.2.0:\n\t\t\t\t\tNull, zero, and CPU values of 1 are passed to Docker as 2.
\n\t\t\tOn Windows container instances, the CPU limit is enforced as an absolute limit, or a\n\t\t\tquota. Windows containers only have access to the specified amount of CPU that is\n\t\t\tdescribed in the task definition. A null or zero CPU value is passed to Docker as\n\t\t\t\t0
, which Windows interprets as 1% of one CPU.
The amount (in MiB) of memory to present to the container. If your container attempts\n\t\t\tto exceed the memory specified here, the container is killed. The total amount of memory\n\t\t\treserved for all containers within a task must be lower than the task\n\t\t\t\tmemory
value, if one is specified. This parameter maps to\n\t\t\t\tMemory
in the Create a container section of the\n\t\t\tDocker Remote API and the --memory
option to docker run.
If using the Fargate launch type, this parameter is optional.
\n\t\tIf using the EC2 launch type, you must specify either a task-level\n\t\t\tmemory value or a container-level memory value. If you specify both a container-level\n\t\t\t\tmemory
and memoryReservation
value, memory
\n\t\t\tmust be greater than memoryReservation
. If you specify\n\t\t\t\tmemoryReservation
, then that value is subtracted from the available\n\t\t\tmemory resources for the container instance on which the container is placed. Otherwise,\n\t\t\tthe value of memory
is used.
The Docker daemon reserves a minimum of 4 MiB of memory for a container, so you should\n\t\t\tnot specify fewer than 4 MiB of memory for your containers.
" } }, "memoryReservation": { "target": "com.amazonaws.ecs#BoxedInteger", "traits": { "smithy.api#documentation": "The soft limit (in MiB) of memory to reserve for the container. When system memory is\n\t\t\tunder heavy contention, Docker attempts to keep the container memory to this soft limit.\n\t\t\tHowever, your container can consume more memory when it needs to, up to either the hard\n\t\t\tlimit specified with the memory
parameter (if applicable), or all of the\n\t\t\tavailable memory on the container instance, whichever comes first. This parameter maps\n\t\t\tto MemoryReservation
in the Create a container section of\n\t\t\tthe 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\n\t\t\tone or both of memory
or memoryReservation
in a container\n\t\t\tdefinition. If you specify both, memory
must be greater than\n\t\t\t\tmemoryReservation
. If you specify memoryReservation
, then\n\t\t\tthat value is subtracted from the available memory resources for the container instance\n\t\t\ton which the container is placed. Otherwise, the value of memory
is\n\t\t\tused.
For example, if your container normally uses 128 MiB of memory, but occasionally\n\t\t\tbursts to 256 MiB of memory for short periods of time, you can set a\n\t\t\t\tmemoryReservation
of 128 MiB, and a memory
hard limit of\n\t\t\t300 MiB. This configuration would allow the container to only reserve 128 MiB of memory\n\t\t\tfrom the remaining resources on the container instance, but also allow the container to\n\t\t\tconsume more memory resources when needed.
The Docker daemon reserves a minimum of 4 MiB of memory for a container, so you should\n\t\t\tnot specify fewer than 4 MiB of memory for your containers.
" } }, "links": { "target": "com.amazonaws.ecs#StringList", "traits": { "smithy.api#documentation": "The links
parameter allows containers to communicate with each other\n\t\t\twithout the need for port mappings. This parameter is only supported if the network mode\n\t\t\tof a task definition is bridge
. The name:internalName
\n\t\t\tconstruct is analogous to name:alias
in Docker links.\n\t\t\tUp to 255 letters (uppercase and lowercase), numbers, underscores, and hyphens are allowed. For more information about linking Docker containers, go to\n\t\t\t\tLegacy container links\n\t\t\tin the Docker documentation. This parameter maps to Links
in the\n\t\t\tCreate a container section of the Docker Remote API and the\n\t\t\t\t--link
option to docker\n\t\t\trun.
This parameter is not supported for Windows containers.
\nContainers that are collocated on a single container instance may be able to\n\t\t\t\tcommunicate with each other without requiring links or host port mappings. Network\n\t\t\t\tisolation is achieved on the container instance using security groups and VPC\n\t\t\t\tsettings.
\n\t\tThe list of port mappings for the container. Port mappings allow containers to access\n\t\t\tports on the host container instance to send or receive traffic.
\n\t\tFor task definitions that use the awsvpc
network mode, you should only\n\t\t\tspecify the containerPort
. The hostPort
can be left blank or\n\t\t\tit must be the same value as the containerPort
.
Port mappings on Windows use the NetNAT
gateway address rather than\n\t\t\t\tlocalhost
. There is no loopback for port mappings on Windows, so you\n\t\t\tcannot access a container's mapped port from the host itself.
This parameter maps to PortBindings
in the\n\t\t\tCreate a container section of the Docker Remote API and the\n\t\t\t\t--publish
option to docker\n\t\t\t\trun. If the network mode of a task definition is set to none
,\n\t\t\tthen you can't specify port mappings. If the network mode of a task definition is set to\n\t\t\t\thost
, then host ports must either be undefined or they must match the\n\t\t\tcontainer port in the port mapping.
After a task reaches the RUNNING
status, manual and automatic host\n\t\t\t\tand container port assignments are visible in the Network\n\t\t\t\t\tBindings section of a container description for a selected task in\n\t\t\t\tthe Amazon ECS console. The assignments are also visible in the\n\t\t\t\t\tnetworkBindings
section DescribeTasks\n\t\t\t\tresponses.
If the essential
parameter of a container is marked as true
,\n\t\t\tand that container fails or stops for any reason, all other containers that are part of\n\t\t\tthe task are stopped. If the essential
parameter of a container is marked\n\t\t\tas false
, then its failure does not affect the rest of the containers in a\n\t\t\ttask. 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\n\t\t\tis composed of multiple containers, you should group containers that are used for a\n\t\t\tcommon purpose into components, and separate the different components into multiple task\n\t\t\tdefinitions. For more information, see Application\n\t\t\t\tArchitecture in the Amazon Elastic Container Service Developer Guide.
" } }, "entryPoint": { "target": "com.amazonaws.ecs#StringList", "traits": { "smithy.api#documentation": "Early versions of the Amazon ECS container agent do not properly handle\n\t\t\t\t\tentryPoint
parameters. If you have problems using\n\t\t\t\t\tentryPoint
, update your container agent or enter your commands and\n\t\t\t\targuments as command
array items instead.
The entry point that is passed to the container. This parameter maps to\n\t\t\t\tEntrypoint
in the Create a container section of the\n\t\t\tDocker Remote API and the --entrypoint
option to docker run. For more information, see https://docs.docker.com/engine/reference/builder/#entrypoint.
The command that is passed to the container. This parameter maps to Cmd
\n\t\t\tin the Create a container section of the Docker Remote API and the\n\t\t\t\tCOMMAND
parameter to docker\n\t\t\t\trun. For more information, see https://docs.docker.com/engine/reference/builder/#cmd. If there are multiple arguments, each\n\t\t\targument should be a separated string in the array.
The environment variables to pass to a container. This parameter maps to\n\t\t\t\tEnv
in the Create a container section of the\n\t\t\tDocker Remote API and the --env
option to docker run.
We do not recommend using plaintext environment variables for sensitive\n\t\t\t\tinformation, such as credential data.
\n\t\tA list of files containing the environment variables to pass to a container. This\n\t\t\tparameter maps to the --env-file
option to docker run.
You can specify up to ten environment files. The file must have a .env
\n\t\t\tfile extension. Each line in an environment file should contain an environment variable\n\t\t\tin VARIABLE=VALUE
format. Lines beginning with #
are treated\n\t\t\tas comments and are ignored. For more information on the environment variable file\n\t\t\tsyntax, see Declare default\n\t\t\t\tenvironment variables in file.
If there are environment variables specified using the environment
\n\t\t\tparameter in a container definition, they take precedence over the variables contained\n\t\t\twithin an environment file. If multiple environment files are specified that contain the\n\t\t\tsame variable, they are processed from the top down. It is recommended to use unique\n\t\t\tvariable names. For more information, see Specifying Environment\n\t\t\t\tVariables in the Amazon Elastic Container Service Developer Guide.
The mount points for data volumes in your container.
\n\t\tThis parameter maps to Volumes
in the Create a container\n\t\t\tsection of the Docker Remote API and the --volume
option to docker run.
Windows containers can mount whole directories on the same drive as\n\t\t\t\t$env:ProgramData
. Windows containers cannot mount directories on a\n\t\t\tdifferent drive, and mount point cannot be across drives.
Data volumes to mount from another container. This parameter maps to\n\t\t\t\tVolumesFrom
in the Create a container section of the\n\t\t\tDocker Remote API and the --volumes-from
option to docker run.
Linux-specific modifications that are applied to the container, such as Linux kernel\n\t\t\tcapabilities. For more information see KernelCapabilities.
\n\t\tThis parameter is not supported for Windows containers.
\n\t\tThe secrets to pass to the container. For more information, see Specifying\n\t\t\t\tSensitive Data in the Amazon Elastic Container Service Developer Guide.
" } }, "dependsOn": { "target": "com.amazonaws.ecs#ContainerDependencies", "traits": { "smithy.api#documentation": "The dependencies defined for container startup and shutdown. A container can contain\n\t\t\tmultiple dependencies. When a dependency is defined for container startup, for container\n\t\t\tshutdown it is reversed.
\n\t\tFor tasks using the EC2 launch type, the container instances require at\n\t\t\tleast version 1.26.0 of the container agent to enable container dependencies. However,\n\t\t\twe recommend using the latest container agent version. For information about checking\n\t\t\tyour agent version and updating to the latest version, see Updating the Amazon ECS\n\t\t\t\tContainer Agent in the Amazon Elastic Container Service Developer Guide. If you are\n\t\t\tusing an Amazon ECS-optimized Linux AMI, your instance needs at least version 1.26.0-1 of the\n\t\t\t\tecs-init
package. If your container instances are launched from version\n\t\t\t\t20190301
or later, then they contain the required versions of the\n\t\t\tcontainer 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\n\t\t\tplatform version 1.3.0
or later.
Time duration (in seconds) to wait before giving up on resolving dependencies for a\n\t\t\tcontainer. For example, you specify two containers in a task definition with containerA\n\t\t\thaving a dependency on containerB reaching a COMPLETE
,\n\t\t\tSUCCESS
, or HEALTHY
status. If a startTimeout
\n\t\t\tvalue is specified for containerB and it does not reach the desired status within that\n\t\t\ttime then containerA will give up and not start. This results in the task transitioning\n\t\t\tto a STOPPED
state.
When the ECS_CONTAINER_START_TIMEOUT
container agent configuration\n\t\t\t\tvariable is used, it is enforced indendently from this start timeout value.
For tasks using the Fargate launch type, this parameter requires that\n\t\t\tthe task or service uses platform version 1.3.0 or later.
\n\t\tFor tasks using the EC2 launch type, your container instances require at\n\t\t\tleast version 1.26.0
of the container agent to enable a container start\n\t\t\ttimeout value. However, we recommend using the latest container agent version. For\n\t\t\tinformation about checking your agent version and updating to the latest version, see\n\t\t\t\tUpdating the Amazon ECS\n\t\t\t\tContainer Agent in the Amazon Elastic Container Service Developer Guide. If you are\n\t\t\tusing an Amazon ECS-optimized Linux AMI, your instance needs at least version 1.26.0-1
of\n\t\t\tthe ecs-init
package. If your container instances are launched from version\n\t\t\t\t20190301
or later, then they contain the required versions of the\n\t\t\tcontainer agent and ecs-init
. For more information, see Amazon ECS-optimized Linux AMI in the Amazon Elastic Container Service Developer Guide.
Time duration (in seconds) to wait before the container is forcefully killed if it\n\t\t\tdoesn't exit normally on its own.
\n\t\tFor tasks using the Fargate launch type, the task or service requires\n\t\t\tplatform version 1.3.0 or later. The max stop timeout value is 120 seconds and if the\n\t\t\tparameter is not specified, the default value of 30 seconds is used.
\n\t\tFor tasks using the EC2 launch type, if the stopTimeout
\n\t\t\tparameter is not specified, the value set for the Amazon ECS container agent configuration\n\t\t\tvariable ECS_CONTAINER_STOP_TIMEOUT
is used by default. If neither the\n\t\t\t\tstopTimeout
parameter or the ECS_CONTAINER_STOP_TIMEOUT
\n\t\t\tagent configuration variable are set, then the default values of 30 seconds for Linux\n\t\t\tcontainers and 30 seconds on Windows containers are used. Your container instances\n\t\t\trequire at least version 1.26.0 of the container agent to enable a container stop\n\t\t\ttimeout value. However, we recommend using the latest container agent version. For\n\t\t\tinformation about checking your agent version and updating to the latest version, see\n\t\t\t\tUpdating the Amazon ECS\n\t\t\t\tContainer Agent in the Amazon Elastic Container Service Developer Guide. If you are\n\t\t\tusing an Amazon ECS-optimized Linux AMI, your instance needs at least version 1.26.0-1 of the\n\t\t\t\tecs-init
package. If your container instances are launched from version\n\t\t\t\t20190301
or later, then they contain the required versions of the\n\t\t\tcontainer agent and ecs-init
. For more information, see Amazon ECS-optimized Linux AMI in the Amazon Elastic Container Service Developer Guide.
The hostname to use for your container. This parameter maps to Hostname
\n\t\t\tin the Create a container section of the Docker Remote API and the\n\t\t\t\t--hostname
option to docker\n\t\t\t\trun.
The hostname
parameter is not supported if you are using the\n\t\t\t\t\tawsvpc
network mode.
The user to use inside the container. This parameter maps to User
in the\n\t\t\tCreate a container section of the Docker Remote API and the\n\t\t\t\t--user
option to docker\n\t\t\trun.
When running tasks using the host
network mode, you should not run\n\t\t\t\tcontainers using the root user (UID 0). It is considered best practice to use a\n\t\t\t\tnon-root user.
You can specify the user
using the following formats. If specifying a UID\n\t\t\tor GID, you must specify it as a positive integer.
\n user
\n
\n user:group
\n
\n uid
\n
\n uid:gid
\n
\n user:gid
\n
\n uid:group
\n
This parameter is not supported for Windows containers.
\nThe working directory in which to run commands inside the container. This parameter\n\t\t\tmaps to WorkingDir
in the Create a container section of the\n\t\t\tDocker Remote API and the --workdir
option to docker run.
When this parameter is true, networking is disabled within the container. This\n\t\t\tparameter maps to NetworkDisabled
in the Create a container\n\t\t\tsection of the Docker Remote API.
This parameter is not supported for Windows containers.
\nWhen this parameter is true, the container is given elevated privileges on the host\n\t\t\tcontainer instance (similar to the root
user). This parameter maps to\n\t\t\t\tPrivileged
in the Create a container section of the\n\t\t\tDocker Remote API and the --privileged
option to docker run.
This parameter is not supported for Windows containers or tasks run on AWS Fargate.
\nWhen this parameter is true, the container is given read-only access to its root file\n\t\t\tsystem. This parameter maps to ReadonlyRootfs
in the\n\t\t\tCreate a container section of the Docker Remote API and the\n\t\t\t\t--read-only
option to docker\n\t\t\t\trun.
This parameter is not supported for Windows containers.
\nA list of DNS servers that are presented to the container. This parameter maps to\n\t\t\t\tDns
in the Create a container section of the\n\t\t\tDocker Remote API and the --dns
option to docker run.
This parameter is not supported for Windows containers.
\nA list of DNS search domains that are presented to the container. This parameter maps\n\t\t\tto DnsSearch
in the Create a container section of the\n\t\t\tDocker Remote API and the --dns-search
option to docker run.
This parameter is not supported for Windows containers.
\nA list of hostnames and IP address mappings to append to the /etc/hosts
\n\t\t\tfile on the container. This parameter maps to ExtraHosts
in the\n\t\t\tCreate a container section of the Docker Remote API and the\n\t\t\t\t--add-host
option to docker\n\t\t\t\trun.
This parameter is not supported for Windows containers or tasks that use the\n\t\t\t\t\tawsvpc
network mode.
A list of strings to provide custom labels for SELinux and AppArmor multi-level\n\t\t\tsecurity systems. This field is not valid for containers in tasks using the\n\t\t\tFargate launch type.
\n\t\tWith Windows containers, this parameter can be used to reference a credential spec\n\t\t\tfile when configuring a container for Active Directory authentication. For more\n\t\t\tinformation, see Using gMSAs for Windows\n\t\t\t\tContainers in the Amazon Elastic Container Service Developer Guide.
\n\t\tThis parameter maps to SecurityOpt
in the\n\t\t\tCreate a container section of the Docker Remote API and the\n\t\t\t\t--security-opt
option to docker\n\t\t\t\trun.
The Amazon ECS container agent running on a container instance must register with the\n\t\t\t\t\tECS_SELINUX_CAPABLE=true
or ECS_APPARMOR_CAPABLE=true
\n\t\t\t\tenvironment variables before containers placed on that instance can use these\n\t\t\t\tsecurity options. For more information, see Amazon ECS Container\n\t\t\t\t\tAgent Configuration in the Amazon Elastic Container Service Developer Guide.
For more information about valid values, see Docker\n\t\t\t\tRun Security Configuration.
\n\t\tValid values: \"no-new-privileges\" | \"apparmor:PROFILE\" | \"label:value\" |\n\t\t\t\"credentialspec:CredentialSpecFilePath\"
" } }, "interactive": { "target": "com.amazonaws.ecs#BoxedBoolean", "traits": { "smithy.api#documentation": "When this parameter is true
, this allows you to deploy containerized\n\t\t\tapplications that require stdin
or a tty
to be allocated. This\n\t\t\tparameter maps to OpenStdin
in the Create a container\n\t\t\tsection of the Docker Remote API and the --interactive
option to docker run.
When this parameter is true
, a TTY is allocated. This parameter maps to\n\t\t\t\tTty
in the Create a container section of the\n\t\t\tDocker Remote API and the --tty
option to docker run.
A key/value map of labels to add to the container. This parameter maps to\n\t\t\t\tLabels
in the Create a container section of the\n\t\t\tDocker 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}}'
\n
A list of ulimits
to set in the container. If a ulimit value is specified\n\t\t\tin a task definition, it will override the default values set by Docker. This parameter\n\t\t\tmaps to Ulimits
in the Create a container section of the\n\t\t\tDocker Remote API and the --ulimit
option to docker run. Valid naming values are displayed\n\t\t\tin the Ulimit data type.
Amazon ECS tasks hosted on Fargate use the default\n\t\t\t\t\t\t\tresource limit values set by the operating system with the exception of\n\t\t\t\t\t\t\tthe nofile
resource limit parameter which Fargate\n\t\t\t\t\t\t\toverrides. The nofile
resource limit sets a restriction on\n\t\t\t\t\t\t\tthe number of open files that a container can use. The default\n\t\t\t\t\t\t\t\tnofile
soft limit is 1024
and hard limit\n\t\t\t\t\t\t\tis 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}}'
\n
This parameter is not supported for Windows containers.
\nThe log configuration specification for the container.
\n\t\tThis parameter maps to LogConfig
in the\n\t\t\tCreate a container section of the Docker Remote API and the\n\t\t\t\t--log-driver
option to docker\n\t\t\t\trun. By default, containers use the same logging driver that the Docker\n\t\t\tdaemon uses. However the container may use a different logging driver than the Docker\n\t\t\tdaemon by specifying a log driver with this parameter in the container definition. To\n\t\t\tuse a different logging driver for a container, the log system must be configured\n\t\t\tproperly on the container instance (or on a different log server for remote logging\n\t\t\toptions). For more information on the options for different supported log drivers, see\n\t\t\t\tConfigure\n\t\t\t\tlogging drivers in the Docker documentation.
Amazon ECS currently supports a subset of the logging drivers available to the Docker\n\t\t\t\tdaemon (shown in the LogConfiguration data type). Additional log\n\t\t\t\tdrivers may be available in future releases of the Amazon ECS container agent.
\n\t\tThis 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}}'
\n
The Amazon ECS container agent running on a container instance must register the\n\t\t\t\tlogging drivers available on that instance with the\n\t\t\t\t\tECS_AVAILABLE_LOGGING_DRIVERS
environment variable before\n\t\t\t\tcontainers placed on that instance can use these log configuration options. For more\n\t\t\t\tinformation, see Amazon ECS Container\n\t\t\t\t\tAgent Configuration in the Amazon Elastic Container Service Developer Guide.
The container health check command and associated configuration parameters for the\n\t\t\tcontainer. This parameter maps to HealthCheck
in the\n\t\t\tCreate a container section of the Docker Remote API and the\n\t\t\t\tHEALTHCHECK
parameter of docker\n\t\t\t\trun.
A list of namespaced kernel parameters to set in the container. This parameter maps to\n\t\t\t\tSysctls
in the Create a container section of the\n\t\t\tDocker Remote API and the --sysctl
option to docker run.
It is not recommended that you specify network-related systemControls
\n\t\t\t\tparameters for multiple containers in a single task that also uses either the\n\t\t\t\t\tawsvpc
or host
network modes. For tasks that use the\n\t\t\t\t\tawsvpc
network mode, the container that is started last determines\n\t\t\t\twhich systemControls
parameters take effect. For tasks that use the\n\t\t\t\t\thost
network mode, it changes the container instance's namespaced\n\t\t\t\tkernel parameters as well as the containers.
The type and amount of a resource to assign to a container. The only supported\n\t\t\tresource is a GPU.
" } }, "firelensConfiguration": { "target": "com.amazonaws.ecs#FirelensConfiguration", "traits": { "smithy.api#documentation": "The FireLens configuration for the container. This is used to specify and configure a\n\t\t\tlog router for container logs. For more information, see Custom Log Routing\n\t\t\tin the Amazon Elastic Container Service Developer Guide.
" } } }, "traits": { "smithy.api#documentation": "Container definitions are used in task definitions to describe the different\n\t\t\tcontainers that are launched as part of a task.
" } }, "com.amazonaws.ecs#ContainerDefinitions": { "type": "list", "member": { "target": "com.amazonaws.ecs#ContainerDefinition" } }, "com.amazonaws.ecs#ContainerDependencies": { "type": "list", "member": { "target": "com.amazonaws.ecs#ContainerDependency" } }, "com.amazonaws.ecs#ContainerDependency": { "type": "structure", "members": { "containerName": { "target": "com.amazonaws.ecs#String", "traits": { "smithy.api#documentation": "The name of a container.
", "smithy.api#required": {} } }, "condition": { "target": "com.amazonaws.ecs#ContainerCondition", "traits": { "smithy.api#documentation": "The dependency condition of the container. The following are the available conditions\n\t\t\tand their behavior:
\n\t\t\n START
- This condition emulates the behavior of links and\n\t\t\t\t\tvolumes today. It validates that a dependent container is started before\n\t\t\t\t\tpermitting other containers to start.
\n COMPLETE
- This condition validates that a dependent\n\t\t\t\t\tcontainer runs to completion (exits) before permitting other containers to\n\t\t\t\t\tstart. This can be useful for nonessential containers that run a script and then\n\t\t\t\t\texit. This condition cannot be set on an essential container.
\n SUCCESS
- This condition is the same as\n\t\t\t\t\t\tCOMPLETE
, but it also requires that the container exits with a\n\t\t\t\t\t\tzero
status. This condition cannot be set on an essential\n\t\t\t\t\tcontainer.
\n HEALTHY
- This condition validates that the dependent\n\t\t\t\t\tcontainer passes its Docker health check before permitting other containers to\n\t\t\t\t\tstart. This requires that the dependent container has health checks configured.\n\t\t\t\t\tThis condition is confirmed only at task startup.
The dependencies defined for container startup and shutdown. A container can contain\n\t\t\tmultiple dependencies. When a dependency is defined for container startup, for container\n\t\t\tshutdown it is reversed.
\n\t\tYour Amazon ECS container instances require at least version 1.26.0 of the container agent\n\t\t\tto enable container dependencies. However, we recommend using the latest container agent\n\t\t\tversion. For information about checking your agent version and updating to the latest\n\t\t\tversion, see Updating the Amazon ECS\n\t\t\t\tContainer Agent in the Amazon Elastic Container Service Developer Guide. If you are\n\t\t\tusing an Amazon ECS-optimized Linux AMI, your instance needs at least version 1.26.0-1 of the\n\t\t\t\tecs-init
package. If your container instances are launched from version\n\t\t\t\t20190301
or later, then they contain the required versions of the\n\t\t\tcontainer 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, this parameter requires\n\t\t\t\tthat the task or service uses platform version 1.3.0 or later.
\n\t\tThe Amazon Resource Name (ARN) of the container instance. The ARN contains the arn:aws:ecs
namespace, followed by the Region of the container instance, the AWS account ID of the container instance owner, the container-instance
namespace, and then the container instance ID. For example, arn:aws:ecs:region:aws_account_id:container-instance/container_instance_ID
.
The EC2 instance ID of the container instance.
" } }, "capacityProviderName": { "target": "com.amazonaws.ecs#String", "traits": { "smithy.api#documentation": "The capacity provider associated with the container instance.
" } }, "version": { "target": "com.amazonaws.ecs#Long", "traits": { "smithy.api#documentation": "The version counter for the container instance. Every time a container instance\n\t\t\texperiences a change that triggers a CloudWatch event, the version counter is\n\t\t\tincremented. If you are replicating your Amazon ECS container instance state with CloudWatch\n\t\t\tEvents, you can compare the version of a container instance reported by the Amazon ECS APIs\n\t\t\twith the version reported in CloudWatch Events for the container instance (inside the\n\t\t\t\tdetail
object) to verify that the version in your event stream is\n\t\t\tcurrent.
The version information for the Amazon ECS container agent and Docker daemon running on the\n\t\t\tcontainer instance.
" } }, "remainingResources": { "target": "com.amazonaws.ecs#Resources", "traits": { "smithy.api#documentation": "For CPU and memory resource types, this parameter describes the remaining CPU and\n\t\t\tmemory that has not already been allocated to tasks and is therefore available for new\n\t\t\ttasks. For port resource types, this parameter describes the ports that were reserved by\n\t\t\tthe Amazon ECS container agent (at instance registration time) and any task containers that\n\t\t\thave reserved port mappings on the host (with the host
or\n\t\t\t\tbridge
network mode). Any port that is not specified here is available\n\t\t\tfor new tasks.
For CPU and memory resource types, this parameter describes the amount of each\n\t\t\tresource that was available on the container instance when the container agent\n\t\t\tregistered it with Amazon ECS. This value represents the total amount of CPU and memory that\n\t\t\tcan be allocated on this container instance to tasks. For port resource types, this\n\t\t\tparameter describes the ports that were reserved by the Amazon ECS container agent when it\n\t\t\tregistered the container instance with Amazon ECS.
" } }, "status": { "target": "com.amazonaws.ecs#String", "traits": { "smithy.api#documentation": "The status of the container instance. The valid values are REGISTERING
,\n\t\t\t\tREGISTRATION_FAILED
, ACTIVE
, INACTIVE
,\n\t\t\t\tDEREGISTERING
, or DRAINING
.
If your account has opted in to the awsvpcTrunking
account setting, then\n\t\t\tany newly registered container instance will transition to a REGISTERING
\n\t\t\tstatus while the trunk elastic network interface is provisioned for the instance. If the\n\t\t\tregistration fails, the instance will transition to a REGISTRATION_FAILED
\n\t\t\tstatus. You can describe the container instance and see the reason for failure in the\n\t\t\t\tstatusReason
parameter. Once the container instance is terminated, the\n\t\t\tinstance transitions to a DEREGISTERING
status while the trunk elastic\n\t\t\tnetwork interface is deprovisioned. The instance then transitions to an\n\t\t\t\tINACTIVE
status.
The ACTIVE
status indicates that the container instance can accept tasks.\n\t\t\tThe DRAINING
indicates that new tasks are not placed on the container\n\t\t\tinstance and any service tasks running on the container instance are removed if\n\t\t\tpossible. For more information, see Container Instance Draining in the\n\t\t\t\tAmazon Elastic Container Service Developer Guide.
The reason that the container instance reached its current status.
" } }, "agentConnected": { "target": "com.amazonaws.ecs#Boolean", "traits": { "smithy.api#documentation": "This parameter returns true
if the agent is connected to Amazon ECS.\n\t\t\tRegistered instances with an agent that may be unhealthy or stopped return\n\t\t\t\tfalse
. Only instances connected to an agent can accept placement\n\t\t\trequests.
The number of tasks on the container instance that are in the RUNNING
\n\t\t\tstatus.
The number of tasks on the container instance that are in the PENDING
\n\t\t\tstatus.
The status of the most recent agent update. If an update has never been requested,\n\t\t\tthis value is NULL
.
The attributes set for the container instance, either by the Amazon ECS container agent at\n\t\t\tinstance registration or manually with the PutAttributes\n\t\t\toperation.
" } }, "registeredAt": { "target": "com.amazonaws.ecs#Timestamp", "traits": { "smithy.api#documentation": "The Unix timestamp for when the container instance was registered.
" } }, "attachments": { "target": "com.amazonaws.ecs#Attachments", "traits": { "smithy.api#documentation": "The resources attached to a container instance, such as elastic network\n\t\t\tinterfaces.
" } }, "tags": { "target": "com.amazonaws.ecs#Tags", "traits": { "smithy.api#documentation": "The metadata that you apply to the container instance to help you categorize and\n\t\t\torganize them. Each tag consists of a key and an optional value, both of which you\n\t\t\tdefine.
\nThe following basic restrictions apply to tags:
\nMaximum number of tags per resource - 50
\nFor each resource, each tag key must be unique, and each tag key can have only\n one value.
\nMaximum key length - 128 Unicode characters in UTF-8
\nMaximum value length - 256 Unicode characters in UTF-8
\nIf your tagging schema is used across multiple services and resources,\n remember that other services may have restrictions on allowed characters.\n Generally allowed characters are: letters, numbers, and spaces representable in\n UTF-8, and the following characters: + - = . _ : / @.
\nTag keys and values are case-sensitive.
\nDo not use aws:
, AWS:
, or any upper or lowercase\n combination of such as a prefix for either keys or values as it is reserved for\n AWS use. You cannot edit or delete tag keys or values with this prefix. Tags with\n this prefix do not count against your tags per resource limit.
An EC2 instance that is running the Amazon ECS agent and has been registered with a\n\t\t\tcluster.
" } }, "com.amazonaws.ecs#ContainerInstanceField": { "type": "string", "traits": { "smithy.api#enum": [ { "value": "TAGS", "name": "TAGS" } ] } }, "com.amazonaws.ecs#ContainerInstanceFieldList": { "type": "list", "member": { "target": "com.amazonaws.ecs#ContainerInstanceField" } }, "com.amazonaws.ecs#ContainerInstanceStatus": { "type": "string", "traits": { "smithy.api#enum": [ { "value": "ACTIVE", "name": "ACTIVE" }, { "value": "DRAINING", "name": "DRAINING" }, { "value": "REGISTERING", "name": "REGISTERING" }, { "value": "DEREGISTERING", "name": "DEREGISTERING" }, { "value": "REGISTRATION_FAILED", "name": "REGISTRATION_FAILED" } ] } }, "com.amazonaws.ecs#ContainerInstances": { "type": "list", "member": { "target": "com.amazonaws.ecs#ContainerInstance" } }, "com.amazonaws.ecs#ContainerOverride": { "type": "structure", "members": { "name": { "target": "com.amazonaws.ecs#String", "traits": { "smithy.api#documentation": "The name of the container that receives the override. This parameter is required if\n\t\t\tany override is specified.
" } }, "command": { "target": "com.amazonaws.ecs#StringList", "traits": { "smithy.api#documentation": "The command to send to the container that overrides the default command from the\n\t\t\tDocker image or the task definition. You must also specify a container name.
" } }, "environment": { "target": "com.amazonaws.ecs#EnvironmentVariables", "traits": { "smithy.api#documentation": "The environment variables to send to the container. You can add new environment\n\t\t\tvariables, which are added to the container at launch, or you can override the existing\n\t\t\tenvironment variables from the Docker image or the task definition. You must also\n\t\t\tspecify a container name.
" } }, "environmentFiles": { "target": "com.amazonaws.ecs#EnvironmentFiles", "traits": { "smithy.api#documentation": "A list of files containing the environment variables to pass to a container, instead\n\t\t\tof the value from the container definition.
" } }, "cpu": { "target": "com.amazonaws.ecs#BoxedInteger", "traits": { "smithy.api#documentation": "The number of cpu
units reserved for the container, instead of the\n\t\t\tdefault value from the task definition. You must also specify a container name.
The hard limit (in MiB) of memory to present to the container, instead of the default\n\t\t\tvalue from the task definition. If your container attempts to exceed the memory\n\t\t\tspecified here, the container is killed. You must also specify a container name.
" } }, "memoryReservation": { "target": "com.amazonaws.ecs#BoxedInteger", "traits": { "smithy.api#documentation": "The soft limit (in MiB) of memory to reserve for the container, instead of the default\n\t\t\tvalue from the task definition. You must also specify a container name.
" } }, "resourceRequirements": { "target": "com.amazonaws.ecs#ResourceRequirements", "traits": { "smithy.api#documentation": "The type and amount of a resource to assign to a container, instead of the default\n\t\t\tvalue from the task definition. The only supported resource is a GPU.
" } } }, "traits": { "smithy.api#documentation": "The overrides that should be sent to a container. An empty container override can be\n\t\t\tpassed in. An example of an empty container override would be\n\t\t\t\t{\"containerOverrides\": [ ] }
. If a non-empty container override is\n\t\t\tspecified, the name
parameter must be included.
The name of the container.
" } }, "imageDigest": { "target": "com.amazonaws.ecs#String", "traits": { "smithy.api#documentation": "The container image SHA 256 digest.
" } }, "runtimeId": { "target": "com.amazonaws.ecs#String", "traits": { "smithy.api#documentation": "The ID of the Docker container.
" } }, "exitCode": { "target": "com.amazonaws.ecs#BoxedInteger", "traits": { "smithy.api#documentation": "The exit code for the container, if the state change is a result of the container\n\t\t\texiting.
" } }, "networkBindings": { "target": "com.amazonaws.ecs#NetworkBindings", "traits": { "smithy.api#documentation": "Any network bindings associated with the container.
" } }, "reason": { "target": "com.amazonaws.ecs#String", "traits": { "smithy.api#documentation": "The reason for the state change.
" } }, "status": { "target": "com.amazonaws.ecs#String", "traits": { "smithy.api#documentation": "The status of the container.
" } } }, "traits": { "smithy.api#documentation": "An object representing a change in state for a container.
" } }, "com.amazonaws.ecs#ContainerStateChanges": { "type": "list", "member": { "target": "com.amazonaws.ecs#ContainerStateChange" } }, "com.amazonaws.ecs#Containers": { "type": "list", "member": { "target": "com.amazonaws.ecs#Container" } }, "com.amazonaws.ecs#CreateCapacityProvider": { "type": "operation", "input": { "target": "com.amazonaws.ecs#CreateCapacityProviderRequest" }, "output": { "target": "com.amazonaws.ecs#CreateCapacityProviderResponse" }, "errors": [ { "target": "com.amazonaws.ecs#ClientException" }, { "target": "com.amazonaws.ecs#InvalidParameterException" }, { "target": "com.amazonaws.ecs#LimitExceededException" }, { "target": "com.amazonaws.ecs#ServerException" }, { "target": "com.amazonaws.ecs#UpdateInProgressException" } ], "traits": { "smithy.api#documentation": "Creates a new capacity provider. Capacity providers are associated with an Amazon ECS\n\t\t\tcluster and are used in capacity provider strategies to facilitate cluster auto\n\t\t\tscaling.
\n\t\tOnly capacity providers using an Auto Scaling group can be created. Amazon ECS tasks on\n\t\t\tAWS Fargate use the FARGATE
and FARGATE_SPOT
capacity providers\n\t\t\twhich are already created and available to all accounts in Regions supported by\n\t\t\tAWS Fargate.
The name of the capacity provider. Up to 255 characters are allowed, including letters\n\t\t\t(upper and lowercase), numbers, underscores, and hyphens. The name cannot be prefixed\n\t\t\twith \"aws
\", \"ecs
\", or \"fargate
\".
The details of the Auto Scaling group for the capacity provider.
", "smithy.api#required": {} } }, "tags": { "target": "com.amazonaws.ecs#Tags", "traits": { "smithy.api#documentation": "The metadata that you apply to the capacity provider to help you categorize and\n\t\t\torganize them. Each tag consists of a key and an optional value, both of which you\n\t\t\tdefine.
\nThe following basic restrictions apply to tags:
\nMaximum number of tags per resource - 50
\nFor each resource, each tag key must be unique, and each tag key can have only\n one value.
\nMaximum key length - 128 Unicode characters in UTF-8
\nMaximum value length - 256 Unicode characters in UTF-8
\nIf your tagging schema is used across multiple services and resources,\n remember that other services may have restrictions on allowed characters.\n Generally allowed characters are: letters, numbers, and spaces representable in\n UTF-8, and the following characters: + - = . _ : / @.
\nTag keys and values are case-sensitive.
\nDo not use aws:
, AWS:
, or any upper or lowercase\n combination of such as a prefix for either keys or values as it is reserved for\n AWS use. You cannot edit or delete tag keys or values with this prefix. Tags with\n this prefix do not count against your tags per resource limit.
The full description of the new capacity provider.
" } } } }, "com.amazonaws.ecs#CreateCluster": { "type": "operation", "input": { "target": "com.amazonaws.ecs#CreateClusterRequest" }, "output": { "target": "com.amazonaws.ecs#CreateClusterResponse" }, "errors": [ { "target": "com.amazonaws.ecs#ClientException" }, { "target": "com.amazonaws.ecs#InvalidParameterException" }, { "target": "com.amazonaws.ecs#ServerException" } ], "traits": { "smithy.api#documentation": "Creates a new Amazon ECS cluster. By default, your account receives a default
\n\t\t\tcluster when you launch your first container instance. However, you can create your own\n\t\t\tcluster with a unique name with the CreateCluster
action.
When you call the CreateCluster API operation, Amazon ECS attempts to\n\t\t\t\tcreate the Amazon ECS service-linked role for your account so that required resources in\n\t\t\t\tother AWS services can be managed on your behalf. However, if the IAM user that\n\t\t\t\tmakes the call does not have permissions to create the service-linked role, it is\n\t\t\t\tnot created. For more information, see Using\n\t\t\t\t\tService-Linked Roles for Amazon ECS in the\n\t\t\t\t\tAmazon Elastic Container Service Developer Guide.
\n\t\tThe name of your cluster. If you do not specify a name for your cluster, you create a\n\t\t\tcluster named default
. Up to 255 letters (uppercase and lowercase), numbers, underscores, and hyphens are allowed.
The metadata that you apply to the cluster to help you categorize and organize them.\n\t\t\tEach tag consists of a key and an optional value, both of which you define.
\n\t\tThe following basic restrictions apply to tags:
\nMaximum number of tags per resource - 50
\nFor each resource, each tag key must be unique, and each tag key can have only\n one value.
\nMaximum key length - 128 Unicode characters in UTF-8
\nMaximum value length - 256 Unicode characters in UTF-8
\nIf your tagging schema is used across multiple services and resources,\n remember that other services may have restrictions on allowed characters.\n Generally allowed characters are: letters, numbers, and spaces representable in\n UTF-8, and the following characters: + - = . _ : / @.
\nTag keys and values are case-sensitive.
\nDo not use aws:
, AWS:
, or any upper or lowercase\n combination of such as a prefix for either keys or values as it is reserved for\n AWS use. You cannot edit or delete tag keys or values with this prefix. Tags with\n this prefix do not count against your tags per resource limit.
The setting to use when creating a cluster. This parameter is used to enable CloudWatch\n\t\t\tContainer Insights for a cluster. If this value is specified, it will override the\n\t\t\t\tcontainerInsights
value set with PutAccountSetting or\n\t\t\t\tPutAccountSettingDefault.
The execute command configuration for the cluster.
" } }, "capacityProviders": { "target": "com.amazonaws.ecs#StringList", "traits": { "smithy.api#documentation": "The short name of one or more capacity providers to associate with the cluster. A\n\t\t\tcapacity provider must be associated with a cluster before it can be included as part of\n\t\t\tthe default capacity provider strategy of the cluster or used in a capacity provider\n\t\t\tstrategy when calling the CreateService or RunTask\n\t\t\tactions.
\n\t\tIf specifying a capacity provider that uses an Auto Scaling group, the capacity\n\t\t\tprovider must already be created and not already associated with another cluster. New\n\t\t\tAuto Scaling group capacity providers can be created with the CreateCapacityProvider API operation.
\n\t\tTo use a AWS Fargate capacity provider, specify either the FARGATE
or\n\t\t\t\tFARGATE_SPOT
capacity providers. The AWS Fargate capacity providers are\n\t\t\tavailable to all accounts and only need to be associated with a cluster to be\n\t\t\tused.
The PutClusterCapacityProviders API operation is used to update the\n\t\t\tlist of available capacity providers for a cluster after the cluster is created.
" } }, "defaultCapacityProviderStrategy": { "target": "com.amazonaws.ecs#CapacityProviderStrategy", "traits": { "smithy.api#documentation": "The capacity provider strategy to set as the default for the cluster. When a default\n\t\t\tcapacity provider strategy is set for a cluster, when calling the RunTask or CreateService APIs wtih no capacity\n\t\t\tprovider strategy or launch type specified, the default capacity provider strategy for\n\t\t\tthe cluster is used.
\n\t\tIf a default capacity provider strategy is not defined for a cluster during creation,\n\t\t\tit can be defined later with the PutClusterCapacityProviders API\n\t\t\toperation.
" } } } }, "com.amazonaws.ecs#CreateClusterResponse": { "type": "structure", "members": { "cluster": { "target": "com.amazonaws.ecs#Cluster", "traits": { "smithy.api#documentation": "The full description of your new cluster.
" } } } }, "com.amazonaws.ecs#CreateService": { "type": "operation", "input": { "target": "com.amazonaws.ecs#CreateServiceRequest" }, "output": { "target": "com.amazonaws.ecs#CreateServiceResponse" }, "errors": [ { "target": "com.amazonaws.ecs#AccessDeniedException" }, { "target": "com.amazonaws.ecs#ClientException" }, { "target": "com.amazonaws.ecs#ClusterNotFoundException" }, { "target": "com.amazonaws.ecs#InvalidParameterException" }, { "target": "com.amazonaws.ecs#PlatformTaskDefinitionIncompatibilityException" }, { "target": "com.amazonaws.ecs#PlatformUnknownException" }, { "target": "com.amazonaws.ecs#ServerException" }, { "target": "com.amazonaws.ecs#UnsupportedFeatureException" } ], "traits": { "smithy.api#documentation": "Runs and maintains a desired number of tasks from a specified task definition. If the\n\t\t\tnumber of tasks running in a service drops below the desiredCount
, Amazon ECS\n\t\t\truns another copy of the task in the specified cluster. To update an existing service,\n\t\t\tsee the UpdateService action.
In addition to maintaining the desired count of tasks in your service, you can\n\t\t\toptionally run your service behind one or more load balancers. The load balancers\n\t\t\tdistribute traffic across the tasks that are associated with the service. For more\n\t\t\tinformation, see Service Load Balancing in the\n\t\t\t\tAmazon Elastic Container Service Developer Guide.
\n\t\tTasks for services that do not use a load balancer are considered\n\t\t\thealthy if they're in the RUNNING
state. Tasks for services that\n\t\t\t\tdo use a load balancer are considered healthy if they're in the\n\t\t\t\tRUNNING
state and the container instance that they're hosted on is\n\t\t\treported as healthy by the load balancer.
There are two service scheduler strategies available:
\n\t\t\n REPLICA
- The replica scheduling strategy places and\n\t\t\t\t\tmaintains the desired number of tasks across your cluster. By default, the\n\t\t\t\t\tservice scheduler spreads tasks across Availability Zones. You can use task\n\t\t\t\t\tplacement strategies and constraints to customize task placement decisions. For\n\t\t\t\t\tmore information, see Service Scheduler Concepts in the\n\t\t\t\t\t\tAmazon Elastic Container Service Developer Guide.
\n DAEMON
- The daemon scheduling strategy deploys exactly one\n\t\t\t\t\ttask on each active container instance that meets all of the task placement\n\t\t\t\t\tconstraints that you specify in your cluster. The service scheduler also\n\t\t\t\t\tevaluates the task placement constraints for running tasks and will stop tasks\n\t\t\t\t\tthat do not meet the placement constraints. When using this strategy, you don't\n\t\t\t\t\tneed to specify a desired number of tasks, a task placement strategy, or use\n\t\t\t\t\tService Auto Scaling policies. For more information, see Service Scheduler Concepts in the\n\t\t\t\t\t\tAmazon Elastic Container Service Developer Guide.
You can optionally specify a deployment configuration for your service. The deployment\n\t\t\tis triggered by changing properties, such as the task definition or the desired count of\n\t\t\ta service, with an UpdateService operation. The default value for a\n\t\t\treplica service for minimumHealthyPercent
is 100%. The default value for a\n\t\t\tdaemon service for minimumHealthyPercent
is 0%.
If a service is using the ECS
deployment controller, the minimum healthy\n\t\t\tpercent represents a lower limit on the number of tasks in a service that must remain in\n\t\t\tthe RUNNING
state during a deployment, as a percentage of the desired\n\t\t\tnumber of tasks (rounded up to the nearest integer), and while any container instances\n\t\t\tare in the DRAINING
state if the service contains tasks using the\n\t\t\tEC2 launch type. This parameter enables you to deploy without using\n\t\t\tadditional cluster capacity. For example, if your service has a desired number of four\n\t\t\ttasks and a minimum healthy percent of 50%, the scheduler might stop two existing tasks\n\t\t\tto free up cluster capacity before starting two new tasks. Tasks for services that\n\t\t\t\tdo not use a load balancer are considered healthy if they're in\n\t\t\tthe RUNNING
state. Tasks for services that do use a\n\t\t\tload balancer are considered healthy if they're in the RUNNING
state and\n\t\t\tthey're reported as healthy by the load balancer. The default value for minimum healthy\n\t\t\tpercent is 100%.
If a service is using the ECS
deployment controller, the maximum percent parameter represents an upper limit on the\n\t\t\tnumber of tasks in a service that are allowed in the RUNNING
or\n\t\t\t\tPENDING
state during a deployment, as a percentage of the desired\n\t\t\tnumber of tasks (rounded down to the nearest integer), and while any container instances\n\t\t\tare in the DRAINING
state if the service contains tasks using the\n\t\t\tEC2 launch type. This parameter enables you to define the deployment batch\n\t\t\tsize. For example, if your service has a desired number of four tasks and a maximum\n\t\t\tpercent value of 200%, the scheduler may start four new tasks before stopping the four\n\t\t\tolder tasks (provided that the cluster resources required to do this are available). The\n\t\t\tdefault value for maximum percent is 200%.
If a service is using either the CODE_DEPLOY
or EXTERNAL
\n\t\t\tdeployment controller types and tasks that use the EC2 launch type, the\n\t\t\t\tminimum healthy percent and maximum percent values are used only to define the lower and upper limit\n\t\t\ton the number of the tasks in the service that remain in the RUNNING
state\n\t\t\twhile the container instances are in the DRAINING
state. If the tasks in\n\t\t\tthe service use the Fargate launch type, the minimum healthy percent and\n\t\t\tmaximum percent values aren't used, although they're currently visible when describing\n\t\t\tyour service.
When creating a service that uses the EXTERNAL
deployment controller, you\n\t\t\tcan specify only parameters that aren't controlled at the task set level. The only\n\t\t\trequired 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 in your\n\t\t\tcluster using the following logic:
\n\t\tDetermine which of the container instances in your cluster can support your\n\t\t\t\t\tservice's task definition (for example, they have the required CPU, memory,\n\t\t\t\t\tports, and container instance attributes).
\n\t\t\tBy default, the service scheduler attempts to balance tasks across\n\t\t\t\t\tAvailability Zones in this manner (although you can choose a different placement\n\t\t\t\t\tstrategy) with the placementStrategy
parameter):
Sort the valid container instances, giving priority to instances that\n\t\t\t\t\t\t\thave the fewest number of running tasks for this service in their\n\t\t\t\t\t\t\trespective Availability Zone. For example, if zone A has one running\n\t\t\t\t\t\t\tservice task and zones B and C each have zero, valid container instances\n\t\t\t\t\t\t\tin either zone B or C are considered optimal for placement.
\n\t\t\t\t\tPlace the new service task on a valid container instance in an optimal\n\t\t\t\t\t\t\tAvailability Zone (based on the previous steps), favoring container\n\t\t\t\t\t\t\tinstances with the fewest number of running tasks for this\n\t\t\t\t\t\t\tservice.
\n\t\t\t\t\tThe short name or full Amazon Resource Name (ARN) of the cluster on which to run your service.\n\t\t\tIf you do not specify a cluster, the default cluster is assumed.
" } }, "serviceName": { "target": "com.amazonaws.ecs#String", "traits": { "smithy.api#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\n\t\t\ta cluster, but you can have similarly named services in multiple clusters within a\n\t\t\tRegion or across multiple Regions.
", "smithy.api#required": {} } }, "taskDefinition": { "target": "com.amazonaws.ecs#String", "traits": { "smithy.api#documentation": "The family
and revision
(family:revision
) or\n\t\t\tfull ARN of the task definition to run in your service. If a revision
is\n\t\t\tnot specified, the latest ACTIVE
revision is used.
A task definition must be specified if the service is using either the\n\t\t\t\tECS
or CODE_DEPLOY
deployment controllers.
A load balancer object representing the load balancers to use with your service. For\n\t\t\tmore information, see Service Load Balancing in the\n\t\t\t\tAmazon Elastic Container Service Developer Guide.
\n\t\tIf the service is using the rolling update (ECS
) deployment controller\n\t\t\tand using either an Application Load Balancer or Network Load Balancer, you must specify one or more target group ARNs to\n\t\t\tattach to the service. The service-linked role is required for services that make use of\n\t\t\tmultiple target groups. For more information, see Using service-linked roles for Amazon ECS in the\n\t\t\t\tAmazon Elastic Container Service Developer Guide.
If the service is using the CODE_DEPLOY
deployment controller, the\n\t\t\tservice is required to use either an Application Load Balancer or Network Load Balancer. When creating an AWS CodeDeploy deployment\n\t\t\tgroup, you specify two target groups (referred to as a targetGroupPair
).\n\t\t\tDuring a deployment, AWS CodeDeploy determines which task set in your service has the status\n\t\t\t\tPRIMARY
and associates one target group with it, and then associates\n\t\t\tthe other target group with the replacement task set. The load balancer can also have up\n\t\t\tto two listeners: a required listener for production traffic and an optional listener\n\t\t\tthat allows you perform validation tests with Lambda functions before routing production\n\t\t\ttraffic to it.
After you create a service using the ECS
deployment controller, the load\n\t\t\tbalancer name or target group ARN, container name, and container port specified in the\n\t\t\tservice definition are immutable. If you are using the CODE_DEPLOY
\n\t\t\tdeployment 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,\n\t\t\tthe container name (as it appears in a container definition), and the container port to\n\t\t\taccess from the load balancer. The load balancer name parameter must be omitted. When a\n\t\t\ttask from this service is placed on a container instance, the container instance and\n\t\t\tport combination is registered as a target in the target group specified here.
\n\t\tFor Classic Load Balancers, this object must contain the load balancer name, the container name (as it\n\t\t\tappears in a container definition), and the container port to access from the load\n\t\t\tbalancer. The target group ARN parameter must be omitted. When a task from this service\n\t\t\tis placed on a container instance, the container instance is registered with the load\n\t\t\tbalancer specified here.
\n\t\tServices with tasks that use the awsvpc
network mode (for example, those\n\t\t\twith the Fargate launch type) only support Application Load Balancers and Network Load Balancers. Classic Load Balancers are\n\t\t\tnot supported. Also, when you create any target groups for these services, you must\n\t\t\tchoose ip
as the target type, not instance
, because tasks that\n\t\t\tuse the awsvpc
network mode are associated with an elastic network\n\t\t\tinterface, not an Amazon EC2 instance.
The details of the service discovery registry to associate with this service. For more\n\t\t\tinformation, see Service\n\t\t\t\tdiscovery.
\n\t\tEach service may be associated with one service registry. Multiple service\n\t\t\t\tregistries per service isn't supported.
\n\t\tThe number of instantiations of the specified task definition to place and keep\n\t\t\trunning on your cluster.
\n\t\tThis is required if schedulingStrategy
is REPLICA
or is not\n\t\t\tspecified. If schedulingStrategy
is DAEMON
then this is not\n\t\t\trequired.
Unique, case-sensitive identifier that you provide to ensure the idempotency of the\n\t\t\trequest. Up to 32 ASCII characters are allowed.
" } }, "launchType": { "target": "com.amazonaws.ecs#LaunchType", "traits": { "smithy.api#documentation": "The launch type on which to run your service. The accepted values are\n\t\t\t\tFARGATE
and EC2
. For more information, see Amazon ECS\n\t\t\t\tlaunch types in the Amazon Elastic Container Service Developer Guide.
When a value of FARGATE
is specified, your tasks are launched on\n\t\t\tAWS Fargate On-Demand infrastructure. To use Fargate Spot, you must use a capacity\n\t\t\tprovider strategy with the FARGATE_SPOT
capacity provider.
When a value of EC2
is specified, your tasks are launched on Amazon EC2\n\t\t\tinstances registered to your cluster.
If a launchType
is specified, the capacityProviderStrategy
\n\t\t\tparameter must be omitted.
The capacity provider strategy to use for the service.
\n\t\tIf a capacityProviderStrategy
is specified, the launchType
\n\t\t\tparameter must be omitted. If no capacityProviderStrategy
or\n\t\t\t\tlaunchType
is specified, the\n\t\t\t\tdefaultCapacityProviderStrategy
for the cluster is used.
The platform version that your tasks in the service are running on. A platform version\n\t\t\tis specified only for tasks using the Fargate launch type. If one isn't\n\t\t\tspecified, the LATEST
platform version is used by default. For more\n\t\t\tinformation, see AWS Fargate platform\n\t\t\t\tversions in the Amazon Elastic Container Service Developer Guide.
The name or full Amazon Resource Name (ARN) of the IAM role that allows Amazon ECS to make calls to your\n\t\t\tload balancer on your behalf. This parameter is only permitted if you are using a load\n\t\t\tbalancer with your service and your task definition does not use the awsvpc
\n\t\t\tnetwork mode. If you specify the role
parameter, you must also specify a\n\t\t\tload balancer object with the loadBalancers
parameter.
If your account has already created the Amazon ECS service-linked role, that role is\n\t\t\t\tused by default for your service unless you specify a role here. The service-linked\n\t\t\t\trole is required if your task definition uses the awsvpc
network mode\n\t\t\t\tor if the service is configured to use service discovery, an external deployment\n\t\t\t\tcontroller, multiple target groups, or Elastic Inference accelerators in which case\n\t\t\t\tyou should not specify a role here. For more information, see Using\n\t\t\t\t\tservice-linked roles for Amazon ECS in the\n\t\t\t\t\tAmazon Elastic Container Service Developer Guide.
If your specified role has a path other than /
, then you must either\n\t\t\tspecify the full role ARN (this is recommended) or prefix the role name with the path.\n\t\t\tFor example, if a role with the name bar
has a path of /foo/
\n\t\t\tthen you would specify /foo/bar
as the role name. For more information, see\n\t\t\t\tFriendly names and paths in the IAM User Guide.
Optional deployment parameters that control how many tasks run during the deployment\n\t\t\tand the ordering of stopping and starting tasks.
" } }, "placementConstraints": { "target": "com.amazonaws.ecs#PlacementConstraints", "traits": { "smithy.api#documentation": "An array of placement constraint objects to use for tasks in your service. You can\n\t\t\tspecify a maximum of 10 constraints per task (this limit includes constraints in the\n\t\t\ttask definition and those specified at runtime).
" } }, "placementStrategy": { "target": "com.amazonaws.ecs#PlacementStrategies", "traits": { "smithy.api#documentation": "The placement strategy objects to use for tasks in your service. You can specify a\n\t\t\tmaximum of five strategy rules per service.
" } }, "networkConfiguration": { "target": "com.amazonaws.ecs#NetworkConfiguration", "traits": { "smithy.api#documentation": "The network configuration for the service. This parameter is required for task\n\t\t\tdefinitions that use the awsvpc
network mode to receive their own elastic\n\t\t\tnetwork interface, and it is not supported for other network modes. For more\n\t\t\tinformation, see Task networking\n\t\t\tin the Amazon Elastic Container Service Developer Guide.
The period of time, in seconds, that the Amazon ECS service scheduler should ignore\n\t\t\tunhealthy Elastic Load Balancing target health checks after a task has first started. This is only used\n\t\t\twhen your service is configured to use a load balancer. If your service has a load\n\t\t\tbalancer defined and you don't specify a health check grace period value, the default\n\t\t\tvalue of 0
is used.
If your service's tasks take a while to start and respond to Elastic Load Balancing health checks, you\n\t\t\tcan specify a health check grace period of up to 2,147,483,647 seconds. During that\n\t\t\ttime, the Amazon ECS service scheduler ignores health check status. This grace period can\n\t\t\tprevent the service scheduler from marking tasks as unhealthy and stopping them before\n\t\t\tthey have time to come up.
" } }, "schedulingStrategy": { "target": "com.amazonaws.ecs#SchedulingStrategy", "traits": { "smithy.api#documentation": "The scheduling strategy to use for the service. For more information, see Services.
\n\t\tThere are two service scheduler strategies available:
\n\t\t\n REPLICA
-The replica scheduling strategy places and\n\t\t\t\t\tmaintains the desired number of tasks across your cluster. By default, the\n\t\t\t\t\tservice scheduler spreads tasks across Availability Zones. You can use task\n\t\t\t\t\tplacement strategies and constraints to customize task placement decisions. This\n\t\t\t\t\tscheduler strategy is required if the service is using the\n\t\t\t\t\t\tCODE_DEPLOY
or EXTERNAL
deployment controller\n\t\t\t\t\ttypes.
\n DAEMON
-The daemon scheduling strategy deploys exactly one\n\t\t\t\t\ttask on each active container instance that meets all of the task placement\n\t\t\t\t\tconstraints that you specify in your cluster. The service scheduler also\n\t\t\t\t\tevaluates the task placement constraints for running tasks and will stop tasks\n\t\t\t\t\tthat do not meet the placement constraints. When you're using this strategy, you\n\t\t\t\t\tdon't need to specify a desired number of tasks, a task placement strategy, or\n\t\t\t\t\tuse Service Auto Scaling policies.
Tasks using the Fargate launch type or the\n\t\t\t\t\t\t\tCODE_DEPLOY
or EXTERNAL
deployment controller\n\t\t\t\t\t\ttypes don't support the DAEMON
scheduling strategy.
The deployment controller to use for the service. If no deployment controller is\n\t\t\tspecified, the default value of ECS
is used.
The metadata that you apply to the service to help you categorize and organize them.\n\t\t\tEach tag consists of a key and an optional value, both of which you define. When a\n\t\t\tservice is deleted, the tags are deleted as well.
\nThe following basic restrictions apply to tags:
\nMaximum number of tags per resource - 50
\nFor each resource, each tag key must be unique, and each tag key can have only\n one value.
\nMaximum key length - 128 Unicode characters in UTF-8
\nMaximum value length - 256 Unicode characters in UTF-8
\nIf your tagging schema is used across multiple services and resources,\n remember that other services may have restrictions on allowed characters.\n Generally allowed characters are: letters, numbers, and spaces representable in\n UTF-8, and the following characters: + - = . _ : / @.
\nTag keys and values are case-sensitive.
\nDo not use aws:
, AWS:
, or any upper or lowercase\n combination of such as a prefix for either keys or values as it is reserved for\n AWS use. You cannot edit or delete tag keys or values with this prefix. Tags with\n this prefix do not count against your tags per resource limit.
Specifies whether to enable Amazon ECS managed tags for the tasks within the service. For\n\t\t\tmore information, see Tagging Your Amazon ECS\n\t\t\t\tResources in the Amazon Elastic Container Service Developer Guide.
" } }, "propagateTags": { "target": "com.amazonaws.ecs#PropagateTags", "traits": { "smithy.api#documentation": "Specifies whether to propagate the tags from the task definition or the service to the\n\t\t\ttasks in the service. If no value is specified, the tags are not propagated. Tags can\n\t\t\tonly be propagated to the tasks within the service during service creation. To add tags\n\t\t\tto a task after service creation, use the TagResource API\n\t\t\taction.
" } }, "enableExecuteCommand": { "target": "com.amazonaws.ecs#Boolean", "traits": { "smithy.api#documentation": "Whether or not the execute command functionality is enabled for the service. If\n\t\t\t\ttrue
, this enables execute command functionality on all containers in\n\t\t\tthe service tasks.
The full description of your service following the create call.
\n\t\tIf a service is using the ECS
deployment controller, the\n\t\t\t\tdeploymentController
and taskSets
parameters will not be\n\t\t\treturned.
If the service is using the CODE_DEPLOY
deployment controller, the\n\t\t\t\tdeploymentController
, taskSets
and\n\t\t\t\tdeployments
parameters will be returned, however the\n\t\t\t\tdeployments
parameter will be an empty list.
Create a task set in the specified cluster and service. This is used when a service\n\t\t\tuses the EXTERNAL
deployment controller type. For more information, see\n\t\t\t\tAmazon ECS Deployment\n\t\t\t\tTypes in the Amazon Elastic Container Service Developer Guide.
The short name or full Amazon Resource Name (ARN) of the service to create the task set in.
", "smithy.api#required": {} } }, "cluster": { "target": "com.amazonaws.ecs#String", "traits": { "smithy.api#documentation": "The short name or full Amazon Resource Name (ARN) of the cluster that hosts the service to create the\n\t\t\ttask set in.
", "smithy.api#required": {} } }, "externalId": { "target": "com.amazonaws.ecs#String", "traits": { "smithy.api#documentation": "An optional non-unique tag that identifies this task set in external systems. If the\n\t\t\ttask set is associated with a service discovery registry, the tasks in this task set\n\t\t\twill have the ECS_TASK_SET_EXTERNAL_ID
AWS Cloud Map attribute set to the provided\n\t\t\tvalue.
The task definition for the tasks in the task set to use.
", "smithy.api#required": {} } }, "networkConfiguration": { "target": "com.amazonaws.ecs#NetworkConfiguration", "traits": { "smithy.api#documentation": "An object representing the network configuration for a task set.
" } }, "loadBalancers": { "target": "com.amazonaws.ecs#LoadBalancers", "traits": { "smithy.api#documentation": "A load balancer object representing the load balancer to use with the task set. The\n\t\t\tsupported load balancer types are either an Application Load Balancer or a Network Load Balancer.
" } }, "serviceRegistries": { "target": "com.amazonaws.ecs#ServiceRegistries", "traits": { "smithy.api#documentation": "The details of the service discovery registries to assign to this task set. For more\n\t\t\tinformation, see Service\n\t\t\t\tDiscovery.
" } }, "launchType": { "target": "com.amazonaws.ecs#LaunchType", "traits": { "smithy.api#documentation": "The launch type that new tasks in the task set will use. For more information, see\n\t\t\t\tAmazon ECS Launch Types in the Amazon Elastic Container Service Developer Guide.
\n\t\tIf a launchType
is specified, the capacityProviderStrategy
\n\t\t\tparameter must be omitted.
The capacity provider strategy to use for the task set.
\n\t\tA capacity provider strategy consists of one or more capacity providers along with the\n\t\t\t\tbase
and weight
to assign to them. A capacity provider\n\t\t\tmust be associated with the cluster to be used in a capacity provider strategy. The\n\t\t\t\tPutClusterCapacityProviders API is used to associate a capacity\n\t\t\tprovider with a cluster. Only capacity providers with an ACTIVE
or\n\t\t\t\tUPDATING
status can be used.
If a capacityProviderStrategy
is specified, the launchType
\n\t\t\tparameter must be omitted. If no capacityProviderStrategy
or\n\t\t\t\tlaunchType
is specified, the\n\t\t\t\tdefaultCapacityProviderStrategy
for the cluster is used.
If specifying a capacity provider that uses an Auto Scaling group, the capacity\n\t\t\tprovider must already be created. New capacity providers can be created with the CreateCapacityProvider API operation.
\n\t\tTo use a AWS Fargate capacity provider, specify either the FARGATE
or\n\t\t\t\tFARGATE_SPOT
capacity providers. The AWS Fargate capacity providers are\n\t\t\tavailable to all accounts and only need to be associated with a cluster to be\n\t\t\tused.
The PutClusterCapacityProviders API operation is used to update the\n\t\t\tlist of available capacity providers for a cluster after the cluster is created.
" } }, "platformVersion": { "target": "com.amazonaws.ecs#String", "traits": { "smithy.api#documentation": "The platform version that the tasks in the task set should use. A platform version is\n\t\t\tspecified only for tasks using the Fargate launch type. If one isn't\n\t\t\tspecified, the LATEST
platform version is used by default.
A floating-point percentage of the desired number of tasks to place and keep running\n\t\t\tin the task set.
" } }, "clientToken": { "target": "com.amazonaws.ecs#String", "traits": { "smithy.api#documentation": "Unique, case-sensitive identifier that you provide to ensure the idempotency of the\n\t\t\trequest. Up to 32 ASCII characters are allowed.
" } }, "tags": { "target": "com.amazonaws.ecs#Tags", "traits": { "smithy.api#documentation": "The metadata that you apply to the task set to help you categorize and organize them.\n\t\t\tEach tag consists of a key and an optional value, both of which you define. When a\n\t\t\tservice is deleted, the tags are deleted as well.
\nThe following basic restrictions apply to tags:
\nMaximum number of tags per resource - 50
\nFor each resource, each tag key must be unique, and each tag key can have only\n one value.
\nMaximum key length - 128 Unicode characters in UTF-8
\nMaximum value length - 256 Unicode characters in UTF-8
\nIf your tagging schema is used across multiple services and resources,\n remember that other services may have restrictions on allowed characters.\n Generally allowed characters are: letters, numbers, and spaces representable in\n UTF-8, and the following characters: + - = . _ : / @.
\nTag keys and values are case-sensitive.
\nDo not use aws:
, AWS:
, or any upper or lowercase\n combination of such as a prefix for either keys or values as it is reserved for\n AWS use. You cannot edit or delete tag keys or values with this prefix. Tags with\n this prefix do not count against your tags per resource limit.
Information about a set of Amazon ECS tasks in either an AWS CodeDeploy or an\n\t\t\t\tEXTERNAL
deployment. A task set includes details such as the desired\n\t\t\tnumber of tasks, how many tasks are running, and whether the task set serves production\n\t\t\ttraffic.
Disables an account setting for a specified IAM user, IAM role, or the root user for\n\t\t\tan account.
" } }, "com.amazonaws.ecs#DeleteAccountSettingRequest": { "type": "structure", "members": { "name": { "target": "com.amazonaws.ecs#SettingName", "traits": { "smithy.api#documentation": "The resource name for which to disable the account setting. If\n\t\t\t\tserviceLongArnFormat
is specified, the ARN for your Amazon ECS services is\n\t\t\taffected. If taskLongArnFormat
is specified, the ARN and resource ID for\n\t\t\tyour Amazon ECS tasks is affected. If containerInstanceLongArnFormat
is\n\t\t\tspecified, the ARN and resource ID for your Amazon ECS container instances is affected. If\n\t\t\t\tawsvpcTrunking
is specified, the ENI limit for your Amazon ECS container\n\t\t\tinstances is affected.
The ARN of the principal, which can be an IAM user, IAM role, or the root user. If you\n\t\t\tspecify the root user, it disables the account setting for all IAM users, IAM roles, and\n\t\t\tthe root user of the account unless an IAM user or role explicitly overrides these\n\t\t\tsettings. If this field is omitted, the setting is changed only for the authenticated\n\t\t\tuser.
" } } } }, "com.amazonaws.ecs#DeleteAccountSettingResponse": { "type": "structure", "members": { "setting": { "target": "com.amazonaws.ecs#Setting", "traits": { "smithy.api#documentation": "The account setting for the specified principal ARN.
" } } } }, "com.amazonaws.ecs#DeleteAttributes": { "type": "operation", "input": { "target": "com.amazonaws.ecs#DeleteAttributesRequest" }, "output": { "target": "com.amazonaws.ecs#DeleteAttributesResponse" }, "errors": [ { "target": "com.amazonaws.ecs#ClusterNotFoundException" }, { "target": "com.amazonaws.ecs#InvalidParameterException" }, { "target": "com.amazonaws.ecs#TargetNotFoundException" } ], "traits": { "smithy.api#documentation": "Deletes one or more custom attributes from an Amazon ECS resource.
" } }, "com.amazonaws.ecs#DeleteAttributesRequest": { "type": "structure", "members": { "cluster": { "target": "com.amazonaws.ecs#String", "traits": { "smithy.api#documentation": "The short name or full Amazon Resource Name (ARN) of the cluster that contains the resource to delete\n\t\t\tattributes. If you do not specify a cluster, the default cluster is assumed.
" } }, "attributes": { "target": "com.amazonaws.ecs#Attributes", "traits": { "smithy.api#documentation": "The attributes to delete from your resource. You can specify up to 10 attributes per\n\t\t\trequest. For custom attributes, specify the attribute name and target ID, but do not\n\t\t\tspecify the value. If you specify the target ID using the short form, you must also\n\t\t\tspecify the target type.
", "smithy.api#required": {} } } } }, "com.amazonaws.ecs#DeleteAttributesResponse": { "type": "structure", "members": { "attributes": { "target": "com.amazonaws.ecs#Attributes", "traits": { "smithy.api#documentation": "A list of attribute objects that were successfully deleted from your resource.
" } } } }, "com.amazonaws.ecs#DeleteCapacityProvider": { "type": "operation", "input": { "target": "com.amazonaws.ecs#DeleteCapacityProviderRequest" }, "output": { "target": "com.amazonaws.ecs#DeleteCapacityProviderResponse" }, "errors": [ { "target": "com.amazonaws.ecs#ClientException" }, { "target": "com.amazonaws.ecs#InvalidParameterException" }, { "target": "com.amazonaws.ecs#ServerException" } ], "traits": { "smithy.api#documentation": "Deletes the specified capacity provider.
\n\t\tThe FARGATE
and FARGATE_SPOT
capacity providers are\n\t\t\t\treserved and cannot be deleted. You can disassociate them from a cluster using\n\t\t\t\teither the PutClusterCapacityProviders API or by deleting the\n\t\t\t\tcluster.
Prior to a capacity provider being deleted, the capacity provider must be removed from\n\t\t\tthe capacity provider strategy from all services. The UpdateService\n\t\t\tAPI can be used to remove a capacity provider from a service's capacity provider\n\t\t\tstrategy. When updating a service, the forceNewDeployment
option can be\n\t\t\tused to ensure that any tasks using the Amazon EC2 instance capacity provided by the capacity\n\t\t\tprovider are transitioned to use the capacity from the remaining capacity providers.\n\t\t\tOnly capacity providers that are not associated with a cluster can be deleted. To remove\n\t\t\ta capacity provider from a cluster, you can either use PutClusterCapacityProviders or delete the cluster.
The short name or full Amazon Resource Name (ARN) of the capacity provider to delete.
", "smithy.api#required": {} } } } }, "com.amazonaws.ecs#DeleteCapacityProviderResponse": { "type": "structure", "members": { "capacityProvider": { "target": "com.amazonaws.ecs#CapacityProvider", "traits": { "smithy.api#documentation": "The details of the capacity provider.
" } } } }, "com.amazonaws.ecs#DeleteCluster": { "type": "operation", "input": { "target": "com.amazonaws.ecs#DeleteClusterRequest" }, "output": { "target": "com.amazonaws.ecs#DeleteClusterResponse" }, "errors": [ { "target": "com.amazonaws.ecs#ClientException" }, { "target": "com.amazonaws.ecs#ClusterContainsContainerInstancesException" }, { "target": "com.amazonaws.ecs#ClusterContainsServicesException" }, { "target": "com.amazonaws.ecs#ClusterContainsTasksException" }, { "target": "com.amazonaws.ecs#ClusterNotFoundException" }, { "target": "com.amazonaws.ecs#InvalidParameterException" }, { "target": "com.amazonaws.ecs#ServerException" }, { "target": "com.amazonaws.ecs#UpdateInProgressException" } ], "traits": { "smithy.api#documentation": "Deletes the specified cluster. The cluster will transition to the\n\t\t\t\tINACTIVE
state. Clusters with an INACTIVE
status may\n\t\t\tremain discoverable in your account for a period of time. However, this behavior is\n\t\t\tsubject to change in the future, so you should not rely on INACTIVE
\n\t\t\tclusters persisting.
You must deregister all container instances from this cluster before you may delete\n\t\t\tit. You can list the container instances in a cluster with ListContainerInstances and deregister them with DeregisterContainerInstance.
" } }, "com.amazonaws.ecs#DeleteClusterRequest": { "type": "structure", "members": { "cluster": { "target": "com.amazonaws.ecs#String", "traits": { "smithy.api#documentation": "The short name or full Amazon Resource Name (ARN) of the cluster to delete.
", "smithy.api#required": {} } } } }, "com.amazonaws.ecs#DeleteClusterResponse": { "type": "structure", "members": { "cluster": { "target": "com.amazonaws.ecs#Cluster", "traits": { "smithy.api#documentation": "The full description of the deleted cluster.
" } } } }, "com.amazonaws.ecs#DeleteService": { "type": "operation", "input": { "target": "com.amazonaws.ecs#DeleteServiceRequest" }, "output": { "target": "com.amazonaws.ecs#DeleteServiceResponse" }, "errors": [ { "target": "com.amazonaws.ecs#ClientException" }, { "target": "com.amazonaws.ecs#ClusterNotFoundException" }, { "target": "com.amazonaws.ecs#InvalidParameterException" }, { "target": "com.amazonaws.ecs#ServerException" }, { "target": "com.amazonaws.ecs#ServiceNotFoundException" } ], "traits": { "smithy.api#documentation": "Deletes a specified service within a cluster. You can delete a service if you have no\n\t\t\trunning tasks in it and the desired task count is zero. If the service is actively\n\t\t\tmaintaining tasks, you cannot delete it, and you must update the service to a desired\n\t\t\ttask count of zero. For more information, see UpdateService.
\n\t\tWhen you delete a service, if there are still running tasks that require cleanup,\n\t\t\t\tthe service status moves from ACTIVE
to DRAINING
, and the\n\t\t\t\tservice is no longer visible in the console or in the ListServices\n\t\t\t\tAPI operation. After all tasks have transitioned to either STOPPING
or\n\t\t\t\t\tSTOPPED
status, the service status moves from DRAINING
\n\t\t\t\tto INACTIVE
. Services in the DRAINING
or\n\t\t\t\t\tINACTIVE
status can still be viewed with the DescribeServices API operation. However, in the future,\n\t\t\t\t\tINACTIVE
services may be cleaned up and purged from Amazon ECS record\n\t\t\t\tkeeping, and DescribeServices calls on those services return a\n\t\t\t\t\tServiceNotFoundException
error.
If you attempt to create a new service with the same name as an existing service\n\t\t\t\tin either ACTIVE
or DRAINING
status, you receive an\n\t\t\t\terror.
The short name or full Amazon Resource Name (ARN) of the cluster that hosts the service to delete.\n\t\t\tIf you do not specify a cluster, the default cluster is assumed.
" } }, "service": { "target": "com.amazonaws.ecs#String", "traits": { "smithy.api#documentation": "The name of the service to delete.
", "smithy.api#required": {} } }, "force": { "target": "com.amazonaws.ecs#BoxedBoolean", "traits": { "smithy.api#documentation": "If true
, allows you to delete a service even if it has not been scaled\n\t\t\tdown to zero tasks. It is only necessary to use this if the service is using the\n\t\t\t\tREPLICA
scheduling strategy.
The full description of the deleted service.
" } } } }, "com.amazonaws.ecs#DeleteTaskSet": { "type": "operation", "input": { "target": "com.amazonaws.ecs#DeleteTaskSetRequest" }, "output": { "target": "com.amazonaws.ecs#DeleteTaskSetResponse" }, "errors": [ { "target": "com.amazonaws.ecs#AccessDeniedException" }, { "target": "com.amazonaws.ecs#ClientException" }, { "target": "com.amazonaws.ecs#ClusterNotFoundException" }, { "target": "com.amazonaws.ecs#InvalidParameterException" }, { "target": "com.amazonaws.ecs#ServerException" }, { "target": "com.amazonaws.ecs#ServiceNotActiveException" }, { "target": "com.amazonaws.ecs#ServiceNotFoundException" }, { "target": "com.amazonaws.ecs#TaskSetNotFoundException" }, { "target": "com.amazonaws.ecs#UnsupportedFeatureException" } ], "traits": { "smithy.api#documentation": "Deletes a specified task set within a service. This is used when a service uses the\n\t\t\t\tEXTERNAL
deployment controller type. For more information, see Amazon ECS Deployment Types in the Amazon Elastic Container Service Developer Guide.
The short name or full Amazon Resource Name (ARN) of the cluster that hosts the service that the task\n\t\t\tset exists in to delete.
", "smithy.api#required": {} } }, "service": { "target": "com.amazonaws.ecs#String", "traits": { "smithy.api#documentation": "The short name or full Amazon Resource Name (ARN) of the service that hosts the task set to\n\t\t\tdelete.
", "smithy.api#required": {} } }, "taskSet": { "target": "com.amazonaws.ecs#String", "traits": { "smithy.api#documentation": "The task set ID or full Amazon Resource Name (ARN) of the task set to delete.
", "smithy.api#required": {} } }, "force": { "target": "com.amazonaws.ecs#BoxedBoolean", "traits": { "smithy.api#documentation": "If true
, this allows you to delete a task set even if it hasn't been\n\t\t\tscaled down to zero.
Details about the task set.
" } } } }, "com.amazonaws.ecs#Deployment": { "type": "structure", "members": { "id": { "target": "com.amazonaws.ecs#String", "traits": { "smithy.api#documentation": "The ID of the deployment.
" } }, "status": { "target": "com.amazonaws.ecs#String", "traits": { "smithy.api#documentation": "The status of the deployment. The following describes each state:
\n\t\tThe most recent deployment of a service.
\n\t\t\t\tA service deployment that still has running tasks, but are in the process\n\t\t\t\t\t\tof being replaced with a new PRIMARY
deployment.
A deployment that has been completely replaced.
\n\t\t\t\tThe most recent task definition that was specified for the tasks in the service to\n\t\t\tuse.
" } }, "desiredCount": { "target": "com.amazonaws.ecs#Integer", "traits": { "smithy.api#documentation": "The most recent desired count of tasks that was specified for the service to deploy or\n\t\t\tmaintain.
" } }, "pendingCount": { "target": "com.amazonaws.ecs#Integer", "traits": { "smithy.api#documentation": "The number of tasks in the deployment that are in the PENDING
\n\t\t\tstatus.
The number of tasks in the deployment that are in the RUNNING
\n\t\t\tstatus.
The number of consecutively failed tasks in the deployment. A task is considered a\n\t\t\tfailure if the service scheduler can't launch the task, the task doesn't transition to a\n\t\t\t\tRUNNING
state, or if it fails any of its defined health checks and is\n\t\t\tstopped.
Once a service deployment has one or more successfully running tasks, the failed\n\t\t\t\ttask count resets to zero and stops being evaluated.
\n\t\tThe Unix timestamp for when the service deployment was created.
" } }, "updatedAt": { "target": "com.amazonaws.ecs#Timestamp", "traits": { "smithy.api#documentation": "The Unix timestamp for when the service deployment was last updated.
" } }, "capacityProviderStrategy": { "target": "com.amazonaws.ecs#CapacityProviderStrategy", "traits": { "smithy.api#documentation": "The capacity provider strategy that the deployment is using.
" } }, "launchType": { "target": "com.amazonaws.ecs#LaunchType", "traits": { "smithy.api#documentation": "The launch type the tasks in the service are using. For more information, see Amazon ECS\n\t\t\t\tLaunch Types in the Amazon Elastic Container Service Developer Guide.
" } }, "platformVersion": { "target": "com.amazonaws.ecs#String", "traits": { "smithy.api#documentation": "The platform version on which your tasks in the service are running. A platform\n\t\t\tversion is only specified for tasks using the Fargate launch type. If one\n\t\t\tis not specified, the LATEST
platform version is used by default. For more\n\t\t\tinformation, see AWS Fargate Platform\n\t\t\t\tVersions in the Amazon Elastic Container Service Developer Guide.
The VPC subnet and security group configuration for tasks that receive their own\n elastic network interface by using the awsvpc
networking mode.
The rolloutState
of a service is only returned for services that use\n\t\t\t\tthe rolling update (ECS
) deployment type that are not behind a\n\t\t\t\tClassic Load Balancer.
The rollout state of the deployment. When a service deployment is started, it begins\n\t\t\tin an IN_PROGRESS
state. When the service reaches a steady state, the\n\t\t\tdeployment will transition to a COMPLETED
state. If the service fails to\n\t\t\treach a steady state and circuit breaker is enabled, the deployment will transition to a\n\t\t\t\tFAILED
state. A deployment in FAILED
state will launch no\n\t\t\tnew tasks. For more information, see DeploymentCircuitBreaker.
A description of the rollout state of a deployment.
" } } }, "traits": { "smithy.api#documentation": "The details of an Amazon ECS service deployment. This is used only when a service uses the\n\t\t\t\tECS
deployment controller type.
Whether to enable the deployment circuit breaker logic for the service.
", "smithy.api#required": {} } }, "rollback": { "target": "com.amazonaws.ecs#Boolean", "traits": { "smithy.api#documentation": "Whether to enable Amazon ECS to roll back the service if a service deployment fails. If\n\t\t\trollback is enabled, when a service deployment fails, the service is rolled back to the\n\t\t\tlast deployment that completed successfully.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "The deployment circuit breaker can only be used for services using the rolling\n\t\t\t\tupdate (ECS
) deployment type that are not behind a Classic Load Balancer.
The deployment circuit breaker determines whether a\n\t\t\tservice deployment will fail if the service can't reach a steady state. If enabled, a\n\t\t\tservice deployment will transition to a failed state and stop launching new tasks. You\n\t\t\tcan also enable Amazon ECS to roll back your service to the last completed deployment after a\n\t\t\tfailure. For more information, see Rolling\n\t\t\t\tupdate in the Amazon Elastic Container Service Developer Guide.
" } }, "com.amazonaws.ecs#DeploymentConfiguration": { "type": "structure", "members": { "deploymentCircuitBreaker": { "target": "com.amazonaws.ecs#DeploymentCircuitBreaker", "traits": { "smithy.api#documentation": "The deployment circuit breaker can only be used for services using the rolling\n\t\t\t\tupdate (ECS
) deployment type.
The deployment circuit breaker determines whether a\n\t\t\tservice deployment will fail if the service can't reach a steady state. If deployment\n\t\t\tcircuit breaker is enabled, a service deployment will transition to a failed state and\n\t\t\tstop launching new tasks. If rollback is enabled, when a service deployment fails, the\n\t\t\tservice is rolled back to the last deployment that completed successfully.
" } }, "maximumPercent": { "target": "com.amazonaws.ecs#BoxedInteger", "traits": { "smithy.api#documentation": "If a service is using the rolling update (ECS
) deployment type, the\n\t\t\t\tmaximum percent parameter represents an upper limit\n\t\t\ton the number of tasks in a service that are allowed in the RUNNING
or\n\t\t\t\tPENDING
state during a deployment, as a percentage of the desired\n\t\t\tnumber of tasks (rounded down to the nearest integer), and while any container instances\n\t\t\tare in the DRAINING
state if the service contains tasks using the\n\t\t\tEC2 launch type. This parameter enables you to define the deployment batch\n\t\t\tsize. For example, if your service has a desired number of four tasks and a maximum\n\t\t\tpercent value of 200%, the scheduler may start four new tasks before stopping the four\n\t\t\tolder tasks (provided that the cluster resources required to do this are available). The\n\t\t\tdefault value for maximum percent is 200%.
If a service is using the blue/green (CODE_DEPLOY
) or\n\t\t\t\tEXTERNAL
deployment types and tasks that use the EC2\n\t\t\tlaunch type, the maximum percent value is set to the\n\t\t\tdefault value and is used to define the upper limit on the number of the tasks in the\n\t\t\tservice that remain in the RUNNING
state while the container instances are\n\t\t\tin the DRAINING
state. If the tasks in the service use the\n\t\t\tFargate launch type, the maximum percent value is not used, although it is\n\t\t\treturned when describing your service.
If a service is using the rolling update (ECS
) deployment type, the\n\t\t\t\tminimum healthy percent represents a lower limit on\n\t\t\tthe number of tasks in a service that must remain in the RUNNING
state\n\t\t\tduring a deployment, as a percentage of the desired number of tasks (rounded up to the\n\t\t\tnearest integer), and while any container instances are in the DRAINING
\n\t\t\tstate if the service contains tasks using the EC2 launch type. This\n\t\t\tparameter enables you to deploy without using additional cluster capacity. For example,\n\t\t\tif your service has a desired number of four tasks and a minimum healthy percent of 50%,\n\t\t\tthe scheduler may stop two existing tasks to free up cluster capacity before starting\n\t\t\ttwo new tasks. Tasks for services that do not use a load balancer\n\t\t\tare considered healthy if they are in the RUNNING
state; tasks for services\n\t\t\tthat do use a load balancer are considered healthy if they are in\n\t\t\tthe RUNNING
state and they are reported as healthy by the load balancer.\n\t\t\tThe default value for minimum healthy percent is 100%.
If a service is using the blue/green (CODE_DEPLOY
) or\n\t\t\t\tEXTERNAL
deployment types and tasks that use the EC2\n\t\t\tlaunch type, the minimum healthy percent value is set\n\t\t\tto the default value and is used to define the lower limit on the number of the tasks in\n\t\t\tthe service that remain in the RUNNING
state while the container instances\n\t\t\tare in the DRAINING
state. If the tasks in the service use the\n\t\t\tFargate launch type, the minimum healthy percent value is not used,\n\t\t\talthough it is returned when describing your service.
Optional deployment parameters that control how many tasks run during a deployment and\n\t\t\tthe ordering of stopping and starting tasks.
" } }, "com.amazonaws.ecs#DeploymentController": { "type": "structure", "members": { "type": { "target": "com.amazonaws.ecs#DeploymentControllerType", "traits": { "smithy.api#documentation": "The deployment controller type to use.
\n\t\tThere are three deployment controller types available:
\n\t\tThe rolling update (ECS
) deployment type involves replacing\n\t\t\t\t\t\tthe current running version of the container with the latest version. The\n\t\t\t\t\t\tnumber of containers Amazon ECS adds or removes from the service during a rolling\n\t\t\t\t\t\tupdate is controlled by adjusting the minimum and maximum number of healthy\n\t\t\t\t\t\ttasks allowed during a service deployment, as specified in the DeploymentConfiguration.
The blue/green (CODE_DEPLOY
) deployment type uses the\n\t\t\t\t\t\tblue/green deployment model powered by AWS CodeDeploy, which allows you to verify a\n\t\t\t\t\t\tnew deployment of a service before sending production traffic to it.
The external (EXTERNAL
) deployment type enables you to use\n\t\t\t\t\t\tany third-party deployment controller for full control over the deployment\n\t\t\t\t\t\tprocess for an Amazon ECS service.
The deployment controller to use for the service. For more information, see Amazon ECS Deployment Types in the Amazon Elastic Container Service Developer Guide.
" } }, "com.amazonaws.ecs#DeploymentControllerType": { "type": "string", "traits": { "smithy.api#enum": [ { "value": "ECS", "name": "ECS" }, { "value": "CODE_DEPLOY", "name": "CODE_DEPLOY" }, { "value": "EXTERNAL", "name": "EXTERNAL" } ] } }, "com.amazonaws.ecs#DeploymentRolloutState": { "type": "string", "traits": { "smithy.api#enum": [ { "value": "COMPLETED", "name": "COMPLETED" }, { "value": "FAILED", "name": "FAILED" }, { "value": "IN_PROGRESS", "name": "IN_PROGRESS" } ] } }, "com.amazonaws.ecs#Deployments": { "type": "list", "member": { "target": "com.amazonaws.ecs#Deployment" } }, "com.amazonaws.ecs#DeregisterContainerInstance": { "type": "operation", "input": { "target": "com.amazonaws.ecs#DeregisterContainerInstanceRequest" }, "output": { "target": "com.amazonaws.ecs#DeregisterContainerInstanceResponse" }, "errors": [ { "target": "com.amazonaws.ecs#ClientException" }, { "target": "com.amazonaws.ecs#ClusterNotFoundException" }, { "target": "com.amazonaws.ecs#InvalidParameterException" }, { "target": "com.amazonaws.ecs#ServerException" } ], "traits": { "smithy.api#documentation": "Deregisters an Amazon ECS container instance from the specified cluster. This instance is\n\t\t\tno longer available to run tasks.
\n\t\tIf you intend to use the container instance for some other purpose after\n\t\t\tderegistration, you should stop all of the tasks running on the container instance\n\t\t\tbefore deregistration. That prevents any orphaned tasks from consuming resources.
\n\t\tDeregistering a container instance removes the instance from a cluster, but it does\n\t\t\tnot terminate the EC2 instance. If you are finished using the instance, be sure to\n\t\t\tterminate it in the Amazon EC2 console to stop billing.
\n\t\tIf you terminate a running container instance, Amazon ECS automatically deregisters the\n\t\t\t\tinstance from your cluster (stopped container instances or instances with\n\t\t\t\tdisconnected agents are not automatically deregistered when terminated).
\n\t\tThe short name or full Amazon Resource Name (ARN) of the cluster that hosts the container instance to\n\t\t\tderegister. If you do not specify a cluster, the default cluster is assumed.
" } }, "containerInstance": { "target": "com.amazonaws.ecs#String", "traits": { "smithy.api#documentation": "The container instance ID or full ARN of the container instance to deregister.\n\t\t\tThe ARN contains the arn:aws:ecs
namespace, followed by the Region of the container instance, the AWS account ID of the container instance owner, the container-instance
namespace, and then the container instance ID. For example, arn:aws:ecs:region:aws_account_id:container-instance/container_instance_ID
.
Forces the deregistration of the container instance. If you have tasks running on the\n\t\t\tcontainer instance when you deregister it with the force
option, these\n\t\t\ttasks remain running until you terminate the instance or the tasks stop through some\n\t\t\tother means, but they are orphaned (no longer monitored or accounted for by Amazon ECS). If\n\t\t\tan orphaned task on your container instance is part of an Amazon ECS service, then the\n\t\t\tservice scheduler starts another copy of that task, on a different container instance if\n\t\t\tpossible.
Any containers in orphaned service tasks that are registered with a Classic Load Balancer or an Application Load Balancer\n\t\t\ttarget group are deregistered. They begin connection draining according to the settings\n\t\t\ton the load balancer or target group.
" } } } }, "com.amazonaws.ecs#DeregisterContainerInstanceResponse": { "type": "structure", "members": { "containerInstance": { "target": "com.amazonaws.ecs#ContainerInstance", "traits": { "smithy.api#documentation": "The container instance that was deregistered.
" } } } }, "com.amazonaws.ecs#DeregisterTaskDefinition": { "type": "operation", "input": { "target": "com.amazonaws.ecs#DeregisterTaskDefinitionRequest" }, "output": { "target": "com.amazonaws.ecs#DeregisterTaskDefinitionResponse" }, "errors": [ { "target": "com.amazonaws.ecs#ClientException" }, { "target": "com.amazonaws.ecs#InvalidParameterException" }, { "target": "com.amazonaws.ecs#ServerException" } ], "traits": { "smithy.api#documentation": "Deregisters the specified task definition by family and revision. Upon deregistration,\n\t\t\tthe task definition is marked as INACTIVE
. Existing tasks and services that\n\t\t\treference an INACTIVE
task definition continue to run without disruption.\n\t\t\tExisting services that reference an INACTIVE
task definition can still\n\t\t\tscale up or down by modifying the service's desired count.
You cannot use an INACTIVE
task definition to run new tasks or create new\n\t\t\tservices, and you cannot update an existing service to reference an\n\t\t\t\tINACTIVE
task definition. However, there may be up to a 10-minute\n\t\t\twindow following deregistration where these restrictions have not yet taken\n\t\t\teffect.
At this time, INACTIVE
task definitions remain discoverable in your\n\t\t\t\taccount indefinitely. However, this behavior is subject to change in the future, so\n\t\t\t\tyou should not rely on INACTIVE
task definitions persisting beyond the\n\t\t\t\tlifecycle of any associated tasks and services.
The family
and revision
(family:revision
) or\n\t\t\tfull Amazon Resource Name (ARN) of the task definition to deregister. You must specify a\n\t\t\t\trevision
.
The full description of the deregistered task.
" } } } }, "com.amazonaws.ecs#DescribeCapacityProviders": { "type": "operation", "input": { "target": "com.amazonaws.ecs#DescribeCapacityProvidersRequest" }, "output": { "target": "com.amazonaws.ecs#DescribeCapacityProvidersResponse" }, "errors": [ { "target": "com.amazonaws.ecs#ClientException" }, { "target": "com.amazonaws.ecs#InvalidParameterException" }, { "target": "com.amazonaws.ecs#ServerException" } ], "traits": { "smithy.api#documentation": "Describes one or more of your capacity providers.
" } }, "com.amazonaws.ecs#DescribeCapacityProvidersRequest": { "type": "structure", "members": { "capacityProviders": { "target": "com.amazonaws.ecs#StringList", "traits": { "smithy.api#documentation": "The short name or full Amazon Resource Name (ARN) of one or more capacity providers. Up to\n\t\t\t\t100
capacity providers can be described in an action.
Specifies whether or not you want to see the resource tags for the capacity provider.\n\t\t\tIf TAGS
is specified, the tags are included in the response. If this field\n\t\t\tis omitted, tags are not included in the response.
The maximum number of account setting results returned by\n\t\t\t\tDescribeCapacityProviders
in paginated output. When this parameter is\n\t\t\tused, DescribeCapacityProviders
only returns maxResults
\n\t\t\tresults in a single page along with a nextToken
response element. The\n\t\t\tremaining results of the initial request can be seen by sending another\n\t\t\t\tDescribeCapacityProviders
request with the returned\n\t\t\t\tnextToken
value. This value can be between\n\t\t\t1 and 10. If this\n\t\t\tparameter is not used, then DescribeCapacityProviders
returns up to\n\t\t\t10 results and a nextToken
value\n\t\t\tif applicable.
The nextToken
value returned from a previous paginated\n\t\t\t\tDescribeCapacityProviders
request where maxResults
was\n\t\t\tused and the results exceeded the value of that parameter. Pagination continues from the\n\t\t\tend of the previous results that returned the nextToken
value.
This token should be treated as an opaque identifier that is only used to\n retrieve the next items in a list and not for other programmatic purposes.
\nThe list of capacity providers.
" } }, "failures": { "target": "com.amazonaws.ecs#Failures", "traits": { "smithy.api#documentation": "Any failures associated with the call.
" } }, "nextToken": { "target": "com.amazonaws.ecs#String", "traits": { "smithy.api#documentation": "The nextToken
value to include in a future\n\t\t\t\tDescribeCapacityProviders
request. When the results of a\n\t\t\t\tDescribeCapacityProviders
request exceed maxResults
, this\n\t\t\tvalue can be used to retrieve the next page of results. This value is null
\n\t\t\twhen there are no more results to return.
Describes one or more of your clusters.
" } }, "com.amazonaws.ecs#DescribeClustersRequest": { "type": "structure", "members": { "clusters": { "target": "com.amazonaws.ecs#StringList", "traits": { "smithy.api#documentation": "A list of up to 100 cluster names or full cluster Amazon Resource Name (ARN) entries.\n\t\t\tIf you do not specify a cluster, the default cluster is assumed.
" } }, "include": { "target": "com.amazonaws.ecs#ClusterFieldList", "traits": { "smithy.api#documentation": "Whether to include additional information about your clusters in the response. If this\n\t\t\tfield is omitted, the attachments, statistics, and tags are not included.
\n\t\tIf ATTACHMENTS
is specified, the attachments for the container instances\n\t\t\tor tasks within the cluster are included.
If SETTINGS
is specified, the settings for the cluster are\n\t\t\tincluded.
If STATISTICS
is specified, the following additional information,\n\t\t\tseparated by launch type, is included:
runningEC2TasksCount
\n\t\t\trunningFargateTasksCount
\n\t\t\tpendingEC2TasksCount
\n\t\t\tpendingFargateTasksCount
\n\t\t\tactiveEC2ServiceCount
\n\t\t\tactiveFargateServiceCount
\n\t\t\tdrainingEC2ServiceCount
\n\t\t\tdrainingFargateServiceCount
\n\t\t\tIf TAGS
is specified, the metadata tags associated with the cluster are\n\t\t\tincluded.
The list of clusters.
" } }, "failures": { "target": "com.amazonaws.ecs#Failures", "traits": { "smithy.api#documentation": "Any failures associated with the call.
" } } } }, "com.amazonaws.ecs#DescribeContainerInstances": { "type": "operation", "input": { "target": "com.amazonaws.ecs#DescribeContainerInstancesRequest" }, "output": { "target": "com.amazonaws.ecs#DescribeContainerInstancesResponse" }, "errors": [ { "target": "com.amazonaws.ecs#ClientException" }, { "target": "com.amazonaws.ecs#ClusterNotFoundException" }, { "target": "com.amazonaws.ecs#InvalidParameterException" }, { "target": "com.amazonaws.ecs#ServerException" } ], "traits": { "smithy.api#documentation": "Describes Amazon Elastic Container Service container instances. Returns metadata about registered and\n\t\t\tremaining resources on each container instance requested.
" } }, "com.amazonaws.ecs#DescribeContainerInstancesRequest": { "type": "structure", "members": { "cluster": { "target": "com.amazonaws.ecs#String", "traits": { "smithy.api#documentation": "The short name or full Amazon Resource Name (ARN) of the cluster that hosts the container instances to\n\t\t\tdescribe. If you do not specify a cluster, the default cluster is assumed. This parameter is required if the container instance\n\t\t\tor container instances you are describing were launched in any cluster other than the\n\t\t\tdefault cluster.
" } }, "containerInstances": { "target": "com.amazonaws.ecs#StringList", "traits": { "smithy.api#documentation": "A list of up to 100 container instance IDs or full Amazon Resource Name (ARN) entries.
", "smithy.api#required": {} } }, "include": { "target": "com.amazonaws.ecs#ContainerInstanceFieldList", "traits": { "smithy.api#documentation": "Specifies whether you want to see the resource tags for the container instance. If\n\t\t\t\tTAGS
is specified, the tags are included in the response. If this field\n\t\t\tis omitted, tags are not included in the response.
The list of container instances.
" } }, "failures": { "target": "com.amazonaws.ecs#Failures", "traits": { "smithy.api#documentation": "Any failures associated with the call.
" } } } }, "com.amazonaws.ecs#DescribeServices": { "type": "operation", "input": { "target": "com.amazonaws.ecs#DescribeServicesRequest" }, "output": { "target": "com.amazonaws.ecs#DescribeServicesResponse" }, "errors": [ { "target": "com.amazonaws.ecs#ClientException" }, { "target": "com.amazonaws.ecs#ClusterNotFoundException" }, { "target": "com.amazonaws.ecs#InvalidParameterException" }, { "target": "com.amazonaws.ecs#ServerException" } ], "traits": { "smithy.api#documentation": "Describes the specified services running in your cluster.
", "smithy.waiters#waitable": { "ServicesInactive": { "acceptors": [ { "state": "failure", "matcher": { "output": { "path": "failures[].reason", "expected": "MISSING", "comparator": "anyStringEquals" } } }, { "state": "success", "matcher": { "output": { "path": "services[].status", "expected": "INACTIVE", "comparator": "anyStringEquals" } } } ], "minDelay": 15 } } } }, "com.amazonaws.ecs#DescribeServicesRequest": { "type": "structure", "members": { "cluster": { "target": "com.amazonaws.ecs#String", "traits": { "smithy.api#documentation": "The short name or full Amazon Resource Name (ARN)the cluster that hosts the service to describe.\n\t\t\tIf you do not specify a cluster, the default cluster is assumed. This parameter is required if the service or services you are\n\t\t\tdescribing were launched in any cluster other than the default cluster.
" } }, "services": { "target": "com.amazonaws.ecs#StringList", "traits": { "smithy.api#documentation": "A list of services to describe. You may specify up to 10 services to describe in a\n\t\t\tsingle operation.
", "smithy.api#required": {} } }, "include": { "target": "com.amazonaws.ecs#ServiceFieldList", "traits": { "smithy.api#documentation": "Specifies whether you want to see the resource tags for the service. If\n\t\t\t\tTAGS
is specified, the tags are included in the response. If this field\n\t\t\tis omitted, tags are not included in the response.
The list of services described.
" } }, "failures": { "target": "com.amazonaws.ecs#Failures", "traits": { "smithy.api#documentation": "Any failures associated with the call.
" } } } }, "com.amazonaws.ecs#DescribeTaskDefinition": { "type": "operation", "input": { "target": "com.amazonaws.ecs#DescribeTaskDefinitionRequest" }, "output": { "target": "com.amazonaws.ecs#DescribeTaskDefinitionResponse" }, "errors": [ { "target": "com.amazonaws.ecs#ClientException" }, { "target": "com.amazonaws.ecs#InvalidParameterException" }, { "target": "com.amazonaws.ecs#ServerException" } ], "traits": { "smithy.api#documentation": "Describes a task definition. You can specify a family
and\n\t\t\t\trevision
to find information about a specific task definition, or you\n\t\t\tcan simply specify the family to find the latest ACTIVE
revision in that\n\t\t\tfamily.
You can only describe INACTIVE
task definitions while an active task\n\t\t\t\tor service references them.
The family
for the latest ACTIVE
revision,\n\t\t\t\tfamily
and revision
(family:revision
) for a\n\t\t\tspecific revision in the family, or full Amazon Resource Name (ARN) of the task definition to\n\t\t\tdescribe.
Specifies whether to see the resource tags for the task definition. If\n\t\t\t\tTAGS
is specified, the tags are included in the response. If this field\n\t\t\tis omitted, tags are not included in the response.
The full task definition description.
" } }, "tags": { "target": "com.amazonaws.ecs#Tags", "traits": { "smithy.api#documentation": "The metadata that is applied to the task definition to help you categorize and\n\t\t\torganize them. Each tag consists of a key and an optional value, both of which you\n\t\t\tdefine.
\nThe following basic restrictions apply to tags:
\nMaximum number of tags per resource - 50
\nFor each resource, each tag key must be unique, and each tag key can have only\n one value.
\nMaximum key length - 128 Unicode characters in UTF-8
\nMaximum value length - 256 Unicode characters in UTF-8
\nIf your tagging schema is used across multiple services and resources,\n remember that other services may have restrictions on allowed characters.\n Generally allowed characters are: letters, numbers, and spaces representable in\n UTF-8, and the following characters: + - = . _ : / @.
\nTag keys and values are case-sensitive.
\nDo not use aws:
, AWS:
, or any upper or lowercase\n combination of such as a prefix for either keys or values as it is reserved for\n AWS use. You cannot edit or delete tag keys or values with this prefix. Tags with\n this prefix do not count against your tags per resource limit.
Describes the task sets in the specified cluster and service. This is used when a\n\t\t\tservice uses the EXTERNAL
deployment controller type. For more information,\n\t\t\tsee Amazon ECS Deployment\n\t\t\t\tTypes in the Amazon Elastic Container Service Developer Guide.
The short name or full Amazon Resource Name (ARN) of the cluster that hosts the service that the task\n\t\t\tsets exist in.
", "smithy.api#required": {} } }, "service": { "target": "com.amazonaws.ecs#String", "traits": { "smithy.api#documentation": "The short name or full Amazon Resource Name (ARN) of the service that the task sets exist in.
", "smithy.api#required": {} } }, "taskSets": { "target": "com.amazonaws.ecs#StringList", "traits": { "smithy.api#documentation": "The ID or full Amazon Resource Name (ARN) of task sets to\n\t\t\tdescribe.
" } }, "include": { "target": "com.amazonaws.ecs#TaskSetFieldList", "traits": { "smithy.api#documentation": "Specifies whether to see the resource tags for the task set. If TAGS
is\n\t\t\tspecified, the tags are included in the response. If this field is omitted, tags are not\n\t\t\tincluded in the response.
The list of task sets described.
" } }, "failures": { "target": "com.amazonaws.ecs#Failures", "traits": { "smithy.api#documentation": "Any failures associated with the call.
" } } } }, "com.amazonaws.ecs#DescribeTasks": { "type": "operation", "input": { "target": "com.amazonaws.ecs#DescribeTasksRequest" }, "output": { "target": "com.amazonaws.ecs#DescribeTasksResponse" }, "errors": [ { "target": "com.amazonaws.ecs#ClientException" }, { "target": "com.amazonaws.ecs#ClusterNotFoundException" }, { "target": "com.amazonaws.ecs#InvalidParameterException" }, { "target": "com.amazonaws.ecs#ServerException" } ], "traits": { "smithy.api#documentation": "Describes a specified task or tasks.
", "smithy.waiters#waitable": { "TasksRunning": { "acceptors": [ { "state": "failure", "matcher": { "output": { "path": "tasks[].lastStatus", "expected": "STOPPED", "comparator": "anyStringEquals" } } }, { "state": "failure", "matcher": { "output": { "path": "failures[].reason", "expected": "MISSING", "comparator": "anyStringEquals" } } }, { "state": "success", "matcher": { "output": { "path": "tasks[].lastStatus", "expected": "RUNNING", "comparator": "allStringEquals" } } } ], "minDelay": 6 }, "TasksStopped": { "acceptors": [ { "state": "success", "matcher": { "output": { "path": "tasks[].lastStatus", "expected": "STOPPED", "comparator": "allStringEquals" } } } ], "minDelay": 6 } } } }, "com.amazonaws.ecs#DescribeTasksRequest": { "type": "structure", "members": { "cluster": { "target": "com.amazonaws.ecs#String", "traits": { "smithy.api#documentation": "The short name or full Amazon Resource Name (ARN) of the cluster that hosts the task or tasks to\n\t\t\tdescribe. If you do not specify a cluster, the default cluster is assumed. This parameter is required if the task or tasks you\n\t\t\tare describing were launched in any cluster other than the default cluster.
" } }, "tasks": { "target": "com.amazonaws.ecs#StringList", "traits": { "smithy.api#documentation": "A list of up to 100 task IDs or full ARN entries.
", "smithy.api#required": {} } }, "include": { "target": "com.amazonaws.ecs#TaskFieldList", "traits": { "smithy.api#documentation": "Specifies whether you want to see the resource tags for the task. If TAGS
\n\t\t\tis specified, the tags are included in the response. If this field is omitted, tags are\n\t\t\tnot included in the response.
The list of tasks.
" } }, "failures": { "target": "com.amazonaws.ecs#Failures", "traits": { "smithy.api#documentation": "Any failures associated with the call.
" } } } }, "com.amazonaws.ecs#DesiredStatus": { "type": "string", "traits": { "smithy.api#enum": [ { "value": "RUNNING", "name": "RUNNING" }, { "value": "PENDING", "name": "PENDING" }, { "value": "STOPPED", "name": "STOPPED" } ] } }, "com.amazonaws.ecs#Device": { "type": "structure", "members": { "hostPath": { "target": "com.amazonaws.ecs#String", "traits": { "smithy.api#documentation": "The path for the device on the host container instance.
", "smithy.api#required": {} } }, "containerPath": { "target": "com.amazonaws.ecs#String", "traits": { "smithy.api#documentation": "The path inside the container at which to expose the host device.
" } }, "permissions": { "target": "com.amazonaws.ecs#DeviceCgroupPermissions", "traits": { "smithy.api#documentation": "The explicit permissions to provide to the container for the device. By default, the\n\t\t\tcontainer has permissions for read
, write
, and\n\t\t\t\tmknod
for the device.
An object representing a container instance host device.
" } }, "com.amazonaws.ecs#DeviceCgroupPermission": { "type": "string", "traits": { "smithy.api#enum": [ { "value": "read", "name": "READ" }, { "value": "write", "name": "WRITE" }, { "value": "mknod", "name": "MKNOD" } ] } }, "com.amazonaws.ecs#DeviceCgroupPermissions": { "type": "list", "member": { "target": "com.amazonaws.ecs#DeviceCgroupPermission" } }, "com.amazonaws.ecs#DevicesList": { "type": "list", "member": { "target": "com.amazonaws.ecs#Device" } }, "com.amazonaws.ecs#DiscoverPollEndpoint": { "type": "operation", "input": { "target": "com.amazonaws.ecs#DiscoverPollEndpointRequest" }, "output": { "target": "com.amazonaws.ecs#DiscoverPollEndpointResponse" }, "errors": [ { "target": "com.amazonaws.ecs#ClientException" }, { "target": "com.amazonaws.ecs#ServerException" } ], "traits": { "smithy.api#documentation": "This action is only used by the Amazon ECS agent, and it is not intended for use outside of the agent.
\nReturns an endpoint for\n\t\t\tthe Amazon ECS agent to poll for updates.
" } }, "com.amazonaws.ecs#DiscoverPollEndpointRequest": { "type": "structure", "members": { "containerInstance": { "target": "com.amazonaws.ecs#String", "traits": { "smithy.api#documentation": "The container instance ID or full ARN of the container instance.\n\t\t\tThe ARN contains the arn:aws:ecs
namespace, followed by the Region of the container instance, the AWS account ID of the container instance owner, the container-instance
namespace, and then the container instance ID. For example, arn:aws:ecs:region:aws_account_id:container-instance/container_instance_ID
.
The short name or full Amazon Resource Name (ARN) of the cluster to which the container instance\n\t\t\tbelongs.
" } } } }, "com.amazonaws.ecs#DiscoverPollEndpointResponse": { "type": "structure", "members": { "endpoint": { "target": "com.amazonaws.ecs#String", "traits": { "smithy.api#documentation": "The endpoint for the Amazon ECS agent to poll.
" } }, "telemetryEndpoint": { "target": "com.amazonaws.ecs#String", "traits": { "smithy.api#documentation": "The telemetry endpoint for the Amazon ECS agent.
" } } } }, "com.amazonaws.ecs#DockerLabelsMap": { "type": "map", "key": { "target": "com.amazonaws.ecs#String" }, "value": { "target": "com.amazonaws.ecs#String" } }, "com.amazonaws.ecs#DockerVolumeConfiguration": { "type": "structure", "members": { "scope": { "target": "com.amazonaws.ecs#Scope", "traits": { "smithy.api#documentation": "The scope for the Docker volume that determines its lifecycle. Docker volumes that are\n\t\t\tscoped to a task
are automatically provisioned when the task starts and\n\t\t\tdestroyed when the task stops. Docker volumes that are scoped as shared
\n\t\t\tpersist after the task stops.
If this value is true
, the Docker volume is created if it does not\n\t\t\talready exist.
This field is only used if the scope
is shared
.
The Docker volume driver to use. The driver value must match the driver name provided\n\t\t\tby Docker because it is used for task placement. If the driver was installed using the\n\t\t\tDocker plugin CLI, use docker plugin ls
to retrieve the driver name from\n\t\t\tyour container instance. If the driver was installed using another method, use Docker\n\t\t\tplugin discovery to retrieve the driver name. For more information, see Docker\n\t\t\t\tplugin discovery. This parameter maps to Driver
in the\n\t\t\tCreate a volume section of the Docker Remote API and the\n\t\t\t\txxdriver
option to docker\n\t\t\t\tvolume create.
A map of Docker driver-specific options passed through. This parameter maps to\n\t\t\t\tDriverOpts
in the Create a volume section of the\n\t\t\tDocker Remote API and the xxopt
option to docker\n\t\t\t\tvolume create.
Custom metadata to add to your Docker volume. This parameter maps to\n\t\t\t\tLabels
in the Create a volume section of the\n\t\t\tDocker Remote API and the xxlabel
option to docker\n\t\t\t\tvolume create.
This parameter is specified when you are using Docker volumes. Docker volumes are only\n\t\t\tsupported when you are using the EC2 launch type. Windows containers only\n\t\t\tsupport the use of the local
driver. To use bind mounts, specify a\n\t\t\t\thost
instead.
The Amazon EFS access point ID to use. If an access point is specified, the root directory\n\t\t\tvalue specified in the EFSVolumeConfiguration
must either be omitted or set\n\t\t\tto /
which will enforce the path set on the EFS access point. If an access\n\t\t\tpoint is used, transit encryption must be enabled in the\n\t\t\t\tEFSVolumeConfiguration
. For more information, see Working with Amazon\n\t\t\t\tEFS Access Points in the Amazon Elastic File System User Guide.
Whether or not to use the Amazon ECS task IAM role defined in a task definition when\n\t\t\tmounting the Amazon EFS file system. If enabled, transit encryption must be enabled in the\n\t\t\t\tEFSVolumeConfiguration
. If this parameter is omitted, the default value\n\t\t\tof DISABLED
is used. For more information, see Using\n\t\t\t\tAmazon EFS Access Points in the Amazon Elastic Container Service Developer Guide.
The authorization configuration details for the Amazon EFS file system.
" } }, "com.amazonaws.ecs#EFSAuthorizationConfigIAM": { "type": "string", "traits": { "smithy.api#enum": [ { "value": "ENABLED", "name": "ENABLED" }, { "value": "DISABLED", "name": "DISABLED" } ] } }, "com.amazonaws.ecs#EFSTransitEncryption": { "type": "string", "traits": { "smithy.api#enum": [ { "value": "ENABLED", "name": "ENABLED" }, { "value": "DISABLED", "name": "DISABLED" } ] } }, "com.amazonaws.ecs#EFSVolumeConfiguration": { "type": "structure", "members": { "fileSystemId": { "target": "com.amazonaws.ecs#String", "traits": { "smithy.api#documentation": "The Amazon EFS file system ID to use.
", "smithy.api#required": {} } }, "rootDirectory": { "target": "com.amazonaws.ecs#String", "traits": { "smithy.api#documentation": "The directory within the Amazon EFS file system to mount as the root directory inside the\n\t\t\thost. If this parameter is omitted, the root of the Amazon EFS volume will be used.\n\t\t\tSpecifying /
will have the same effect as omitting this parameter.
If an EFS access point is specified in the authorizationConfig
, the\n\t\t\t\troot directory parameter must either be omitted or set to /
which will\n\t\t\t\tenforce the path set on the EFS access point.
Whether or not to enable encryption for Amazon EFS data in transit between the Amazon ECS host\n\t\t\tand the Amazon EFS server. Transit encryption must be enabled if Amazon EFS IAM authorization is\n\t\t\tused. If this parameter is omitted, the default value of DISABLED
is used.\n\t\t\tFor more information, see Encrypting Data in Transit in\n\t\t\tthe Amazon Elastic File System User Guide.
The port to use when sending encrypted data between the Amazon ECS host and the Amazon EFS\n\t\t\tserver. If you do not specify a transit encryption port, it will use the port selection\n\t\t\tstrategy that the Amazon EFS mount helper uses. For more information, see EFS Mount\n\t\t\t\tHelper in the Amazon Elastic File System User Guide.
" } }, "authorizationConfig": { "target": "com.amazonaws.ecs#EFSAuthorizationConfig", "traits": { "smithy.api#documentation": "The authorization configuration details for the Amazon EFS file system.
" } } }, "traits": { "smithy.api#documentation": "This parameter is specified when you are using an Amazon Elastic File System file system for task\n\t\t\tstorage. For more information, see Amazon EFS Volumes in the\n\t\t\t\tAmazon Elastic Container Service Developer Guide.
" } }, "com.amazonaws.ecs#EnvironmentFile": { "type": "structure", "members": { "value": { "target": "com.amazonaws.ecs#String", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the Amazon S3 object containing the environment\n\t\t\tvariable file.
", "smithy.api#required": {} } }, "type": { "target": "com.amazonaws.ecs#EnvironmentFileType", "traits": { "smithy.api#documentation": "The file type to use. The only supported value is s3
.
A list of files containing the environment variables to pass to a container. You can\n\t\t\tspecify up to ten environment files. The file must have a .env
file\n\t\t\textension. Each line in an environment file should contain an environment variable in\n\t\t\t\tVARIABLE=VALUE
format. Lines beginning with #
are treated\n\t\t\tas comments and are ignored. For more information on the environment variable file\n\t\t\tsyntax, see Declare default\n\t\t\t\tenvironment variables in file.
If there are environment variables specified using the environment
\n\t\t\tparameter in a container definition, they take precedence over the variables contained\n\t\t\twithin an environment file. If multiple environment files are specified that contain the\n\t\t\tsame variable, they are processed from the top down. It is recommended to use unique\n\t\t\tvariable names. For more information, see Specifying environment\n\t\t\t\tvariables in the Amazon Elastic Container Service Developer Guide.
This field is only valid for containers in Fargate tasks that use\n\t\t\tplatform version 1.4.0
or later.
The total amount, in GiB, of ephemeral storage to set for the task. The minimum\n\t\t\tsupported value is 21
GiB and the maximum supported value is\n\t\t\t\t200
GiB.
The amount of ephemeral storage to allocate for the task. This parameter is used to\n\t\t\texpand the total amount of ephemeral storage available, beyond the default amount, for\n\t\t\ttasks hosted on AWS Fargate. For more information, see Fargate task\n\t\t\t\tstorage in the Amazon ECS User Guide for AWS Fargate.
\n\t\tThis parameter is only supported for tasks hosted on AWS Fargate using platform\n\t\t\t\tversion 1.4.0
or later.
Runs a command remotely on a container within a task.
" } }, "com.amazonaws.ecs#ExecuteCommandConfiguration": { "type": "structure", "members": { "kmsKeyId": { "target": "com.amazonaws.ecs#String", "traits": { "smithy.api#documentation": "Specify an AWS Key Management Service key ID to encrypt the data between the local\n\t\t\tclient and the container.
" } }, "logging": { "target": "com.amazonaws.ecs#ExecuteCommandLogging", "traits": { "smithy.api#documentation": "The log setting to use for redirecting logs for your execute command results. The\n\t\t\tfollowing log settings are available.
\n\t\t\n NONE
: The execute command session is not logged.
\n DEFAULT
: The awslogs
configuration in the task\n\t\t\t\t\tdefinition is used. If no logging parameter is specified, it defaults to this\n\t\t\t\t\tvalue. If no awslogs
log driver is configured in the task\n\t\t\t\t\tdefinition, the output won't be logged.
\n OVERRIDE
: Specify the logging details as a part of\n\t\t\t\t\t\tlogConfiguration
. If the OVERRIDE
logging option\n\t\t\t\t\tis specified, the logConfiguration
is required.
The log configuration for the results of the execute command actions. The logs can be\n\t\t\tsent to CloudWatch Logs or an Amazon S3 bucket. When logging=OVERRIDE
is\n\t\t\tspecified, a logConfiguration
must be provided.
The details of the execute command configuration.
" } }, "com.amazonaws.ecs#ExecuteCommandLogConfiguration": { "type": "structure", "members": { "cloudWatchLogGroupName": { "target": "com.amazonaws.ecs#String", "traits": { "smithy.api#documentation": "The name of the CloudWatch log group to send logs to.
\n\t\tThe CloudWatch log group must already be created.
\n\t\tWhether or not to enable encryption on the CloudWatch logs. If not specified,\n\t\t\tencryption will be disabled.
" } }, "s3BucketName": { "target": "com.amazonaws.ecs#String", "traits": { "smithy.api#documentation": "The name of the S3 bucket to send logs to.
\n\t\tThe S3 bucket must already be created.
\n\t\tWhether or not to enable encryption on the CloudWatch logs. If not specified,\n\t\t\tencryption will be disabled.
" } }, "s3KeyPrefix": { "target": "com.amazonaws.ecs#String", "traits": { "smithy.api#documentation": "An optional folder in the S3 bucket to place logs in.
" } } }, "traits": { "smithy.api#documentation": "The log configuration for the results of the execute command actions. The logs can be\n\t\t\tsent to CloudWatch Logs or an Amazon S3 bucket.
" } }, "com.amazonaws.ecs#ExecuteCommandLogging": { "type": "string", "traits": { "smithy.api#enum": [ { "value": "NONE", "name": "NONE" }, { "value": "DEFAULT", "name": "DEFAULT" }, { "value": "OVERRIDE", "name": "OVERRIDE" } ] } }, "com.amazonaws.ecs#ExecuteCommandRequest": { "type": "structure", "members": { "cluster": { "target": "com.amazonaws.ecs#String", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) or short name of the cluster the task is running in.\n\t\t\tIf you do not specify a cluster, the default cluster is assumed.
" } }, "container": { "target": "com.amazonaws.ecs#String", "traits": { "smithy.api#documentation": "The name of the container to execute the command on. A container name only needs to be\n\t\t\tspecified for tasks containing multiple containers.
" } }, "command": { "target": "com.amazonaws.ecs#String", "traits": { "smithy.api#documentation": "The command to run on the container.
", "smithy.api#required": {} } }, "interactive": { "target": "com.amazonaws.ecs#Boolean", "traits": { "smithy.api#documentation": "Use this flag to run your command in interactive mode.
", "smithy.api#required": {} } }, "task": { "target": "com.amazonaws.ecs#String", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) or ID of the task the container is part of.
", "smithy.api#required": {} } } } }, "com.amazonaws.ecs#ExecuteCommandResponse": { "type": "structure", "members": { "clusterArn": { "target": "com.amazonaws.ecs#String", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the cluster.
" } }, "containerArn": { "target": "com.amazonaws.ecs#String", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the container.
" } }, "containerName": { "target": "com.amazonaws.ecs#String", "traits": { "smithy.api#documentation": "The name of the container.
" } }, "interactive": { "target": "com.amazonaws.ecs#Boolean", "traits": { "smithy.api#documentation": "Whether or not the execute command session is running in interactive mode. Amazon ECS only\n\t\t\tsupports initiating interactive sessions, so you must specify true
for this\n\t\t\tvalue.
The details of the SSM session that was created for this instance of\n\t\t\texecute-command.
" } }, "taskArn": { "target": "com.amazonaws.ecs#String", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the task.
" } } } }, "com.amazonaws.ecs#FSxWindowsFileServerAuthorizationConfig": { "type": "structure", "members": { "credentialsParameter": { "target": "com.amazonaws.ecs#String", "traits": { "smithy.api#documentation": "The authorization credential option to use. The authorization credential options can\n\t\t\tbe provided using either the Amazon Resource Name (ARN) of an AWS Secrets Manager secret or AWS Systems Manager\n\t\t\tParameter Store parameter. The ARNs refer to the stored credentials.
", "smithy.api#required": {} } }, "domain": { "target": "com.amazonaws.ecs#String", "traits": { "smithy.api#documentation": "A fully qualified domain name hosted by an AWS Directory Service Managed Microsoft AD (Active Directory) or self-hosted AD on\n\t\t\tAmazon EC2.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "The authorization configuration details for Amazon FSx for Windows File Server file system. See FSxWindowsFileServerVolumeConfiguration in the Amazon Elastic\n\t\t\t\tContainer Service API Reference.
\n\t\tFor more information and the input format, see Amazon FSx for Windows File Server Volumes\n\t\t\tin the Amazon Elastic Container Service Developer Guide.
" } }, "com.amazonaws.ecs#FSxWindowsFileServerVolumeConfiguration": { "type": "structure", "members": { "fileSystemId": { "target": "com.amazonaws.ecs#String", "traits": { "smithy.api#documentation": "The Amazon FSx for Windows File Server file system ID to use.
", "smithy.api#required": {} } }, "rootDirectory": { "target": "com.amazonaws.ecs#String", "traits": { "smithy.api#documentation": "The directory within the Amazon FSx for Windows File Server file system to mount as the root directory\n\t\t\tinside the host.
", "smithy.api#required": {} } }, "authorizationConfig": { "target": "com.amazonaws.ecs#FSxWindowsFileServerAuthorizationConfig", "traits": { "smithy.api#documentation": "The authorization configuration details for the Amazon FSx for Windows File Server file system.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "This parameter is specified when you are using Amazon FSx for Windows File Server file system for task\n\t\t\tstorage.
\n\t\tFor more information and the input format, see Amazon FSx for Windows File Server Volumes\n\t\t\tin the Amazon Elastic Container Service Developer Guide.
" } }, "com.amazonaws.ecs#Failure": { "type": "structure", "members": { "arn": { "target": "com.amazonaws.ecs#String", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the failed resource.
" } }, "reason": { "target": "com.amazonaws.ecs#String", "traits": { "smithy.api#documentation": "The reason for the failure.
" } }, "detail": { "target": "com.amazonaws.ecs#String", "traits": { "smithy.api#documentation": "The details of the failure.
" } } }, "traits": { "smithy.api#documentation": "A failed resource. For a list of common causes, see API failure\n\t\t\t\treasons in the Amazon Elastic Container Service Developer Guide.
" } }, "com.amazonaws.ecs#Failures": { "type": "list", "member": { "target": "com.amazonaws.ecs#Failure" } }, "com.amazonaws.ecs#FirelensConfiguration": { "type": "structure", "members": { "type": { "target": "com.amazonaws.ecs#FirelensConfigurationType", "traits": { "smithy.api#documentation": "The log router to use. The valid values are fluentd
or\n\t\t\t\tfluentbit
.
The options to use when configuring the log router. This field is optional and can be\n\t\t\tused to specify a custom configuration file or to add additional metadata, such as the\n\t\t\ttask, task definition, cluster, and container instance details to the log event. If\n\t\t\tspecified, the syntax to use is\n\t\t\t\t\"options\":{\"enable-ecs-log-metadata\":\"true|false\",\"config-file-type:\"s3|file\",\"config-file-value\":\"arn:aws:s3:::mybucket/fluent.conf|filepath\"}
.\n\t\t\tFor more information, see Creating\n\t\t\t\ta Task Definition that Uses a FireLens Configuration in the\n\t\t\t\tAmazon Elastic Container Service Developer Guide.
Tasks hosted on AWS Fargate only support the file
configuration file\n\t\t\t\ttype.
The FireLens configuration for the container. This is used to specify and configure a\n\t\t\tlog router for container logs. For more information, see Custom Log Routing\n\t\t\tin the Amazon Elastic Container Service Developer Guide.
" } }, "com.amazonaws.ecs#FirelensConfigurationOptionsMap": { "type": "map", "key": { "target": "com.amazonaws.ecs#String" }, "value": { "target": "com.amazonaws.ecs#String" } }, "com.amazonaws.ecs#FirelensConfigurationType": { "type": "string", "traits": { "smithy.api#enum": [ { "value": "fluentd", "name": "FLUENTD" }, { "value": "fluentbit", "name": "FLUENTBIT" } ] } }, "com.amazonaws.ecs#GpuIds": { "type": "list", "member": { "target": "com.amazonaws.ecs#String" } }, "com.amazonaws.ecs#HealthCheck": { "type": "structure", "members": { "command": { "target": "com.amazonaws.ecs#StringList", "traits": { "smithy.api#documentation": "A string array representing the command that the container runs to determine if it is\n\t\t\thealthy. The string array must start with CMD
to execute the command\n\t\t\targuments directly, or CMD-SHELL
to run the command with the container's\n\t\t\tdefault shell. For example:
\n\t\t\t [ \"CMD-SHELL\", \"curl -f http://localhost/ || exit 1\" ]
\n\t\t
An exit code of 0 indicates success, and non-zero exit code indicates failure. For\n\t\t\tmore information, see HealthCheck
in the Create a container\n\t\t\tsection of the Docker Remote API.
The time period in seconds between each health check execution. You may specify\n\t\t\tbetween 5 and 300 seconds. The default value is 30 seconds.
" } }, "timeout": { "target": "com.amazonaws.ecs#BoxedInteger", "traits": { "smithy.api#documentation": "The time period in seconds to wait for a health check to succeed before it is\n\t\t\tconsidered a failure. You may specify between 2 and 60 seconds. The default value is\n\t\t\t5.
" } }, "retries": { "target": "com.amazonaws.ecs#BoxedInteger", "traits": { "smithy.api#documentation": "The number of times to retry a failed health check before the container is considered\n\t\t\tunhealthy. You may specify between 1 and 10 retries. The default value is 3.
" } }, "startPeriod": { "target": "com.amazonaws.ecs#BoxedInteger", "traits": { "smithy.api#documentation": "The optional grace period within which to provide containers time to bootstrap before\n\t\t\tfailed health checks count towards the maximum number of retries. You may specify\n\t\t\tbetween 0 and 300 seconds. The startPeriod
is disabled by default.
If a health check succeeds within the startPeriod
, then the container\n\t\t\t\tis considered healthy and any subsequent failures count toward the maximum number of\n\t\t\t\tretries.
An object representing a container health check. Health check parameters that are\n\t\t\tspecified in a container definition override any Docker health checks that exist in the\n\t\t\tcontainer image (such as those specified in a parent image or from the image's\n\t\t\tDockerfile).
\n\t\tYou can view the health status of both individual containers and a task with the\n\t\t\tDescribeTasks API operation or when viewing the task details in the console.
\n\t\tThe following describes the possible healthStatus
values for a\n\t\t\tcontainer:
\n HEALTHY
-The container health check has passed\n\t\t\t\t\tsuccessfully.
\n UNHEALTHY
-The container health check has failed.
\n UNKNOWN
-The container health check is being evaluated or\n\t\t\t\t\tthere is no container health check defined.
The following describes the possible healthStatus
values for a task. The\n\t\t\tcontainer health check status of nonessential containers do not have an effect on the\n\t\t\thealth status of a task.
\n HEALTHY
-All essential containers within the task have\n\t\t\t\t\tpassed their health checks.
\n UNHEALTHY
-One or more essential containers have failed\n\t\t\t\t\ttheir health check.
\n UNKNOWN
-The essential containers within the task are still\n\t\t\t\t\thaving their health checks evaluated or there are no container health checks\n\t\t\t\t\tdefined.
If a task is run manually, and not as part of a service, the task will continue its\n\t\t\tlifecycle regardless of its health status. For tasks that are part of a service, if the\n\t\t\ttask reports as unhealthy then the task will be stopped and the service scheduler will\n\t\t\treplace it.
\n\t\tThe following are notes about container health check support:
\n\t\tContainer health checks require version 1.17.0 or greater of the Amazon ECS\n\t\t\t\t\tcontainer agent. For more information, see Updating the\n\t\t\t\t\t\tAmazon ECS Container Agent.
\n\t\t\tContainer health checks are supported for Fargate tasks if you\n\t\t\t\t\tare using platform version 1.1.0 or greater. For more information, see AWS Fargate\n\t\t\t\t\t\tPlatform Versions.
\n\t\t\tContainer health checks are not supported for tasks that are part of a service\n\t\t\t\t\tthat is configured to use a Classic Load Balancer.
\n\t\t\tThe hostname to use in the /etc/hosts
entry.
The IP address to use in the /etc/hosts
entry.
Hostnames and IP address entries that are added to the /etc/hosts
file of\n\t\t\ta container via the extraHosts
parameter of its ContainerDefinition.
When the host
parameter is used, specify a sourcePath
to\n\t\t\tdeclare the path on the host container instance that is presented to the container. If\n\t\t\tthis parameter is empty, then the Docker daemon has assigned a host path for you. If the\n\t\t\t\thost
parameter contains a sourcePath
file location, then\n\t\t\tthe data volume persists at the specified location on the host container instance until\n\t\t\tyou delete it manually. If the sourcePath
value does not exist on the host\n\t\t\tcontainer instance, the Docker daemon creates it. If the location does exist, the\n\t\t\tcontents of the source path folder are exported.
If you are using the Fargate launch type, the sourcePath
\n\t\t\tparameter is not supported.
Details on a container instance bind mount host volume.
" } }, "com.amazonaws.ecs#InferenceAccelerator": { "type": "structure", "members": { "deviceName": { "target": "com.amazonaws.ecs#String", "traits": { "smithy.api#documentation": "The Elastic Inference accelerator device name. The deviceName
must also\n\t\t\tbe referenced in a container definition as a ResourceRequirement.
The Elastic Inference accelerator type to use.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "Details on a Elastic Inference accelerator. For more information, see Working with\n\t\t\t\tAmazon Elastic Inference on Amazon ECS in the\n\t\t\t\tAmazon Elastic Container Service Developer Guide.
" } }, "com.amazonaws.ecs#InferenceAcceleratorOverride": { "type": "structure", "members": { "deviceName": { "target": "com.amazonaws.ecs#String", "traits": { "smithy.api#documentation": "The Elastic Inference accelerator device name to override for the task. This parameter\n\t\t\tmust match a deviceName
specified in the task definition.
The Elastic Inference accelerator type to use.
" } } }, "traits": { "smithy.api#documentation": "Details on an Elastic Inference accelerator task override. This parameter is used to\n\t\t\toverride the Elastic Inference accelerator specified in the task definition. For more\n\t\t\tinformation, see Working with Amazon Elastic Inference on Amazon ECS in the\n\t\t\t\tAmazon Elastic Container Service Developer Guide.
" } }, "com.amazonaws.ecs#InferenceAcceleratorOverrides": { "type": "list", "member": { "target": "com.amazonaws.ecs#InferenceAcceleratorOverride" } }, "com.amazonaws.ecs#InferenceAccelerators": { "type": "list", "member": { "target": "com.amazonaws.ecs#InferenceAccelerator" } }, "com.amazonaws.ecs#Integer": { "type": "integer" }, "com.amazonaws.ecs#InvalidParameterException": { "type": "structure", "members": { "message": { "target": "com.amazonaws.ecs#String" } }, "traits": { "smithy.api#documentation": "The specified parameter is invalid. Review the available parameters for the API\n\t\t\trequest.
", "smithy.api#error": "client" } }, "com.amazonaws.ecs#IpcMode": { "type": "string", "traits": { "smithy.api#enum": [ { "value": "host", "name": "HOST" }, { "value": "task", "name": "TASK" }, { "value": "none", "name": "NONE" } ] } }, "com.amazonaws.ecs#KernelCapabilities": { "type": "structure", "members": { "add": { "target": "com.amazonaws.ecs#StringList", "traits": { "smithy.api#documentation": "The Linux capabilities for the container that have been added to the default\n\t\t\tconfiguration provided by Docker. This parameter maps to CapAdd
in the\n\t\t\tCreate a container section of the Docker Remote API and the\n\t\t\t\t--cap-add
option to docker\n\t\t\t\trun.
Tasks launched on AWS Fargate only support adding the SYS_PTRACE
kernel\n\t\t\t\tcapability.
Valid values: \"ALL\" | \"AUDIT_CONTROL\" | \"AUDIT_WRITE\" | \"BLOCK_SUSPEND\" |\n\t\t\t\t\"CHOWN\" | \"DAC_OVERRIDE\" | \"DAC_READ_SEARCH\" | \"FOWNER\" | \"FSETID\" | \"IPC_LOCK\" |\n\t\t\t\t\"IPC_OWNER\" | \"KILL\" | \"LEASE\" | \"LINUX_IMMUTABLE\" | \"MAC_ADMIN\" | \"MAC_OVERRIDE\" |\n\t\t\t\t\"MKNOD\" | \"NET_ADMIN\" | \"NET_BIND_SERVICE\" | \"NET_BROADCAST\" | \"NET_RAW\" | \"SETFCAP\"\n\t\t\t\t| \"SETGID\" | \"SETPCAP\" | \"SETUID\" | \"SYS_ADMIN\" | \"SYS_BOOT\" | \"SYS_CHROOT\" |\n\t\t\t\t\"SYS_MODULE\" | \"SYS_NICE\" | \"SYS_PACCT\" | \"SYS_PTRACE\" | \"SYS_RAWIO\" |\n\t\t\t\t\"SYS_RESOURCE\" | \"SYS_TIME\" | \"SYS_TTY_CONFIG\" | \"SYSLOG\" |\n\t\t\t\"WAKE_ALARM\"
\n
The Linux capabilities for the container that have been removed from the default\n\t\t\tconfiguration provided by Docker. This parameter maps to CapDrop
in the\n\t\t\tCreate a container section of the Docker Remote API and the\n\t\t\t\t--cap-drop
option to docker\n\t\t\t\trun.
Valid values: \"ALL\" | \"AUDIT_CONTROL\" | \"AUDIT_WRITE\" | \"BLOCK_SUSPEND\" |\n\t\t\t\t\"CHOWN\" | \"DAC_OVERRIDE\" | \"DAC_READ_SEARCH\" | \"FOWNER\" | \"FSETID\" | \"IPC_LOCK\" |\n\t\t\t\t\"IPC_OWNER\" | \"KILL\" | \"LEASE\" | \"LINUX_IMMUTABLE\" | \"MAC_ADMIN\" | \"MAC_OVERRIDE\" |\n\t\t\t\t\"MKNOD\" | \"NET_ADMIN\" | \"NET_BIND_SERVICE\" | \"NET_BROADCAST\" | \"NET_RAW\" | \"SETFCAP\"\n\t\t\t\t| \"SETGID\" | \"SETPCAP\" | \"SETUID\" | \"SYS_ADMIN\" | \"SYS_BOOT\" | \"SYS_CHROOT\" |\n\t\t\t\t\"SYS_MODULE\" | \"SYS_NICE\" | \"SYS_PACCT\" | \"SYS_PTRACE\" | \"SYS_RAWIO\" |\n\t\t\t\t\"SYS_RESOURCE\" | \"SYS_TIME\" | \"SYS_TTY_CONFIG\" | \"SYSLOG\" |\n\t\t\t\"WAKE_ALARM\"
\n
The Linux capabilities for the container that are added to or dropped from the default\n\t\t\tconfiguration provided by Docker. For more information on the default capabilities and\n\t\t\tthe non-default available capabilities, see Runtime privilege and Linux capabilities in the Docker run\n\t\t\t\treference. For more detailed information on these Linux capabilities, see\n\t\t\tthe capabilities(7) Linux manual page.
" } }, "com.amazonaws.ecs#KeyValuePair": { "type": "structure", "members": { "name": { "target": "com.amazonaws.ecs#String", "traits": { "smithy.api#documentation": "The name of the key-value pair. For environment variables, this is the name of the\n\t\t\tenvironment variable.
" } }, "value": { "target": "com.amazonaws.ecs#String", "traits": { "smithy.api#documentation": "The value of the key-value pair. For environment variables, this is the value of the\n\t\t\tenvironment variable.
" } } }, "traits": { "smithy.api#documentation": "A key-value pair object.
" } }, "com.amazonaws.ecs#LaunchType": { "type": "string", "traits": { "smithy.api#enum": [ { "value": "EC2", "name": "EC2" }, { "value": "FARGATE", "name": "FARGATE" } ] } }, "com.amazonaws.ecs#LimitExceededException": { "type": "structure", "members": { "message": { "target": "com.amazonaws.ecs#String" } }, "traits": { "smithy.api#documentation": "The limit for the resource has been exceeded.
", "smithy.api#error": "client" } }, "com.amazonaws.ecs#LinuxParameters": { "type": "structure", "members": { "capabilities": { "target": "com.amazonaws.ecs#KernelCapabilities", "traits": { "smithy.api#documentation": "The Linux capabilities for the container that are added to or dropped from the default\n\t\t\tconfiguration provided by Docker.
\n\t\tFor tasks that use the Fargate launch type,\n\t\t\t\t\tcapabilities
is supported for all platform versions but the\n\t\t\t\t\tadd
parameter is only supported if using platform version 1.4.0 or\n\t\t\t\tlater.
Any host devices to expose to the container. This parameter maps to\n\t\t\t\tDevices
in the Create a container section of the\n\t\t\tDocker Remote API and the --device
option to docker run.
If you are using tasks that use the Fargate launch type, the\n\t\t\t\t\tdevices
parameter is not supported.
Run an init
process inside the container that forwards signals and reaps\n\t\t\tprocesses. 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}}'
\n
The value for the size (in MiB) of the /dev/shm
volume. This parameter\n\t\t\tmaps to the --shm-size
option to docker\n\t\t\t\trun.
If you are using tasks that use the Fargate launch type, the\n\t\t\t\t\tsharedMemorySize
parameter is not supported.
The container path, mount options, and size (in MiB) of the tmpfs mount. This\n\t\t\tparameter maps to the --tmpfs
option to docker run.
If you are using tasks that use the Fargate launch type, the\n\t\t\t\t\ttmpfs
parameter is not supported.
The total amount of swap memory (in MiB) a container can use. This parameter will be\n\t\t\ttranslated to the --memory-swap
option to docker run where the value would be the sum of\n\t\t\tthe container memory plus the maxSwap
value.
If a maxSwap
value of 0
is specified, the container will not\n\t\t\tuse swap. Accepted values are 0
or any positive integer. If the\n\t\t\t\tmaxSwap
parameter is omitted, the container will use the swap\n\t\t\tconfiguration for the container instance it is running on. A maxSwap
value\n\t\t\tmust be set for the swappiness
parameter to be used.
If you are using tasks that use the Fargate launch type, the\n\t\t\t\t\tmaxSwap
parameter is not supported.
This allows you to tune a container's memory swappiness behavior. A\n\t\t\t\tswappiness
value of 0
will cause swapping to not happen\n\t\t\tunless absolutely necessary. A swappiness
value of 100
will\n\t\t\tcause pages to be swapped very aggressively. Accepted values are whole numbers between\n\t\t\t\t0
and 100
. If the swappiness
parameter is not\n\t\t\tspecified, a default value of 60
is used. If a value is not specified for\n\t\t\t\tmaxSwap
then this parameter is ignored. This parameter maps to the\n\t\t\t\t--memory-swappiness
option to docker run.
If you are using tasks that use the Fargate launch type, the\n\t\t\t\t\tswappiness
parameter is not supported.
Linux-specific options that are applied to the container, such as Linux KernelCapabilities.
" } }, "com.amazonaws.ecs#ListAccountSettings": { "type": "operation", "input": { "target": "com.amazonaws.ecs#ListAccountSettingsRequest" }, "output": { "target": "com.amazonaws.ecs#ListAccountSettingsResponse" }, "errors": [ { "target": "com.amazonaws.ecs#ClientException" }, { "target": "com.amazonaws.ecs#InvalidParameterException" }, { "target": "com.amazonaws.ecs#ServerException" } ], "traits": { "smithy.api#documentation": "Lists the account settings for a specified principal.
", "smithy.api#paginated": { "inputToken": "nextToken", "outputToken": "nextToken", "items": "settings", "pageSize": "maxResults" } } }, "com.amazonaws.ecs#ListAccountSettingsRequest": { "type": "structure", "members": { "name": { "target": "com.amazonaws.ecs#SettingName", "traits": { "smithy.api#documentation": "The name of the account setting you want to list the settings for.
" } }, "value": { "target": "com.amazonaws.ecs#String", "traits": { "smithy.api#documentation": "The value of the account settings with which to filter results. You must also specify\n\t\t\tan account setting name to use this parameter.
" } }, "principalArn": { "target": "com.amazonaws.ecs#String", "traits": { "smithy.api#documentation": "The ARN of the principal, which can be an IAM user, IAM role, or the root user. If\n\t\t\tthis field is omitted, the account settings are listed only for the authenticated\n\t\t\tuser.
\n\t\tFederated users assume the account setting of the root user and can't have\n\t\t\t\texplicit account settings set for them.
\n\t\tSpecifies whether to return the effective settings. If true
, the account\n\t\t\tsettings for the root user or the default setting for the principalArn
are\n\t\t\treturned. If false
, the account settings for the principalArn
\n\t\t\tare returned if they are set. Otherwise, no account settings are returned.
The nextToken
value returned from a ListAccountSettings
\n\t\t\trequest indicating that more results are available to fulfill the request and further\n\t\t\tcalls will be needed. If maxResults
was provided, it is possible the number\n\t\t\tof results to be fewer than maxResults
.
This token should be treated as an opaque identifier that is only used to\n retrieve the next items in a list and not for other programmatic purposes.
\nThe maximum number of account setting results returned by\n\t\t\t\tListAccountSettings
in paginated output. When this parameter is used,\n\t\t\t\tListAccountSettings
only returns maxResults
results in a\n\t\t\tsingle page along with a nextToken
response element. The remaining results\n\t\t\tof the initial request can be seen by sending another ListAccountSettings
\n\t\t\trequest with the returned nextToken
value. This value can be between\n\t\t\t1 and 10. If this\n\t\t\tparameter is not used, then ListAccountSettings
returns up to\n\t\t\t10 results and a nextToken
value\n\t\t\tif applicable.
The account settings for the resource.
" } }, "nextToken": { "target": "com.amazonaws.ecs#String", "traits": { "smithy.api#documentation": "The nextToken
value to include in a future\n\t\t\t\tListAccountSettings
request. When the results of a\n\t\t\t\tListAccountSettings
request exceed maxResults
, this value\n\t\t\tcan be used to retrieve the next page of results. This value is null
when\n\t\t\tthere are no more results to return.
Lists the attributes for Amazon ECS resources within a specified target type and cluster.\n\t\t\tWhen you specify a target type and cluster, ListAttributes
returns a list\n\t\t\tof attribute objects, one for each attribute on each resource. You can filter the list\n\t\t\tof results to a single attribute name to only return results that have that name. You\n\t\t\tcan also filter the results by attribute name and value, for example, to see which\n\t\t\tcontainer instances in a cluster are running a Linux AMI\n\t\t\t(ecs.os-type=linux
).
The short name or full Amazon Resource Name (ARN) of the cluster to list attributes.\n\t\t\tIf you do not specify a cluster, the default cluster is assumed.
" } }, "targetType": { "target": "com.amazonaws.ecs#TargetType", "traits": { "smithy.api#documentation": "The type of the target with which to list attributes.
", "smithy.api#required": {} } }, "attributeName": { "target": "com.amazonaws.ecs#String", "traits": { "smithy.api#documentation": "The name of the attribute with which to filter the results.
" } }, "attributeValue": { "target": "com.amazonaws.ecs#String", "traits": { "smithy.api#documentation": "The value of the attribute with which to filter results. You must also specify an\n\t\t\tattribute name to use this parameter.
" } }, "nextToken": { "target": "com.amazonaws.ecs#String", "traits": { "smithy.api#documentation": "The nextToken
value returned from a ListAttributes
request\n\t\t\tindicating that more results are available to fulfill the request and further calls will\n\t\t\tbe needed. If maxResults
was provided, it is possible the number of results\n\t\t\tto be fewer than maxResults
.
This token should be treated as an opaque identifier that is only used to\n retrieve the next items in a list and not for other programmatic purposes.
\nThe maximum number of cluster results returned by ListAttributes
in\n\t\t\tpaginated output. When this parameter is used, ListAttributes
only returns\n\t\t\t\tmaxResults
results in a single page along with a nextToken
\n\t\t\tresponse element. The remaining results of the initial request can be seen by sending\n\t\t\tanother ListAttributes
request with the returned nextToken
\n\t\t\tvalue. This value can be between 1 and 100. If this\n\t\t\tparameter is not used, then ListAttributes
returns up to\n\t\t\t100 results and a nextToken
value if applicable.
A list of attribute objects that meet the criteria of the request.
" } }, "nextToken": { "target": "com.amazonaws.ecs#String", "traits": { "smithy.api#documentation": "The nextToken
value to include in a future ListAttributes
\n\t\t\trequest. When the results of a ListAttributes
request exceed\n\t\t\t\tmaxResults
, this value can be used to retrieve the next page of\n\t\t\tresults. This value is null
when there are no more results to\n\t\t\treturn.
Returns a list of existing clusters.
", "smithy.api#paginated": { "inputToken": "nextToken", "outputToken": "nextToken", "items": "clusterArns", "pageSize": "maxResults" } } }, "com.amazonaws.ecs#ListClustersRequest": { "type": "structure", "members": { "nextToken": { "target": "com.amazonaws.ecs#String", "traits": { "smithy.api#documentation": "The nextToken
value returned from a ListClusters
request\n\t\t\tindicating that more results are available to fulfill the request and further calls will\n\t\t\tbe needed. If maxResults
was provided, it is possible the number of results\n\t\t\tto be fewer than maxResults
.
This token should be treated as an opaque identifier that is only used to\n retrieve the next items in a list and not for other programmatic purposes.
\nThe maximum number of cluster results returned by ListClusters
in\n\t\t\tpaginated output. When this parameter is used, ListClusters
only returns\n\t\t\t\tmaxResults
results in a single page along with a nextToken
\n\t\t\tresponse element. The remaining results of the initial request can be seen by sending\n\t\t\tanother ListClusters
request with the returned nextToken
\n\t\t\tvalue. This value can be between 1 and 100. If this\n\t\t\tparameter is not used, then ListClusters
returns up to\n\t\t\t100 results and a nextToken
value if applicable.
The list of full Amazon Resource Name (ARN) entries for each cluster associated with your\n\t\t\taccount.
" } }, "nextToken": { "target": "com.amazonaws.ecs#String", "traits": { "smithy.api#documentation": "The nextToken
value to include in a future ListClusters
\n\t\t\trequest. When the results of a ListClusters
request exceed\n\t\t\t\tmaxResults
, this value can be used to retrieve the next page of\n\t\t\tresults. This value is null
when there are no more results to\n\t\t\treturn.
Returns a list of container instances in a specified cluster. You can filter the\n\t\t\tresults of a ListContainerInstances
operation with cluster query language\n\t\t\tstatements inside the filter
parameter. For more information, see Cluster Query Language in the\n\t\t\t\tAmazon Elastic Container Service Developer Guide.
The short name or full Amazon Resource Name (ARN) of the cluster that hosts the container instances to\n\t\t\tlist. If you do not specify a cluster, the default cluster is assumed.
" } }, "filter": { "target": "com.amazonaws.ecs#String", "traits": { "smithy.api#documentation": "You can filter the results of a ListContainerInstances
operation with\n\t\t\tcluster query language statements. For more information, see Cluster Query Language in the\n\t\t\t\tAmazon Elastic Container Service Developer Guide.
The nextToken
value returned from a ListContainerInstances
\n\t\t\trequest indicating that more results are available to fulfill the request and further\n\t\t\tcalls will be needed. If maxResults
was provided, it is possible the number\n\t\t\tof results to be fewer than maxResults
.
This token should be treated as an opaque identifier that is only used to\n retrieve the next items in a list and not for other programmatic purposes.
\nThe maximum number of container instance results returned by\n\t\t\t\tListContainerInstances
in paginated output. When this parameter is\n\t\t\tused, ListContainerInstances
only returns maxResults
results\n\t\t\tin a single page along with a nextToken
response element. The remaining\n\t\t\tresults of the initial request can be seen by sending another\n\t\t\t\tListContainerInstances
request with the returned nextToken
\n\t\t\tvalue. This value can be between 1 and 100. If this\n\t\t\tparameter is not used, then ListContainerInstances
returns up to\n\t\t\t100 results and a nextToken
value if applicable.
Filters the container instances by status. For example, if you specify the\n\t\t\t\tDRAINING
status, the results include only container instances that have\n\t\t\tbeen set to DRAINING
using UpdateContainerInstancesState.\n\t\t\tIf you do not specify this parameter, the default is to include container instances set\n\t\t\tto all states other than INACTIVE
.
The list of container instances with full ARN entries for each container instance\n\t\t\tassociated with the specified cluster.
" } }, "nextToken": { "target": "com.amazonaws.ecs#String", "traits": { "smithy.api#documentation": "The nextToken
value to include in a future\n\t\t\t\tListContainerInstances
request. When the results of a\n\t\t\t\tListContainerInstances
request exceed maxResults
, this\n\t\t\tvalue can be used to retrieve the next page of results. This value is null
\n\t\t\twhen there are no more results to return.
Lists the services that are running in a specified cluster.
", "smithy.api#paginated": { "inputToken": "nextToken", "outputToken": "nextToken", "items": "serviceArns", "pageSize": "maxResults" } } }, "com.amazonaws.ecs#ListServicesRequest": { "type": "structure", "members": { "cluster": { "target": "com.amazonaws.ecs#String", "traits": { "smithy.api#documentation": "The short name or full Amazon Resource Name (ARN) of the cluster that hosts the services to list.\n\t\t\tIf you do not specify a cluster, the default cluster is assumed.
" } }, "nextToken": { "target": "com.amazonaws.ecs#String", "traits": { "smithy.api#documentation": "The nextToken
value returned from a ListServices
request\n\t\t\tindicating that more results are available to fulfill the request and further calls will\n\t\t\tbe needed. If maxResults
was provided, it is possible the number of results\n\t\t\tto be fewer than maxResults
.
This token should be treated as an opaque identifier that is only used to\n retrieve the next items in a list and not for other programmatic purposes.
\nThe maximum number of service results returned by ListServices
in\n\t\t\tpaginated output. When this parameter is used, ListServices
only returns\n\t\t\t\tmaxResults
results in a single page along with a nextToken
\n\t\t\tresponse element. The remaining results of the initial request can be seen by sending\n\t\t\tanother ListServices
request with the returned nextToken
\n\t\t\tvalue. This value can be between 1 and 100. If\n\t\t\tthis parameter is not used, then ListServices
returns up to\n\t\t\t10 results and a nextToken
value if\n\t\t\tapplicable.
The launch type for the services to list.
" } }, "schedulingStrategy": { "target": "com.amazonaws.ecs#SchedulingStrategy", "traits": { "smithy.api#documentation": "The scheduling strategy for services to list.
" } } } }, "com.amazonaws.ecs#ListServicesResponse": { "type": "structure", "members": { "serviceArns": { "target": "com.amazonaws.ecs#StringList", "traits": { "smithy.api#documentation": "The list of full ARN entries for each service associated with the specified\n\t\t\tcluster.
" } }, "nextToken": { "target": "com.amazonaws.ecs#String", "traits": { "smithy.api#documentation": "The nextToken
value to include in a future ListServices
\n\t\t\trequest. When the results of a ListServices
request exceed\n\t\t\t\tmaxResults
, this value can be used to retrieve the next page of\n\t\t\tresults. This value is null
when there are no more results to\n\t\t\treturn.
List the tags for an Amazon ECS resource.
" } }, "com.amazonaws.ecs#ListTagsForResourceRequest": { "type": "structure", "members": { "resourceArn": { "target": "com.amazonaws.ecs#String", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) that identifies the resource for which to list the tags. Currently, the\n\t\t\tsupported resources are Amazon ECS tasks, services, task definitions, clusters, and container\n\t\t\tinstances.
", "smithy.api#required": {} } } } }, "com.amazonaws.ecs#ListTagsForResourceResponse": { "type": "structure", "members": { "tags": { "target": "com.amazonaws.ecs#Tags", "traits": { "smithy.api#documentation": "The tags for the resource.
" } } } }, "com.amazonaws.ecs#ListTaskDefinitionFamilies": { "type": "operation", "input": { "target": "com.amazonaws.ecs#ListTaskDefinitionFamiliesRequest" }, "output": { "target": "com.amazonaws.ecs#ListTaskDefinitionFamiliesResponse" }, "errors": [ { "target": "com.amazonaws.ecs#ClientException" }, { "target": "com.amazonaws.ecs#InvalidParameterException" }, { "target": "com.amazonaws.ecs#ServerException" } ], "traits": { "smithy.api#documentation": "Returns a list of task definition families that are registered to your account (which\n\t\t\tmay include task definition families that no longer have any ACTIVE
task\n\t\t\tdefinition revisions).
You can filter out task definition families that do not contain any\n\t\t\t\tACTIVE
task definition revisions by setting the status
\n\t\t\tparameter to ACTIVE
. You can also filter the results with the\n\t\t\t\tfamilyPrefix
parameter.
The familyPrefix
is a string that is used to filter the results of\n\t\t\t\tListTaskDefinitionFamilies
. If you specify a familyPrefix
,\n\t\t\tonly task definition family names that begin with the familyPrefix
string\n\t\t\tare returned.
The task definition family status with which to filter the\n\t\t\t\tListTaskDefinitionFamilies
results. By default, both\n\t\t\t\tACTIVE
and INACTIVE
task definition families are listed.\n\t\t\tIf this parameter is set to ACTIVE
, only task definition families that have\n\t\t\tan ACTIVE
task definition revision are returned. If this parameter is set\n\t\t\tto INACTIVE
, only task definition families that do not have any\n\t\t\t\tACTIVE
task definition revisions are returned. If you paginate the\n\t\t\tresulting output, be sure to keep the status
value constant in each\n\t\t\tsubsequent request.
The nextToken
value returned from a\n\t\t\t\tListTaskDefinitionFamilies
request indicating that more results are\n\t\t\tavailable to fulfill the request and further calls will be needed. If\n\t\t\t\tmaxResults
was provided, it is possible the number of results to be\n\t\t\tfewer than maxResults
.
This token should be treated as an opaque identifier that is only used to\n retrieve the next items in a list and not for other programmatic purposes.
\nThe maximum number of task definition family results returned by\n\t\t\t\tListTaskDefinitionFamilies
in paginated output. When this parameter is\n\t\t\tused, ListTaskDefinitions
only returns maxResults
results in a\n\t\t\tsingle page along with a nextToken
response element. The remaining results\n\t\t\tof the initial request can be seen by sending another\n\t\t\t\tListTaskDefinitionFamilies
request with the returned\n\t\t\t\tnextToken
value. This value can be between 1 and\n\t\t\t100. If this parameter is not used, then\n\t\t\t\tListTaskDefinitionFamilies
returns up to 100 results\n\t\t\tand a nextToken
value if applicable.
The list of task definition family names that match the\n\t\t\t\tListTaskDefinitionFamilies
request.
The nextToken
value to include in a future\n\t\t\t\tListTaskDefinitionFamilies
request. When the results of a\n\t\t\t\tListTaskDefinitionFamilies
request exceed maxResults
, this\n\t\t\tvalue can be used to retrieve the next page of results. This value is null
\n\t\t\twhen there are no more results to return.
Returns a list of task definitions that are registered to your account. You can filter\n\t\t\tthe results by family name with the familyPrefix
parameter or by status\n\t\t\twith the status
parameter.
The full family name with which to filter the ListTaskDefinitions
\n\t\t\tresults. Specifying a familyPrefix
limits the listed task definitions to\n\t\t\ttask definition revisions that belong to that family.
The task definition status with which to filter the ListTaskDefinitions
\n\t\t\tresults. By default, only ACTIVE
task definitions are listed. By setting\n\t\t\tthis parameter to INACTIVE
, you can view task definitions that are\n\t\t\t\tINACTIVE
as long as an active task or service still references them. If\n\t\t\tyou paginate the resulting output, be sure to keep the status
value\n\t\t\tconstant in each subsequent request.
The order in which to sort the results. Valid values are ASC
and\n\t\t\t\tDESC
. By default (ASC
), task definitions are listed\n\t\t\tlexicographically by family name and in ascending numerical order by revision so that\n\t\t\tthe newest task definitions in a family are listed last. Setting this parameter to\n\t\t\t\tDESC
reverses the sort order on family name and revision so that the\n\t\t\tnewest task definitions in a family are listed first.
The nextToken
value returned from a ListTaskDefinitions
\n\t\t\trequest indicating that more results are available to fulfill the request and further\n\t\t\tcalls will be needed. If maxResults
was provided, it is possible the number\n\t\t\tof results to be fewer than maxResults
.
This token should be treated as an opaque identifier that is only used to\n retrieve the next items in a list and not for other programmatic purposes.
\nThe maximum number of task definition results returned by\n\t\t\t\tListTaskDefinitions
in paginated output. When this parameter is used,\n\t\t\t\tListTaskDefinitions
only returns maxResults
results in a\n\t\t\tsingle page along with a nextToken
response element. The remaining results\n\t\t\tof the initial request can be seen by sending another ListTaskDefinitions
\n\t\t\trequest with the returned nextToken
value. This value can be between\n\t\t\t1 and 100. If this parameter is not used, then\n\t\t\t\tListTaskDefinitions
returns up to 100 results and a\n\t\t\t\tnextToken
value if applicable.
The list of task definition Amazon Resource Name (ARN) entries for the ListTaskDefinitions
\n\t\t\trequest.
The nextToken
value to include in a future\n\t\t\t\tListTaskDefinitions
request. When the results of a\n\t\t\t\tListTaskDefinitions
request exceed maxResults
, this value\n\t\t\tcan be used to retrieve the next page of results. This value is null
when\n\t\t\tthere are no more results to return.
Returns a list of tasks for a specified cluster. You can filter the results by family\n\t\t\tname, by a particular container instance, or by the desired status of the task with the\n\t\t\t\tfamily
, containerInstance
, and desiredStatus
\n\t\t\tparameters.
Recently stopped tasks might appear in the returned results. Currently, stopped tasks\n\t\t\tappear in the returned results for at least one hour.
", "smithy.api#paginated": { "inputToken": "nextToken", "outputToken": "nextToken", "items": "taskArns", "pageSize": "maxResults" } } }, "com.amazonaws.ecs#ListTasksRequest": { "type": "structure", "members": { "cluster": { "target": "com.amazonaws.ecs#String", "traits": { "smithy.api#documentation": "The short name or full Amazon Resource Name (ARN) of the cluster that hosts the tasks to list.\n\t\t\tIf you do not specify a cluster, the default cluster is assumed.
" } }, "containerInstance": { "target": "com.amazonaws.ecs#String", "traits": { "smithy.api#documentation": "The container instance ID or full ARN of the container instance with which to filter\n\t\t\tthe ListTasks
results. Specifying a containerInstance
limits\n\t\t\tthe results to tasks that belong to that container instance.
The name of the family with which to filter the ListTasks
results.\n\t\t\tSpecifying a family
limits the results to tasks that belong to that\n\t\t\tfamily.
The nextToken
value returned from a ListTasks
request\n\t\t\tindicating that more results are available to fulfill the request and further calls will\n\t\t\tbe needed. If maxResults
was provided, it is possible the number of results\n\t\t\tto be fewer than maxResults
.
This token should be treated as an opaque identifier that is only used to\n retrieve the next items in a list and not for other programmatic purposes.
\nThe maximum number of task results returned by ListTasks
in paginated\n\t\t\toutput. When this parameter is used, ListTasks
only returns\n\t\t\t\tmaxResults
results in a single page along with a nextToken
\n\t\t\tresponse element. The remaining results of the initial request can be seen by sending\n\t\t\tanother ListTasks
request with the returned nextToken
value.\n\t\t\tThis value can be between 1 and 100. If this parameter is\n\t\t\tnot used, then ListTasks
returns up to 100 results and a\n\t\t\t\tnextToken
value if applicable.
The startedBy
value with which to filter the task results. Specifying a\n\t\t\t\tstartedBy
value limits the results to tasks that were started with that\n\t\t\tvalue.
The name of the service with which to filter the ListTasks
results.\n\t\t\tSpecifying a serviceName
limits the results to tasks that belong to that\n\t\t\tservice.
The task desired status with which to filter the ListTasks
results.\n\t\t\tSpecifying a desiredStatus
of STOPPED
limits the results to\n\t\t\ttasks that Amazon ECS has set the desired status to STOPPED
. This can be useful\n\t\t\tfor debugging tasks that are not starting properly or have died or finished. The default\n\t\t\tstatus filter is RUNNING
, which shows tasks that Amazon ECS has set the desired\n\t\t\tstatus to RUNNING
.
Although you can filter results based on a desired status of PENDING
,\n\t\t\t\tthis does not return any results. Amazon ECS never sets the desired status of a task to\n\t\t\t\tthat value (only a task's lastStatus
may have a value of\n\t\t\t\t\tPENDING
).
The launch type for services to list.
" } } } }, "com.amazonaws.ecs#ListTasksResponse": { "type": "structure", "members": { "taskArns": { "target": "com.amazonaws.ecs#StringList", "traits": { "smithy.api#documentation": "The list of task ARN entries for the ListTasks
request.
The nextToken
value to include in a future ListTasks
\n\t\t\trequest. When the results of a ListTasks
request exceed\n\t\t\t\tmaxResults
, this value can be used to retrieve the next page of\n\t\t\tresults. This value is null
when there are no more results to\n\t\t\treturn.
The full Amazon Resource Name (ARN) of the Elastic Load Balancing target group or groups associated with a service or\n\t\t\ttask set.
\n\t\tA target group ARN is only specified when using an Application Load Balancer or Network Load Balancer. If you are using a\n\t\t\tClassic Load Balancer the target group ARN should be omitted.
\n\t\tFor services using the ECS
deployment controller, you can specify one or\n\t\t\tmultiple target groups. For more information, see Registering Multiple Target Groups with a Service in\n\t\t\tthe Amazon Elastic Container Service Developer Guide.
For services using the CODE_DEPLOY
deployment controller, you are\n\t\t\trequired to define two target groups for the load balancer. For more information, see\n\t\t\t\tBlue/Green Deployment with CodeDeploy in the\n\t\t\t\tAmazon Elastic Container Service Developer Guide.
If your service's task definition uses the awsvpc
network mode (which\n\t\t\t\tis required for the Fargate launch type), you must choose\n\t\t\t\t\tip
as the target type, not instance
, when creating\n\t\t\t\tyour target groups because tasks that use the awsvpc
network mode are\n\t\t\t\tassociated with an elastic network interface, not an Amazon EC2 instance.
The name of the load balancer to associate with the Amazon ECS service or task set.
\n\t\tA load balancer name is only specified when using a Classic Load Balancer. If you are using an Application Load Balancer\n\t\t\tor a Network Load Balancer the load balancer name parameter should be omitted.
" } }, "containerName": { "target": "com.amazonaws.ecs#String", "traits": { "smithy.api#documentation": "The name of the container (as it appears in a container definition) to associate with\n\t\t\tthe load balancer.
" } }, "containerPort": { "target": "com.amazonaws.ecs#BoxedInteger", "traits": { "smithy.api#documentation": "The port on the container to associate with the load balancer. This port must\n\t\t\tcorrespond to a containerPort
in the task definition the tasks in the\n\t\t\tservice are using. For tasks that use the EC2 launch type, the container\n\t\t\tinstance they are launched on must allow ingress traffic on the hostPort
of\n\t\t\tthe port mapping.
The load balancer configuration to use with a service or task set.
\n\t\tFor specific notes and restrictions regarding the use of load balancers with services\n\t\t\tand task sets, see the CreateService and CreateTaskSet actions.
" } }, "com.amazonaws.ecs#LoadBalancers": { "type": "list", "member": { "target": "com.amazonaws.ecs#LoadBalancer" } }, "com.amazonaws.ecs#LogConfiguration": { "type": "structure", "members": { "logDriver": { "target": "com.amazonaws.ecs#LogDriver", "traits": { "smithy.api#documentation": "The log driver to use for the container.
\n\t\tFor tasks on AWS Fargate, the supported log drivers are awslogs
,\n\t\t\t\tsplunk
, and awsfirelens
.
For tasks hosted on Amazon EC2 instances, the supported log drivers are\n\t\t\t\tawslogs
, fluentd
, gelf
,\n\t\t\t\tjson-file
, journald
,\n\t\t\t\tlogentries
,syslog
, splunk
, and\n\t\t\t\tawsfirelens
.
For more information about using the awslogs
log driver, see Using\n\t\t\t\tthe 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 is not listed, you can fork the Amazon ECS container\n\t\t\t\tagent project that is available\n\t\t\t\t\ton GitHub and customize it to work with that driver. We encourage you to\n\t\t\t\tsubmit pull requests for changes that you would like to have included. However, we\n\t\t\t\tdo not currently provide support for running modified copies of this\n\t\t\t\tsoftware.
\n\t\tThe 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}}'
\n
The secrets to pass to the log configuration. For more information, see Specifying\n\t\t\t\tSensitive Data in the Amazon Elastic Container Service Developer Guide.
" } } }, "traits": { "smithy.api#documentation": "The log configuration for the container. This parameter maps to LogConfig
\n\t\t\tin the Create a container section of the Docker Remote API and the\n\t\t\t\t--log-driver
option to \n docker\n\t\t\t\t\trun
\n .
By default, containers use the same logging driver that the Docker daemon uses;\n\t\t\thowever the container may use a different logging driver than the Docker daemon by\n\t\t\tspecifying a log driver configuration in the container definition. For more information\n\t\t\ton the options for different supported log drivers, see Configure logging\n\t\t\t\tdrivers in the Docker documentation.
\n\t\tThe following should be noted when specifying a log configuration for your\n\t\t\tcontainers:
\n\t\tAmazon ECS currently supports a subset of the logging drivers available to the\n\t\t\t\t\tDocker daemon (shown in the valid values below). Additional log drivers may be\n\t\t\t\t\tavailable in future releases of the Amazon ECS container agent.
\n\t\t\tThis parameter requires version 1.18 of the Docker Remote API or greater on\n\t\t\t\t\tyour container instance.
\n\t\t\tFor tasks hosted on Amazon EC2 instances, the Amazon ECS container agent must register\n\t\t\t\t\tthe available logging drivers with the\n\t\t\t\t\t\tECS_AVAILABLE_LOGGING_DRIVERS
environment variable before\n\t\t\t\t\tcontainers placed on that instance can use these log configuration options. For\n\t\t\t\t\tmore information, see Amazon ECS container agent configuration in the\n\t\t\t\t\t\tAmazon Elastic Container Service Developer Guide.
For tasks on AWS Fargate, because you do not have access to the underlying\n\t\t\t\t\tinfrastructure your tasks are hosted on, any additional software needed will\n\t\t\t\t\thave to be installed outside of the task. For example, the Fluentd output\n\t\t\t\t\taggregators or a remote host running Logstash to send Gelf logs to.
\n\t\t\tThe Unix timestamp for when the managed agent was last started.
" } }, "name": { "target": "com.amazonaws.ecs#ManagedAgentName", "traits": { "smithy.api#documentation": "The name of the managed agent. When the execute command feature is enabled, the\n\t\t\tmanaged agent name is ExecuteCommandAgent
.
The reason for why the managed agent is in the state it is in.
" } }, "lastStatus": { "target": "com.amazonaws.ecs#String", "traits": { "smithy.api#documentation": "The last known status of the managed agent.
" } } }, "traits": { "smithy.api#documentation": "Details about the managed agent status for the container.
" } }, "com.amazonaws.ecs#ManagedAgentName": { "type": "string", "traits": { "smithy.api#enum": [ { "value": "ExecuteCommandAgent", "name": "ExecuteCommandAgent" } ] } }, "com.amazonaws.ecs#ManagedAgentStateChange": { "type": "structure", "members": { "containerName": { "target": "com.amazonaws.ecs#String", "traits": { "smithy.api#documentation": "The name of the container associated with the managed agent.
", "smithy.api#required": {} } }, "managedAgentName": { "target": "com.amazonaws.ecs#ManagedAgentName", "traits": { "smithy.api#documentation": "The name of the managed agent.
", "smithy.api#required": {} } }, "status": { "target": "com.amazonaws.ecs#String", "traits": { "smithy.api#documentation": "The status of the managed agent.
", "smithy.api#required": {} } }, "reason": { "target": "com.amazonaws.ecs#String", "traits": { "smithy.api#documentation": "The reason for the status of the managed agent.
" } } }, "traits": { "smithy.api#documentation": "An object representing a change in state for a managed agent.
" } }, "com.amazonaws.ecs#ManagedAgentStateChanges": { "type": "list", "member": { "target": "com.amazonaws.ecs#ManagedAgentStateChange" } }, "com.amazonaws.ecs#ManagedAgents": { "type": "list", "member": { "target": "com.amazonaws.ecs#ManagedAgent" } }, "com.amazonaws.ecs#ManagedScaling": { "type": "structure", "members": { "status": { "target": "com.amazonaws.ecs#ManagedScalingStatus", "traits": { "smithy.api#documentation": "Whether or not to enable managed scaling for the capacity provider.
" } }, "targetCapacity": { "target": "com.amazonaws.ecs#ManagedScalingTargetCapacity", "traits": { "smithy.api#documentation": "The target capacity value for the capacity provider. The specified value must be\n\t\t\tgreater than 0
and less than or equal to 100
. A value of\n\t\t\t\t100
will result in the Amazon EC2 instances in your Auto Scaling group being\n\t\t\tcompletely utilized.
The minimum number of container instances that Amazon ECS will scale in or scale out at one\n\t\t\ttime. If this parameter is omitted, the default value of 1
is used.
The maximum number of container instances that Amazon ECS will scale in or scale out at one\n\t\t\ttime. If this parameter is omitted, the default value of 10000
is\n\t\t\tused.
The period of time, in seconds, after a newly launched Amazon EC2 instance can contribute\n\t\t\tto CloudWatch metrics for Auto Scaling group. If this parameter is omitted, the default value\n\t\t\tof 300
seconds is used.
The managed scaling settings for the Auto Scaling group capacity provider.
\n\t\tWhen managed scaling is enabled, Amazon ECS manages the scale-in and scale-out actions of\n\t\t\tthe Auto Scaling group. Amazon ECS manages a target tracking scaling policy using an\n\t\t\tAmazon ECS-managed CloudWatch metric with the specified targetCapacity
value as the\n\t\t\ttarget value for the metric. For more information, see Using Managed Scaling in the Amazon Elastic Container Service Developer Guide.
If managed scaling is disabled, the user must manage the scaling of the Auto Scaling\n\t\t\tgroup.
" } }, "com.amazonaws.ecs#ManagedScalingInstanceWarmupPeriod": { "type": "integer", "traits": { "smithy.api#box": {}, "smithy.api#range": { "min": 0, "max": 10000 } } }, "com.amazonaws.ecs#ManagedScalingStatus": { "type": "string", "traits": { "smithy.api#enum": [ { "value": "ENABLED", "name": "ENABLED" }, { "value": "DISABLED", "name": "DISABLED" } ] } }, "com.amazonaws.ecs#ManagedScalingStepSize": { "type": "integer", "traits": { "smithy.api#box": {}, "smithy.api#range": { "min": 1, "max": 10000 } } }, "com.amazonaws.ecs#ManagedScalingTargetCapacity": { "type": "integer", "traits": { "smithy.api#box": {}, "smithy.api#range": { "min": 1, "max": 100 } } }, "com.amazonaws.ecs#ManagedTerminationProtection": { "type": "string", "traits": { "smithy.api#enum": [ { "value": "ENABLED", "name": "ENABLED" }, { "value": "DISABLED", "name": "DISABLED" } ] } }, "com.amazonaws.ecs#MissingVersionException": { "type": "structure", "members": { "message": { "target": "com.amazonaws.ecs#String" } }, "traits": { "smithy.api#documentation": "Amazon ECS is unable to determine the current version of the Amazon ECS container agent on the\n\t\t\tcontainer instance and does not have enough information to proceed with an update. This\n\t\t\tcould be because the agent running on the container instance is an older or custom\n\t\t\tversion that does not use our version information.
", "smithy.api#error": "client" } }, "com.amazonaws.ecs#MountPoint": { "type": "structure", "members": { "sourceVolume": { "target": "com.amazonaws.ecs#String", "traits": { "smithy.api#documentation": "The name of the volume to mount. Must be a volume name referenced in the\n\t\t\t\tname
parameter of task definition volume
.
The path on the container to mount the host volume at.
" } }, "readOnly": { "target": "com.amazonaws.ecs#BoxedBoolean", "traits": { "smithy.api#documentation": "If this value is true
, the container has read-only access to the volume.\n\t\t\tIf this value is false
, then the container can write to the volume. The\n\t\t\tdefault value is false
.
Details on a volume mount point that is used in a container definition.
" } }, "com.amazonaws.ecs#MountPointList": { "type": "list", "member": { "target": "com.amazonaws.ecs#MountPoint" } }, "com.amazonaws.ecs#NetworkBinding": { "type": "structure", "members": { "bindIP": { "target": "com.amazonaws.ecs#String", "traits": { "smithy.api#documentation": "The IP address that the container is bound to on the container instance.
" } }, "containerPort": { "target": "com.amazonaws.ecs#BoxedInteger", "traits": { "smithy.api#documentation": "The port number on the container that is used with the network binding.
" } }, "hostPort": { "target": "com.amazonaws.ecs#BoxedInteger", "traits": { "smithy.api#documentation": "The port number on the host that is used with the network binding.
" } }, "protocol": { "target": "com.amazonaws.ecs#TransportProtocol", "traits": { "smithy.api#documentation": "The protocol used for the network binding.
" } } }, "traits": { "smithy.api#documentation": "Details on the network bindings between a container and its host container instance.\n\t\t\tAfter a task reaches the RUNNING
status, manual and automatic host and\n\t\t\tcontainer port assignments are visible in the networkBindings
section of\n\t\t\t\tDescribeTasks API responses.
The VPC subnets and security groups associated with a task.
\n\t\tAll specified subnets and security groups must be from the same VPC.
\n\t\tAn object representing the network configuration for a task or service.
" } }, "com.amazonaws.ecs#NetworkInterface": { "type": "structure", "members": { "attachmentId": { "target": "com.amazonaws.ecs#String", "traits": { "smithy.api#documentation": "The attachment ID for the network interface.
" } }, "privateIpv4Address": { "target": "com.amazonaws.ecs#String", "traits": { "smithy.api#documentation": "The private IPv4 address for the network interface.
" } }, "ipv6Address": { "target": "com.amazonaws.ecs#String", "traits": { "smithy.api#documentation": "The private IPv6 address for the network interface.
" } } }, "traits": { "smithy.api#documentation": "An object representing the elastic network interface for tasks that use the\n\t\t\t\tawsvpc
network mode.
There is no update available for this Amazon ECS container agent. This could be because the\n\t\t\tagent is already running the latest version, or it is so old that there is no update\n\t\t\tpath to the current version.
", "smithy.api#error": "client" } }, "com.amazonaws.ecs#PidMode": { "type": "string", "traits": { "smithy.api#enum": [ { "value": "host", "name": "HOST" }, { "value": "task", "name": "TASK" } ] } }, "com.amazonaws.ecs#PlacementConstraint": { "type": "structure", "members": { "type": { "target": "com.amazonaws.ecs#PlacementConstraintType", "traits": { "smithy.api#documentation": "The type of constraint. Use distinctInstance
to ensure that each task in\n\t\t\ta particular group is running on a different container instance. Use\n\t\t\t\tmemberOf
to restrict the selection to a group of valid\n\t\t\tcandidates.
A cluster query language expression to apply to the constraint. You cannot specify an\n\t\t\texpression if the constraint type is distinctInstance
. For more\n\t\t\tinformation, see Cluster Query Language in the\n\t\t\t\tAmazon Elastic Container Service Developer Guide.
An object representing a constraint on task placement. For more information, see\n\t\t\t\tTask Placement Constraints in the\n\t\t\t\tAmazon Elastic Container Service Developer Guide.
\n\t\tIf you are using the Fargate launch type, task placement constraints\n\t\t\t\tare not supported.
\n\t\tThe type of placement strategy. The random
placement strategy randomly\n\t\t\tplaces tasks on available candidates. The spread
placement strategy spreads\n\t\t\tplacement across available candidates evenly based on the field
parameter.\n\t\t\tThe binpack
strategy places tasks on available candidates that have the\n\t\t\tleast available amount of the resource that is specified with the field
\n\t\t\tparameter. For example, if you binpack on memory, a task is placed on the instance with\n\t\t\tthe least amount of remaining memory (but still enough to run the task).
The field to apply the placement strategy against. For the spread
\n\t\t\tplacement strategy, valid values are instanceId
(or host
,\n\t\t\twhich has the same effect), or any platform or custom attribute that is applied to a\n\t\t\tcontainer instance, such as attribute:ecs.availability-zone
. For the\n\t\t\t\tbinpack
placement strategy, valid values are cpu
and\n\t\t\t\tmemory
. For the random
placement strategy, this field is\n\t\t\tnot used.
The task placement strategy for a task or service. For more information, see Task Placement Strategies in the\n\t\t\t\tAmazon Elastic Container Service Developer Guide.
" } }, "com.amazonaws.ecs#PlacementStrategyType": { "type": "string", "traits": { "smithy.api#enum": [ { "value": "random", "name": "RANDOM" }, { "value": "spread", "name": "SPREAD" }, { "value": "binpack", "name": "BINPACK" } ] } }, "com.amazonaws.ecs#PlatformDevice": { "type": "structure", "members": { "id": { "target": "com.amazonaws.ecs#String", "traits": { "smithy.api#documentation": "The ID for the GPU(s) on the container instance. The available GPU IDs can also be\n\t\t\tobtained on the container instance in the\n\t\t\t\t/var/lib/ecs/gpu/nvidia_gpu_info.json
file.
The type of device that is available on the container instance. The only supported\n\t\t\tvalue is GPU
.
The devices that are available on the container instance. The only supported device\n\t\t\ttype is a GPU.
" } }, "com.amazonaws.ecs#PlatformDeviceType": { "type": "string", "traits": { "smithy.api#enum": [ { "value": "GPU", "name": "GPU" } ] } }, "com.amazonaws.ecs#PlatformDevices": { "type": "list", "member": { "target": "com.amazonaws.ecs#PlatformDevice" } }, "com.amazonaws.ecs#PlatformTaskDefinitionIncompatibilityException": { "type": "structure", "members": { "message": { "target": "com.amazonaws.ecs#String" } }, "traits": { "smithy.api#documentation": "The specified platform version does not satisfy the task definition's required\n\t\t\tcapabilities.
", "smithy.api#error": "client" } }, "com.amazonaws.ecs#PlatformUnknownException": { "type": "structure", "members": { "message": { "target": "com.amazonaws.ecs#String" } }, "traits": { "smithy.api#documentation": "The specified platform version does not exist.
", "smithy.api#error": "client" } }, "com.amazonaws.ecs#PortMapping": { "type": "structure", "members": { "containerPort": { "target": "com.amazonaws.ecs#BoxedInteger", "traits": { "smithy.api#documentation": "The port number on the container that is bound to the user-specified or automatically\n\t\t\tassigned host port.
\n\t\tIf you are using containers in a task with the awsvpc
or\n\t\t\t\thost
network mode, exposed ports should be specified using\n\t\t\t\tcontainerPort
.
If you are using containers in a task with the bridge
network mode and\n\t\t\tyou specify a container port and not a host port, your container automatically receives\n\t\t\ta host port in the ephemeral port range. For more information, see\n\t\t\thostPort
. Port mappings that are automatically assigned in this way do not\n\t\t\tcount toward the 100 reserved ports limit of a container instance.
The port number on the container instance to reserve for your container.
\n\t\tIf you are using containers in a task with the awsvpc
or\n\t\t\t\thost
network mode, the hostPort
can either be left blank\n\t\t\tor set to the same value as the containerPort
.
If you are using containers in a task with the bridge
network mode, you\n\t\t\tcan specify a non-reserved host port for your container port mapping, or you can omit\n\t\t\tthe hostPort
(or set it to 0
) while specifying a\n\t\t\t\tcontainerPort
and your container automatically receives a port in the\n\t\t\tephemeral port range for your container instance operating system and Docker\n\t\t\tversion.
The default ephemeral port range for Docker version 1.6.0 and later is listed on the\n\t\t\tinstance under /proc/sys/net/ipv4/ip_local_port_range
. If this kernel\n\t\t\tparameter is unavailable, the default ephemeral port range from 49153 through 65535 is\n\t\t\tused. Do not attempt to specify a host port in the ephemeral port range as these are\n\t\t\treserved for automatic assignment. In general, ports below 32768 are outside of the\n\t\t\tephemeral port range.
The default ephemeral port range from 49153 through 65535 is always used for\n\t\t\t\tDocker versions before 1.6.0.
\n\t\tThe default reserved ports are 22 for SSH, the Docker ports 2375 and 2376, and the\n\t\t\tAmazon ECS container agent ports 51678-51680. Any host port that was previously specified in\n\t\t\ta running task is also reserved while the task is running (after a task stops, the host\n\t\t\tport is released). The current reserved ports are displayed in the\n\t\t\t\tremainingResources
of DescribeContainerInstances\n\t\t\toutput. A container instance can have up to 100 reserved ports at a time, including the\n\t\t\tdefault reserved ports. Automatically assigned ports don't count toward the 100 reserved\n\t\t\tports limit.
The protocol used for the port mapping. Valid values are tcp
and\n\t\t\t\tudp
. The default is tcp
.
Port mappings allow containers to access ports on the host container instance to send\n\t\t\tor receive traffic. Port mappings are specified as part of the container\n\t\t\tdefinition.
\n\t\tIf you are using containers in a task with the awsvpc
or\n\t\t\t\thost
network mode, exposed ports should be specified using\n\t\t\t\tcontainerPort
. The hostPort
can be left blank or it must\n\t\t\tbe the same value as the containerPort
.
You cannot expose the same container port for multiple protocols. An error will be\n\t\t\t\treturned if this is attempted
\n\t\tAfter a task reaches the RUNNING
status, manual and automatic host and\n\t\t\tcontainer port assignments are visible in the networkBindings
section of\n\t\t\t\tDescribeTasks API responses.
The proxy type. The only supported value is APPMESH
.
The name of the container that will serve as the App Mesh proxy.
", "smithy.api#required": {} } }, "properties": { "target": "com.amazonaws.ecs#ProxyConfigurationProperties", "traits": { "smithy.api#documentation": "The set of network configuration parameters to provide the Container Network Interface\n\t\t\t(CNI) plugin, specified as key-value pairs.
\n\t\t\n IgnoredUID
- (Required) The user ID (UID) of the proxy\n\t\t\t\t\tcontainer as defined by the user
parameter in a container\n\t\t\t\t\tdefinition. This is used to ensure the proxy ignores its own traffic. If\n\t\t\t\t\t\tIgnoredGID
is specified, this field can be empty.
\n IgnoredGID
- (Required) The group ID (GID) of the proxy\n\t\t\t\t\tcontainer as defined by the user
parameter in a container\n\t\t\t\t\tdefinition. This is used to ensure the proxy ignores its own traffic. If\n\t\t\t\t\t\tIgnoredUID
is specified, this field can be empty.
\n AppPorts
- (Required) The list of ports that the\n\t\t\t\t\tapplication uses. Network traffic to these ports is forwarded to the\n\t\t\t\t\t\tProxyIngressPort
and ProxyEgressPort
.
\n ProxyIngressPort
- (Required) Specifies the port that\n\t\t\t\t\tincoming traffic to the AppPorts
is directed to.
\n ProxyEgressPort
- (Required) Specifies the port that\n\t\t\t\t\toutgoing traffic from the AppPorts
is directed to.
\n EgressIgnoredPorts
- (Required) The egress traffic going to\n\t\t\t\t\tthe specified ports is ignored and not redirected to the\n\t\t\t\t\t\tProxyEgressPort
. It can be an empty list.
\n EgressIgnoredIPs
- (Required) The egress traffic going to\n\t\t\t\t\tthe specified IP addresses is ignored and not redirected to the\n\t\t\t\t\t\tProxyEgressPort
. It can be an empty list.
The configuration details for the App Mesh proxy.
\n\t\tFor tasks using the EC2 launch type, the container instances require at\n\t\t\tleast version 1.26.0 of the container agent and at least version 1.26.0-1 of the\n\t\t\t\tecs-init
package to enable a proxy configuration. If your container\n\t\t\tinstances are launched from the Amazon ECS-optimized AMI version 20190301
or\n\t\t\tlater, then they contain the required versions of the container agent and\n\t\t\t\tecs-init
. For more information, see Amazon ECS-optimized Linux AMI\n\t\t
Modifies an account setting. Account settings are set on a per-Region basis.
\n\t\tIf you change the account setting for the root user, the default settings for all of\n\t\t\tthe IAM users and roles for which no individual account setting has been specified are\n\t\t\treset. For more information, see Account\n\t\t\t\tSettings in the Amazon Elastic Container Service Developer Guide.
\n\t\tWhen serviceLongArnFormat
, taskLongArnFormat
, or\n\t\t\t\tcontainerInstanceLongArnFormat
are specified, the Amazon Resource Name\n\t\t\t(ARN) and resource ID format of the resource type for a specified IAM user, IAM role, or\n\t\t\tthe root user for an account is affected. The opt-in and opt-out account setting must be\n\t\t\tset for each Amazon ECS resource separately. The ARN and resource ID format of a resource\n\t\t\twill be defined by the opt-in status of the IAM user or role that created the resource.\n\t\t\tYou must enable this setting to use Amazon ECS features such as resource tagging.
When awsvpcTrunking
is specified, the elastic network interface (ENI)\n\t\t\tlimit for any new container instances that support the feature is changed. If\n\t\t\t\tawsvpcTrunking
is enabled, any new container instances that support the\n\t\t\tfeature are launched have the increased ENI limits available to them. For more\n\t\t\tinformation, see Elastic Network\n\t\t\t\tInterface Trunking in the Amazon Elastic Container Service Developer Guide.
When containerInsights
is specified, the default setting indicating\n\t\t\twhether CloudWatch Container Insights is enabled for your clusters is changed. If\n\t\t\t\tcontainerInsights
is enabled, any new clusters that are created will\n\t\t\thave Container Insights enabled unless you disable it during cluster creation. For more\n\t\t\tinformation, see CloudWatch\n\t\t\t\tContainer Insights in the Amazon Elastic Container Service Developer Guide.
Modifies an account setting for all IAM users on an account for whom no individual\n\t\t\taccount setting has been specified. Account settings are set on a per-Region\n\t\t\tbasis.
" } }, "com.amazonaws.ecs#PutAccountSettingDefaultRequest": { "type": "structure", "members": { "name": { "target": "com.amazonaws.ecs#SettingName", "traits": { "smithy.api#documentation": "The resource name for which to modify the account setting. If\n\t\t\t\tserviceLongArnFormat
is specified, the ARN for your Amazon ECS services is\n\t\t\taffected. If taskLongArnFormat
is specified, the ARN and resource ID for\n\t\t\tyour Amazon ECS tasks is affected. If containerInstanceLongArnFormat
is\n\t\t\tspecified, the ARN and resource ID for your Amazon ECS container instances is affected. If\n\t\t\t\tawsvpcTrunking
is specified, the ENI limit for your Amazon ECS container\n\t\t\tinstances is affected. If containerInsights
is specified, the default\n\t\t\tsetting for CloudWatch Container Insights for your clusters is affected.
The account setting value for the specified principal ARN. Accepted values are\n\t\t\t\tenabled
and disabled
.
The current setting for a resource.
" } } } }, "com.amazonaws.ecs#PutAccountSettingRequest": { "type": "structure", "members": { "name": { "target": "com.amazonaws.ecs#SettingName", "traits": { "smithy.api#documentation": "The Amazon ECS resource name for which to modify the account setting. If\n\t\t\t\tserviceLongArnFormat
is specified, the ARN for your Amazon ECS services is\n\t\t\taffected. If taskLongArnFormat
is specified, the ARN and resource ID for\n\t\t\tyour Amazon ECS tasks is affected. If containerInstanceLongArnFormat
is\n\t\t\tspecified, the ARN and resource ID for your Amazon ECS container instances is affected. If\n\t\t\t\tawsvpcTrunking
is specified, the elastic network interface (ENI) limit\n\t\t\tfor your Amazon ECS container instances is affected. If containerInsights
is\n\t\t\tspecified, the default setting for CloudWatch Container Insights for your clusters is\n\t\t\taffected.
The account setting value for the specified principal ARN. Accepted values are\n\t\t\t\tenabled
and disabled
.
The ARN of the principal, which can be an IAM user, IAM role, or the root user. If you\n\t\t\tspecify the root user, it modifies the account setting for all IAM users, IAM roles, and\n\t\t\tthe root user of the account unless an IAM user or role explicitly overrides these\n\t\t\tsettings. If this field is omitted, the setting is changed only for the authenticated\n\t\t\tuser.
\n\t\tFederated users assume the account setting of the root user and can't have\n\t\t\t\texplicit account settings set for them.
\n\t\tThe current account setting for a resource.
" } } } }, "com.amazonaws.ecs#PutAttributes": { "type": "operation", "input": { "target": "com.amazonaws.ecs#PutAttributesRequest" }, "output": { "target": "com.amazonaws.ecs#PutAttributesResponse" }, "errors": [ { "target": "com.amazonaws.ecs#AttributeLimitExceededException" }, { "target": "com.amazonaws.ecs#ClusterNotFoundException" }, { "target": "com.amazonaws.ecs#InvalidParameterException" }, { "target": "com.amazonaws.ecs#TargetNotFoundException" } ], "traits": { "smithy.api#documentation": "Create or update an attribute on an Amazon ECS resource. If the attribute does not exist,\n\t\t\tit is created. If the attribute exists, its value is replaced with the specified value.\n\t\t\tTo delete an attribute, use DeleteAttributes. For more information,\n\t\t\tsee Attributes in the\n\t\t\tAmazon Elastic Container Service Developer Guide.
" } }, "com.amazonaws.ecs#PutAttributesRequest": { "type": "structure", "members": { "cluster": { "target": "com.amazonaws.ecs#String", "traits": { "smithy.api#documentation": "The short name or full Amazon Resource Name (ARN) of the cluster that contains the resource to apply\n\t\t\tattributes. If you do not specify a cluster, the default cluster is assumed.
" } }, "attributes": { "target": "com.amazonaws.ecs#Attributes", "traits": { "smithy.api#documentation": "The attributes to apply to your resource. You can specify up to 10 custom attributes\n\t\t\tper resource. You can specify up to 10 attributes in a single call.
", "smithy.api#required": {} } } } }, "com.amazonaws.ecs#PutAttributesResponse": { "type": "structure", "members": { "attributes": { "target": "com.amazonaws.ecs#Attributes", "traits": { "smithy.api#documentation": "The attributes applied to your resource.
" } } } }, "com.amazonaws.ecs#PutClusterCapacityProviders": { "type": "operation", "input": { "target": "com.amazonaws.ecs#PutClusterCapacityProvidersRequest" }, "output": { "target": "com.amazonaws.ecs#PutClusterCapacityProvidersResponse" }, "errors": [ { "target": "com.amazonaws.ecs#ClientException" }, { "target": "com.amazonaws.ecs#ClusterNotFoundException" }, { "target": "com.amazonaws.ecs#InvalidParameterException" }, { "target": "com.amazonaws.ecs#ResourceInUseException" }, { "target": "com.amazonaws.ecs#ServerException" }, { "target": "com.amazonaws.ecs#UpdateInProgressException" } ], "traits": { "smithy.api#documentation": "Modifies the available capacity providers and the default capacity provider strategy\n\t\t\tfor a cluster.
\n\t\tYou must specify both the available capacity providers and a default capacity provider\n\t\t\tstrategy for the cluster. If the specified cluster has existing capacity providers\n\t\t\tassociated with it, you must specify all existing capacity providers in addition to any\n\t\t\tnew ones you want to add. Any existing capacity providers associated with a cluster that\n\t\t\tare omitted from a PutClusterCapacityProviders API call will be\n\t\t\tdisassociated with the cluster. You can only disassociate an existing capacity provider\n\t\t\tfrom a cluster if it's not being used by any existing tasks.
\n\t\tWhen creating a service or running a task on a cluster, if no capacity provider or\n\t\t\tlaunch type is specified, then the cluster's default capacity provider strategy is used.\n\t\t\tIt is recommended to define a default capacity provider strategy for your cluster,\n\t\t\thowever you may specify an empty array ([]
) to bypass defining a default\n\t\t\tstrategy.
The short name or full Amazon Resource Name (ARN) of the cluster to modify the capacity provider\n\t\t\tsettings for. If you do not specify a cluster, the default cluster is assumed.
", "smithy.api#required": {} } }, "capacityProviders": { "target": "com.amazonaws.ecs#StringList", "traits": { "smithy.api#documentation": "The name of one or more capacity providers to associate with the cluster.
\n\t\tIf specifying a capacity provider that uses an Auto Scaling group, the capacity\n\t\t\tprovider must already be created. New capacity providers can be created with the CreateCapacityProvider API operation.
\n\t\tTo use a AWS Fargate capacity provider, specify either the FARGATE
or\n\t\t\t\tFARGATE_SPOT
capacity providers. The AWS Fargate capacity providers are\n\t\t\tavailable to all accounts and only need to be associated with a cluster to be\n\t\t\tused.
The capacity provider strategy to use by default for the cluster.
\n\t\tWhen creating a service or running a task on a cluster, if no capacity provider or\n\t\t\tlaunch type is specified then the default capacity provider strategy for the cluster is\n\t\t\tused.
\n\t\tA capacity provider strategy consists of one or more capacity providers along with the\n\t\t\t\tbase
and weight
to assign to them. A capacity provider\n\t\t\tmust be associated with the cluster to be used in a capacity provider strategy. The\n\t\t\t\tPutClusterCapacityProviders API is used to associate a capacity\n\t\t\tprovider with a cluster. Only capacity providers with an ACTIVE
or\n\t\t\t\tUPDATING
status can be used.
If specifying a capacity provider that uses an Auto Scaling group, the capacity\n\t\t\tprovider must already be created. New capacity providers can be created with the CreateCapacityProvider API operation.
\n\t\tTo use a AWS Fargate capacity provider, specify either the FARGATE
or\n\t\t\t\tFARGATE_SPOT
capacity providers. The AWS Fargate capacity providers are\n\t\t\tavailable to all accounts and only need to be associated with a cluster to be\n\t\t\tused.
Details about the cluster.
" } } } }, "com.amazonaws.ecs#RegisterContainerInstance": { "type": "operation", "input": { "target": "com.amazonaws.ecs#RegisterContainerInstanceRequest" }, "output": { "target": "com.amazonaws.ecs#RegisterContainerInstanceResponse" }, "errors": [ { "target": "com.amazonaws.ecs#ClientException" }, { "target": "com.amazonaws.ecs#InvalidParameterException" }, { "target": "com.amazonaws.ecs#ServerException" } ], "traits": { "smithy.api#documentation": "This action is only used by the Amazon ECS agent, and it is not intended for use outside of the agent.
\nRegisters an EC2\n\t\t\tinstance into the specified cluster. This instance becomes available to place containers\n\t\t\ton.
" } }, "com.amazonaws.ecs#RegisterContainerInstanceRequest": { "type": "structure", "members": { "cluster": { "target": "com.amazonaws.ecs#String", "traits": { "smithy.api#documentation": "The short name or full Amazon Resource Name (ARN) of the cluster with which to register your container\n\t\t\tinstance. If you do not specify a cluster, the default cluster is assumed.
" } }, "instanceIdentityDocument": { "target": "com.amazonaws.ecs#String", "traits": { "smithy.api#documentation": "The instance identity document for the EC2 instance to register. This document can be\n\t\t\tfound by running the following command from the instance: curl\n\t\t\t\thttp://169.254.169.254/latest/dynamic/instance-identity/document/
\n\t\t
The instance identity document signature for the EC2 instance to register. This\n\t\t\tsignature can be found by running the following command from the instance: curl\n\t\t\t\thttp://169.254.169.254/latest/dynamic/instance-identity/signature/
\n\t\t
The resources available on the instance.
" } }, "versionInfo": { "target": "com.amazonaws.ecs#VersionInfo", "traits": { "smithy.api#documentation": "The version information for the Amazon ECS container agent and Docker daemon running on the\n\t\t\tcontainer instance.
" } }, "containerInstanceArn": { "target": "com.amazonaws.ecs#String", "traits": { "smithy.api#documentation": "The ARN of the container instance (if it was previously registered).
" } }, "attributes": { "target": "com.amazonaws.ecs#Attributes", "traits": { "smithy.api#documentation": "The container instance attributes that this container instance supports.
" } }, "platformDevices": { "target": "com.amazonaws.ecs#PlatformDevices", "traits": { "smithy.api#documentation": "The devices that are available on the container instance. The only supported device\n\t\t\ttype is a GPU.
" } }, "tags": { "target": "com.amazonaws.ecs#Tags", "traits": { "smithy.api#documentation": "The metadata that you apply to the container instance to help you categorize and\n\t\t\torganize them. Each tag consists of a key and an optional value, both of which you\n\t\t\tdefine.
\nThe following basic restrictions apply to tags:
\nMaximum number of tags per resource - 50
\nFor each resource, each tag key must be unique, and each tag key can have only\n one value.
\nMaximum key length - 128 Unicode characters in UTF-8
\nMaximum value length - 256 Unicode characters in UTF-8
\nIf your tagging schema is used across multiple services and resources,\n remember that other services may have restrictions on allowed characters.\n Generally allowed characters are: letters, numbers, and spaces representable in\n UTF-8, and the following characters: + - = . _ : / @.
\nTag keys and values are case-sensitive.
\nDo not use aws:
, AWS:
, or any upper or lowercase\n combination of such as a prefix for either keys or values as it is reserved for\n AWS use. You cannot edit or delete tag keys or values with this prefix. Tags with\n this prefix do not count against your tags per resource limit.
The container instance that was registered.
" } } } }, "com.amazonaws.ecs#RegisterTaskDefinition": { "type": "operation", "input": { "target": "com.amazonaws.ecs#RegisterTaskDefinitionRequest" }, "output": { "target": "com.amazonaws.ecs#RegisterTaskDefinitionResponse" }, "errors": [ { "target": "com.amazonaws.ecs#ClientException" }, { "target": "com.amazonaws.ecs#InvalidParameterException" }, { "target": "com.amazonaws.ecs#ServerException" } ], "traits": { "smithy.api#documentation": "Registers a new task definition from the supplied family
and\n\t\t\t\tcontainerDefinitions
. Optionally, you can add data volumes to your\n\t\t\tcontainers with the volumes
parameter. For more information about task\n\t\t\tdefinition parameters and defaults, see Amazon ECS Task\n\t\t\t\tDefinitions in the Amazon Elastic Container Service Developer Guide.
You can specify an IAM role for your task with the taskRoleArn
parameter.\n\t\t\tWhen you specify an IAM role for a task, its containers can then use the latest versions\n\t\t\tof the AWS CLI or SDKs to make API requests to the AWS services that are specified in\n\t\t\tthe IAM policy associated with the role. For more information, see IAM\n\t\t\t\tRoles for Tasks in the Amazon Elastic Container Service Developer Guide.
You can specify a Docker networking mode for the containers in your task definition\n\t\t\twith the networkMode
parameter. The available network modes correspond to\n\t\t\tthose described in Network\n\t\t\t\tsettings in the Docker run reference. If you specify the awsvpc
\n\t\t\tnetwork mode, the task is allocated an elastic network interface, and you must specify a\n\t\t\t\tNetworkConfiguration when you create a service or run a task with\n\t\t\tthe task definition. For more information, see Task Networking\n\t\t\tin the Amazon Elastic Container Service Developer Guide.
You must specify a family
for a task definition, which allows you to\n\t\t\ttrack multiple versions of the same task definition. The family
is used as\n\t\t\ta name for your task definition. Up to 255 letters (uppercase and lowercase), numbers, underscores, and hyphens are allowed.
The short name or full Amazon Resource Name (ARN) of the IAM role that containers in this task can\n\t\t\tassume. All containers in this task are granted the permissions that are specified in\n\t\t\tthis role. For more information, see IAM Roles for\n\t\t\t\tTasks in the Amazon Elastic Container Service Developer Guide.
" } }, "executionRoleArn": { "target": "com.amazonaws.ecs#String", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the task execution role that grants the Amazon ECS container agent\n permission to make AWS API calls on your behalf. The task execution IAM role is required\n depending on the requirements of your task. For more information, see Amazon ECS task\n execution IAM role in the Amazon Elastic Container Service Developer Guide.
" } }, "networkMode": { "target": "com.amazonaws.ecs#NetworkMode", "traits": { "smithy.api#documentation": "The Docker networking mode to use for the containers in the task. The valid values are\n none
, bridge
, awsvpc
, and host
.\n If no network mode is specified, the default is bridge
.
For Amazon ECS tasks on Fargate, the awsvpc
network mode is required. \n For Amazon ECS tasks on Amazon EC2 instances, any network mode can be used. If the network\n mode is set to none
, you cannot specify port mappings in your container\n definitions, and the tasks containers do not have external connectivity. The\n host
and awsvpc
network modes offer the highest networking\n performance for containers because they use the EC2 network stack instead of the\n virtualized network stack provided by the bridge
mode.
With the host
and awsvpc
network modes, exposed container\n ports are mapped directly to the corresponding host port (for the host
\n network mode) or the attached elastic network interface port (for the\n awsvpc
network mode), so you cannot take advantage of dynamic host port\n mappings.
When using the host
network mode, you should not run\n containers using the root user (UID 0). It is considered best practice\n to use a non-root user.
If the network mode is awsvpc
, the task is allocated an elastic network\n interface, and you must specify a NetworkConfiguration value when you create\n a service or run a task with the task definition. For more information, see Task Networking in the\n Amazon Elastic Container Service Developer Guide.
Currently, only Amazon ECS-optimized AMIs, other Amazon Linux variants with the\n ecs-init
package, or AWS Fargate infrastructure support the\n awsvpc
network mode.
If the network mode is host
, you cannot run multiple instantiations of the\n same task on a single container instance when port mappings are used.
Docker for Windows uses different network modes than Docker for Linux. When you\n register a task definition with Windows containers, you must not specify a network mode.\n If you use the console to register a task definition with Windows containers, you must\n choose the
network mode object.
For more information, see Network\n settings in the Docker run reference.
" } }, "containerDefinitions": { "target": "com.amazonaws.ecs#ContainerDefinitions", "traits": { "smithy.api#documentation": "A list of container definitions in JSON format that describe the different containers\n\t\t\tthat make up your task.
", "smithy.api#required": {} } }, "volumes": { "target": "com.amazonaws.ecs#VolumeList", "traits": { "smithy.api#documentation": "A list of volume definitions in JSON format that containers in your task may\n\t\t\tuse.
" } }, "placementConstraints": { "target": "com.amazonaws.ecs#TaskDefinitionPlacementConstraints", "traits": { "smithy.api#documentation": "An array of placement constraint objects to use for the task. You can specify a\n\t\t\tmaximum of 10 constraints per task (this limit includes constraints in the task\n\t\t\tdefinition and those specified at runtime).
" } }, "requiresCompatibilities": { "target": "com.amazonaws.ecs#CompatibilityList", "traits": { "smithy.api#documentation": "The task launch type that Amazon ECS should validate the task definition against. A client\n\t\t\texception is returned if the task definition doesn't validate against the\n\t\t\tcompatibilities specified. If no value is specified, the parameter is omitted from the\n\t\t\tresponse.
" } }, "cpu": { "target": "com.amazonaws.ecs#String", "traits": { "smithy.api#documentation": "The number of CPU units used by the task. It can be expressed as an integer using CPU\n\t\t\tunits, for example 1024
, or as a string using vCPUs, for example 1\n\t\t\t\tvCPU
or 1 vcpu
, in a task definition. String values are\n\t\t\tconverted to an integer indicating the CPU units when the task definition is\n\t\t\tregistered.
Task-level CPU and memory parameters are ignored for Windows containers. We\n\t\t\t\trecommend specifying container-level resources for Windows containers.
\n\t\tIf you are using the EC2 launch type, this field is optional. Supported\n\t\t\tvalues are between 128
CPU units (0.125
vCPUs) and\n\t\t\t\t10240
CPU units (10
vCPUs).
If you are using the Fargate launch type, this field is required and you\n\t\t\tmust use one of the following values, which determines your range of supported values\n\t\t\tfor the memory
parameter:
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: Between 4096 (4 GB) and 16384 (16 GB) in increments of 1024 (1 GB)
4096 (4 vCPU) - Available memory
values: Between 8192 (8 GB) and 30720 (30 GB) in increments of 1024 (1 GB)
The amount of memory (in MiB) used by the task. It can be expressed as an integer\n\t\t\tusing MiB, for example 1024
, or as a string using GB, for example\n\t\t\t\t1GB
or 1 GB
, in a task definition. String values are\n\t\t\tconverted to an integer indicating the MiB when the task definition is\n\t\t\tregistered.
Task-level CPU and memory parameters are ignored for Windows containers. We\n\t\t\t\trecommend specifying container-level resources for Windows containers.
\n\t\tIf using the EC2 launch type, this field is optional.
\n\t\tIf using the Fargate launch type, this field is required and you must\n\t\t\tuse one of the following values, which determines your range of supported values for the\n\t\t\t\tcpu
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)
The metadata that you apply to the task definition to help you categorize and organize\n\t\t\tthem. Each tag consists of a key and an optional value, both of which you define.
\n\t\tThe following basic restrictions apply to tags:
\nMaximum number of tags per resource - 50
\nFor each resource, each tag key must be unique, and each tag key can have only\n one value.
\nMaximum key length - 128 Unicode characters in UTF-8
\nMaximum value length - 256 Unicode characters in UTF-8
\nIf your tagging schema is used across multiple services and resources,\n remember that other services may have restrictions on allowed characters.\n Generally allowed characters are: letters, numbers, and spaces representable in\n UTF-8, and the following characters: + - = . _ : / @.
\nTag keys and values are case-sensitive.
\nDo not use aws:
, AWS:
, or any upper or lowercase\n combination of such as a prefix for either keys or values as it is reserved for\n AWS use. You cannot edit or delete tag keys or values with this prefix. Tags with\n this prefix do not count against your tags per resource limit.
The process namespace to use for the containers in the task. The valid\n values are host
or task
. If host
\n is specified, then all containers within the tasks that specified the\n host
PID mode on the same container instance share the\n same process namespace with the host Amazon EC2 instance. If task
is\n specified, all containers within the specified task share the same\n process namespace. If no value is specified, the default is a private\n namespace. For more information, see PID settings in the Docker run\n reference.
If the host
PID mode is used, be aware that there is a\n heightened risk of undesired process namespace expose. For more\n information, see Docker\n security.
This parameter is not supported for Windows containers or tasks run on AWS Fargate.
\nThe IPC resource namespace to use for the containers in the task. The valid values are\n host
, task
, or none
. If host
is\n specified, then all containers within the tasks that specified the host
IPC\n mode on the same container instance share the same IPC resources with the host Amazon EC2\n instance. If task
is specified, all containers within the specified task\n share the same IPC resources. If none
is specified, then IPC resources\n within the containers of a task are private and not shared with other containers in a\n task or on the container instance. If no value is specified, then the IPC resource\n namespace sharing depends on the Docker daemon setting on the container instance. For\n more information, see IPC\n settings in the Docker run reference.
If the host
IPC mode is used, be aware that there is a heightened risk of\n undesired IPC namespace expose. For more information, see Docker\n security.
If you are setting namespaced kernel parameters using systemControls
for\n the containers in the task, the following will apply to your IPC resource namespace. For\n more information, see System\n Controls in the Amazon Elastic Container Service Developer Guide.
For tasks that use the host
IPC mode, IPC namespace related\n systemControls
are not supported.
For tasks that use the task
IPC mode, IPC namespace related\n systemControls
will apply to all containers within a\n task.
This parameter is not supported for Windows containers or tasks run on AWS Fargate.
\nThe configuration details for the App Mesh proxy.
\n\t\tFor tasks hosted on Amazon EC2 instances, the container instances require at least version\n\t\t\t\t1.26.0
of the container agent and at least version\n\t\t\t\t1.26.0-1
of the ecs-init
package to enable a proxy\n\t\t\tconfiguration. If your container instances are launched from the Amazon ECS-optimized\n\t\t\tAMI version 20190301
or later, then they contain the required versions of\n\t\t\tthe container agent and ecs-init
. For more information, see Amazon ECS-optimized AMI versions in the\n\t\t\tAmazon Elastic Container Service Developer Guide.
The Elastic Inference accelerators to use for the containers in the task.
" } }, "ephemeralStorage": { "target": "com.amazonaws.ecs#EphemeralStorage", "traits": { "smithy.api#documentation": "The amount of ephemeral storage to allocate for the task. This parameter is used to\n\t\t\texpand the total amount of ephemeral storage available, beyond the default amount, for\n\t\t\ttasks hosted on AWS Fargate. For more information, see Fargate task\n\t\t\t\tstorage in the Amazon ECS User Guide for AWS Fargate.
\n\t\tThis parameter is only supported for tasks hosted on AWS Fargate using platform\n\t\t\t\tversion 1.4.0
or later.
The full description of the registered task definition.
" } }, "tags": { "target": "com.amazonaws.ecs#Tags", "traits": { "smithy.api#documentation": "The list of tags associated with the task definition.
" } } } }, "com.amazonaws.ecs#RepositoryCredentials": { "type": "structure", "members": { "credentialsParameter": { "target": "com.amazonaws.ecs#String", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the secret containing the private repository\n\t\t\tcredentials.
\n\t\tWhen you are using the Amazon ECS API, AWS CLI, or AWS SDK, if the secret exists in the\n\t\t\t\tsame Region as the task that you are launching then you can use either the full ARN\n\t\t\t\tor the name of the secret. When you are using the AWS Management Console, you must specify the\n\t\t\t\tfull ARN of the secret.
\n\t\tThe repository credentials for private registry authentication.
" } }, "com.amazonaws.ecs#RequiresAttributes": { "type": "list", "member": { "target": "com.amazonaws.ecs#Attribute" } }, "com.amazonaws.ecs#Resource": { "type": "structure", "members": { "name": { "target": "com.amazonaws.ecs#String", "traits": { "smithy.api#documentation": "The name of the resource, such as CPU
, MEMORY
,\n\t\t\t\tPORTS
, PORTS_UDP
, or a user-defined resource.
The type of the resource, such as INTEGER
, DOUBLE
,\n\t\t\t\tLONG
, or STRINGSET
.
When the doubleValue
type is set, the value of the resource must be a\n\t\t\tdouble precision floating-point type.
When the longValue
type is set, the value of the resource must be an\n\t\t\textended precision floating-point type.
When the integerValue
type is set, the value of the resource must be an\n\t\t\tinteger.
When the stringSetValue
type is set, the value of the resource must be a\n\t\t\tstring type.
Describes the resources available for a container instance.
" } }, "com.amazonaws.ecs#ResourceInUseException": { "type": "structure", "members": { "message": { "target": "com.amazonaws.ecs#String" } }, "traits": { "smithy.api#documentation": "The specified resource is in-use and cannot be removed.
", "smithy.api#error": "client" } }, "com.amazonaws.ecs#ResourceNotFoundException": { "type": "structure", "members": { "message": { "target": "com.amazonaws.ecs#String" } }, "traits": { "smithy.api#documentation": "The specified resource could not be found.
", "smithy.api#error": "client" } }, "com.amazonaws.ecs#ResourceRequirement": { "type": "structure", "members": { "value": { "target": "com.amazonaws.ecs#String", "traits": { "smithy.api#documentation": "The value for the specified resource type.
\n\t\tIf the GPU
type is used, the value is the number of physical\n\t\t\t\tGPUs
the Amazon ECS container agent will reserve for the container. The\n\t\t\tnumber of GPUs reserved for all containers in a task should not exceed the number of\n\t\t\tavailable GPUs on the container instance the task is launched on.
If the InferenceAccelerator
type is used, the value
should\n\t\t\tmatch the deviceName
for an InferenceAccelerator\n\t\t\tspecified in a task definition.
The type of resource to assign to a container. The supported values are\n\t\t\t\tGPU
or InferenceAccelerator
.
The type and amount of a resource to assign to a container. The supported resource\n\t\t\ttypes are GPUs and Elastic Inference accelerators. For more information, see Working with\n\t\t\t\tGPUs on Amazon ECS or Working with Amazon Elastic Inference on Amazon ECS in the\n\t\t\t\tAmazon Elastic Container Service Developer Guide\n
" } }, "com.amazonaws.ecs#ResourceRequirements": { "type": "list", "member": { "target": "com.amazonaws.ecs#ResourceRequirement" } }, "com.amazonaws.ecs#ResourceType": { "type": "string", "traits": { "smithy.api#enum": [ { "value": "GPU", "name": "GPU" }, { "value": "InferenceAccelerator", "name": "INFERENCE_ACCELERATOR" } ] } }, "com.amazonaws.ecs#Resources": { "type": "list", "member": { "target": "com.amazonaws.ecs#Resource" } }, "com.amazonaws.ecs#RunTask": { "type": "operation", "input": { "target": "com.amazonaws.ecs#RunTaskRequest" }, "output": { "target": "com.amazonaws.ecs#RunTaskResponse" }, "errors": [ { "target": "com.amazonaws.ecs#AccessDeniedException" }, { "target": "com.amazonaws.ecs#BlockedException" }, { "target": "com.amazonaws.ecs#ClientException" }, { "target": "com.amazonaws.ecs#ClusterNotFoundException" }, { "target": "com.amazonaws.ecs#InvalidParameterException" }, { "target": "com.amazonaws.ecs#PlatformTaskDefinitionIncompatibilityException" }, { "target": "com.amazonaws.ecs#PlatformUnknownException" }, { "target": "com.amazonaws.ecs#ServerException" }, { "target": "com.amazonaws.ecs#UnsupportedFeatureException" } ], "traits": { "smithy.api#documentation": "Starts a new task using the specified task definition.
\n\t\tYou can allow Amazon ECS to place tasks for you, or you can customize how Amazon ECS places\n\t\t\ttasks using placement constraints and placement strategies. For more information, see\n\t\t\t\tScheduling Tasks in the\n\t\t\t\tAmazon Elastic Container Service Developer Guide.
\n\t\tAlternatively, you can use StartTask to use your own scheduler or\n\t\t\tplace tasks manually on specific container instances.
\n\t\tThe Amazon ECS API follows an eventual consistency model, due to the distributed nature of\n\t\t\tthe system supporting the API. This means that the result of an API command you run that\n\t\t\taffects your Amazon ECS resources might not be immediately visible to all subsequent commands\n\t\t\tyou run. Keep this in mind when you carry out an API command that immediately follows a\n\t\t\tprevious API command.
\n\t\tTo manage eventual consistency, you can do the following:
\n\t\tConfirm the state of the resource before you run a command to modify it. Run\n\t\t\t\t\tthe DescribeTasks command using an exponential backoff algorithm to ensure that\n\t\t\t\t\tyou allow enough time for the previous command to propagate through the system.\n\t\t\t\t\tTo do this, run the DescribeTasks command repeatedly, starting with a couple of\n\t\t\t\t\tseconds of wait time and increasing gradually up to five minutes of wait\n\t\t\t\t\ttime.
\n\t\t\tAdd wait time between subsequent commands, even if the DescribeTasks command\n\t\t\t\t\treturns an accurate response. Apply an exponential backoff algorithm starting\n\t\t\t\t\twith a couple of seconds of wait time, and increase gradually up to about five\n\t\t\t\t\tminutes of wait time.
\n\t\t\tThe capacity provider strategy to use for the task.
\n\t\tIf a capacityProviderStrategy
is specified, the launchType
\n\t\t\tparameter must be omitted. If no capacityProviderStrategy
or\n\t\t\t\tlaunchType
is specified, the\n\t\t\t\tdefaultCapacityProviderStrategy
for the cluster is used.
The short name or full Amazon Resource Name (ARN) of the cluster on which to run your task.\n\t\t\tIf you do not specify a cluster, the default cluster is assumed.
" } }, "count": { "target": "com.amazonaws.ecs#BoxedInteger", "traits": { "smithy.api#documentation": "The number of instantiations of the specified task to place on your cluster. You can\n\t\t\tspecify up to 10 tasks per call.
" } }, "enableECSManagedTags": { "target": "com.amazonaws.ecs#Boolean", "traits": { "smithy.api#documentation": "Specifies whether to enable Amazon ECS managed tags for the task. For more information, see\n\t\t\t\tTagging Your Amazon ECS\n\t\t\t\tResources in the Amazon Elastic Container Service Developer Guide.
" } }, "enableExecuteCommand": { "target": "com.amazonaws.ecs#Boolean", "traits": { "smithy.api#documentation": "Whether or not to enable the execute command functionality for the containers in this\n\t\t\ttask. If true
, this enables execute command functionality on all containers\n\t\t\tin the task.
The name of the task group to associate with the task. The default value is the family\n\t\t\tname of the task definition (for example, family:my-family-name).
" } }, "launchType": { "target": "com.amazonaws.ecs#LaunchType", "traits": { "smithy.api#documentation": "The launch type on which to run your task. The accepted values are\n\t\t\t\tFARGATE
and EC2
. For more information, see Amazon ECS\n\t\t\t\tLaunch Types in the Amazon Elastic Container Service Developer Guide.
When a value of FARGATE
is specified, your tasks are launched on\n\t\t\tAWS Fargate On-Demand infrastructure. To use Fargate Spot, you must use a capacity\n\t\t\tprovider strategy with the FARGATE_SPOT
capacity provider.
When a value of EC2
is specified, your tasks are launched on Amazon EC2\n\t\t\tinstances registered to your cluster.
If a launchType
is specified, the capacityProviderStrategy
\n\t\t\tparameter must be omitted.
The network configuration for the task. This parameter is required for task\n\t\t\tdefinitions that use the awsvpc
network mode to receive their own elastic\n\t\t\tnetwork interface, and it is not supported for other network modes. For more\n\t\t\tinformation, see Task Networking\n\t\t\tin the Amazon Elastic Container Service Developer Guide.
A list of container overrides in JSON format that specify the name of a container in\n\t\t\tthe specified task definition and the overrides it should receive. You can override the\n\t\t\tdefault command for a container (that is specified in the task definition or Docker\n\t\t\timage) with a command
override. You can also override existing environment\n\t\t\tvariables (that are specified in the task definition or Docker image) on a container or\n\t\t\tadd new environment variables to it with an environment
override.
A total of 8192 characters are allowed for overrides. This limit includes the JSON\n\t\t\t\tformatting characters of the override structure.
\n\t\tAn array of placement constraint objects to use for the task. You can specify up to 10\n\t\t\tconstraints per task (including constraints in the task definition and those specified\n\t\t\tat runtime).
" } }, "placementStrategy": { "target": "com.amazonaws.ecs#PlacementStrategies", "traits": { "smithy.api#documentation": "The placement strategy objects to use for the task. You can specify a maximum of five\n\t\t\tstrategy rules per task.
" } }, "platformVersion": { "target": "com.amazonaws.ecs#String", "traits": { "smithy.api#documentation": "The platform version the task should run. A platform version is only specified for\n\t\t\ttasks using the Fargate launch type. If one is not specified, the\n\t\t\t\tLATEST
platform version is used by default. For more information, see\n\t\t\t\tAWS Fargate Platform\n\t\t\t\tVersions in the Amazon Elastic Container Service Developer Guide.
Specifies whether to propagate the tags from the task definition to the task. If no\n\t\t\tvalue is specified, the tags are not propagated. Tags can only be propagated to the task\n\t\t\tduring task creation. To add tags to a task after task creation, use the TagResource API action.
\n\t\tAn error will be received if you specify the SERVICE
option when\n\t\t\t\trunning a task.
The reference ID to use for the task.
" } }, "startedBy": { "target": "com.amazonaws.ecs#String", "traits": { "smithy.api#documentation": "An optional tag specified when a task is started. For example, if you automatically\n\t\t\ttrigger a task to run a batch process job, you could apply a unique identifier for that\n\t\t\tjob to your task with the startedBy
parameter. You can then identify which\n\t\t\ttasks belong to that job by filtering the results of a ListTasks call\n\t\t\twith the startedBy
value. Up to 36 letters (uppercase and lowercase),\n\t\t\tnumbers, hyphens, and underscores are allowed.
If a task is started by an Amazon ECS service, then the startedBy
parameter\n\t\t\tcontains the deployment ID of the service that starts it.
The metadata that you apply to the task to help you categorize and organize them. Each\n\t\t\ttag consists of a key and an optional value, both of which you define.
\n\t\tThe following basic restrictions apply to tags:
\nMaximum number of tags per resource - 50
\nFor each resource, each tag key must be unique, and each tag key can have only\n one value.
\nMaximum key length - 128 Unicode characters in UTF-8
\nMaximum value length - 256 Unicode characters in UTF-8
\nIf your tagging schema is used across multiple services and resources,\n remember that other services may have restrictions on allowed characters.\n Generally allowed characters are: letters, numbers, and spaces representable in\n UTF-8, and the following characters: + - = . _ : / @.
\nTag keys and values are case-sensitive.
\nDo not use aws:
, AWS:
, or any upper or lowercase\n combination of such as a prefix for either keys or values as it is reserved for\n AWS use. You cannot edit or delete tag keys or values with this prefix. Tags with\n this prefix do not count against your tags per resource limit.
The family
and revision
(family:revision
) or\n\t\t\tfull ARN of the task definition to run. If a revision
is not specified,\n\t\t\tthe latest ACTIVE
revision is used.
A full description of the tasks that were run. The tasks that were successfully placed\n\t\t\ton your cluster are described here.
" } }, "failures": { "target": "com.amazonaws.ecs#Failures", "traits": { "smithy.api#documentation": "Any failures associated with the call.
" } } } }, "com.amazonaws.ecs#Scale": { "type": "structure", "members": { "value": { "target": "com.amazonaws.ecs#Double", "traits": { "smithy.api#documentation": "The value, specified as a percent total of a service's desiredCount
, to\n\t\t\tscale the task set. Accepted values are numbers between 0 and 100.
The unit of measure for the scale value.
" } } }, "traits": { "smithy.api#documentation": "A floating-point percentage of the desired number of tasks to place and keep running\n\t\t\tin the task set.
" } }, "com.amazonaws.ecs#ScaleUnit": { "type": "string", "traits": { "smithy.api#enum": [ { "value": "PERCENT", "name": "PERCENT" } ] } }, "com.amazonaws.ecs#SchedulingStrategy": { "type": "string", "traits": { "smithy.api#enum": [ { "value": "REPLICA", "name": "REPLICA" }, { "value": "DAEMON", "name": "DAEMON" } ] } }, "com.amazonaws.ecs#Scope": { "type": "string", "traits": { "smithy.api#enum": [ { "value": "task", "name": "TASK" }, { "value": "shared", "name": "SHARED" } ] } }, "com.amazonaws.ecs#Secret": { "type": "structure", "members": { "name": { "target": "com.amazonaws.ecs#String", "traits": { "smithy.api#documentation": "The name of the secret.
", "smithy.api#required": {} } }, "valueFrom": { "target": "com.amazonaws.ecs#String", "traits": { "smithy.api#documentation": "The secret to expose to the container. The supported values are either the full ARN of\n\t\t\tthe AWS Secrets Manager secret or the full ARN of the parameter in the AWS Systems Manager Parameter Store.
\n\t\tIf the AWS Systems Manager Parameter Store parameter exists in the same Region as the task you\n\t\t\t\tare launching, then you can use either the full ARN or name of the parameter. If the\n\t\t\t\tparameter exists in a different Region, then the full ARN must be specified.
\n\t\tAn object representing the secret to expose to your container. Secrets can be exposed\n\t\t\tto a container in the following ways:
\n\t\tTo inject sensitive data into your containers as environment variables, use\n\t\t\t\t\tthe secrets
container definition parameter.
To reference sensitive information in the log configuration of a container,\n\t\t\t\t\tuse the secretOptions
container definition parameter.
For more information, see Specifying\n\t\t\t\tSensitive Data in the Amazon Elastic Container Service Developer Guide.
" } }, "com.amazonaws.ecs#SecretList": { "type": "list", "member": { "target": "com.amazonaws.ecs#Secret" } }, "com.amazonaws.ecs#SensitiveString": { "type": "string", "traits": { "smithy.api#sensitive": {} } }, "com.amazonaws.ecs#ServerException": { "type": "structure", "members": { "message": { "target": "com.amazonaws.ecs#String" } }, "traits": { "smithy.api#documentation": "These errors are usually caused by a server issue.
", "smithy.api#error": "server" } }, "com.amazonaws.ecs#Service": { "type": "structure", "members": { "serviceArn": { "target": "com.amazonaws.ecs#String", "traits": { "smithy.api#documentation": "The ARN that identifies the service. The ARN contains the arn:aws:ecs
namespace, followed by the Region of the service, the AWS account ID of the service owner, the service
namespace, and then the service name. For example, arn:aws:ecs:region:012345678910:service/my-service
.
The name of your service. Up to 255 letters (uppercase and lowercase), numbers, underscores, and hyphens are allowed. Service names must be unique within\n\t\t\ta cluster, but you can have similarly named services in multiple clusters within a\n\t\t\tRegion or across multiple Regions.
" } }, "clusterArn": { "target": "com.amazonaws.ecs#String", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the cluster that hosts the service.
" } }, "loadBalancers": { "target": "com.amazonaws.ecs#LoadBalancers", "traits": { "smithy.api#documentation": "A list of Elastic Load Balancing load balancer objects, containing the load balancer name, the\n\t\t\tcontainer name (as it appears in a container definition), and the container port to\n\t\t\taccess from the load balancer.
" } }, "serviceRegistries": { "target": "com.amazonaws.ecs#ServiceRegistries", "traits": { "smithy.api#documentation": "The details of the service discovery registries to assign to this service. For more\n\t\t\tinformation, see Service\n\t\t\t\tDiscovery.
" } }, "status": { "target": "com.amazonaws.ecs#String", "traits": { "smithy.api#documentation": "The status of the service. The valid values are ACTIVE
,\n\t\t\t\tDRAINING
, or INACTIVE
.
The desired number of instantiations of the task definition to keep running on the\n\t\t\tservice. This value is specified when the service is created with CreateService, and it can be modified with UpdateService.
" } }, "runningCount": { "target": "com.amazonaws.ecs#Integer", "traits": { "smithy.api#documentation": "The number of tasks in the cluster that are in the RUNNING
state.
The number of tasks in the cluster that are in the PENDING
state.
The launch type on which your service is running. If no value is specified, it will\n\t\t\tdefault to EC2
. Valid values include EC2
and\n\t\t\t\tFARGATE
. For more information, see Amazon ECS\n\t\t\t\tLaunch Types in the Amazon Elastic Container Service Developer Guide.
The capacity provider strategy associated with the service.
" } }, "platformVersion": { "target": "com.amazonaws.ecs#String", "traits": { "smithy.api#documentation": "The platform version on which to run your service. A platform version is only\n\t\t\tspecified for tasks using the Fargate launch type. If one is not\n\t\t\tspecified, the LATEST
platform version is used by default. For more\n\t\t\tinformation, see AWS Fargate Platform\n\t\t\t\tVersions in the Amazon Elastic Container Service Developer Guide.
The task definition to use for tasks in the service. This value is specified when the\n\t\t\tservice is created with CreateService, and it can be modified with\n\t\t\t\tUpdateService.
" } }, "deploymentConfiguration": { "target": "com.amazonaws.ecs#DeploymentConfiguration", "traits": { "smithy.api#documentation": "Optional deployment parameters that control how many tasks run during the deployment\n\t\t\tand the ordering of stopping and starting tasks.
" } }, "taskSets": { "target": "com.amazonaws.ecs#TaskSets", "traits": { "smithy.api#documentation": "Information about a set of Amazon ECS tasks in either an AWS CodeDeploy or an EXTERNAL
\n\t\t\tdeployment. An Amazon ECS task set includes details such as the desired number of tasks, how\n\t\t\tmany tasks are running, and whether the task set serves production traffic.
The current state of deployments for the service.
" } }, "roleArn": { "target": "com.amazonaws.ecs#String", "traits": { "smithy.api#documentation": "The ARN of the IAM role associated with the service that allows the Amazon ECS container\n\t\t\tagent to register container instances with an Elastic Load Balancing load balancer.
" } }, "events": { "target": "com.amazonaws.ecs#ServiceEvents", "traits": { "smithy.api#documentation": "The event stream for your service. A maximum of 100 of the latest events are\n\t\t\tdisplayed.
" } }, "createdAt": { "target": "com.amazonaws.ecs#Timestamp", "traits": { "smithy.api#documentation": "The Unix timestamp for when the service was created.
" } }, "placementConstraints": { "target": "com.amazonaws.ecs#PlacementConstraints", "traits": { "smithy.api#documentation": "The placement constraints for the tasks in the service.
" } }, "placementStrategy": { "target": "com.amazonaws.ecs#PlacementStrategies", "traits": { "smithy.api#documentation": "The placement strategy that determines how tasks for the service are placed.
" } }, "networkConfiguration": { "target": "com.amazonaws.ecs#NetworkConfiguration", "traits": { "smithy.api#documentation": "The VPC subnet and security group configuration for tasks that receive their own\n elastic network interface by using the awsvpc
networking mode.
The period of time, in seconds, that the Amazon ECS service scheduler ignores unhealthy\n\t\t\tElastic Load Balancing target health checks after a task has first started.
" } }, "schedulingStrategy": { "target": "com.amazonaws.ecs#SchedulingStrategy", "traits": { "smithy.api#documentation": "The scheduling strategy to use for the service. For more information, see Services.
\n\t\tThere are two service scheduler strategies available:
\n\t\t\n REPLICA
-The replica scheduling strategy places and\n\t\t\t\t\tmaintains the desired number of tasks across your cluster. By default, the\n\t\t\t\t\tservice scheduler spreads tasks across Availability Zones. You can use task\n\t\t\t\t\tplacement strategies and constraints to customize task placement\n\t\t\t\t\tdecisions.
\n DAEMON
-The daemon scheduling strategy deploys exactly one\n\t\t\t\t\ttask on each active container instance that meets all of the task placement\n\t\t\t\t\tconstraints that you specify in your cluster. The service scheduler also\n\t\t\t\t\tevaluates the task placement constraints for running tasks and will stop tasks\n\t\t\t\t\tthat do not meet the placement constraints.
Fargate tasks do not support the DAEMON
\n\t\t\t\t\t\tscheduling strategy.
The deployment controller type the service is using. When using the DescribeServices\n\t\t\tAPI, this field is omitted if the service is using the ECS
deployment\n\t\t\tcontroller type.
The metadata that you apply to the service to help you categorize and organize them.\n\t\t\tEach tag consists of a key and an optional value, both of which you define.
\n\t\tThe following basic restrictions apply to tags:
\nMaximum number of tags per resource - 50
\nFor each resource, each tag key must be unique, and each tag key can have only\n one value.
\nMaximum key length - 128 Unicode characters in UTF-8
\nMaximum value length - 256 Unicode characters in UTF-8
\nIf your tagging schema is used across multiple services and resources,\n remember that other services may have restrictions on allowed characters.\n Generally allowed characters are: letters, numbers, and spaces representable in\n UTF-8, and the following characters: + - = . _ : / @.
\nTag keys and values are case-sensitive.
\nDo not use aws:
, AWS:
, or any upper or lowercase\n combination of such as a prefix for either keys or values as it is reserved for\n AWS use. You cannot edit or delete tag keys or values with this prefix. Tags with\n this prefix do not count against your tags per resource limit.
The principal that created the service.
" } }, "enableECSManagedTags": { "target": "com.amazonaws.ecs#Boolean", "traits": { "smithy.api#documentation": "Specifies whether to enable Amazon ECS managed tags for the tasks in the service. For more\n\t\t\tinformation, see Tagging Your Amazon ECS\n\t\t\t\tResources in the Amazon Elastic Container Service Developer Guide.
" } }, "propagateTags": { "target": "com.amazonaws.ecs#PropagateTags", "traits": { "smithy.api#documentation": "Specifies whether to propagate the tags from the task definition or the service to the\n\t\t\ttask. If no value is specified, the tags are not propagated.
" } }, "enableExecuteCommand": { "target": "com.amazonaws.ecs#Boolean", "traits": { "smithy.api#documentation": "Whether or not the execute command functionality is enabled for the service. If\n\t\t\t\ttrue
, the execute command functionality is enabled for all containers\n\t\t\tin tasks as part of the service.
Details on a service within a cluster
" } }, "com.amazonaws.ecs#ServiceEvent": { "type": "structure", "members": { "id": { "target": "com.amazonaws.ecs#String", "traits": { "smithy.api#documentation": "The ID string of the event.
" } }, "createdAt": { "target": "com.amazonaws.ecs#Timestamp", "traits": { "smithy.api#documentation": "The Unix timestamp for when the event was triggered.
" } }, "message": { "target": "com.amazonaws.ecs#String", "traits": { "smithy.api#documentation": "The event message.
" } } }, "traits": { "smithy.api#documentation": "Details on an event associated with a service.
" } }, "com.amazonaws.ecs#ServiceEvents": { "type": "list", "member": { "target": "com.amazonaws.ecs#ServiceEvent" } }, "com.amazonaws.ecs#ServiceField": { "type": "string", "traits": { "smithy.api#enum": [ { "value": "TAGS", "name": "TAGS" } ] } }, "com.amazonaws.ecs#ServiceFieldList": { "type": "list", "member": { "target": "com.amazonaws.ecs#ServiceField" } }, "com.amazonaws.ecs#ServiceNotActiveException": { "type": "structure", "members": { "message": { "target": "com.amazonaws.ecs#String" } }, "traits": { "smithy.api#documentation": "The specified service is not active. You can't update a service that is inactive. If\n\t\t\tyou have previously deleted a service, you can re-create it with CreateService.
", "smithy.api#error": "client" } }, "com.amazonaws.ecs#ServiceNotFoundException": { "type": "structure", "members": { "message": { "target": "com.amazonaws.ecs#String" } }, "traits": { "smithy.api#documentation": "The specified service could not be found. You can view your available services with\n\t\t\t\tListServices. Amazon ECS services are cluster-specific and\n\t\t\tRegion-specific.
", "smithy.api#error": "client" } }, "com.amazonaws.ecs#ServiceRegistries": { "type": "list", "member": { "target": "com.amazonaws.ecs#ServiceRegistry" } }, "com.amazonaws.ecs#ServiceRegistry": { "type": "structure", "members": { "registryArn": { "target": "com.amazonaws.ecs#String", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the service registry. The currently supported service registry is\n\t\t\tAWS Cloud Map. For more information, see CreateService.
" } }, "port": { "target": "com.amazonaws.ecs#BoxedInteger", "traits": { "smithy.api#documentation": "The port value used if your service discovery service specified an SRV record. This\n\t\t\tfield may be used if both the awsvpc
network mode and SRV records are\n\t\t\tused.
The container name value, already specified in the task definition, to be used for\n\t\t\tyour service discovery service. If the task definition that your service task specifies\n\t\t\tuses the bridge
or host
network mode, you must specify a\n\t\t\t\tcontainerName
and containerPort
combination from the task\n\t\t\tdefinition. If the task definition that your service task specifies uses the\n\t\t\t\tawsvpc
network mode and a type SRV DNS record is used, you must specify\n\t\t\teither a containerName
and containerPort
combination or a\n\t\t\t\tport
value, but not both.
The port value, already specified in the task definition, to be used for your service\n\t\t\tdiscovery service. If the task definition your service task specifies uses the\n\t\t\t\tbridge
or host
network mode, you must specify a\n\t\t\t\tcontainerName
and containerPort
combination from the task\n\t\t\tdefinition. If the task definition your service task specifies uses the\n\t\t\t\tawsvpc
network mode and a type SRV DNS record is used, you must specify\n\t\t\teither a containerName
and containerPort
combination or a\n\t\t\t\tport
value, but not both.
Details of the service registry.
" } }, "com.amazonaws.ecs#Services": { "type": "list", "member": { "target": "com.amazonaws.ecs#Service" } }, "com.amazonaws.ecs#Session": { "type": "structure", "members": { "sessionId": { "target": "com.amazonaws.ecs#String", "traits": { "smithy.api#documentation": "The ID of the execute command session.
" } }, "streamUrl": { "target": "com.amazonaws.ecs#String", "traits": { "smithy.api#documentation": "A URL back to managed agent on the container that the SSM Session Manager client uses\n\t\t\tto send commands and receive output from the container.
" } }, "tokenValue": { "target": "com.amazonaws.ecs#SensitiveString", "traits": { "smithy.api#documentation": "An encrypted token value containing session and caller information. Used to\n\t\t\tauthenticate the connection to the container.
" } } }, "traits": { "smithy.api#documentation": "The details of the execute command session.
" } }, "com.amazonaws.ecs#Setting": { "type": "structure", "members": { "name": { "target": "com.amazonaws.ecs#SettingName", "traits": { "smithy.api#documentation": "The Amazon ECS resource name.
" } }, "value": { "target": "com.amazonaws.ecs#String", "traits": { "smithy.api#documentation": "Whether the account setting is enabled or disabled for the specified resource.
" } }, "principalArn": { "target": "com.amazonaws.ecs#String", "traits": { "smithy.api#documentation": "The ARN of the principal, which can be an IAM user, IAM role, or the root user. If\n\t\t\tthis field is omitted, the authenticated user is assumed.
" } } }, "traits": { "smithy.api#documentation": "The current account setting for a resource.
" } }, "com.amazonaws.ecs#SettingName": { "type": "string", "traits": { "smithy.api#enum": [ { "value": "serviceLongArnFormat", "name": "SERVICE_LONG_ARN_FORMAT" }, { "value": "taskLongArnFormat", "name": "TASK_LONG_ARN_FORMAT" }, { "value": "containerInstanceLongArnFormat", "name": "CONTAINER_INSTANCE_LONG_ARN_FORMAT" }, { "value": "awsvpcTrunking", "name": "AWSVPC_TRUNKING" }, { "value": "containerInsights", "name": "CONTAINER_INSIGHTS" } ] } }, "com.amazonaws.ecs#Settings": { "type": "list", "member": { "target": "com.amazonaws.ecs#Setting" } }, "com.amazonaws.ecs#SortOrder": { "type": "string", "traits": { "smithy.api#enum": [ { "value": "ASC", "name": "ASC" }, { "value": "DESC", "name": "DESC" } ] } }, "com.amazonaws.ecs#StabilityStatus": { "type": "string", "traits": { "smithy.api#enum": [ { "value": "STEADY_STATE", "name": "STEADY_STATE" }, { "value": "STABILIZING", "name": "STABILIZING" } ] } }, "com.amazonaws.ecs#StartTask": { "type": "operation", "input": { "target": "com.amazonaws.ecs#StartTaskRequest" }, "output": { "target": "com.amazonaws.ecs#StartTaskResponse" }, "errors": [ { "target": "com.amazonaws.ecs#ClientException" }, { "target": "com.amazonaws.ecs#ClusterNotFoundException" }, { "target": "com.amazonaws.ecs#InvalidParameterException" }, { "target": "com.amazonaws.ecs#ServerException" } ], "traits": { "smithy.api#documentation": "Starts a new task from the specified task definition on the specified container\n\t\t\tinstance or instances.
\n\t\tAlternatively, you can use RunTask to place tasks for you. For more\n\t\t\tinformation, see Scheduling Tasks in the\n\t\t\t\tAmazon Elastic Container Service Developer Guide.
" } }, "com.amazonaws.ecs#StartTaskRequest": { "type": "structure", "members": { "cluster": { "target": "com.amazonaws.ecs#String", "traits": { "smithy.api#documentation": "The short name or full Amazon Resource Name (ARN) of the cluster on which to start your task.\n\t\t\tIf you do not specify a cluster, the default cluster is assumed.
" } }, "containerInstances": { "target": "com.amazonaws.ecs#StringList", "traits": { "smithy.api#documentation": "The container instance IDs or full ARN entries for the container instances on which\n\t\t\tyou would like to place your task. You can specify up to 10 container instances.
", "smithy.api#required": {} } }, "enableECSManagedTags": { "target": "com.amazonaws.ecs#Boolean", "traits": { "smithy.api#documentation": "Specifies whether to enable Amazon ECS managed tags for the task. For more information, see\n\t\t\t\tTagging Your Amazon ECS\n\t\t\t\tResources in the Amazon Elastic Container Service Developer Guide.
" } }, "enableExecuteCommand": { "target": "com.amazonaws.ecs#Boolean", "traits": { "smithy.api#documentation": "Whether or not the execute command functionality is enabled for the task. If\n\t\t\t\ttrue
, this enables execute command functionality on all containers in\n\t\t\tthe task.
The name of the task group to associate with the task. The default value is the family\n\t\t\tname of the task definition (for example, family:my-family-name).
" } }, "networkConfiguration": { "target": "com.amazonaws.ecs#NetworkConfiguration", "traits": { "smithy.api#documentation": "The VPC subnet and security group configuration for tasks that receive their own\n elastic network interface by using the awsvpc
networking mode.
A list of container overrides in JSON format that specify the name of a container in\n\t\t\tthe specified task definition and the overrides it should receive. You can override the\n\t\t\tdefault command for a container (that is specified in the task definition or Docker\n\t\t\timage) with a command
override. You can also override existing environment\n\t\t\tvariables (that are specified in the task definition or Docker image) on a container or\n\t\t\tadd new environment variables to it with an environment
override.
A total of 8192 characters are allowed for overrides. This limit includes the JSON\n\t\t\t\tformatting characters of the override structure.
\n\t\tSpecifies whether to propagate the tags from the task definition or the service to the\n\t\t\ttask. If no value is specified, the tags are not propagated.
" } }, "referenceId": { "target": "com.amazonaws.ecs#String", "traits": { "smithy.api#documentation": "The reference ID to use for the task.
" } }, "startedBy": { "target": "com.amazonaws.ecs#String", "traits": { "smithy.api#documentation": "An optional tag specified when a task is started. For example, if you automatically\n\t\t\ttrigger a task to run a batch process job, you could apply a unique identifier for that\n\t\t\tjob to your task with the startedBy
parameter. You can then identify which\n\t\t\ttasks belong to that job by filtering the results of a ListTasks call\n\t\t\twith the startedBy
value. Up to 36 letters (uppercase and lowercase),\n\t\t\tnumbers, hyphens, and underscores are allowed.
If a task is started by an Amazon ECS service, then the startedBy
parameter\n\t\t\tcontains the deployment ID of the service that starts it.
The metadata that you apply to the task to help you categorize and organize them. Each\n\t\t\ttag consists of a key and an optional value, both of which you define.
\n\t\tThe following basic restrictions apply to tags:
\nMaximum number of tags per resource - 50
\nFor each resource, each tag key must be unique, and each tag key can have only\n one value.
\nMaximum key length - 128 Unicode characters in UTF-8
\nMaximum value length - 256 Unicode characters in UTF-8
\nIf your tagging schema is used across multiple services and resources,\n remember that other services may have restrictions on allowed characters.\n Generally allowed characters are: letters, numbers, and spaces representable in\n UTF-8, and the following characters: + - = . _ : / @.
\nTag keys and values are case-sensitive.
\nDo not use aws:
, AWS:
, or any upper or lowercase\n combination of such as a prefix for either keys or values as it is reserved for\n AWS use. You cannot edit or delete tag keys or values with this prefix. Tags with\n this prefix do not count against your tags per resource limit.
The family
and revision
(family:revision
) or\n\t\t\tfull ARN of the task definition to start. If a revision
is not specified,\n\t\t\tthe latest ACTIVE
revision is used.
A full description of the tasks that were started. Each task that was successfully\n\t\t\tplaced on your container instances is described.
" } }, "failures": { "target": "com.amazonaws.ecs#Failures", "traits": { "smithy.api#documentation": "Any failures associated with the call.
" } } } }, "com.amazonaws.ecs#Statistics": { "type": "list", "member": { "target": "com.amazonaws.ecs#KeyValuePair" } }, "com.amazonaws.ecs#StopTask": { "type": "operation", "input": { "target": "com.amazonaws.ecs#StopTaskRequest" }, "output": { "target": "com.amazonaws.ecs#StopTaskResponse" }, "errors": [ { "target": "com.amazonaws.ecs#ClientException" }, { "target": "com.amazonaws.ecs#ClusterNotFoundException" }, { "target": "com.amazonaws.ecs#InvalidParameterException" }, { "target": "com.amazonaws.ecs#ServerException" } ], "traits": { "smithy.api#documentation": "Stops a running task. Any tags associated with the task will be deleted.
\n\t\tWhen StopTask is called on a task, the equivalent of docker\n\t\t\t\tstop
is issued to the containers running in the task. This results in a\n\t\t\t\tSIGTERM
value and a default 30-second timeout, after which the\n\t\t\t\tSIGKILL
value is sent and the containers are forcibly stopped. If the\n\t\t\tcontainer handles the SIGTERM
value gracefully and exits within 30 seconds\n\t\t\tfrom receiving it, no SIGKILL
value is sent.
The default 30-second timeout can be configured on the Amazon ECS container agent with\n\t\t\t\tthe ECS_CONTAINER_STOP_TIMEOUT
variable. For more information, see\n\t\t\t\t\tAmazon ECS Container Agent Configuration in the\n\t\t\t\t\tAmazon Elastic Container Service Developer Guide.
The short name or full Amazon Resource Name (ARN) of the cluster that hosts the task to stop.\n\t\t\tIf you do not specify a cluster, the default cluster is assumed.
" } }, "task": { "target": "com.amazonaws.ecs#String", "traits": { "smithy.api#documentation": "The task ID or full Amazon Resource Name (ARN) of the task to stop.
", "smithy.api#required": {} } }, "reason": { "target": "com.amazonaws.ecs#String", "traits": { "smithy.api#documentation": "An optional message specified when a task is stopped. For example, if you are using a\n\t\t\tcustom scheduler, you can use this parameter to specify the reason for stopping the task\n\t\t\there, and the message appears in subsequent DescribeTasks API\n\t\t\toperations on this task. Up to 255 characters are allowed in this message.
" } } } }, "com.amazonaws.ecs#StopTaskResponse": { "type": "structure", "members": { "task": { "target": "com.amazonaws.ecs#Task", "traits": { "smithy.api#documentation": "The task that was stopped.
" } } } }, "com.amazonaws.ecs#String": { "type": "string" }, "com.amazonaws.ecs#StringList": { "type": "list", "member": { "target": "com.amazonaws.ecs#String" } }, "com.amazonaws.ecs#StringMap": { "type": "map", "key": { "target": "com.amazonaws.ecs#String" }, "value": { "target": "com.amazonaws.ecs#String" } }, "com.amazonaws.ecs#SubmitAttachmentStateChanges": { "type": "operation", "input": { "target": "com.amazonaws.ecs#SubmitAttachmentStateChangesRequest" }, "output": { "target": "com.amazonaws.ecs#SubmitAttachmentStateChangesResponse" }, "errors": [ { "target": "com.amazonaws.ecs#AccessDeniedException" }, { "target": "com.amazonaws.ecs#ClientException" }, { "target": "com.amazonaws.ecs#InvalidParameterException" }, { "target": "com.amazonaws.ecs#ServerException" } ], "traits": { "smithy.api#documentation": "This action is only used by the Amazon ECS agent, and it is not intended for use outside of the agent.
\nSent to\n\t\t\tacknowledge that an attachment changed states.
" } }, "com.amazonaws.ecs#SubmitAttachmentStateChangesRequest": { "type": "structure", "members": { "cluster": { "target": "com.amazonaws.ecs#String", "traits": { "smithy.api#documentation": "The short name or full ARN of the cluster that hosts the container instance the\n\t\t\tattachment belongs to.
" } }, "attachments": { "target": "com.amazonaws.ecs#AttachmentStateChanges", "traits": { "smithy.api#documentation": "Any attachments associated with the state change request.
", "smithy.api#required": {} } } } }, "com.amazonaws.ecs#SubmitAttachmentStateChangesResponse": { "type": "structure", "members": { "acknowledgment": { "target": "com.amazonaws.ecs#String", "traits": { "smithy.api#documentation": "Acknowledgement of the state change.
" } } } }, "com.amazonaws.ecs#SubmitContainerStateChange": { "type": "operation", "input": { "target": "com.amazonaws.ecs#SubmitContainerStateChangeRequest" }, "output": { "target": "com.amazonaws.ecs#SubmitContainerStateChangeResponse" }, "errors": [ { "target": "com.amazonaws.ecs#AccessDeniedException" }, { "target": "com.amazonaws.ecs#ClientException" }, { "target": "com.amazonaws.ecs#ServerException" } ], "traits": { "smithy.api#documentation": "This action is only used by the Amazon ECS agent, and it is not intended for use outside of the agent.
\nSent to\n\t\t\tacknowledge that a container changed states.
" } }, "com.amazonaws.ecs#SubmitContainerStateChangeRequest": { "type": "structure", "members": { "cluster": { "target": "com.amazonaws.ecs#String", "traits": { "smithy.api#documentation": "The short name or full ARN of the cluster that hosts the container.
" } }, "task": { "target": "com.amazonaws.ecs#String", "traits": { "smithy.api#documentation": "The task ID or full Amazon Resource Name (ARN) of the task that hosts the container.
" } }, "containerName": { "target": "com.amazonaws.ecs#String", "traits": { "smithy.api#documentation": "The name of the container.
" } }, "runtimeId": { "target": "com.amazonaws.ecs#String", "traits": { "smithy.api#documentation": "The ID of the Docker container.
" } }, "status": { "target": "com.amazonaws.ecs#String", "traits": { "smithy.api#documentation": "The status of the state change request.
" } }, "exitCode": { "target": "com.amazonaws.ecs#BoxedInteger", "traits": { "smithy.api#documentation": "The exit code returned for the state change request.
" } }, "reason": { "target": "com.amazonaws.ecs#String", "traits": { "smithy.api#documentation": "The reason for the state change request.
" } }, "networkBindings": { "target": "com.amazonaws.ecs#NetworkBindings", "traits": { "smithy.api#documentation": "The network bindings of the container.
" } } } }, "com.amazonaws.ecs#SubmitContainerStateChangeResponse": { "type": "structure", "members": { "acknowledgment": { "target": "com.amazonaws.ecs#String", "traits": { "smithy.api#documentation": "Acknowledgement of the state change.
" } } } }, "com.amazonaws.ecs#SubmitTaskStateChange": { "type": "operation", "input": { "target": "com.amazonaws.ecs#SubmitTaskStateChangeRequest" }, "output": { "target": "com.amazonaws.ecs#SubmitTaskStateChangeResponse" }, "errors": [ { "target": "com.amazonaws.ecs#AccessDeniedException" }, { "target": "com.amazonaws.ecs#ClientException" }, { "target": "com.amazonaws.ecs#InvalidParameterException" }, { "target": "com.amazonaws.ecs#ServerException" } ], "traits": { "smithy.api#documentation": "This action is only used by the Amazon ECS agent, and it is not intended for use outside of the agent.
\nSent to acknowledge\n\t\t\tthat a task changed states.
" } }, "com.amazonaws.ecs#SubmitTaskStateChangeRequest": { "type": "structure", "members": { "cluster": { "target": "com.amazonaws.ecs#String", "traits": { "smithy.api#documentation": "The short name or full Amazon Resource Name (ARN) of the cluster that hosts the task.
" } }, "task": { "target": "com.amazonaws.ecs#String", "traits": { "smithy.api#documentation": "The task ID or full ARN of the task in the state change request.
" } }, "status": { "target": "com.amazonaws.ecs#String", "traits": { "smithy.api#documentation": "The status of the state change request.
" } }, "reason": { "target": "com.amazonaws.ecs#String", "traits": { "smithy.api#documentation": "The reason for the state change request.
" } }, "containers": { "target": "com.amazonaws.ecs#ContainerStateChanges", "traits": { "smithy.api#documentation": "Any containers associated with the state change request.
" } }, "attachments": { "target": "com.amazonaws.ecs#AttachmentStateChanges", "traits": { "smithy.api#documentation": "Any attachments associated with the state change request.
" } }, "managedAgents": { "target": "com.amazonaws.ecs#ManagedAgentStateChanges", "traits": { "smithy.api#documentation": "The details for the managed agent associated with the task.
" } }, "pullStartedAt": { "target": "com.amazonaws.ecs#Timestamp", "traits": { "smithy.api#documentation": "The Unix timestamp for when the container image pull began.
" } }, "pullStoppedAt": { "target": "com.amazonaws.ecs#Timestamp", "traits": { "smithy.api#documentation": "The Unix timestamp for when the container image pull completed.
" } }, "executionStoppedAt": { "target": "com.amazonaws.ecs#Timestamp", "traits": { "smithy.api#documentation": "The Unix timestamp for when the task execution stopped.
" } } } }, "com.amazonaws.ecs#SubmitTaskStateChangeResponse": { "type": "structure", "members": { "acknowledgment": { "target": "com.amazonaws.ecs#String", "traits": { "smithy.api#documentation": "Acknowledgement of the state change.
" } } } }, "com.amazonaws.ecs#SystemControl": { "type": "structure", "members": { "namespace": { "target": "com.amazonaws.ecs#String", "traits": { "smithy.api#documentation": "The namespaced kernel parameter for which to set a value
.
The value for the namespaced kernel parameter specified in\n\t\t\tnamespace
.
A list of namespaced kernel parameters to set in the container. This parameter maps to\n\t\t\t\tSysctls
in the Create a container section of the\n\t\t\tDocker Remote API and the --sysctl
option to docker run.
It is not recommended that you specify network-related systemControls
\n\t\t\tparameters for multiple containers in a single task that also uses either the\n\t\t\t\tawsvpc
or host
network mode for the following\n\t\t\treasons:
For tasks that use the awsvpc
network mode, if you set\n\t\t\t\t\t\tsystemControls
for any container, it applies to all containers\n\t\t\t\t\tin the task. If you set different systemControls
for multiple\n\t\t\t\t\tcontainers in a single task, the container that is started last determines which\n\t\t\t\t\t\tsystemControls
take effect.
For tasks that use the host
network mode, the\n\t\t\t\t\t\tsystemControls
parameter applies to the container instance's\n\t\t\t\t\tkernel parameter as well as that of all containers of any tasks running on that\n\t\t\t\t\tcontainer instance.
One part of a key-value pair that make up a tag. A key
is a general label\n\t\t\tthat acts like a category for more specific tag values.
The optional part of a key-value pair that make up a tag. A value
acts as\n\t\t\ta descriptor within a tag category (key).
The metadata that you apply to a resource to help you categorize and organize them.\n\t\t\tEach tag consists of a key and an optional value, both of which you define.
\n\t\tThe following basic restrictions apply to tags:
\nMaximum number of tags per resource - 50
\nFor each resource, each tag key must be unique, and each tag key can have only\n one value.
\nMaximum key length - 128 Unicode characters in UTF-8
\nMaximum value length - 256 Unicode characters in UTF-8
\nIf your tagging schema is used across multiple services and resources,\n remember that other services may have restrictions on allowed characters.\n Generally allowed characters are: letters, numbers, and spaces representable in\n UTF-8, and the following characters: + - = . _ : / @.
\nTag keys and values are case-sensitive.
\nDo not use aws:
, AWS:
, or any upper or lowercase\n combination of such as a prefix for either keys or values as it is reserved for\n AWS use. You cannot edit or delete tag keys or values with this prefix. Tags with\n this prefix do not count against your tags per resource limit.
Associates the specified tags to a resource with the specified\n\t\t\t\tresourceArn
. If existing tags on a resource are not specified in the\n\t\t\trequest parameters, they are not changed. When a resource is deleted, the tags\n\t\t\tassociated with that resource are deleted as well.
The Amazon Resource Name (ARN) of the resource to which to add tags. Currently, the supported resources\n\t\t\tare Amazon ECS capacity providers, tasks, services, task definitions, clusters, and container\n\t\t\tinstances.
", "smithy.api#required": {} } }, "tags": { "target": "com.amazonaws.ecs#Tags", "traits": { "smithy.api#documentation": "The tags to add to the resource. A tag is an array of key-value pairs.
\n\t\tThe following basic restrictions apply to tags:
\nMaximum number of tags per resource - 50
\nFor each resource, each tag key must be unique, and each tag key can have only\n one value.
\nMaximum key length - 128 Unicode characters in UTF-8
\nMaximum value length - 256 Unicode characters in UTF-8
\nIf your tagging schema is used across multiple services and resources,\n remember that other services may have restrictions on allowed characters.\n Generally allowed characters are: letters, numbers, and spaces representable in\n UTF-8, and the following characters: + - = . _ : / @.
\nTag keys and values are case-sensitive.
\nDo not use aws:
, AWS:
, or any upper or lowercase\n combination of such as a prefix for either keys or values as it is reserved for\n AWS use. You cannot edit or delete tag keys or values with this prefix. Tags with\n this prefix do not count against your tags per resource limit.
The target container is not properly configured with the execute command agent or the\n\t\t\tcontainer is no longer active or running.
", "smithy.api#error": "client" } }, "com.amazonaws.ecs#TargetNotFoundException": { "type": "structure", "members": { "message": { "target": "com.amazonaws.ecs#String" } }, "traits": { "smithy.api#documentation": "The specified target could not be found. You can view your available container\n\t\t\tinstances with ListContainerInstances. Amazon ECS container instances are\n\t\t\tcluster-specific and Region-specific.
", "smithy.api#error": "client" } }, "com.amazonaws.ecs#TargetType": { "type": "string", "traits": { "smithy.api#enum": [ { "value": "container-instance", "name": "CONTAINER_INSTANCE" } ] } }, "com.amazonaws.ecs#Task": { "type": "structure", "members": { "attachments": { "target": "com.amazonaws.ecs#Attachments", "traits": { "smithy.api#documentation": "The Elastic Network Adapter associated with the task if the task uses the\n\t\t\t\tawsvpc
network mode.
The attributes of the task
" } }, "availabilityZone": { "target": "com.amazonaws.ecs#String", "traits": { "smithy.api#documentation": "The availability zone of the task.
" } }, "capacityProviderName": { "target": "com.amazonaws.ecs#String", "traits": { "smithy.api#documentation": "The capacity provider associated with the task.
" } }, "clusterArn": { "target": "com.amazonaws.ecs#String", "traits": { "smithy.api#documentation": "The ARN of the cluster that hosts the task.
" } }, "connectivity": { "target": "com.amazonaws.ecs#Connectivity", "traits": { "smithy.api#documentation": "The connectivity status of a task.
" } }, "connectivityAt": { "target": "com.amazonaws.ecs#Timestamp", "traits": { "smithy.api#documentation": "The Unix timestamp for when the task last went into CONNECTED
\n\t\t\tstatus.
The ARN of the container instances that host the task.
" } }, "containers": { "target": "com.amazonaws.ecs#Containers", "traits": { "smithy.api#documentation": "The containers associated with the task.
" } }, "cpu": { "target": "com.amazonaws.ecs#String", "traits": { "smithy.api#documentation": "The number of CPU units used by the task as expressed in a task definition. It can be\n\t\t\texpressed as an integer using CPU units, for example 1024
. It can also be\n\t\t\texpressed as a string using vCPUs, for example 1 vCPU
or 1\n\t\t\t\tvcpu
. String values are converted to an integer indicating the CPU units when\n\t\t\tthe task definition is registered.
If you are using the EC2 launch type, this field is optional. Supported\n\t\t\tvalues are between 128
CPU units (0.125
vCPUs) and\n\t\t\t\t10240
CPU units (10
vCPUs).
If you are using the Fargate launch type, this field is required and you\n\t\t\tmust use one of the following values, which determines your range of supported values\n\t\t\tfor the memory
parameter:
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: Between 4096 (4 GB) and 16384 (16 GB) in increments of 1024 (1 GB)
4096 (4 vCPU) - Available memory
values: Between 8192 (8 GB) and 30720 (30 GB) in increments of 1024 (1 GB)
The Unix timestamp for when the task was created (the task entered the\n\t\t\t\tPENDING
state).
The desired status of the task. For more information, see Task\n\t\t\tLifecycle.
" } }, "enableExecuteCommand": { "target": "com.amazonaws.ecs#Boolean", "traits": { "smithy.api#documentation": "Whether or not execute command functionality is enabled for this task. If\n\t\t\t\ttrue
, this enables execute command functionality on all containers in\n\t\t\tthe task.
The Unix timestamp for when the task execution stopped.
" } }, "group": { "target": "com.amazonaws.ecs#String", "traits": { "smithy.api#documentation": "The name of the task group associated with the task.
" } }, "healthStatus": { "target": "com.amazonaws.ecs#HealthStatus", "traits": { "smithy.api#documentation": "The health status for the task, which is determined by the health of the essential\n\t\t\tcontainers in the task. If all essential containers in the task are reporting as\n\t\t\t\tHEALTHY
, then the task status also reports as HEALTHY
. If\n\t\t\tany essential containers in the task are reporting as UNHEALTHY
or\n\t\t\t\tUNKNOWN
, then the task status also reports as UNHEALTHY
or\n\t\t\t\tUNKNOWN
, accordingly.
The Amazon ECS container agent does not monitor or report on Docker health checks that\n\t\t\t\tare embedded in a container image (such as those specified in a parent image or from\n\t\t\t\tthe image's Dockerfile) and not specified in the container definition. Health check\n\t\t\t\tparameters that are specified in a container definition override any Docker health\n\t\t\t\tchecks that exist in the container image.
\n\t\tThe Elastic Inference accelerator associated with the task.
" } }, "lastStatus": { "target": "com.amazonaws.ecs#String", "traits": { "smithy.api#documentation": "The last known status of the task. For more information, see Task\n\t\t\t\tLifecycle.
" } }, "launchType": { "target": "com.amazonaws.ecs#LaunchType", "traits": { "smithy.api#documentation": "The launch type on which your task is running. For more information, see Amazon ECS\n\t\t\t\tLaunch Types in the Amazon Elastic Container Service Developer Guide.
" } }, "memory": { "target": "com.amazonaws.ecs#String", "traits": { "smithy.api#documentation": "The amount of memory (in MiB) used by the task as expressed in a task definition. It\n\t\t\tcan be expressed as an integer using MiB, for example 1024
. It can also be\n\t\t\texpressed as a string using GB, for example 1GB
or 1 GB
.\n\t\t\tString values are converted to an integer indicating the MiB when the task definition is\n\t\t\tregistered.
If you are using the EC2 launch type, this field is optional.
\n\t\tIf you are using the Fargate launch type, this field is required and you\n\t\t\tmust use one of the following values, which determines your range of supported values\n\t\t\tfor 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)
One or more container overrides.
" } }, "platformVersion": { "target": "com.amazonaws.ecs#String", "traits": { "smithy.api#documentation": "The platform version on which your task is running. A platform version is only\n\t\t\tspecified for tasks using the Fargate launch type. If one is not\n\t\t\tspecified, the LATEST
platform version is used by default. For more\n\t\t\tinformation, see AWS Fargate Platform\n\t\t\t\tVersions in the Amazon Elastic Container Service Developer Guide.
The Unix timestamp for when the container image pull began.
" } }, "pullStoppedAt": { "target": "com.amazonaws.ecs#Timestamp", "traits": { "smithy.api#documentation": "The Unix timestamp for when the container image pull completed.
" } }, "startedAt": { "target": "com.amazonaws.ecs#Timestamp", "traits": { "smithy.api#documentation": "The Unix timestamp for when the task started (the task transitioned from the\n\t\t\t\tPENDING
state to the RUNNING
state).
The tag specified when a task is started. If the task is started by an Amazon ECS service,\n\t\t\tthen the startedBy
parameter contains the deployment ID of the service that\n\t\t\tstarts it.
The stop code indicating why a task was stopped. The stoppedReason
may\n\t\t\tcontain additional details.
The Unix timestamp for when the task was stopped (the task transitioned from the\n\t\t\t\tRUNNING
state to the STOPPED
state).
The reason that the task was stopped.
" } }, "stoppingAt": { "target": "com.amazonaws.ecs#Timestamp", "traits": { "smithy.api#documentation": "The Unix timestamp for when the task stops (transitions from the RUNNING
\n\t\t\tstate to STOPPED
).
The metadata that you apply to the task to help you categorize and organize them. Each\n\t\t\ttag consists of a key and an optional value, both of which you define.
\n\t\tThe following basic restrictions apply to tags:
\nMaximum number of tags per resource - 50
\nFor each resource, each tag key must be unique, and each tag key can have only\n one value.
\nMaximum key length - 128 Unicode characters in UTF-8
\nMaximum value length - 256 Unicode characters in UTF-8
\nIf your tagging schema is used across multiple services and resources,\n remember that other services may have restrictions on allowed characters.\n Generally allowed characters are: letters, numbers, and spaces representable in\n UTF-8, and the following characters: + - = . _ : / @.
\nTag keys and values are case-sensitive.
\nDo not use aws:
, AWS:
, or any upper or lowercase\n combination of such as a prefix for either keys or values as it is reserved for\n AWS use. You cannot edit or delete tag keys or values with this prefix. Tags with\n this prefix do not count against your tags per resource limit.
The Amazon Resource Name (ARN) of the task.
" } }, "taskDefinitionArn": { "target": "com.amazonaws.ecs#String", "traits": { "smithy.api#documentation": "The ARN of the task definition that creates the task.
" } }, "version": { "target": "com.amazonaws.ecs#Long", "traits": { "smithy.api#documentation": "The version counter for the task. Every time a task experiences a change that triggers\n\t\t\ta CloudWatch event, the version counter is incremented. If you are replicating your Amazon ECS task\n\t\t\tstate with CloudWatch Events, you can compare the version of a task reported by the Amazon ECS API\n\t\t\tactions with the version reported in CloudWatch Events for the task (inside the\n\t\t\t\tdetail
object) to verify that the version in your event stream is\n\t\t\tcurrent.
The ephemeral storage settings for the task.
" } } }, "traits": { "smithy.api#documentation": "Details on a task in a cluster.
" } }, "com.amazonaws.ecs#TaskDefinition": { "type": "structure", "members": { "taskDefinitionArn": { "target": "com.amazonaws.ecs#String", "traits": { "smithy.api#documentation": "The full Amazon Resource Name (ARN) of the task definition.
" } }, "containerDefinitions": { "target": "com.amazonaws.ecs#ContainerDefinitions", "traits": { "smithy.api#documentation": "A list of container definitions in JSON format that describe the different containers\n\t\t\tthat make up your task. For more information about container definition parameters and\n\t\t\tdefaults, see Amazon ECS Task\n\t\t\t\tDefinitions in the Amazon Elastic Container Service Developer Guide.
" } }, "family": { "target": "com.amazonaws.ecs#String", "traits": { "smithy.api#documentation": "The name of a family that this task definition is registered to. Up to 255 letters\n\t\t\t(uppercase and lowercase), numbers, hyphens, and underscores are allowed.
\n\t\tA family groups multiple versions of a task definition. Amazon ECS gives the first task\n\t\t\tdefinition that you registered to a family a revision number of 1. Amazon ECS gives\n\t\t\tsequential revision numbers to each task definition that you add.
" } }, "taskRoleArn": { "target": "com.amazonaws.ecs#String", "traits": { "smithy.api#documentation": "The short name or full Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that grants containers in the\n\t\t\ttask permission to call AWS APIs on your behalf. For more information, see Amazon ECS\n\t\t\t\tTask Role in the Amazon Elastic Container Service Developer Guide.
\n\t\tIAM roles for tasks on Windows require that the -EnableTaskIAMRole
option\n\t\t\tis set when you launch the Amazon ECS-optimized Windows AMI. Your containers must also run some\n\t\t\tconfiguration code in order to take advantage of the feature. For more information, see\n\t\t\t\tWindows IAM roles\n\t\t\t\tfor tasks in the Amazon Elastic Container Service Developer Guide.
The Amazon Resource Name (ARN) of the task execution role that grants the Amazon ECS container agent\n permission to make AWS API calls on your behalf. The task execution IAM role is required\n depending on the requirements of your task. For more information, see Amazon ECS task\n execution IAM role in the Amazon Elastic Container Service Developer Guide.
" } }, "networkMode": { "target": "com.amazonaws.ecs#NetworkMode", "traits": { "smithy.api#documentation": "The Docker networking mode to use for the containers in the task. The valid values are\n none
, bridge
, awsvpc
, and host
.\n If no network mode is specified, the default is bridge
.
For Amazon ECS tasks on Fargate, the awsvpc
network mode is required. \n For Amazon ECS tasks on Amazon EC2 instances, any network mode can be used. If the network\n mode is set to none
, you cannot specify port mappings in your container\n definitions, and the tasks containers do not have external connectivity. The\n host
and awsvpc
network modes offer the highest networking\n performance for containers because they use the EC2 network stack instead of the\n virtualized network stack provided by the bridge
mode.
With the host
and awsvpc
network modes, exposed container\n ports are mapped directly to the corresponding host port (for the host
\n network mode) or the attached elastic network interface port (for the\n awsvpc
network mode), so you cannot take advantage of dynamic host port\n mappings.
When using the host
network mode, you should not run\n containers using the root user (UID 0). It is considered best practice\n to use a non-root user.
If the network mode is awsvpc
, the task is allocated an elastic network\n interface, and you must specify a NetworkConfiguration value when you create\n a service or run a task with the task definition. For more information, see Task Networking in the\n Amazon Elastic Container Service Developer Guide.
Currently, only Amazon ECS-optimized AMIs, other Amazon Linux variants with the\n ecs-init
package, or AWS Fargate infrastructure support the\n awsvpc
network mode.
If the network mode is host
, you cannot run multiple instantiations of the\n same task on a single container instance when port mappings are used.
Docker for Windows uses different network modes than Docker for Linux. When you\n register a task definition with Windows containers, you must not specify a network mode.\n If you use the console to register a task definition with Windows containers, you must\n choose the
network mode object.
For more information, see Network\n settings in the Docker run reference.
" } }, "revision": { "target": "com.amazonaws.ecs#Integer", "traits": { "smithy.api#documentation": "The revision of the task in a particular family. The revision is a version number of a\n\t\t\ttask definition in a family. When you register a task definition for the first time, the\n\t\t\trevision is 1
. Each time that you register a new revision of a task\n\t\t\tdefinition in the same family, the revision value always increases by one, even if you\n\t\t\thave deregistered previous revisions in this family.
The list of data volume definitions for the task. For more information, see Using data volumes in tasks in the\n\t\t\tAmazon Elastic Container Service Developer Guide.
\n\t\tThe host
and sourcePath
parameters are not supported for\n\t\t\t\ttasks run on AWS Fargate.
The status of the task definition.
" } }, "requiresAttributes": { "target": "com.amazonaws.ecs#RequiresAttributes", "traits": { "smithy.api#documentation": "The container instance attributes required by your task. When an Amazon EC2 instance is\n\t\t\tregistered to your cluster, the Amazon ECS container agent assigns some standard attributes\n\t\t\tto the instance. You can apply custom attributes, specified as key-value pairs using the\n\t\t\tAmazon ECS console or the PutAttributes API. These attributes are used when\n\t\t\tconsidering task placement for tasks hosted on Amazon EC2 instances. For more information,\n\t\t\tsee Attributes in the Amazon Elastic Container Service Developer Guide.
\n\t\tThis parameter is not supported for tasks run on AWS Fargate.
\n\t\tAn array of placement constraint objects to use for tasks.
\n\t\tThis parameter is not supported for tasks run on AWS Fargate.
\n\t\tThe task launch types the task definition validated against during task definition\n\t\t\tregistration. For more information, see Amazon ECS launch types\n\t\t\tin the Amazon Elastic Container Service Developer Guide.
" } }, "requiresCompatibilities": { "target": "com.amazonaws.ecs#CompatibilityList", "traits": { "smithy.api#documentation": "The task launch types the task definition was validated against. To determine which\n\t\t\ttask launch types the task definition is validated for, see the TaskDefinition$compatibilities parameter.
" } }, "cpu": { "target": "com.amazonaws.ecs#String", "traits": { "smithy.api#documentation": "The number of cpu
units used by the task. If you are using the EC2 launch\n\t\t\ttype, this field is optional and any value can be used. If you are using the Fargate\n\t\t\tlaunch type, this field is required and you must use one of the following values, which\n\t\t\tdetermines your range of valid values for the memory
parameter:
256 (.25 vCPU) - Available memory
values: 512 (0.5 GB), 1024 (1 GB), 2048 (2 GB)
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: Between 4096 (4 GB) and 16384 (16 GB) in increments of 1024 (1 GB)
4096 (4 vCPU) - Available memory
values: Between 8192 (8 GB) and 30720 (30 GB) in increments of 1024 (1 GB)
The amount (in MiB) of memory used by the task.
\n\t\tIf your tasks will be run on Amazon EC2 instances, you must specify either a task-level\n\t\t\tmemory value or a container-level memory value. This field is optional and any value can\n\t\t\tbe used. If a task-level memory value is specified then the container-level memory value\n\t\t\tis optional. For more information regarding container-level memory and memory\n\t\t\treservation, see ContainerDefinition.
\n\t\tIf your tasks will be run on AWS Fargate, this field is required and you must use one of\n\t\t\tthe following values, which determines your range of valid values for the\n\t\t\t\tcpu
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)
The Elastic Inference accelerator associated with the task.
" } }, "pidMode": { "target": "com.amazonaws.ecs#PidMode", "traits": { "smithy.api#documentation": "The process namespace to use for the containers in the task. The valid\n values are host
or task
. If host
\n is specified, then all containers within the tasks that specified the\n host
PID mode on the same container instance share the\n same process namespace with the host Amazon EC2 instance. If task
is\n specified, all containers within the specified task share the same\n process namespace. If no value is specified, the default is a private\n namespace. For more information, see PID settings in the Docker run\n reference.
If the host
PID mode is used, be aware that there is a\n heightened risk of undesired process namespace expose. For more\n information, see Docker\n security.
This parameter is not supported for Windows containers or tasks run on AWS Fargate.
\nThe IPC resource namespace to use for the containers in the task. The valid values are\n host
, task
, or none
. If host
is\n specified, then all containers within the tasks that specified the host
IPC\n mode on the same container instance share the same IPC resources with the host Amazon EC2\n instance. If task
is specified, all containers within the specified task\n share the same IPC resources. If none
is specified, then IPC resources\n within the containers of a task are private and not shared with other containers in a\n task or on the container instance. If no value is specified, then the IPC resource\n namespace sharing depends on the Docker daemon setting on the container instance. For\n more information, see IPC\n settings in the Docker run reference.
If the host
IPC mode is used, be aware that there is a heightened risk of\n undesired IPC namespace expose. For more information, see Docker\n security.
If you are setting namespaced kernel parameters using systemControls
for\n the containers in the task, the following will apply to your IPC resource namespace. For\n more information, see System\n Controls in the Amazon Elastic Container Service Developer Guide.
For tasks that use the host
IPC mode, IPC namespace related\n systemControls
are not supported.
For tasks that use the task
IPC mode, IPC namespace related\n systemControls
will apply to all containers within a\n task.
This parameter is not supported for Windows containers or tasks run on AWS Fargate.
\nThe configuration details for the App Mesh proxy.
\n\t\tYour Amazon ECS container instances require at least version 1.26.0 of the container agent\n\t\t\tand at least version 1.26.0-1 of the ecs-init
package to enable a proxy\n\t\t\tconfiguration. If your container instances are launched from the Amazon ECS-optimized AMI\n\t\t\tversion 20190301
or later, then they contain the required versions of the\n\t\t\tcontainer agent and ecs-init
. For more information, see Amazon ECS-optimized Linux AMI in the Amazon Elastic Container Service Developer Guide.
The Unix timestamp for when the task definition was registered.
" } }, "deregisteredAt": { "target": "com.amazonaws.ecs#Timestamp", "traits": { "smithy.api#documentation": "The Unix timestamp for when the task definition was deregistered.
" } }, "registeredBy": { "target": "com.amazonaws.ecs#String", "traits": { "smithy.api#documentation": "The principal that registered the task definition.
" } }, "ephemeralStorage": { "target": "com.amazonaws.ecs#EphemeralStorage", "traits": { "smithy.api#documentation": "The ephemeral storage settings to use for tasks run with the task definition.
" } } }, "traits": { "smithy.api#documentation": "The details of a task definition which describes the container and volume definitions\n\t\t\tof an Amazon Elastic Container Service task. You can specify which Docker images to use, the required\n\t\t\tresources, and other configurations related to launching the task definition through an\n\t\t\tAmazon ECS service or task.
" } }, "com.amazonaws.ecs#TaskDefinitionFamilyStatus": { "type": "string", "traits": { "smithy.api#enum": [ { "value": "ACTIVE", "name": "ACTIVE" }, { "value": "INACTIVE", "name": "INACTIVE" }, { "value": "ALL", "name": "ALL" } ] } }, "com.amazonaws.ecs#TaskDefinitionField": { "type": "string", "traits": { "smithy.api#enum": [ { "value": "TAGS", "name": "TAGS" } ] } }, "com.amazonaws.ecs#TaskDefinitionFieldList": { "type": "list", "member": { "target": "com.amazonaws.ecs#TaskDefinitionField" } }, "com.amazonaws.ecs#TaskDefinitionPlacementConstraint": { "type": "structure", "members": { "type": { "target": "com.amazonaws.ecs#TaskDefinitionPlacementConstraintType", "traits": { "smithy.api#documentation": "The type of constraint. The MemberOf
constraint restricts selection to be\n\t\t\tfrom a group of valid candidates.
A cluster query language expression to apply to the constraint. For more information,\n\t\t\tsee Cluster query language in the\n\t\t\t\tAmazon Elastic Container Service Developer Guide.
" } } }, "traits": { "smithy.api#documentation": "An object representing a constraint on task placement in the task definition. For more\n\t\t\tinformation, see Task placement constraints in the\n\t\t\t\tAmazon Elastic Container Service Developer Guide.
\n\t\tTask placement constraints are not supported for tasks run on AWS Fargate.
\n\t\tOne or more container overrides sent to a task.
" } }, "cpu": { "target": "com.amazonaws.ecs#String", "traits": { "smithy.api#documentation": "The cpu override for the task.
" } }, "inferenceAcceleratorOverrides": { "target": "com.amazonaws.ecs#InferenceAcceleratorOverrides", "traits": { "smithy.api#documentation": "The Elastic Inference accelerator override for the task.
" } }, "executionRoleArn": { "target": "com.amazonaws.ecs#String", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the task execution IAM role override for the task.
" } }, "memory": { "target": "com.amazonaws.ecs#String", "traits": { "smithy.api#documentation": "The memory override for the task.
" } }, "taskRoleArn": { "target": "com.amazonaws.ecs#String", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the IAM role that containers in this task can assume. All containers\n\t\t\tin this task are granted the permissions that are specified in this role.
" } }, "ephemeralStorage": { "target": "com.amazonaws.ecs#EphemeralStorage", "traits": { "smithy.api#documentation": "The ephemeral storage setting override for the task.
\n\t\tThis parameter is only supported for tasks hosted on AWS Fargate using platform\n\t\t\t\tversion 1.4.0
or later.
The overrides associated with a task.
" } }, "com.amazonaws.ecs#TaskSet": { "type": "structure", "members": { "id": { "target": "com.amazonaws.ecs#String", "traits": { "smithy.api#documentation": "The ID of the task set.
" } }, "taskSetArn": { "target": "com.amazonaws.ecs#String", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the task set.
" } }, "serviceArn": { "target": "com.amazonaws.ecs#String", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the service the task set exists in.
" } }, "clusterArn": { "target": "com.amazonaws.ecs#String", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the cluster that the service that hosts the task set exists\n\t\t\tin.
" } }, "startedBy": { "target": "com.amazonaws.ecs#String", "traits": { "smithy.api#documentation": "The tag specified when a task set is started. If the task set is created by an AWS CodeDeploy\n\t\t\tdeployment, the startedBy
parameter is CODE_DEPLOY
. For a task\n\t\t\tset created for an external deployment, the startedBy field isn't used.
The external ID associated with the task set.
\n\t\tIf a task set is created by an AWS CodeDeploy deployment, the externalId
parameter\n\t\t\tcontains the AWS CodeDeploy deployment ID.
If a task set is created for an external deployment and is associated with a service\n\t\t\tdiscovery registry, the externalId
parameter contains the\n\t\t\t\tECS_TASK_SET_EXTERNAL_ID
AWS Cloud Map attribute.
The status of the task set. The following describes each state:
\n\t\tThe task set is serving production traffic.
\n\t\t\t\tThe task set is not serving production traffic.
\n\t\t\t\tThe tasks in the task set are being stopped and their corresponding\n\t\t\t\t\t\ttargets are being deregistered from their target group.
\n\t\t\t\tThe task definition the task set is using.
" } }, "computedDesiredCount": { "target": "com.amazonaws.ecs#Integer", "traits": { "smithy.api#documentation": "The computed desired count for the task set. This is calculated by multiplying the\n\t\t\tservice's desiredCount
by the task set's scale
percentage. The\n\t\t\tresult is always rounded up. For example, if the computed desired count is 1.2, it\n\t\t\trounds up to 2 tasks.
The number of tasks in the task set that are in the PENDING
status during\n\t\t\ta deployment. A task in the PENDING
state is preparing to enter the\n\t\t\t\tRUNNING
state. A task set enters the PENDING
status when\n\t\t\tit launches for the first time or when it is restarted after being in the\n\t\t\t\tSTOPPED
state.
The number of tasks in the task set that are in the RUNNING
status during\n\t\t\ta deployment. A task in the RUNNING
state is running and ready for\n\t\t\tuse.
The Unix timestamp for when the task set was created.
" } }, "updatedAt": { "target": "com.amazonaws.ecs#Timestamp", "traits": { "smithy.api#documentation": "The Unix timestamp for when the task set was last updated.
" } }, "launchType": { "target": "com.amazonaws.ecs#LaunchType", "traits": { "smithy.api#documentation": "The launch type the tasks in the task set are using. For more information, see Amazon ECS\n\t\t\t\tlaunch types in the Amazon Elastic Container Service Developer Guide.
" } }, "capacityProviderStrategy": { "target": "com.amazonaws.ecs#CapacityProviderStrategy", "traits": { "smithy.api#documentation": "The capacity provider strategy associated with the task set.
" } }, "platformVersion": { "target": "com.amazonaws.ecs#String", "traits": { "smithy.api#documentation": "The AWS Fargate platform version on which the tasks in the task set are running. A\n\t\t\tplatform version is only specified for tasks run on AWS Fargate. For more information, see\n\t\t\t\tAWS Fargate platform\n\t\t\t\tversions in the Amazon Elastic Container Service Developer Guide.
" } }, "networkConfiguration": { "target": "com.amazonaws.ecs#NetworkConfiguration", "traits": { "smithy.api#documentation": "The network configuration for the task set.
" } }, "loadBalancers": { "target": "com.amazonaws.ecs#LoadBalancers", "traits": { "smithy.api#documentation": "Details on a load balancer that is used with a task set.
" } }, "serviceRegistries": { "target": "com.amazonaws.ecs#ServiceRegistries", "traits": { "smithy.api#documentation": "The details of the service discovery registries to assign to this task set. For more\n\t\t\tinformation, see Service\n\t\t\t\tdiscovery.
" } }, "scale": { "target": "com.amazonaws.ecs#Scale", "traits": { "smithy.api#documentation": "A floating-point percentage of the desired number of tasks to place and keep running\n\t\t\tin the task set.
" } }, "stabilityStatus": { "target": "com.amazonaws.ecs#StabilityStatus", "traits": { "smithy.api#documentation": "The stability status, which indicates whether the task set has reached a steady state.\n\t\t\tIf the following conditions are met, the task set will be in\n\t\t\tSTEADY_STATE
:
The task runningCount
is equal to the\n\t\t\t\t\t\tcomputedDesiredCount
.
The pendingCount
is 0
.
There are no tasks running on container instances in the DRAINING
\n\t\t\t\t\tstatus.
All tasks are reporting a healthy status from the load balancers, service\n\t\t\t\t\tdiscovery, and container health checks.
\n\t\t\tIf any of those conditions are not met, the stability status returns\n\t\t\t\tSTABILIZING
.
The Unix timestamp for when the task set stability status was retrieved.
" } }, "tags": { "target": "com.amazonaws.ecs#Tags", "traits": { "smithy.api#documentation": "The metadata that you apply to the task set to help you categorize and organize them.\n\t\t\tEach tag consists of a key and an optional value, both of which you define.
\n\t\tThe following basic restrictions apply to tags:
\nMaximum number of tags per resource - 50
\nFor each resource, each tag key must be unique, and each tag key can have only\n one value.
\nMaximum key length - 128 Unicode characters in UTF-8
\nMaximum value length - 256 Unicode characters in UTF-8
\nIf your tagging schema is used across multiple services and resources,\n remember that other services may have restrictions on allowed characters.\n Generally allowed characters are: letters, numbers, and spaces representable in\n UTF-8, and the following characters: + - = . _ : / @.
\nTag keys and values are case-sensitive.
\nDo not use aws:
, AWS:
, or any upper or lowercase\n combination of such as a prefix for either keys or values as it is reserved for\n AWS use. You cannot edit or delete tag keys or values with this prefix. Tags with\n this prefix do not count against your tags per resource limit.
Information about a set of Amazon ECS tasks in either an AWS CodeDeploy or an EXTERNAL
\n\t\t\tdeployment. An Amazon ECS task set includes details such as the desired number of tasks, how\n\t\t\tmany tasks are running, and whether the task set serves production traffic.
The specified task set could not be found. You can view your available task sets with\n\t\t\t\tDescribeTaskSets. Task sets are specific to each cluster, service\n\t\t\tand Region.
", "smithy.api#error": "client" } }, "com.amazonaws.ecs#TaskSets": { "type": "list", "member": { "target": "com.amazonaws.ecs#TaskSet" } }, "com.amazonaws.ecs#TaskStopCode": { "type": "string", "traits": { "smithy.api#enum": [ { "value": "TaskFailedToStart", "name": "TASK_FAILED_TO_START" }, { "value": "EssentialContainerExited", "name": "ESSENTIAL_CONTAINER_EXITED" }, { "value": "UserInitiated", "name": "USER_INITIATED" } ] } }, "com.amazonaws.ecs#Tasks": { "type": "list", "member": { "target": "com.amazonaws.ecs#Task" } }, "com.amazonaws.ecs#Timestamp": { "type": "timestamp" }, "com.amazonaws.ecs#Tmpfs": { "type": "structure", "members": { "containerPath": { "target": "com.amazonaws.ecs#String", "traits": { "smithy.api#documentation": "The absolute file path where the tmpfs volume is to be mounted.
", "smithy.api#required": {} } }, "size": { "target": "com.amazonaws.ecs#Integer", "traits": { "smithy.api#documentation": "The maximum size (in MiB) of the tmpfs volume.
", "smithy.api#required": {} } }, "mountOptions": { "target": "com.amazonaws.ecs#StringList", "traits": { "smithy.api#documentation": "The list of tmpfs volume mount options.
\n\t\tValid values: \"defaults\" | \"ro\" | \"rw\" | \"suid\" | \"nosuid\" | \"dev\" | \"nodev\" |\n\t\t\t\t\"exec\" | \"noexec\" | \"sync\" | \"async\" | \"dirsync\" | \"remount\" | \"mand\" | \"nomand\" |\n\t\t\t\t\"atime\" | \"noatime\" | \"diratime\" | \"nodiratime\" | \"bind\" | \"rbind\" | \"unbindable\" |\n\t\t\t\t\"runbindable\" | \"private\" | \"rprivate\" | \"shared\" | \"rshared\" | \"slave\" | \"rslave\" |\n\t\t\t\t\"relatime\" | \"norelatime\" | \"strictatime\" | \"nostrictatime\" | \"mode\" | \"uid\" | \"gid\"\n\t\t\t\t| \"nr_inodes\" | \"nr_blocks\" | \"mpol\"
\n
The container path, mount options, and size of the tmpfs mount.
" } }, "com.amazonaws.ecs#TmpfsList": { "type": "list", "member": { "target": "com.amazonaws.ecs#Tmpfs" } }, "com.amazonaws.ecs#TransportProtocol": { "type": "string", "traits": { "smithy.api#enum": [ { "value": "tcp", "name": "TCP" }, { "value": "udp", "name": "UDP" } ] } }, "com.amazonaws.ecs#Ulimit": { "type": "structure", "members": { "name": { "target": "com.amazonaws.ecs#UlimitName", "traits": { "smithy.api#documentation": "The type
of the ulimit
.
The soft limit for the ulimit type.
", "smithy.api#required": {} } }, "hardLimit": { "target": "com.amazonaws.ecs#Integer", "traits": { "smithy.api#documentation": "The hard limit for the ulimit type.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "The ulimit
settings to pass to the container.
Amazon ECS tasks hosted on Fargate use the default\n\t\t\t\t\t\t\tresource limit values set by the operating system with the exception of\n\t\t\t\t\t\t\tthe nofile
resource limit parameter which Fargate\n\t\t\t\t\t\t\toverrides. The nofile
resource limit sets a restriction on\n\t\t\t\t\t\t\tthe number of open files that a container can use. The default\n\t\t\t\t\t\t\t\tnofile
soft limit is 1024
and hard limit\n\t\t\t\t\t\t\tis 4096
.
The specified task is not supported in this Region.
", "smithy.api#error": "client" } }, "com.amazonaws.ecs#UntagResource": { "type": "operation", "input": { "target": "com.amazonaws.ecs#UntagResourceRequest" }, "output": { "target": "com.amazonaws.ecs#UntagResourceResponse" }, "errors": [ { "target": "com.amazonaws.ecs#ClientException" }, { "target": "com.amazonaws.ecs#ClusterNotFoundException" }, { "target": "com.amazonaws.ecs#InvalidParameterException" }, { "target": "com.amazonaws.ecs#ResourceNotFoundException" }, { "target": "com.amazonaws.ecs#ServerException" } ], "traits": { "smithy.api#documentation": "Deletes specified tags from a resource.
" } }, "com.amazonaws.ecs#UntagResourceRequest": { "type": "structure", "members": { "resourceArn": { "target": "com.amazonaws.ecs#String", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the resource from which to delete tags. Currently, the supported\n\t\t\tresources are Amazon ECS capacity providers, tasks, services, task definitions, clusters, and\n\t\t\tcontainer instances.
", "smithy.api#required": {} } }, "tagKeys": { "target": "com.amazonaws.ecs#TagKeys", "traits": { "smithy.api#documentation": "The keys of the tags to be removed.
", "smithy.api#required": {} } } } }, "com.amazonaws.ecs#UntagResourceResponse": { "type": "structure", "members": {} }, "com.amazonaws.ecs#UpdateCapacityProvider": { "type": "operation", "input": { "target": "com.amazonaws.ecs#UpdateCapacityProviderRequest" }, "output": { "target": "com.amazonaws.ecs#UpdateCapacityProviderResponse" }, "errors": [ { "target": "com.amazonaws.ecs#ClientException" }, { "target": "com.amazonaws.ecs#InvalidParameterException" }, { "target": "com.amazonaws.ecs#ServerException" } ], "traits": { "smithy.api#documentation": "Modifies the parameters for a capacity provider.
" } }, "com.amazonaws.ecs#UpdateCapacityProviderRequest": { "type": "structure", "members": { "name": { "target": "com.amazonaws.ecs#String", "traits": { "smithy.api#documentation": "The name of the capacity provider to update.
", "smithy.api#required": {} } }, "autoScalingGroupProvider": { "target": "com.amazonaws.ecs#AutoScalingGroupProviderUpdate", "traits": { "smithy.api#documentation": "An object representing the parameters to update for the Auto Scaling group capacity\n\t\t\tprovider.
", "smithy.api#required": {} } } } }, "com.amazonaws.ecs#UpdateCapacityProviderResponse": { "type": "structure", "members": { "capacityProvider": { "target": "com.amazonaws.ecs#CapacityProvider", "traits": { "smithy.api#documentation": "Details about the capacity provider.
" } } } }, "com.amazonaws.ecs#UpdateCluster": { "type": "operation", "input": { "target": "com.amazonaws.ecs#UpdateClusterRequest" }, "output": { "target": "com.amazonaws.ecs#UpdateClusterResponse" }, "errors": [ { "target": "com.amazonaws.ecs#ClientException" }, { "target": "com.amazonaws.ecs#ClusterNotFoundException" }, { "target": "com.amazonaws.ecs#InvalidParameterException" }, { "target": "com.amazonaws.ecs#ServerException" } ], "traits": { "smithy.api#documentation": "Updates the cluster.
" } }, "com.amazonaws.ecs#UpdateClusterRequest": { "type": "structure", "members": { "cluster": { "target": "com.amazonaws.ecs#String", "traits": { "smithy.api#documentation": "The name of the cluster to modify the settings for.
", "smithy.api#required": {} } }, "settings": { "target": "com.amazonaws.ecs#ClusterSettings", "traits": { "smithy.api#documentation": "The cluster settings for your cluster.
" } }, "configuration": { "target": "com.amazonaws.ecs#ClusterConfiguration", "traits": { "smithy.api#documentation": "The execute command configuration for the cluster.
" } } } }, "com.amazonaws.ecs#UpdateClusterResponse": { "type": "structure", "members": { "cluster": { "target": "com.amazonaws.ecs#Cluster", "traits": { "smithy.api#documentation": "Details about the cluster.
" } } } }, "com.amazonaws.ecs#UpdateClusterSettings": { "type": "operation", "input": { "target": "com.amazonaws.ecs#UpdateClusterSettingsRequest" }, "output": { "target": "com.amazonaws.ecs#UpdateClusterSettingsResponse" }, "errors": [ { "target": "com.amazonaws.ecs#ClientException" }, { "target": "com.amazonaws.ecs#ClusterNotFoundException" }, { "target": "com.amazonaws.ecs#InvalidParameterException" }, { "target": "com.amazonaws.ecs#ServerException" } ], "traits": { "smithy.api#documentation": "Modifies the settings to use for a cluster.
" } }, "com.amazonaws.ecs#UpdateClusterSettingsRequest": { "type": "structure", "members": { "cluster": { "target": "com.amazonaws.ecs#String", "traits": { "smithy.api#documentation": "The name of the cluster to modify the settings for.
", "smithy.api#required": {} } }, "settings": { "target": "com.amazonaws.ecs#ClusterSettings", "traits": { "smithy.api#documentation": "The setting to use by default for a cluster. This parameter is used to enable CloudWatch\n\t\t\tContainer Insights for a cluster. If this value is specified, it will override the\n\t\t\t\tcontainerInsights
value set with PutAccountSetting or\n\t\t\t\tPutAccountSettingDefault.
Details about the cluster
" } } } }, "com.amazonaws.ecs#UpdateContainerAgent": { "type": "operation", "input": { "target": "com.amazonaws.ecs#UpdateContainerAgentRequest" }, "output": { "target": "com.amazonaws.ecs#UpdateContainerAgentResponse" }, "errors": [ { "target": "com.amazonaws.ecs#ClientException" }, { "target": "com.amazonaws.ecs#ClusterNotFoundException" }, { "target": "com.amazonaws.ecs#InvalidParameterException" }, { "target": "com.amazonaws.ecs#MissingVersionException" }, { "target": "com.amazonaws.ecs#NoUpdateAvailableException" }, { "target": "com.amazonaws.ecs#ServerException" }, { "target": "com.amazonaws.ecs#UpdateInProgressException" } ], "traits": { "smithy.api#documentation": "Updates the Amazon ECS container agent on a specified container instance. Updating the\n\t\t\tAmazon ECS container agent does not interrupt running tasks or services on the container\n\t\t\tinstance. The process for updating the agent differs depending on whether your container\n\t\t\tinstance was launched with the Amazon ECS-optimized AMI or another operating system.
\n\t\tThe UpdateContainerAgent
API isn't supported for container instances\n\t\t\t\tusing the Amazon ECS-optimized Amazon Linux 2 (arm64) AMI. To update the container agent,\n\t\t\t\tyou can update the ecs-init
package which will update the agent. For\n\t\t\t\tmore information, see Updating the\n\t\t\t\t\tAmazon ECS container agent in the\n\t\t\t\tAmazon Elastic Container Service Developer Guide.
The UpdateContainerAgent
API requires an Amazon ECS-optimized AMI or Amazon\n\t\t\tLinux AMI with the ecs-init
service installed and running. For help\n\t\t\tupdating the Amazon ECS container agent on other operating systems, see Manually updating the Amazon ECS container agent in the\n\t\t\t\tAmazon Elastic Container Service Developer Guide.
The short name or full Amazon Resource Name (ARN) of the cluster that your container instance is\n\t\t\trunning on. If you do not specify a cluster, the default cluster is assumed.
" } }, "containerInstance": { "target": "com.amazonaws.ecs#String", "traits": { "smithy.api#documentation": "The container instance ID or full ARN entries for the container instance on which\n\t\t\tyou would like to update the Amazon ECS container agent.
", "smithy.api#required": {} } } } }, "com.amazonaws.ecs#UpdateContainerAgentResponse": { "type": "structure", "members": { "containerInstance": { "target": "com.amazonaws.ecs#ContainerInstance", "traits": { "smithy.api#documentation": "The container instance for which the container agent was updated.
" } } } }, "com.amazonaws.ecs#UpdateContainerInstancesState": { "type": "operation", "input": { "target": "com.amazonaws.ecs#UpdateContainerInstancesStateRequest" }, "output": { "target": "com.amazonaws.ecs#UpdateContainerInstancesStateResponse" }, "errors": [ { "target": "com.amazonaws.ecs#ClientException" }, { "target": "com.amazonaws.ecs#ClusterNotFoundException" }, { "target": "com.amazonaws.ecs#InvalidParameterException" }, { "target": "com.amazonaws.ecs#ServerException" } ], "traits": { "smithy.api#documentation": "Modifies the status of an Amazon ECS container instance.
\n\t\tOnce a container instance has reached an ACTIVE
state, you can change the\n\t\t\tstatus of a container instance to DRAINING
to manually remove an instance\n\t\t\tfrom a cluster, for example to perform system updates, update the Docker daemon, or\n\t\t\tscale down the cluster size.
A container instance cannot be changed to DRAINING
until it has\n\t\t\t\treached an ACTIVE
status. If the instance is in any other status, an\n\t\t\t\terror will be received.
When you set a container instance to DRAINING
, Amazon ECS prevents new tasks\n\t\t\tfrom being scheduled for placement on the container instance and replacement service\n\t\t\ttasks are started on other container instances in the cluster if the resources are\n\t\t\tavailable. Service tasks on the container instance that are in the PENDING
\n\t\t\tstate are stopped immediately.
Service tasks on the container instance that are in the RUNNING
state are\n\t\t\tstopped and replaced according to the service's deployment configuration parameters,\n\t\t\t\tminimumHealthyPercent
and maximumPercent
. You can change\n\t\t\tthe deployment configuration of your service using UpdateService.
If minimumHealthyPercent
is below 100%, the scheduler can ignore\n\t\t\t\t\t\tdesiredCount
temporarily during task replacement. For example,\n\t\t\t\t\t\tdesiredCount
is four tasks, a minimum of 50% allows the\n\t\t\t\t\tscheduler to stop two existing tasks before starting two new tasks. If the\n\t\t\t\t\tminimum is 100%, the service scheduler can't remove existing tasks until the\n\t\t\t\t\treplacement tasks are considered healthy. Tasks for services that do not use a\n\t\t\t\t\tload balancer are considered healthy if they are in the RUNNING
\n\t\t\t\t\tstate. Tasks for services that use a load balancer are considered healthy if\n\t\t\t\t\tthey are in the RUNNING
state and the container instance they are\n\t\t\t\t\thosted on is reported as healthy by the load balancer.
The maximumPercent
parameter represents an upper limit on the\n\t\t\t\t\tnumber of running tasks during task replacement, which enables you to define the\n\t\t\t\t\treplacement batch size. For example, if desiredCount
is four tasks,\n\t\t\t\t\ta maximum of 200% starts four new tasks before stopping the four tasks to be\n\t\t\t\t\tdrained, provided that the cluster resources required to do this are available.\n\t\t\t\t\tIf the maximum is 100%, then replacement tasks can't start until the draining\n\t\t\t\t\ttasks have stopped.
Any PENDING
or RUNNING
tasks that do not belong to a service\n\t\t\tare not affected. You must wait for them to finish or stop them manually.
A container instance has completed draining when it has no more RUNNING
\n\t\t\ttasks. You can verify this using ListTasks.
When a container instance has been drained, you can set a container instance to\n\t\t\t\tACTIVE
status and once it has reached that status the Amazon ECS scheduler\n\t\t\tcan begin scheduling tasks on the instance again.
The short name or full Amazon Resource Name (ARN) of the cluster that hosts the container instance to\n\t\t\tupdate. If you do not specify a cluster, the default cluster is assumed.
" } }, "containerInstances": { "target": "com.amazonaws.ecs#StringList", "traits": { "smithy.api#documentation": "A list of container instance IDs or full ARN entries.
", "smithy.api#required": {} } }, "status": { "target": "com.amazonaws.ecs#ContainerInstanceStatus", "traits": { "smithy.api#documentation": "The container instance state with which to update the container instance. The only\n\t\t\tvalid values for this action are ACTIVE
and DRAINING
. A\n\t\t\tcontainer instance can only be updated to DRAINING
status once it has\n\t\t\treached an ACTIVE
state. If a container instance is in\n\t\t\t\tREGISTERING
, DEREGISTERING
, or\n\t\t\t\tREGISTRATION_FAILED
state you can describe the container instance but\n\t\t\twill be unable to update the container instance state.
The list of container instances.
" } }, "failures": { "target": "com.amazonaws.ecs#Failures", "traits": { "smithy.api#documentation": "Any failures associated with the call.
" } } } }, "com.amazonaws.ecs#UpdateInProgressException": { "type": "structure", "members": { "message": { "target": "com.amazonaws.ecs#String" } }, "traits": { "smithy.api#documentation": "There is already a current Amazon ECS container agent update in progress on the specified\n\t\t\tcontainer instance. If the container agent becomes disconnected while it is in a\n\t\t\ttransitional stage, such as PENDING
or STAGING
, the update\n\t\t\tprocess can get stuck in that state. However, when the agent reconnects, it resumes\n\t\t\twhere it stopped previously.
Updating the task placement strategies and constraints on an Amazon ECS service remains\n\t\t\t\tin preview and is a Beta Service as defined by and subject to the Beta Service\n\t\t\t\tParticipation Service Terms located at https://aws.amazon.com/service-terms (\"Beta Terms\"). These Beta Terms\n\t\t\t\tapply to your participation in this preview.
\n\t\tModifies the parameters of a service.
\n\t\tFor services using the rolling update (ECS
) deployment controller, the\n\t\t\tdesired count, deployment configuration, network configuration, task placement\n\t\t\tconstraints and strategies, or task definition used can be updated.
For services using the blue/green (CODE_DEPLOY
) deployment controller,\n\t\t\tonly the desired count, deployment configuration, task placement constraints and\n\t\t\tstrategies, and health check grace period can be updated using this API. If the network\n\t\t\tconfiguration, platform version, or task definition need to be updated, a new AWS CodeDeploy\n\t\t\tdeployment should be created. For more information, see CreateDeployment in the AWS CodeDeploy API Reference.
For services using an external deployment controller, you can update only the desired\n\t\t\tcount, task placement constraints and strategies, and health check grace period using\n\t\t\tthis API. If the launch type, load balancer, network configuration, platform version, or\n\t\t\ttask definition need to be updated, you should create a new task set. For more\n\t\t\tinformation, see CreateTaskSet.
\n\t\tYou can add to or subtract from the number of instantiations of a task definition in a\n\t\t\tservice by specifying the cluster that the service is running in and a new\n\t\t\t\tdesiredCount
parameter.
If you have updated the Docker image of your application, you can create a new task\n\t\t\tdefinition with that image and deploy it to your service. The service scheduler uses the\n\t\t\tminimum healthy percent and maximum percent parameters (in the service's deployment\n\t\t\tconfiguration) to determine the deployment strategy.
\n\t\tIf your updated Docker image uses the same tag as what is in the existing task\n\t\t\t\tdefinition for your service (for example, my_image:latest
), you do not\n\t\t\t\tneed to create a new revision of your task definition. You can update the service\n\t\t\t\tusing the forceNewDeployment
option. The new tasks launched by the\n\t\t\t\tdeployment pull the current image/tag combination from your repository when they\n\t\t\t\tstart.
You can also update the deployment configuration of a service. When a deployment is\n\t\t\ttriggered by updating the task definition of a service, the service scheduler uses the\n\t\t\tdeployment configuration parameters, minimumHealthyPercent
and\n\t\t\t\tmaximumPercent
, to determine the deployment strategy.
If minimumHealthyPercent
is below 100%, the scheduler can ignore\n\t\t\t\t\t\tdesiredCount
temporarily during a deployment. For example, if\n\t\t\t\t\t\tdesiredCount
is four tasks, a minimum of 50% allows the\n\t\t\t\t\tscheduler to stop two existing tasks before starting two new tasks. Tasks for\n\t\t\t\t\tservices that do not use a load balancer are considered healthy if they are in\n\t\t\t\t\tthe RUNNING
state. Tasks for services that use a load balancer are\n\t\t\t\t\tconsidered healthy if they are in the RUNNING
state and the\n\t\t\t\t\tcontainer instance they are hosted on is reported as healthy by the load\n\t\t\t\t\tbalancer.
The maximumPercent
parameter represents an upper limit on the\n\t\t\t\t\tnumber of running tasks during a deployment, which enables you to define the\n\t\t\t\t\tdeployment batch size. For example, if desiredCount
is four tasks,\n\t\t\t\t\ta maximum of 200% starts four new tasks before stopping the four older tasks\n\t\t\t\t\t(provided that the cluster resources required to do this are available).
When UpdateService stops a task during a deployment, the equivalent\n\t\t\tof docker stop
is issued to the containers running in the task. This\n\t\t\tresults in a SIGTERM
and a 30-second timeout, after which\n\t\t\t\tSIGKILL
is sent and the containers are forcibly stopped. If the\n\t\t\tcontainer handles the SIGTERM
gracefully and exits within 30 seconds from\n\t\t\treceiving it, no SIGKILL
is sent.
When the service scheduler launches new tasks, it determines task placement in your\n\t\t\tcluster with the following logic:
\n\t\tDetermine which of the container instances in your cluster can support your\n\t\t\t\t\tservice's task definition (for example, they have the required CPU, memory,\n\t\t\t\t\tports, and container instance attributes).
\n\t\t\tBy default, the service scheduler attempts to balance tasks across\n\t\t\t\t\tAvailability Zones in this manner (although you can choose a different placement\n\t\t\t\t\tstrategy):
\n\t\t\t\tSort the valid container instances by the fewest number of running\n\t\t\t\t\t\t\ttasks for this service in the same Availability Zone as the instance.\n\t\t\t\t\t\t\tFor example, if zone A has one running service task and zones B and C\n\t\t\t\t\t\t\teach have zero, valid container instances in either zone B or C are\n\t\t\t\t\t\t\tconsidered optimal for placement.
\n\t\t\t\t\tPlace the new service task on a valid container instance in an optimal\n\t\t\t\t\t\t\tAvailability Zone (based on the previous steps), favoring container\n\t\t\t\t\t\t\tinstances with the fewest number of running tasks for this\n\t\t\t\t\t\t\tservice.
\n\t\t\t\t\tWhen the service scheduler stops running tasks, it attempts to maintain balance across\n\t\t\tthe Availability Zones in your cluster using the following logic:
\n\t\tSort the container instances by the largest number of running tasks for this\n\t\t\t\t\tservice in the same Availability Zone as the instance. For example, if zone A\n\t\t\t\t\thas one running service task and zones B and C each have two, container\n\t\t\t\t\tinstances in either zone B or C are considered optimal for termination.
\n\t\t\tStop the task on a container instance in an optimal Availability Zone (based\n\t\t\t\t\ton the previous steps), favoring container instances with the largest number of\n\t\t\t\t\trunning tasks for this service.
\n\t\t\tModifies which task set in a service is the primary task set. Any parameters that are\n\t\t\tupdated on the primary task set in a service will transition to the service. This is\n\t\t\tused when a service uses the EXTERNAL
deployment controller type. For more\n\t\t\tinformation, see Amazon ECS Deployment\n\t\t\t\tTypes in the Amazon Elastic Container Service Developer Guide.
The short name or full Amazon Resource Name (ARN) of the cluster that hosts the service that the task\n\t\t\tset exists in.
", "smithy.api#required": {} } }, "service": { "target": "com.amazonaws.ecs#String", "traits": { "smithy.api#documentation": "The short name or full Amazon Resource Name (ARN) of the service that the task set exists in.
", "smithy.api#required": {} } }, "primaryTaskSet": { "target": "com.amazonaws.ecs#String", "traits": { "smithy.api#documentation": "The short name or full Amazon Resource Name (ARN) of the task set to set as the primary task set in the\n\t\t\tdeployment.
", "smithy.api#required": {} } } } }, "com.amazonaws.ecs#UpdateServicePrimaryTaskSetResponse": { "type": "structure", "members": { "taskSet": { "target": "com.amazonaws.ecs#TaskSet", "traits": { "smithy.api#documentation": "Details about the task set.
" } } } }, "com.amazonaws.ecs#UpdateServiceRequest": { "type": "structure", "members": { "cluster": { "target": "com.amazonaws.ecs#String", "traits": { "smithy.api#documentation": "The short name or full Amazon Resource Name (ARN) of the cluster that your service is running on.\n\t\t\tIf you do not specify a cluster, the default cluster is assumed.
" } }, "service": { "target": "com.amazonaws.ecs#String", "traits": { "smithy.api#documentation": "The name of the service to update.
", "smithy.api#required": {} } }, "desiredCount": { "target": "com.amazonaws.ecs#BoxedInteger", "traits": { "smithy.api#documentation": "The number of instantiations of the task to place and keep running in your\n\t\t\tservice.
" } }, "taskDefinition": { "target": "com.amazonaws.ecs#String", "traits": { "smithy.api#documentation": "The family
and revision
(family:revision
) or\n\t\t\tfull ARN of the task definition to run in your service. If a revision
is\n\t\t\tnot specified, the latest ACTIVE
revision is used. If you modify the task\n\t\t\tdefinition with UpdateService
, Amazon ECS spawns a task with the new version of\n\t\t\tthe task definition and then stops an old task after the new version is running.
The capacity provider strategy to update the service to use.
\n\t\tIf the service is using the default capacity provider strategy for the cluster, the\n\t\t\tservice can be updated to use one or more capacity providers as opposed to the default\n\t\t\tcapacity provider strategy. However, when a service is using a capacity provider\n\t\t\tstrategy that is not the default capacity provider strategy, the service cannot be\n\t\t\tupdated to use the cluster's default capacity provider strategy.
\n\t\tA capacity provider strategy consists of one or more capacity providers along with the\n\t\t\t\tbase
and weight
to assign to them. A capacity provider\n\t\t\tmust be associated with the cluster to be used in a capacity provider strategy. The\n\t\t\t\tPutClusterCapacityProviders API is used to associate a capacity\n\t\t\tprovider with a cluster. Only capacity providers with an ACTIVE
or\n\t\t\t\tUPDATING
status can be used.
If specifying a capacity provider that uses an Auto Scaling group, the capacity\n\t\t\tprovider must already be created. New capacity providers can be created with the CreateCapacityProvider API operation.
\n\t\tTo use a AWS Fargate capacity provider, specify either the FARGATE
or\n\t\t\t\tFARGATE_SPOT
capacity providers. The AWS Fargate capacity providers are\n\t\t\tavailable to all accounts and only need to be associated with a cluster to be\n\t\t\tused.
The PutClusterCapacityProviders API operation is used to update the\n\t\t\tlist of available capacity providers for a cluster after the cluster is created.
\n\t\t " } }, "deploymentConfiguration": { "target": "com.amazonaws.ecs#DeploymentConfiguration", "traits": { "smithy.api#documentation": "Optional deployment parameters that control how many tasks run during the deployment\n\t\t\tand the ordering of stopping and starting tasks.
" } }, "networkConfiguration": { "target": "com.amazonaws.ecs#NetworkConfiguration", "traits": { "smithy.api#documentation": "An object representing the network configuration for the service.
" } }, "placementConstraints": { "target": "com.amazonaws.ecs#PlacementConstraints", "traits": { "smithy.api#documentation": "An array of task placement constraint objects to update the service to use. If no\n\t\t\tvalue is specified, the existing placement constraints for the service will remain\n\t\t\tunchanged. If this value is specified, it will override any existing placement\n\t\t\tconstraints defined for the service. To remove all existing placement constraints,\n\t\t\tspecify an empty array.
\n\t\tYou can specify a maximum of 10 constraints per task (this limit includes constraints\n\t\t\tin the task definition and those specified at runtime).
" } }, "placementStrategy": { "target": "com.amazonaws.ecs#PlacementStrategies", "traits": { "smithy.api#documentation": "The task placement strategy objects to update the service to use. If no value is\n\t\t\tspecified, the existing placement strategy for the service will remain unchanged. If\n\t\t\tthis value is specified, it will override the existing placement strategy defined for\n\t\t\tthe service. To remove an existing placement strategy, specify an empty object.
\n\t\tYou can specify a maximum of five strategy rules per service.
" } }, "platformVersion": { "target": "com.amazonaws.ecs#String", "traits": { "smithy.api#documentation": "The platform version on which your tasks in the service are running. A platform\n\t\t\tversion is only specified for tasks using the Fargate launch type. If a\n\t\t\tplatform version is not specified, the LATEST
platform version is used by\n\t\t\tdefault. For more information, see AWS Fargate Platform\n\t\t\t\tVersions in the Amazon Elastic Container Service Developer Guide.
Whether to force a new deployment of the service. Deployments are not forced by\n\t\t\tdefault. You can use this option to trigger a new deployment with no service definition\n\t\t\tchanges. For example, you can update a service's tasks to use a newer Docker image with\n\t\t\tthe same image/tag combination (my_image:latest
) or to roll Fargate tasks\n\t\t\tonto a newer platform version.
The period of time, in seconds, that the Amazon ECS service scheduler should ignore\n\t\t\tunhealthy Elastic Load Balancing target health checks after a task has first started. This is only valid\n\t\t\tif your service is configured to use a load balancer. If your service's tasks take a\n\t\t\twhile to start and respond to Elastic Load Balancing health checks, you can specify a health check grace\n\t\t\tperiod of up to 2,147,483,647 seconds. During that time, the Amazon ECS service\n\t\t\tscheduler ignores the Elastic Load Balancing health check status. This grace period can prevent the ECS\n\t\t\tservice scheduler from marking tasks as unhealthy and stopping them before they have\n\t\t\ttime to come up.
" } }, "enableExecuteCommand": { "target": "com.amazonaws.ecs#BoxedBoolean", "traits": { "smithy.api#documentation": "If true
, this enables execute command functionality on all task\n\t\t\tcontainers.
If you do not want to override the value that was set when the service was created,\n\t\t\tyou can set this to null
when performing this action.
The full description of your service following the update call.
" } } } }, "com.amazonaws.ecs#UpdateTaskSet": { "type": "operation", "input": { "target": "com.amazonaws.ecs#UpdateTaskSetRequest" }, "output": { "target": "com.amazonaws.ecs#UpdateTaskSetResponse" }, "errors": [ { "target": "com.amazonaws.ecs#AccessDeniedException" }, { "target": "com.amazonaws.ecs#ClientException" }, { "target": "com.amazonaws.ecs#ClusterNotFoundException" }, { "target": "com.amazonaws.ecs#InvalidParameterException" }, { "target": "com.amazonaws.ecs#ServerException" }, { "target": "com.amazonaws.ecs#ServiceNotActiveException" }, { "target": "com.amazonaws.ecs#ServiceNotFoundException" }, { "target": "com.amazonaws.ecs#TaskSetNotFoundException" }, { "target": "com.amazonaws.ecs#UnsupportedFeatureException" } ], "traits": { "smithy.api#documentation": "Modifies a task set. This is used when a service uses the EXTERNAL
\n\t\t\tdeployment controller type. For more information, see Amazon ECS Deployment\n\t\t\t\tTypes in the Amazon Elastic Container Service Developer Guide.
The short name or full Amazon Resource Name (ARN) of the cluster that hosts the service that the task\n\t\t\tset exists in.
", "smithy.api#required": {} } }, "service": { "target": "com.amazonaws.ecs#String", "traits": { "smithy.api#documentation": "The short name or full Amazon Resource Name (ARN) of the service that the task set exists in.
", "smithy.api#required": {} } }, "taskSet": { "target": "com.amazonaws.ecs#String", "traits": { "smithy.api#documentation": "The short name or full Amazon Resource Name (ARN) of the task set to update.
", "smithy.api#required": {} } }, "scale": { "target": "com.amazonaws.ecs#Scale", "traits": { "smithy.api#documentation": "A floating-point percentage of the desired number of tasks to place and keep running\n\t\t\tin the task set.
", "smithy.api#required": {} } } } }, "com.amazonaws.ecs#UpdateTaskSetResponse": { "type": "structure", "members": { "taskSet": { "target": "com.amazonaws.ecs#TaskSet", "traits": { "smithy.api#documentation": "Details about the task set.
" } } } }, "com.amazonaws.ecs#VersionInfo": { "type": "structure", "members": { "agentVersion": { "target": "com.amazonaws.ecs#String", "traits": { "smithy.api#documentation": "The version number of the Amazon ECS container agent.
" } }, "agentHash": { "target": "com.amazonaws.ecs#String", "traits": { "smithy.api#documentation": "The Git commit hash for the Amazon ECS container agent build on the amazon-ecs-agent\n\t\t\t GitHub repository.
" } }, "dockerVersion": { "target": "com.amazonaws.ecs#String", "traits": { "smithy.api#documentation": "The Docker version running on the container instance.
" } } }, "traits": { "smithy.api#documentation": "The Docker and Amazon ECS container agent version information about a container\n\t\t\tinstance.
" } }, "com.amazonaws.ecs#Volume": { "type": "structure", "members": { "name": { "target": "com.amazonaws.ecs#String", "traits": { "smithy.api#documentation": "The name of the volume. Up to 255 letters (uppercase and lowercase), numbers, underscores, and hyphens are allowed. This name is referenced in the\n\t\t\t\tsourceVolume
parameter of container definition\n\t\t\tmountPoints
.
This parameter is specified when you are using bind mount host volumes. The contents\n\t\t\tof the host
parameter determine whether your bind mount host volume\n\t\t\tpersists on the host container instance and where it is stored. If the host
\n\t\t\tparameter is empty, then the Docker daemon assigns a host path for your data volume.\n\t\t\tHowever, the data is not guaranteed to persist after the containers associated with it\n\t\t\tstop running.
Windows containers can mount whole directories on the same drive as\n\t\t\t\t$env:ProgramData
. Windows containers cannot mount directories on a\n\t\t\tdifferent drive, and mount point cannot be across drives. For example, you can mount\n\t\t\t\tC:\\my\\path:C:\\my\\path
and D:\\:D:\\
, but not\n\t\t\t\tD:\\my\\path:C:\\my\\path
or D:\\:C:\\my\\path
.
This parameter is specified when you are using Docker volumes.
\n\t\tWindows containers only support the use of the local
driver. To use bind\n\t\t\tmounts, specify the host
parameter instead.
Docker volumes are not supported by tasks run on AWS Fargate.
\n\t\tThis parameter is specified when you are using an Amazon Elastic File System file system for task\n\t\t\tstorage.
" } }, "fsxWindowsFileServerVolumeConfiguration": { "target": "com.amazonaws.ecs#FSxWindowsFileServerVolumeConfiguration", "traits": { "smithy.api#documentation": "This parameter is specified when you are using Amazon FSx for Windows File Server file system for task\n\t\t\tstorage.
" } } }, "traits": { "smithy.api#documentation": "A data volume used in a task definition. For tasks that use the Amazon Elastic File\n\t\t\tSystem (Amazon EFS), specify an efsVolumeConfiguration
. For Windows tasks\n\t\t\tthat use Amazon FSx for Windows File Server file system, specify a\n\t\t\t\tfsxWindowsFileServerVolumeConfiguration
. For tasks that use a Docker\n\t\t\tvolume, specify a DockerVolumeConfiguration
. For tasks that use a bind\n\t\t\tmount host volume, specify a host
and optional sourcePath
. For\n\t\t\tmore information, see Using Data Volumes in\n\t\t\t\tTasks.
The name of another container within the same task definition from which to mount\n\t\t\tvolumes.
" } }, "readOnly": { "target": "com.amazonaws.ecs#BoxedBoolean", "traits": { "smithy.api#documentation": "If this value is true
, the container has read-only access to the volume.\n\t\t\tIf this value is false
, then the container can write to the volume. The\n\t\t\tdefault value is false
.
Details on a data volume from another container in the same task definition.
" } }, "com.amazonaws.ecs#VolumeFromList": { "type": "list", "member": { "target": "com.amazonaws.ecs#VolumeFrom" } }, "com.amazonaws.ecs#VolumeList": { "type": "list", "member": { "target": "com.amazonaws.ecs#Volume" } } } }